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. | ||
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 and will be enabled for navigation). This type of column must also reference the fkref= and input= mnemonics to define how the FK reference is called. Note: To show a foreign key's information but not enable navigation, refer to Common Use Cases for the recommended technique. | ||
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. | 'Business Object Code' | |
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. | 'Business Service Code' | |
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. | 'Service Script Code' | |
fkref= | Defines the FK reference used to retrieve the column’s information when source=FKREF. This mnemonic must be used in conjunction with the input= mnemonic to define how information is sent to the FK reference to build the information. | Cx | This means FK reference code is defined in an earlier column. For example, define C1 if column 1 defines the FK reference value. |
COLUMN_NAME | This means the FK reference was retrieved by the SELECT statement. The value should match the name defined in the SELECT clause. | ||
'FK Reference Code' | This means the FK Reference is defined directly. For example 'F1-ROLE'. | ||
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. |
Refer to Expression Parser for information about the functions supported. | |||
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. | ||
installationTimeZone | This means the installation 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 installation 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 |
pagingkey= | This mnemonic is only applicable when the Enable Paging parameter has been configured. It indicates that this column is one of the keys used by the SQL statement to orchestrate paging through results. This mnemonic can only be specified when the source=SQLCOL. Fastpath: Refer to Pagination Configuration for more information. | Y | |
N | This is the default, meaning that you don't need to indicate pagingkey=N at all to indicate that the column is not one of the paging keys. | ||
Mnemonic | Description | Valid Values | Comments |
|---|---|---|---|
type= | Defines how the column's value is formatted. Note:Icon and Foreign Key columns. The source= source mnemonic may be used to indicate a column should be derived from an icon reference or a foreign key (FK) reference. If you use either of these sources, the type= mnemonic is not relevant as either an icon or a context menu / info string will appear in the column. | STRING | Columns of this type capture a string. This is the default value. |
DATE | Columns of this type capture a date and will be displayed using the user's display profile. | ||
TIME | Columns of this type capture a time (in database format) and will be displayed using the user's display profile. | ||
DATE/TIME | Columns of this type capture a date and time (in database format) and will be displayed using the user's display profile. | ||
MONEY | Columns of this type capture a monetary field. This type of column may also reference the cur= mnemonic. If the cur mnemonic is not specified, the currency code on the installation record is used. | ||
NUMBER | Columns of this type capture a numeric field. This type of column may also reference the dec= mnemonic. | ||
label= | Defines the column's override label. The label appears in the column's heading and in the zone's drag and drop area. If this mnemonic is not defined, the system uses the column's default label. The source of a column's default label differs depending on the column's source. Note that some sources don't have a default value and omitting this mnemonic will result in a blank label. Note: In the case of the zone type Info Data Explorer - Multiple SQLs (F1–DE), the system will use the column definitions in SQL 1 to define the labels. | FIELD_NAME | Enter a valid field name whose label should be used for the column label. This should always be the option used if multiple languages are needed. |
'text' | Defines the text directly. | ||
cur= | Defines the currency code applied when type=MONEY if the installation record's currency should not be used. | Cx | This means currency code value is defined in an earlier column. For example, define C1 if column 1 defines the currency code. |
COLUMN_NAME | This means the currency code was retrieved by the SELECT statement. The value should match the name defined in the SELECT clause. | ||
'Currency Code' | This means the currency code is defined directly. For example 'USD'. | ||
dec= | Defines the number of decimal places when type=NUMBER. It is optional. If provided it should be an integer. If not provided, the number of decimals will default to the number of decimal places defined on the currency code specified on the installation record. | nR | Where n is the number of decimal places to show. Suffixing the number of decimal places with R means that the system should round up / down. Simply specifying n (without an R) means that decimal places should be truncated. For example, entering dec=4 will display 4 decimal places and truncate the remainder. Note:Formatting only. This mnemonic is only used for formatting, it does not impact the precision used for subsequent calculations. For example, if a column retrieved from the database contains 6 significant digits and dec=0, the column will be shown with no decimal places (truncated), however any references to the column in subsequent calculations will use 6 decimal places. For example, if the column is referenced in a formula or set function, all 6 decimal places will be used. |
char= | This mnemonic applies special character(s) to the column's value. | 'x[]x' | Where x references the literal value to display and [ ] defines the relative position of the characters (before or after the value). You need only include the [ ] if you want to position characters in front of the value. For example, char='%' will place a percent sign after the value. If you want to position the word 'minutes' before a value, enter char='minutes [ ]'. If you want to output a value like BUDGET $123.12 (YTD), enter char='BUDGET [ ] (YTD)'. |
suppress= | This is used to indicate a column should not be displayed. A column would be suppressed if it's only defined for use by subsequent columns, for example, if there is a formula that derives a column using two other columns. In this scenario, the columns referenced in the formula can be suppressed. Note: In the case of the zone type Info Data Explorer - Multiple SQLs (F1–DE), the system will apply the settings for the column definitions in SQL 1 to all subsequent SQLs. | true | |
false | This is the default, meaning that you don't need to indicate suppress=false at all to indicate that the field should be shown. | ||
suppressSearch= | This is used to indicate a column should not be displayed when the zone is invoked in search mode only. Note: In the case of the zone type Info Data Explorer - Multiple SQLs (F1–DE), the system will apply the settings for the column definitions in SQL 1 to all subsequent SQLs. | true | |
false | This is the default, meaning that you don't need to indicate suppressSearch=false at all to indicate that the field should be shown. | ||
suppressExport= | This is used to indicate a column should not be downloaded to Excel. Note: In the case of the zone type Info Data Explorer - Multiple SQLs (F1–DE), the system will apply the settings for the column definitions in SQL 1 to all subsequent SQLs. | true | |
false | This is the default, meaning that you don't need to indicate suppressExport=false at all to indicate that the field should be included in a download. | ||
width= | This is used to override the width of a column (number of pixels). The default value is the maximum width of any cell in the column. | n | Where n is a number between 0 and 999. Note: If there is no available breaking point in the data, the column will be longer than the specified number of pixels. The length of the column's label (which appears in the column's heading) may also make the width wider than specified. In the case of the zone type Info Data Explorer - Multiple SQLs (F1–DE), the system will set the width based on the column definitions in SQL 1. |
color= | This is used to override the column's text color. | A valid HTML "named" color | For example color=yellow. Note: Refer to Color Contrast for information about the use of the HTML color 'red' and its impact on accessibility. |
A valid RGB color model combination | For example color=#E0292F or color=#CCCCCC. Note that the # is required. | ||
bgcolor= | This is used to override the column's background color. | A valid HTML "named" color | Similar to the color= mnemonic. |
A valid RGB color model combination | Similar to the color= mnemonic. | ||
order= | Defines the column's default sort order. | ASC | Indicates that the order is ascending. This is the default meaning that it is not necessary to indicate order=ASC. |
DESC | Indicates that the order is descending. | ||
rowHeader= | Designates the column as a row header for accessibility purposes. | true | By default, the first data column of the data explorer results is identified as the row header, for accessibility tools. If the data in the first column does not uniquely identify the row, use this mnemonic to explicitly mark a different column or multiple columns as the row header. Note: In the case of the zone type Info Data Explorer - Multiple SQLs (F1–DE), the system will look only at the columns in SQL 1 that have this mnemonic defined and apply it to all results for those columns. |
Mnemonic | Description | Valid Values | Comments |
|---|---|---|---|
navopt= | Defines the navigation option that references the target transaction or script when the user clicks a column. Note, this mnemonic should be used in conjunction with the context= mnemonic to define what information is sent to the navigation option's target transaction. This mnemonic is ignored if source=FKREF because the FK reference code defines the hyperlink's destination. | Cx | This means navigation option code is defined in an earlier column. For example, define C1 if column 1 defines the navigation option. |
COLUMN_NAME | This means the navigation option was retrieved by the SELECT statement. The value should match the name defined in the SELECT clause. Example: navopt=MAIN_PORTAL | ||
'Navigation Option Code' | This means the navigation option code is defined directly. For example navopt='userMaint'. | ||
context= | This is used to define one or more context fields and values passed to the target navigation option to go along with the navopt= mnemonic. The syntax is as follows: [FIELD_NAME=FIELD_REF FIELD_NAME=FIELD_REF ...] In other words, the list of input values is surrounded by square brackets separated by a space. Each passed value first defines the FIELD_NAME, which is the name of the context field in the navigation option. FIELD_REF is the value passed in. The next column indicates the possible values for FIELD_REF. | Cx | Where Cx represents the value of a previous column. For example, 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. | ||
bpa= | Indicates that a BPA script should be executed with the user clicks the column and indicates the BPA to execute. Note, this mnemonic should be used in conjunction with the tempstorage= mnemonic to define the temporary storage values that will be initiated when the script is executed. This mnemonic is ignored if source=FKREF because the FK reference code defines the hyperlink's destination. | Cx | Indicates that the BPA script is defined in a previous column. |
COLUMN_NAME | This means the BPA script to execute was retrieved by the SELECT statement. The value should match the name defined in the SELECT clause. | ||
'BPA Script Code' | This means that the BPA script to execute is defined directly. | ||
tempstorage= | This is used to define how temporary storage variables are initiated when the bpa= mnemonic is used. The syntax is as follows: [FIELD_NAME=FIELD_REF FIELD_NAME=FIELD_REF ...] In other words, the list of input values is surrounded by square brackets separated by a space. Each passed value first defines the FIELD_NAME, which is the name of the field in temporary storage. FIELD_REF is the value passed in. The next column indicates the possible values for FIELD_REF. | Cx | Where Cx represents the value of a previous column. For example, 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. | ||
list= | This is used to enable work list capability for this column. You may optionally populate the listdesc= mnemonic to override the text that will be placed in the worklist zone. | true | Setting list=true will cause the work list icon to appear in the column's header. If a user clicks the column, it will populate all the rows in the output into the work list zone. Note: In the case of the zone type Info Data Explorer - Multiple SQLs (F1-DE), the output may be showing a union of the results of multiple SQL statements. In this case, if some of the SQL statements configure a given column with list=true, but not all, only the data in the cells for the statements that configure this mnemonic are put into the work list when the user clicks the icon. Also note that when determining which columns should have the worklist icon when building the zone, the system only looks at the configuration for the columns in SQL 1. |
listdesc= | This is an optional mnemonic when using the list= mnemonic. It can be used to override the text that is placed in the work list zone. | Cx | Where Cx represents the value of a previous column. For example, if the text to use is in the first column, reference C1. |
listbroadcast= | Indicates that the broadcast information for the column is also to be made available in the work list zone. This means that the work list can be used to broadcast information to a portal in the same manner as a data explorer. | true | Use this setting to turn on the feature. |
Use Case | Code Snippet |
|---|---|
Displaying the description of a lookup value that has been retrieved in the SQL statement. The business service checks for an override label. | source=BS bs='F1-GetLookupDescription' label=FLD_NAME input=[fieldName='FLD_NAME' fieldValue=FLD_NAME] output=description |
Display a foreign key with its information but suppressing the navigation. (This is useful when you have a foreign key that is additional information in a zone but would cause confusion to enable navigation. To display foreign key reference with its information and enabled for navigation, use the source of FKREF as described above.) The first example assumes that you know the FK Reference. The second example uses a business service that receives the maintenance object as input. | source=BS bs='F1-GetForeignKeyReference' input=[input/fkReference=FK_REF_CD input/fkValue1=BUS_OBJ_CD] output=output/infoDescription label=DESCR |
source=BS bs='F1-GetFKReferenceDetails' input=[input/maintenanceObject='F1-EXT LKUP' input/pkValue1=BUS_OBJ_CD input/pkValue2=C1] output=output/infoDescription label=DESCR |