3. Installation › 3.6 Finalize Database Complex › 3.6.1 Produce CA MICS Documentation
3.6.1 Produce CA MICS Documentation
CA MICS generates printed documents from MWF Document Access
or from a batch job. We recommend producing documents from
Document Access, an ISPF panel-driven facility for selecting
documents to print. Document Access includes full tutorial
support.
Activate the CA MICS Workstation Facility as explained in
Section 3.3.6 of this guide and select Option 1 for Document
Access.
CA MICS also provides backup methods for printing documents,
including jobs to assist you in producing your own copies of
the CA MICS documentation. These facilities can produce all
of the CA MICS guides or any individual guide. The jobs,
described below, are available for use after the CA MICS
database complex is fully defined.
If you need to produce CA MICS documentation prior to
installing the database complex, the EARLYDOC job in
sharedprefix.MICS.CNTL can be used after the CA MICS
production libraries have been loaded from the distribution
tape. Documentation produced before products are generated
reflects the default component definitions shipped with the
system.
IMPORTANT NOTES:
If you do not have upper and lower case printing
capability, a translation feature is available as part of
the document production facility. It is discussed in the
section on the MICSDOC Procedure that follows.
The DOCUMENT print program assumes a page size of 60
lines. If the paper you use will not hold 60 lines on a
page, there is an option to change the number of lines
per page. It is discussed in the section on the MICSDOC
Procedure that follows.
Guides for optional CA MICS products, and chapters or
sections of guides for these optional products, are not
available for printing unless you have the products
installed.
The sharedprefix.MICS.CNTL(DOCUMENT) job can be used to
print CA MICS guides. The DOCUMENT job uses the MICSDOC
procedure described below. You adjust this job's JES
parameters to verify that it will print all of the lines
it produces. In this case, a permanent change must be
made to the JCLINFO member of sharedprefix.MICS.PARMS
before you regenerate the DOCUMENT job.
MICSDOC Procedure:
To produce a single guide, build and submit the following
job:
//jobname JOB
//S1 EXEC MICSDOC,MANUAL=x
where "x" must be a one or two character value corresponding
to one the CA MICS documents listed below:
AH - CA MICS Tandem Option Guide
AI - CA MICS CA ASTEX Option Guide
BE - CA MICS How to Use the PSP
BS - CA MICS System Administrator Guide
C - CA MICS Network Analyzer Option Guide
CK - CA MICS Space Collector Option Guide
CL - CA MICS IMS Log Data Extractor Option Guide
CM - CA MICS Data Transfer Option for VM/CMS Guide
FB - CA MICS Analyzer for TSO Guide
FC - CA MICS Hardware and SCP Analyzer Guide
FD - CA MICS Batch and Operations Analyzer Guide
FE - CA MICS Analyzer Option for CICS Guide
FG - CA MICS Analyzer Option for IMS Guide
FH - CA MICS System Reliability Analyzer Option Guide
FI - CA MICS Analyzer Option for VM/CMS Guide
FJ - CA MICS Space Analyzer Option Guide
FM - CA MICS Analyzer Option for MeasureWare Guide
FN - CA MICS Analyzer Option for DB2 Guide
FO - CA MICS Analyzer Option for MQSeries Guide
FQ - CA MICS Analyzer Option for VSE/Power Guide
FT - CA MICS Tape Analyzer Option Guide
FV - CA MICS Analyzer Option for VAX/VMS Guide
FW - CA MICS Web Analyzer Option Guide
H - CA MICS Standard Reports Guide
I - CA MICS Database Structure and Content Guide
JD - CA MICS Document Access Guide
JR - CA MICS MICF Reference Guide
JU - CA MICS MICF User Guide
L - CA MICS Planning, Installation, Operation, and
Maintenance Guide
M - CA MICS System Modification Guide
PA - CA MICS Capacity Planner Option Guide
PD - CA MICS Performance Manager Option Guide
PG - CA MICS StorageMate Option Guide
PK - CA MICS Accounting and Chargeback Option
Concepts and Overview Guide
PL - CA MICS Accounting and Chargeback Option User Guide
W - CA MICS Analyzer Option for CA IDMS Guide
To produce several documents, build and submit a multistep
job like the following:
//jobname JOB
//S1 EXEC MICSDOC,MANUAL=x
//S2 EXEC MICSDOC,MANUAL=y
where "x" and "y" are any of the one or two character manual
ID values shown above.
To produce only selected chapters of a document, build and
submit a job as above, but qualify the MANUAL= value with a
chapter number. For example, to produce the chapters
discussing the Hardware and SCP information areas in the
Hardware and SCP Analyzer Guide, the following job would be
built:
//jobname JOB
//*
//S1 EXEC MICSDOC,MANUAL=FC5 Files for both areas
//S2 EXEC MICSDOC,MANUAL=FCXD Data Dictionary
To request multiple copies of the printout from MICSDOC, use
the COPIES parameter as in the following example.
//S1 EXEC MICSDOC,MANUAL=x,COPIES=2
If you do not have upper and lowercase printing at your site,
request the translation of all text to all uppercase
characters as follows:
//jobname JOB
//S1 EXEC MICSDOC,MANUAL=x,CASE=UCASE
where "x" is any of the values shown above.
In addition to the lower to uppercase translation, this
option translates certain special characters to other
characters more commonly found on printers that do not
support lowercase printing. This translation includes
translating vertical bar to "I" and underscore to ".".
If you use paper that will not hold 60 lines of output per
page, change the number of lines of output per page by using
the NLINES option. For example, to request 55 lines per
page, code:
//jobname JOB
//S1 EXEC MICSDOC,MANUAL=x,SYSPARM='NLINES=55'
The value for NLINES ranges from 20 to 60.
Much of the document text is formatted assuming 60 lines per
page (e.g., full page figures of report output). For this
reason, NLINES should not be used unless required, and if
used, the value for NLINES should be as close to 60 as
possible.
When printing CA MICS documentation, use the SNUM option if
you want to print Table of Contents entries without document
section numbers. For instance, this section would typically
be listed as follows in the Detail Table of Contents.
3.6.1 Produce CA MICS Documentation . . . . . . page #
Code the SNUM option in the SYSPARM field to suppress text
section numbering.
//jobname JOB
//S1 EXEC MICSDOC,MANUAL=x,SYSPARM='SNUM'
By default, MICSDOC prints text section numbers in the table
of contents.
For printing the text of the guides, the MICSDOC procedure
uses the SYSOUT specification you gave on the DOCUMENT
parameter in sharedprefix.MICS.PARMS(JCLDEFC) when the
CA MICS system JCL was generated.
EARLYDOC Job:
The EARLYDOC job is used to print a CA MICS guide or guide
chapter once the CA MICS production libraries have been
loaded from the distribution tape. This job requires the use
of SAS, but not necessarily the CA MICS copy.
Review and complete the job card and the parameters on the
EXEC statement of sharedprefix.MICS.CNTL(EARLYDOC). The EXEC
statement is as follows:
//DOC EXEC MICSDOC,
// MANUAL='__', <-- REQUIRED
// WKUNIT='SYSDA', <-- REQUIRED
// SHRPFX='sharedprefix.MICS', <-- NO TRAILING PERIOD
//*
// SASNAME='entry', <-- SASHOST for V8
//* SAS for V9
// SASPFX='sas.prefix', <-- NO TRAILING PERIOD
//*SASENV='TKMVSENV(TKMVSENV)', <-- Environment File if
//* SAS >= 9.1.3
//* Uncomment if you have
//* this library
//* If you do NOT have this
//* file you MUST comment
//* the TKMVSENV DDs as the
//* job will abend if it
//* does not refer to the
//* actual library
// SASCFG1='config', <-- CNTL(BATCH) IF SAS V8
//* CNTL(BATW0) IF SAS 9.1.3
//* CONFIG(BATCH) SAS >=9.2
//* For SAS >=9.2 uncomment
//* and specify next 3:
//*SASCFG2='CONFIG(COMMON)', CONFIG(COMMON)
//*SASCFG3='CONFIG(ENW0)', CONFIG(ENW0)
//*SASCFG4='CONFIG(SITE)', CONFIG(SITE)
//*
//*AUTOLIB='fixed.block.AUTOLIB',<-- For 9.1.3 only
//* uncomment and
//* point to FB version
//* of SAS AUTOCALL library
//*
// LANG1='', <-- SAS V9 LANGUAGE
//* EN = English
//* blank if V8
// LANG2='', <-- SAS V9 encoding value
//* W0. = EBCDIC (1047)
//* MUST HAVE TRAILING .
//* blank if V8
//*
// CASE=, <-- UPPER CASE ? (UCASE)
// DOCOUT='A', <-- OUTPUT SPEC FOR GUIDE
// SYSPARM=' ' <-- DOCUMENT OPTIONS
EARLYDOC uses an instream version of the standard MICSDOC
procedure. Therefore, use of the MANUAL, CASE, and SYSPARM
parameters is the same as described above for the DOCUMENT
job.
The parameters required to execute the MICSDOC instream
procedure in EARLYDOC follow. Specify the values
for these parameters. The defaults provided for all other
parameters are usually adequate, though you must verify
that these values are valid for your installation before
submitting the job.
WKUNIT
The unit for the SYSUT3 and SYSUT4 work data sets needed
by IEBCOPY.
SHRPFX
The sharedprefix for the database complex. Include the CA
MICS level node as needed by your site. Note that this
name is specified with no trailing period.
SASNAME
The library member name of the SAS program to be used,
also called the entry point name. Typically this is
SASHOST for version 8, and SAS for version 9.
SASPFX
The common data set name prefix for your SAS libraries.
Specify the sharedprefix name without trailing period.
SASENV
The name of the SAS environment file. The TKMVSENV file
is used to make a list of pseudo environment variables.
Option values in SAS configuration files can contain
symbolic references. The values of these symbolic
references are resolved from a variable that is set in
the TKMVSENV file. If your installation used symbolic
references in your SAS configuration files, specify this
data set.
SASCFG1-4
The data set name qualifier and member name of your SAS
configuration files. Specify only SASCFG1 for SAS
versions 8 and 9.1.3. Typically the value is CNTL(BATCH)
for SAS version 8 and CNTL(BATW0) for SAS version 9.1.3.
For SAS version 9.2 or above, SASCFG1 is typically
CONFIG(BATCH). To specify additional configuration files
for SAS version 9.2 or above, uncomment SASCFG2, SASCFG3
and SASCFG4. The values are normally CONFIG(COMMON),
CONFIG(ENW0), and CONFIG(SITE). The full data
set names are built by prefixing the value of SASPFX.
AUTOLIB
The SAS AUTOCALL library that is being converted to fixed
block with SAS 9.1.3. It is not required for SAS Version
9.2 and higher.
LANG1
The language code required with SAS versions 9 and
higher, for example, EN stands for English. The value is
blank for SAS version 8.
LANG2
The encoding value required with SAS version 9 and
higher. The value for EBCDIC is W0 and must have a
trailing period (.). The value is blank for SAS version
8.
When you have completed editing the job, submit it by coding
the following to print a CA MICS guide or chapter using the
default document text shipped with the system.
SUB 'sharedprefix.MICS.CNTL(EARLYDOC)'
