ENTER-PROCEDURE

File 217
Op-Sys BS2000
Task Enter procedure

Common Fields for all Operating Systems

Dictionary Field Name F/L Mu DE Remarks
ERROR-CODE N3      
ERROR-TEXT A58      
NODE N5   D  
NODE-NAME A16   D  
SYSTEM-MESSAGE-CODE A10      
SYSTEM-CODE B2      
IDENTIFIER A8   D Required if multiple update views are executing in parallel.
FUNCTION A8   D Required on last request.
CARD A80   D Required if no DSNAME/ELEMENT is given.
DSNAME A54   D Required if no CARD is given.
ELEMENT A64   D  
PASSWORD A8   D  
JOB-NAME A8   D  
USERID A8   D  
ACCOUNT-NUMBER A8   D  
TIME A5   D  
MONITOR-JOB-VARIABLE A54   D  
JOB-VARIABLE-PASSWORD A4   D  
USER-PASSWORD A8   D  
JOB-CLASS A8   D  
JOB-PRIORITY A3   D  
RUN-PRIORITY A3   D  
START-OPTION A17   D  
START-DATE A8   D  
START-TIME A5   D  
REPEAT-OPTION A17   D  
REPEAT-TIME A5   D  
ELEMENT-PASSWORD A8   D  
PARAMETER-SET-1 A253   D  
PARAMETER-SET-2 A253   D  
COMMAND-RESPONSE A253      
START-DATX D      
START-TIMX T      
JOB-ID A5      

Relevant Error Codes

Code Text BS2000
506 Data set is migrated. X
530 Access denied by Security facility. X
556 File is in use. X
701 DSNAME missing. X
733 User ID does not exist. X
749 PVS (CATID) not available. X
798 Task was not started under TSOS. X
799 Entire System Server internal error. X
856 Operator unable to mount volume. X
883 Dataset is full. X
889 Permanent I/O error while writing dataset. X
903 Dynamic allocation failed for temporary dataset. X
909 Syntax error in JCL command. X
991 Unknown product. X
998 Member not found. X

Field Descriptions

Which fields are relevant with which statement depends on the FUNCTION specified (see the description of the FUNCTION field, below).

Field Name Format/Length Operating System
ACCOUNT-NUMBER (A8) BS2000

Account number for the job.

Field Name Format/Length Operating System
CARD (A80) BS2000

Procedure record to be sent from Natural to the temporary file.

Field Name Format/Length Operating System
COMMAND-RESPONSE (A253) BS2000

ENTER-PROCEDURE command response.

Field Name Format/Length Operating System
DSNAME (A54) BS2000

Name of the list to be entered.

Note:
FUNCTION=CLOSE is required to enter the procedure.

Field Name Format/Length Operating System
ELEMENT (A64) BS2000

Name of the LMS element to be entered.

Field Name Format/Length Operating System
ELEMENT-PASSWORD (A8) BS2000

Password for protected LMS element.

Field Name Format/Length Operating System
FUNCTION (A8) BS2000

Function to be performed. Possible options:

Blank Pass a JCL card or the name of the dataset or element to be submitted to the Entire System Server.
CLOSE All cards have been submitted. Specify this on the last request.
Field Name Format/Length Operating System
JOB-CLASS (A8) BS2000

Name of the job class where the job is to run.

Field Name Format/Length Operating System
JOB-ID (A5) BS2000

This field is returned after a call with FUNCTIONS=CLOSE.

Field Name Format/Length Operating System
JOB-NAME (A8) BS2000

Name of the job to be entered.

Field Name Format/Length Operating System
JOB-PRIORITY (A3)  

Scheduling priority for job. Possible values are between 9 and the maximum of the job class, or STD. STD is the default.

Field Name Format/Length Operating System
JOB-VARIABLE-PASSWORD (A4) BS2000

Password for protected monitoring job variable.

Field Name Format/Length Operating System
MONITOR-JOB-VARIABLE (A54) BS2000

Specifies the name of a monitoring job variable that always contains the job status. For an explanation, see the description of the MONITOR-JOB-VARIABLE parameter of the view SUBMIT.

Field Name Format/Length Operating System
PARAMETER-SET-1 (A253) BS2000

Extra operands for command ENTER-PROCEDURE.

Field Name Format/Length Operating System
PARAMETER-SET-2 (A253) BS2000

Extra operands for command ENTER-PROCEDURE.

Field Name Format/Length Operating System
PASSWORD (A8) BS2000

Password of protected file.

Field Name Format/Length Operating System
REPEAT-OPTION (A17) BS2000

Specifies repeated job runs. For an explanation, see the description of the REPEAT-OPTION parameter of the view SUBMIT.

Field Name Format/Length Operating System
REPEAT-TIME (A5) BS2000

Specifies time for repeat runs. For an explanation, see the description of the REPEAT-TIME parameter of the view SUBMIT.

Field Name Format/Length Operating System
RUN-PRIORITY (A3) BS2000

Priority during job execution. The value can be between job class maximum and 255, or STD. STD is the default.

Field Name Format/Length Operating System
START-DATE (A8) BS2000

Start date value in format YY-MM-DD.

Field Name Format/Length Operating System
START-DATX (D) BS2000

Start date of the entered procedure in Natural format.

Field Name Format/Length Operating System
START-OPTION (A17) BS2000

Specifies start of job. For an explanation, see the description of the START-OPTION parameter of the view SUBMIT.

Field Name Format/Length Operating System
START-TIME (A5) BS2000

Start time value in format HH:MM.

Field Name Format/Length Operating System
START-TIMX (T) BS2000

Start time of entered procedure in Natural format.

Field Name Format/Length Operating System
TIME (A5) BS2000

Maximum CPU time the job may consume. For an explanation, see the description of the TIME parameter of the view SUBMIT.

Field Name Format/Length Operating System
USERID (A8) BS2000

User ID under which the job is to be submitted.

Field Name Format/Length Operating System
USER-PASSWORD (A8) BS2000

Password belonging to the user ID under which the job is to be started.

ENTER-PROCEDURE Programming Notes

ENTER-PROCEDURE is an UPDATE view, that is, data is transmitted from the Natural program (client side) to ESY (server side).

The Entire System Server view ENTER-PROCEDURE returns codes and messages that describe whether the requested operation has been executed successfully or not.

Therefore, the DEFINE DATA section of the Natural program should only contain the fields shown in the following example: 

1 ENTER-PROCEDURE VIEW OF ENTER-PROCEDURE
  2 ERROR-CODE
  2 ERROR-TEXT
  2 SYSTEM-MESSAGE-CODE
  2 SYSTEM-CODE
  2 COMMAND-RESPONSE
  2 JOB-ID
  2 START-DATX
  2 START-TIMX

These fields in DEFINE DATA statement are the fields returned from the ENTER-PROCEDURE view in Entire System Server to the calling Natural program.

Defining other fields in DDM is not critical, but the access to these fields may lead to unpredictible results.