Common Configuration Buttons (5.0)
Configurations that are created in the platform share a button bar that allows interactions and operations to be performed. These common configuration buttons apply to all configuration types except Workflows. Some configuration types may have additional buttons, and those are described in detail in each separate section of the documentation. For more information, see the documentation for each configuration type.
Note!
Save prompt behavior
Each configuration stores data in a serialized format. When you enter or exit Edit mode, the system captures the current state of this data and compares it to identify changes. Updates, such as bug fixes or new features, can change the internal format. After a version upgrade, you might see a save prompt when you open a configuration in Edit mode, even if you do not see any visible changes in the user interface. The system prompts you to save so that the configuration matches the latest internal format.
A workflow configuration contains several individual configurations, for example, agent configurations or workflow properties configurations. Because of this, you might receive multiple Save prompts if you open different configurations from the Workflow Template in Edit mode at different times.
Changes to individual configurations is relatively rare when systems are only a few versions apart.
Button | Description |
|---|---|
Click this button to edit the configuration. Note! Each configuration will only allow 1 user to edit it at any one time. While editing the configuration, it will be locked to the user's session. To release the lock, you must navigate away from the configuration to another page. It is advised not to close the browser tab without navigating away from the configuration first as this will cause the lock to stay in place until timeout. | |
Click this button to create a new configuration of the same type. | |
Click this button to open another configuration. | |
Click this button to save changes to an existing configuration. | |
Click this button to open the Save As dialog where you can select in which folder you want to save the configuration and enter the name you want to save it as. | |
Click this button to define permissions for the configuration. | |
Click this button to check if the configuration is valid. | |
Click this button to see which other configurations the configuration uses, or is used by. | |
Click this button to view the version history of the configuration. | |
Click this button to access the user documentation. |
See the different tabs below for examples of the Open, Save As, Permissions, References and History dialogs when using the previous buttons in the table above.
Select Workflow
This dialog is displayed when the users click the Open button in the configurations screen. It allows previously saved configurations to be loaded in the current instance. – the name permissions and owner are displayed in individual rows.
You can use the Filter Name field to easily find a given instance.
Save As
This dialog is displayed when the users click the Save As button in the configurations screen. it allows the current configuration to be saved to a designated folder.
You assign a Name and an optional version comment in the fields.
Permissions
This dialog is displayed when the users click the Permissions button in the configurations screen. It is used to set individual permissions based on the users' role – the owner itself, and the associated access groups in both read, write and execute permissions.
The Browse… option allow the users to select the designated user from a dialog box called User Selection.
Reference Viewer
This dialog is displayed when the users click the References button in the configurations screen.
It displays three tabs that show important information in relation to all references that are part of the current configuration. The Used By tab lists all references that are currently used in the configuration, and the Users list the active users that have access to these references. The Access shows the access group and the listed users under them.
History
This dialog is displayed when the users click the History button in the configurations screen.
It shows the available Version digit, the Modified date, Modified by, and the Comment which lists an optional comment for the listed version.