Configures the Client Store process. Calling this method during the first application start is required for all other methods to work.
At the JavaScript level, the options object is validated to verify the value
of the version parameter. Based on this value, either of the two
versions of native code is triggered to pass various parameters. See the "Parameters" section
below for details.
The options object contains the following configuration parameter.
| Name | Description | Type | Use |
|---|---|---|---|
| version |
A protocol that Pega Client for Windows must use:
|
integer |
required |
Regardless of the version parameter's setting, the following
configuration parameters must be provided as part of the options object.
| Name | Description | Type | Use |
|---|---|---|---|
| url | Absolute location of the REST service for triggering the Synchronization process: <server_URL>/PRRestService/offlinehttp/DataSync/pzSynchronizationService Where |
string |
required |
| binaryServiceUrl |
Absolute location of the REST Service that supports binary upload: <server_URL>/PRRestService/offlinehttp/DataSync/pzBinaryUploadService Where Note This parameter is required, when the |
string |
required |
| logoutServiceUrl |
Absolute location of the service that supports logging out of the offline requestor. |
string |
optional |
| compressRequest | Decides whether the synchronization requests from the Pega Client for Windows to Pega Platform should be compressed. By default, the parameter is set to false. | boolean |
optional |