Integration Properties

Last Updated: July 2024

Integration-related properties may reside in database or property files. Updates of some properties require restart of the integration services to take effect. Refer to Integration Properties Details for more information.

⚠️ Clarity v6.3 introduces a new feature (System Setting) for configuring properties (including some integration properties).

Refer to table below on the recommended methods of property configuration for different scenarios.

Scenario

Configuring Properties

Remarks

Fresh installation of integration packages on Clarity v6.2

  • Properties in database: configure via omxProps-ConfigTool utility

  • Properties in files: edit property files directly

Applicable to any integration packages released together with or after Clarity v6.2

Fresh installation of integration packages (released with or after Clarity v6.3) on Clarity v6.3

  • Properties exposed in System Setting: configure via System Setting

    ℹ️ Property updates do not require restart of integration service

  • Properties in database: configure via omxProps-ConfigTool utility

  • Properties in files: edit property files directly

For integration packages released with or after Clarity v6.3, some of the database can be configured via System Setting page (Available from Clarity v6.3 or above).

Fresh installation of integration packages (released before Clarity v6.3) on Clarity v6.3

  • N.A.

⚠️ Integration configuration scripts are not compatible with Clarity v6.3. Integration properties must be updated using omxProps-ConfigTool utility

Users are recommended to install the latest integration package to avoid issues with configuration scripts and to leverage the new System Setting page for configuring integration properties.

Upgrade scenario:

  • Upgrade Clarity v6.2 to Clarity v6.3

  • Continue to use previously installed integrations

  • Properties in database: configure via omxProps-ConfigTool utility

  • Properties in files: edit property files directly

Upgrade scenario:

  • Upgrade Clarity v6.2 to Clarity v6.3

Upgrade integrations to latest versions

  • Properties exposed in System Setting: configure via System Setting

    ℹ️ Property updates do not require restart of integration service

  • Properties in database: configure via omxProps-ConfigTool utility

  • Properties in files: edit property files directly

Last updated