logoBack to home screen

Runtime Properties

You can use runtime properties to customize the behaviour of ADx, Conversion, ActiveMQ, and the Tribefire platform, in accordance with the business needs of your organization. This document explains what runtime properties are available and what's their purpose.

You can add the below runtime properties in your configuration file provided with the installation package (example-installation-setting.yaml), before installation.

Syntax

Add properties in a new line, as in the below example:

ADX_DEFAULT_STORAGE_CONTENT_TYPE=db
ADX_DEFAULT_DB_PORT=1234

ADx Runtime Properties

These properties can be added to the installation settings file of your ADx installation. Note that not all properties mentioned here are added to the settings file by default.

PropertyDescriptionDefault Value
ADX_DEFAULT_DB_TYPEThe Type of the default database. Can be one of the following: Oracle, MSSQL, MySQL, PostgreSQLPostgreSQL
ADX_DEFAULT_DB_NAMEThe name of the default database.adx-content
ADX_DEFAULT_DB_HOSTThe hostname/ip of the default database.127.0.0.1
ADX_DEFAULT_DB_PORTThe port of the default database.5432
ADX_INIT_DEFAULT_REPOSITORYwhen set to true, a repository will be automatically generated from the default values upon installation.false
ADX_DEFAULT_DB_USERThe username for authentication with the default DB.adx
ADX_DEFAULT_DB_PASSWORDThe password for authentication with the default DB. This value has to be encrypted.
ADX_DEFAULT_STORAGE_CONTENT_TYPEThe default content storage type. (possible values: db, fs)fs
ADX_DEFAULT_STORAGE_CONTENT_PATHThe default content storage path (only takes effect if ADX_DEFAULT_STORAGE_CONTENT_TYPE=fs)tmp/adx-storage/demo
ADX_DEFAULT_STORAGE_CACHE_TYPEThe default cache storage type (possible values: db, fs)fs
ADX_DEFAULT_STORAGE_CACHE_PATHThe default storage path (only takes effect if ADX_DEFAULT_STORAGE_CACHE_TYPE=fs)tmp/adx-storage/demo
ADX_DEFAULT_CACHE_DB_NAMEThe name of the default cache database.
ADX_DEFAULT_CACHE_DB_HOSTThe hostname/ip of the default cache database.
ADX_DEFAULT_CACHE_DB_PORTThe port of the default cache database.
ADX_DEFAULT_CACHE_DB_USERThe username for authentication with the default cache DB.
ADX_DEFAULT_CACHE_DB_PASSWORDThe password for authentication with the default cache DB. This value has to be encrypted.
ADX_DEFAULT_CMIS_SERVICEURLThe default CMIS Service URLhttp://documentum73.agile-documents.com:8080/emc-cmis/browser
ADX_DEFAULT_CMIS_REPOIDThe default CMIS RepoIDrep01
ADX_DEFAULT_CMIS_USERThe default CMIS USERdmadmin
ADX_DEFAULT_CMIS_PASSWORDThe default CMIS PWD
ADX_DEFAULT_DCTM_SERVICEURLThe default Documentum Service URL
ADX_DEFAULT_DCTM_REPOIDThe default Documentum RepoID
ADX_DEFAULT_DCTM_USERThe default Documentum USER
ADX_DEFAULT_DCTM_PASSWORDThe default Documentum PWD
ADX_WB_COMMON_RESOURCES_PATH${TRIBEFIRE_STORAGE_DIR}/databases/access.adx.content.wb/resources
ADX_DEFAULT_JOB_REVIVE_WORKER_CHECK_INTERVALHow often ADx checks for stale jobs.5 min
ADX_DEFAULT_JOB_REVIVE_WORKER_MAX_INACTIVITY_BEFORE_RETRYHow long is a job allowed to be stale before retrying. We recommend not to set this lower than 60 minutes.60 min
ADX_DEFAULT_JOB_REVIVE_WORKER_MAX_TRIESHow many times a retry can be attempted on a single job3

Conversion Runtime Properties

These properties can be added to the installation settings file of your Conversion installation. Note that not all properties mentioned here are added to the settings file by default.

