iTwin Synchronizer for Stack

Before you begin

The iTwin Synchronizer works with your bank deployment with the help of a configuration file consisting of the required variables. Find the variables and their descriptions below and have then handy to set up the bankConfig.json

Define variables

Followings are the variables need to be set in order to do the installations:

Variable Validation Rules Description Example
updateCDN update ITSYN and bridges CDN url and "" means use the default CDN https://itsyn.itwin365.cn/
connectionStorageLocation Folder location can be accessed from machine running synchronizer Local folder and "" means use the default folder For example D:\\ConnectionStore
iModelBankUrl Bank deployment URL
bankStorageType The type of storage should be azure, storageservice or localhost. It must be one of the supported storage types. Storage type used by the bank deployment For example it would be one of the three supported types, such as azure, storageservice or localhost
contextRegistryUrl The context registry server endpoint for projectList and iModelList with RBAC. RESTful: "https://developer.bentley.com/apis/projects/operations/my-projects/" "contextRegistryUrl": "http://dev.win.ipc.itwin365.cn",
realityModelLocalStore Value set to true When set to true reality data is stored at the location provided by realityModelStorageLocation
realityModelStorageLocation Folder location can be accessed from machine running synchronizer. "realityModelStorageLocation": "D:\RealityData",

Following Variables are required when iModel id and context id are directly provided in the iModelConfig property

Variable Validation Rules Description Example
iModelConfig
imodelBankContextId Value is a GUID Requires the created ContextID GUID "imodelBankContextId":"0f6ca41b-e780-41db-b73b-e4a944d16870"
imodelBankContextId Value is a GUID Requires the created iModelID GUID "imodelBankImodelId":"634d33d1-a218-448d-81b8-f67c282f8cbb"

Following Variables are only required when authenticationType is Bearer

Variable Validation Rules Description Example
oidcConfig
iPCWay Value set to true
oidcUrl The authority URL of your OAuth provider E.g "http://dev.win.ipc.itwin365.cn/.well-known/openid-configuration"
clientId OAuth clientID of the clientCredentials app
clientScope The scope
redirectUrl Registered redirect URL for the ClientID

Generate Configuration

Add the above values and generate the bank configuration JSON. Please ensure the file is called bankConfig.json.

Place the configuration on disk and set it to an environment variable

Set ITSYN_STACK_CONFIGURATION_FILE = "D:\bankConfig.json"

Launch application

When the environment the ITSYN_STACK_CONFIGURATION_FILE set the application will launch in the Stack mode.

Parameter supported with IPC's bank deployment

Variable Validation Rules Description Example
getIModelUrl At the end of synchronization, URL points to the iModel to view e.g. ${iModelPageUrl}?projectId=${contextId}${iModelId}
fwkToken IPC bank basic token.

Following parameter can be added to the bankConfig.json to work with IPC's bank deployment

"getIModelUrl": "http://dev.win.ipc.itwin365.cn/project?projectId={contextId}",
"fwkToken": "",

results matching ""

    No results matching ""