Creating the Console Properties File

  1. Navigate to the Cantara Installation Component Folder on your Console Server.

  2. In the console/etc subfolder, create a text file called cantara-console.properties

  3. Add definitions for the properties listed in the table below. Customize values to suit your deployment. Refer to Creating the Console Properties File | Cantara Administration Console Properties for further information.

    Property

    Value

    Comment

    cantara.jdbc.driver

    com.mysql.cj.jdbc.Driver


    cantara.jdbc.url

    jdbc\:mysql\://localhost\:3306/cip6_console_enterprise?useSSL\=false&rewriteBatchedStatements=true&allowPublicKeyRetrieval\=true&serverTimezone\=Australia/Brisbane


    cantara.hibernate.dialect

    org.hibernate.dialect.MySQL8Dialect


    cantara.jdbc.username

    cantara


    cantara.jdbc.password

    cantara


  4. At web application startup, Cantara will insert additional properties into this file using default values. A summary of the additional properties and their purpose is provided below. The additional properties can also be modified as required.

Cantara Administration Console Properties

Property

Default Value

Comment

Networking

cantara.socket.timeout

0

Max duration for web connection with Access Server (milliseconds). 0=Indefinite

cantara.request.timeout

30000

Max wait time for a response (milliseconds)

cantara.connections.route

250

Max connections pooled together for an endpoint

cantara.connections.max

500

Max open connections

cantara.connection.timeout

15000

Max wait time for an initial connection (milliseconds)

cantara.session.timeout

30

Max duration of web session (minutes)

cantara.mail.hostname

localhost 

SMTP hostname

cantara.mail.port

25

SMTP port number

cantara.mail.protocol

smtp

Mail transport protocol (smtp or smtps supported)

cantara.mail.username


SMTP username

cantara.mail.password


SMTP user password

cantara.mail.auth

false

Authentication enabled (true or false)

cantara.mail.tls

false

TLS encryption enabled (true or false)

cantara.mail.from

noreply@cantara.cloud

Default email from address if not specified

cantara.proxy.host


Proxy server hostname

cantara.proxy.port

0

Proxy server port

cantara.proxy.username


Proxy server access username

cantara.proxy.password


Proxy server access password

cantara.proxy.media

false

Use proxy server to access HTTP media attachments (true or false)

Database

cantara.jdbc.driver


JDBC driver class name

cantara.jdbc.url


Database connection string

cantara.jdbc.pool_size


Max open connections in parallel

cantara.jdbc.username


Database connection username

cantara.jdbc.password


Database connection password

cantara.hibernate.dialect


Database type (Oracle12cDialect, MySQL8Dialect, MySQL57Dialect, SQLServer2012Dialect, SQLServer2008Dialect)

cantara.hibernate.show_sql

false

Show SQL transactions in logs (true or false)

cantara.hibernate.format_sql

false

Format SQL transaction for logs (true or false)

cantara.hibernate.jdbc.batch_size

20

Batch SQL transactions

Logging

cantara.log.level

INFO

Log detail level (Should be managed through

Cantara Administration Console

)

cantara.log.path


Path to log file

Other

cantara.async.threads

100

Number of processing threads run by the console

cantara.async.timeout

300000

Maximum transaction processing time (milliseconds)