This section contains detailed reference to all actions available using the Policy Builder interface.
Sends an add association command to the Identity Vault, with the specified association.
Select whether this action should be added to the current operation, or written directly to the Identity Vault.
Specify the DN of the target object or leave blank to use the current object.
Specify the value of the association to be added.
Adds a value to an attribute on an object in the destination data store.
Specify the name of the attribute.
(Optional) Specify the class name of the target object. Leave blank to use the class name from the current object.
Select whether this action should be added to, before, or after the current operation, or written directly to the destination data store.
Select the target object. This object can be the current object, or be specified by a DN or an association.
Select the syntax of the attribute value to be added.
Specify the attribute value to be added.
The example adds the destination attribute value to the OU attribute. It creates the value from the local variables that are created. The rule is from the predefined rules that come with Identity Manager. For more information, see Command Transformation - Create Departmental Container - Part 1 and Part 2.
Creates a new object of the specified type in the destination data store.
Specify the class name of the object to be created.
Select whether this action should be added to, before, or after the current operation, or written directly to the destination data store.
Specify the DN of the object to be created.
Any attribute values to be added as part of the object creation must be done in subsequent Add Destination Attribute Value actions using the same DN.
The example creates the department container that is needed. The rule is from the predefined rules that come with Identity Manager. For more information, see Command Transformation - Create Departmental Container - Part 1 and Part 2 from the predefined rules.
The OU object is created. The value for the OU attribute is created from the destination attribute value action that occurs after this action.
Adds the specified value the specified attribute on an object in the source data store. The target object is the current object, a DN, or an association.
Specify the name of the attribute.
(Optional) Specify the class name of the target object. Leave blank to use the class name from the current object.
Select the target object. This object can be the current object, or be specified by a DN or an association.
Select the syntax of the attribute value to be added.
Specify the attribute value to be added.
Creates an object of the specified type to be created in the source data store. Any attribute values to be added as part of the object creation must be done in subsequent Add Source Attribute Value actions using the same DN.
Specify the class name of the object to be added.
Specify the DN of the object to be added.
Specify the class name of the object to add to the source data store.
Specify the DN of the new object to add to the source data store.
Appends an element to a set of elements selected by the XPath expression.
Specify the tag name of the XML element. This name can contain a namespace prefix if the prefix has been previously defined in this policy.
Specify an XPath 1.0 expression that returns a node set containing the elements to which the new elements should be appended.
Appends text to a set of elements selected by the XPath expression.
XPath 1.0 expression that returns a node set containing the elements to which the new elements should be appended.
Specify the text to be appended.
Ends processing of the current operation by the current policy.
Removes the all values for the named attribute from an object in the destination data store.
Specify the name of the attribute.
(Optional) Specify the class name of the target object. Leave blank to use the class name from the current object.
Select whether this action should be added to, before, or after the current operation, or written directly to the destination data store.
Select the target object. This object can be the current object, or be specified by a DN or an association.
Clears any operation property current operation.
Specify the name of the operation property to clear.
Clears the Single Sign On credential, so objects can be deprovisioned. This action is part of the Credential Provisioning policies. For more information, see Section 4.0, Novell Credential Provisioning Policies.
Specify the DN of the repository object.
Specify the DN of the target users.
Specify the application credential that is stored in the application object.
Specify each login parameter for the application. The login parameters are the authentication keys stored in the application object.
Removes the all values of an attribute from an object in the source data store.
Specify the name of the attribute.
(Optional) Specify the class name of the target object. Leave blank to use the class name from the current object.
Select the target object. This object can be the current object, or be specified by a DN or an association.
Appends deep copies of a set of XML nodes selected by an XPath expression to a set of elements selected by another XPath expression.
Specify the XPath 1.0 expression that returns a node set containing the nodes to be copied.
Specify the XPath 1.0 expression that returns a node set containing the elements to which the copied nodes are to be appended.
Copies all occurrences of an attribute within the current operation to a different attribute within the current operation.
Specify the name of the attribute to be copied from.
Specify the name of the attribute to be copied to.
The example adds a User object to the appropriate group, Employee or Manager, based on Title. It also creates the group, if needed, and setup security equal to that group. The policy is Govern Groups for User Based on Title Attribute, and it is available for download from Novell’s support Web site. For more information, see Downloadable Identity Manager Policies.
The Clone Operation Attribute is taking the information from the Group Membership attribute and adding that to the Security Equals attribute so the values are the same.
Deletes an object in the destination data store.
Select whether this action should be added to, before, or after the current operation, or written directly to the destination data store.
Select the target object to delete in the destination data store. This object can be the current object, or be specified by a DN or an association.
Deletes the object in the source data store.
Select whether this action should be added to, before, or after the current operation, or written directly to the destination data store.
Select the target object to delete in the source data store. This object can be the current object, or be specified by a DN or an association.
Finds a match for the current object in the destination data store.
Select the scope of the search. The scope might be an entry, a subordinates, or a subtree.
Specify the DN that is the base of the search.
Specify the attribute values to search for.
Find Matching Object is only valid when the current operation is an add.
The DN argument is required when scope is “entry”, and is optional otherwise. At least one match attribute is required when scope is “subtree” or “subordinates”.The results are undefined if scope is entry and there are match attributes specified. If the destination data store is the connected application, then an association is added to the current operation for each successful match that is returned. No query is performed if the current operation already has a non-empty association, thus allowing multiple find matching object actions to be strung together in the same rule.
If the destination data store is the Identity Vault, then the destination DN attribute for the current operation is set. No query is performed if the current operation already has a non-empty destination DN attribute, thus allowing multiple find matching object actions to be strung together in the same rule. If only a single result is returned and it is not already associated, then the destination DN of the current operation is set to the source DN of the matching object. If only a single result is returned and it is already associated, then the destination DN of the current operation is set to the single character . If multiple results are returned, then the destination DN of the current operation is set to the single character �.
The example matches on Users objects with the attributes CN and L. The location where the rule is searching starts at the Users container and adds the information stored in the OU attribute to the DN. The rule is from the predefined rules that come with Identity Manager. For more information, see Matching - By Attribute Value.
When you click on the Argument Builder icon, the Match Attribute Builder comes up. You specify the attribute you want to match on in the builder. This examples uses the CN and L attributes.
Repeats a set of actions for each node in a node set.
Specify the node set.
Specify the actions to perform on each node in the node set.
The current node is a different value for each iteration of the actions, if a local variable is used.
If a node in the node set is an entitlement, then the for each implicitly performs an Implement Entitlement action.
The following is an example of the Argument Actions Builder, used to provide the action argument:
Sends a user-defined event to Novell Audit.
ID of the event. The provided value must result in an integer in the range of 1000-1999 when parsed using the parseInt method of java.lang.Integer.
Level of the event.
Specify User-defined string, integer, and binary values to include with the event. These values are provided using the Named String Builder.
The Novell Audit event structure contains a target, a subTarget, three strings (text1, text2, text3), two integers (value, value3), and a generic field (data). The text fields are limited to 256 bytes, and the data field can contain up to 3 KB of information, unless a larger data field is enabled in your environment.
The example has four rules that implements a placement policy for User objects based on the first character of the Surname attribute and generates both a trace message and a custom Novell Audit event. The Generate Event action is used to send Novell Audit an event. The policy name is Policy to Place by Surname and is available for download from Novell’s support Web site. For more information Downloadable Identity Manager Policies.
The following is an example of the Named String Builder, used to provide the strings argument.
Generate Event is creating and event with the ID 1000 and displaying the text that is generated by the local variable of LVUser1. The local variable LVUser1 is the string of User:Operation Attribute “cn” +” added to the “+”Training\Users\Active\Users1”+” container”. The event will read User:jsmith added to the Trainging\Users\Active\Users1 container.
Designates actions that implement an entitlement so that the status of those entitlements might be reported to the agent that granted or revoked the entitlement.
Node set containing the entitlement being implemented by the specified actions.
Actions that implement the specified entitlements.
The following is an example of the Argument Actions Builder, used to provide the action argument:
Moves an object in the destination data store.
Select whether this action should be added to, before, or after the current operation, or written directly to the destination data store.
(Optional) Specify the class name of the object to be moved. Leave blank to use the class name from the current object.
Select the object to be moved. This object can be the current object, or can be specified by a DN or an association.
Select the container to receive the object. This container is specified by a DN or an association.
The example contains a single rule which disables a user’s account and moves them to a disabled container when the Description attribute indicates they are terminated. The policy is named Disable User Account and Move When Terminated, and it is available for download from Novell’s support Web site. For more information, see Downloadable Identity Manager Policies.
The policy checks to see if it is a modify event on a User object and if the attribute Description contains the value of terminated. If that is the case, then it sets the attribute of Login Disabled to true and moves the object in to the User\Disabled container.
Moves an object in the source data store.
Select the object to be moved. This object can be the current object, or can be specified by a DN or an association.
Select the container to receive the object. This container is specified by a DN or an association.
Reformats all values of an attribute within the current operation using a pattern.
Specify the name of the attribute.
Specify the syntax of the new attribute value.
Specify a value to use as a pattern for the new format of the attribute values. If the original value is needed to constructed the new value, it must be obtained by referencing the local variable current-value.
The example reformats the telephone number. It changes it from (nnn)-nnn-nnnn to nnn-nnn-nnnn. The rule is from the predefined rules that come with Identity Manager. For more information, see Input or Output Transformation - Reformat Telephone Number from (nnn) nnn-nnnn to nnn-nnn-nnnn.
The action reformat operation attribute changes the format of the telephone number. The rule uses the Argument Builder and regular expressions to change how the information is displayed.
Sends a remove association command to the Identity Vault.
Select whether this action should be added to, before, or after the current operation, or written directly to the destination data store.
Specify the value of the association to be removed.
The example takes a delete operation and disables the User object instead. The transforms an event. The rule is from the predefined rules that come with Identity Manager. For more information, see Command Transformation - Publisher Delete to Disable.
When a delete operation occurs for a User object, value of the attribute Login Disabled is set to true and the association is removed from the object. The association is removed because the associated object in the connected application no longer exists.
Removes an attribute value from an object in the destination data store.
Specify the name of the attribute.
(Optional) Specify the class name of the target object. Leave blank to use the class name from the current object.
Select whether this action should be added to, before, or after the current operation, or written directly to the destination data store.
Select the target object. This object can be the current object, or can be specified by a DN or an association.
Specify the syntax of the new attribute value.
Specify the value of the new attribute.
Removes the specified value from the named attribute on an object in the source data store.
Specify the name of the attribute.
(Optional) Specify the class name of the target object. Leave blank to use the class name from the current object.
Select the target object. This object can be the current object, or can be specified by a DN or an association.
Specify the syntax of the attribute value to be removed.
Specify the attribute value to be removed.
Renames an object in the destination data store.
Select whether this action should be added to, before, or after the current operation, or written directly to the destination data store.
Select the target object. This object can be the current object, or can be specified by a DN or an association.
Specify the new name of the object.
Renames all occurrences of an attribute within the current operation.
Specify the original attribute name.
Specify the new attribute name.
Renames an object in the source data store.
Select the target object. This object can be the current object, or specified by a DN or an association.
Specify the new name of the object.
Sends an e-mail notification.
(Optional) Specify the User ID in the SMTP system sending the message.
Specify the SMTP server name.
(Optional) Specify SMTP server account password.
IMPORTANT:The value of the password attribute is stored in clear text.
Select the e-mail message type.
Specify the values containing the various e-mail addresses, subject, and message. The following table lists valid named string arguments:
The following is an example of the Named String Builder being used to provide the strings argument:
Generates an e-mail notification using a template.
Specify the slash form DN of the SMTP notification configuration object.
Specify the slash form DN of the e-mail template object.
(Optional) Specify SMTP server account password.
IMPORTANT:The value of the password attribute is stored in clear text.
Specify additional fields for the e-mail message. The following table contains reserved field names, which specify the various e-mail addresses:
Each template might also define fields that can be replaced in the subject and body of the email message.
The following is an example of the Named String Builder, used to provide the strings argument:
Adds default values to the current operation (and optionally to the current object in the source data store) if no values for that attribute already exist. It is only valid when the current operation is add.
Specify the name of the default attribute.
Select whether or not to also write back the default values to the source data store.
Specify the default values of the attribute.
The example sets the default value for the attribute company. You can set the value for an attribute of your choice. The rule is from the predefined rules that come with Identity Manager. For more information, see Creation - Set Default Attribute Value.
To build the value, the Argument Value List Builder is launched. See Argument Value List Builder for more information on the builder. You can set the value to what is needed. In this case, we used the Argument Builder and set the text to be the name of the company.
Adds a value to an attribute on an object in the destination data store, and removes all other values for that attribute.
Specify the name of the attribute.
(Optional) Specify the class name of the target object in the destination data store. Leave blank to use the class name from the current object.
Select whether this action should be added to, before, or after the current operation, or written directly to the destination data store.
Select the target object. This object can be the current object, or be specified by a DN or an association.
Select the syntax of the attribute value to set.
Specify the attribute values to set.
The example takes a delete operation and disables the User object instead. The rule is from the predefined rules that come with Identity Manager. For more information, see Command Transformation - Publisher Delete to Disable.
The rule sets the value for the attribute of Login Disabled to true. The rule uses the Argument Builder to add the text of true for the value of the attribute. See Argument Builder for more information about the builder.
Sets the password for the current object in the destination data store.
Select whether this action should be added to, before, or after the current operation, or written directly to the destination data store.
Select the target object. This object can be the current object, or be specified by an DN or an association.
Specify the password to be set.
The example sets a default password for the User object that is created. The rule is from the predefined rules that come with Identity Manager. For more information, see Creation - Set Default Password.
When a User object is created, the password is set to the Given Name attribute plus the Surname attribute.
Sets a local variable.
Specify the name of the new local variable.
Select the type of local variable. This can be a string, an XPath 1.0 Node Set, or a Java object.
The example adds a User object to the appropriate group, Employee or Manager, based on Title. It also creates the group, if needed, and setup security equal to that group. The policy name is Govern Groups for User Based on Title and it is available for download from Novell’s support Web site. For more information, see Downloadable Identity Manager Policies.
The local variable is set to the value that is in the User object’s destination attribute of Object Class plus the Local Variable of manager-group-info. The Argument Builder is used to construct the local variable. See Argument Builder for more information.
Sets the association value for the current operation.
Provide the new association value.
Sets the object class name for the current operation.
Specify the new class name.
Sets the destination DN for the current operation.
Specify the new destination DN.
The example places the objects in the Identity Vault using the structure that is mirrored from the connected system. You need to define at what point the mirroring begins in the source and destination data stores. The rule is from the predefined rules that come with Identity Manager. For more information, see Creation - Set Default Attribute Value.
The rule sets the operation destination DN to be the local variable of the destination base location plus the source DN.
Sets an operation property. An operation property is a named value that is stored within an operation. It is typically used to supply additional context that might be needed by the policy that handles the results of an operation.
Specify the name of the operation property.
Specify the name of the operation property.
Sets the source DN for the current operation.
Specify the new source DN.
Sets the template DN for the current operation to the specified value. This action is only valid when the current operation is add.
Specify the template DN.
The example applies the Manager template if the Title attribute contains the word Manager. The name of the policy is Policy: Assign Template to User Based on Tile, and it is available for download from Novell’s support Web site. For more information, see Downloadable Identity Manager Policies.
The template Manager Template is applied to any User object the has the attribute of Title available and it contains the word manager somewhere in the title. The policy uses regular expressions to find all possible matches.
Adds a value to an attribute on an object in the source data store, and removes all other values for that attribute.
Specify the name of the attribute.
(Optional) Specify the class name of the target object in the source data store. Leave blank to use the class name from the current object.
Select the target object. This object can be the current object, or be specified by a DN or an association.
Select the syntax of the attribute value.
Specify the attribute value to be set.
The example detects when an e-mail address is changed and sets it back to what it was. The policy name is Policy: Reset Value of the E-mail Attribute, and it is available for download from Novell’s support Web site. For more information, see Downloadable Identity Manager Policies.
The action takes the value of the destination attribute Internet EMail Address and set the source attribute of Email to this same value.
Sets the password for the current object in the source data store.
Specify the password to be set.
Sets the SSO credential when a user object is created or when a password is modified. This action is part of the Credential Provisioning policies. For more information, see Section 4.0, Novell Credential Provisioning Policies.
Specify the DN of the repository object.
Specify the DN of the target users.
Specify the application credential that is stored in the application object.
Specify each login parameter for the application. The login parameters are the authentication keys stored in the application object.
Sets the Novell SecureLogin® passphrase and answer when a User object is provisioned. This action is part of the Credential Provisioning policies. For more information, see Section 4.0, Novell Credential Provisioning Policies.
Specify the DN of the repository object.
Specify the DN of the target users.
Specify the SecureLogin passphrase question and answer.
The SecureLogin passphrase question and answer are stored as strings in the policy. Click the
to launch the string builder. Specify the passphrase question and answer.
Sets an XML on a set of elements selected by an XPath expression.
Specify the name of the XML attribute. This name can contain a namespace prefix if the prefix has been previously defined in this policy.
XPath 1.0 expression that returns a node set containing the elements on which the XML attribute should be set.
Specify the value of the XML attribute.
Generates a status notification.
Specify the status level of the notification.
Provide the status message using the Argument Builder.
If level is retry then the policy immediately halt processing of the input document and schedules a retry of the event currently being processed.
If level is fatal then the policy immediately halt processing of the input document and initiates a shutdown of the driver.
If a the current operation has an event-id, then that event-id is used for the status notification, otherwise there is no event-id reported.
Strips all occurrences of an attribute from the current operation.
Specify the name of the attribute to be stripped.
The example detects when an e-mail address is changed and sets it back to what it was. The policy name is Policy: Reset Value of the E-mail Attribute and it is available for download from Novell’s support Web site. For more information, see Downloadable Identity Manager Policies.
The action strips the attribute of Email. The value that is kept is what was in the destination Email attribute.
Strips nodes selected by an XPath 1.0 expression.
Specify the XPath 1.0 expression that returns a node set containing the nodes to be stripped.
Sends a message to DSTRACE.
Specify the trace level of the message. The default level is 0. The message only appears if the specified the trace level is less than or equal to the trace level configured in the driver.
For information on how to set the trace level on the driver, see
Viewing Identity Manager Processes
in the
Novell Identity Manager 3.0.1 Administration Guide
.
Select the color of the trace message.
Specify the value of the trace message.
The example has four rules that implements a Placement policy for User objects based on the first character of the Surname attribute. It generates both a trace message and a custom Novell Audit event. The Trace Message action is used to send a trace message into DSTRACE. The policy name is Policy to Place by Surname and it is available for download from Novell’s support Web site. For more information Downloadable Identity Manager Policies.
The action sends a trace message to DSTRACE. The contents of the local variable is LVUsers1 and it shows up in yellow in DSTRACE.
Vetoes the current operation.
The example excludes all events that come from the specified subtree. The rule is from the predefined rules that come with Identity Manager. For more information, see Event Transformation - Scope Filtering - Exclude Subtrees from the predefined rules.
The action vetoes all events that come from the specified subtree.
Conditionally cancels the current operation and ends processing of the current policy, based on the availability of an attribute in the current operation.
Specify the name of the attribute.
The example does not all User objects to be created unless the attributes Given Name, Surname, Title, Description, and Internet EMail Address are available. The policy name is Policy to Enforce the Presences of Attributes and it is available for download from Novell’s support Web site. For more information, see Downloadable Identity Manager Policies.
The actions vetoes the operation if the attributes of Given Name, Surname, Title, Description, and Internet Email Address are not available.