Configuration Currency Attributes

Overview

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.

The following images show the different display options available for Currency attributes.

Administration

ClosedAdd a Currency Attribute Watch Video  Video icon

  1. ClosedNavigate to the Attributes Administration List page.

    1. Click Admin to go to the Admin Home Page.

    2. Click Catalog Definition in the Products section.

      The Supported Products page opens.

    3. In the Navigation column, select Attributes and then click List.

      The Attributes Administration List page opens.

  2. Click Add. The Attribute Editor page opens.

    Attribute Editor with Currency selected

  3. Enter information for the fields listed below.

    Note: Fields preceded by an asterisk (*) are required.

    Field Description

    *Name

    Enter the attribute name.

    *Variable Name

    The Variable Name field populates automatically. Variable names can only contain alpha-numeric characters and underscores. The entry can be changed before saving, but after saving the value is read-only.

    Note: Customers should not use any of the following names for Configuration attribute variable names. Using these values may cause issues with customer configurations and could possibly alter site functionality.

    • action_id
    • bm_cm_process_id
    • _bom_
    • bs_id
    • commerce_doc_url_params
    • commerce_list_id
    • document_id
    • document_number
    • folder_id
    • formaction
    • from_config
    • scrollTop
    • shopping_cart_id
    • step_id
    • token
    • version_id
    *Category

    Select Configurable Attribute or Signed Punch-in Attribute.

    A Signed Punch-in Attribute functions identically to Configuration attributes except they require verification of digital signature data before pricing data is provided to the end customer. See Signed Punch-in Attributes for more information.

    Array Type

    Select this checkbox if the attribute can be used as a column in an array set.
    Refer to Managing Arrays and Sets for more information.

    *Data Type

    Select Currency.

    Attribute Type Select Text Field.
  4. Click one of the following:

    • Cancel to return to the Attributes List page without saving changes.
    • Add and New to save changes and create another attribute.
    • Add to save changes and open the Text Attribute Editor, proceed to Edit a Currency Attribute.

ClosedEdit a Currency Attribute Watch Video  Video icon

  1. ClosedNavigate to the Attributes Administration List page.

    1. Click Admin to go to the Admin Home Page.

    2. Click Catalog Definition in the Products section.

      The Supported Products page opens.

    3. In the Navigation column, select Attributes and then click List.

      The Attributes Administration List page opens.

  2. Click the name of an attribute with Text in the Attribute Type column, or create a new attribute.

    The Text Attribute Editor page opens.

    Currency Attribute Editor

    Note: The Attribute Editor defines the default display type properties for all layouts.

    ClosedMain Information

    ClosedProperties

    ClosedCurrency Properties

    ClosedData Validation

  3. Select one of the following options:

    • If translations are required, click Translations and provide translated values for the label and description fields.

    • Click Apply to save changes and remain on the Attribute Editor page.
    • Click Update to save changes and return to the Configurable Attributes Administration List.

    • Click Update and New to define another attribute.

    • Click Back to return to the Configurable Attributes Administration List without saving changes.


Use Cases

ClosedUse in Configuration Rules

Currency attributes can be used in the Condition, Action, Condition Input and Action Input like other configuration attributes. In advanced functions, currency is treated as a float.


ClosedUse in Configuration Pages

ClosedConfiguration Flow

Currency Attributes can be displayed in the Default and Advanced Templates.


ClosedSearch Flow

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.

ClosedCurrency 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

Notes

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 = ""
  • Using NULL as an attribute value is strongly discouraged.
  • If you use logic that tests for NULL values in rule conditions or BML, confirm that the logic takes this difference into account.

A FullAccess user can choose to display currency in the printed document using the formatting functions available.

Currency 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.

In Configuration, currency attributes are displayed in the format of the session currency of the user.

Have as few attributes "auto-update" as possible.

Related Topics

Related Topics Link IconSee Also