Skip to content

Buttons for executing scripts (script buttons)

You can create buttons in the UserClient that can be used to execute user-defined scripts. The scripts are configured in the AdminClient, Script management module.

Example: You want to execute UserClient to transfer a version of octoplant to another software.

Two types of scripts can be executed via buttons:

  • Component-independent scripts are executed exactly once, regardless of which component is selected.
  • Component-specific scripts expect a component to be selected and are executed once per selected component after a click. A component-specific interface file is written in each case.

The following rules apply when creating the scripts:

  • At least one ScriptButton1.bat or ScriptButton1.exe script must be provided.
  • A maximum of 3 scripts can be configured independently of each other. These are named as follows: ScriptButton1.bat/.exe, ScriptButton2.bat/.exe, ScriptButton3.bat/.exe
  • The label, the tooltip and the icon for the button can be configured individually and language-independently, e.g. via a script configuration file. You can specify the label and tooltip in multiple languages.
  • The executability and visibility of the buttons can be restricted for certain user groups.

The buttons are only displayed in the UserClient if a corresponding script has been defined and the user has the corresponding rights.

The script is started and executed by clicking on the corresponding button. A dialog with information on which script is being executed is displayed.

  • If the script is executed successfully, the dialog is closed and the UserClient is updated to take possible changes into account.
  • If the script returns an error, an error message is displayed.
  • If the script returns information, this is displayed in a dialog.