Home
Functions and Expressions
Use HCL Link functions and expressions to create component rules and map rules.
Number format strings
You can create custom number formats by using the given format strings.
Whole number and fraction format strings
You can use these format strings to specify the range of whole number digits and of fraction digits.

Functions and Expressions
Use HCL Link functions and expressions to create component rules and map rules.
- Expressions and evaluations
  The documentation provided here describes HCL Link functions and expressions. Functions and expressions are used to create component rules and map rules.
- Using functions
  A function is an expression that generates an output by performing a certain operation on one or more inputs.
- Syntax of a function
  The following is an example of a function:
- Function argument syntax
  Arguments typically have some restrictions on the expression used for that argument.
- Character-set encoding functions
  Functions that use the HCL Link EXIT architecture convert data to the native character set of the platform as part of the function call.
- General functions
  There are several general functions you can call from map rule to process input.
- Bidirectional functions
  Bidirectional languages such as Arabic and Hebrew are languages in which the text is presented to the user ordered from right to left, but numbers and Latin alphabetic strings within the text are presented left to right.
- Bit manipulation and testing functions
  You can use this function to manipulate and to test a bit in a binary number.
- Cache functions
  Use cache functions to specify a value for each of the cache variables defined for a flow, and additionally, to alter an already specified value for a cache variable.
- Conversion functions
  You can use this function to convert an expression from one datatype to another datatype.
- Date/time functions
  You can use this function to perform various operations on date and time.
- Error handling functions
  You can use this function in evaluating the type of error during map execution.
- External interface functions
  You can use this function to retrieve data from a database from within in a map rule.
- Flow functions
  Use Flow functions to specify a value for each of the flow variables defined for a flow, and additionally, to alter an already specified value for a flow variable.
- Inspection functions
  You can use this function to test and inspect the object.
- Logical functions
  Logical functions provide a way to use logical conditions to display one of several values.
- Lookup and reference functions
  These function search operates by scanning the appropriate set of items in sequence, attempting to match the logical condition.
- Math and statistics functions
  Precede all MATHLIB functions with mathlib->
- Text functions
  These functions are used to convert the text item in a map rule.
- XML functions
  There are several XML functions that you can call from component rules and map rules to process input XML data.
- Custom functions
  From the Type Designer or Map Designer, you can create custom functions to call external libraries.
- Date and time format strings
  You can use the listed format strings for numbers, dates and times in functions such as the CURRENTDATETIME, FROMNUMBER, TONUMBER, FROMDATETIME, and TODATETIME.
- Number format strings
  You can create custom number formats by using the given format strings.
  - Leading sign format strings
    You can create leading sign formats by using the given format strings.
  - Trailing sign format strings
    You can create trailing sign formats by using the given format strings.
  - Substring format strings
    You can create substring formats by using the given format strings
  - Whole number and fraction format strings
    You can use these format strings to specify the range of whole number digits and of fraction digits.
- RUN function return codes
  The RUN function return codes and messages might result when using the RUN function.
- Character set codes for CPACKAGE, CSERIESTOTEXT, and CTEXT
  The second argument of the CPACKAGE, CSERIESTOTEXT, and CTEXT functions specifies the character set of the output of the function. The value of the second argument (the character set of the object content), must be a valid character set code.

Whole number and fraction format strings

You can use these format strings to specify the range of whole number digits and of fraction digits.

Whole# substring name

Substring value: Meaning
MinDigits(1) + "#" + Value(1) + "###" + MaxDigits(1)
MinDigits(1) + "#" + "[" + Value(1) + "]" + "###" + MaxDigits(1): Specifies the thousands separator and the range of whole number digits. If min-digits is not used, the default is zero. If max-digits is not used, the default is "S". If a ThousandsItem is specified, a Value must be present as the default for the syntax item.

Fraction substring name

Substring value: Meaning
"V" + ImpliedPlaces: Specifies the decimal to be in an explicit place, and ImpliedPlaces determines where the intended decimal separator is to be placed.
Value + MinDigits(1) + "##" + MaxDigits(1): Specifies the value of the decimal separator to be required and the range of fraction digits. If min-digits is not used, default is zero. If max-digits is not used, default is "S"
"[" + Value + MinDigits(1) + "##" + MaxDigits(1) + "]": Specifies the value of the decimal separator to be optional if there is no fractional portion of the number. It also specifies the range of fraction digits. If min-digits is not used, default is zero. If max-digits is not used, default is "S"