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.

​
Configuration Properties and property files

For details, see Properties Location: mr-application/src/main/resources
FilePurpose
application.yamlSets port and context for the application.
dee.export.propertiesConfigures the DEE service tool that is intended to perform data extractions.
logback-spring.xmlDefines the logging configuration for testing the MR application.
logback-spring-file.xmlDefines the logback configuration for the MR application in production.
mr-jaxb-mapping.xmlDefines the configuration of the Java Architecture for XML Binding (JAXB) for context values defined in the MR application.
serializer-jaxb-cfg.xmlConfigures all the JAXB mapping resources needed by the application.

​
Spring annotations

AnnotationMeaningValue
@ConditionalOnAdjustmentsWithDirectQueryAdjustments activated as read-only for DirectQuery.directquery.with-adjustments AND starter.deployment.type=direct-query AND configuration.sign-off.enabled
@ConditionalOnClickHouseDirectQuery uses ClickHouse.directquery.database.type=clickhouse AND starter.deployment.type=direct-query
@ConditionalOnDirectQueryDatabaseDirectQuery is activated.starter.deployment.type=direct-query
@ConditionalOnInMemoryDatabaseInMemory mode is activated, DirectQuery is disabled.starter.deployment.type=in-memory
@ConditionalOnMSSQLDirectQuery uses MSSQL (not implemented).directquery.database.type=mssql AND starter.deployment.type=direct-query
@ConditionalOnNoAdjustmentsWithDirectQuerySign-Off is activated but DirectQuery has no information about adjustments.NOT directquery.with-adjustments AND starter.deployment.type=direct-query AND configuration.sign-off.enabled
@ConditionalOnSignOffDisabledSign-Off is not used.NOT configuration.sign-off.enabled
@ConditionalOnSignOffEnabledSign-Off is fully enabled on an InMemory setup.configuration.sign-off.enabled ANDNOT starter.deployment.type=direct-query
@ConditionalOnSignOffHierarchyThe Sign-Off hierarchy is displayed for InMemory or DirectQuery Cubes.configuration.sign-off.enabled
@ConditionalOnSnowflakeDirectQuery uses SnowFlake.directquery.database.type=snowflake AND starter.deployment.type=direct-query
@ConditionalOnAggregatedDataDisabledThe summary data are not aggregated.NOT mr.enable.data-model.aggregated
@ConditionalOnAggregatedDataEnabledThe summary data are aggregated.mr.enable.data-model.aggregated
@ConditionalOnAnyCubeEnabledAny non-summary Cubes are activatedmr.enable.cubes.var OR mr.enable.cubes.pln OR mr.enable.cubes.sensi OR mr.enable.cubes.market
@ConditionalOnAnyPnLCubeEnabledPnL Cube or PnL Summary Cube is activated.mr.enable.cubes.pln OR mr.enable.cubes.pnl-summary
@ConditionalOnAnySensitivityCubeEnabledSensitivity Cube or Sensitivity Summary Cube is activated.mr.enable.cubes.sensi OR mr.enable.cubes.sensi-summary
@ConditionalOnAnyVaRCubeEnabledVaR Cube or VaR Summary Cube is activated.mr.enable.cubes.var OR mr.enable.cubes.var-summary
@ConditionalOnCommonCubeEnabledThe common query Cube is activated.mr.enable.cubes.common
@ConditionalOnHasDataCubeThe server contains data Cubes.starter.deployment.type != query-node
@ConditionalOnHasQueryCubeThe server contains a query Cube.mr.enable.cubes.common or any other query cube
@ConditionalOnHasSourceThe data needs to be fetched from a source (Azure, Local, etc.)dlc.enabled ANDNOT directquery.enabled
@ConditionalOnHasSourceAndDirectQueryA in-memory data source is defined and DirectQuery is enabled.dlc.enabled
@ConditionalOnLocalBusThe server uses the internal bus to communicate between data Cubes and query Cube.starter.deployment.transport == local
@ConditionalOnLocalContentServiceThe content server is hosted locallyspring.profiles.active HAS local-content
@ConditionalOnMarketDataCubeEnabledThe Market Data Cube is activated.mr.enable.cubes.market
@ConditionalOnMissingSourceThere is no source set or no DirectQuery (it’s an error case).NOT dlc.enabled ANDNOT starter.deployment.type=direct-query
@ConditionalOnNettyBusThe server uses the Netty bus to communicate between data Cubes and query Cube.starter.deployment.transport == netty
@ConditionalOnPnLCubeEnabledThe PnL Cube is activated.mr.enable.cubes.pln
@ConditionalOnPnLSummaryCubeDisabledThe PnL Summary Cube is disabled.NOT mr.enable.cubes.pnl-summary
@ConditionalOnPnLSummaryCubeEnabledThe PnL Summary Cube is activated.mr.enable.cubes.pnl-summary
@ConditionalOnQueryNodeThe server node contains only the query Cube.starter.deployment.type == query-node
@ConditionalOnRemoteContentServiceThe content service instance is remote.spring.profiles.active HAS remote-content
@ConditionalOnSensitivityCubeEnabledThe Sensitivity Cube is activated.mr.enable.cubes.sensi
@ConditionalOnSensitivitySummaryCubeDisabledThe Sensitivity Summary Cube is disabled.NOT mr.enable.cubes.sensi-summary
@ConditionalOnSensitivitySummaryCubeEnabledThe Sensitivity Summary Cube is activated.mr.enable.cubes.sensi-summary
@ConditionalOnVaRCubeEnabledThe VaR/ES Cube is activated.mr.enable.cubes.var
@ConditionalOnVaRSummaryCubeDisabledThe VaR/ES Summary Cube is disabled.NOT mr.enable.cubes.var-summary
@ConditionalOnVaRSummaryCubeEnabledThe VaR/ES Summary Cube is activated.mr.enable.cubes.var-summary
@ConditionalNotOnDirectQueryDatabaseIf DirectQuery is not enabledstarter.deployment.type != direct-query

