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 protolocol that Hybrid Container must use:

  • "undefined" or 1 - the client uses an old protocol to support PRPC in versions prior to ML10

  • 2 - the client uses the newest protocol to support ML10 and ML11 service connections

 integer optional

If the version parameter is set to use the old PRPC protocol, the following configuration parameters must be provided as part of the options object.

Name Description Type Use
sendItemsURL

An absolute location of the service for triggering the StoreAndForward process:

<server_URL>/sendItems

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

 string optional
getItemsStatusURL

An absolute location of the service for monitoring the StoreAndForward process:

<server_URL>/getResults?dummy=value
 string optional
triggerPackagingURL

An absolute location of the service for triggering the MapsReplication process:

<server_URL>/initializePackaging
 string optional
packagingActivity

A name of the activity for triggering the MapsReplication process.

Data-Portal.pzRequestSynchronization
 string optional
getDataSynchPackageURL

An absolute location of the service for getting the MapsReplication's package.

<server_URL>/downloadPackage
 string optional
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.

 object optional

If the version parameter is set to use the new Pega 7 Platform protocol, 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 is logged out. integer optional
identifier An identifier of the Pega 7 Platform user. If it is not provided, an identifier set in the Account Manager is used. string optional
password A 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 © 2017 and Confidential to Pegasystems Inc. All rights reserved
PDN | Feedback
Advanced...