Showing Pre and Post Refresh rules for Refresh Identities tasks in the UI

IdentityIQ (IIQ) IIQ Community Knowledge Base
,
1

Refresh Rules

It is possible to run custom code during the ‘Refresh Identities’ task. A refreshRule runs after the refresh of each identity in the task and a preRefreshRule runs before the refresh. These rule permits the adjustment of Identity attributes as the Identity undergoes a refresh. Refresh rules are typically employed in refresh tasks that are manually initiated, which are set up for data rectification when incorrect aggregation setups have led to unintended data impacts on Identities. Nonetheless, these rules can also be used in standard refresh or aggregation tasks to assign attributes, typically custom attributes.

Configure Refresh Rules

Out-of-the-Box the refresh rules are specified as a task argument to a refresh task, but can only be added to the task XML, not through the UI.
The rule name is recorded in the taskDefinition XML as:

<entry key= "refreshRule" value = "[Refresh Rule Name]" />
<entry key= "preRefreshRule" value = "[Refresh Rule Name]" />

Adjusting the UI to show and edit the refresh rules

It is possible to adjust the default task definition for all Refresh-tasks to show the Refresh rules in the UI:

  • Go to the debug pages
  • Select Object type : TaskDefinition
  • Open: Identity Refresh
  • Add to the Inputs-element the following XML code:
      <Argument helpKey="This rule runs before the refresh of each identity" name="preRefreshRule" type="string">
        <Prompt>Pre Refresh Rule</Prompt>
      </Argument>
      <Argument helpKey="This rule runs after the refresh of each identity" name="refreshRule" type="string">
        <Prompt>Post Refresh Rule</Prompt>
      </Argument>
  • Save the object

Example:

image
image827×242 12.9 KB

Next time you edit a refresh-task in the UI, you will see:
image

Adding the name of the (pre) refresh rule in the UI will be saved in the task definition :slight_smile:

Notes on upgrades/patched of IdentityIQ

:exclamation: The instructions above do adjust an Out-of-the-Box object. During an upgrade or patch all Out-of-the-Box objects can be overwritten during the process. Validate after the upgrade/patch if the instructions above have the be performed again.

References

More information on the refresh rules can be found in the whitepaper: Rules in IdentityIQ
Although the whitepaper states it is for IIQ 7.0, 7.1 & 7.2, it is for all version 7.x and 8.x versions

12 Likes
2

Good information @Remold. It is useful in some least cases. Besides, I think it may impact on performance because the task has lots of options enabled). But we have to select the options wisely (whatever required or create multiple refresh tasks by enabling required options and schedule them).

2 Likes