HCL information

HCL programming interface information

HCL is a programming interface.

HCL heading information

Common name: HARDCOPY LOG FORMAT (HCL OR HCR)
Macro ID: IHAHCLOG
DSECT name: HCL OR HCRREQ
Owning component: CONSOLE (SC1CK)
Eye-catcher ID: NONE
Storage attributes: Subpool:   N/A
Key:       N/A
Residency: N/A
Size: 55 BYTES PLUS A FIELD OF VARIABLE LENGTH AT OFFSET
55 (when the system is using a 2-digit year).
If system is using 4-digit years in the log
(HCFORMAT(CENTURY) was specified in CONSOLxx) ,
then the size is 57 bytes, plus a field of variable
length at offset 57.
Created by: N/A
Pointed to by: N/A
Serialization: NONE
Function: MAPS HARDCOPY LOG RECORDS

HCL mapping

Table 1. Structure HCL
Offset
Dec		 Offset
Hex		 Type Len Name(Dim) Description
0 (0) STRUCTURE 0 HCL HARDCOPY LOG RECORD
0 (0) X'0' 0  HCLHEAD "*" HEADER INFORMATION
0 (0) CHARACTER 2  HCLRECID(0) RECORD ID
0 (0) CHARACTER 1  HCLRECTP RECORD TYPE
0 (0) X'D5' 0  HCLWTO "C'N'" SINGLE-LINE MESSAGE
0 (0) X'E6' 0  HCLWTOR "C'W'" SINGLE-LINE MESSAGE WITH REPLY
0 (0) X'D4' 0  HCLMLWTO "C'M'" FIRST LINE OF A MULTI-LINE MESSAGE
0 (0) X'D6' 0  HCLLOG "C'O'" LOG COMMAND INPUT
0 (0) X'E7' 0  HCLOTHER "C'X'" ENTRY FROM A SOURCE OTHER THAN HARDCOPY OR LOG COMMAND
0 (0) X'E2' 0  HCLSPLIT "C'S'" CONTINUATION OF PREVIOUS LINE
0 (0) X'D3' 0  HCLLABEL "C'L' LABEL LINE OF A MULTI-LINE MESSAGE "
0 (0) X'C4' 0  HCLDATA "C'D'" DATA LINE OF A MULTI-LINE MESSAGE
0 (0) X'C5' 0  HCLDTEND "C'E'" DATA/END LINE OF A MULTI-LINE MESSAGE
1 (1) CHARACTER 1  HCLREQTP REQUEST TYPE
1 (1) X'C3' 0  HCLCMD "C'C'" COMMAND ISSUED BY OPERATOR
1 (1) X'D9' 0  HCLRESP "C'R'" COMMAND RESPONSE
1 (1) X'C9' 0  HCLINTNL "C'I'" INTERNAL ISSUED COMMAND
1 (1) X'E4' 0  HCLUNKID "C'U'" COMMAND FROM UNKNOWN CONSOLE ID
2 (2) CHARACTER 7  HCLROUTC ROUTING CODES
9 (9) CHARACTER 1 BLANK
10 (A) CHARACTER 8  HCLSYSID SYSTEM NAME
18 (12) CHARACTER 1 BLANK
19 (13) CHARACTER 5  HCLDATE(0) JULIAN DATE OF MESSAGE - YYDDD
19 (13) CHARACTER 2  HCLYEAR YEAR YY
21 (15) CHARACTER 3  HCLDAY DAY OF YEAR DDD
24 (18) CHARACTER 1  HCLFRMT BLANK
25 (19) CHARACTER 11  HCLTIME(0) TIME MESSAGE WAS ISSUED - HH:MM:SS.TH
25 (19) CHARACTER 2  HCLHR HOURS HH
27 (1B) CHARACTER 1  HCLCOLN1 COLON :
28 (1C) CHARACTER 2  HCLMIN MINUTES MM
30 (1E) CHARACTER 1  HCLCOLN2 COLON :
31 (1F) CHARACTER 2  HCLSEC SECONDS SS
33 (21) CHARACTER 1  HCLDOT1 DECIMAL POINT .
34 (22) CHARACTER 2  HCLTHSEC .01 SECONDS TH
36 (24) CHARACTER 1 BLANK
37 (25) CHARACTER 8  HCLCONID(0) ID OF CONSOLE THAT ISSUED COMMAND - APPEARS ON FIRST/ONLY LINE OF COMMANDS AND COMMAND RESPONSES
37 (25) CHARACTER 8  HCLJOBID(0) ID OF JOB THAT ISSUED MESSAGE - APPEARS ON FIRST/ONLY LINE OF OTHER MESSAGES
37 (25) CHARACTER 5 RESERVED
42 (2A) CHARACTER 3  HCLMLID MULTI-LINE MESSAGE ID - APPEARS ON ADDITIONAL LINES OF MULTI-LINE MESSAGES
45 (2D) CHARACTER 1 BLANK
46 (2E) CHARACTER 8  HCLREQFL USER EXIT/MPF REQUEST FLAGS 
         WHEN THIS PRINTABLE HEX VALUE IS CONVERTED TO
         BINARY, THE RESULTING BITS HAVE THE FOLLOWING
         DEFINITIONS ASSOCIATED WITH THEM.
         REQUEST FLAGS BYTE 1
            BIT POSITION X'80' - MESSAGE TEXT WAS CHANGED
            BIT POSITION X'40' - ROUTING CODES WERE CHANGED
            BIT POSITION X'20' - DESCRIPTOR CODES WERE
                                 CHANGED
            BIT POSITION X'10' - MESSAGE WAS QUEUED TO A
                                 PARTICULAR ACTIVE CONSOLE
            BIT POSITION X'08' - RESERVED
            BIT POSITION X'04' - MESSAGE WAS QUEUED BY
                                 ROUTING CODES ONLY
            BIT POSITION X'02' - THE CONSOLE ID TO WHICH THE
                                 MESSAGE WAS QUEUED, WAS
                                 CHANGED
            BIT POSITION X'01' - MINOR LINES WERE PROCESSED
         REQUEST FLAGS BYTE 2
            BIT POSITION X'80' - MESSAGE WAS DELETED
            BIT POSITION X'40' - MPF SUPPRESSION OVERRIDDEN
            BIT POSITION X'20' - MESSAGE WAS FORCED TO
                                 HARDCOPY
            BIT POSITION X'10' - MESSAGE BYPASSED HARDCOPY
            BIT POSITION X'08' - MESSAGE WAS FORCED TO
                                 HARDCOPY ONLY
            BIT POSITION X'04' - MESSAGE WAS BROADCASTED TO
                                 ACTIVE CONSOLES
            BIT POSITION X'02' - BROADCASTING OF MESSAGE WAS
                                 TURNED OFF
            BIT POSITION X'01' - A USER EXIT REQUESTED THAT THIS
                                 MESSAGE NOT BE RETAINED
         REQUEST FLAGS BYTE 3
            BIT POSITION X'80' - A USER EXIT REQUESTED THAT THIS
                                 MESSAGE BE RETAINED
            BIT POSITION X'40' - CHANGE THE RETRIEVAL KEY
            BIT POSITION X'20' - CHANGE THE 4-BYTE CONSOLE ID
            BIT POSITION X'10' - CHANGE THE MESSAGE TYPE FLAGS
            BIT POSITION X'08' - AUTOMATION IS NOT REQUIRED
            BIT POSITION X'04' - AUTOMATION IS REQUIRED
                                 AND/OR AUTOMATION TOKEN
            BIT POSITION X'02' - MESSAGE WAS ISSUED AS
                                 HARDCOPY ONLY
            BIT POSITION X'01' - RESERVED IN JBB7727 (WAS UD
                                 INDICATOR)
         SUPPRESSION FLAGS BYTE 4

            BIT POSITION X'80' - MESSAGE NOT SERVICED BY ANY
                                 WTO USER EXIT
            BIT POSITION X'40' - WTO USER EXIT ABENDED PROCESSING
                                 THIS MESSAGE
            BIT POSITION X'20' - MESSAGE NOT SERVICED BECAUSE
                                 OF AN INCOMPATIBLE REQUEST
            BIT POSITION X'10' - AUTOMATION REQUESTED
            BIT POSITION X'08' - Message Flood Automation
                                 processed this message
            BIT POSITION X'04' - MESSAGE SUPPRESSED BY A
                                 SUBSYSTEM
            BIT POSITION X'02' - MESSAGE SUPPRESSED BY A
                                 WTO USER EXIT ROUTINE
            BIT POSITION X'01' - MESSAGE SUPPRESSED BY MPF or
                                 Message Flood Automation
