ConnectPlazaAgent Properties

1. ConnectPlaza® Agent configuration

This chapter will inform you about the configuration options in the connectplaza-agent.properties and the connectplaza-agent-default.properties file.

As you download the ConnectPlaza® Agent from Deploy you will get a preconfigured ConnectPlaza® Agent. As you set some values before downloading the ConnectPlaza® Agent, these values will be injected into several .properties files.

Every configuratie has two properties files. A -default.properties file and a .properties file as described above.

The connectplaza-agent-default.properties file contains the default settings for all properties concerning your ConnectPlaza® Agent, the connectplaza-agent.properties file contains your changes made through the Agent Configuration option in ConnectPlaza® Deploy.

DO NOT CHANGE PROPERTIES IN THE PROPERTIES FILES! ONLY CHANGE PROPERTIES VIA THE CONNECTPLAZA® DEPLOY APPLICATION!

The *connectplaza-agent-default.properties file looks like this:

################################################################################
# WARNING
################################################################################
# This file is automatically generated and should not be edited manually.
#
# If you want to change the default value of a property, use the Deploy frontend
# or override the property in the connectplaza-agent.properties file.
################################################################################


################################################################################
# MANAGEMENT
################################################################################

# Label            : Management server
# Description      : URL to Management server
# Type             : TEXT
connect.mbean.server.connector.url=service:jmx:jmxmp://localhost:9876

# Label            : Default Management Domain
# Description      : Default Management Domain
# Type             : TEXT
connect.mbean.defaultdomain=com.connectplaza

# Label            : ConnectPlaza Management domain
# Description      : ConnectPlaza MBean domain
# Type             : TEXT
connect.mbean.connectdomain=com.connectplaza.connect.management

# Label            : Spring Integration Management domain
# Description      : Spring Integration MBean domain
# Type             : TEXT
connect.mbean.sidomain=com.connectplaza.si

# Label            : ComponentIndex as attribute
# Description      : ComponentIndex as attribute
# Type             : SELECT
# Permitted Values : [true, false]
connect.mbean.componentindex.asattribute=false

# Label            : ComponentIndex in name
# Description      : ComponentIndex in name
# Type             : SELECT
# Permitted Values : [true, false]
connect.mbean.componentindex.inname=true


################################################################################
# SUPPORT FOR ACTIVEMQ
################################################################################

# Label            : ActiveMQ broker
# Description      : URL to Internal ActiveMQ broker
# Type             : TEXT
connect.activemq.broker.uri=vm://localhost

# Label            : ActiveMQ persistency
# Description      : Persistency value
# Type             : SELECT
# Permitted Values : [true, false]
connect.activemq.broker.persistent=true

# Label            : ActiveMQ ignore missing journal files
# Description      : Ignore missing journal files for KahaDB persistence adapter
# Type             : SELECT
# Permitted Values : [true, false]
connect.activemq.broker.persistenceAdapter.ignoreMissingJournalFiles=false

# Label            : ActiveMQ max memory usage
# Description      : Allocated memory usage
# Type             : TEXT
connect.activemq.broker.systemusage.memoryusage=64mb

# Label            : ActiveMQ max disk store usage
# Description      : Maximum allowed disk usage
# Type             : TEXT
connect.activemq.broker.systemusage.storeusage=10gb

# Label            : ActiveMQ max swap space
# Type             : TEXT
connect.activemq.broker.systemusage.tempusage=2gb

# Label            : Default JMS Connection Factory
# Description      : Default internal JMS Connection Factory
# Type             : TEXT
connect.connectionfactory.name=activeMQFactory


################################################################################
# SUPPORT FOR AMQP
################################################################################

# Label            : AMQP host
# Type             : TEXT
connect.amqp.host=localhost

# Label            : AMQP port
# Type             : NUMBER
connect.amqp.port=5672

# Label            : AMQP username
# Type             : TEXT
connect.amqp.username=guest

# Label            : AMQP username
# Type             : SECRET
connect.amqp.password=guest


