This method returns a promise object resolved with no value.
The config object contains the following configuration parameters.
| Name | Description | Type | Use |
|---|---|---|---|
| version | A version of the analytics mechanism. This parameter must always be set to 1. | integer |
required |
| url | A URL address pointing to the Pega Platform server endpoint. | string |
required |
| applicationName | A value taken from the the <code>pyLabel<code> field of the application definition in the Pega Platform. | string |
required |
| logbookSpecific | Additional data specific to a module, described below. | object |
required |
| resendingInterval | Interval in seconds for re-sending logs in case of sending failure. | boolean |
optional |
The logbookSpecific object can be structured as follows:
{
PRPCClientStore {
synchronizationErrorTypeFilteringMode
}
}The table below lists parameters of the logbookSpecific object.
| Name | Description | Type |
|---|---|---|
| PRPCClientStore | A configuration object that contains parameters specific to messages published by the ClientStore module. | object |
The table below lists parameters of the PRPCClientStore object.
| Name | Description | Type |
|---|---|---|
| synchronizationErrorTypeFilteringMode | One of the following string values: "NONE", "ALL_BUT_NETWORK_FAILURES", "ALL_FAILURES" | string |