8.24.1 WEBROUTINE Parameters
NAME is the unique name of the WebRoutine. The name must be unique in the WAM. The name can be up to 20 characters long.
Use the DESC parameter to write a brief description for the WebRoutine. It can be 40 characters long. By default, this description will be displayed on the output page.
Use the RESPONSE parameter to indicate a response type other than the default, which is to send a result document.
Response type can be:
*DEFAULT: Send a result document (for example, an XHTML page)
*NONE: The webroutine produces no output
*JSON: The webroutine's web maps (fields and lists) is sent as a JSON response with MIME type application/json and encoded in UTF-8.
Response variable name: Enter the name of the variable for a LOB response. See LOB Data Types and Stream Files in the Web Application Module (WAM) Guide for details.
Only valid for RESPONSE(*JSON). Use the OPTIONS parameter to indicate whether the JSON response should include captions.
*METADATA: Include field/list captions in JSON response.
Not implemented.
A Service Name is unique to all WAMs, i.e. a Service Name can only be used once in a LANSA Partition. Once deployed, the WEBROUTINE may be invoked from the browser by providing just the Service Name and Partition keyword in the URL (without the additional keywords). A Partition keyword may be omitted if LANSA for the Web has been setup to always run in a configured partition.
Using a Service Name provides greater flexibility when deploying WAM applications. For example, it allows applications to be re-deployed to a different Partition, WAM or WEBROUTINE without having to modify any external URL references to it.
Is used to override the SessionStatus property setting for individual WEBROUTINEs.
This is useful when the default SessionStatus is Active, which prevents execution of WEBROUTINEs in the WAM unless a session is created. In this situation, you need at least one WEBROUTINE that can be executed initially so that a session can be created. ONENTRY Parameter value of *SESSIONSTATUS_NONE can be used to turn off session validation and session data loading for that WEBROUTINE
Can be one of:
*SESSIONSTATUS_NONE does not validate the session and will not load any session data when the WEBROUTINE is entered.
*SESSIONSTATUS_OF_WAM uses the value specified by WAM SessionStatus property.
*SESSIONSTATUS_ACTIVE enables validation of session and will load session data, if the session is valid, when the WEBROUTINE is entered.
The default value is *SESSIONSTATUS_OF_WAM.