Process - Standard service tasks in Identity Manager

searchConfigName

Defines the search configuration that should be used to count objects.

During process execution the user must have the permission to execute the search configuration. It is possible to use a search configuration that searches over multiple levels.

minCount

-

The minimum number of objects that should be found.

If the search finds less than minCount objects, the action will trigger an ErrorBoundaryEvent with error code "uniquenessTestFailed". Although neither minCount nor maxCount are mandatory, at least one of them must be specified.

maxCount

-

The maximum number of objects that should be found.

If the search finds more than maxCount objects, the action will trigger an ErrorBoundaryEvent with error code "uniquenessTestFailed". Although neither minCount nor maxCount are mandatory, at least one of them must be specified.

resultVariableName

-

resultCount (used if nothing is specified)

Specifies where the number of found objects will be stored in the data map. 

The value is stored whether the condition is met or not. If no resultVariableName is specified, 'resultCount' is used as a default name.

<Datapool_Field>

-

For configuring search fields, add a parameter for each search field. The name of the parameter should be the full name of the datapool field. The value has to contain the filter condition and value, separated by a colon symbol.

For example:

EQUALS:${Person_PersonnelNumber}

GREATER_THAN:${now}

CONTAINS:st

If the underlying data source of the search configuration does not allow to query just the number of result objects, only as less objects as possible are fetched, but enough to find violations of minCount or maxCount. If the number of found objects equals to the upper limit, that was searched for, it is not possible to decide whether there are more objects. In such cases a hint is logged in debug mode:

"The search has been restricted to 2 object(s) for performance reasons, but there might exist more objects".

For more information, see <Datapool_Field> under Process: Execute Search Task.

resultVariableNameZipFile

Fieldname in the datamap where the builded zipFile is written to.

resultVariableNameZipName

-

Fieldname in the datamap where the name of the zipFile is written to.

zipfileName

Example value:

• ${Person_LastName}_${Person_FirstName}_Binaries.zip

How the zipFile shall be named. fileExtension like '.zip' is needed.

coreObjectDescriptorList

coreObjectDescriptor which contains a list of CoreObjects with binaryData

<name of the zipFile-Entry>

 (minimum 1)

<name of binaryField to save into zipFIle>

Example value:

• ${Person_LastName}_${Person_FirstName}_Photo.jpg
  ← Person_Photo

• ${Person_LastName}_${Person_FirstName}_Softtoken.p12
  ← Person_Softtoken

• Additional parameter, added with "+"

• Combination zipEntryName ← BinaryFieldName

userNameOutputField

-

userinfoUsername

The output field of the datamap which will contain the user name.

userFullNameOutputField

-

userinfoUserFullName

The output field of the datamap which will contain the user's full name.

userIdOutputField

-

userinfoUserid

The output field of the datamap which will contain the user id.

userIpAdressOutputField

-

userinfoIpAddress

The output field of the datamap which will contain the user's IP address.

userAuthProfileTypeOutputField

-

userinfoAuthprofileType

The output field of the datamap which will contain the users AuthProfileType (Enum is passed).

userExplorerInstanceIdOutputField

-

userinfoExplorerInstanceId

The output field of the datamap which will contain the user's explorer instance ID if logged in through explorer.

userUsspInstanceIdOutputField

-

userinfoUsspInstanceId

The output field of the datamap which will contain the user's Smart ID Self-Service instance ID if logged in through Smart ID Self-Service.

userRolesOutputField

-

userinfoUserRoles

The output field of the datamap which will contain the user's assigned roles as a list. This is not meant to be used for the GUI and may result in issues. Use this, for example, in gateways like this:

${userinfoUserRoles.contains("Administrator") == true}

userSamlTokenIDOutputField

-

userinfoSamlTokenID

The output field of the datamap which will contain the user's SAML Token ID.

userSamlIssueInstantOutputField

-

userinfoSamlIssueInstant

The output field of the datamap which will contain the user's SAML IssueInstant.

userLocaleOutputField

-

userinfoLocale

The output field of the datamap which will contain the user's selected Locale.

referenceField

The field to be deleted in secret field store.

scriptName

The name of the script.

searchConfigName

-

Defines the search configuration that should be used to count objects.

During process execution the user must have the permission to execute the search configuration. It is possible to use a search configuration that searches over multiple levels.

Note: The binary data fields will not be loaded into the process map unless the search configuration has at least one binary data field in the result columns.

maxCount

The maximum number of objects that should be found.

resultVariableName

-

• CoreObjectDescriptorList

Specifies the name of a variable of the data map, where the CoreObjectDescriptorList of the found objects is stored.

copyValuesOfFirstResult

-

Valid values:

• true

• false (default)

This parameter decides whether the first found object is put completely to the map (true) or if the CoreObjectDescriptorList is put to the map (false). If set to true, resultVariableName will be ignored. maxCount will be ignored too and set to 1.

