configure_correlation_ids.py

Run the configure_correlation_ids.py script as the mtx user on only one processing server on only the active engine (because memory is shared across processing servers, MATRIXX populates the same correlation ID ranges on each server in the engine). When removing correlation IDs, the range of correlation IDs that you specify must exist on the engine. If you are using sub-domains in your MATRIXX environment, you must populate a unique range of correlation IDs per sub-domain.

Syntax

configure_correlation_ids.py [-h] [-H URI] –-addRemoveList=add|remove|list [--prefix=prefix_number] [--startRange=start_number] [--endRange=end_number] [--maxTsans=max] [--force=0|1] [-–verbose=0|1]

Options

The configure_correlation_ids.py script has the following options:

-h, --help

Show help about the script options.

-H=URI, --host=URI

The MDC Gateway server to connect to. This option specifies the host name, host:port, or IP address of the processing server on which to run the configuration script. This value defaults to the current server.

--addRemoveList=add|remove|list

Specifies whether to add or remove a range of correlation IDs or to list all the correlation IDs in the database.

--prefix=prefix_number

When adding correlation IDs, the prefix_number specifies an optional correlation ID number prefix for each number in the correlation ID range. The prefix can contain up to a maximum of 13 digits and use a combination of the digits 0 to 9.

When removing a range of correlation IDs, if you used a prefix to add the correlation IDs, you must specify the same prefix when removing them. Omit the prefix option when removing correlation IDs only if this option was not used to add the correlation IDs.

--startRange=start_number

The start_number specifies the start of the correlation ID number range. You must specify a positive integer that uses a maximum of 15 digits in the range 0 to 9. This value is set to 10000 by default.

Note: If you are adding correlation IDs, the total range of provisioned numbers is: endRange - startRange.

--endRange=end_number

The end_number specifies the end of the correlation ID number range. You must specify a positive integer that is equal to or greater than the startRange value and that uses a maximum of 15 digits in the range 0 to 9. This value is set to 20000 by default.

Note: The difference between the startRange value and the endRange value must be equal to or less than the value of maxCorrelationIds.

--maxCorrelationIds=max

Specifies the maximum number of correlation IDs allowed in the database. This value defaults to 10000. The value of max must match the value specified when you are answering the following create_config.py question:

Camel Gateway:What is the maximum number of correlation ID objects per sub-domain?

Note: When adding correlation IDs, the script exits if the specified maximum is exceeded.

--force=0|1

When you are removing a range of correlation IDs, this option determines whether to force the removal of a correlation ID object that is in use. If this value is set to:

• 0 - The correlation ID object is not removed.
• 1 - It forces the removal of the correlation ID object.

When removing a range of correlation IDs, first run the script without using the --force option. If the script tries to remove a correlation ID object that is in use, the script sets the correlation ID object to invalid so that it cannot be reused after the current call is completed. To remove the invalid correlation ID object, rerun the script.

Note: When you are removing a range of correlation IDs, run the script with the --force option set to 1 only if earlier tries to remove a correlation ID object failed. Forcibly removing correlation ID objects could cause calls to be lost.

--verbose=0|1

Enables or disables verbose mode. Set this value to 1 to enable verbose mode.