Global Data Service request parameters

Field Description
PROD

Required. The data area or product line name.

The default value is the user’s ProductLine attribute in the Lawson Resource Management repository.

Note: If the product line or data area is set in the Resource Management system for the user making the query, this parameter does not have to be included in the query.
FILE Required. The file name.
FIELD

The fields to be displayed, separated by a semicolon.

ALL specifies every field in the file. If no fields are specified, this parameter defaults to first 10 fields in the file, or all the fields, whichever is less.

These values could be appended to the end of a field name:

  • ,xlt

    Displays the translation value, if one exists.

    For example,

    FIELD=COMPANY;STATUS,xlt

  • ,cnt

    Displays the One-To-Many (OTM) record counts, if the relation exists.

  • ,tot

    Returns the total of this field for all related records, for an OTM field.

  • ,nofmt

    Indicates field data is to be returned unformatted.

    For example, for a date field, data would be returned as stored in the database, usually yyyymmdd.

MAX

The maximum number of records to return. Queries with a large MAX value can result in errors.

For XML, the default is 25 records. For CSV, it depends on the value specified in iosconfig.xml, by default, the value is 10,000.

INDEX

The name of the index to use for sorting.

The default is the primary index.

KEY

The key fields to be used. The keys correspond to the fields in the index being used. Keys can be:

  • A single value that corresponds to the first field in the index:

    KEY=1

  • Multiple keys in an index separated by an equals (=) sign. In this case, the first key value corresponds to the first index field, the second key value to the second index field, and so on:

    KEY=001=00144

  • A list of values separated by a semicolon:

    KEY=1;3

  • A range specified as val1->val2:

    KEY=10->20

  • These can be combined, as in:

    KEY=1=3->7=a;b;c;d

Using the key above would return all records where the value of the first field of the index was 1, the value of the second field of the index was between 3 and 7 (inclusive), and the value of the third index field was a, b, c, or d.

If the key value contains spaces, substitute a plus sign (+) for each space.

For a key value of all spaces, use the word spaces.

BEGIN

Specify the beginning record keys.

Usage is similar to that of the KEY parameter, though here only the single and multiple forms are allowed.

If BEGIN is specified, by default the record matching those keys and subsequent records are returned. This behavior can be overridden with the PREV and INCPREV parameters:

  • PREV

    Using PREV with BEGIN returns data records previous to those that match the beginning key. PREV does not take a value; its inclusion in the query string is sufficient.

  • INCPREV

    Using INCPREV with BEGIN returns data records previous to and including those that match the beginning key. INCPREV does not take a value; its inclusion in the query string is sufficient.

SELECT

Specify a selection expression used as criteria for retrieving records. This parameter functions similar to a SQL WHERE clause.

The SELECT expression can use the AND (&) and OR (|) conjunctions, as well as parentheses to establish precedence.

The SELECT expression also takes some punctuation characters to further filter the data that is returned from the call. For a detailed description of these parameters, see Filter data with the SELECT parameter.

SORTASC The list of field names, separated by semicolons, to sort in ascending order. Performance considerations when sorting data
SORTDESC The list of field names, separated by semicolons, to sort in descending order. Performance considerations when sorting data
COND Names of database conditions to use when selecting data, separated by a semi-colon.

The MAX parameter works in relation to the value defined in com.lawson.ios.dig.db.maxRecsQuery in iosconfig.xml. Consider these scenarios when including MAX in the call:

  • If com.lawson.ios.dig.db.maxRecsQuery is not configured and if MAX was not included in the call, CSV calls have a default MAX of 10,000.

    For example, if number of records returned is more than 10,000, and NEXT=TRUE was not included on the call, it throws NEXT_REQUIRED. If number of records returned is more than 10,000, and NEXT=TRUE was included on the call, it proceeds with call to next record.

  • If com.lawson.ios.dig.db.maxRecsQuery is not configured and if MAX was included in the call, MAX should never be greater than 10,000. If MAX is greater than 10,000 and number of records returned is more than 10,000, it throws MAX_EXCEEDED. Otherwise, it proceeds with normal operation.

  • If com.lawson.ios.dig.db.maxRecsQuery is configured and if MAX was not included in the call, CSV calls have a default MAX of com.lawson.ios.dig.db.maxRecsQuery. MAX should never be greater than com.lawson.ios.dig.db.maxRecsQuery.

    In this example, com.lawson.ios.dig.db.maxRecsQuery is set to 8,888.

    If number of records returned is more than 8,888, and NEXT=TRUE was not included in the call, it throws NEXT_REQUIRED. If number of records returned is more than 8,888, and NEXT=TRUE was included on the call, it proceeds to call the next record.

  • If com.lawson.ios.dig.db.maxRecsQuery is configured and if MAX was included in the call, MAX should never be greater than com.lawson.ios.dig.db.maxRecsQuery.

    In this example, com.lawson.ios.dig.db.maxRecsQuery is set to 8,888.

    If MAX is greater than 8,888 and number of records returned is more than 8,888, it throws MAX_EXCEEDED. Otherwise, it proceeds with normal operation.