PRINT-DOCUMENT

File 213
Op-Sys BS2000/OSD
Task Print document

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.
RECORD A253   D Required if no DSNAME/ELEMENT is given.
RECORD-LENGTH N3   D  
DSNAME A54   D Required if no RECORD is given.
ELEMENT A64   D  
PASSWORD A8   D  
ELEMENT-PASSWORD A8   D  
ELEMENT-TYPE A8   D  
ELEMENT-VERSION A24   D  
ADDITIONAL-COPIES A3   D  
CHARACTER-SETS A8   D  
DELETE-AFTER-PRINT A3   D  
FACE-SIDE A8   D  
FORM-NAME A8   D  
HEADER-PAGE-TEXT A32   D  
JOB-NAME A8   D  
LEFT-MARGIN A4   D  
LINE-SPACING A64   D  
PAGE-DEFINITION A8   D  
USER-RESOURCES-FILE A54   D  
PARAMETER-SET-1 A253   D  
PARAMETER-SET-2 A253   D  
COMMAND-RESPONSE A253      
JOB-ID A5      

Relevant Error Codes

Code Text BS2000/OSD
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
750 Invalid operand within operand list X
798 Task was not started under TSOS. X
799 Entire System Server internal error X
809 Subsystem not active 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
991 Unknown product X
998 Member not found X

Field Descriptions

Field Name Type/Length Operating System
ADDITIONAL-COPIES A3 BS2000/OSD

Number of additional copies.

ADDITIONAL-COPIES=0|integer1..255

See the description of the ADDITIONAL-COPIES parameter of the BS2000/OSD command PRINT-DOCUMENT.

Field Name Type/Length Operating System
CHARACTER-SETS A8 BS2000/OSD

Name of fonts or font pools.

CHARACTER-SETS=*BY-EXTENDED-NAME(<alphanum_name_1...8>)

See the description of the CHARACTER-SETS parameter of the BS2000/OSD command PRINT-DOCUMENT.

Field Name Type/Length Operating System
COMMAND-RESPONSE A253 BS2000/OSD

PRINT-DOCUMENT command response.

Field Name Type/Length Operating System
DELETE-AFTER-PRINT A3 BS2000/OSD

Delete file after print: YES or NO.

Field Name Type/Length Operating System
DSNAME A54 BS2000/OSD

Name of the file to be printed out.

Note that FUNCTION=CLOSE is required to start the printout.

Field Name Type/Length Operating System
ELEMENT A64 BS2000/OSD

Name of the LMS element to be printed out.

Field Name Type/Length Operating System
ELEMENT-PASSWORD A8 BS2000/OSD

Password for protected LMS element.

Field Name Type/Length Operating System
ELEMENT-TYPE A8 BS2000/OSD

Type of LMS element to be printed out.

Field Name Type/Length Operating System
ELEMENT-TYPE A24 BS2000/OSD

Version of LMS element to be printed out.

Field Name Type/Length Operating System
FACE-SIDE A8 BS2000/OSD

Face side identifier.

See the description of the FACE-SIDE parameter of the BS2000/OSD command PRINT-DOCUMENT.

Field Name Type/Length Operating System
FORM-NAME A8 BS2000/OSD

Name of form.

See the description of the FORM-NAME parameter of the BS2000/OSD command PRINT-DOCUMENT.

Field Name Type/Length Operating System
FUNCTION A8 BS2000/OSD

Function to be performed.

Possible options:

blank Default. Print a record.
CLOSE All records have been written. Specify this on the last request.
Field Name Type/Length Operating System
HEADER-PAGE-TEXT A32 BS2000/OSD

Used for system exits.

See the description of the HEADER-PAGE-TEXT parameter of the BS2000/OSD command PRINT-DOCUMENT.

Field Name Type/Length Operating System
JOB-ID A5 BS2000/OSD

Returned for FUNCTION=CLOSE.

Field Name Type/Length Operating System
JOB-NAME A8 BS2000/OSD

Name of the job under which the output is to be printed.

Field Name Type/Length Operating System
LEFT-MARGIN A4 BS2000/OSD

Left margin of text. 

LAYOUT-CONTROL=*PARAMETERS(LEFT-MARGIN=value_1)

See the description of the LEFT-MARGIN parameter of the BS2000/OSD command PRINT-DOCUMENT.

Field Name Type/Length Operating System
LINE-SPACING A64 BS2000/OSD

File contains ASA print control characters. 

DOCUMENT-FORMAT=*TEXT(LINE-SPACING=value)

For an explanation, see the description of the LINE-SPACING parameter of the BS2000/OSD command PRINT-DOCUMENT.

Field Name Type/Length Operating System
PAGE-DEFINITION A8 BS2000/OSD

Page definition to be used for print. 

PAGE-DEFINITION=*STD/<integer_1...50000>/<alphanum_name_1...8>

For an explanation, see the description of the PAGE-DEFINITION parameter of the BS2000/OSD command PRINT-DOCUMENT.

Field Name Type/Length Operating System
PARAMETER-SET-1 A253 BS2000/OSD

Extra operands for command PRINT-DOCUMENT.

Field Name Type/Length Operating System
PARAMETER-SET-2 A253 BS2000/OSD

Extra operands for command PRINT-DOCUMENT.

Field Name Type/Length Operating System
PASSWORD A8 BS2000/OSD

Password of protected file.

Field Name Type/Length Operating System
RECORD A253 BS2000/OSD

Record to be printed out.

Field Name Type/Length Operating System
RECORD-LENGTH N3 BS2000/OSD

Length of record.

Field Name Type/Length Operating System
USER-RESOURCES-FILE A54 BS2000/OSD

Fully qualified name of a user file containing all resources.

USER-RESOURCES-FILE=*STD/<filename_1...44>

PRINT-DOCUMENT Programming Notes

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

The Entire System Server view PRINT-DOCUMENT 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 this example: 

1 PRINT-DOCUMENT VIEW OF PRINT-DOCUMENT
  2 ERROR-CODE
  2 ERROR-TEXT
  2 SYSTEM-MESSAGE-CODE
  2 SYSTEM-CODE
  2 COMMAND-RESPONSE
  2 JOB-ID

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

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