Property File Settings for Connect - EcoSys - - Installation & Upgrade - Hexagon PPM

EcoSys Connect Installation and Configuration

PPMProduct
EcoSys
PPMCategory_custom
Installation & Upgrade
Version_EcoSys
1.1

This section lists the property file settings for Dispatcher, Agent, and Log Agent.

Dispatcher Property File Settings

The table below lists the property file setting for Dispatcher.

Property

Comment

Default

encryption.passphrase

Encryption phrase for sending messages

ironTissueVentPenny

ecosys.passphrase

EcoSys Encryption pass phrase

dispatcher.scheduler.threadPool.threadCount

Number of threads to be used to run jobs

20

dispatcher.springBatch.tablePrefix

Spring Batch database table prefix.

BATCH_

dispatcher.brokerURL

ActiveMQ broker URL

failover:ssl://[host]:61617

dispatcher.mq.trustStore.file

Location inside the container for the AMQ SLL Truststore file. This should not be changed

/opt/ecosys/connect-dispatcher/amq-client.ts

dispatcher.mq.trustStore.password

AMQ SSL Truststore password

dispatcher.clientID

ID used to register dispatcher as a client to AMQ. Should not be duplicated on any other Agents.

ConnectDispatcher

dispatcher.mq.username

ActiveMQ broker username

ecuser

dispatcher.mq.password

ActiveMQ broker password

dispatcher.workRequestQueue.prefix

ActiveMQ work request prefix for where work requests will be sent

connect_workRequests

dispatcher.workResponseQueue.prefix

ActiveMQ work response prefix for where work responses will be sent

connect_workResponses

dispatcher.cancelRequestTopic.name

ActiveMQ work cancel prefix for where work cancel will be sent

connect_cancelRequests

dispatcher.logRequestQueue.name

ActiveMQ work log request prefix for where log requests are sent to the Log Agent

connect_logRequests

dispatcher.logResponseQueue.name

ActiveMQ work log response prefix for where log responses are sent from the Log Agent

connect_logResponses

dispatcher.logRequest.timeout.seconds

Log response timeout setting

60

dispatcher.logResponse.pattern

Log4J pattern to format log messages for Log Agent

%d{ISO8601} %p [%t] %X{jobName}:%X{jobExecId}.%X{stepName} %c: %m

dispatcher.job.maxNestedCallDepth

Limits the job depth for the number of jobs to prevent infinite loops

10

dispatcher.job.cancellation.check.interval.seconds=

Interval in seconds to check job cancellation request while waiting response from response queue. Default is 5 sec.

5

dispatcher.default.stepExecution.timeout.minutes

Default timeout for job step execution in minutes.

30

dispatcher.default.commit.size

Default size of batch to submit by Agent Writer component.

25000

dispatcher.default.processBatch.size

Default size of batch for batch processors.

25000

dispatcher.default.job.timeout.seconds

Default job timeout in seconds for having notification messages to clients.

3600 (1 hour)

dispatcher.security.jwksURL=

URL for JSON Web Token Keystore for OAuth2 token verification.

dispatcher.security.tokenScope=

Scope assigned for EcoSys Connect Application on OAuth2 Authorization Server

debug.saveClasses.enabled

For debugging only. Saves the generated classes.

FALSE

debug.saveClasses.folder

Location in the container to generate the files

/opt/ecosys/connect-dispatcher/debug

debug.soap.logIncomingMessages.enabled

Log the incoming SOAP messages

FALSE

debug.soap.logOutgoingMessages.enabled

Log the Outgoing SOAP messages

FALSE

embed.ui.ecosys.url

EcoSys URL that the Connect UI will be embedded in

dispatcher.mode.production

When set to false WSDL it disables WSDL caching.

TRUE

metrics.enabled

Controls if metrics monitoring is enabled

TRUE

metrics.captureInterval.seconds

Metrics capturing interval in seconds.

10

metrics.reportingInterval.seconds

Metrics reporting interval in seconds. To disable reporting, set to 0.

120

metrics.jmxPerformanceCapture.enabled

Whether to use JMX to capture CPU utilization.

TRUE

metrics.diagnosticsResponseQueue.name

ActiveMQ queue name where Agent metrics will be sent for the Dispatcher

connect_diagnosticsResponses

metrics.diagnosticsRequestTopic.name

ActiveMQ topic name where diagnostics messages will be sent from Dispatcher to Agents

connect_diagnosticsRequests

dispatcher.mq.metrics.enabled

Whether ActiveMQ metrics are enabled or not.

TRUE

dispatcher.mq.metricsResponseQueue.name

ActiveMQ queue name where ActiveMQ stats will be reported from the ACtiveMQ broker for the dispatcher

connect_metricsResponses

dispatcher.dataStore.cleanupRequestQueue.name

ActiveMQ queue name where requests for inter step datastore cleanup requests will be sent

connect_dataStoreCleanupRequests

Agent Property File Settings

The table below lists all the property file settings for Agent.

Property

Comment

Default

encryption.passphrase

Encryption phrase for sending messages

ironTissueVentPenny

agent.brokerURL

ActiveMQ broker URL

failover:ssl://[host]:61617

agent.mq.trustStore.file

Location inside the container for AMQ SSL Truststore file. This should not be changed.

/opt/ecosys/connect-agent/config/amq-client.ts

agent.mq.trustStore.password

AMQ SSL Truststore password

agent.clientID

Client ID used to register the Agent with ActiveMQ.

If two or more agents are running on the same host, their client IDs must be different.

ConnectAgent

agent.mq.username

ActiveMQ broker username

ecuser

agent.mq.password

ActiveMQ broker password

agent.workRequestQueue.prefi

ActiveMQ work request prefix from where the work requests will come from

connect_workRequests

