Script buttons

You can set up buttons in the UserClient that can be used to execute user defined scripts. To configure scripts, go to the Script management module in the AdminClient.

Example: You want to execute a script using a button in the UserClient, in order to transfer a version (created in octoplant) to another software

Two types of scripts can be executed using buttons:

• Component independent scripts are executed only once regardless of which component is selected
• Component specific scripts require for a component to be selected and, after a click, are executed once for each selected component. In each case, a component specific script interface file is written

To create scripts, the following rules apply:

• There needs to be at least oneScriptButton1.batorScriptButton1.exescript available
• A maximum of three scripts (independent of each other) can be configured. These scripts need to be given the following names:ScriptButton1.bat/.exe,ScriptButton2.bat/.exe,ScriptButton3.bat/.exe
• By using a scripting configuration file, for example, the caption, the tooltip, and the icon for the button can be configured individually and are language independent. The caption and the tooltip can be given in multiple languages
• It is possible to limit the right to execute and the right to view this button to certain user groups

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

The script is started and executed by clicking on the button. Upon clicking the button, a dialog containing information about which script is being executed will be displayed.

• If the script is successfully executed, the dialog will close and the UserClient will update, in order to allow for changes
• If an error occurs, an error message will be displayed
• If the script returns information, this will be displayed in a dialog

Related Topics

• UserClient
• AdminClient -> Module Script management