Publish
Performing the Publish action is a critical step that you must take whenever you make any changes to the platform configuration. Without performing this action, the changes will not be applied to the platform, and the platform will not consider the changes when executing any integration actions.
The Publish button can be found on the homepage within your assigned Company tile. However, this option is available only to users with the necessary permissions. The button will not be visible if you do not have these permissions.
You can also find the Publish button in the top right corner after you open a specific company. The button is consistently displayed across all items in the left side panel, including Tasks, Endpoints, Agents, and more.
Publish button behavior
When publishing is required, the Publish button in the header reflects the company type color and starts blinking after 10 seconds to draw attention.
If there are no configuration changes that require publishing, the Publish button remains disabled and is displayed in grey.
Clicking the Publish button opens a pop-over that provides information about the last time the company was published and offers actions to either start the publishing process or cancel the action.
Once the Publish action is confirmed, the button changes to a disabled grey loading state labeled Publishing. At the same time, a toast notification appears in the bottom-right corner, informing the user that publishing is currently in progress.
After the publishing process is completed, a toast notification displays the result:
- Success – All changes were published successfully.
- Warning – Publishing completed with warnings. Potential configuration issues were detected but do not affect functionality.
- Error – Publishing failed and no changes were applied. The previously published configuration remains active.
The toast notification is visible for a limited time and disappears automatically after a few seconds. Hovering over the toast pauses the timeout, allowing the message to be read in full. For Warning and Error statuses, the toast can be clicked to open a modal window with detailed publish information.
Detailed publish results in a modal window are shown only to the user who initiated the publish action. Other users are informed about the publish completion solely through a toast notification.
Publish button behavior in Company list
Publish options are also available in the Company list under the Admin section and are controlled through a split-button located in the page header.
The primary action of the split-button starts publishing all companies with unpublished changes. The secondary (hidden) action allows you to republish all companies, including those without any detected changes.
You can choose to:
- Publish all – available by clicking the chevron on the split-button, publishes all listed companies, including those that were already published. A confirmation pop-over is displayed showing all companies will be published and allowing you to confirm or cancel the action.
- Publish – triggers publishing only for companies with pending changes. A confirmation pop-over is displayed showing how many companies will be published and allowing you to confirm or cancel the action.
Publishing can also be triggered for an individual company directly from its corresponding Publish button, which reloads the cache for that specific company.
If all companies are already up to date, the split-button is replaced with a secondary Publish all button, which triggers only a full republish.
Once publishing starts, a toast notification appears at the bottom of the screen showing the current progress, including which company is being published and the total number of companies, along with a loading indicator. At the same time, the split-button changes into a single button displaying a loader to indicate that publishing is in progress.
After the publishing process is completed, a toast notification displays the result:
- Success – All changes were published successfully.
- Warning – Publishing completed with warnings. Potential configuration issues were detected but do not affect functionality.
- Error – At least one company was not published successfully.
The toast notification is visible for a limited time and disappears automatically after a few seconds. Hovering over the toast pauses the timeout, allowing the message to be read in full. For Warning and Error statuses, the toast can be clicked to open a modal window with detailed publish information for each company.
Additional columns provide further information about the publishing status:
- Last Publish – Displays the date and time of the last successful publish for the selected company.
- Published Tasks – Shows the number of successfully published tasks out of the total number of publishable tasks.
- Published Endpoints – Indicates the number of successfully published endpoints out of the total number of publishable endpoints.
Publish messages
Once the publish is confirmed, another modal window will appear, showing the publish status (either Published or Failed) along with additional details. A list of Detected issues may also be presented within this modal window, where warning messages are highlighted in orange and error messages are in red. Each of these messages provides an in-depth explanation and includes a hyperlink directing to the relevant entity involved.
List of publish statuses and messages
| Status | Message |
|---|---|
| Publish failed (empty) | There is nothing to publish. There are no configurations yet. |
| Publish failed (unchanged) | Nothing has changed in the published configurations. The published configurations still contain (task count) tasks(s) and (endpoint count) endpoint(s) published at (date and time). |
| Publish success updated | The published configurations were fully cleared and all your configured items were successfully published. |
| Publish success updated with warning | The published configurations were fully cleared and all your configured items were successfully published. Check the published items with warnings below pointing to incorrect configurations. |
| Publish success updated with errors | The published configurations were fully cleared and all correctly configured items were successfully published. The items listed as errors were skipped from publishing and need to be fixed first. |
| Publish success updated with errors and warning | The published configurations were fully cleared and all correctly configured items were successfully published. The items listed as errors were skipped from publishing and need to be fixed first. Check the published items with warnings below pointing to incorrect configurations. |
| Unknown | The publish command was executed by an admin user without direct access rights. Although the cache reload was initiated, verification of the result is not possible. |
Cache publish updates the entire cache with valid Tasks / Endpoints only. Omitted items are displayed as Error with explanations and links. Special cases are displayed as Warnings (see below). The overall status is always Success, except when nothing can be published. In such a case, the overall status is Error, and the cache is unchanged.
Special cases - Warning
- Publishing endpoint with the bound non-runnable task.
- Publishing ASYNC endpoint with a defined output.
- Publishing endpoint with defined output schema but without defined output step (or mapping).
- The Agent connected to the Task is offline.
Publish does not apply changes to Log hub rules and Application settings
Log hub rules on the admin level and on the company level as well as the Application settings have their own Apply buttons for the application of the changes made in these particular areas.
Config changes without the need to Publish
Runability, Orchestrator, Max instances, Priority