fullResultListField

-

<variableName>

Variable in which the full search result will be stored inside the process map. Will be ignored if it is empty.

TargetPrefix

-

<Prefix>

Example: Manager_

If the found objects fields should be added to the process map with a special prefix. It replaces the <Datapool_>, which is otherwise at this position. With this function, conflicting entries can be avoided.

Example: Instead of "Person_Email" the data map will get an additional entry: "Manager_Email".

sortColumn

-

<ColumnName> Example: FirstName

This parameter is the column name of the dataset, which is taken to order the search result.

sortOrder

-

Valid values:

• ASC (default)

• DESC

Combo box to select if the search result is ordered ascending or descending. Default is ascending.

<Datapool_Field>

-

<CONDITION>:<value>

Examples:

• EQUALS:true

• STARTS_WITH:${processVariable}

Valid CONDITIONS:

• EQUALS

• NOT_EQUALS

• GREATER_THAN

• GREATER_EQUALS

• LESS_THAN

• LESS_EQUALS

• STARTS_WITH

• ENDS_WITH

• CONTAINS

• SOUNDEX

• EMPTY

• NOT_EMPTY

• The datapool field adds and overwrites filters to the existing filters in the searchConfiguration.

• Allowed multiple times, for each search field of the search config. You can add several datapool_fields with the same name, for example, birth date fields to create a date range. 

• Filter condition and value shall be separated by a colon symbol, like this, <CONDITION>:<value>.

  • Drag and drop a datapool-field into the Service Task definition, to create a filter, for example, OrderNumber, see (1) in the screenshot.

  • Add the datapool field name as a prefix, for example, SclmDpOrder_OrderNumber, see (2) in the screenshot. Every filter that is added as <Datapool_Field> MUST exist in the used SearchConfig, otherwise it will not be added when the search task is executed. When adding the new parameter and its name, make sure to use the correct prefix for your configuration. 

  • For the value, a condition is needed, in the screenshot "EQUALS".
    

    

You can also use the conjunctions AND and OR. For example:
EQUALS:Active _OR_ temporary.inactive

searchUniqueId

-

<value>

Example: ${<Datapool>_Id}

It is the Unique ID (<Datapool>_Id) used to store records in the underlying database. The value can be a literal or a JUEL expression. This filter always uses equals to identify the record. In case of a related search, this is used to identify the Source Object.

resultUniqueId

-

<value>

Example: ${<Datapool>_Id}

It is the Unique ID (<Datapool>_Id) used to store records in the underlying database. The value can be a literal or a JUEL expression. This filter always uses equals to identify the record. In case of a related search, this is used to identify the Result Object.

dataPoolName

The datapool name of the underlying batch order.

resturnField

The name of the variable containing all the possible states (which were found).

EntityDataPool

Person

The name of the entity's datapool.

EntityAttribute

Email

The attribute of the entity that must match a certain value.

EntityAttributeValue

${Person_Email} or ${user.Person_Email}

