Technical Guide Reference Guide Frequently Asked Questions Tutorials
Show menu

Analyze Properties

Analyze Properties

You can set the configuration properties via ConnectPlaza Deploy. Select the agent you want to configure and select Agent configuration. Select in the selection box the Analyze and you will be presented with the correct settings. See Deploy Configuration for more information.

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

The connectplaza-analyze-default.properties file contains the default settings for all properties concerning your ConnectPlaza Agent, the connectplaza-analyze.properties file contains your changes made through the Agent Configuration option in ConnectPlaza Deploy.  
 
################################################################################
# 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-analyze.properties file.
################################################################################


################################################################################
# ANALYZE SQL SETTINGS
################################################################################

# Label            : Driver Classname
# Description      : Driver class for SQL Database
# Type             : TEXT
connectplaza.analyze.jdbc.driverclass=org.hsqldb.jdbcDriver

# Label            : Database URL
# Description      : URL to connect to SQL Database
# Type             : TEXT
connectplaza.analyze.jdbc.url=jdbc:hsqldb:mem:mem:ema

# Label            : Database username
# Type             : TEXT
connectplaza.analyze.jdbc.username=sa

# Label            : Database password
# Type             : SECRET
connectplaza.analyze.jdbc.password=

# Label            : Database Dialect
# Type             : TEXT
connectplaza.analyze.jdbc.dialect=org.hibernate.dialect.HSQLDialect

# Label            : Database Enable Debug
# Type             : SELECT
# Permitted Values : [true, false]
connectplaza.analyze.jdbc.debug=false

# Label            : Hibernate Database Generation
# Description      : USE with ABSOLUTE CARE! Can destroy existing database!
# Type             : SELECT
# Permitted Values : [create, update, validate, create-drop]
connectplaza.analyze.jdbc.hbm2dll=update

# Label            : Database table prefix
# Type             : TEXT
connectplaza.analyze.jdbc.prefix=ema

# Label            : MySQL Database storage engine
# Type             : TEXT
connectplaza.analyze.jdbc.storage_engine=innodb


################################################################################
# ANALYZE MONGO SETTINGS
################################################################################

# Label            : Mongo Database name
# Type             : TEXT
connectplaza.analyze.mongo.db=analyze

# Label            : Mongo Hostname
# Type             : TEXT
connectplaza.analyze.mongo.host=localhost

# Label            : Mongo port
# Type             : NUMBER
connectplaza.analyze.mongo.port=27017

# Label            : Mongo username
# Type             : TEXT
connectplaza.analyze.mongo.user=

# Label            : Mongo password
# Type             : SECRET
connectplaza.analyze.mongo.password=

# Label            : Mongo write concern
# Type             : SELECT
# Permitted Values : [ACKNOWLEDGED, JOURNALED, MAJORITY, UNACKNOWLEDGED]
connectplaza.analyze.mongo.writeconcern=ACKNOWLEDGED


################################################################################
# DATABASE CLEANUP
################################################################################

# Label            : Cleanup enabled for messages
# Description      : Enables the internal cleanup mechanism for messages
# Type             : SELECT
# Permitted Values : [true, false]
connectplaza.analyze.cleanup.enabled=false

# Label            : Cleanup Schedule for messages
# Description      : Schedule for executing internal cleanup for messages
# Type             : CRON
connectplaza.analyze.cleanup.cron=0 0 2 * * *

# Label            : Cleanup Expiration in hours for messages
# Description      : Any message older than this expiration will be deleted. Defaults to 30 days.
# Type             : TEXT
connectplaza.analyze.cleanup.expiration=720

# Label            : Cleanup enabled for business entities
# Description      : Enables the internal cleanup mechanism for business entities
# Type             : SELECT
# Permitted Values : [true, false]
connectplaza.analyze.be.cleanup.enabled=false

# Label            : Cleanup Schedule for business entities
# Description      : Schedule for executing internal cleanup for business entities
# Type             : CRON
connectplaza.analyze.be.cleanup.cron=0 0 2 * * *

# Label            : Cleanup Expiration in hours for business entities
# Description      : Any business entity older than this expiration will be deleted. Defaults to 30 days.
# Type             : TEXT
connectplaza.analyze.be.cleanup.expiration=720


################################################################################
# ANALYZE GENERAL SETTINGS
################################################################################

# Label            : Export path
# Description      : Path for exporting reports
# Type             : TEXT
ema.export.path=temp

# Label            : Enables Business Entity Mappings
# Type             : SELECT
# Permitted Values : [true, false]
ema.messagestore.advancedmode=true


################################################################################
# HIBERNATE SETTINGS
################################################################################

