Source Mnemonics

This table describe the mnemonics that control how the data in a column is derived.

Mnemonic

Description

Valid Values

Comments

source=

Defines how the column’s value is derived.

SQLCOL

Indicates that the source of the column’s value comes from a column in the SQL statement. This type of column must also reference the sqlcol= mnemonic.

BO

Indicates that the source of the column’s value comes from a business object. This type of column must also reference the bo=, input= and output= mnemonics to define how to interact with the business object.

BS

Indicates that the source of the column’s value comes from a business service. This type of column must also reference the bs=, input= and output= mnemonics to define how to interact with the business service.

SS

Indicates that the source of the column’s value comes from a service script. This type of column must also reference the ss=, input= and output= mnemonics to define how to interact with the service script.

FORMULA

Indicates that the source of this column’s value is calculated using a formula. This type of column must also reference the formula= mnemonic.

SETFUNC

Indicates that the source of this column’s value is calculated using a superset of values from the rows in the SQL statement. This type of column must also reference the setfunc= mnemonic.

ICON

Indicates that the source of this column’s value is a display icon reference (meaning that an icon will be displayed in the column). This type of column must also reference the icon= mnemonic to define the icon reference.

Note: When using this source mnemonic, the formatting mnemonic type= is not applicable.

FKREF

Indicates that the source of this column’s value is an FK reference (meaning that the FK reference’s context menu and information string will be displayed in the column). This type of column must also reference the fkref= and input= mnemonics to define how the FK reference is called.

Note: When using this source mnemonic, the formatting mnemonic type= is not applicable.

SPECIFIED

Indicates that the source of this column’s value is specified by concatenating literals and other column values. This type of column must also reference the spec= mnemonic.

MSG

Indicates that the source of this column is a message from the message table (along with any substitution variables). This type of column must also reference the msg= mnemonic.

sqlcol=

Defines the column in the SQL statement when source=SQLCOL

COLUMN_​​​NAME

Enter the name of a column that is retrieved in the SELECT statement. Note that if the select statement uses an alias for a column, then the alias should be referenced here.

x

Where x is an integer value that references a column by its relative position in the SELECT statement. For example, sqlcol=3 would display the 3rd column in the SELECT statement).

bo=

Defines the business object to invoke when source=BO.

This mnemonic must be used in conjunction with the input= and output= mnemonics to define how information is sent to / received from the business object.  

Cx

This means business object code is defined in an earlier column.  For example, define C1 if column 1 defines the business object.

COLUMN_​​​NAME

This means the business object was retrieved by the SELECT statement.  The value should match the name defined in the SELECT clause.

‘Business Object Code’

This means the business object is defined directly. For example ‘F1–BundleImport’.

bs=

Defines the business service to invoke when source=BS.

This mnemonic must be used in conjunction with the input= and output= mnemonics to define how information is sent to/received from the business service.  

Cx

This means business service code is defined in an earlier column.  For example, define C1 if column 1 defines the business service.

COLUMN_​​​NAME

This means the business service was retrieved by the SELECT statement.  The value should match the name defined in the SELECT clause.

‘Business Service Code’

>

This means the business service is defined directly. For example ‘F1-GetCountryStates’.

ss=

Defines the service script to invoke when source=SS.

This mnemonic must be used in conjunction with the input= and output= mnemonics to define how information is sent to / received from the service script.  

Cx

This means service script code is defined in an earlier column.  For example, define C1 if column 1 defines the service script.

COLUMN_​​​NAME

This means the service script was retrieved by the SELECT statement.  The value should match the name defined in the SELECT clause.

‘Service Script Code’

This means the service script is defined directly. For example ‘F1-ReturnBtn’.

formula=

Defines the formula to use when source=FORMULA.

Examples:

  • formula=C1*.90/C2

  • formula=(C1/C2)*100

The formula can contain numeric constants, operators and column references.

For column references, use the format Cx where x represents the column number.

The following operators are supported: *, /, -, +, ABS, NEGATE, ROUND, FLOOR (round down), CEILING (round up), SIN, ASIN, COS, ACOS, TAN, ATAN, LOG, LOG10, EXP, EXP10, SQRT, **.

setfunc=

Defines the function to apply to the rows of a given column when source=SETFUNC.

function(Cx)

Where Cx represents a column whose rows should have the function applied and the function is one of the following

  • MAX. This derives the maximum value of all rows in the column.

  • MIN. This derives the minimum value of all rows in the column.

  • TOT. This derives the sum (total value) of all rows in the column.

  • ACC. This derives the cumulative total of all rows up to an including the current row.

input=

This is used to define one or more input fields and values passed to business objects, business services, service scripts, and FK references.

The syntax is as follows: [ELEMENT_​​​NAME=ELEMENT_​​​REF ELEMENT_​​​NAME=ELEMENT_​​​REF ...]

In other words, the list of input values is surrounded by square brackets separated by a space. Each passed value first defines the ELEMENT_​​​NAME, which is the name of the element / field in the target. ELEMENT_​​​REF is the value passed in. The next column indicates the possible values for ELEMENT_​​​REF.

Cx Where Cx represents the value of a previous column. If the value to pass is in the first column, reference C1.
COLUMN_​​​NAME This means the value to pass in was retrieved by the SELECT statement.  The value should match the name defined in the SELECT clause.
‘literal value’ This means a literal value within the single quotes should be passed in.

userTimeZone

This means the current user's time zone should be passed in. This is typically used with the business service F1-ShiftDateTime to convert data in the storage time zone to the user's time zone for display.

Examples:

  • input=[USER_​​​ID=C1]

  • input=[USER_​​​ID=USER_​​​ID]

  • input=[input/targetTimeZone=userTimeZone]

output=

This is used to define the name of the element retrieved from the business object, business service or service script used to populate this column.

elementName

Example: output=personInfo