The value that EntityAttribute must match. Most of the time, an expression will be used here. Also special expressions like ${user.*} are possible, to use values from the authenticated User or from system.properties (${sysprop.*}

EntityCoreObject

The core template of the entity. This limits the search to objects of this core template.

EntityCoreObjectIdField

coreObjectId

The field in which the CoreObjectId is added in the process map.

EntityCoreObjectDescField

coreObjectDescriptor

The field in which the CoreObjectDescriptor is added in the process map.

EntityRolesField

roles

The field in which the roles of the object is added in the process map.

ExclusiveLoadFields

FirstName,LastName,Email

If not the complete dataset should be loaded, only the ones defined here are loaded/added in the process map.

TargetPrefix

Manager_

If the found objects fields should be added to the process map with a special prefix. It replaces the <Datapool_>, which is otherwise at this position. With this function, conflicting entries can be avoided.

Example: Instead of "Person_Email" the data map will get an additional entry: "Manager_Email".

certificateDataPoolName

Certificate

The name of the certificate's datapool.

certificateDataFieldName

Data

The name of the field of the certificate's datapool that holds the binary certificate.

certificateAttribute

Example value:

• SAN_UPN

The field of the certificate whose value must match the entity. SAN values are prefixed with "SAN_". Possible values: any one of de.nexus.pkiutils.certificate.DNs or any one of de.nexus.pkiutils.certificate.SANs. Currently that allows the following possibilities: DN_C, DN_CN, DN_DNQ, DN_E, DN_L, DN_O, DN_OU, DN_SN, DN_ST, DN_UID, DN_STREET, DN_INITIALS, DN_POSTAL_ADDRESS, DN_POSTAL_CODE, DN_TELEPHONE_NUMBER, DN_TITLE, DN_SURNAME, DN_GIVENNAME, SAN_EMAIL, SAN_UPN, SAN_DNS, SAN_IP, SAN_URI, SAN_GUID, SAN_RID.

entityDataPoolName

Person

The datapool of the entity to loadCertificateMatchingEntityParameterizedTask

entityDataPoolFieldName

Email

The name of the field of the entity's datapool that must match the certificate's field value.

entityCoreTemplateName

-

Person

The core template of the entity. This limits the search to objects of this core template.

targetFieldName

Name of systemProperty to load

Combination of target field and system property.

A system property is defined of <contextid>.<propertyName>.

loggerName

Any String, but typically a java package optionally followed by a class name.

Example values:

• MyLogger

• de.nexus

• de.nexus.MyClass

In the log4j configuration, defined loggers have a name, typically a package name or a class, however any String is valid. This attribute specifies to which logger this task will write. You can use this to route the log message to a file, the console or any other appender.

loglevel

Valid values:

• TRACE

• DEBUG

• INFO

• WARN

• ERROR

Use this to describe the severity of the log entry. It will appear in the logfile. Loggers and/or appenders typically ignore entries under a configurable threshold.

message

Any String or JUEL expression.

Example values:

• This is a message

• ${Person_Name} just executed this task

• ${Person_Name.toUpperCase()} just executed this task

The message that will be logged. You can use Expression Language and methods from the String API. Expressions will be evaluated against the process map.

ignoreKeyNotFound

Valid values:

• true

• false

If this is set to true, expressions from the message that can't be resolved to a key in the process map will be ignored. If it is set to false, an exception will be thrown.

OutputVariableName

Specifies the name of a variable of the data map, in which the process instance ID should be put. 

EntityDatapoolName

The name of the entity's datapool.

variableName

The name of the variable, which should be removed from the process map

variableName

Datapool_Field1

variableName2

Datapool_Field2

variableName3

Datapool_Field3

...

...

firstSecretFieldName

String value

UID of the first secret field

secondSecretFieldName

String value

UID of the second secret field

resultFieldName

String value

Default value: secretsAreEqual

The name of the variable in the processMap that will contain the result of the comparison.

variableName

The name of the variable whose value should change in the process map

variableValue

-

The new value for the variable. It may contain JUEL expressions like ${Person_FirstName}.

setToNull

-

Valid values:

• true

• false

If set to true, the variable's value will be set to null.

setToEmptyString

-

Valid values:

• true

• false

If set to true, the variable's value will be set to an empty string.

searchConfigName

Select in drop-down list

The searchConfig, which is executed to search the list of X509-Certificates

encCertResultCoreTemplate

Select in drop-down list

The name of a CoreTemplate to store the found encryptionCertificate in the Database, if it does not already exist with this CoreTemplate name.

The name must be based on CertificateDAO-dataPool

If the certificate already exists with a different CoreTemplate name, a second entry will be saved with the encCertResultCoreTemplate. It is recommended to use these additional entries only temporarily and remove them after use.

encCertResultDescriptorName

String value

The name of the variable in the processMap where the found encryptionCert is put as CoreObjectDescriptor

X509ListFieldInSearchResult

String value

The field in the result of the searchConfig with the list of certificates.

This field should be a multi-value binary field in the datapool (LDAP-datapool).

<Datapool_Field>

-

Additional Filter-Field for the searchConfig, added with '+'-Button

For more information, see <Datapool_Field> under Process: Execute Search Task.

setEmptyAsNull

Valid values:

• true

• false (default)

Defines if a variable without a value should stay empty or null.

<variableName>

-

<variableValue> 

The name and value of the variable. It can be also a combination of expressions that gets resolved from current values of the process map.

Example:

• Person_Name

• MyTestVar

• ${part1} ${part2}

<variableName2> 

-

<variableValue2> 

...

-

...

Fill in as many variables as needed.

variableName

Example value:

• Text string, free of choice

Field in the process data map whose value (or list of values) is checked with the regular expression.

resultVariableName

Example value:

• Text string, free of choice, example: "ProcessVarCNRegexResult"

Field in the process data map where the result of the validation is saved as Boolean ("true" when regex matches, "false" if not).

regex

Example value:

• See examples in drop down list

• Can also be edited free

The regular expression, which the field value must match.

variableMustExist

-

Valid values (Boolean):

• true

• false (default at design time)

If true, validation fails if map has no entry for the variable described in variableName.

delimiter

-

Example values:

• "," (colon)

• ";" (semi colon)

Can be defined if the value in variableName contains a list which is separated with a delimiter. For example: "value1; value2; value3"

If delimiter is defined, the value is treated as a list of multiple values, and every value is validated.

trim

-

Valid values (Boolean):

• true

• false (default at design time)

If true, any whitespace before and after the value in variableName is removed before validation.

Example:

• if " value " then "value" is validated. Every value in a list is trimmed, if delimiter is defined.

caseSensitive

-

Valid values (Boolean):

• true (default at design time)

• false

If true, the validation does differentiate between lowercase and uppercase characters.