Data Requester Activity

The Data Requester activity allows an application to submit one or more SQL statements, stored procedures, and functions to be processed. The plug-in processes the request and returns the results as a reply.

General

The General tab contains the following fields:

Data Requester Activity: General Tab: Request Reply Mode

Data Requester Activity: General Tab: RPC Mode

Data Requester Activity: General Tab: RPC Mode with Custom Operations

The RPC custom operations schema is used when you want to integrate with third-party applications to describe the actual input and output values of a database operation or a stored procedure. You can use the RPC custom operation mode to define your operations and specify the stored procedures to be run at design time.

Field Literal Value/Process Property/Module Property? Description
Name No The name to be displayed as the label for the activity in the process.

See Entity Naming Conventions.

Configuration Resource Yes Shared configuration resource containing information about the ADB Configuration connection.
Schema No The DBRequester schema which is configured with Request Reply mode or Remote Procedure Call (RPC) mode.

The Request Reply mode takes a sequence of statements as a request and sends the reply back to the reply subject.

The RPC mode is used to configure the plug-in to act as a remote procedure call server on behalf of a client.

Note: Same procedure name cannot be used within and across schemas.
Operation No Type of RPC operation.
  • RPC Standard operation
    • SQL_EXECUTE - A single SQL statement is processed.
    • SQL_BATCHEXECUTE - A sequence of SQL statements is processed.
  • RPC Custom operation

    If you have configured custom operations and stored procedures in the ADB Configuration resource, a list of those stored procedures is displayed. You can select any one of them.

Description

Provide a short description for the activity.

Advanced

This tab has the following fields:

Data Requester Activity: Advanced Tab
Field Literal Value/Process Property/Module Property? Description
Operation Options
Timeout (sec) Yes Select the timeout period to be used.

Default: 180 seconds

Maximum Rows Yes Specifies the maximum number of rows to be fetched. This can be used to limit the memory usage of the plug-in. The unfetched rows are ignored by the plug-in.

At run time, the plug-in fetches the number of rows according to the value set in the operation level instead of the service level.

Statement Cache Yes The number of cache statements for a generic RPC request/reply service.

The size of the cache depends on the number of unique statements provided as input.

Date And Time Pattern Options
Date Yes Enter the date in the yyyy-MM-dd format.
Time Yes Enter the time in the HH:mm:ss format.
Timestamp Yes

Enter the timestamp in the yyyy-MM-dd HH:mm:ss.S format, where S is milliseconds.

Input

This tab displays the input schema.

Data Requester Activity: Input Tab with Request Reply Mode
Data Requester Activity: Input Tab with RPC Mode (Operation: SQL_EXECUTE)

To execute multiple SQL statements, you must provide the input as multiple item elements for statements with their individual SQL string as can be seen in the following image:

Data Requester Activity: Input Tab with RPC Mode (Operation: SQL_BATCHEXECUTE)

Input Schema Description

Fields for the Request Reply mode:
Field Description
MAXROWS The maximum number of rows to retrieve.
SQL_STRING The SQL string used to specify the SQL statement to be executed.
CLOSURE Closure argument. The reply returns this closure argument untouched.
POSITION Specify the index of the input parameter to bind the input data.
NAME
  • Specify the column name from the database table if binding either of the following data types: DATE, TIME, TIMESTAMP, BINARY, and BLOB.
  • Specify the column name from the database table if you are using the BIND variable to pass parameters to the SELECT statement for Sybase database.
PARAMTYPE Specify if the parameter is the INPUT parameter or OUTPUT. Use IN/OUT.
DATA Specify the input data to bind to the input parameter in the SQL String.
Data Requester Activity: Input Tab with RPC Mode (Operation: Custom Operation)
Fields for the RPC mode:
Field Description
MAXROWS The maximum number of rows to retrieve.
SQL The SQL string used to specify the SQL statement to be executed. This string is automatically generated by the palette.
CACHE True if users want the agent to cache the statement for performance optimization.
PACKAGE Read only. Uses the call operation form to modify the package of the stored procedure.
SCHEMA Read only. Uses the call operation form to modify the schema of the stored procedure.
INBINDS Input parameters of the stored procedure.

This tab displays the output schema.

Data Requester Activity: Output Tab

Data Requester Activity: Output Tab with Request Reply Mode

Data Requester Activity: Output Tab with RPC Mode (Operation: SQL_EXECUTE)

Data Requester Activity: Output Tab with RPC Mode (Operation: SQL_BATCHEXECUTE)

Data Requester Activity: Output Tab with RPC Mode (Operation: Custom Operation)

For more information about how different data types are mapped to the XSD type, see Output Mapping.

Field Description
STATUS SUCCESS if the stored procedure or SQL statement is executed successfully.

FAILURE if an error occurs. Error details are stored in the ERROR_DESC field.

SQL The SQL string used to specify the SQL statement to be executed.
ERROR_DESC In case if the status is FAILURE, error description is stored here.
CLOSURE Closure argument obtained from the request.
OUTBINDS The output parameters of the stored procedure.
RESULTSETS The result set(s) returned by the stored procedure or SQL statement.

Fault

Data Requester Activity: Fault Tab

The Fault tab lists exceptions that are thrown by this activity:

Error Schema Element Data Type Description
ADBSQLException String

It has a msg and msgCode field for the exception.

ADBValidationException String

It has a msg and msgCode field for the exception.

msg String The error message returned by the plug-in.
msgCode String The error code returned by the plug-in.