MVX GETDATA

MVX GETDATA

CHANNEL(channelName)

REFRESH

[FORM(formName)]

[START(nnnnnn)]

[COUNT(nnnnnn)]

[STEM(variableName)]

[WHERE(whereClause)]

[QWHERE(qwhereClause)]

CHANNEL

Specifies the name of a local variable that receives the identification token for the connection

1 to 32 alphanumeric characters

This value is the token returned in the CHANNEL variable that is returned by the IMFEXEC MVX CONNECT command.

REFRESH

Required parameter on first request of data from a view in a given channel

In addition, the following conditions also apply:

• Always specify REFRESH on the first call to a particular channel.
• When you use the COUNT keyword and the number of rows in the result set exceeds COUNT, do not specify REFRESH on subsequent GETDATA commands. When you receive a return code of 0, all of the available rows have been retrieved.
• When you want to obtain a new result set, specify REFRESH.

START

Specifies the starting row number of the desired data

Valid values are 1 through 999999.

If the keyword is not specified, the data that is retrieved starts at row 1; the data continues incrementing until you reset it by including the REFRESH keyword or by specifying a new START() value.

COUNT

Specifies the number of rows of data to retrieve

Valid values are 1 through 65500.

If you do not specify a value, the default is 500. See the explanation for return code 4 for retrieving more rows of data.

STEM

Specifies the name of the REXX stem variable to hold the returned data

Valid values are up to 31 alphanumeric characters. If you do not specify a value, the default is MV.

The STEM() value can be specified with or without the trailing dot (.)

For more information about how this keyword's value is used, see Stem-variables-returned-by-IMFEXEC-MVX-GETDATA.

If only one set of data is retrieved and used at a time, you do not need to adjust this value. However, if multiple sets of data from different views need to be referenced simultaneously, use this keyword to uniquely name each set of returned data.

WHERE

Specifies a filter clause

Specifying this keyword adds additional filters to the data returned by the specified QWHERE (or the default QWHERE for the view) before the data is returned to the API.

Using the WHERE keyword also allows multiple filters to be applied against a query set without adding additional overhead in re-issuing the query, and without refreshing the data that is already stored in memory.

QWHERE

Queries the filter clause

FORM

Specifies the name of an alternate form to use when formatting the data

If this keyword is not specified, the default is the value that is specified on the MVX VIEW FORM(formName) command. If no value is specified on MVX VIEW FORM(formName), the value BASE is used.

To override the FORM specified on the MVX VIEW command, specify the name of the desired FORM, or specify BASE to use the base form of the view.