Object Types for Import / Export

The following Entire Event Management object types can be exported and imported:

  • CONSOLE

  • CALENDAR

  • LAYOUT

  • NODE

  • PROFILE

  • RANGE

  • RULE

  • SERVER

  • USER

  • MESSAGE-LOG

For an explanation of these object types, see Entire Event Management Object Types in the Concepts and Facilities documentation.

The following topics are covered below:


Abbreviations

Abbreviation Explanation
+ Required field
D Contains date only.
DT Contains date and time.
K Key Field, required.
M Multiple field.
PG Periodic group identifier.
PI Part of periodic group element "key" (identifier).
T Contains time only.

Reserved Keywords

The following reserved keywords appear in all objects:

Keyword Explanation
OBJECT Beginning of an object.
END-OBJECT End of an object.

Common Field Names

K    NAME     A32 
+    NAME-L     A32 after upper case translation, <NAME-L> must
        be identical to <NAME>.

USER COMMENT and MAINTENANCE-ACTIVITY are part of all objects:

<USER COMMENT>

     SHORT-DESCRIPTION   A32 #NSHD=16

<MAINTENANCE-ACTIVITY>

     MAINTENANCE-USERID  A08
     MAINTENANCE-TIME   DT
     CREATION-TIME   DT

Object Descriptions

This subsection lists all object types and their keywords.

For an explanation of these object types, see Entire Event Management Object Types in the Concepts and Facilities documentation.

OBJECT=ACTION

K    KEY                       A16 hexadecimal representation of B8
+    NAME                      A32 
+    TYPE                      A04 'BOX', 'CMD', 'JOB', 'MSG', 'NAT', 'NET'
     EXEC-NODE                 N03 
     WAIT-TIME                 N05 
     WAIT-TIME-UNIT            A08 blank, 'MIN', 'SEC'
     NAT-PROGRAM               A08 
     NAT-LIBRARY               A08 must not be blank, if DBID and FNR > 0
     NAT-DBID                  N03 
     NAT-FNR                   N03 
M    CMD-COMMAND               A180 
     EOR-OWNER                 A10 
     EOR-NETWORK               A10 
     EOR-JOB                   A10 
     JOB-NODE                  N03 
     JOB-VOLSER                A06 
     JOB-DSNAME                A54 
     JOB-MEMBER                A64 
     JOB-MEMBER-TYPE           A08 
     JOB-LIBRARY               A08 
     JOB-SUBLIB                A08 
     JOB-VSAM-CATALOG          A08 
     JOB-SUBSTITUTE-SYMBOL     A01 
     MSG-TEXT                  A200 
M    MSG-TO-USER               A08 #NU = 5
M    MSG-TO-LOGICAL-CONSOLE    A08 #NLC = 5
M    MSG-TO-PHYSICAL-CONSOLE   N03 #NPC = 5
M    BOX-TEXT                  A220 #NB = 7     

include <USER COMMENT> and <MAINTENANCE ACTIVITY>

OBJECT=CALENDAR

K    NAME                    common 
K    OWNER                   A10 
K    YEAR                    N04 
+    TABLE                   A50 bit string

include <USER COMMENT> and <MAINTENANCE ACTIVITY>

OBJECT=CONSOLE/RANGE

K    CONSOLE                 A08 
K    RANGE-OF-MSG            A32 
     PRIORITY                N03 
+    EXCLUDE/INCLUDE         A01 'E' or 'I'
     REPLY                   A01 
     ME-REPRESENTATION       A09 

include <USER COMMENT> and <MAINTENANCE ACTIVITY>

OBJECT=CONSOLE

K    NAME                    common 
     LIFE-TIME               N05 
     LIFE-TIME-UNIT          A08 'DAYS', 'MONTHS', 'WEEKS', 'YEARS'
+    NAME-L                  common 
     TIME-FROM               T 
     TIME-TO                 T 
     LAYOUT                  A32 
     CALENDAR                A20 
     SW-AU-ACTIVE            A01 ' ' or 'X'
     SW-ME-LOG               A01 ' ' or 'X'

include <USER COMMENT> and <MAINTENANCE ACTIVITY>

OBJECT=EVENT

K    KEY                       A12 hexadecimal representation of B6
+    NAME                      A32 
     LOG                       A01 blank '1', '2', '3'
+    LAST-ACTION-KEY           A04 hexadecimal representation of B2
+    LEVEL                     A04 hexadecimal representation of B2
     SUBTREE                   A01 ' ' or 'X'
     ASSIGNED-TO               A04 hexadecimal representation of B2
     FREQUENCY                 N05 
PG   VAR-ASSIGNMENT #NVA = 10
PI      VAR-NAME               A08 
PI      VAR-POSITION           N02 
M    MSG-ID                    A59 #NMI = 1
     MSG-ID-IDX                N03 
PG   TOKEN-OR-EXPRESSION #NTOE = 1
PI,M    TOKEN-AND-EXPRESSION   A14 #NTAE = 2
M    JOB-NAME                  A08 #NJN = 4

