On this page you will learn how to [ Add a Data Query Object |#add_data_query_object] and Call a Data Query Object from within an Expression.  
Examples for  specific specific data query objects including DB Request, DB Request (SQL) and Run Panel are provided.

Anchor
add_data_query_object add_data_query_object

Add a Data Query Object to the Worksheet

First, choose an object in the toolbox under the Data Query Lib section.  In this example, a Code Category lookup is used.
Next, drag the object from the Data Query Lib toolbox onto your worksheet.   
Then, connect the input and output nodes you will be using.
The Data Query object can be used in mapping like any other data lookup object group.
 
BACK TO TOP

Anchor
call_data_query_object call_data_query_object

Call a Data Query Object within an Expression

Items that have default output parameters defined can be used without adding them onto the worksheet. They can be called via expressions in the format:
 dataquery_name( arg1, arg2, … )
The arguments of this expression will be delivered as input parameters to the Data Query object specified.
To call a Data Query Object within an expression, start by editing a destination expression. You can choose a library item to be called from the autocomplete dropdown:
Alternatively, you can also drag and drop a Data Query item directly into the expression:
Next, set the input parameters:
BACK TO TOP

Anchor
examples_dataquery examples_dataquery

Examples

Below are some more examples of particular types of Data Query Objects. 

Anchor
dbrequestexample dbrequestexample

DB Request

The DB Request element allows to use a DB procedure within your solution.
After dragging and dropping the DB Request element to your working area, please click "Settings" (the gear icon in the bottom-left corner) :
The following dialog window can help you to choose the appropriate DB procedure and decide whether to let IWS do auto-mapping or not.
Click "OK".
If you want to change input parameters manually, set them in the "Properties" window at the right.
You can give a Name to your DB Request element. It is used to construct the result status variable names. If the Name is not empty, the name_STATUS_CODE, name_CHANNEL_STATUS_CODE, and
name_STATUS_MESSAGE variables are created, and can be used in other expressions. See the following table for more details:

BACK TO TOP

Anchor
dbrequestsqlexample dbrequestsqlexample

DB Request (SQL)

The DB Request (SQL) element allows to use a SQL statement in the rule to interact with the database. After drag-and-dropping the DB Request element to the work area, please click "Settings":
The dialog window helps to specify additional parameters for the SQL statement:
Then enter the SQL query in the "Expression" cell:
The DB Request (SQL) element can have a Name. It is used to construct the result status variable names. If this attribute is not empty, the name_STATUS_CODE, name_CHANNEL_STATUS_CODE, and
name_STATUS_MESSAGE variables are created, and can be used in other expressions. 

The "Properties" window to the right allows to specify the parameters of the DB Request (SQL) element manually. 
BACK TO TOP

Anchor
runpanelexample runpanelexample

Run Panel

The Run Panel element allows to execute a panel and retrieve the data received from the STAR engine.
After drag-and-dropping Run Panel to the work area, click "Settings" button in the bottom-left corner to select a panel:
The following dialog window will open. You can either scroll to the required panel or use quick search:
Once the panel is chosen, click OK.  IWS will automatically fill in several fields:
You can give the Run Panel element a specific Name. The Name is used to refer to the Run Panel element and to check execution results. If this attribute is not empty, the Name_STATUS, Name_STATUS_MESSAGE, and Name_PANEL_STATUS variables are created and can be used in other expressions.

The "Properties" window to the right allows to edit several parameters of the Run Panel element manually:
BACK TO TOP