Project configuration
Properties files
note
These properties files relate to configuring the FRTB Accelerator 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-starter
module in the frtb-starter/src/main/resources/
directory
File | Purpose |
---|---|
activepivot.remote.properties | ActiveMonitor properties |
application.yaml | Sets port and context for the application |
frtb.properties | General properties |
frtb-config.properties | Cube levels for postprocessors and constant values used in tuple publishers and postprocessors |
hibernate.properties | Hibernate (persistence and query service) properties |
signoff.properties | General Sign-off module configurations |
signoff.export.properties | Sign-off export configurations |
Data Files
You will need to specify where your CSV files are placed. In the default implementation, the CSV files are required to provide ActivePivot with the necessary data and configuration to do the calculations in the Accelerator.
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 frtb.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 frtb-starter/src/test/resources/data folder (a.k.a. don’t expect to see any of them in the WAR generated by the build)…
csvSource.dataset=data
tip
TIP: 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 frtb.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 ActivePivot instance starts up.
In order to do this, the value for the property contentServer.factory-reset should be set to true in the file frtb.properties as below.
contentServer.factory-reset=true
The data that gets loaded into the content server is imported from a json file. The json file that gets loaded in by default is frtb-content-server.json. It is specified in frtb.properties as below:
contentServer.factory-reset.filename=frtb-content-server.json
The accelerator ships with the following two sample content server files:
- frtb-content-server.json - Sample set of bookmarks are for the SA, IMA, PL Attribution and Combined Cube.
- frtb-content-server-query.json - If running on distributed deployment and only the query node is exposed to end users, sample set of bookmarks for the SA, IMA, PL Attribution and Combined Cube to be used in the query node.
ActiveUI
You will need to specify in the ActiveUI configuration file where the ActivePivot 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 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',
}
],
...
}
ActiveMonitor (optional)
If you choose to deploy ActiveMonitor, you will need to modify the following properties files:
-
activepivot.remote.properties (frtb-starter)
# The URL to use to connect to the ActiveMonitor sentinel.remote.url=http://localhost:8081/frtb-activemonitor # The URL to use to connect to the ActiveMonitor repository repository.remote.url=http://localhost:8081/frtb-activemonitor # The URL of the current ActivePivot activepivot.snl.url=http://localhost:8080/frtb-starter
-
env.js (frtb-activeui)
# The URL to use to connect to the ActiveMonitor activeMonitorServerUrl: 'http://localhost:8081/frtb-activemonitor',
DoctorPivot Configuration(optional)
- No changes required
Data load controller
For configuration details, see FRTB-specific configuration.