Previous Topic: 3.3.6.4 ISPF Preprocessed Panels

Next Topic: 3.4 Define and Generate Components

3.3.7 Generate Document Access (DOCAGEN1)


CA MICS Document Access uses ISPF tables to provide the
displays for Guide Selection, Text Selection, and the Subject
Cross Reference selection panels.  When installing a new
CA MICS system or an additional CA MICS component, the
following tables are generated to
sharedprefix.MICS.ISPTLIB by the DOCAGEN1 job:
 
   DOCLSTP4    -  Guide list table
   DOCPxx      -  Titles table for guide xx
   DOCXPa-z,@  -  Subject Cross Reference Phrase Tables
   DOCXSa-z,@  -  Subject Cross Reference Section Tables
   DOCXWV      -  Subject Cross Reference Keyword Table
 
These tables are also generated when guides are added or
updated in the documentation libraries by other types of
product updates.  In such cases, the product update
documentation includes this step, if necessary.
 
To generate all the tables for Document Access, perform the
following:
 
  Submit 'sharedprefix.MICS.CNTL(DOCAGEN1)'
 
After the job completes, check the output to ensure that the
job completed successfully.  Review the MICSLOG output file
for any error messages.  DOCAGEN1 also sends these messages
to the ISPF LOG output file if the ISPF LOG is allowed in
batch at your installation.  If the following message
appears:
 
  Docpick Incomplete - Docpick Program Issued Return Code:  x
 
check the return code value of x.  If the value is 1 or 2,
this is merely an information message (not an error), and the
generation should have continued to completion.  A higher
value indicates that a problem exists, and should be
accompanied by a longer diagnostic message to help determine
the cause of the problem.
 
 
DOCAGEN and DOCAGEN1 Jobs
 
Two generation jobs are provided for Document Access.  The
DOCAGEN1 job performs the complete generation process, which
includes the Subject Cross Reference tables generation.  The
DOCAGEN job generates only the Guide and Titles tables, and
is used for product updates that do not require regeneration
of the Subject Cross Reference tables.
 
 
 
Other tables created by Document Access include:
 
  DOCCAT   - Document Management Print Request Table,
             which is created automatically the first time
             that any user requests the Document Print option
             from Document Access.
 
  DOCBMKP4 - User-level Bookmark Table in MICS.USER.TABLES,
             which is created automatically the first time
             that each user invokes Document Access.
 
 
Document Access Installation Notes:
 
If default values set in Document Access need to be changed
globally for all Document Access users, the following modules
should be reviewed and changed accordingly:
 
    o  sharedprefix.MICS.ISPSLIB(DOCAG09S)
 
       -  If your CA MICS cataloged procedures reside in a
          user-specified procedure library, there are two
          ways to specify that library in generated JCL.
 
          To use the PROCLIB that may have been specified in
          sharedprefix.MICS.PARMS(JCLDEFC), uncomment the
          )SEL, //DOCAG09S, and )ENDSEL statements by
          removing the )CM characters.  (The PROCLIB
          definition statement in JCLDEFC is optional.)
 
          To ensure that a specific PROCLIB is always used,
          uncomment only the //DOCAG09S statement and code it
          to specify that PROCLIB.
 
       -  If you do not have lowercase print capability and
          want all Document Print jobs to translate output to
          uppercase, uncomment the )SEL DOCACASE statement
          by removing the )CM characters.
 
       -  If you want to print something other than 60 lines
          per page, set xx to your desired page size.  Then
          uncomment the )SEL DOCASPAR statement by removing
          the )CM characters.
 
       To illustrate, if all of the above changes were made,
       the DOCAG09S member would look similar to this:
 
       )CM
       )SET DOCACASE = 'UCASE'
       )SET DOCASPAR = 'NLINES=66'
       )SEL @DOCAMPRC NE @Z
       //DOCAG09S JCLLIB  ORDER=(@DOCAMPRC)
       )ENDSEL
 
    o  sharedprefix.MICS.ISPPLIB(DOCAI00P)
 
       Sample options are described in the panel module as
       )PROC section comments.  They include options such as
       overriding the default SYSOUT print destination for
       text printing, allowing for unusual high-level name
       qualifiers for the user's browse data sets, and
       setting all text output to uppercase.
 
       Any one of the comment lines can be uncommented by
       removing the initial /* and customized according to
       your needs.
 
       For example, this statement would change the number of
       lines per page to 66:
 
       &DOCASPAR = 'NLINES=66'     /* PRINT LINES PER PAGE */