Omniscripts Currency Element (Managed Package)

For the managed package runtime, enable users to enter a currency amount by adding the Currency element to your Omniscript. Update default format options such as the number of decimal places to display, minimum and maximum currency value, and more.

Managed Package app icon This information is for Omnistudio for Managed Packages. For Omnistudio on standard runtime, see Omnistudio Help.

  1. Drag a Currency element from the Build panel onto the canvas.
  2. In the Properties panel, give the element a name in the Name field.
  3. In Field Label, enter a label visible to the user.
  4. To override the default allowable format, select Custom Mask and enter a new mask in the Format Override: Custom Mask field. See JavaScript Number Formatter.
    Currency masks require both a decimal separator and a thousands separator, with a different character for each. Separator choices are a whitespace, a comma, or a period.
    Here are some examples:
    • #,###.## — Commas separate the thousands, and a period separates the decimals, with 2 decimal places.
    • #.###,## — Periods separate the thousands, and a comma separates the decimals, with 2 decimal places.
    • #,###. — Commas separate the thousands, and a period separates the decimals, with no decimal places. For the mask to ignore decimal places, the period is required.
    • #,### — Commas separate the thousands, but no decimal separator anchors where the decimal places begin. Therefore decimal places are promoted instead of ignored, and numbers are multiplied by 10 until they're at least four digits long.
  5. Configure other properties as needed:
    1. In Format Override: Decimal Places, enter a number to change the default number of decimal places to display.
    2. In Minimum Currency Value, enter the minimum value that a user can enter, such as 1.
    3. In Maximum Currency Value, enter the maximum value that a user can enter, such as 10,000.
    4. Select Allow Negative Numbers to allow users to enter negative values, such as -15.
    5. Select Hide Comma Separators to hide commas for values greater than three digits. For example, display 1000 instead of 1,000.
    6. Select Display Currency Code to display a currency code based on the logged-in user's locale. For example, if the user locale is en-US, the currency code is USD.
  • Currency Properties (Managed Package)
    For the managed package runtime, Currency properties are configurable from the Properties panel when you select a Currency element. With the Currency element, enable users to enter a currency amount in an input field in your Omniscript.