Previous Topic

Next Topic

Book Contents

Book Index

Doc Library/ Doc Path

For a z/OS job, Doc Library defines the name of the library where the Documentation (description) is saved. For a non-z/OS job, Doc Path defines the name of the file path where the Documentation is saved. (This is specified in the Doc Member/ Doc File parameter).

Additional information

Description

Usage

Optional

Length

  • Microsoft Windows and UNIX: 1-255 characters
  • iSeries (AS/400): 1-21 characters
  • OpenVMS: 1-60 characters
  • z/OS: 1-44 characters

Case Sensitive

Yes

Invalid Characters

z/OS: Non-English characters

Variable Name

None

Alternate Names

  • Control‑M/EM Utilities: DOCLIB
  • Reporting Facility: DOC LIB
  • Control‑M/Server Utilities:‑doclib
  • Control‑M for z/OS: DOCLIB
  • Control‑M/EM API: doc_lib

Computer specific information

UNIX

Specify the name of the directory and subdirectories (if any). One of the following symbols can be used in place of or as part of the directory or subdirectory name (these symbols are resolved at the time the job is ordered or forced):

  • $HOME resolves to the home directory of the job owner.
  • ~<username> resolves to the home directory of the specified UNIX user.

iSeries (AS/400)

You must specify one of the following:

  • Name of an iSeries (AS/400) library
  • Library / File
  • *LIBL (library list)
  • *CURLIB (current library)

OpenVMS

The directory can be specified as the physical path or as an OpenVMS logical name.

The library or directory specified by this parameter, and the file specified in the Doc Member/ Doc File parameter, do not have to exist when the job processing parameters are defined.

If you specify this parameter, you must also specify a value for the Doc Member/ Doc File parameter.

NOTE: To access the documentation the user must be defined and have authorization on the Control-M/Server where the documentation resides

EXAMPLE: OpenVMS

DUA0:[ACCOUNT.DOC], ACCDOC$DIR

UNIX

$HOME/ctm/account/doc

Parent Topic

General parameters