Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.activeviam.com/llms.txt

Use this file to discover all available pages before exploring further.

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

PropertyValueDescription
server.port9090Port 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.
PropertyValueDescription
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_classorg.h2.DriverDriver used for the Hibernate connection to the content server.
content.hibernate.show_sqlfalseFlag used to set up the printing of the SQL queries in the Hibernate logs.
content.hibernate.format_sqlfalseFlag used to set up the formatting of the SQL queries in the Hibernate logs.
content.hibernate.hbm2ddl.autoupdateHibernate 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_identifiersfalseEnable/disable quoting database identifiers for the Content Server database. Disabled by default.
content.hibernate.hikari.connectionTimeout30000Maximum time (in milliseconds) that a client will wait for a connection from the pool (connection to the content server).
content.hibernate.hikari.idleTimeout60000Maximum time (in milliseconds) that a connection is allowed to sit idle in the pool (connection to the content server).
content.hibernate.hikari.minimumIdle1Minimum number of idle connections that HikariCP tries to maintain in the pool (connection to the content server).
content.hibernate.hikari.maximumPoolSize10Maximum 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
PropertyValueDescription
activeviam.jwt.key.publicThe RSA key public key encoded in Base64, used to verify the integrity of the tokens.
activeviam.jwt.key.privateThe RSA key private key encoded in Base64, used to sign the tokens.
activeviam.jwt.expiration43200The lifetime of the tokens in seconds.

Section: Content Server security configuration

This section configures the Content Service entitlements
PropertyValueDescription
contentServer.security.calculatedMemberRoleROLE_USERThe role users must have to create calculated members in the content server.
contentServer.security.kpiRoleROLE_USERThe role users must have to create KPIs in the content server.
contentServer.security.cache.entitlementsTTL3600The time to live of the entitlement cache.

Section: Activiti

This section configures the use of the Activiti workflow engine. See Activity user guide for details about the Activiti workflow engine: https://www.activiti.org/userguide/
PropertyValueDescription
spring.activiti.dbHistoryUsedtrueFlag used to enable/disable the Activiti History.
spring.activiti.historyLevelauditActivity History level.
spring.activiti.database-schemasign-offThe schema used by the Activiti databases.

Section: Activiti database

