DML: Reserved words and special characters

Reserved words

Special Characters

Reserved words and special characters are elements that have a predefined meaning in DML code.

Reserved words

The following table lists and describes the set of reserved words in alphabetical order, along with the meaning and use of the word in this software.

You can use the following words in the names of Business Document and Business Document nodes.

Note DML reserved words are not case sensitive. For example, the two following expressions are equivalent:

IF (MyElement = 1) THEN 2 ELSE 3

if  (MyElement = 1) then 2 else 3

List and description of reserved words in alphabetical order

Reserved word Rule

absent

constant

and

logical operator

break

jump instruction

case

DML instruction

default

DML instruction

defined

operator

do

DML instruction (for each do, n times do)

else

conditional operator

false

constant

for each

DML instruction

for each do

DML instruction

for each attribute

DML instruction

for each child

DML instruction

for each terminal child

DML instruction

if

DML instruction

in

operator

into

DML instruction (parse into)

item

constant (where clause)

loop

DML instruction

loop on

DML instruction

next

jump instruction

not

logical operator

null

constant

on

DML instruction (loop on)

or

logical operator

out

operator

parse

DML instruction

separate

DML instruction argument (used with for each, loop on)

When there are multiple paths that return the same field several times, the standard behavior of the for each instruction is to process these fields only once.

To separately process the field for each path, add the separate argument after the instruction (for each separate, loop on separate).

The separate argument impacts the field processing order:

  • without separate: evaluates targeted nodes, then processes them.
  • with separate: evaluates targeted nodes of the first path, processes them, then evaluates for the next path, processes them, and so on.

switch

DML instruction

then

DML instruction (if-then-else)

this

constant (Business Document Paths)

times

DML instruction (n times, n times do)

to

comparison operator

true

constant

undefined

operator

where

DML instruction (where clause)

while

DML instruction

xor

logical operator

Special Characters

The following table lists and describes the role of the DML special characters. You can use special characters in the names of Business Documents and Business Document nodes.

The DML special characters include:

Character Meaning

!

The exclamation mark delimits the names of Business Document and Business Document nodes that include reserved words or special characters.

You cannot use the exclamation mark in any name that you define in Mapping Services.

.

The period character:

  • Delimits the parts of an object name. For example:
    • Folder_name.table_name is the name of a Table that is in the current Entity but not the current WorkFolder.
    • entity_name.Folder_name.table_name is the name of a Table that is not in the current WorkFolder, nor in the current Entity.
  • separates the whole number portion from the decimal portion in a real number
  • refers to the current context in a Business Document Path

-

The minus sign is an arithmetic operator and precedes a negative real number or integer.

+

The plus sign is an arithmetic operator and precedes a positive real number or integer.

$:=

The dollar sign, colon character, and equals sign indicate which expression returns a value in an instruction block. In Mapping Services; instruction blocks form part of the following DML instructions:

$

The dollar sign delimits the name of system fields.

:=

The colon character and equals sign assigns a value to a Variable.

%

The percent sign encloses the name of a Mapping Services Variable

( )

Parentheses:

  • Indicate priority in expressions. Data in parentheses is processed before data that is not in parentheses.
  • Enclose Function parameters.

,

The comma character:

  • Separates each parameter in a Function call.
  • Separates the whole number portion from the decimal portion in a real number.

;

The semicolon character separates each expression in a list of expressions.

@

The commercial at symbol precedes the name of an Attribute node.

..

Two periods refer to the parent of the current context in a Business Document Path.

\

The backslash character:

  • Separates the names of nodes in a Business Document Path.
  • Refers to the root of a Business Document in a Business Document Path.
  • Separates the names of a folder and a subfolder in a name of Variable, Custom Function, or Table.
  • Is used as an escape character in String constants (suppresses the special meaning of the following character in the string).

[ ]

Square brackets enclose:

  • The index of a node in a Business Document Path.
  • The name of an environment variable.

{ }

Curly brackets enclose the set of statements that belong to:

  • A for each do instruction
  • A loop instruction
  • A loop on instruction
  • An n times do instruction
  • The then and else blocks of an if-the-else instruction
  • A while instruction
  • A switch or case instruction

#

The hash character delimits the names of Business Document nodes in SQL instructions. You define SQL instructions in dbStatements.

{#

Start of a comment in a DML expression.

#}

End of a comment in a DML expression.

Related Links