Drill
The action which allows interacting with LSF Drill functions.
Drill is the formal action name. This name is appended to the action framework root path: "/lawson-ios/action/".
Parameter map for Drill Types
The table below shows the supported parameters of the individual drill types:
Parameter Key | Supported parameters | Description |
---|---|---|
productLine | SELECT | Required |
FIELD-EXIT | Required | |
FUNCTION | Required | |
KNVIEW | Required | |
DETAIL | Required | |
NUMERIC | Required | |
OBJSELECT | Required | |
OBJVIEW | Required | |
OBJWIN | Required | |
COMMENT | Required | |
URL | Required | |
_LOCALE | SELECT | Optional |
FIELD-EXIT | Optional | |
FUNCTION | Optional | |
KNVIEW | Optional | |
DETAIL | Optional | |
NUMERIC | Optional | |
OBJSELECT | Optional | |
OBJVIEW | Optional | |
OBJWIN | Optional | |
COMMENT | Optional | |
URL | Optional | |
drillType | SELECT | Required |
FIELD-EXIT | Required | |
FUNCTION | Required | |
KNVIEW | Required | |
DETAIL | Required | |
NUMERIC | Required | |
OBJSELECT | Required | |
OBJVIEW | Required | |
OBJWIN | Required | |
COMMENT | Required | |
URL | Required | |
ruleId | KNVIEW | Required |
OBJVIEW | Required | |
OBJEWIN | Required | |
systemCode | SELECT | Required |
FIELD-EXIT | Required | |
KNVIEW | Required | |
DETAIL | Required | |
OBJSELECT | Optional | |
OBJVIEW | Optional | |
OBJWIN | Optional | |
COMMENT | Optional | |
URL | Optional | |
keyNbr | SELECT | Required |
FIELD-EXIT | Required | |
DETAIL | Optional | |
COMMENT | Optional | |
URL | Optional | |
token | SELECT | Optional |
FIELD-EXIT | Optional | |
KNVIEW | Optional | |
DETAIL | Optional | |
findFld | SELECT | Optional |
FIELD-EXIT | Optional | |
KNVIEW | Optional | |
DETAIL | Optional | |
OBJVIEW | Optional | |
OBJWIN | Optional | |
screenKeyNbr | DETAIL | Optional |
COMMENT | Optional | |
URL | Optional | |
lineKeyNbr | DETAIL | Optional |
COMMENT | Optional | |
URL | Optional | |
indexName | OBJSELECT | Required |
OBJVIEW | Optional | |
OBJWIN | Optional | |
section | Optional | Optional |
fileName | OBJSELECT | Optional |
keyUsage | SELECT | Optional |
FIELD-EXIT | Optional | |
FUNCTION | Optional | |
KNVIEW | Optional | |
DETAIL | Optional | |
NUMERIC | Optional | |
OBJSELECT | Optional | |
OBJVIEW | Optional | |
OBJWIN | Optional | |
COMMENT | Optional | |
URL | Optional | |
startKey | SELECT | Optional |
KNVIEW | Optional | |
DETAIL | Optional | |
NUMERIC | Optional | |
OBJSELECT | Optional | |
OBJVIEW | Optional | |
OBJWIN | Optional | |
COMMENT | Optional | |
URL | Optional | |
maxRecords | SELECT | Optional |
lastUsed | SELECT | Optional |
Parameter value limits and defaults
The table below shows the value limits for the parameters, and default values, if available:
Parameter value | Value Type | Parameter Description |
---|---|---|
productLine | Alphanumeric string | The product line where the drill call is made. |
_LOCALE | Alphanumeric string | The LSF locale set for the user. |
drillType | Alphanumeric string |
The type of drill call. Can only contain the following fixed values: SL, RL, FN, KV, DT, N, OS, OV, OW, CMT, URL |
ruleId | Alphanumeric string | The rule ID of the drill being done. |
systemCode | Alphanumeric string | The system code of the form. |
keyNbr | Alphanumeric string | The key number of the field. Equivalent of _KNB in Drill requests to the Drill service. |
token | Alphanumeric string | The token of the form. |
findFld | Alphanumeric string | The condition used to filter the drill results (i.e. COMPANY = '1000'). |
screenKeyNbr | Alphanumeric string | The screen key number. Equivalent of parameter _SKN in Drill requests to the Drill service. |
lineKeyNbr | Alphanumeric string | The line key number. Equivalent of parameter _LKN in Drill requests to the Drill service. |
indexName | Alphanumeric string | The index name of the table to be drilled. |
section | Alphanumeric string |
Fixed values are VIEW, DATA, TRAD. Adding any of the keywords VIEW, DATA, TRAD to this parameter will return specific information about the object window (for OBJWIN drills only) |
fileName | Alphanumeric string | The name of the table to be drilled. |
keyUsage | Alphanumeric string |
Fixed value is PARAM. If set to PARAM, it will return key values in this format: "SK1=...&SK2=..." in the response. |
startKey | Alphanumeric string | The initial key values to be used for the drill call. |
maxRecords | Integer | The maximum amount of records to be returned in the drill call. |
lastUsed | Boolean |
Fixed values are TRUE and FALSE. The default value is TRUE. If set to TRUE, activates the LastDrillRule feature, which saves and displays the last drill done by the user on that field. |
URL request format
Format of the request for GET method calls.
http://phlsfrel10.ird.infor.com:10100/lawson-ios/action/Drill?drillType=SL&productLine=APPS10&systemCode=IF&keyNbr=98&ruleID=PO-PLI-S-0002&keyUsage=PARAM&token=CU01.1&maxrecords=25