################################################################################
# NETWORK SETTINGS
################################################################################

# Label            : Network interface name
# Description      : Used to register ip address
# Type             : TEXT
connect.network.interfacename=eth0

# Label            : Default host address for HTTP consumers
# Type             : TEXT
connect.jetty.connector.host=127.0.0.1

# Label            : Default port address for HTTP consumers
# Type             : NUMBER
connect.jetty.connector.port=8088

# Label            : HTTP idle time
# Type             : TEXT
connect.jetty.connector.maxidletime=30000

# Label            : Number of HTTP acceptors
# Type             : NUMBER
connect.jetty.connector.acceptors=2

# Label            : Default HTTPS address
# Type             : TEXT
connect.jetty.sslconnector.host=127.0.0.1

# Label            : Default HTTPS port
# Type             : NUMBER
connect.jetty.sslconnector.port=8443

# Label            : Secure HTTPS idle time
# Type             : TEXT
connect.jetty.sslconnector.maxidletime=30000

# Label            : Number of HTTPS acceptors
# Type             : NUMBER
connect.jetty.sslconnector.acceptors=2


################################################################################
# SECURITY
################################################################################

# Label            : Accepted TLS Protocols
# Description      : A comma-separated list of supported TLS protocol versions.
# Type             : TEXT
connect.jetty.sslconnector.included.protocols=TLSv1,TLSv1.1,TLSv1.2,TLSv1.3

# Label            : Accepted TLS Ciphers
# Description      : A comma-separated list of supported TLS ciphers.
# Type             : TEXT
connect.jetty.sslconnector.included.ciphers=

# Label            : Default Keystore
# Type             : TEXT
connect.jetty.sslconnector.keystore=./context/connectplaza_keystore.jks

# Label            : Default Keystore Password
# Type             : SECRET
connect.jetty.sslconnector.keystore.password=opdion01

# Label            : Default Truststore
# Type             : TEXT
connect.jetty.sslconnector.truststore=./context/connectplaza_truststore.jks

# Label            : Default Truststore Password
# Type             : SECRET
connect.jetty.sslconnector.truststore.password=opdion01

# Label            : Include default JVM Truststore
# Description      : Enable loading of CA certificates
# Type             : SELECT
# Permitted Values : [true, false]
connect.ssl.ca.truststore=true


################################################################################
# PAYLOAD SETTINGS
################################################################################

# Label            : Payload size in bytes threshold warning
# Description      : Threshold for warning when ConnectMessagePart payload size exceeds this value
# Type             : NUMBER
connect.message-part.payload-size-in-bytes-threshold-warning=2097152


################################################################################
# THREADS AND TIMING
################################################################################

# Label            : Task Scheduler Pool Size
# Description      : The task scheduler runs services and producers when property connect.threadperflow=false. Make sure the pool size is at least 2 x the number of flows + 20!
# Type             : TEXT
connect.taskscheduler.poolsize=50

# Label            : Consumer Thread Pool Size
# Description      : Taskexecutors run pollable Consumers
# Type             : TEXT
connect.taskexecutor.poolsize=5-40

# Label            : Taskexecutor Queue size
# Description      : Consumer request buffer
# Type             : NUMBER
connect.taskexecutor.queue.capacity=200

# Label            : ThreadsPerFlow queue size
# Description      : when env var connect.threadsperflow=true (default) queuesize for Inbound- and OutboundServiceChannels
# Type             : NUMBER
connect.threadsperflow.queuesize=2000

# Label            : Global poller delay in ms
# Description      : Fixed delay for all pollers
# Type             : NUMBER
connect.globalpoller.fixed-delay=50

# Label            : Global poller receive timeout
# Description      : Poller thread will wait this amount of time for message to arrive on polled queue, after that Thread will return to pool
# Type             : NUMBER
connect.globalpoller.receive-timeout=500

# Label            : Per Flow Consumer Taskexecutor Queue size
# Description      : Queue size for Concurrent Flows
# Type             : NUMBER
connectplaza.flow.taskexecutor.queue.capacity=200