include <USER COMMENT> and <MAINTENANCE ACTIVITY>

OBJECT=LAYOUT

K    NAME                    common 
+    NAME-L                  common 
     SW-DAY-BREAK            A01 ' ' or 'X'
     SW-FROZEN-BREAK         A01 ' ' or 'X'
PG   LAYOUT #NLAY = 99
PI      SEQUENCE             N02 
PI      HEADER               A15 
PI      LENGTH               N03 

include <USER COMMENT> and <MAINTENANCE ACTIVITY>

OBJECT=NODE

+    NAME-L                  A32 
K    KEY                     N03 1 to 255
     TIME-DIFFERENCE         N02.1 

include <USER COMMENT> and <MAINTENANCE ACTIVITY>

OBJECT=PROFILE

K    NAME                    common 
+    NAME-L                  common 
K    PRODUCT                 A03 
K    TYPE                    A02 'MA', 'CV', 'SV'
K    OBJECT-NAME             A32 
M    CLASS/LEVEL             A03 #NCL = 50

include <USER COMMENT> and <MAINTENANCE ACTIVITY>

OBJECT=RANGE

K    NAME                      common 
K    KEY                       A08 hexadecimal representation of B4
+    NAME-L                    common 
     REPRESENTATION            A09 
     PRIORITY                  N03 
M    MSG-ID                    A59 #NMI = 44
     MSG-ID-IDX                N03 
PG   TOKEN-OR-EXPRESSION #NTOE = 2
PI,M    TOKEN-AND-EXPRESSION   A14 #NTAE = 4
M    JOB-NAME                  A08 #NJN = 4
     REPLY-INDICATOR           A01 ' ' or 'X'

include <USER COMMENT> and <MAINTENANCE ACTIVITY>

OBJECT=RULE

K    NAME                    common 
K    KEY                     A08 hexadecimal representation of B4
K    CONSOLE                 A08 
+    RANGE                   A08 hexadecimal representation of B4
+    RANGE-NAME              A32 
+    NAME-L                  common 
     SW-ACTIVE               A01 ' ' or 'X'
     CALENDAR                A20 
M,+  TREE-SEQUENCE           A04 #NTS = 100; hex. representation of B2
     TIME-FROM               T 
     TIME-TO                 T 
     TIMEOUT                 N05 
     TIMEOUT-UNIT            A08 blank, 'MIN', 'SEC'
     LOCKTIME                N05
     LOCKTIME-UNIT           A08 blank, 'MIN', 'SEC'
     LOOP-CRITERION          A01 '1' or '2'
     LOOP-RESUMETIME         N05
     LOOP-RESUMETIME-UNIT    A08 blank, 'MIN', 'SEC'
+    LAST-EVENT-KEY          A04 hexadecimal representation of B2
     REPRESENTATION          A09 

include <USER COMMENT> and <MAINTENANCE ACTIVITY>

OBJECT=SERVER

K    KEY                     N03 values 1 to 255
M    CONSOLE                 A08 #NC = 30
M    MSG-ID                  A59 #NC = 88
     MSG-ID-IDX              N03 
     DATA-PREFIX             A54 
     VOLSER                  A06
     MLOG-DBID               N03 
     MLOG-FNR                N03 
     ACTION-DBID             N03 
     ACTION-FNR              N03 
     ACTION-LIBRARY          A08 
     TOKENIZING-DELIMITERS   A10 
     MSGID-EXIT              A08 must start with 'U' or 'Y'
     INIT-EXIT               A08 must start with 'U' or 'Y'
     GETMSG-WAIT-TIME        N05 
     GETMSG-WAIT-TIME-UNIT   A08 blank, 'MIN', 'SEC'
     ET-MAX-COUNT            N05 if ne ' ' -> NE <= 0
     ET-MAX-TIME             N05 
     ET-MAX-TIME-UNIT        A08 blank, 'MIN', 'SEC'
     UNDEF-TIME-FROM         T  
     UNDEF-TIME-TO           T  
     SIZE-ARE-QUEUE          N09 
     SIZE-ANE-QUEUE          N09 
     RULE-TIMEOUT            N05 
     RULE-TIMEOUT-UNIT       A08 blank, 'MIN', 'SEC'
     LOCKTIME                N05
     LOCKTIME-UNIT           A08 blank, 'MIN', 'SEC'
     LOOP-CRITERION          A01 '1' or '2'
     LOOP-RESUMETIME         N05
     LOOP-RESUMETIME-UNIT    A08 blank, 'MIN', 'SEC'
     EVENT-LOOP-FREQUENCY    N05 
     ACTLOG-PREFIX           A03 
     ACTLOG-DB               A01 ' ' or 'X'
     ACTLOG-NODE             N03 
     ACTLOG-SYSOUT           A01 ' ' or 'X'
     API-RECEIVER            A16
     RETRY-WAIT-TIME         N05
     RETRY-WAIT-TIME-UNIT    A08 blank, 'MIN', 'SEC'
     SYS3-CLEANUP            T  Format HHIISS
     SYS3-CLEANUP-TRACE      A01

