Function Name

Function

add

R = X + Y

subtract

R = X - Y

equalsA

R = true, if value X equals value Y, otherwise R = false. The values are interpreted numerically, therefore the value 1.5 is the same as 1.50.

abs

O = absolute value of I

sqrt

R is the square root of X

sqr

R is the square of X

sign

R = 1, when X is a positive number

R = 0, when X equals 0

R = 1, when X is a negative number

neg

R = -X

1/x

R is the reciprocal of X

power

R = X^Y

less

true, when X < Y, otherwise false

greater

true, when X > Y, otherwise false

multiply

R = X * Y

divide

R = X / Y

max

R = Maximum of values X and Y

min

R = Minimum of values X and Y

ceil

O = The smallest possible integer value (up to minus 'infinite’) that is not smaller than the argument I. Corresponds to the Java function java.lang.Math.ceil().

floor

O = The largest possible integer value that is not larger than the argument I. Corresponds to the Java function java.lang.Math.floor().

round

O = integer value back that is closest to the value of argument I. Corresponds to the Java function java.lang.Math.round().

counter

O = Number of calls for this target field mapping where you specify the initial value and the increment of the counter in the function properties.

FormatNum

Converts I according to a pattern that you define using the function properties. The possible patterns are the same as in the Java class java.text.DecimalFormat.

Function Name

Function

And

R is true if X and Y have the value true. Otherwise, R is false.

Or

R is true if X or Y have the value true. Otherwise, R is false.

Not

·        O is false if I has the value true

·        O is true if I has the value false

Equals

Compares both boolean values X and Y and returns true if both are equal, otherwise false. Non-Boolean values are interpreted as false (see above).

Use the functions equalsS or compare from the Text category to compare strings.

notEquals

R = Not(Equals(X,Y))

if

·        If condition X is fulfilled (gets true): R = Y

·        If condition X is not fulfilled (gets false): R = Z

ifWithoutElse

If condition X is fulfilled (gets true): R = Y. Which Else-value the function is to get depends on various different factors (see the detailed documentation for more information).

Function

Use

Constant

O gets any string constant that you can enter in the dialog for the function properties.

CopyValue

For a frequently occurring element, copies the value at a defined position in the source structure to the assigned target field.

sender

O gets the name of the sender system. Test_Sender_System is outputted when you test the message mapping in the Integration Builder.

receiver

O gets the name of the receiver system. Test_Receiver_System is outputted when you test the message mapping in the Integration Builder.

Function

Use

FixValues

Executes a value mapping using a fixed value table that you complete using the function properties. The table is saved together with the most current message mapping and can only be used once.

Value mapping

Executes a value mapping for the value I entered. In the function attributes, assign both input value I and source value O to a representation in the value-mapping table. In this way, you can assign source and target structure fields to a representation. You complete the value-mapping table on the configuration maintenance screen in the Integration Builder. Since these entries are not available at design time, the mapping result is just an estimate when you test the message mapping. See also: Value Mapping.

The runtime interface for value mappings has changed for XI 3.0. However, XI 2.0 message mappings that call the Value Mapping function still function using the old runtime interface. To use the function parameters in the new runtime interface, choose XI 3.0 Interface.

Function

Use

currentDate

Returns the current data using O.  This function is a generating function.

DateTrans

Converts date format I to another date format O.

DateBefore

R = true, when date X comes before date Y, otherwise false

DateAfter

R = true, when date X comes after date Y, otherwise false

CompareDates

R = 1, when date X is after date Y
R = 0, when date X is the same as date Y
R = -1, when date X is before date Y

Function

Use

createIf

If there are structuring elements in your target structure that do not exist in the source structure, insert them using this function. Using condition I you can control whether the element is inserted or not. You connect the element in the target structure using O.

removeContexts

Removes all top contexts of a source field. In this way, you can delete all hierarchy levels and generate a list.

replaceValue

Replaces the value I with a value that you can define in the dialog for the function properties.

exists

O = true, if the source field assigned to inbound channel I exists in the XML instance. Otherwise, false.

SplitByValue

Inserts a context change for an element.

collapseContexts

Deletes all values from all contexts from the inbound queue except for the first value. Empty contexts (= ResultList.SUPPRESS) are replaced by empty strings. Only one queue remains, which consists of contexts that contain just one value each. Finally, all internal context changes are deleted, so that all values belong to one and the same context.

useOneAsMany

Replicates a value of a field that only occurs once, to enable you to pair it with the values of a field that occurs more than once as a record.

sort

Sorts all values of the multiply-occurring inbound field I within the existing or set context. The sorting process is stable (the order of elements that are the same is not switched) and it sorts the values in O(n*log(n)) steps. Using the function properties, you can specify whether values are to be sorted numerically or lexicographically (case-sensitive or non case-sensitive) and in ascending or descending order.

sortByKey

Like sort, but with two inbound parameters to sort (key/value) pairs. The sort process can be compared to that of a table with two columns.

·        Using the first parameter, you pass key values from the first column, which are used to sort the table. If you have classified the key values as numeric in the function properties, they must not be equal to the constant ResultList.SUPPRESS. See also: The ResultList object

·        Using the second parameter, you pass the values from the second column of the table.

If there is a discrepancy between the number of keys and values, the mapping runtime triggers an exception. The function returns a queue with the values sorted according to the keys.

mapWithDefault

Replaces empty contexts in the inbound queue with a default value, which you specify in the function properties.

Example:
If “Default” is the default value and
A|B1,B2| |C| |D
is the inbound queue,
mapWithDefault returns the following outbound queue:
A | B1,B2 | Default | C | Default |D.

The function corresponds to the following combination of standard functions:

If(
  []field,
  exists([]field),
  Constant([value=default]))

formatByExample

This function has two inbound queues, which must both have the same number of values. To generate the result queue, the function takes the values from the first queue and combines them with the context changes from the second queue.

Function

Use

sum

R = Sum of values X₁ to X_i of a context.

average

R = Average of values X₁ to X_i of a context.

count

R = Number of fields in a context (i)

index

In the function properties, you specify the following: the initial value of i, the increment, and whether the index value is to be reinitialized at the beginning of every new context, or whether it is to have the same value for the entire source structure.

Function

Use

substring

Returns a substring O for a string I. Use the dialog for the function properties to specify the position of the substring. Example: substring(“Hello“, 0,1) = “H“, means that the substring from Startindex 0 to Endindex 1 (not including position 1) is shown.

concat

R = linking of strings X and Y (without blanks).

Example: X = “Mrs.”; Y = “Miller”; R = “Mrs.Miller”. Use the dialog for the function properties to insert a separator in the string.

equalsS

R = true, if string X equals string Y, otherwise R = false.

indexOf
(2 input parameters)

R = first position at which string Y is found in X and –1 if Y does not occur at all.

indexOf
(3 input parameters)

R = first position from position Z at which string Y is found in X and –1 if Y does not occur at all.

lastIndexOf
(2 input parameters)

R = last position at which string Y is found in X and –1 if Y does not occur at all.

lastIndexOf
(3 input parameters)

R = Last position from position z at which string Y is found in X and –1 if Y does not occur at all.

compare

Compares string X with string Y:

R = 0, when the strings are equal
R = positive number i, when X is lexicographically larger than Y
R = negative number i, when X is lexicographically smaller than Y

i specifies the difference between the two strings lexicographically.

The function acts in the same ways as the method compareTo()of the JDK class java.lang.String.

replaceString

X: String in which something is to be replaced

Y: Sequence to be replaced in X

Z: Sequence to replace Y

R = Sequence in which each occurrence of Y in X is replaced by Z.

X = "sparring with a purple porpoise"

Y = “p”

Z = “t”

R = "starring with a turtle tortoise"

length

O = Length of string

endsWith

R = true when Y is the last string in X; otherwise false.

startsWith
(2 input parameters)

R = true when Y is the first string in X; otherwise false.

startWith
(3 input parameters)

R = true when Y matches X from position Z; otherwise false.

toUpperCase

Converts all lower case characters to upper case from I

trim

Removes all white space characters at the start and end of a string. Acts the same as the method trim() of the JDK class java.lang.String.

toLowerCase

Converts all upper case letters from I to lower case letters