This section configures the Activiti database and the connection to the Activiti database.
PropertyValueDescription
activiti.datasource.urljdbc:h2:file:./sign-off-activiti;DB_CLOSE_DELAY=-1;INIT=CREATE SCHEMA IF NOT EXISTS “sign-off”;URL of the Hibernate connection to the Activiti database.
activiti.datasource.usernameactivitiUser name used for the Hibernate connection to the Activiti database.
activiti.datasource.passwordPassword used for the Hibernate connection to the Activiti database.
activiti.datasource.properties.hibernate.format_sqltrueFlag used to set up the formatting of the SQL queries in the Hibernate logs.
activiti.datasource.properties.hibernate.hbm2ddl.autoupdateHibernate DDL generation setup to run on startup against the Activiti database. NOTE: Remove this line once the table is created.
activiti.datasource.properties.hibernate.default_schemasign-offThe default schema used by the Activiti database.
activiti.datasource.properties.hibernate.globally_quoted_identifierstrueEnable/disable quoting database identifiers for the Activiti database. Enabled by default.
activiti.datasource.hikari.connectionTimeout30000Maximum time (in milliseconds) that a client will wait for a connection from the pool (connection to the Activiti database).
activiti.datasource.hikari.idleTimeout60000Maximum time (in milliseconds) that a connection is allowed to sit idle in the pool (connection to the Activiti database).
activiti.datasource.hikari.minimumIdle1Minimum number of idle connections that HikariCP tries to maintain in the pool (connection to the Activiti database).
activiti.datasource.hikari.maximumPoolSize10Maximum 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 Application database and the connection to the Application database.
PropertyValueDescription
application.datasource.urljdbc:h2:file:./application-sign-off;DB_CLOSE_DELAY=-1;INIT=CREATE SCHEMA IF NOT EXISTS “sign-off”;URL of the Hibernate connection to the Application database.
application.datasource.usernameappUser name used for the Hibernate connection to the Application database.
application.datasource.passwordPassword used for the Hibernate connection to the Application database
application.datasource.properties.hibernate.format_sqltrueFlag used to set up the formatting of the SQL queries in the Hibernate logs
application.datasource.properties.hibernate.hbm2ddl.autoupdateHibernate DDL generation setup to run on startup against the Application database. NOTE: Remove this line once the table is created.
application.datasource.properties.hibernate.default_schemasign-offThe default schema used by the Application database.
application.datasource.properties.hibernate.globally_quoted_identifierstrueEnable/disable quoting database identifiers for the Application database. Enabled by default.
application.datasource.hikari.connectionTimeout30000Maximum time (in milliseconds) that a client will wait for a connection from the pool (connection to the Application database).
application.datasource.hikari.idleTimeout60000Maximum time (in milliseconds) that a connection is allowed to sit idle in the pool (connection to the Application database).
application.datasource.hikari.minimumIdle1Minimum number of idle connections that HikariCP tries to maintain in the pool (connection to the Application database).
application.datasource.hikari.maximumPoolSize10Maximum 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). Note that this configuration stands as an example. We don’t ship this configuration by default.
PropertyValueDescription
sign-off.application.rest-apis.MR.urlhttp://localhost:10010/mr-applicationURL of the RESTful server used for operations on the signed-off data in the Atoti Server application where those data are present (MR).
sign-off.application.rest-apis.MR.useradminUser ID used to send requests on the RESTful service (MR).
sign-off.application.rest-apis.MR.passwordadminPassword used to send requests on the RESTful service (MR).
sign-off.application.rest-apis.MR.status-endpoint/sign-off/enabledA REST endpoint that can be called to determine if the server is running. The endpoint should return HTTP status code 200 if running (MR).
sign-off.application.rest-apis.MR.polling-period-in-milliseconds5000The frequency with which application servers are polled to determine if they are running (MR).
sign-off.application.rest-apis.MR.initial-delay-in-milliseconds1000The delay that should be applied from starting the sign-off server to beginning to poll application servers to determine if they are running (MR).
sign-off.application.rest-apis.MR.notify-on-failure-count3The 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).
sign-off.application.rest-apis.MR.notify-on-success-count1The 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).
sign-off.application.rest-apis.MR.mdx-endpoint/activeviam/pivot/rest/v9/cube/query/mdxA rest endpoint that can be called to execute MDX queries on the server. (MR)
sign-off.application.rest-apis.MR.cubes.Var-ES Cube.as-of-date-level[Dates].[Date].[AsOfDate]The full level used to determine the As-Of-Date of the VAR-ES Cube on the server. (MR).
sign-off.application.rest-apis.MR.cubes.VaR-ES Summary Cube.as-of-date-level[Dates].[Date].[AsOfDate]The full level used to determine the As-Of-Date of the VaR-ES Summary Cube on the server. (MR).
sign-off.application.rest-apis.MR.cubes.Sensitivity Cube.as-of-date-level[Dates].[Date].[AsOfDate]The full level used to determine the As-Of-Date of the Sensitivity Cube on the server. (MR).
sign-off.application.rest-apis.MR.cubes.Sensitivity Summary Cube.as-of-date-level[Dates].[Date].[AsOfDate]The full level used to determine the As-Of-Date of the Sensitivity Summary Cube on the server. (MR).
sign-off.application.rest-apis.MR.cubes.PLCube.as-of-date-level[Dates].[Date].[AsOfDate]The full level used to determine the As-Of-Date of the PLCube on the server. (MR).
sign-off.application.rest-apis.MR.cubes.PL Summary Cube.as-of-date-level[Dates].[Date].[AsOfDate]The full level used to determine the As-Of-Date of the PL Summary Cube on the server. (MR).
sign-off.application.rest-apis.MR.cubes.MRCombinedCube.as-of-date-level[Dates].[Date].[AsOfDate]The full level used to determine the As-Of-Date of the MRCombinedCube on the server. (MR).
sign-off.application.rest-apis.FRTB.urlhttp://localhost:8080/frtb-starterURL of the RESTful server used for operations on the signed-off data in the Atoti Server application where those data are present (FRTB).
sign-off.application.rest-apis.FRTB.useradminUser ID used to send requests on the RESTful service (FRTB).
sign-off.application.rest-apis.FRTB.passwordadminPassword used to send requests on the RESTful service (FRTB).
sign-off.application.rest-apis.FRTB.status-endpoint/sign-off/enabledA REST endpoint that can be called to determine if the server is running. The endpoint should return HTTP status code 200 if running (FRTB).
sign-off.application.rest-apis.FRTB.polling-period-in-milliseconds5000The frequency with which application servers are polled to determine if they are running (FRTB).
sign-off.application.rest-apis.FRTB.initial-delay-in-milliseconds1000The delay that should be applied from starting the Sign-Off server to beginning to poll application servers to determine if they are running (FRTB).
sign-off.application.rest-apis.FRTB.notify-on-failure-count3The 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).
sign-off.application.rest-apis.FRTB.notify-on-success-count1The 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).
sign-off.application.rest-apis.FRTB.mdx-endpoint/activeviam/pivot/rest/v9/cube/query/mdxA rest endpoint that can be called to execute MDX queries on the server. (FRTB)
To add the configuration related to other application servers, add these properties:
  • sign-off.application.rest-apis.<server name>.url
  • sign-off.application.rest-apis.<server name>.user
  • sign-off.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.
  • sign-off.application.rest-apis.<server name>.status-endpoint
  • sign-off.application.rest-apis.<server name>.polling-period-in-milliseconds
  • sign-off.application.rest-apis.<server name>.initial-delay-in-milliseconds
  • sign-off.application.rest-apis.<server name>.notify-on-failure-count
  • sign-off.application.rest-apis.<server name>.notify-on-success-count

