Provisioning node CommandStatusCode and CommandStatusMessage in RSA Identity Governance & Lifecycle

[#1]

Article Number

000034403

Applies To

RSA Product Set: Identity Governance & Lifecycle 
RSA Version/Condition: 6.9.1. 7.0.0, 7.0.1, 7.0.2 ,7.1.0, 7.1.1
 

Issue

How to check the status of a RSA Identity Governance & Lifecycle Provisioning Command workflow node

The Provisioning Command workflow node does return a status of 0 if the command completes and a status of -1 if the command does not complete.  This status however only confirms if the Provisioning Command executed, and does not actually represent the status of the Provisioning event.  

RSA recommends that you always use an Unconditional transition from the Provisioning Command node and then check the status of the provisioning explicitly yourself in the workflow.

Image description

Resolution

You can check the actual return codes from the provisioning event by checking the status of the following workflow variables.   Note that these variables are set for each Provisioning Command node and must be checked immediately after the provisioning has completed.  If you have multiple Provisioning Commands the values of these variables will be overwritten by the next Provisioning Command node. 

acm.provisioningCommandStatusCode
acm.provisioningCommandStatusMessage

The acm.provisioningCommandStatusCode typically contains the value of 0 for success or -1 for failure.
The acm.provisoningCommandStatusMessage contains a text value that gives additional information on the success or failure.  The value returned will depend on the type of provisioning.  For example the Message for success is typically "Success".

1. In order to set these variable the Provisioning Command must have the Wait for Result setting enabled.   Select the Provisioning Command node and then enable the checkbox for Wait for result.

Image description

2. In order to access these internal RSA workflow variables you need to assign them to variables using a SQL select node.   
   1. Create a SQL Select node.   
   2. Select the QUERY section.

Image description

3. Enter the following SQL query to set the job level variables that will return the code and status message into variables of your choice such as errorcode and errormsg.

SELECT ${jobUserData_acm.provisioningCommandStatusCode} AS errorcode,
${jobUserData_acm.provisioningCommandStatusMessage} AS errormsg
FROM DUAL

4. Create a Decision node to process the results from the SQL Select node.  Under the Condition section check the WorkFlow variables checkbox and then select the result or message you wish to compare. The basic decision node might just parse the provisioningStatusCode result.   For more comprehensive error handling you would want to include logic that examines the provisioningCommandStatusMessage as well.

Image description

Notes

Ensure you are at the latest patch level to use this feature.    The Wait for result feature was introduced in 6.9.1 P06 and later.   Ensure you are at the following patch level as there are known issues in earlier patches. 

• RSA Identity Governance & Lifecycle 6.9.1 P25
• RSA Identity Governance & Lifecycle 7.0.0 please upgrade to 7.0.2
• RSA Identity Governance & Lifecycle 7.0.1 P05 or later
• RSA Identity Governance & Lifecycle 7.0.2 P01 or later
• RSA Identity Governance & Lifecycle 7.1.0