Page History
9.23 COMPOSER_RUN
| Note |
|---|
| Note: Built-In Function Rules Usage Options |
COMPOSER_RUN runs a LANSA Composer Processing Sequence, in the LANSA Composer system identified by the server symbolic name argument, through the LANSA Composer Request Server. It can pass up to five named parameter values to the processing sequence.
| Info |
|---|
COMPOSER_RUN assumes that the target system (the system identified by the LANSA Composer server symbolic name argument) is a LANSA Composer system greater than Version 3, and contains the LANSA Composer Request Server software. This Built-In Function will fail if this is not the case. |
You must execute the 9.24 COMPOSER_USE Built-In Function to define the server connection details and a symbolic name representing them before executing this Built-In Function.
...
For further information, also refer to the COMPOSER_RUN activity and Appendix F - The LANSA Composer Request Server, in the LANSA Composer Guide.
Arguments
No | Type | Req/ Opt | Description | Min Len | Max Len | Min Dec | Max Dec |
|---|---|---|---|---|---|---|---|
1 | A | Req | LANSA Composer server symbolic name. The symbolic name is used to identify the connection details for the required LANSA Composer server system. The name must have previously been specified in the COMPOSER_USE Built-In Function in the current session. | 1 | 10 | ||
2 | A | Req | Processing Sequence identifier Identifies the LANSA Composer processing sequence to run. Specify either the external identifier (name) or the internal identifier. | 1 | 32 | ||
3 | A | Opt | Parameter name 1 (see below). | 1 | 20 | ||
4 | A | Opt | Parameter value 1 (see below). | 1 | 200 | ||
5 | A | Opt | Parameter name 2 (see below). | 1 | 20 | ||
6 | A | Opt | Parameter value 2 (see below). | 1 | 200 | ||
7 | A | Opt | Parameter name 3 (see below). | 1 | 20 | ||
8 | A | Opt | Parameter value 3 (see below). | 1 | 200 | ||
9 | A | Opt | Parameter name 4 (see below). | 1 | 20 | ||
10 | A | Opt | Parameter value 4 (see below). | 1 | 200 | ||
11 | A | Opt | Parameter name 5 (see below). | 1 | 20 | ||
12 | A | Opt | Parameter value 5 (see below). | 1 | 200 | ||
13 | A | Opt | Synchronous call? Specifies whether the Built-In Function waits for the processing sequence to complete. Defaults is 'Y', to wait. | 1 | 1 | ||
14 | N | Opt | Synchronous timeout (seconds). The number of seconds the Built-In Function waits for a synchronous processing sequence run to complete. If the timeout is exceeded, the Built-In Function ends with a result code of 'TM'. Default is 30 seconds. | 1 | 5 | 0 | 0 |
15 | N | Opt | Request expires (seconds). IBM i servers only. Expiry does not apply to Winders servers. The number of seconds the request remains effective after it is posted to the request server. If more than the specified interval has elapsed before the request server begins to process the request, the request server will consider that the request has expired and will not process it. Default is zero (0). This means that no expiry applies to the request. | 1 | 5 | 0 | 0 |
Return Values
No | Type | Req/ Opt | Description | Min Len | Max Len | Min Dec | Max Dec |
|---|---|---|---|---|---|---|---|
1 | A | Opt | Result code. OK, if the Built-In Function completes successfully. | 2 | 2 |
Examples
This example uses a previously defined connection to a LANSA Composer system, with the symbolic name COMPOSER (see COMPOSER_USE), to call the processing sequence 'EXAMPLE_AATEST1'.
...