include <USER COMMENT> and <MAINTENANCE ACTIVITY>

OBJECT=USER

K    USER-ID                 A08 
     ADMINISTRATOR           A01 ' ' or 'X'
K    LAST-NAME               A32 
     LAST-NAME-L             A32 lower-case representation of LAST-NAME
     INITIAL                 A01 
K    FIRST-NAME              A32 
     FIRST-NAME-L            A32 lower-case representation of FIRST-NAME
     TITLE                   A24 
     DEPT-NAME               A32 
     DEPT-NR                 A10 
M    ADDRESS                 A60 #NAD = 3
     CITY                    A32 
     POSTAL-CODE             A10 
     COUNTRY                 A08 
     PHONE-COUNTRY           N02 
     PHONE                   A16 
     PHONE-EXT               A10 
M    HOME-ADDRESS            A60 #NHA = 3
     HOME-CITY               A32 
     HOME-POSTAL-CODE        A10 
     HOME-COUNTRY            A08 
     HOME-PHONE-COUNTRY      N02 
     HOME-PHONE              A16 
M    PRODUCT-PROFILE         A35 #NPP = 10
PG   REPRESENTATION-G #NREP = 99
PI      REPRESENTATION       A09 
     DATE-POSITION           N01 '1' = left corner, '2' = right corner
     DATE-FORMAT             A01 'A' = American, 'E' = English, 'G' = German
        'I' = international
     NCL-CMD-PROMPT          A01 ' ' or 'X'
     OPERATOR-PROMPT         A01 ' ' or 'X'
     NCL-NODE                A08 
     MENU-SELECTION          A01 'A' = alphanumeric codes,
        'N' = numeric codes
     DELETE-CONFIRM          A01 blank, 'Y' = confirm with Y/N,
        'N' = confirm with name
     FLIP/KEY                A01 'F' = action bar, 'K' = PF key display
     ZOOM-PROTECT            A01 ' ' or 'X'
     UKEYS-ON                A01 ' ' or 'X'
     ENTER-SELECTION         A01 'D' = down, 'S' = stay on current page
     ENTER-CONSOLE           A01 'B' = bottom, 'D' = down,
        'S' = stay on current page
     MODE-USER               A01 'B' = backtracking,
        'M' = back to assigned menu
PG   MAGIC #NMAG = 10
PI      MAGIC-CHAR           A01 
PI      MAGIC-FIRST          A01 
PI      MAGIC-VALUE          A32 
PG   PFKEY #NPFK = 24
PI      PFKEY-TEXT           A05 
PI      PFKEY-VALUE          A32 

include <USER COMMENT> and <MAINTENANCE ACTIVITY>

OBJECT=MESSAGE-LOG

MESSAGE-LOG is an object type of System File 3. Its structure does not conform to that of System File 2 object types. The common fields are not used here.

K    NODE-NR                 N03 
+    TIME                    DT 
K    TIME-CNT                N17 Format YYYYMMDDHHIISST * 10.000
K    TIME-CNT-COMPLEMENT     N17 99999999999999999 - <TIME-CNT>
K,M  CONSOLE                 A08 #NC = 55
+,M  RANGE                    A08 #NR = 55; hexadecimal representation of B4
     MSG-TYPE                A01 
+    MSG-ID                  A09 
+    KW-ASSIGN-CHAR          A01
+    KW-DELIM-CHAR           A01
+    KW-MSG-ATTRIBUTES       A250 #NK = 2
     FROZEN-INDICATOR        A01 
     RULE-TIME-CNT           N17 Format YYYYMMDDHHIISST * 10.000
     ACTION-KEY              A16 hexadecimal representation of binary B8
     ACTION-TYPE             A03 
     ACTION-STATUS           A01 
M    ACTION-USER-VARIABLES   A200 #NA = 3
M    STATISTICS              A250 #NS = 4

Hierarchy of the Object Types

The following table shows the relationship between the different object types.

Object Type Object Type Used Export Import
CALENDAR none - -
CONSOLE RULE O O
CALENDAR O R
CONSOLE-RANGE O R
LAYOUT O R
RANGE O R
LAYOUT none - -
NODE none - -
PROFILE CONSOLE O R
SERVER O R
RANGE none - -
RULE ACTION R R
CALENDAR O R
CONSOLE O R
CONSOLE-RANGE O R
EVENT R R
RANGE O R
SERVER CONSOLE O R
NODE O R
USER PROFILE O R
MESSAGE-LOG CONSOLE - R

Object Types Used appearing in BOLD/ITALICS cannot be selected for export.

Object Types Used in normal print can be selected for export.

O = Optional. These referred object types can be exported together with the main object, but need not exist, when importing the main object.

R = Required. These referred object types are always exported together with the main object and must exist, when importing the main object.