​
Data Files

You will need to specify where your CSV files are placed. In the default implementation, the CSV files are required to provide Atoti Server with the necessary data and configuration to do the calculations in Atoti Market Risk. All the files need to be kept under one directory of your choice anywhere on the file system. The path to this directory needs to be specified with the mr.data-load.csv.dataset property. The below property needs to be updated to specify an accessible directory containing the necessary files. Sample files can be found in the mr-application/src/main/resources/data folder.
Files in this folder are excluded from the mr-application JAR.
mr.data-load.csv.dataset=data
To get started with deployment (e.g. if you are not running the application directly from the IDE) you can easily copy/paste the whole sample data folder (from source zip) into somewhere accessible by your deployed runtime, and change the configuration in application.yaml accordingly to point to that data.

​
Local Content Server

When using the local-content Spring profile automatically activated in the application.yaml file, Atoti Market Risk defaults to an in-memory content server with an H2 database. The core Atoti Market Risk bookmarks are imported to this server at startup. To set different bookmarks, please see the section below. To use a different local database for the content server, modify the following properties in the application.yaml file:
  • To connect to an H2 database, set the mr.application.content-server.db.file.name property, specifying the path to the database file, relative to the classpath.
  • To connect to a database that is not H2, set the mr.application.content-server.db.url property, specifying the JDBC URL of your database.

​
Bookmarks

If you want to replace the bookmarks you have persisted in your content server, there are several options for overriding the content of the content server with the core Atoti Market Risk bookmarks at startup. The behavior of the bookmark reset is driven by the contentServer.factory-reset group of properties in the application.yaml file. The mr.application.content-server.reset property determines whether the reset is performed, and from which persistence type. Available options are:
  • true: Imports data from a single JSON file
  • file: Same as for true
  • folder: Imports the bookmarks from a folder-based hierarchical representation of the Atoti UI bookmark tree.
  • false: Does not reset the bookmarks. The bookmarks are loaded directly from the content server without any modification.
The location from which Atoti Market Risk will attempt to load the various options is determined by the factory reset filename (mr.application.content-server.factory-reset.filename) and folder name (mr.application.content-server.factory-reset.folder-name) properties. The default values point to sample files on the classpath. Due to the inability to load classpath files or folders from a JAR file, running the application via the SpringBoot JAR will require overriding the property via the CLI argument: 
mr.application.content-server.factory-reset.folder-name="file:full\example\path\mr-content-server"
The bookmark samples for Atoti Market Risk can be found within the UI release files, containing bookmarks for the VaR-ES, Sensitivities, PnL, and MRCombined Cubes.

​
Atoti UI

You will need to specify in the Atoti UI configuration file where the Atoti Server project is running. Please note, the end-user’s browser will be connecting to the URL you specify here, so you should specify the exact host name as opposed to localhost. The standalone application contains an mr_env.js file which will need to be updated with the correct server URL: 
# The URL to use to connect to Atoti Server
activePivotServerUrl: 'http://localhost:10010/mr-application',