7.119.1 SRVROUTINE Parameters

DESC

HELP

NAME

RESPONSE

SESSION

NAME

NAME is the unique name of the SRVROUTINE.  The name must be unique within the Server Module. The name can be up to 20 characters long.

For simplicity, it is recommended that you use only the characters 0-9 and Aa-Zz

DESC

Use the DESC parameter to write a brief description for the SRVROUTINE. It can be 40 characters long. By default, this description will be displayed in the Feature Help (F2) for the routine.

RESPONSE

Use the RESPONSE parameter to specify how the SRVROUTINE returns its output.

Response type can be:

*DATA: The output is returned as JSON and automatically mapped in to field and list variables

*WEBPAGE: A secondary Web Page is executed. Maps defined as *Output or *Both are passed in to the page.

Response variable name: Enter the name of the variable for a LOB response. This will produce an instance of a Response Variable (Prim_CLRC) that can be configured to manipulate a returned LOB.

HELP

256 byte string used to document the routine.

SESSION

The Session parameter is used to define the session requirements for the routine.

*None: By default, no session is required and the routine will execute when called.

*Required: The routine will not execute if there is no valid session available. The Failed event will fire in the calling component and the Reason parameter will contain the value SessionInvalid.