Installing and updating the Velixo customization package

Overview

The Velixo customization package installs what Velixo needs in Acumatica and Acumatica-based ERPs: the generic inquiries Velixo reads, the single sign-on configuration, the web services and screens used for writeback, and a Velixo workspace.

The VelixoIntelligence package also adds what the Velixo AI Gateway needs to connect Claude, ChatGPT, Microsoft Teams, and Slack to your ERP, plus the Export to Velixo Workbook buttons and Smart Links.

Writeback uses Velixo's own endpoints, so the package is unlikely to conflict with other customization projects.

This article covers:

• choosing the package for your Acumatica version

• preparing to publish

• installing the package for the first time

• updating the package

• switching from VelixoCore to VelixoIntelligence

• assigning the Velixo roles

• checking the installed version

Choosing the package

Choose the package by your Acumatica version and by whether you use the Velixo AI Gateway:

Before you begin

• Coordinate package installation with your ERP consultant to avoid accidentally unpublishing other existing customization projects.

• When you publish, keep every other customization project that should stay published selected on the Customization Projects form (SM204505) alongside the Velixo project.

• Publishing can restart the site and log out active users, especially on versions before 2021 R2 and when you publish with cleanup. Plan the update for a time when you can afford the downtime.

• If your instance has several tenants, publish to every tenant that Velixo connects to.

For more about customization projects, see the Acumatica documentation listed in at the bottom of this page.

Installing the package for the first time

Use this procedure if no Velixo customization project is published on your instance.

1. Open the Customization Projects form (SM204505).

   

2. Select Import, and import the downloaded .zip file as a new project.

   

3. Select the checkbox for the Velixo project and for every other project that should stay published.

4. If your instance uses a single tenant, select Publish. Otherwise, select … → Publish to Multiple Tenants.

   

5. In the dialog that appears, select every tenant that Velixo connects to, and select OK.

   

When the process completes, the customization project is published to each selected tenant, and a Velixo workspace appears in your ERP. With VelixoCore, the workspace contains the Help, Community, and Videos tiles. In the Modern UI, the Velixo inquiries and writeback screens are not placed in the workspace. Next, assign the Velixo roles: see Assigning the Velixo roles.

Updating the package

Velixo updates the package when new functionality requires changes in Acumatica. Use this procedure to replace an installed Velixo project with a newer version of the same package.

1. Download the latest package for your Acumatica version: see Choosing the package.

2. On the Customization Projects form (SM204505), select the Velixo project to open it in the Customization Project Editor. The project's name depends on the file you imported, for example VelixoConnectedAppConfig, velixo, VelixoCore, or VelixoIntelligence.

3. On the File menu, select Replace from Package.

   

4. In the Open Package dialog, select Choose File, select the downloaded .zip file, and select Upload.

   

5. Return to the Customization Projects form. Make sure the Velixo project and every other project that should stay published are selected.

6. If your instance uses a single tenant, select Publish. Otherwise, select … → Publish to Multiple Tenants, select every tenant that Velixo connects to, and select OK.

   

7. Acumatica compiles the project. When you are ready to log out all active users, select Publish.

8. When Acumatica reports that the website has been updated, close the Compilation window.

Switching from VelixoCore to VelixoIntelligence

Use this procedure if a VelixoCore project is published on your instance and you want to use the Velixo AI Gateway.

1. On the Customization Projects form (SM204505), import the VelixoIntelligence .zip file as a new project, as described in Installing the package for the first time. If a project named VelixoIntelligence already exists from the earlier Velixo Intelligence add-on, select it and use … → Replace Highlighted Project Content instead.

2. Clear the check box of your existing Velixo project. Select the check box of the VelixoIntelligence project and of every other project that should stay published, and select Save.

3. On the form toolbar, select Publish.

4. Select the VelixoIntelligence project, select Edit, and in the project editor select Publish → Publish with Cleanup.

5. If your instance has several tenants, return to the Customization Projects form, select … → Publish to Multiple Tenants, and select every tenant that Velixo connects to.

Assigning the Velixo roles

In Acumatica 2024 R1 and newer, the Velixo screens, buttons, and inquiries are not accessible to anyone by default, except administrators.

The Customization package includes the following roles:

Which roles a user needs depends on how they use Velixo:

• Excel reports need Velixo Core, Velixo GL, or Velixo PM, depending on the data the reports use.

• The Export to Velixo Workbook buttons need Velixo Core, Velixo GL, or Velixo PM.

• The Velixo AI Gateway needs Velixo Intelligence (Read Only) or Velixo Intelligence (Read and Write) for the Acumatica user whose credentials the Velixo Portal connection uses. To query the Velixo inquiries through the AI Gateway, that user also needs the Velixo Core, GL, or PM role that grants the necessary inquiry.

When you save an Acumatica connection in the Velixo Portal, Velixo checks the user's roles. If one is missing, the connection is saved and you’re given an appropriate warning.

Permissions per role

Expand the tables below to see each role's access to individual Acumatica screens, writeback screens, and inquiries. Administrators have access to all of them.

Checking the installed version

Check your version to decide whether it is time to update, or whether a Velixo feature you want to use is compatible with your package. The Velixo NX add-in also tells you automatically when a newer package is available.

You can check your Velixo Customization Project version in Acumatica, in the VelixoReportsPro-VelixoCustomizationProjectVersion screen, ScreenID = VE500095.

To read the customization project version from Excel, use the GI function with your connection name, for example:

=GI("Acumatica","VelixoReportsPro-VelixoCustomizationProjectVersion",,"VersionNumber")

The function returns the version for the specified connection, for example 20261008.

What an outdated package means

Excel reports keep working with an older package, but you cannot use the features added in newer versions. When a newer package is available, the Velixo NX add-in shows a warning.

To update, follow Updating the package.

The Auto calculation mode of the cost projection writeback requires customization project version 20260806 or later.

Related articles

• Velixo Customization Project Release notes

• Configuring access rights in Acumatica

• Configuring Access Rights (ERP 2023R2 and older)

• Exporting data to Velixo from your ERP

• Configure Single-Sign-On for Acumatica-based ERPs

• Acumatica Velixo version compatibility

• Acumatica user interface changes after installing Velixo customization

• Getting started with the Velixo AI Gateway

• The Velixo Intelligence customization is missing or out of date

Acumatica documentation:

• Acumatica Customization Guide (2020 R2, but the steps are similar for other versions)

• Managing Customization Projects

• How to Publish a Project

• Importing a Customization Project

• Introduction to Acumatica Customization Packages