configure


Purpose

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.

Signature

configure( options )

Returns

This method does not return anything.

Parameters

The options object contains the following configuration parameter.

Name Description Type Use
version

A protocol that Hybrid Container must use:

  • 2 - the client uses an older version of the protocol to support connections with the Pega 7 Platform in versions 7.1.10, 7.2, and 7.2.1

  • 3 - the client uses the newest protocol to support connections with the Pega 7 Platform in version 7.2.2 and newer

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 service for triggering the Synchronization process:

<server_URL>/PRRestService/offlinehttp/DataSync/pzSynchronizationService

Where <server_URL> stands for the URL address of an instance of your Pega 7 Platform application.

string required
reportChangesForTypes An array of synchronization item types for which changes will be reported after every MapsReplication operation. Item types are freely defined data item categories, presented as string values. They are used in correlation with data handles to identify individual data items. For example: "harness", "splitdatapage", "datapage", "image". object required
sessionTimeout A session timeout value in seconds. When it passes, the user should be logged out. integer optional
identifier An optional identifier of the Pega 7 Platform user. If it is not provided, an identifier set in the Account Manager is used. string optional
password An optional password of the Pega 7 Platform user. If it is not provided, a password set in the Account Manager is used. string optional

Related topics

Client Store
Legal notice | Copyright © 2016 and Confidential to Pegasystems Inc. All rights reserved
PDN | Hybrid Container | Feedback
Advanced...