Synchronizer parameter reference

To enable synchronization, the following values must be defined for the Synchronizer parameters in the /opt/sync/conf/sync.yml file.

  • If you ran the enablesyncx.sh command, default values are populated in these fields. You can then modify them as needed.

  • In a complex environment, fill in the fields as described below.

Note: Sensitive data such as passwords or initString (excluding encryptionSeed) are written in plain text. When the installation script is executed ("service start"), the plain text values are replaced by encrypted values. The encryption seed (sync/firstTimeInit/encryptionSeed) is removed from the .yml file.

serviceLocations: Section with URLs of services and ALM Octane
octane

Base URL of ALM Octane (or its load balancer for multi-node deployment)

Example: http://octane.company.com:8080
opb

Deprecated
sync

Base URL of Synchronizer (or its load balancer for multi-node deployment)

Example: http://sync.company.com:8080/sync

firstTimeInit

Values from this section are deleted after the Synchronizer is run for the first time.

encryptionSeed

Enter the contents of the initstring file on the ALM Octane machine installation:

<octane-repository>/storage/site/initstring.txt

Example: more /opt/octane/repo/storage/site/initstring.txt

general

Section of general properties

logFolder

Folder where Synchronizer logs will be located.

Example: /opt/sync/logs

port

HTTP port where the Synchronizer listens.

Example: 8080
httpsPort

HTTPS port where the Synchronizer listens.

If commented out, HTTPS is not configured.
keystorePath

Path to the java keystore.

You can copy the keystore from the ALM Octane server HTTPS configuration to here.

If commented out, <installation directory>/server/conf/keystore is used with the password storepwd.

keystorePassword

Password for the java keystore.

If commented out, <installation directory>/server/conf/keystore is used with the password storepwd.

synchronization Section related to synchronization of entities

publicOctaneUrl

Public (base) URL of ALM Octane.

Example: http://octane.company.com:8080

database

Section of database-related properties

action

Enter one of the following:

  • CREATE_NEW for a new installation (first execution of installation script). This creates the site admin schema.

  • FILL_EXISTING for a new installation, where the site admin schema is supplied by the organization's DBA. This populates the empty schema. Note that for MSSQL, a login named hpu must exist and have access to the supplied schemata.

  • AUTO for detecting and performing the needed action automatically.

  • UPGRADE for an existing deployment. This updates the existing schema if needed.

  • CONNECT_TO_EXISTING for an existing deployment. This connects to the existing schema without upgrade.

type

The supported database types are:

  • ORACLE

  • MSSQL

connectionString

The Java Database Connectivity (JDBC) database connection string required to connect to the database. It includes the following details: database type, database server name, and database server port number.

Examples:

jdbc:sqlserver://localhost:1433

jdbc:oracle:thin:@//localhost:1521:xe
jdbc:oracle:thin:@//localhost:1521/test

Note that Oracle multi-tenant database is not supported.

adminUser

The name of the database admin user.

Note: In case of FILL_EXISTING action, enter the saSchemaUser for Oracle, or hpu for MSSQL.

adminPassword

The password of the database admin user (DBAdminUser for Oracle, or MssqlLoginNameForSetup for MSSQL).

Note: In case of FILL_EXISTING action, enter the saSchemaPassword for Oracle, or password of the hpu login for MSSQL.

saSchemaUser

The name of the site schema that is created by the DBAdminUser for Oracle, or MssqlLoginNameForSetup for MSSQL, during the installation, or supplied by the organization's DBA.

Example: sync_sa

saSchemaPassword

The plain-text password of the site schema.

schemaUser

Used with FILL_EXISTING action. The name of the space schema that should be populated, supplied by the organization's DBA.

schemaPassword

Password of a user created by the Synchronizer for each attached space.

Note that for MSSQL, schemaPassword must be the same as saSchemaPassword.
oracle: Section for Oracle DB only

tableSpace

The tablespace in the Oracle database where the site schema segment will be created. Case-sensitive.

Example: USERS

tempTableSpace

The temporary tablespace in the Oracle database. Case-sensitive.

Example: TEMP
repository: Section of file repository related properties
rootFolder

Root folder for file repository. This folder must be located on disk space which is shared among all Synchronizer nodes.

Example: /opt/sync/repo

integration:

Section of integration specific properties

serviceApiKey

API client ID

serviceApiSecret

API client secret

distributedCache:

Optional: Cluster configuration section

password

Password of the cache. Must be the same on all of the Synchronizer's distributed cache nodes.

clusterNodes

  • This is not needed in single-node deployment. ֲBy default, the cluster is not configured, and the default value is:

    - localhost

  • In multi-node deployment, enter the list of nodes where the Synchronizer's distributed cache is running. For example:

    - "node1"
    - "node2"
    - "10.0.0.23"

    Alternative notations could be in a single line:

    Nodes: ["node1","node2","10.0.0.23"]

port

Default cache port

Example: 5788

Note that if this is not a valid integer, the validation fails.

sso:

Section of SSO-related properties

initString

Enter the contents of the authenticationKey file on the machine installation:

/opt/octane/repo/storage/site/authenticationKey.txt

redirectToAuthPageUrl

Authentication provider sign-in page

In most cases, this is the ALM Octane login URL.

master:

SSO provider properties

domain

The user-facing domain name. This must be identical for the Synchronizer and ALM Octane.

Example: If the user-facing address is almoctane.mydomain.com, the domain should be written as mydomain.com.

loginUrl

Authentication provider sign-in URL

Example: http://octane.company.com:8080/authentication-point/web-ui-login.jsp

logoutUrl

Authentication provider sign-out URL

Example: http://octane.company.com:8080/authentication/sign_out