Structure of a grid web service request - HxGN EAM - Version 11.07.01 - Customization & Programming - Hexagon

HxGN EAM Connector Grid Services Help

Language
English
Product
HxGN EAM
Search by Category
Customization & Programming
HxGN EAM Version
11.7.1

Element

Attrib

Description

Occurs

Lvl

FUNCTION_REQUEST_INFO

Outer element for GWS request

1

1

REQUEST_TYPE

Defines type of retrieval. Each WS can be for LOV or LIST (As defined by GRID_TYPE TYPE below) Values for each WS:

GetGridHeaderData: LIST.HEAD_DATA.STORED

LOV.HEAD_DATA.STORED

GetGridDataOnly: LIST.DATA_ONLY.STORED

LOV.DATA_ONLY.STORED

GetGridDataCache: LIST.DATA_ONLY.CACHE

1

GRID

Which grid to return. Either GRID_NAME or GRID_ID must be specified.

1

2

CACHE_REQUEST

This flag stops the mechanism to cache the grid request.

Values are true | false; default is true.

0,1

GRID_NAME

Name of the grid in the database to run

0,1

GRID_ID

Grid identifier of the grid

0,1

NUMBER_OF_ROWS_FIRST_RETURNED

Number of rows to return from the grid result. It should not be a maximum number but an optimum number that considers the xml result size (default 500).

0,1

CURSOR_POSITION

Current cursor position from which to retrieve the records. This is also used in GetGridDataOnlyCache where we can retrieve the number of rows after a certain number of rows have been retrieved. (default 1) See the note below for more information.

0,1

USER_FUNCTION_NAME

User- or System-defined screen function for presentation security. This value is required for most grids. It should normally be set to the function name of the corresponding screen.

0,1

TAB_NAME

Tab in presentation where this grid appears. Ignore this attribute.

0,1

RESULT_IN_SAXORDER

Guarantees that the results are returned in the order defined in the xml schema; default is false.

0,1

TERSERESPONSE

Abbreviates some elements in the response to reduce the size of the xml message; default is false. See example below.

0,1

LOCALIZE_RESULT

Returns results formatted for the user’s locale (default is true).

0,1

GRID_TYPE

TYPE

Type of grid as either "LIST" or "LOV". LOV grids can accept substitution parameters in LOV PARAMETER.

1

2

DATASPY

Specify which set of saved filter/fields to run for a grid. If not specified, the default Dataspy for

0,1

2

DATASPY_ID

Data spy identifier to run

1

MULTIADDON_FILTERS

Any additional filter(s) at run time

0,1

2

Each comparison condition. Is ‘and’ed to the existing where clause.

1

3

SEQNUM

The sequence in which the filter conditions are to be applied

0,1

LPAREN

This is the left parenthesis that will be appended before this filter condition

0,1

ALIAS_NAME

Field name to be used for filtering

1

OPERATOR

Operator to use. See "Table 1:

Comparison Operators" later in this chapter for values. Values can be "=", "IS EMPTY", "NOT EMPTY", "CONTAINS", "BEGINS", "ENDS", "!=", "<", ">", ">=", "=>", "=<", "<=

1

VALUE

Filter value

1

RPAREN

This is the right parenthesis that will be appended after this filter condition.

0,1

JOINER

This is the AND / OR operator used to join two filter conditions. Values are AND OR. Note that the last occurrence of this is ignored.

1

ADDON_SORT

Any add on sort other than the one specified in the Dataspy definition

0,1

ALIAS_NAME

Field name to be used for sorting

1

TYPE

"ASC" for ascending sort or "DESC" for descending sort

1

LOV

Used for GRID_TYPE LOV to substitute

0,1

2

LOV_PARAMETER

Defines parameter for List Of Values lookups

ALIAS_NAME

Field name to be used for parameter in where clause

1

TYPE

Data type of parameter. See "Table 2: Data Types" later in this chapter for values.

1

VALUE

Value of parameter

1

  • Example: if there are 10,000 records in the grid, the first request will be either GetGridDataOnly or GetGridHeaderData with no CURSOR_POSITION. The GWS will return at most NUMBER_OF_ROW S_FIRST_RETURNED, for example, 500 records. In subsequent requests of GetGridDataOnlyCache, it will retrieve the next 500 records and CURRENTCURSORPOSITION will start with 501 and increase by 500 on each call. To step though all rows, you can just set the CURSOR_POSITION in the request using the CURRENTCURSORPOSITION from the last response. For efficiency, you should use the SOAP session ID on subsequent GW S calls.

  • The system provides values for certain predefined parameters for LOV queries. They are:

    parameter.language

    Logged in

    user’s Language parameter.r5user

    Logged in user's ID

    parameter.userfunction

    User function for this query. In xml request:

    FUNCTION_REQUEST_INFO/GRID[@ USER_FUNCTION_NAME]

    parameter.gridname

    Name of the grid being called.

  • Date values may also be relative by entering "+- <number>", i.e., last week would be >= "-7"