Job Documentation, Data Stores and Best Practices

[Rebecca Keller]

Hello,

I was curious as to how people store their job documentation used by your workload operations teams.    We currently have documentation in a PDS on z/OS, but using the ISPF editor isn't  user friendly for our distributed community.  We could get an editor front end, but the PDS also limits us to 8 character member names to match the job names.   We would also like to maintain the capabilities to search the documentation repository, as we do today.

Anyone have any creative ideas on how they have modernized this functionality?

Thanks!
Becky Keller

[Lucy Zhang]

Hi Becky,

Currently the JOB document is stored on mainframe. And please feel free to post an idea for future enhancement:
https://community.broadcom.com/ideation/allideas

As you may also read. the following doc link provide two possible workarounds:
https://techdocs.broadcom.com/content/broadcom/techdocs/us/en/ca-mainframe-software/automation/ca-workload-automation-esp-edition/12-0/using/document-a-job.html#concept.dita_b73d670fdbea763e7b1940e506dc86ce355d1854_UseJobDocumentationforQualifiedJobs

CA WA ESP Edition uses the eight-character job name to access job documentation. If you want to use job documentation for jobs defined with a job qualifier, you can do one of the following:

• Use the DOCMEM operand when you define the job in the CA WA ESP Edition procedure, and specify the name of the member used for the job's documentation.
• Use IF-THEN-ELSE logic in the job documentation member to check the qualifier of a job and process different statements. Use the ESPAPQUAL symbolic variable for jobs in an application. Use the ESPJQUAL variable for jobs in a DJC/JES3 network.

DOCMEM Method
This method shows you how you use different job documentation members for different qualified versions of a job. Job A.RUN1 references member A1; job A.RUN2 references member A2.
JOB A.RUN1 DOCMEM(A1)
JOB A.RUN2 DOCMEM(A2)
IF-THEN-ELSE Method

The if-then-else method uses a common job documentation member for job A. CA WA ESP Edition processes different statements based on the job qualifier.
If the qualifier is RUN1, the job runs daily and releases job Y.
If the qualifier is RUN2, the job runs on workdays and releases job Z.
Graphically, the dependencies look like this:
Qualified Job Version Dependencies
Qualified Job Version Dependencies
The job documentation member looks like this:
A: JOBDOC
IF ESPAPQUAL='RUN1' THEN DO
RUN DAILY
RELEASE Y
ENDDO
IF ESPAPQUAL='RUN2' THEN DO
RUN WORKDAYS
RELEASE Z
ENDDO
--------------------

Thank you,

Lucy