IMPORTANT: After creating and editing the script, you should test compiling the script. Compile the scripts in the script library for this script to take effect.
NOTE: You can find detailed examples for syntax and usage of scripts on the installation medium in the QBM\dvd\AddOn\SDK\ScriptSamples directory.
To create a new script
-
In the Designer, select the Script Library category.
-
Start the Script Editor using the Create a new script task.
-
Edit the main data.
Table 140: Script main data
|
Script |
Name of the script. Prefix custom scripts with CCC_. |
|
Description |
Detailed description about the script's function |
|
Script code |
One Identity Manager scripts are written in VB.Net syntax, which allows all VB.Net functions to be used. The values to be edited are given as preprocessor instructions. |
|
Locked |
Specifies whether the script is locked and therefore may not be used. Locking the script is useful, for example, if it is currently being edited. |
To edit a script
-
In the Designer, select the script in the Script Library.
-
Select the Edit script task.
-
Edit the script main data.
Detailed information about this topic
IMPORTANT: After creating and editing the script, you should test compiling the script. Compile the scripts in the script library for this script to take effect.
To copy an existing script
-
In the Designer, select the script that you want to copy from the Script Library category.
-
Select the Copy script task.
-
In the Copy script dialog, check the following information and correct if necessary.
Table 141: Copying a script
|
Old script name |
Name of the copied script. |
|
script |
The name of the new script is made up of the CCC_ prefix and the name of the old script. You can change the name. Prefix custom scripts with CCC_. |
|
Script code |
The script code from the original is copied over. If necessary, you can modify the script code of the script to copy beforehand. |
-
To create the copy, click OK.
-
In the Script Editor, edit the main data of the script.
Related topics
You can use the Script Editor to test a script.
To test a script
-
In the Designer, select the script in the Script Library.
-
Select the Edit script task.
-
Select the View > Test script menu item.
-
In the Test script view, select the script from the menu and modify the parameters as required.
All the parameters to be passed to the script are displayed with their data types. You can edit the values. You can also predefine values for the Base and Value script base class variables as input parameters and use these in the script.
-
Use Options to select one or more of the following options for running the test.
-
Use main database connection: Specifies whether the script test is tested against the main database or an internal SQLite database. Scripts that relate to the application part of the One Identity Manager data model should always be tested with the main database. Scripts for system parts can be test with against the main database or the internal SQLite database.
-
Use transaction: Specifies whether the script is run within a transaction with subsequent rollback or whether the script is run immediately against the database.
-
Record SQL log: Specifies whether the database actions should be recorded in an SQL log while the script is running. The output is displayed in a separate dialog window. The time to run the script is output in addition to the statement run.
-
Select the Start button to run the script test.
The test results are displayed in the Result field after the script has been run.
Related topics
If you have created a new script, you need to compile it. The script cannot be generated until it has been compiled. You can test script compilation in the Script Editor.
To test compiling scripts
-
In the Designer, select the script in the Script Library category.
-
Select the Edit script task.
-
Start compilation with the icon 
, the Script > Compile script menu item or F9.
All scripts are converted during compilation. The assemblies are created and placed on the workstation where generating will take place. During the conversion, the script code is tested for validity. This process may required some time.
Error messages are sent to the Compiler errors view. A double-click on the error message takes you straight to the corresponding line in the script code view where you can edit it. It can be modified at this point.
IMPORTANT: Once you have tested the script it needs to be added to the One Identity Manager database and compiled with the Database Compiler. For more information, see the One Identity Manager Operational Guide.
