Apama 10.3 | Apama Capital Markets Foundation Documentation | Capital Markets Foundation | Analytics | Creating and configuring a currency converter | Default settings for currency converter parameters | Descriptions of currency converter parameters
 
Descriptions of currency converter parameters
Constant values defined in com.apama.ccyconverter.Consts define the names of the configuration parameters that control currency converter behavior. These configuration parameters are described below.
Parameter
Description
CONFIG_BASE_CURRENCY
Defines the name of the configuration parameter that specifies the base currency. The base currency is the currency that the currency converter will normalize values to. The currency converter uses this parameter in conjunction with the CONFIG_CURRENCIES parameter to construct the sequence of symbols for which to obtain values.
CONFIG_CROSS_CURRENCY_INFO
Defines the name of the configuration parameter that specifies the cross currency pairs that the currency converter uses to construct symbols. Use this parameter with the CONFIG_SYMBOLS and CONFIG_CURRENCIES parameter. The type of the value of this configuration parameter must be dictionary<string,string>. See About cross currencies.
CONFIG_CURRENCIES
Defines the name of the configuration parameter that specifies the sequence of currencies that the currency converter will use to construct symbols for which to obtain updates. The type of the value of this parameter must be sequence<string>. The currency converter uses this parameter in conjunction with the CONFIG_BASE_CURRENCY parameter to construct the sequence of symbols for which to obtain values.
CONFIG_CURRENCY_SEPARATOR
Defines the name of the configuration parameter that specifies the currency separator that the currency converter uses when constructing or splitting symbols. The default is /.
CONFIG_ENABLE_PERSISTENCE
Defines the name of the configuration parameter that specifies whether persistence is enabled for the currency converter. Note that currency converter persistence is separate from correlator persistence. When currency converter persistence is enabled the last stored values in the currency converter's cache are reloaded to be used until the fresh values are obtained from the calculation extension. The default is false.
CONFIG_SYMBOLS
Defines the name of the configuration parameter that specifies the sequence of symbols that the currency converter supplies values for. If you set values for CONFIG_BASE_CURRENCY and CONFIG_CURRENCIES but not CONFIG_SYMBOLS the currency converter can construct the sequence that would have been specified in CONFIG_SYMBOLS itself.
If you specify a value for each of these parameters: CONFIG_BASE_CURRENCY, CONFIG_CURRENCIES, and CONFIG_SYMBOLS, the currency converter constructs a superset of each value in CONFIG_SYMBOLS plus each possible combination that results from the specifications of CONFIG_BASE_CURRENCY and CONFIG_CURRENCIES.
Specify a value for CONFIG_SYMBOLS when you know the exact symbols you need values for or when you want to normalize to more than one base currency. When you want to normalize to a single base currency you can use CONFIG_BASE_CURRENCY and CONFIG_CURRENCIES without specifying a value for CONFIG_SYMBOLS.
CONFIG_TIMEOUT_DURATION
Defines the name of the configuration parameter that specifies the maximum duration in seconds that any asynchronous communication can take before an error is returned. For example, if you connect to a remote currency converter, the operation waits no more than 5 seconds for the currency converter to be created. The default is 5.0.
CONFIG_UPDATE_TIMEOUT
Defines the name of the configuration parameter that specifies the timeout for obtaining currency values from the extension. For example, using the default (0.5), the currency converter would obtain values from the extension every half second. To disable automatic retrieval of values, set this parameter to 0.0. For additional information, see the documentation for the refresh() action in Creating a currency calculation extension.
CONFIGSTORE_PATH_DEFAULT
Defines the name of the configuration parameter that specifies the default file and path for persisting currency converter data in configuration store tables. The default is "CurrencyConverter.sqlite". To change the setting of this parameter, use the CONFIGSTORE_PATH_KEY parameter.
CONFIGSTORE_PATH_KEY
Defines the name of the configuration parameter that specifies the configuration key value for setting the currency converter default file and path for its configuration store tables. Use this parameter when you need to override the default storage location used by the currency converter. If you change the value of this parameter you must have read/write access to the location you specify.
CURRENCY_CONVERTER_SERVICE_TYPE
Defines the name of the configuration parameter that specifies the currency converter service that is registered with the CMF Service Framework. The default is "CurrencyConverter". You cannot modify the value of this parameter. However, you can use this parameter to query the CMF Service Framework directly for all services of this type.
DEFAULT_FIELD_NAME
Defines the name of the configuration parameter that specifies the default field name used by the currency converter and the calculation extension. The default is "VALUE". You cannot modify the value of this parameter.

Copyright © 2013-2018 | Software AG, Darmstadt, Germany and/or Software AG USA, Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.