Easy Query API

The following section explains the result of the easy query:

Import

If the query contains variables, an import structure of type RSEQ_S_SELECT_OPTION (SIGN, OPTION, LOW, HIGH ) is created for every variable.

Example Example

The query has a mandatory variable for the 'country' characteristic. This characteristic is restricted to the value country = Germany.

SIGN = ‘I’

OPTION = ‘EQ’

LOW = ‘DE’

HIGH =’’

End of the example.

Export

The easy query prepares the data so that it can be displayed by different tools for specific applications. The easy query does this by returning the following tables as a result (see Example: Easy Query API):

Value Table: E_T_GRID_DATA

Table E_T_GRID_DATA contains the values. Every key figure appears twice in this table: an unformatted key figure for use in diagrams, and a key figure as a text string formatted according to the local user settings.

Column Descriptions in the E_T_COLUMN_DESCRIPTION Table

This section deals is information with the columns in the result set with language-dependent names.

Column header	Description
COLUMN_NAME	Technical name of the column
COLUMN_Type	Column type; possible values: C = Characteristic A = Attribute K = Key Figure
COLUMN_DESCRIPTION	Column description (in logon language)

Row Description in the E_T_Row_Description Table

This is additional information about the result values in table E_T_GRID_DATA.

Column header	Description
ROW_ID	Row number
COLUMN_ID	Column number
VALUE_TYPE	Value type, for example: T = (total/subtotal E = expanded hierarchy node C = collapsed hierarchy node L = leaf element within the hierarchy
PARENT_ROW_ID	Rows number of parent (only for hierarchies)
HIER_LEVEL	Number of hierarchy level for this element

Message Table: E_T_Message_Log

This relates to messages.

Return Value

Return value

Description

E_S_QUERY_PROPERTIES

Metadata of query: InfoProvider, query name, created on, created or changed by (user), changed on (date)

E_QUERY_OUTDATED_OR_INVALID

Flag that indicates whether the query is obsolete or invalid.

If the query is changed, and an easy query already exists, the easy query must be generated again to ensure that the current data is displayed. If the easy query is not generated again, the system sets the E_QUERY_OUTDATED_OR_INVALID=X flag, and the easy query does not display any data.