Return to main navigation Page
The currency attribute is displayed as a floating point
number field that will display the number in currency format. The
currency displayed is the user's currency.
Currency attributes can be of array and non-array types. A range check can be defined on currency attributes.
Currency is also supported for single-select and multi-select menus.
Configuration currency attributes support negative currency.
However, no special formatting is available for negative currency.
Currency is formatted based on the current user's currency preference.
Accessing the Text Attribute Editor Page for Currency Attributes
Navigate to the Configurable Attributes Administration List page.
Click Admin to go to the Admin Home Page.
Click Catalog Definition in the Products section.
The Supported Products page appears.
In the Navigation column, select Configurable Attribute and then click List.
The Configurable Attributes Administration List page appears.
Click the name of an attribute with Currency in the Attribute Type column, or create a new attribute.
The Text Attribute Editor page for Currency attributes appears.
Using the Text Attribute Editor Page for Currency Attributes
The Text Attribute Editor for currency has the following sections under the General tab: Main Information, Properties, Currency Properties, and Data Validation.
Main Information Section
- Edit the Name of the attribute.
Enter a Description.
If Help Icon is checked for the attribute
in the Configuration Flow Editor, the description appears when the user
hovers over the help icon.
For more information, see Configuration Flows.
- Choose the Set Type:
- None The user can input any value without encountering an error message.
- Set A recommendation rule can change the value entered by the user unless the attribute is locked by the user.
- Forced Set
A recommendation rule will change the value of the attributes
regardless of what the user enters and if the attribute is locked or
- Select the appropriate checkbox for:
- Required This will require the user to enter a value before proceeding to a commerce transaction.
- Hidden This attribute will not appear to the user. It can be used in rules.
- Auto Update This will by updated by the system without the user invoking an action.
- Hide In Transaction This attribute is hidden within a commerce document.
- Choose the Status of the attribute:
Click Show Start/End Dates to specify how long the attribute will remain in the chosen status.
If no duration is specified, the attribute maintains its status until the admin changes it.
An drop-down appears for every currency defined for CPQ Cloud. Select the decimal precision.
Data Validation Section
- Enter a default value in the Default field.
- Select a validation.
- None A validation will not be run.
- Range Check Enter a minimum and maximum value.
Use in Configuration Rules
attributes can be used in the Condition, Action, Condition Input and
Action Input like other configurable attributes. In advanced functions,
currency is treated as a float.
- Currency attributes in Condition – Currency attributes can be used in the Simple and the advanced condition.
used in the Simple Condition, the following options are available as
Operators: “=”, “Not =”, “>”, “<”, “>=”, “<=”
- The simple condition grid also supports ranges for currency attributes.
- Currency Attributes in Action – Recommendations, Constraints and Hiding rules can be defined on currency attributes.
- Simple action for constraint rules allow the FullAccess user to constrain a range of values for currency attributes
$BM_UNCHANGED_NUM$ is supported for array type currency attributes
For a multi-currency application, if the
user currency is not the same as the base currency, then exchange rates
are applied to convert the currency attribute value to the corresponding
value in the base currency for use in BML.
Anything returned from BML is in base currency and exchange rates are applied on the way back out.
Use in Configuration Pages
Currency Attributes can be displayed in the Default and Advanced Templates.
Currency can be displayed in the Search Flow in the Default or Advanced Template
- Currency in Function to evaluate Result Set –
Only unformatted currency is passed into the Function to evaluate Result
Set. The currency will be formatted on the Search Result page based on
the current user’s session currency.
- Currency in pop-up function – Formatted
currency must be passed into pop-up function as currency formats will
not be applied on the end user side.
Currency attributes in BML and BML Library
The following functions have been provided for currency attributes:
- formatascurrency: This function takes a number and returns it as a formatted string
- Syntax: String formatascurrency(Float x, [String currencyCode]
- Example:formatascurrency(32.15, "EUR"); will return the string "€32,15".
- getcurrencyvalue: This function takes a formatted currency string and returns the numeric value
- Syntax: Float getcurrencyvalue(String value, [String currencyCode])
- Example: getcurrencyvalue("€32,15", "EUR"); will return the float 32.15
In Configuration, currency attributes are displayed in the format of the session currency of the user.
Have as few attributes "auto-update" as possible.
A FullAccess user can choose to display currency in the printed document using the formatting functions available.
values are carried from Configuration to Commerce and can be displayed
on the sub-document in the format of the document currency.
Attribute range calculations are validated on the Value Punch-In.
Example: If the value was passed in the URL to the Configuration, it will be validated and an error message will appear.
This affects both Mobile and Desktop.
Currency values in SOAP are not
formatted, though the user's session currency is taken into account to
apply exchange rates and return the correct values.
NULL and blank Integer values are treated as separate values.
- NULL= 0
- Blank = ""
If you use logic that tests for NULL values in rule conditions or BML, this logic should be updated.
Using "null" as an attribute value is strongly discouraged.