54 (36) CHARACTER 1 BLANK
54 (36) X'37' 0  HCLHEADL "*-HCLHEAD" LENGTH OF HEADER
54 (36) X'37' 0  HCLTEXT "*" MESSAGE OR COMMAND TEXT
Table 2. Structure HCRREC
Offset
Dec		 Offset
Hex		 Type Len Name(Dim) Description
0 (0) STRUCTURE 0 HCRREC HARDCOPY LOG RECORD WITH A DATE OF THE FORM YYYYDDD
0 (0) X'0' 0  HCRHEAD "*" HEADER INFORMATION
0 (0) CHARACTER 2  HCRRECID(0) RECORD ID
0 (0) CHARACTER 1  HCRRECTP RECORD TYPE
0 (0) X'D5' 0  HCRWTO "C'N'" SINGLE-LINE MESSAGE
0 (0) X'E6' 0  HCRWTOR "C'W'" SINGLE-LINE MESSAGE WITH REPLY
0 (0) X'D4' 0  HCRMLWTO "C'M'" FIRST LINE OF A MULTI-LINE MESSAGE
0 (0) X'D6' 0  HCRLOG "C'O'" LOG COMMAND INPUT
0 (0) X'E7' 0  HCROTHER "C'X'" ENTRY FROM A SOURCE OTHER THAN HARDCOPY OR LOG COMMAND
0 (0) X'E2' 0  HCRSPLIT "C'S'" CONTINUATION OF PREVIOUS LINE
0 (0) X'D3' 0  HCRLABEL "C'L' LABEL LINE OF A MULTI-LINE MESSAGE "
0 (0) X'C4' 0  HCRDATA "C'D'" DATA LINE OF A MULTI-LINE MESSAGE
0 (0) X'C5' 0  HCRDTEND "C'E'" DATA/END LINE OF A MULTI-LINE MESSAGE
1 (1) CHARACTER 1  HCRREQTP REQUEST TYPE
1 (1) X'C3' 0  HCRCMD "C'C'" COMMAND ISSUED BY OPERATOR
1 (1) X'D9' 0  HCRRESP "C'R'" COMMAND RESPONSE
1 (1) X'C9' 0  HCRINTNL "C'I'" INTERNAL ISSUED COMMAND
1 (1) X'E4' 0  HCRUNKID "C'U'" COMMAND FROM UNKNOWN CONSOLE ID
2 (2) CHARACTER 7  HCRROUTC ROUTING CODES
9 (9) CHARACTER 1 BLANK
10 (A) CHARACTER 8  HCRSYSID SYSTEM NAME
18 (12) CHARACTER 1 BLANK
19 (13) CHARACTER 7  HCRDATE(0) JULIAN DATE OF MESSAGE - YYYYDDD
19 (13) CHARACTER 2  HCRCENT CENTURY YY
21 (15) CHARACTER 5  HCRYYDDD(0) OLD FORMAT OF DATE - YYDDD
21 (15) CHARACTER 2  HCRYEAR YEAR YY
23 (17) CHARACTER 3  HCRDAY(0) DAY OF YEAR DDD
23 (17) CHARACTER 1 FIRST DIGIT OF DAY OF YEAR
24 (18) CHARACTER 1  HCRFRMT SECOND DIGIT OF DAY OF YEAR IF THIS FIELD IS A BLANK THEN THE HCL MAPPING SHOULD BE USED TO MAP THE HARDCOPY LOG RECORD
25 (19) CHARACTER 1 LAST DIGIT OF DAY OF YEAR
26 (1A) CHARACTER 1 BLANK
27 (1B) CHARACTER 11  HCRTIME(0) TIME MESSAGE WAS ISSUED - HH:MM:SS.TH
27 (1B) CHARACTER 2  HCRHR HOURS HH
29 (1D) CHARACTER 1  HCRCOLN1 COLON :
30 (1E) CHARACTER 2  HCRMIN MINUTES MM
32 (20) CHARACTER 1  HCRCOLN2 COLON :
33 (21) CHARACTER 2  HCRSEC SECONDS SS
35 (23) CHARACTER 1  HCRDOT1 DECIMAL POINT .
36 (24) CHARACTER 2  HCRTHSEC .01 SECONDS TH
38 (26) CHARACTER 1 BLANK
39 (27) CHARACTER 8  HCRCONID(0) ID OF CONSOLE THAT ISSUED COMMAND - APPEARS ON FIRST/ONLY LINE OF COMMANDS AND COMMAND RESPONSES
39 (27) CHARACTER 8  HCRJOBID(0) ID OF JOB THAT ISSUED MESSAGE - APPEARS ON FIRST/ONLY LINE OF OTHER MESSAGES
39 (27) CHARACTER 5 RESERVED
44 (2C) CHARACTER 3  HCRMLID MULTI-LINE MESSAGE ID - APPEARS ON ADDITIONAL LINES OF MULTI-LINE MESSAGES
47 (2F) CHARACTER 1 BLANK
48 (30) CHARACTER 8  HCRREQFL USER EXIT/MPF REQUEST FLAGS - See description after HCLREQFL
56 (38) CHARACTER 1 BLANK
56 (38) X'39' 0  HCRHEADL "*-HCRHEAD" LENGTH OF HEADER
56 (38) X'39' 0  HCRTEXT "*" MESSAGE OR COMMAND TEXT 
         MISCELLANEOUS CONSTANTS
