Deploy add-ons

Administration page Application/Contract Syracuse/Collaboration class xtremAddonsGenerators Representation xtremAddonsGenerators

Purpose

Use this function to easily deploy Sage X3 Builder add-on packages to the Sage X3 Services component or generate a ZIP file containing all existing add-ons for a given endpoint.

You can use this feature to create and manage the deployment of your Sage X3 Builder add-ons (custom packages) across the endpoints of your solution.

Add-on packages are ZIP files that you can either build manually from your Sage X3 Builder projects or retrieve from an existing Sage X3 Services endpoint using the Download add-ons function.

For more information, refer to the How to deploy node and page extensions guide.

Procedure

Follow these steps to deploy an add-on:

  1. From the Actions menu, select New add-ons deployment.

  2. Enter a description.

  3. Select your Sage X3 root endpoint.

  4. In the endpoint list, delete the endpoints where you do not want to deploy your add-ons. Keep only the intended target endpoints.

  5. In the Add-ons ZIP file field, click Select file to upload your ZIP file.

  6. From the Actions menu, select Save.

  7. Click Start add-ons deployment process. You can launch the deployment at any time later if needed.

  8. A confirmation message displays. Click OK.

  9. The deployment process starts.

  10. To view traces and their status, click the link in the Trace ID field.

  11. Refresh the page.

  12. The deployment status displays in the Generation status field.

  13. Your add-on is deployed.
  14. Once the deployment is complete, you need to restart the Sage X3 Services service for your add-ons to be applied.

Logging and troubleshooting

During add-on deployment, Sage X3 Services notifies the Deploy add-ons function of ongoing events with a trace ID.

The trace (log) is refreshed by Sage X3 Services every 30 seconds by default.

You can change this interval in the xtrem-config.yml file in the Sage X3 Services installation, under the following section. Specify the value in milliseconds:

Copier 
x3:
    agent:
        traceInterval: 30000

During deployment, you can switch to another Sage X3 function and perform other tasks.

You can return to the Deploy add-ons function to check its progress at any time, as deployments can take a while.