CurrencyRate Function
The CurrencyRate()
model function allows users to reference exchange rates dynamically during model building. This enables calculations to automatically adapt to the configured currency settings in both Capex Strategy (CS) and Capex Management (CM) projects.
This function is particularly useful when working with international models where values need to be calculated or converted based on current exchange rates.
Syntax and usage
One parameter: Return absolute exchange rate
When a single currency code is passed, the function returns the absolute value of that currency’s exchange rate (relative to the group currency).
CurrencyRate("EUR")
Two parameters: Return exchange rate between two currencies
When two currency codes are provided, the function returns the exchange rate from the first currency to the second.
CurrencyRate("EUR"; "USD")
Use this form to perform direct currency conversions in the model logic.
Behavior by module
In Capex Strategy (CS)
The function uses either global or custom exchange rates based on project settings.
In Capex Management (CM)
The function only uses global exchange rates.
The model is built on yearly values, so even if your application use an exchange rate resolution set to monthly , the yearly average exchange rate will be used.
Special currency node references
The CurrencyRate()
function can also fetch the local currency rate for specific node types using predefined identifiers:
Node type | Function call | Description |
---|---|---|
Production Unit/Site/Mill |
| Returns the local currency for the production unit |
Division |
| Returns the local currency for the division |
Group |
| Returns the group-level currency |
Currency codes reference
All available currency codes can be found under:
Administration → Common → Currencies