OnUcOpen
Scripting applications called by this interface serve to carry out an action if the UserClient or EasyClient was opened.
Example 1: When the UserClient opens, all projects belonging to the user will be checked out.
Example 2: The script prevents the UserClient from opening because the of changes happening on the server. In this case, a warning will appear.
Command lines for this scripting application
Without agents:
| OnUcOpen.exe /ConfigFileW:[absolute path to the interface file] /rd:[path to the server archive] /at:s |
With agents:
| OnUcOpen.exe /ConfigFileW:[absolute path to the interface file] /rd:[path to the agent archive] /at:s |
Description of the interface file
[Common]
Only the following keys are used for this scripting interface:
- RootDirAdmin
- DirPrjData
- Language
- ComputerName
The keys is described in Global interface file sections.
[Result]
The general keys of this section are described in Global interface file sections.
| INI key | I/O | Description |
|---|---|---|
| SuppressOpen | O |
Displays whether opening the UserClient is connected with a script Possible values are Y and N . The default value is N. |
| SuppressOpenText [optional] | O |
If the script prevents the UserClient from opening, a message appears. In the message, it is possible to use the SuppressOpenText to add a configurable text |
| Related topics |
|---|
| Global interface file sections |
| UserClient |