PropertyDescriptionDefault
CONV_INITIALIZEEnables local conversion service. If set to false, the remote conversion service needs to be initialized.false
DOCUMENTS_REMOTE_CONVERSIONEnables remote conversion service. If enabled the following three properties need to be set as welltrue
DOCUMENTS_CONVERSION_TFS_URLIf configured (as in "https://[CONV_HOST]:[CONV_PORT]/tribefire-services"), a remote tribefire connection will be created and also username and password are required. Otherwise the conversion access will be assumed locally.
DOCUMENTS_CONVERSION_USERNAMEThe remote conversion service user.cortex
DOCUMENTS_CONVERSION_PASSWORDThe remote conversion service password (encrypted), as in "${decrypt('[ENCRYPTED_PASSWORD]')}"
CONVERSION_ACCESS_IDThe access id of the conversion service (either remote or local).conversion.access
CONV_STANDARD_USER_ENSUREEnsure that the conversion standard user exists. If not, create one in accordance with the parameters belowtrue
CONV_STANDARD_USER_NAMEConversion standard user used to send conversion requests.tf-conversion
CONV_STANDARD_USER_PASSWORDPassword for the above usercortex
CONV_MAX_AGEThe maximum age of a conversion job in the access. This only refers to jobs that have not been updated for this amount of time (in ms)86400000 (1 day)
CONV_MAX_INPUT_FILE_SIZEThe maximum allowed file size (in bytes) of an input resource.157286400 (150 MB)
CONV_CHECK_INTERVALThe interval (in ms) how often the system should check for jobs that reached their end of life or should be removed.600000 (10 minutes)
CONV_MAX_RETRIES:The maximum number of retries to revive a stale conversion job.3
CONV_MAX_INACTIVITY_BEFORE_RETRY:The maximum interval of inactivity before a job gets restarted. This is calculated by comparing the current time with the Last Update Time time stamp of the job. We recommend a period of no less than 60 minutes.360000 (60 minutes)
CONV_JOB_SCHEDULER_INTERVAL:The interval (in ms) of the Job Scheduler checking for stale jobs.300000 (5 minutes)
CONV_WORKER_THREADS:The number of parallel worker threads. If this value is less than 1, the number will be computed based on available CPU cores and memory.0

ActiveMQ Runtime Properties

Each node provides its own, embedded messaging service (based on ActiveMQ). These settings are related to AMQ service and you can set them in both Conversion and ADx installations. Note that not all properties mentioned here are added to the settings file by default.

PropertyDescriptionDefault
AMQ_SERVER_BINDADDRESSThe local IP address that the ActiveMQ broker should listen on. Use 0.0.0.0 to listen on all IP interfaces.0.0.0.0
AMQ_SERVER_PORTThe server port of the ActiveMQ broker.61616
AMQ_SERVER_DATA_DIRECTORYThe folder where ActiveMQ should put its data files. If the state of the ActiveMQ service should stay consistent between re-installations, this must be set.WEB-INF/activemq-data
AMQ_SERVER_BROKER_NAMEThe name that the local ActiveMQ broker should get. If this is not set, a default name that contains the local IP address and the listening port will be created.null
AMQ_SERVER_USE_JMXBoolean flag that indicates whether the ActiveMQ broker should support JMX access. This can be useful for debugging purposes or when using a monitoring/inspection tool like HawtIO.false
AMQ_SERVER_PERSISTENCE_DB_DIRECTORYDefines where the persistence database should be stored.WEB-INF/activemq-db
AMQ_SERVER_HEAP_USAGE_IN_PERCENTAn Integer value that defines how much heap (in percent) the ActiveMQ broker should use.70
AMQ_SERVER_DISK_USAGE_LIMITThe maximum number of bytes that ActiveMQ is allowed to occupy on the disk in general.100000000 (100 MB)
AMQ_SERVER_TEMP_USAGE_LIMITThe maximum number of bytes that ActiveMQ is allowed to occupy on the disk for temporary files.10000000 (10 MB)
AMQ_SERVER_CREATE_VM_CONNECTORBoolean flag for indicating whether ActiveMQ should also add a vm://localhost connector. See the ActiveMQ documentation for more details.false
AMQ_SERVER_PERSISTENTIndicates whether the messages should be persisted. This would increase the fault tolerance, but also decreases the performance. Set this to true when there a mission-critical messages that are not re-sent.false
AMQ_CLUSTER_NODESA comma-separated list of IP addresses (or hostnames) or ActiveMQ instances that should form a cluster. The address may contain a port (separated by a colon), if the port is not part of the hostname, it will be assumed to be the same port as AMQ_SERVER_PORT. The hostname and the colon must be URL-encoded.null

Tribefire Runtime Properties

These properties configure the Tribefire platform. You can set them in both Conversion and ADx installations. Note that not all properties mentioned here are added to the settings file by default.

PropertyDescriptionDefault
ELASTIC_RUN_SERVICEWhether an elasticsearch service should be started together with this ADx installation.true
ELASTIC_SERVICE_DATA_PATHThe base directory to store elasticsearch indices../data
ELASTIC_CREATE_DEMO_ACCESSWhether to enable the default elasticsearch access.false
TRIBEFIRE_SECURED_ENVIRONMENTEnables support for encrypted passwords in this filetrue
TRIBEFIRE_PUBLIC_SERVICES_URLThe public tribefire services URL, which must be reachable from API clients and other services.https://[PUBLIC_HOST]:[PUBLIC_PORT]/tribefire-services
TRIBEFIRE_RUNTIME_OFFER_STAYSIGNEDWhen set to true, the login dialog offers the option Stay signed in. If this option is selected, the session cookie will remain active, even if the user closes the browser session. If it's set to false (or, if the user disables the check box in the login dialog), the session cookie sent to the browser will have no expiry date, thus will be removed when the browser is closed (unless the default behaviour of your browser is different).false
TRIBEFIRE_USER_SESSIONS_MAX_IDLE_TIMESpecifies how long a user session should remain active when there is no activity on the session. After the specified inactive time has passed (i.e. no request with the corresponding session ID has been received by the server), the session is flagged as inactive and consequently removed by a periodic cleanup process. The time span can be specified as a human-readable string, using numbers and the time unit, as in 12h, 30m, 3600s, etc.24h