# Label            : Per Flow Consumer Executor pool size
# Description      : Pool size for Consumers in Concurrent Flows
# Type             : TEXT
connectplaza.flow.taskexecutor.poolsize=5-20


################################################################################
# LICENSE
################################################################################

# Label            : License owner
# Type             : TEXT
connect.license.owner=dummy

# Label            : License key
# Type             : TEXT
connect.license.key=

# Label            : License in cloud
# Type             : SELECT
# Permitted Values : [true, false]
connect.license.cloud=true

# Label            : Cloud Backend URL
# Type             : TEXT
connect.cloudserver.uri=https://backend.connectplaza.com:443


################################################################################
# INTERFACE MANAGEMENT
################################################################################

# Label            : Do not start these interfaces
# Type             : TEXT
connect.adapters.donotstart=


################################################################################
# HTTP PROXY SETTINGS
################################################################################

# Label            : Proxy host
# Type             : TEXT
connect.http.proxyHost=

# Label            : Proxy port
# Type             : NUMBER
connect.http.proxyPort=

# Label            : Proxy user
# Type             : TEXT
connect.http.proxyUser=

# Label            : Proxy password
# Type             : SECRET
connect.http.proxyPassword=

# Label            : Secure Proxy host
# Type             : TEXT
connect.https.proxyHost=

# Label            : Secure Proxy port
# Type             : NUMBER
connect.https.proxyPort=

# Label            : Secure Proxy user
# Type             : TEXT
connect.https.proxyUser=

# Label            : Secure Proxy password
# Type             : SECRET
connect.https.proxyPassword=


################################################################################
# HTTP/REST LISTENER
################################################################################

# Label            : Max Multipart Upload Size in Bytes
# Description      : Max Multipart Upload Size in Bytes
# Type             : NUMBER
connect.http.max-upload-size-in-bytes=10000000

# Label            : Max Form URL Encoded Upload Size in Bytes
# Description      : Max Form URL Encoded Upload Size in Bytes
# Type             : NUMBER
connect.http.max-form-url-encoded-upload-size-in-bytes=200000


################################################################################
# EXTERNAL ANALYZE INTEGRATION
################################################################################

# Label            : Connection Factory
# Description      : Connection Factory used by the JMS based consumer of the Analyze Flow for receiving messages from external JMS implementations
# Type             : TEXT
connect.analyze.connectionfactory=connectionFactory

# Label            : Analyze JMS queue name
# Description      : Name of the external queue used by JMS based consumer of the Analyze Flow receive messages
# Type             : TEXT
connect.analyze.queue=queue.analyze


################################################################################
# ANALYZE DATABASE ENGINE
################################################################################

# Label            : Analyze Storage Type
# Type             : SELECT
# Permitted Values : [SQL, MONGO]
connect.analyze.storagetype=SQL


################################################################################
# LARGE FILE SUPPORT
################################################################################

# Label            : Large File Support timeout
# Type             : NUMBER
connect.lfs.timeout=3600


################################################################################
# INTERNAL SUPPORT FLOWS
################################################################################

# Label            : Store channel directory
# Type             : TEXT
connect.adapter.myesbcommon.storechannel.storedirectory=./temp/storechannel

# Label            : Default mail host
# Type             : TEXT
connect.adapter.myesbcommon.mailchannel.smtp.host=test-host

# Label            : Default mail port
# Type             : NUMBER
connect.adapter.myesbcommon.mailchannel.smtp.port=25

# Label            : Default mail host user
# Type             : TEXT
connect.adapter.myesbcommon.mailchannel.smtp.username=test-username

# Label            : Default mail host password
# Type             : SECRET
connect.adapter.myesbcommon.mailchannel.smtp.password=test-password

# Label            : Default mail host to address
# Type             : TEXT
connect.adapter.myesbcommon.mailchannel.smtp.to=test

