application.yml
The application.yml file configures the Sign-Off database settings, including initial load, schema, cube-level adjustments, conflicts, and domains.
Location: signoff-starter\src\main\resources.
File values
| Property | Value | Description |
|---|---|---|
| server.port | 9090 | Port used by the sign-off server application |
| management.endpoints.web.exposure.include | “*” | List of the Spring Boot Actuator endpoint exposed in the application |
Section: content.hibernate
This section configures the Content Service database and connections to the Content Server.
| Property | Value | Description |
|---|---|---|
| content.hibernate.connection.url | “jdbc:h2:mem:content_service;DB_CLOSE_DELAY=-1” | URL of the Hibernate connection to the content server. |
| content.hibernate.connection.driver_class | org.h2.Driver | Driver used for the Hibernate connection to the content server. |
| content.hibernate.show_sql | false | Flag used to set up the printing of the SQL queries in the Hibernate logs. |
| content.hibernate.format_sql | false | Flag used to set up the formatting of the SQL queries in the Hibernate logs. |
| content.hibernate.hbm2ddl.auto | update | Hibernate DDL generation setup to run on startup against the content server database. NOTE: Remove this line once the table is created. |
| content.hibernate.connection.globally_quoted_identifiers | false | Enable/disable quoting database identifiers for the Content Server database. Disabled by default. |
| content.hibernate.hikari.connectionTimeout | 30000 | Maximum time (in milliseconds) that a client will wait for a connection from the pool (connection to the content server). |
| content.hibernate.hikari.idleTimeout | 60000 | Maximum time (in milliseconds) that a connection is allowed to sit idle in the pool (connection to the content server). |
| content.hibernate.hikari.minimumIdle | 1 | Minimum number of idle connections that HikariCP tries to maintain in the pool (connection to the content server). |
| content.hibernate.hikari.maximumPoolSize | 10 | Maximum size that the pool is allowed to reach, including both idle and in-use connections (connection to the content server). |
| content.hibernate.hikari.poolName | “content” | User-defined name for the connection pool. Displayed mainly in logging and JMX management consoles to identify pools. |
Section: JWT configuration
This section configures the JWT parameters used for authentication
| Property | Value | Description |
|---|---|---|
| activeviam.jwt.key.public | The RSA key public key encoded in Base64, used to verify the integrity of the tokens. | |
| activeviam.jwt.key.private | The RSA key private key encoded in Base64, used to sign the tokens. | |
| activeviam.jwt.expiration | 43200 | The lifetime of the tokens in seconds. |
Section: Content Server security configuration
This section configures the Content Service entitlements
| Property | Value | Description |
|---|---|---|
| contentServer.security.calculatedMemberRole | ROLE_USER | The role users must have to create calculated members in the content server. |
| contentServer.security.kpiRole | ROLE_USER | The role users must have to create KPIs in the content server. |
| contentServer.security.cache.entitlementsTTL | 3600 | The time to live of the entitlement cache. |
Section: Activiti History
This section configures the use of the Activiti History. See Activity user guide for details about the Activiti History: https://www.activiti.org/userguide/
| Property | Value | Description |
|---|---|---|
| spring.activiti.dbHistoryUsed | true | Flag used to enable/disable the Activiti History. |
| spring.activiti.historyLevel | full | Activity History level. |
Section: Activiti database
This section configures the Activiti database and the connection to the Activiti database.
| Property | Value | Description |
|---|---|---|
| activiti.datasource.url | “jdbc:h2:file:./sign-off-activiti;DB_CLOSE_DELAY=-1” | URL of the Hibernate connection to the Activiti database. |
| activiti.datasource.username | activiti | User name used for the Hibernate connection to the Activiti database. |
| activiti.datasource.password | password | Password used for the Hibernate connection to the Activiti database. |
| activiti.datasource.properties.hibernate.format_sql | true | Flag used to set up the formatting of the SQL queries in the Hibernate logs. |
| activiti.datasource.properties.hibernate.hbm2ddl.auto | update | Hibernate DDL generation setup to run on startup against the Activiti database. NOTE: Remove this line once the table is created. |
| activiti.datasource.properties.hibernate.globally_quoted_identifiers | true | Enable/disable quoting database identifiers for the Activiti database. Enabled by default. |
| activiti.datasource.hikari.connectionTimeout | 30000 | Maximum time (in milliseconds) that a client will wait for a connection from the pool (connection to the Activiti database). |
| activiti.datasource.hikari.idleTimeout | 60000 | Maximum time (in milliseconds) that a connection is allowed to sit idle in the pool (connection to the Activiti database). |
| activiti.datasource.hikari.minimumIdle | 1 | Minimum number of idle connections that HikariCP tries to maintain in the pool (connection to the Activiti database). |
| activiti.datasource.hikari.maximumPoolSize | 10 | Maximum size that the pool is allowed to reach, including both idle and in-use connections (connection to the Activiti database). |
| activiti.datasource.hikari.poolName | “activiti” | User-defined name for the connection pool. Displayed mainly in logging and JMX management consoles to identify pools. |
Section: Application database
This section configures the Activiti database and the connection to the Application database.
| Property | Value | Description |
|---|---|---|
| application.datasource.url | “jdbc:h2:tcp://localhost/./application-signoff” | URL of the Hibernate connection to the Application database. |
| application.datasource.username | app | User name used for the Hibernate connection to the Application database. |
| application.datasource.password | Password used for the Hibernate connection to the Application database | |
| application.datasource.properties.hibernate.format_sql | true | Flag used to set up the formatting of the SQL queries in the Hibernate logs |
| application.datasource.properties.hibernate.hbm2ddl.auto | update | Hibernate DDL generation setup to run on startup against the Application database. NOTE: Remove this line once the table is created. |
| application.datasource.properties.hibernate.globally_quoted_identifiers | true | Enable/disable quoting database identifiers for the Application database. Enabled by default. |
| application.datasource.hikari.connectionTimeout | 30000 | Maximum time (in milliseconds) that a client will wait for a connection from the pool (connection to the Application database). |
| application.datasource.hikari.idleTimeout | 60000 | Maximum time (in milliseconds) that a connection is allowed to sit idle in the pool (connection to the Application database). |
| application.datasource.hikari.minimumIdle | 1 | Minimum number of idle connections that HikariCP tries to maintain in the pool (connection to the Application database). |
| application.datasource.hikari.maximumPoolSize | 10 | Maximum size that the pool is allowed to reach, including both idle and in-use connections (connection to the Application database). |
| application.datasource.hikari.poolName | “application” | User-defined name for the connection pool. Displayed mainly in logging and JMX management consoles to identify pools |
Section: RESTful service
This section configures the access to the RESTful service used to communicate with the Atoti Server that contains the data to be signed-off (in this case, the MR application)
| Property | Value | Description |
|---|---|---|
| application.rest-apis.MR.url | http://localhost:10010/mr-application | URL of the RESTful server used for operations on the signed-off data in the Atoti Server application where those data are present (MR). |
| application.rest-apis.MR.user | admin | User ID used to send requests on the RESTful service (MR). |
| application.rest-apis.MR.password | admin | Password used to send requests on the RESTful service (MR). |
| application.rest-apis.MR.status-endpoint | /activeviam/pivot/rest/v8/ping | A REST endpoint that can be called to determine if the server is running. The endpoint should return HTTP status code 200 if running (MR). |
| application.rest-apis.MR.polling-period-in-milliseconds | 5000 | The frequency with which application servers are polled to determine if they are running (MR). |
| application.rest-apis.MR.initial-delay-in-milliseconds | 1000 | The delay that should be applied from starting the sign-off server to beginning to poll application servers to determine if they are running (MR). |
| application.rest-apis.MR.notify-on-failure-count | 3 | The number of times to observe that the application server has changed from a running state to a not running state before notifying sign-off tasks (MR). |
| application.rest-apis.MR.notify-on-success-count | 1 | The number of times to observe that the application server has changed from a not running state to a running state before notifying sign-off tasks (MR). |
| application.rest-apis.FRTB.url | http://localhost:8080/frtb-starter | URL of the RESTful server used for operations on the signed-off data in the Atoti Server application where those data are present (FRTB). |
| application.rest-apis.FRTB.user | admin | User ID used to send requests on the RESTful service (FRTB). |
| application.rest-apis.FRTB.password | admin | Password used to send requests on the RESTful service (FRTB). |
| application.rest-apis.FRTB.status-endpoint | /activeviam/pivot/rest/v8/ping | A REST endpoint that can be called to determine if the server is running. The endpoint should return HTTP status code 200 if running (FRTB). |
| application.rest-apis.FRTB.polling-period-in-milliseconds | 5000 | The frequency with which application servers are polled to determine if they are running (FRTB). |
| application.rest-apis.FRTB.initial-delay-in-milliseconds | 1000 | The delay that should be applied from starting the Sign-Off server to beginning to poll application servers to determine if they are running (FRTB). |
| application.rest-apis.FRTB.notify-on-failure-count | 3 | The number of times to observe that the application server has changed from a running state to a not running state before notifying sign-off tasks (FRTB). |
| application.rest-apis.FRTB.notify-on-success-count | 1 | The number of times to observe that the application server has changed from a not running state to a running state before notifying sign-off tasks (FRTB). |
note
To add the configuration related to other application servers, add these properties:
- application.rest-apis.<server name>.url
- application.rest-apis.<server name>.user
- application.rest-apis.<server name>.password
where <server name> is the server name defined in the sign-off definitions related to the application server.
You can also optionally add the following properties. If they are not provided, the defaults shown above for MR will be used for the new application server.
- application.rest-apis.<server name>.status-endpoint
- application.rest-apis.<server name>.polling-period-in-milliseconds
- application.rest-apis.<server name>.initial-delay-in-milliseconds
- application.rest-apis.<server name>.notify-on-failure-count
- application.rest-apis.<server name>.notify-on-success-count
Section: Audit Log Database
This section configures the Activiti database and the connection to the Audit Log database.
| Property | Value | Description |
|---|---|---|
| audit-log.datasource.url | “jdbc:h2:tcp://localhost/./audit-log” | URL of the Hibernate connection to the Audit Log database. |
| audit-log.datasource.username | audit | User name used for the Hibernate connection to the Audit Log database. |
| audit-log.datasource.password | Password used for the Hibernate connection to the Audit Log database. | |
| audit-log.datasource.properties.hibernate.format_sql | true | Flag used to set up the formatting of the SQL queries in the Hibernate logs. |
| audit-log.datasource.properties.hibernate.hbm2ddl.auto | update | Hibernate DDL generation setup to run on startup against the Audit Log database. NOTE: Remove this line once the table is created. |
| audit-log.datasource.properties.hibernate.globally_quoted_identifiers | true | Enable/disable quoting database identifiers for the Audit Log database. Enabled by default. |
| audit-log.datasource.hikari.connectionTimeout | 30000 | Maximum time (in milliseconds) that a client will wait for a connection from the pool (connection to the Audit Log database). |
| audit-log.datasource.hikari.idleTimeout | 60000 | Maximum time (in milliseconds) that a connection is allowed to sit idle in the pool (connection to the Audit Log database). |
| audit-log.datasource.hikari.minimumIdle | 1 | Minimum number of idle connections that HikariCP tries to maintain in the pool (connection to the Audit Log database). |
| audit-log.datasource.hikari.maximumPoolSize | 10 | Maximum size that the pool is allowed to reach, including both idle and in-use connections (connection to the Audit Log database). |
| audit-log.datasource.hikari.poolName | “audit-log” | User-defined name for the connection pool. Displayed mainly in logging and JMX management consoles to identify pools. |
Section: sign-off
This section defines additional properties used in the sign-off process
| Property | Value | Description |
|---|---|---|
| sign-off.workflow.configuration.4-eyes.key | sign-off-process-instance.four-eyes | Maps the ‘4-eyes’ workflow type used for the creation of sign-off tasks to the ‘sign-off-process-instance.four-eyes’ workflow |
| sign-off.workflow.configuration.4-eyes.participant | Examiners,Approvers | Maps intended participants to the ‘4-eyes’ workflow |
| sign-off.workflow.configuration.simple.key | sign-off-process-instance.simple | Maps the ‘simple’ workflow type used for the creation of sign-off tasks to the ‘sign-off-process-instance.simple’ workflow |
| sign-off.workflow.configuration.simple.participant | Approvers | Maps intended participants to the ‘simple’ with workflow |
| sign-off.workflow.configuration.4-eyes-kpi.key | sign-off-process-instance.four-eyes-kpi | Maps the ‘4-eyes-kpi’ workflow type used for the creation of sign-off tasks to the ‘sign-off-process-instance.four-eyes-kpi’ workflow |
| sign-off.workflow.configuration.4-eyes-kpi.participant | Examiners,Approvers | Maps intended participants to the ‘4-eyes-kpi’ workflow |
| sign-off.workflow.roles | USERS,MANAGERS | The list of roles for workflow participants |
| sign-off.export.polling-period-in-milliseconds | 1000 | Polling period (in milliseconds) of the task that polls for the export status / |
| sign-off.export.initial-delay-in-milliseconds | 500 | Delay (in milliseconds) before the polling for the export status starts |
| sign-off.export.timeout-delay-in-milliseconds | 3600000 | Delay (in milliseconds) before the polling will timeout by raising an error and stop |
| sign-off.export.scheduler-pool-size | 1 | Size of the thread pool used for the polling of the export status |