Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The ECB Exchange Rates only provide the exchange rates from the Euro Dollar against other currencies. To use ECB Exchange Rates the Lead Currency in Apliqo FPM must be EUR - Euro Dollar in Apliqo FPM.

Alpha Vantage is more flexible and offers exchange rates for a broader array of currency pairs. To access Alpha Vantage's data source, you need to acquire a Rapid API access token, which is free. The Basic tier service allows access to foreign exchange rates with certain restrictions, such as a limit of 500 API queries per month and a cap of 50 API calls per minute. Information regarding registration and subscription to Alpha Vantage can be found at https://docs.rapidapi.com/docs/api-pricing. The FX Downloader can be set up to prevent exhausting of API limits in terms of the number of API calls per minute, particularly if your plan has stricter restrictions than the default ones.

...

  1. Locate <FPM install location>\Batch\fxdownload\Config\ folder and open config.json file in a text editor.

  2. Locate tm1_instances object inside the config.json file. Out of the box version of the file contains a default connection object called “default”.

  3. Specify connection information to your Apliqo FPM instance inside the default object data fields. You may specify following details, only basic are listed below, all are compatible with TM1Py TM1Service class. Do not modified modify any other values outside the default connection object data field. Save the config.json file after changing the connection information.

...

  • The credentials will be stored by the FX Download inside a system keychain on the server you are running the FX Downloader on. This guarantees the security of the credentials stored. The keychain is password protected and only available to the Windows AD account that is running the Apliqo FPM service. The FX Download does not store the sensitive information outside the keychain and doesn’t output the information to a display or any system logs.

  • Supply a valid connection object name from config.json in parameter pConnection should you define your own connection information other than default.

  • Connection test with the provided credentials will be attempted before populating the credential values into a system keychain. Should the connection test fail, the credentials will not be stored in the keychain.

  • Success or failure of the credentials store action will be communicated by the Apliqo FPM messaging framework. Messages are output into }APQ Process Response Message cube and to the TM1 System Log (tm1server.log) and the FX Downloader log file. If the connection test succeeds the FX Downloader will set Credentials setup option in }APQ Settings cube to 'Y'.

...

  • The Rapid API access key is considered sensitive information and will be stored by the FX Downloader inside a system keychain.

  • Supply a valid connection object name from config.json in parameter pConnection should you define your own connection information other than default.

  • Connection test with provided credentials will be attempted before populating the credential values into a system keychain. Should the connection test fail, the credentials will not be stored!

  • Success or failure of the credentials store action will be communicated by the Apliqo FPM messaging framework. Messages are output into }APQ Process Response Message cube and in the TM1 System Log (tm1server.log) and the application log file. If the connection test succeeds the FX Downloader will set Credentials setup option in }APQ Settings cube to Y.

...

  • The FX Downloader will run the process }APQ.C3.FIN.Cub.CurrencyXRDaily.FillBlanks to clear the FIN Currency xR Daily cube in specified date range. Please keep in mind that List of currency pairs specified in pSymbols parameter will be observed during data clear (if supplied), otherwise all currency pairs data will be cleared regardless of pSymbols parameter settings.

  • Supply a valid connection object name from config.json in parameter pConnection should you define your own connection information other than default.

  • After the download of data is successfully finished, the FX Downloader will run the process, }APQ.C3.FIN.Cub.CurrencyXRDaily.FillBlanks to make sure currency rates are populated into non-trading days by repeating last non-zero currency rate from preceding trading day. Take extra care to specify a start date range (pStartDate) that is an actual trading day to avoid repeating invalid currency rates.

  • Success or failure of the credentials store action will be communicated by the Apliqo FPM messaging framework. Messages are output into the }APQ Process Response Message cube, in the TM1 System Log (tm1server.log) and the FX Downloader log file.

...

  • The FX Downloader will run the process, }APQ.C3.FIN.Cub.CurrencyXRDaily.FillBlanks that will clear the FIN Currency xR Daily cube for a specified date range . All and a list of symbols provided in pSymbols parameter (if supplied, otherwise all currency pairs data will be cleared regardless of pSymbols parameter settings).

  • Supply a valid connection object name from config.json in parameter pConnection should you define your own connection information other than 'default'.

  • After the download of data is successfully finished, the FX Downloader will run the process, }APQ.C3.FIN.Cub.CurrencyXRDaily.FillBlanks to make sure currency rates are populated into non-trading days by repeating last non-zero currency rate from preceding trading day. Take extra care to specify a start date range (pStartDate) that is an actual trading day to avoid repeating invalid currency rates.

  • Success or failure of the credentials store action will be communicated by the Apliqo FPM messaging framework. Messages are output into the }APQ Process Response Message cube, in the TM1 System Log (tm1server.log) and the FX Downloader log file.

...

Or, you may run the process }APQ.C3.FIN.Cub.CurrencyXR.Update.From.CurrencyXRDaily with following parameters:
pCurrencyVersion: Target currency version to load the data into (default is ACT).
pCurrency: You may supply a list of delimited target currencies to be updated. The source currency is the Lead Currency set in }APQ Settings cube. Target currencies are all currencies under the Reporting Currency All Leaf Currencies excl. Local rollup in FIN Currency dimension.
pYear: The Financial Year for the required date range.
pMonthFrom: Starting financial month corresponding to required date range.
pMonthTo: Ending financial month corresponding to required date range.

...

  • The FX Downloader log can be found in .\<FPM install location>\Batch\fxdownload\log\application.log for basic troubleshooting. The log is available in highest verbosity level (debug).

  • You may set pLogLevel parameter value of process }APQ.C3.FIN.Cub.CurrencyXRDaily.LoadFromAPI to “DEBUG” to have debug level logs routed into TM1 message cube.

...