TRACE documentation

[Michael A. Lowry]

The documentation pages for TRACE and TRACE_DUMP need updates.

1. The description of Trace Option is simply "Trace Setting". This description does not add useful information.
   The description should instead probably be something like:
   "The type of information to write to the trace."
2. The allowed values listed under Trace Options are missing several values, including 3 File Transfer, 11 Reporting, and 15 Internal.
3. The meaning of trace option 6 depends on the Automation Engine process type. For the REST Communication Process, trace option 6 means rest tracing but for all other AE process types, trace option 6 means JCL tracing.
4. The description of trace option 14 changed in the AWI after UC4 was renamed to Automation Engine. Now it is just global instead of UC4global.
5. The description of Trace Level reads "Trace Size". This is not very informative, and potentially misleading.
   It should instead state something like:
   "The specific type of details to write to the trace; sometimes but not always, higher trace levels cause more information to be written. The meaning of each trace level depends on the trace option specified. Not all trace levels are valid for every trace option.
6. It could be useful to enumerate the valid trace levels by trace option. These can be listed in the AWI, but it could still be worthwhile to list them in the documentation.
   Trace Level values for each Trace Option
   Level 0 always means no output (tracing disabled). Unlisted levels are invalid.
   1. TCP/IP
      • 1 = XRO, login
      • 2 = HOSTG timer, period calculation, filescan agent
      • 3 = calendar calculation, mail sending
      • 4 = extended calendar calculation
      • 5 = FT connections
      • 6 = calendar cache
      • 7 = SMTP
      • 9 = max. output
   2. Database
      • 1 = SQL
      • 2 = Opcodes
      • 3 = bind parameter
      • 4 = Data areas
      • 9 = max. output
   3. File Transfer
      • 1 = generating FT name
      • 2 = additional FT info
      • 9 = trace FT_ASYNC_QUIT
   4. Srcall
      • 1 = call of server routines
      • 2 = server interface
      • 3 = input memory
      • 4 = local memory
   5. Memio
      • 1 = memory management
      • 2 = extended memory management
      • 8 = internal MQBUSY table
      • 9 = internal memory areas
   6. JCL/rest (depending on process type)
      
      • JCL (WP, CP, JWP, JCP)
        • 1 = Generated JCL
        • 2 = Input and output parameters
        • 5 = Input and output parameters (binary)
        • 9 = Generated JCL (byte code)
      • rest (REST process)
        • 1 = HTTP headers and content
        • 2 = Login information
        • 9 = max. output
   7. Memsv
      • 1 = ZUMEMSV OPEN/CLOSE
      • 2 = ZUMEMSV PUT/GET
      • 6 = FOREACH MEMSV
   8. SNMP
      • 2 = BLKCHNG, COCHNG
      • 9 = max. output
   9. Zuxml
      • 1 = Call
      • 2 = Error
      • 3 = Exec
      • 4 = Recovery
      • 5 = Call+Error
      • 6 = Call+Exec
      • 7 = Call+Recovery
      • 8 = Call+Error+Recovery
      • 8 = Call+Exec+Recovery
   10.  Cache
       • 1 = Insert/Search
       • 2 = Statistics
   11. Reporting
       • 1 = optional reports (with JCL trace flag > 1) or trace writing into variable table (with MEMSV trace flag > 1)
       • 2 = trace updating variable table (use with MEMSV trace flag > 1)
       • 3 = trace reading from variable table (with MEMSV trace flag > 1)
       • 4 = trace sections while resolving variables
   12. Ucds
       • 1 = UC_SEND
       • 9 = max. output
   13. Xscript
       • 1 = xload
       • 2 = xreq
       • 4 = actprint
       • 5 = save/restore syntax
       • 9 = max. output
   14. global
       • 9 = max. output
   15. Internal
       Not documented
   16. Minimal
       • 1 = minimal trace
       • 2 = REGEN, FORECAST
       • 3 = COC_Abend, activate job
7. The Notes section should be reviewed to verify correctness. I'm skeptical that the statements listed are 100% correct.

In my opinion, it would make sense to create a separate dedicated page just for trace options and their respective levels.

Ping @Gabi Oberreiter​

[Dominic Irudayasamy]

Nice...

------------------------------
Dominic I
------------------------------

[Christoph Rekers]

WOW! @Michael A. Lowry,

Thumbs up!!!

Cheers
Christoph ​

------------------------------
----------------------------------------------------------------
Automic AE Consultant and Trainer since 2000
----------------------------------------------------------------
------------------------------

[Gabi Oberreiter]

Hi Michael,

We will look into this topic and enhance the docs accordingly. Thank you for your input!

Best, Gabi

[Michael A. Lowry]

The v24 documentation has not been updated. Just a reminder, @Gabi Oberreiter / @Gabi Oberreiter.

[Michael A. Lowry]

The v24.4 documentation still lacks descriptions of the trace levels. Ping @Gabi Oberreiter / @Gabi Oberreiter