Overriding scripts
You might want to label scripts for overriding if there are limits to how much you can modify default scripts. Scripts that can be overwritten are labeled with the overridable property.
NOTE: Only the default scripts that are supplied can be overriden. Custom scripts cannot be overridden because these are saved in a Custom scripts script class.
To override a script
-
In the Designer, select the script to override in Script Library > Overridable scripts.
-
Select the Copy script task.
-
In the Copy script dialog, edit the following information.
-
To create the copy, click OK.
-
In the Script Editor, replace the overridable property with overrides in the script header.
-
Modify the other script code accordingly to suit your requirements.
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.
Syntax example
Public overridable Function My_Function() as Boolean
'script code of the original version
End Function
Public overrides Function My_Function() as Boolean
End Function
Related topics
Permissions for running scripts
The basic permissions for running scripts are granted to the logged in user through the program feature Allow the starting of arbitrary scripts from the frontend (Common_StartScripts).
If a script is assigned a program function (QBMScriptHasFeature table), users can only run this script if they have the necessary permissions groups. An error occurs if the user does not own this program function and tries to run it.
Detailed information about managing permissions and running scripts through program functions can be found in the One Identity Manager Authorization and Authentication Guide.
Editing and testing script code with the System Debugger
The System Debugger gives you the opportunity to test scripts, templates, formatting rules, methods, and table scripts. Visual Studio debug and edit options are available to you.
The following software must be installed to use the System Debugger:
NOTE: To use the System Debugger with privileges without starting Visual Studio, you must install the One Identity Manager components in a local directory which is not controlled through user accounts.
Detailed information about this topic
Loading the script library
When you call the System Debugger, a SystemLibrary.sln solution template with the SystemLibrary solution is loaded in theVisual Studio for editing and testing the scripts.
The following projects are defined in the solution.
Table 141: Solution project files
|
Methods |
Methods.vb |
This script file contains all methods. |
|
Scripts |
VIScripts.vb |
This script file contains all predefined scripts from the model components. |
|
VIDScripts.vb |
This script file contains all predefined scripts from the system components. |
|
CustomerScripts.vb |
This script file contains custom scripts. Add new scripts here. |
|
SystemDebugger |
Main.vb |
Start up project. |
|
Tables |
Tables.vb |
This script file contains all the table scripts. |
|
Templates |
Templates.vb |
This script file contains all templates and formatting scripts. |
To load the system library
-
Run the SystemLibrary.sln file in the One Identity Manager installation directory.
-
Check whether SystemDebugger is entered in Visual Studio as the start project.
-
Start the solution with F5 in Visual Studio.
-
Connect to the database.
-
Check the solution file directory and the options for creating the script library.
|
Export system scripts |
Specifies whether predefined scripts are loaded into the system library. |
|
Export custom scripts |
Specifies whether custom scripts are loaded into the system library. |
|
Export locked scripts |
Specifies whether only active scripts or also locked scripts are loaded from the script library. |
|
Update project references |
Specifies whether references used in scripts are also loaded. |
|
Create backups of existing files |
Specifies whether backups of existing files are made. |
-
Click OK.
The script library files are filled with data from the database.
-
Confirm reloading of each project in Visual Studio.
-
Start the solution with F5 in Visual Studio.
The source code generated for the solution is compiled.
-
Reconnect to the database.
Starts the System Debugger.
Related topics