# Label            : Initial pool size
# Type             : NUMBER
hibernate.c3p0.initialPoolSize=10

# Label            : Minimal pool size
# Type             : NUMBER
hibernate.c3p0.minPoolSize=1

# Label            : Maximal pool size
# Type             : NUMBER
hibernate.c3p0.maxPoolSize=25

# Label            : Acquire attempts
# Type             : NUMBER
hibernate.c3p0.acquireRetryAttempts=10

# Label            : Acquire increment
# Type             : NUMBER
hibernate.c3p0.acquireIncrement=5

# Label            : Idle connection test period
# Type             : NUMBER
hibernate.c3p0.idleConnectionTestPeriod=3600

# Label            : Test connection on checkin
# Type             : SELECT
# Permitted Values : [true, false]
hibernate.c3p0.testConnectionOnCheckin=false

# Label            : Max connection age
# Type             : NUMBER
hibernate.c3p0.maxConnectionAge=14400

# Label            : Max idle time
# Type             : NUMBER
hibernate.c3p0.maxIdleTime=10800

# Label            : Context classloader
# Type             : TEXT
hibernate.c3p0.contextClassLoaderSource=caller


################################################################################
# MAIL SETTINGS
################################################################################

# Label            : From
# Description      : Specify mail From Address
# Type             : TEXT
connectplaza.analyze.mail.from=

# Label            : ReplyTo
# Description      : Specify mail ReplyTo Address
# Type             : TEXT
connectplaza.analyze.mail.replyto=

# Label            : Mail Server Port
# Description      : Mail server SMTP Port
# Type             : NUMBER
connectplaza.analyze.mail.port=587

# Label            : Mail Server Host
# Description      : Mail server SMTP Host
# Type             : TEXT
connectplaza.analyze.mail.host=

# Label            : Mail Server username
# Description      : Mail Server username
# Type             : TEXT
connectplaza.analyze.mail.username=

# Label            : Mail Server password
# Description      : Mail Server password
# Type             : SECRET
connectplaza.analyze.mail.password=

# Label            : Enable StartTLS
# Description      : Enable StartTLS
# Type             : SELECT
# Permitted Values : [true, false]
connectplaza.analyze.mail.starttls.enable=false
 
When you download the Agent the next parameters are written for ConnectPlaza ANALYZE to the configuration before downloading the agent. This will end up in the connectplaza-analyze.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 Analyze Properties
#Wed Oct 09 09:11:13 CEST 2024
connectplaza.analyze.jdbc.driverclass=org.hsqldb.jdbcDriver
connectplaza.analyze.jdbc.password=
connectplaza.analyze.jdbc.url=jdbc\:hsqldb\:mem\:mem\:analyze
connectplaza.analyze.jdbc.dialect=org.hibernate.dialect.HSQLDialect
connectplaza.analyze.jdbc.username=sa

Hibernate values

Analyze uses hibernate to automatically create / update the analyze database.

You can set the values via the ConnectPlaza agent in Deploy.

If you need a database which you cannot select via the drop down, please contact ConnectPlaza to inform you about the needed settings in the configuration file.

A word about writing messages to the database

We have taken several measures to realise maximum guarantees that all Analyze messages are correctly persisted to your database. First of all, all Analyze transactions to the database are performed through our internal JMS (ActiveMQ) broker to ensure reliability and recovery between restarts of the ConnectPlaza Agent and that all messages are stored persistently and will all be delivered to the database.

During the case of downtime of the database of connection loss, Analyze will ensure that all messages are retained and none are lost, through the use of the ActiveMQ’s JMS queues. When a connection error occurs, this will result in technical failure that will cause the system to store all Analyze messages that cannot be delivered onto the database, into a separate folder on your system.

When the connection to the database is recovered, Analyze will attempt to deliver the entire backlog of un-stored messages onto the database. This may take some time as there may be many messages awaiting retry. All stored messages, during the connection loss, will be automatically resubmitted into Analyze.

The settings to regulate the resubmission of messages can be found in the connectplaza-analyze.properties file:

ema.messagestore.basic.error.discardtimeoutmillis= 10810000   --> Time in milliseconds, after which the RME messages will be deleted.
ema.messagestore.basic.error.startdelay          = 2410000    --> Delay time in milliseconds, after which Analyze will attempt a resubmission of all files in the resubmission folder.

ema.messagestore.basic.error.repeatinterval      = 3600000    --> Interval time in milliseconds, after which Analyze will rescan the submission folder.

Database reconnection functionality will be automatically managed by the database pool manager along with the JDBC driver of the selected database vendor.