Section: Audit Log database

This section configures the Audit Log database and the connection to the Audit Log database.
PropertyValueDescription
audit-log.datasource.urljdbc:h2:file:./audit-log;DB_CLOSE_DELAY=-1;INIT=CREATE SCHEMA IF NOT EXISTS “sign-off”;URL of the Hibernate connection to the Audit Log database.
audit-log.datasource.usernameauditUser name used for the Hibernate connection to the Audit Log database.
audit-log.datasource.passwordPassword used for the Hibernate connection to the Audit Log database.
audit-log.datasource.properties.hibernate.format_sqltrueFlag used to set up the formatting of the SQL queries in the Hibernate logs.
audit-log.datasource.properties.hibernate.hbm2ddl.autoupdateHibernate 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.default_schemasign-offThe default schema used by the Audit Log database.
audit-log.datasource.properties.hibernate.globally_quoted_identifierstrueEnable/disable quoting database identifiers for the Audit Log database. Enabled by default.
audit-log.datasource.hikari.connectionTimeout30000Maximum time (in milliseconds) that a client will wait for a connection from the pool (connection to the Audit Log database).
audit-log.datasource.hikari.idleTimeout60000Maximum time (in milliseconds) that a connection is allowed to sit idle in the pool (connection to the Audit Log database).
audit-log.datasource.hikari.minimumIdle1Minimum number of idle connections that HikariCP tries to maintain in the pool (connection to the Audit Log database).
audit-log.datasource.hikari.maximumPoolSize10Maximum 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
PropertyValueDescription
sign-off.workflow.configuration.4-eyes.keysign-off-process-instance.four-eyesMaps 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.participantExaminers,ApproversMaps intended participants to the ‘4-eyes’ workflow
sign-off.workflow.configuration.simple.keysign-off-process-instance.simpleMaps 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.participantApproversMaps intended participants to the ‘simple’ with workflow
sign-off.workflow.configuration.4-eyes-kpi.keysign-off-process-instance.four-eyes-kpiMaps 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.participantExaminers,ApproversMaps intended participants to the ‘4-eyes-kpi’ workflow
sign-off.workflow.rolesUSERS,MANAGERSThe list of roles for workflow participants
sign-off.export.polling-period-in-milliseconds1000Polling period (in milliseconds) of the task that polls for the export status /
sign-off.export.initial-delay-in-milliseconds500Delay (in milliseconds) before the polling for the export status starts
sign-off.export.timeout-in-milliseconds3600000Time (in milliseconds) before the polling will timeout by raising an error and stop
sign-off.export.scheduler-pool-size1Size of the thread pool used for the polling of the export status

Section: Spring Boot

PropertyValueDescription
spring.h2.console.enabledfalseWhen set to true, the H2 console is available. This is useful for investigating JDBC connections.
spring.application.nameAtoti Sign-OffSpring property for the application name. Used by the notification service to identify the source server for each notification.