Retry Configurations

Connectors that support provisioning operations also have the capability to retry the operation if it fails. The retryableErrors entry is a list of strings through which the connector searches when it receives a message from the managed application. To take advantage of this feature, add a retryable error messages list to the attributes map in a source. If one of the strings in the entry is in the error, the connector attempts to retry the connection. If the configured error string is not a part of the error message, then the connector will not attempt a retry. Add the following entry in the source XML using the SailPoint REST APIs.

For example:

PATCH https://{orgName}.api.identitynow.com/v3/sources/:id

In the body of the PATCH, enter the retryable errors as follows:

Copy 
[
    {
        "op": "add",
        "path": "/connectorAttributes/retryableErrors",
        "value": [
            "<error_message_1>",
            "<error_message_2>"
        ]
    }
]

Note
For more information on SailPoint's REST APIs, refer to Best Practices: REST API Authentication and REST API - Update Source (Partial) in the SailPoint Developer Community.

Note
Error messages containing very specific information about date/time, sequence ID and so on must be avoided. Error codes or error message substrings would be good candidates for inclusion.

Maximum Retry Count

The maxRetryCount parameter enables you to configure the maximum number of attempts the connector retries a failing operation before terminating it.

Sets the maximum number of attempts before terminating a failing operation.

Integer

Default: 2

Set the parameter as follows using the REST API:

PATCH https://{orgName}.api.identitynow.com/v3/sources/:id

In the body of the PATCH, enter the maximum retry count as follows:

Copy 
[
    {
        "op": "add",
        "path": "/connectorAttributes/maxRetryCount",
        "value": <required_value>
    }
]

Note
For more information on SailPoint's REST APIs, refer to Best Practices: REST API Authentication and REST API - Update Source (Partial) in the SailPoint Developer Community.