# Label            : Default mail host from address
# Type             : TEXT
connect.adapter.myesbcommon.mailchannel.smtp.from=test

# Label            : Default mail host subject
# Type             : TEXT
connect.adapter.myesbcommon.mailchannel.smtp.subject=Exception Report

# Label            : Default mail host starttls
# Type             : SELECT
# Permitted Values : [true, false]
connect.adapter.myesbcommon.mailchannel.smtp.starttls=false

# Label            : Default mail host debug
# Type             : SELECT
# Permitted Values : [true, false]
connect.adapter.myesbcommon.mailchannel.smtp.maildebug=false


################################################################################
# UPDATE SETTINGS
################################################################################

# Label            : Schedule for automatic updates
# Description      : When Update Mode is 'scheduled-update', updates will be automatically installed on given Schedule
# Type             : CRON
install.updates.crontimer=0 0 1 * * *

# Label            : Update Mode
# Type             : SELECT
# Permitted Values : [user-restart, scheduled-update]
install.updates.mode=user-restart


################################################################################
# MAIL PRODUCER SETTINGS
################################################################################

# Label            : Default smtp timeout for mail producer in ms
# Type             : NUMBER
connect.smtp.timeout=30000

When you download the Agent the next parameters are written to the configuration before downloading the agent. This will end up in the connectplaza-agent.properties file. This file consist only of the changed properties, and not with all the properties available. This is more readable then the pre 5.0 version.

#ConnectPlaza Agent Properties
#Wed Oct 09 09:11:13 CEST 2024
connect.license.key=NUP5-19YX-AJMY-JS2V-523T
connect.cloudserver.uri=https\://backend.connectplaza.com
connect.mbean.server.connector.url=service\:jmx\:jmxmp\://localhost\:9876
connect.jetty.sslconnector.port=8443
connect.jetty.connector.port=8088
connectplaza.rsocket.gatewayuri=wss\://rsocket.connectplaza.com
connect.analyze.storagetype=SQL

Parameter	Value example	Description
connect.mbean.server.connector.url	service:jmx:jmxmp://localhost:9876	This is the connection to the ConnectPlaza® JMX server.
connect.jetty.sslconnector.host	localhost	This is the hostname or IP of the SSL Server of the agent. This is where the ConnectPlaza® Agent binds to when using SSL connections
connect.license.key	XXXX-XXXX-XXXX-XXXX-XXXX	This is the license code of you ConnectPlaza® Agent. Every Agent has its own licensekey.
connect.jetty.connector.host	localhost	This is the hostname or IP of the Server of the agent. This is where the ConnectPlaza® Agent binds to if using non-SSL connections
connect.cloudserver.uri	https://www.connectplaza.com:8443	This is the connection to the cloudserver. Only change this if told by a ConnectPlaza® consultant.
connect.jetty.sslconnector.port	8443	Port number of the SSL connection to the ConnectPlaza® Agent
connect.jetty.connector.port	8088	Port number of the non-SSL connection to the ConnectPlaza® Agent

Parameter

Value example

Description

connect.mbean.server.connector.url

service:jmx:jmxmp://localhost:9876

This is the connection to the ConnectPlaza® JMX server.

connect.jetty.sslconnector.host

localhost

This is the hostname or IP of the SSL Server of the agent. This is where the ConnectPlaza® Agent binds to when using SSL connections

connect.license.key

XXXX-XXXX-XXXX-XXXX-XXXX

This is the license code of you ConnectPlaza® Agent. Every Agent has its own licensekey.

connect.jetty.connector.host

localhost

This is the hostname or IP of the Server of the agent. This is where the ConnectPlaza® Agent binds to if using non-SSL connections

connect.cloudserver.uri

https://www.connectplaza.com:8443

This is the connection to the cloudserver. Only change this if told by a ConnectPlaza® consultant.

connect.jetty.sslconnector.port

8443

Port number of the SSL connection to the ConnectPlaza® Agent

connect.jetty.connector.port

8088

Port number of the non-SSL connection to the ConnectPlaza® Agent