Table of Contents

Search

  1. Preface
  2. Introduction to Data Transformation
  3. Data Processor Transformation
  4. Wizard Input and Output Formats
  5. Relational Input and Output
  6. XMap
  7. Libraries
  8. Schema Object
  9. Command Line Interface
  10. Scripts
  11. Parsers
  12. Script Ports
  13. Document Processors
  14. Formats
  15. Data Holders
  16. Anchors
  17. Transformers
  18. Actions
  19. Serializers
  20. Mappers
  21. Locators, Keys, and Indexing
  22. Streamers
  23. Validators, Notifications, and Failure Handling
  24. Validation Rules
  25. Custom Script Components

Data Transformation User Guide

Data Transformation User Guide

FormatNumber

FormatNumber

The
FormatNumber
transformer formats a number by adding a sign, decimal point, leading or trailing zeros, and unit.
The following table describes the properties of the
FormatNumber
transformer:
Property
Description
disabled
Determines whether the Script ignores the component and all of the child components. Use this property to test, debug, and modify a Script. You can choose one of the following options:
  • Selected. The Script ignores the component.
  • Cleared. The Script applies the component.
The default is cleared.
insert_decimal_point
Defines the decimal point symbol. You can choose one of the following options:
  • comma. The decimal is a comma.
  • none. The output does not have a decimal.
  • point. The decimal is a period.
Default is none.
name
A descriptive label for the component. This label appears in the log file and the
Events
view. Use the
name
property to identify the component that caused the event.
number_of_decimals
Pads the decimal part with trailing zeros to the indicated size. Default is 0.
optional
Determines whether a component failure causes the parent component to fail. You can choose one of the following options:
  • Selected. Component failure does not cause the parent component to fail.
  • Cleared. Component failure causes the parent component to fail.
Default is cleared. For more information about component failure, see Failure Handling.
remark
A user-defined comment that describes the purpose or action of the component.
sign
Determines the sign of the output number. You can choose one of the following options:
  • un_signed. Deletes a sign if present.
  • leading_sign. A plus or minus is added to the front of the output number.
  • trailing_sign. A plus or minus is added after the output number.
  • negative sign only. A minus sign is added to the number if the number is negative.
  • as in source. Does not change the input sign.
Default is un_signed.
size_of_integer_part
Pads the integer part with leading zeros to the indicated size. Default is 0.
unit_type
Defines the measurement unit after the number. You can choose one of the following options:
  • cm
  • inch
  • meter
  • mm
  • undefined. No unit is added.
Default is undefined.