Chat now with support
Chat with Support

Identity Manager 8.1.5 - Configuration Guide

About this guide One Identity Manager software architecture Customizing the One Identity Manager default configuration Customizing the One Identity Manager base configuration One Identity Manager schema basics Editing the user interface
Object definitions for the user interface User interface navigation Forms for the user interface Statistics in One Identity Manager Extending the Launchpad Task definitions for the user interface Applications for configuring the user interface Icons and images for configuring the user interface Using predefined database queries
Localization in One Identity Manager Process orchestration in One Identity Manager
Setting up Job servers Configuring the One Identity Manager Service Handling processes in One Identity Manager
Tracking changes with process monitoring Conditional compilation using preprocessor conditions Scripts in One Identity Manager
Using scripts Notes on message output Notes on using date values Using dollar ($) notation Using base objects Calling functions Pre-scripts for use in processes and process steps Using session services Using #LD-notation Script library Support for processing of scripts in Script Editor Creating and editing scripts in the Script Editor Copying scripts in the Script Editor Testing scripts in the Script Editor Testing script compilation in the Script Editor Overriding scripts Permissions for executing scripts Editing and testing script code with the System Debugger Extended debugging in the Object Browser
Reports in One Identity Manager Adding custom tables or columns to the One Identity Manager schema Web service integration SOAP Web Service One Identity Manager as SPML provisioning service provider Processing DBQueue tasks One Identity Manager Service configuration files

Editing process step parameters

To edit process step parameters

  1. In the Designer, select the process in the Process Orchestration category.

  2. Start the Process Editor with the Edit process task.

  3. Click on the element for the process step in the process document.

  4. Select the Parameter view.

    This displays all the parameters defined for the process.

  5. Check whether the required parameters are assigned and edit the parameters.

    You can add, delete, or edit parameters from the toolbar.

    TIP: Click an entry to edit the parameter value directly.

    Table 108: Meaning of icon used
    Icon Meaning

    Mandatory process task parameter

    Optional process task parameter, which is assigned to a process step.

    Optional process task parameter, which is not assigned to a process step.

Related topics
  1. Editing process step parameters
  2. Allocating parameter values

Properties of process step parameters

Table 109: Properties for parameters
Property Meaning

Name

Name of the parameter.

NOTE: You should not change the name of a parameter. The special parameters of the HandleObjectComponent process component are an exception to this rule.

Hidden

This option specifies whether the parameter is shown in the One Identity Manager Service log file and in the Job Queue Info program. Values for hidden parameters are shown as <HIDDEN>.

NOTE: Users with the program function Option to see the values of hidden parameters in Job Queue Info (JobQueue_ShowHiddenParameters) can view the hidden parameters in the Job Queue Info. Assign the appropriate permissions group to the program function.

Encrypted

Specifies whether the parameter is encrypted when it is passed if the database is encrypted. Encrypted parameters are shown as <hidden> in the One Identity Manager Service log file and in the Job Queue Info program.

NOTE: If the option is already set in the parameter template, the parameter must also be encrypted when it is passed.

Contains encrypted components

Specifies whether encrypted sequences are contained in this value. Use this option, if partially encrypted sequences such as passwords are to be passed in complex parameters, for example Windows PowerShell scripts. Encrypted parts of a parameter are shown as <Hidden> in the One Identity Manager Service log file and in the Job Queue Info program.

Value template

Define value templates in VB.Net syntax. When a parameter is added, the value template is copied from the parameter template.

TIP: To restore the default value template, select the button in View | Parameter and click the Template button in the Edit parameters view.

Type

Type of parameter. The IN, OUT and INOUT values are permitted.

Parameters of the OUT or INOUT type are parameters that a process component can use to output a value. This value is then available in all subsequent process steps in the process and can be used as a value for parameters of the IN type.

Related topics

 

Allocating parameter values

Define value templates in VB.Net syntax. The following statements can be used for allocating values:

  • None

  • Columns of an object or columns of an object connected by a relation

    Syntax:

    Value = $<column name>:<data type>$

    Value = ${FK(<foreign key column>).}column name>:<data type>$

    Example:

    Value = $Lastname$

    Value = $PasswordNeverExpires:bool$

    Value = $FK(Ident_Domain).Description$

  • Parameter from the optional parameter collection

    Syntax:

    Value = $PC(<parameter name>)$

    Example:

    Value = $PC(SRCUID_Application)$

  • Out-Parameter

    Parameters of the OUT or INOUT type are parameters that a process component can use to output a value. This value is then available in all subsequent process steps in the process and can be used as a value for parameters of the IN type.

    When you use OUT parameters, you need to ensure that they contain data at runtime. Alternatively, when the text is processed "&OUT(<parameter name>)&" is entered, which means that the variable will not be replaced.

    Syntax:

    Value = "&OUT(<parameter name>)&"

    Example:

    Value = "&Out(FileSize)&"

  • Global variables allocated by the set-up program

    Syntax:

    Value = Variables("<variable name>")

    Example:

    Value = Variables("GENPROCID")

    Value = Variables("FULLSYNC")

  • The local variables of the process step or of the process generated by the pre-script

    Syntax:

    Value = values("Name")

    Example:

    Value = Values("FirstHomeServer")

  • Querying configuration parameters

    The full path for the configuration parameter must always be entered.

    Syntax:

    Value = Session.Config().GetConfigParm("<full path>")

    Example:

    Value = Session.Config().GetConfigParm("TargetSystem | ADS | PersonAutoDefault")

  • VB.Net

    Enter any statements in VB.NET syntax.

Related topics

Events for processes

Events are defined to assign processes to objects. Processes cannot be generated until a link has been created between object, event, and process. The following predefined events are available. These are described in the following table.

Table 110: Predefined events
Event Comment

Insert

Event created when an object is created. Available for all objects.

Update

Event created when an object is changed. Available for all objects.

Delete

Event created when an object is deleted. Available for all objects.

Execute

The event is triggered by the DBQueue Processor when the time of execution of a deferred operation is reached.

Assign

The event is triggered when many-to-many assignments are added.

Remove

The event is triggered when many-to-many assignments are removed.

Other events are provided by the Customizer. You can define other custom events to trigger processes.

Detailed information about this topic
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating