Home
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.
Data object names
A data object is referenced in an expression by its name.
Comment object name
A comment name can be either an in-comment name or an @-comment name.

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.
  - Expressions
    An expression is a statement about data objects. Expressions are used in component rules in the schema designer and in map rules in the map designer.
  - Literals
    A literal is a constant value. A literal may be a number or a text string.
  - Data object names
    A data object is referenced in an expression by its name.
    - Object names in map rules
      In a map rule, data object names always refer to the card name that contains the data object name. So, in a map rule, a data object name ends with a card name.
    - Object names in component rules
      In a component rule, data object names always refer to components in the same component list. In a component rule, a data object name ends with a component name.
    - Card name
      A map rule can reference the object of an entire card. A card name is a simple type name from 1 to 32 bytes in length in UTF-8 encoding.
    - Local type name
      An object name can be a local type name.
    - Partition list
      A partition list is a set of partition names separated by the symbols <>.
    - Component path
      A component path is specified as an optional partition list, followed by a local type name and then followed by an optional index.
    - Indexed object names
      An object name can refer to a particular occurrence of a data object. The index of the occurrence appears in square brackets immediately after its name.
    - Component paths separated by a colon
      A component in the component list of another object is always referenced by a colon (:).
    - Component paths separated by IN
      To reference all occurrences of an object contained in another object, use the keyword IN.
    - Comment object name
      A comment name can be either an in-comment name or an @-comment name.
    - Shorthand notation
      In a rule, a dollar sign ($) can be used to refer to the object to the left of the rule cell.
  - Evaluating expressions
    Expressions are evaluated based on the context in which data object names, literals, operators, function names and map names appear in the expression, and the data on which it operates. .
  - Operators
    Operators are used for arithmetic functions and text functions on items.
  - Using functions in expressions
    Functions perform a particular action on its input arguments.
  - Map names in expressions
    Map names in expressions that are used in map rules represent calls to functional maps.
  - Expressions that evaluate to NONE
    The following discussion explains how the map designer evaluates an expression when expressions within it evaluate to "none".
  - Evaluated expressions assigned to output items
    When an output item is defined, then it is determined from the result of the evaluated expression.
  - Automatic item format conversions
    When an item is assigned an output value, the map designer will automatically convert an item with the same interpretation (either number, text, date, or time) from one presentation to another.
- 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.
- 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.

Comment object name

A comment name can be either an in-comment name or an @-comment name.

An in-comment name references all comment objects within a specified object. An in-comment name is specified as a component-path, a space, the reserved word IN, followed by another space, followed by the component path of the component on which the floating component type is defined. For example, given the data structure shown below, to reference all INPUT Parameters for a particular Input, regardless of whether they followed Method OpenFile or Method GetEntry, the object name would be INPUT Parameters IN Input.

An @-comment name references all comment objects that follow immediately after a specified object. An @-comment name is specified as the component path of the comment, followed by the reserved symbol "@", followed by the component path of the component that follows the comment. For example, to reference only the INPUT Parameters that follow immediately after the Method OpenFile (and before Method GetEntry), the object name would be INPUT Parameters @ Method OpenFile:Input.