OnUcOpen¶
Script applications that are called by this interface are used to execute an action when the UserClient or the EasyClient is opened.
Example 1: When the UserClient is opened, all projects belonging to a user are checked out.
Example 2: The script prevents the UserClient from being opened, for example because work is currently being carried out on the Server. In this case, a message appears.
Command lines for this script application¶
Without agents:
OnUcOpen.exe /ConfigFileW:[absolute path of the interface file] /rd:[path of the server archive] /at:s
When using agents:
OnUcOpen.exe /ConfigFileW:[absolute path of the interface file] /rd:[path of the agent archive] /at:s
Description of the interface file¶
Section Common¶
Only the following keys of the [Common] section are output for this script interface:
- RootDirAdmin
- DirPrjData
- Language
- Computer name
The keys are described in General sections of the interface file.
Section Result¶
The keys of the [Result] section are described in General sections of the interface file.
Key | I/O | Description | Values | Default |
---|---|---|---|---|
SuppressOpen | O | Indicates whether the script should prevent the UserClient from opening. | Y/N | N |
SuppressOpenText [optional] | O | If the script prevents the UserClient from being opened, a message appears. A freely configurable text can be added to the message with the help of SuppressOpenText. |