CurrencyAdd

The CurrencyAdd verb adds a currency definition to the currency table for the model.

The user interface equivalent is to right-click a currency item in the currency table and then select Add New Currency.

The syntax is as follows.

CurrencyAdd objCurrency [Dimension objDim] 
[Drill objDrillCat] Levels objLevel [currencyrecordopts] 
CurrencyRateListEffectiveDate {objCat|0} ConversionRate rate  
[RateIsBySource {True|False}][CurrencyTableType tabletype] EndList

Argument

Description

CurrencyAdd objCurrency

Adds the currency objCurrency to the list of currencies in the currency table. objCurrency must be the object name and can include the object identifier.

Dimension objDim

Is specified, if necessary, to uniquely identify the level objLevel. objDim can be the object name, object identifier, or both.

Drill objDrillCat

Is specified, if necessary, to uniquely identify the date level objLevel. objDrillCat can be the drill category object name, object identifier, or both.

Levels objLevel

Specifies the level of the date category objCat. This indicates the granularity of the rate data, such as daily or monthly. objLevel can be the object name or object identifier. The level is mandatory.

currencyrecordopts

Optional parameters that describe the currency in greater detail. Some options are set by default if you do not set them. For the complete list of options, see currencyrecordopts .

CurrencyRateList

Indicates the start of conversion rates.

EffectiveDate {objCat|0}

Specifies conversion rates for the currency. This argument is repeated for each time period that has a conversion rate.

Each conversion rate specification starts with the keyword EffectiveDate. objCat indicates the date for each conversion rate; it is the date category and can be specified by object name, object identifier, or both. Zero (0) indicates that the country or region is part of the European Monetary Union (EMU).

ConversionRate rate

rate is the exchange rate for that date. It can include decimals; for example, 3.42556.

RateIsBySource {True|False}

RateIsBySource indicates whether the conversion rate is sourced from an external data source or was manually entered. The default is False.

CurrencyTableType tabletype

CurrencyTableType specifies the table type that applies to this currency record for the time period. tabletype can be one of BaseTable, EuroTable, or OtherTable. The default is BaseTable unless EffectiveDate is followed by zero (0), in which case the default is EuroTable.

Example

This example adds a new currency to the currency table, and specifies conversion rates for three months.

CurrencyAdd "C$" Dimension "Years"Levels "Month" CountryCode "Can" 
CurrencyRateList EffectiveDate "199601" ConversionRate 1.2 
RateIsBySource False EffectiveDate "199602" ConversionRate 1.75 
RateIsBySource False EffectiveDate "199603"ConversionRate 1.55 
RateIsBySource False EndList