Analyze properties

1. Introduction

You can set the configuration properties via ConnectPlaza® Deploy. Select the Agent you want to configure, then Agent configuration. Choose Analyze in the selection box to see its settings. See Deploy Configuration for more information.

Every configuration has two properties files: a -default.properties file and a .properties file, as described above.

The connectplaza-analyze-default.properties file holds the default settings for every property concerning your ConnectPlaza® Agent. The connectplaza-analyze.properties file holds the changes you make through Agent configuration in ConnectPlaza® Deploy.

The section about SMTP/email is going to be removed from later versions because sending email has become more and more complicated.
Because of this, we decided to remove the mail option altogether.
For now it is available only for backwards compatibility with the old version of ConnectPlaza® Analyze.

 
################################################################################
# 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

# Label            : Analyze cleanup batch size
# Description      : The number of Analyze messages or business entities to delete in one transaction.
#                    If the database becomes unresponsive during cleanup, you can try lowering this value.
#                    Note that a lower value will slow down the cleanup process, particularly in combination
#                    with a high value for connectplaza.analyze.cleanup.batch.pause.ms.
# Type             : NUMBER
connectplaza.analyze.cleanup.batch.size=10

# Label            : Analyze cleanup batch pause in milliseconds
# Description      : The number of milliseconds to pause between individual Analyze cleanup transactions.
#                    If the database becomes unresponsive during cleanup, you can try increasing this value.
#                    Note that a higher value will slow down the cleanup process, particularly in combination
#                    with a low value for connectplaza.analyze.cleanup.batch.size.
# Type             : NUMBER
connectplaza.analyze.cleanup.batch.pause.ms=10

# Label            : Enable cascading delete
# Description      : Enables cascading delete for Analyze messages and business entities. This can greatly speed
#                    up cleanup jobs.
#                    Note that this only works using the 5.0 Analyze database schema or later. In particular, the
#                    foreign key constraints must include ON DELETE CASCADE (or the vendor-specific equivalent).
# Type             : SELECT
# Permitted Values : [true, false]
connectplaza.analyze.enable.cascading.delete=false


################################################################################
# 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

################################################################################
# PIPELINE SETTINGS
################################################################################

# Label            : Pipeline Storage Directory
# Description      : Directory for storing pipeline definitions
# Type             : TEXT
connectplaza.analyze.pipeline.storage.directory=.data/analyze

# Label            : Enable Pipeline Processing
# Description      : Enable processing of pipelines
# Type             : SELECT
# Permitted Values : [true, false]
connectplaza.analyze.pipeline.processing.enable=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 consists only of the changed properties rather than all of them, which is more readable than 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

2. Retention and cleanup

Cleanup is disabled by default. Both connectplaza.analyze.cleanup.enabled (Analyze messages) and connectplaza.analyze.be.cleanup.enabled (business entities) ship as false, so nothing is ever deleted and the database grows without limit until an administrator turns them on.

The two cleanup jobs are independent, and each has its own switch, schedule and expiration:

Property Default What it does

connectplaza.analyze.cleanup.enabled

false

Whether stored Analyze messages are ever deleted.

connectplaza.analyze.cleanup.cron

0 0 2 * * *

When that job runs. A six-field Spring cron expression - see the installation guide for the field order.

connectplaza.analyze.cleanup.expiration

720

How old a message must be, in hours. 720 is 30 days.

connectplaza.analyze.be.cleanup.enabled

false

The same, for business entities.

connectplaza.analyze.be.cleanup.cron

0 0 2 * * *

When the business entity job runs. Same six-field Spring cron expression.

connectplaza.analyze.be.cleanup.expiration

720

How old a business entity must be, in hours. 720 is 30 days.

connectplaza.analyze.cleanup.batch.size

10

Rows deleted per transaction. Lower it if the database struggles during cleanup.

connectplaza.analyze.cleanup.batch.pause.ms

10

Pause between transactions. Raise it for the same reason.

connectplaza.analyze.enable.cascading.delete

false

Much faster cleanup, but only on the 5.0 Analyze schema or later, where the foreign keys carry ON DELETE CASCADE.

The batch size and pause exist to keep a cleanup run from monopolising the database. If a nightly cleanup makes the database unresponsive, lower the batch size and raise the pause rather than switching cleanup off.

3. Business entities: two engines

Analyze can populate business entities in two independent ways, and in 5.3.0 they no longer affect each other.

Property Default What it does

connectplaza.analyze.pipeline.processing.enable

true

Runs the pipelines described in Pipelines. This is the current mechanism.

ema.messagestore.advancedmode

true

Runs the older rule-set engine, kept for installations that still depend on it.

Both are enabled by default, and each is evaluated on its own for every message. Turning one off does not turn the other off.

If you are coming from a pre-5.3.0 installation, note that pipeline processing is on out of the box and does not depend on ema.messagestore.advancedmode, which used to be the switch that gated business entities as a whole.

connectplaza.analyze.pipeline.storage.directory (default .data/analyze) is where the agent keeps its copy of the pipeline configuration. It does not need backing up: the configuration lives in your Studio profile and is sent to the agent again whenever a document is promoted to snapshot, and after the agent reconnects.

4. Hibernate values

Analyze uses Hibernate to create and update the Analyze database for you.

You set these values on the ConnectPlaza® Agent in Deploy.

If you need a database that is not in the dropdown, contact ConnectPlaza® for the settings it needs in the configuration file.

5. A word about writing messages to the database

Every Analyze write to the database goes through the agent’s internal JMS broker, ActiveMQ Classic 5.19.7. The broker stores the queue on disk, so a message that has reached it survives a restart of the ConnectPlaza® Agent.

If the database is down when a message is picked up, the write fails and the broker redelivers it. There are four redeliveries, the first after a minute and each following one four times further apart than the last, which spreads them over roughly 85 minutes in total. A database that returns inside that window costs you nothing: the next redelivery succeeds and the backlog drains on its own.

A message that still cannot be written after the fourth redelivery is moved to the broker’s dead-letter queue, where Analyze consumes it and logs Failed to redeliver Analyze message. The message is not stored, and it is not retried again. An outage longer than about 85 minutes therefore loses the traffic that arrived during it, and the only record is that line in the agent log.

None of this is configurable: there is no property that lengthens the retry window and no folder to resubmit from. If you are planning maintenance on the Analyze database that will take longer than that, stop the interfaces that feed Analyze for the duration rather than relying on the queue to hold them.

Reconnection itself needs no attention. The connection pool and the JDBC driver re-establish the connection between them as soon as the database answers again.