Changing the Default Values for Retry Mechanism
Pre-requisites:
To change the default values for retry configuration through the CentraSite Command Line Interface, you must have the CentraSite Administrator role.
CentraSite uses the default values set for the global properties numberOfRetries and retryIntervals for the guaranteed delivery of messages from CentraSite to API Portal. By default, numberOfRetries = 5 and retryIntervals = 10,300,900,1800,3600 seconds. In case of a transient failure, CentraSite tries to resend the undelivered access tokens 5 times at time intervals of 10,300,900,1800 and 3600 seconds respectively.
The default values for resending the undelivered access tokens are stored in the CentraSite's internal database. You can change the default values for retry configuration to suit your individual requirements.
CentraSite provides a command tool named set ApiPortalConfig for this purpose. The tool displays the updated values for numberOfRetries and retryIntervals in the console.
When changing the default values set for the global properties numberOfRetries and retryIntervals, keep the following points in mind:
If
numberOfRetries is more than the number of values specified for
retryIntervals,
CentraSite uses the last time interval specified in
retryIntervals for the remaining retry attempts. For example, if
numberOfRetries = 5 and
retryIntervals = 10,300,900,1800 seconds,
CentraSite tries to resend the undelivered access tokens
5 times at time intervals of
10,300,900,1800,1800 seconds.
If
numberOfRetries is less than the number of values specified for
retryIntervals,
CentraSite ignores the values that are beyond the value set for
numberOfRetries. For example, if
numberOfRetries = 4 and
retryIntervals = 10,300,900,1800,3600,7200 seconds,
CentraSite tries to resend the undelivered access tokens
4 times at time intervals of
10,300,900,1800 seconds. Time intervals beyond
1800 seconds are ignored.
To change the default values for retry configuration
Run the command set ApiPortalConfig. The syntax is of the format: C:\SoftwareAG\CentraSite\utilities>CentraSiteCommand.cmd set ApiPortalConfig [-url <CENTRASITE-URL>] -user <USER-ID> -password <PASSWORD> -file <CONFIG-FILE>
The input parameters are:
Parameter | Description |
CENTRASITE-URL | (Optional). The URL of the CentraSite registry. For example, http://localhost:53307/CentraSite/CentraSite. |
USER-ID | The user ID of a registered CentraSite user who has the CentraSite Administrator role. For example, Administrator. |
PASSWORD | The password for the registered CentraSite user identified by the parameter USER-ID. |
CONFIG-FILE | Name of the XML file where numberOfRetries and retryIntervals values are changed. Note: If the file is in a different location other than <CentraSiteInstall_Directory>/utilities, provide the absolute file path. |
Example (all in one line):
C:\SoftwareAG\CentraSite\utilities>CentraSiteCommand.cmd set ApiPortalConfig -url http://localhost:53307/CentraSite/CentraSite -user Administrator -password manage -file C:\CentraSite\configuration\test.xml
The response to this command could be:
Executing the command : set ApiPortalConfig
API Portal CONFIGURATIONS
-------------------------
com.centrasite.apiportal.config.retry.RetryIntervals : 10,10,10,10,10
com.centrasite.apiportal.config.retry.NumberOfRetries : 5
Successfully executed the command : set ApiPortalConfig