Skip to main content
Skip table of contents

Creating the Access Server Properties File

  1. Navigate to the Cantara Installation Component Folders on your Access Server.

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

  3. Add definitions for the properties listed in the table below. Customize values to suit your deployment. Refer to Cantara Access Server Properties for further information.

    PropertyValueComment
    cantara.agent.urlhttps://agent.example.comThis property is only required for deployments that include a Cantara Agent server. Modify the url to suit your deployment.
    cantara.jdbc.drivercom.mysql.cj.jdbc.Driver
    cantara.jdbc.urljdbc\:mysql\://localhost\:3306/cip6_access_enterprise?useSSL\=false&rewriteBatchedStatements=true&allowPublicKeyRetrieval\=true&serverTimezone\=Australia/Brisbane
    cantara.hibernate.dialectorg.hibernate.dialect.MySQL8Dialect
    cantara.jdbc.usernamecantara
    cantara.jdbc.passwordcantara



  4. At web application startup, Cantara will insert additional properties into this file using default values. The additional properties can also be modified as required.

Cantara Access Server Properties

(* indicates required property)

Property

Default Value

Comment

Networking
cantara.agent.url
For deployments that include a Cantara Agent Server, this property defines the agent server url
cantara.clustered.instancefalseSet to true if the access endpoint represents multiple access servers deployed within a containerized environment.
cantara.socket.timeout0Max duration for web connection with Access Server (milliseconds). 0=Indefinite
cantara.request.timeout30000Max wait time for a response (milliseconds)
cantara.connections.route250Max connections pooled together for an endpoint
cantara.connections.max500Max open connections
cantara.connection.timeout15000Max wait time for an initial connection (milliseconds)
cantara.session.timeout30Max duration of web session (minutes)
cantara.encrypted.range60Maximum age of encrypted login payload in seconds
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.pool.mincantara.jdbc.pool.size valueMin open connections in parallel
cantara.jdbc.connection.timeout30000JDBC connection timeout in milliseconds
cantara.jdbc.idle.timeout300000Time in milliseconds open connections are maintained when minimum pool size is less than maximum pool size
cantara.jdbc.max.lifetime1800000Maximum life of pooled connection in milliseconds
cantara.jdbc.leak.threshold10000Leak detection threhold in milliseconds. Connections not returned to the connection pool within this time will cause a warning in the log file.
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_sqlfalseShow SQL transactions in logs (true or false)
cantara.hibernate.format_sqlfalseFormat SQL transaction for logs (true or false)
cantara.hibernate.jdbc.batch_size20Batch SQL transactions
Scheduler
cantara.scheduler.threads0Number of active threads for scheduled jobs. This value should be managed through the Cantara Administration Console
cantara.system.threads8Number of active threads for system management jobs.
cantara.scheduler.id*
Scheduler instance name. Must be set if scheduler is active.
cantara.scheduler.purge24Max age of active scheduler group in hours.
Logging
cantara.log.levelINFOLog detail level (Should be managed through Cantara Administration Console)
cantara.log.path*
Path to log file
Email
cantara.mail.hostnamelocalhost SMTP hostname
cantara.mail.port25SMTP port number
cantara.mail.protocolsmtpMail transport protocol (smtp or smtps supported)
cantara.mail.username
SMTP username
cantara.mail.password
SMTP user password
cantara.mail.authfalseAuthentication enabled (true or false)
cantara.mail.tlsfalseTLS encryption enabled (true or false)
cantara.mail.fromnoreply@cantara.cloudDefault email from address if not specified
Proxy Server
cantara.proxy.host
Proxy server hostname
cantara.proxy.port0Proxy server port
cantara.proxy.username
Proxy server access username
cantara.proxy.password
Proxy server access password
cantara.proxy.mediafalseUse proxy server to access HTTP media attachments (true or false)
Other
cantara.async.threads100Number of processing threads run by the console
cantara.async.timeout300000Maximum transaction processing time (milliseconds)
cantara.raw.enabledfalseEnable raw communications with JDE Enterprise Servers (should only be enabled for debugging)






JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.