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.

​
Properties files

These properties files relate to configuring the application. For details of properties files for configuring inputs to the calculations, see Configuration files.
Location: The application properties files are provided in the frtb-application module in the frtb-application/src/main/resources/ directory
FilePurpose
application.yamlSets port and context for the application
application.propertiesGeneral properties
frtb-config.propertiesCube levels for postprocessors and constant values used in tuple publishers and postprocessors
hibernate.propertiesHibernate (persistence and query service) properties
signoff.propertiesGeneral Sign-off module configurations
signoff.export.propertiesSign-off export configurations

​
Spring annotations

AnnotationMeaningValue
@ConditionalOnAdjustmentsWithDirectQueryAdjustments activated as read-only for DirectQuerydirectquery.withAdjustments AND starter.deployment.type=direct-query AND configuration.sign-off.enabled
@ConditionalOnClickHouseDirectQuery uses ClickHousedirectquery.database.type=clickhouse AND starter.deployment.type=direct-query
@ConditionalOnDirectQueryDatabaseDirectQuery is activatedstarter.deployment.type=direct-query
@ConditionalOnInMemoryDatabaseIn-memory mode is activated, DirectQuery is disabledstarter.deployment.type=in-memory
@ConditionalOnMSSQLDirectQuery uses MSSQL (not implemented)directquery.database.type=mssql AND starter.deployment.type=direct-query
@ConditionalOnNoAdjustmentsWithDirectQuerySignOff is activated but DirectQuery has no information about adjustmentsNOT directquery.withAdjustments AND starter.deployment.type=direct-query AND configuration.sign-off.enabled
@ConditionalOnSignOffDisabledSignOff is not usedNOT configuration.sign-off.enabled
@ConditionalOnSignOffEnabledSingOff is fully enabled on an in-memory setupconfiguration.sign-off.enabled AND**NOT starter.deployment.type=direct-query
@ConditionalOnSignOffHierarchyThe SignOff hierarchy is displayed for in-memory or DirectQuery cubeconfiguration.sign-off.enabled
@ConditionalOnSnowflakeDirectQuery uses SnowFlakedirectquery.database.type=snowflake AND starter.deployment.type=direct-query
@ConditionalOnHasCombinedCubeThe current node contains the “FRTBCombinedCube”combined.disable == false
@ConditionalOnHasDataCubeThe server contains data cubesstarter.deployment.type != query-node
@ConditionalOnHasImaCubeThe server contains “InternalModelApproachCube” and allows other IMA cubesima.disable == false
@ConditionalOnHasImaDrcCubeThe server contains the “IMADRCCube”ima.drc.disable == false AND ima.disable == false
@ConditionalOnHasImaPLCubeThe server contains the “PLCube”ima.plat-backtesting.disable == false AND ima.disable == false
@ConditionalOnHasImaStressCalibrationCubeThe server contains the “StressCalibrationCube”ima.stress-calibration.disable == false AND ima.disable == false
@ConditionalOnHasQueryCubeThe server contains the query cubestarter.deployment.type = query-node OR combined.disable != false
@ConditionalOnLocalBusThe server uses the internal bus to communicate between data cubes and query cubestarter.deployment.transport == local
@ConditionalOnNettyBusThe server uses the Netty bus to communicate between data cubes and query cubestarter.deployment.transport == netty
@ConditionalOnQueryNodeThe server node contains only the query cubestarter.deployment.type == query-node
@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 with the necessary data and configuration to do the calculations in . 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 in application.properties. The below property needs to be updated to specify an accessible directory containing the necessary files.

​
Example

Sample files can be found in the sample-data/data folder.
These files can’t be found in the WAR generated by the build.
csv-source.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.properties accordingly to point to that data.

​
Bookmarks

If you want to replace the bookmarks you have persisted in your content server, you can override all the content of the content server with content from a JSON file when the instance starts up. To do this, in application.properties, set the value of the contentServer.factory-reset property to true: 
contentServer.factory-reset=true
The data loaded into the content server is imported from a json file. The json file loaded by default is frtb-content-server.json. It is specified in application.properties as below: 
contentServer.factory-reset.filename=frtb-content-server.json
provides a directory for the bookmarks which can be loaded using the contentServer.factory-reset=folder and contentServer.factory-reset.folder-name=dir-name. See the bookmarks.zip in the distribution files for this release. You will need to specify in the configuration file where the project is running.
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 frtb_env.js file which will need to be updated with the correct server URL: 
const FRTB_port = 8080
const FRTB_host = window.location.hostname
const FRTB_path = "/frtb-starter"

window.env = {
...
  csServers: [
    {
      name: 'Bookmarks',
      url: 'http://' + FRTB_host + ':' + FRTB_port + FRTB_path,
    }
  ],
  apServers: [
    {
      name: 'FRTB',
      url: 'http://' + FRTB_host + ':' + FRTB_port + FRTB_path,
      csServerName: 'Bookmarks',
    }
  ],
...
}

​
DoctorPivot Configuration(optional)

  • No changes required

​
Data Load Controller (DLC)

The Data Load Controller (DLC) is a component within that supports managing the loading and unloading of data. For an overview of how the DLC is used and how to customize it, see Data Load Controller in For configuration details, see FRTB-specific configuration.