Iptor IP1 Knowledge Portal

The following input and output parameters control a long list of output (response) data. It allows us to limit the number of records per request and provide means of paginating the returned response in a sorted order.

Input fields	Description
Number of records to return	Use to limit the number of records to return.
Scan words	If more than one word is used, it will filter using AND condition.
Filter fields – Name Value Condition {EQ, GT, GE, LT, LE}.	Filter field name must be database field name. Numeric fields can not be used. This is the value to filter. If condition is not given or invalid, then EQ is assumed. Note: If more than one filter field is used it will filter using AND condition.
Sort fields – Name Order {A=ascending, D=descending}.	Sort field name must be database field name. If order is not given, then ascending is assumed.
Key returned previously From To	“keyFrom” & “keyTo” should be the range of key value that was returned from the previous request. Both “keyFrom” & “keyTo” value needs to be passed on the subsequent request if “direction” is Next or Previous. If not given then start reading data from the beginning to end.
Direction {P=Previous, N=Next, F=First, L=Last}	If not given or invalid, assume Next. If Next and “keyTo” is given then start read data forwards from “keyTo”. If Next and “keyTo” is not given then start read data forwards from the first record. If Previous, and “keyFrom” is given then start read data backwards from “keyFrom”. If Previous, and “keyFrom” is not given then start read data backwards from last record. If First, start read data from the first record. If Last, start read data backwards from the last record.

Input fields

Description

Number of records to return

Use to limit the number of records to return.

Scan words

If more than one word is used, it will filter using AND condition.

Filter fields – Name

Value

Condition {EQ, GT, GE, LT, LE}.

Filter field name must be database field name. Numeric fields can not be used.

This is the value to filter.

If condition is not given or invalid, then EQ is assumed.

Note: If more than one filter field is used it will filter using AND condition.

Sort fields – Name

Order {A=ascending, D=descending}.

Sort field name must be database field name.

If order is not given, then ascending is assumed.

Key returned previously

From

“keyFrom” & “keyTo” should be the range of key value that was returned from the previous request. Both “keyFrom” & “keyTo” value needs to be passed on the subsequent request if “direction” is Next or Previous.

If not given then start reading data from the beginning to end.

Direction {P=Previous, N=Next, F=First, L=Last}

If not given or invalid, assume Next.

If Next and “keyTo” is given then start read data forwards from “keyTo”. If Next and “keyTo” is not given then start read data forwards from the first record.

If Previous, and “keyFrom” is given then start read data backwards from “keyFrom”. If Previous, and “keyFrom” is not given then start read data backwards from last record.

If First, start read data from the first record.

If Last, start read data backwards from the last record.

Output fields	Description
Number of records returned	Actual number of records returned.
Key returned From To	First key returned Last key returned
Page info {A=All, T=Top, M=More, B=Bottom}	A = shows all records T = shows records from the top of the retrieved list M = shows records from the middle of the retrieved list B = shows records from the bottom of the retrieved list

Note

To obtain database fields for filter and sort:

Access Aperio Interface Template option from menu Other Options > Data Interfaces > Aperio > Management > Aperio Interface Management. XAW350 Work with Database Interface panel appears, listing all the database files. Use option 2=Fields against the respective database file.