agent.workQueue.name

The queue that this Agent will receive work from. This must be the queue assigned to the Agent in the Connect UI.

agent.cancelRequestTopic.name

ActiveMQ work cancel prefix from where work cancel will come from

connect_cancelRequests

agent.processMetrics.maxLines

Process Metrics report can be huge and consume a lot of memory for its construction (depending on step batch sizes and processor complexity).
The setting below is to limit Process Metrics report to configured first number of the detailed report lines (after summary line).

-1 (Unlimited)

stepExecutor.soap.connectionTimeout.seconds

SOAP connection timeout in seconds.

0

stepExecutor.mongo.readBatchSize

MongoDB read batch size.

1000

stepExecutor.hierarchy.maxDepth

Max Hierarchy Depth allowed for HierarchyBuilderProcessor.

20

stepExecutor.parallelExecution.threadPoolSize

Thread pool size for parallel task execution

20

#stepExecutor.soap.fieldMapperParallelization.enabled

Whether field mapping can occur in parallel (across entities)

FALSE

stepExecutor.soap.maxChildElements

Maximum number of child elements for a given parent element

250000

stepExecutor.soap.maxElementDepth

Maximum depth of an element (# of hierarchy levels)

100

stepExecutor.soap.maxAttributeCount

Maximum number of attributes on a single element

500

stepExecutor.soap.maxAttributeSize

Maximum size of a single attribute in KB

64

stepExecutor.soap.maxTextLength

Maximum size of an elements text value in MB

128

agent.dataStore.mongo.connectionURL

URL to connect to the Mongo DataStore for the Agent

mongodb://[host]:[port]

agent.dataStore.mongo.databaseName

Mongo database name

connectData

agent.dataStore.mongo.username

Mongo datastore user name

Ecuser

agent.dataStore.mongo.password

Mongo datastore password

agent.dataStore.mongo.trustStore.password

Mongo truststore password

agent.dataStore.cleanupRequestQueue.name

Queue for cleanup request

connect_dataStoreCleanupRequests

Monitoring Settings

Property

Comment

Default

metrics.enabled

Allows to disable metrics monitoring altogether.

TRUE

metrics.captureInterval.seconds

Metrics capturing interval in seconds. To disable capturing of some metrics, set to 0.

10

metrics.reportingInterval.seconds=120

Metrics reporting interval in seconds. To disable reporting, set to 0

120

metrics.jmxPerformanceCapture.enabled

Specifies whether to use JMX to capture CPU utilization.

TRUE

metrics.reporting.jms.enabled

specifies whether metrics from the Agent must be also sent to Dispatcher via ActiveMQ queue.

TRUE

metrics.diagnosticsResponseQueue.name

ActiveMQ queue name where Agent metrics will be sent for the Dispatcher

connect_diagnosticsResponses

metrics.diagnosticsRequestTopic.name

ActiveMQ topic name where diagnostics messages will be sent from Dispatcher to Agents

connect_diagnosticsRequests

agent.log.jms.enabled

Specifies whether logging to JMS is enabled.

TRUE

agent.log.jms.ignoreExceptions

Specifies whether Agent should ignore exceptions. If JMS appender cannot write log event into queue or Agent should fail.

TRUE

debug.saveClasses.enabled

For debugging only. Saves the generated classes.

FALSE

debug.saveClasses.folder

Location in the container to generate the files

/opt/ecosys/connect-agent/debug

debug.soap.logIncomingMessages.enabled

Log the incoming SOAP messages.

Credentials are printed in clear text, delete the log files after debugging or remove before sharing log files.

FALSE

debug.soap.logOutgoingMessages.enabled

Log the outgoing SOAP messages.

Credentials are printed in clear text, delete the log files after debugging or remove before sharing log files.

FALSE

debug.soap.logMessages.maxSize

The logged SOAP message will be truncated when > this size (in KB)

100 KN

debug.soap.logMessages.prettyPrint.enabled

Specifies whether to pretty print the SOAP message

FALSE

agent.mode.production=false

When set to false WSDL, it disables WSDL caching.

TRUE

Log Agent Property File Settings

The table below lists the property files settings for Log Agent.

Property

Comment

Default

encryption.passphrase=ironTissueVentPenny

Encryption phrase for sending messages

ironTissueVentPenny

logAgent.brokerURL=failover:ssl://[host]:61617

ActiveMQ broker URL

failover:ssl://[host]:61617

logAgent.mq.trustStore.file

Location in Encryption phrase for sending messages to the container for the AMQ SSL Truststore file. This should not be changed.

/opt/ecosys/connect-log-agent/config/amq-client.ts

logAgent.mq.trustStore.password

AMQ SSL Truststore password

logAgent.clientID

Client ID used to register the Agent with ActiveMQ. If two or more agents are running on the same host, their client IDs must be different.

ConnectLogAgent

logAgent.mq.username

ActiveMQ broker username

ecuser

logAgent.mq.password

ActiveMQ broker password

xx

logAgent.incomingLogQueue.name

ActiveMQ queue name where log messages will come from.

connect_logQueue

logAgent.logRequestQueue.name

ActiveMQ topic name where log requests will come from.

connect_logRequests

logAgent.storage.mongo.connectionURL

Connection URL for Mongo DB that stored log messages. Mongo DB runs in the same container as the Log Agent. Mongo is a hostname local to the container

mongodb://mongo:27017

logAgent.storage.mongo.databaseName

Mongo database name

connectLogs

logAgent.storage.mongo.username

Mongo database user

xx

logAgent.storage.mongo.password

Mongo Databsae user's password

xx

logAgent.storage.mongo.readBatchSize

MongoDB read batch size.

1000

logAgent.logRequest.executionLog.lines.limit

Sets limit for Execution Log lines to be shown.

10000