56 (38) X'7A' 0  HCLCOLON "C':'" COLON FOR TIMESTAMP
56 (38) X'4B' 0  HCLDOT "C'.'" DECIMAL POINT FOR TIMESTAMP
56 (38) X'40' 0  HCLBLANK "C' '" BLANK FOR COLUMN SEPARATION
Table 3. Cross Reference for HCL
Name Offset Hex Tag
HCL 0
HCLBLANK 38 40
HCLCMD 1 C3
HCLCOLN1 1B
HCLCOLN2 1E
HCLCOLON 38 7A
HCLCONID 25
HCLDATA 0 C4
HCLDATE 13
HCLDAY 15
HCLDOT 38 4B
HCLDOT1 21
HCLDTEND 0 C5
HCLFRMT 18
HCLHEAD 0 0
HCLHEADL 36 37
HCLHR 19
HCLINTNL 1 C9
HCLJOBID 25
HCLLABEL 0 D3
HCLLOG 0 D6
HCLMIN 1C
HCLMLID 2A
HCLMLWTO 0 D4
HCLOTHER 0 E7
HCLRECID 0
HCLRECTP 0
HCLREQFL 2E
HCLREQTP 1
HCLRESP 1 D9
HCLROUTC 2
HCLSEC 1F
HCLSPLIT 0 E2
HCLSYSID A
HCLTEXT 36 37
HCLTHSEC 22
HCLTIME 19
HCLUNKID 1 E4
HCLWTO 0 D5
HCLWTOR 0 E6
HCLYEAR 13
HCRCENT 13
HCRCMD 1 C3
HCRCOLN1 1D
HCRCOLN2 20
HCRCONID 27
HCRDATA 0 C4
HCRDATE 13
HCRDAY 17
HCRDOT1 23
HCRDTEND 0 C5
HCRFRMT 18
HCRHEAD 0 0
HCRHEADL 38 39
HCRHR 1B
HCRINTNL 1 C9
HCRJOBID 27
HCRLABEL 0 D3
HCRLOG 0 D6
HCRMIN 1E
HCRMLID 2C
HCRMLWTO 0 D4
HCROTHER 0 E7
HCRREC 0
HCRRECID 0
HCRRECTP 0
HCRREQFL 30
HCRREQTP 1
HCRRESP 1 D9
HCRROUTC 2
HCRSEC 21
HCRSPLIT 0 E2
HCRSYSID A
HCRTEXT 38 39
HCRTHSEC 24
HCRTIME 1B
HCRUNKID 1 E4
HCRWTO 0 D5
HCRWTOR 0 E6
HCRYEAR 15
HCRYYDDD 15