Identity Director Setup and Sync Tool

Home 

Command-line options

The Setup and Sync Tool, Transaction Engine and Mobile Gateway have several command-line options. This enables you, for example, to configure the Datastore connection after installation or, if your environment still contains them, to set the password for the Catalog Services.
Some of the options will open a menu in which configuration changes can be made, others can be used for unattended configuration.

Configuration database connection window

To open the Configure database connection window, in which you can review, change and test the connection settings:

  • For the Setup and Sync Tool and the Transaction Engine, apply the property /CONFIGDB to their executable.
    • "C:\Program Files\RES Software\IT Store\Console\resocc.exe" /CONFIGDB
    • "C:\Program Files\RES Software\IT Store\Transaction Engine\resote.exe" /CONFIGDB
  • For the Mobile Gateway, run ITStore.ClientService.InstallerSupport.exe as an administrator.
    • C:\Program Files (x86)\RES Software\IT Store\MobileGateway\bin\ITStore.ClientService.InstallerSupport.exe

To open the Setup page for the Web Portal, add /setup to the URL for the portal.

  • https://identitydirector.example.com/setup

For the Setup and Sync Tool (and the Management Portal), the Datastore connection can also be reconfigured at Setup > Datastore.

Command-line options

Setup and Sync Tool command lines

Transaction Engine

Available public properties

Property

Value

Functionality

CONFIGDB

Empty

  • When used for the Setup and Sync Tool or Transaction Engine, without any other parameters: opens the Configure database connection window.
  • When used in combination with other parameters:
    • Include /CONFIGDB to save the provided connection settings to registry.
    • Exclude /CONFIGDB to discard the provided connection settings.

CREATEDB

Empty or NO

Specify if a new database should be created.

  • Specify /CREATEDB=NO (or do not include CREATEDB) to connect to an existing Datastore.
  • Specify /CREATEDB to create a new Datastore.

DBSERVER

[SERVERNAME]

Specify the database server that hosts the Datastore.

  • If the database server uses instances, use the format: server\instance. Unattended installations on instances in which this format isn't used fail.
  • Example: DBSERVER=SQLServer01

DBNAME

[DATABASENAME]

Specify the name of the Datastore that you want to connect to or want to create.

  • Example: DBNAME=IDDB

DBTYPE

MSSQL, DB2, ORACLE, MYSQL or MSSQLAZURE

Specify the database type.

  • Example: DBTYPE=MSSQL

DBCREATEUSER

[USERNAME]

Specify a database user account that has the rights to create new databases and logins, e.g. sa. This must be an existing SQL user. Use this property only when you create a new Datastore.

DBCREATEPASSWORD

[PASSWORD]

Specify the plain text database password that should be used to create the new database.

  • Use this property only when you create a new Datastore.
  • Example: DBCREATEPASSWORD=SAPassword

DBUSER

[DBUSERNAME]

Specify the database user account that can connect to the database.

  • When you create a new Datastore, a new user account is created with this name.
  • Example: DBUSER=IDUser

DBPASSWORD

[DBPASSWORD]

Specify the corresponding plain text password of DBUSER.

  • Example: DBPASSWORD=IDUserPassword

DBENCRYPTION

DISABLED, ENABLEDWITHOUTVALIDATECERTIFICATE, or ENABLEDWITHVALIDATECERTIFICATE (default)

YES or NO are also available for backwards compatibility

Specify if protocol encryption should be used (Microsoft SQL Server database systems only).

  • The preferred, default value is ENABLEDWITHVALIDATECERTIFICATE, in which protocol encryption is used and the server’s certificate is validated; if the server does not present a valid certificate, the connection fails
  • ENABLEDWITHOUTVALIDATECERTIFICATE and YES both use protocol encryption, but the connection succeeds even if the server does not present a valid certificate
  • DISABLED and NO do not use protocol encryption

INITEMPTYDB

TRUE or FALSE (default)

Specify if the existing database that you connect to must be initiated for use as a Datastore. Only available for the Setup and Sync Tool.

DBIMPORTLICENSE

[FILEPATH]

Specify a license file that should be imported after the Datastore has been created (optional).

  • Example: DBIMPORTLICENSE="C:\TEMP\License.xml"

CATALOGSERVICEPASSWORD

[CatSvcPwd]

Set or reset the password for the Catalog Services.

  • Only applies to Setup and Sync Tool 2019.0 and earlier.
  • Also useful when you add a Setup and Sync Tool version 2019.0 to an Identity Director environment that was started at version 2019.1 or higher (for example .


Was this article useful?