Show TOC

Function documentationQuery Parameters Locate this document in the navigation structure

 

You use query parameters in a URL that you use to interact with SAP Manufacturing Integration and Intelligence (SAP MII).

Features

A parameter is a name-value pair, or a pair of values separated by an equals sign.

Example Example

You could use the following URL to query the current status of SAP MII: http://<servername>/XMII/Illuminator?Service=SystemInfo&Mode=Status. The Service parameter identifies the SAP MII service that is being called to accept and process this query. The Mode parameter sets the mode value to Status.

End of the example.

Common Query Parameters

Parameter Name

Data Type

Description

Server

String

Name of the server to use for the query.

See Data Servers.

Mode

String

Mode of the specified connector.

Modes can include:

  • Namespace query modes

    For example, tag names for a tag server and table names for a relational database.

  • Support capability for a specific server

  • Functional data retrieval modes

Method

String

Method, or additional behavior for a mode, used by the query.

RowCount

Integer

Maximum number of rows returned by the query.

Some tag connectors use it to interpolate data values over a time range.

InlineTransform

String

Fully-qualified URL for the XSLT style sheet used to process data returned by a connector before it is returned to the requester.

Param.1 - Param.32

String

Dynamic parameter values that are passed to the connector and inserted into the query string or URL.

Use these parameters instead of changing properties at runtime.

An additional field, Description is added to all parameters in query templates. In Self Service Composition Environment, when you configure the query templates, the descriptions are visible instead of names. The names are used during execution of queries.

Note Note

The Description field is available for MII 14.1 and higher version

End of the note.

XParamName.1 - XParamName.16

String

Dynamic transform parameter variable names that are passed to the style sheet and used as variables in the InlineTransform.

XParamValue.1 - XParamValue.16

String

Values for the XParamName parameters.

NumberFormat

String

Format used to output floating point values.

DateFormat

String

Format used for parsing input dates and outputting date and time values.

StartDate

String

Starting date and time for a time-based query.

EndDate

String

Ending date and time for a time-based query.

Duration

Integer

Number of time units used to calculate relative time intervals.

DurationUnits

String

Units associated with Duration.

Possible values are:

  • S for seconds

  • M for minutes

  • H for hours

  • D for days

CacheDuration

Integer

Number of time units used to cache query results.

CacheDurationUnits

String

Units associated with CacheDuration. See DurationUnits for possible values.

IsCachable

Boolean

Indicator for enabling query caching.

Time

String

Alternative for defining the start date and time for a time-based query.

For example, Today@08:00:00 and Thursday@16:15:00.

TimePeriod

String

Alternative for defining the start date and time and duration for a time-based query.

See Time Period.

Schedule

String

Alternative for defining the start date and time and duration for a time-based query.

See Time Period Schedule.

AllowFuture

Boolean

Indicator that allows future query dates.

IntervalCount

Integer

Number of time intervals used to repeatedly run a query.

Applies to Tag connectors that support Statistics mode.

Session

Boolean

If the value is true, SAP MII system will create a new session for each request