7 91 1 SUBMIT Parameters

LANSA Technical

7.91.1 SUBMIT Parameters

EXCHANGE

FUNCTION

JOB

JOBD

JOBQ

OUTQ

PARM

PGM

PROCESS

PGM

Specifies the name of the program which is to be invoked in batch. This parameter is a qualified name. Either a program name or a process name (but not both) must be specified on this command. If required the library in which the program resides can also be specified. If no library name is specified, library *LIBL is assumed which indicates the execution time library list of the batch job should be searched to find the program.

Portability Considerations

 

The submit of 3GL programs is only supported on IBM i for compatability with existing RDML Code. As such, only RDML fields are supported in the PARM parameter that may be used for the submit of 3GL programs.

Not supported in the current version of Visual LANSA but will be supported in a future release. A build warning will be generated if used and an error will occur at execution time. Code using this facility can be made conditional so that it is not executed in this environment.

PROCESS

Specifies the name of the LANSA process or Form that is to be invoked. Either the PGM parameter or the PROCESS parameter (but not both) must be specified.

Portability Considerations

 

A Form can only be executed on Windows.

 

FUNCTION

Optionally specifies the function within the nominated process that should be invoked in batch. If this parameter is not specified a default value of *FIRST is assumed that indicates that the first function (alphabetically) associated with the nominated process should be invoked.

When a Form is specified for the PROCESS parameter, this value must be *FORM.

 

PARM

Is optional, and if specified defines a list of parameters which are to be passed to the batch program or process. The parameters must correspond in number and type to those expected by the program or process. This is not checked by LANSA.

Parameters specified may be alphanumeric or numeric literals, field names, an expandable group expression, system variables or process parameters. They are passed to the called program or process with the same type and length attributes as they are defined within LANSA.

When passing numeric parameters to a process they must always be in packed decimal format. This rule does not necessarily apply to user application programs written in other languages such as RPG or COBOL.

The passing of parameters to a process is not recommended. Use the exchange list instead as a more flexible means of passing information to the batch process. Refer to the EXCHANGE parameter of this command and to the EXCHANGE command in this guide for more details of the exchange list and exchange list processing.

Portability Considerations

Not supported in the current release of Visual LANSA and not expected to be in future releases.

EXCHANGE

Optionally specifies the name of the field(s) whose value(s) are to be exchanged, or the name of a group that defines the field(s) whose value(s) are to be exchanged, with the batch function.

For details of how field and group names can be specified in this parameter, refer to Field Groups and Expandable Groups. For more details of how information is exchanged between functions, refer to the EXCHANGE command.

Use of the EXCHANGE parameter is only valid when submitting a process/function/form to batch. The parameter is ignored when submitting a program to batch.

The EXCHANGE parameter on this command is provided for convenience only. Using it is identical to using one or more EXCHANGE commands before the SUBMIT command. Thus:

SUBMIT   PROCESS(PROC01) FUNCTION(FUN1) EXCHANGE(#A #B #C #D)

is functionally identical to:

EXCHANGE  FIELDS(#A #B #C #D)
SUBMIT    PROCESS(PROC01) FUNCTION(FUN1)
 

which is functionally identical to:

EXCHANGE  FIELDS(#A)
EXCHANGE  FIELDS(#B)
EXCHANGE  FIELDS(#C)
EXCHANGE  FIELDS(#D)
SUBMIT    PROCESS(PROC01) FUNCTION(FUN1)
 

Note that the exchange list is cleared of all entries after the SUBMIT command has completed execution.

JOB

Optionally specifies the name that is to be assigned to the batch job when it is submitted. The name specified must conform to IBM i naming conventions. Refer to the LANSA Application Design Guide for LANSA's naming conventions.

If this parameter is not specified, default value *PGMPRO is assumed. This indicates that the job submitted should have the same name as either the program specified in the PGM parameter or the process/form specified in the PROCESS parameter (which ever is used).

JOBD

Specifies the name (and optionally library) of the job description that is to be used to submit the job to batch.

To submit a job on the IBM i a job description is always required. The details of what a job description is and how it is used are beyond the scope of this guide. Refer to the appropriate IBM supplied manual for more details of job descriptions.

This parameter is a qualified name. Specify the name of the job description that is to be used. If required the library in which the job description resides can also be specified. If no library name is specified, library *LIBL is assumed which indicates the execution time library list of this job (ie: the job executing the SUBMIT command) should be searched to locate the job description.

If this parameter is not specified, default value QBATCH.*LIBL is assumed. This indicates that the library list of this job should be searched to locate a job description named QBATCH.

Special value *USRPRF indicates that the job description associated with the user profile under whose name the submitted job is to execute should be used. Normally submitted jobs execute under the user profile of the person who submitted the job.

Portability Considerations

Refer to IBM i Job Queue Emulation .

JOBQ

Specifies the name (and optionally library) of the job queue onto which the batch job should be placed.

All batch jobs submitted on the IBM i must be placed onto a job queue. The details of what a job queue is and how it is used are beyond the scope of this guide. Refer to the appropriate IBM supplied manual for more details of job queues.

This parameter is a qualified name. Specify the name of the job queue that is to be used. If required the library in which the job queue resides can also be specified. If no library name is specified, library *LIBL is assumed which indicates the execution time library list of this job (ie: the job executing the SUBMIT command) should be searched to locate the job queue.

If this parameter is not specified, default value *JOBD is assumed. This indicates that the job queue associated with the job description specified in the JOBD parameter should be used.

Portability Considerations

Refer to IBM i Job Queue Emulation .

OUTQ

Specifies the name (and optionally library) of the output queue onto which the batch job's output should be placed.

All batch jobs submitted on the IBM i must have an associated output queue. The details of what an output queue is and how it is used are beyond the scope of this guide. Refer to the appropriate IBM supplied manual for more details of output queues.

This parameter is a qualified name. Specify the name of the output queue that is to be used. If required the library in which the output queue resides can also be specified. If no library name is specified, library *LIBL is assumed which indicates the execution time library list of this job (ie: the job executing the SUBMIT command) should be searched to locate the output queue.

If this parameter is not specified, default value *JOBD is assumed. This indicates that the output queue associated with the job description specified in the JOBD parameter should be used.

Refer to the appropriate IBM supplied manual for more details of how the special parameter values *CURRENT, *USRPRF and *DEV can be used.

Portability Considerations

Refer to the SET_SESSION_VALUE Built-In Function.