HELP

HELP (SHOW) explains CA OLQ commands and provides information about the data accessed by the current subschema. HELP and SHOW are synonymous.

Access mode: Some HELP parameters are invalid when the access switch is set to IDMS.

Syntax:

►►─┬─ HELp ─┬─────────────────────────────────────────────────────────────────►
   └─ SHOw ─┘

 ►─┬────────────────────────────────────────────────────────────────────────┬─►─
   ├─┬─ BUIltin functions ─┬─┬─────┬─┬─────────────────────────┬────────────┤
   │ └─ BIF ───────────────┘ └─ = ─┘ ├─ ALL ◄ ─────────────────┤            │
   │                                 ├─ AGGregate ─────────────┤            │
   │                                 ├─ NONaggregate ──────────┤            │
   │                                 └─ builtin-function-name ─┘            │
   ├─ COMmands ─────────────────────────────────────────────────────────────┤
   ├─ COMmand ─┬─────┬─ command-name ───────────────────────────────────────┤
   │           └─ = ─┘                                                      │
   ├─ DEStination                                                           │
   ├─ DIRectory ─┬────────────────────────────┬─────────────────────────────┤
   │             └─ USEr ─┬─────┬─ user-name ─┘                             │
   │                      └─ = ─┘                                           │
   ├─┬─ FUNctions ─┬────────────────────────────────────────────────────────┤
   │ └─ PFKey ─────┘                                                        │
   ├─┬─ FUNction ─┬─┬─────┬── control-key-value ────────────────────────────┤
   │ └─ PFKey ────┘ └─ = ─┘                                                 │
   ├─┬─ LOGical records ─┬─┬──────────────────────────┬─────────────────────┤
   │ └─ LRS ─────────────┘ └─ VIEw ─┬─────┬─ view-id ─┘                     │
   │                                └─ = ─┘                                 │
   ├─ MESsage ─┬─────┬─ message-id ─────────────────────────────────────────┤
   │           └─ = ─┘                                                      │
   ├─ OPTions ──────────────────────────────────────────────────────────────┤
   ├─ PATh ─────────────────────────────────────────────────────────────────┤
   ├─ QFIles ─┬────────────────────────────┬────────────────────────────────┤
   │          └─ dictionary-specification ─┘                                │
   ├─ QFIle ─┬─────┬─ qfile-name ┬───────────┬─┬──────────────────────────┬─┤
   │         └─ = ─┘             └ (version) ┘ └ dictionary-specification ┘ │
   ├─ RECords ─┬──────────────────────────┬─────────────────────────────────┤
   │           └─ VIEw ─┬─────┬─ view-id ─┘                                 │
   │                    └─ = ─┘                                             │
   ├─ RECord ─┬─────┬─┬─ record-name ─────────┬─┬────────────────────────┬──┤
   │          └─ = ─┘ └─ logical-record-name ─┘ └─ VIEw ─┬───┬─ view-id ─┘  │
   │                                                     └ = ┘              │
   └─ REPort ─┬──────────────────────────────────────────────────────┬──────┘
                  └─┬─────┬─ report-name ─┬────────────────────────────┬─┘
                    └─ = ─┘               └─ USEr ─┬─────┬─ user-name ─┘
                                                   └─ = ─┘

─►─┬────────────────────────────────────────────────────────────────────────┬─►◄
   ├─┬─ SUBschemas ─┬─┬────────────────────────────┬────────────────────────┤
   │ └─ SS ─────────┘ └─ dictionary-specification ─┘                        │
   └─ TABles ─┬─────────────────┬───────────────────────────────────────────┘
              └─ table-options ─┘

Expansion of dictionary-specification

►►─┬──────────────────────────────────────┬───────────────────────────────────►
   └─ DICtname ─┬─────┬─ dictionary-name ─┘
                └─ = ─┘

 ►─┬──────────────────────────────────────┬───────────────────────────────────►◄
   └─ DICTNOde ─┬─────┬─ dictionary-node ─┘
                └─ = ─┘

Expansion of table-options

►►─┬────────────────────────────────────────┬─────────────────────────────────►
   ├─ DICtname ─┬─┬─────┬─ dictionary-name ─┘
   └─ CATalog ──┘ └─ = ─┘

 ►─┬──────────────────────────────────────┬───────────────────────────────────►
   └─ LOCation ─┬─────┬─ dictionary-node ─┘
                └─ = ─┘

 ►─┬─────────────────────────────┬────────────────────────────────────────────►
   └─ OWNer ─┬─────┬─ user-name ─┘
             └─ = ─┘

 ►─┬────────────────────────────────┬─────────────────────────────────────────►◄
   └─ SCHema ─┬─────┬─ schema-name ─┘
              └─ = ─┘

Parameters:

BUILTIN FUNCTIONS

Lists information about built-in functions:

ALL—Lists all the built-in function commands.
AGGREGATE—Lists all the aggregate functions.
An aggregate function is one whose argument includes one or more columns and operates on one or more values in each column. A few examples are SUM, AVERAGE, and COUNT.
NONAGGREGATE—Lists all the nonaggregate functions.
A nonaggregate function is one whose argument includes a single value within a column and only operates that value. A few examples are LOG10, MODULO, and ABSOLUTE-VALUE.
builtin-function-name—Lists information about a particular built-in function.

COMMANDS

Lists the syntax and definitions of all CA OLQ commands.

COMMAND= command-name

Lists the syntax for the specified CA OLQ command.

Example:

HELP SIGNON lists syntax for the SIGNON command.

DESTINATION

Lists printer classes and destinations defined for the CA IDMS/DC or CA IDMS UCF system under which CA OLQ is executing. These printer classes and destinations can be specified in the PRINT command.

DIRECTORY USER= user-name

Lists all saved CA OLQ report files for a specified user. USER=user-name is an optional qualifier; user-name defaults to the current user. You must have a browse passkey for the specified user in order to see the directory.

FUNCTIONS

Lists CA OLQ commands associated with control keys for command mode.

FUNCTION= control-key-value

Displays the CA OLQ command associated with the named control key.

LOGICAL RECORDS

Displays the following information:

Access mode: This parameter is invalid when the access switch is set to IDMS.

All logical records defined in the current subschema associated with an OBTAIN PATH command
Any keywords associated with each logical record's OBTAIN path
Any comments associated with each logical record
VIEW=view-id—The qualifying ID for the record or logical record name. Use view-id when you are signed on to multiple subschemas. View-id refers to the subschema where the record (or logical record) can be found.

MESSAGE= message-id

Lists detailed information about the CA OLQ error message identified by message-id.

OPTIONS

Lists all session options, indicating the current setting and the alternate setting for each option.

PATH

Displays the sequence of CA OLQ retrieval commands for the current path definition, including the WHERE criteria.

Access mode: This parameter is invalid when the access switch is set to IDMS.

QFILES

In secure installations, lists all qfiles in the data dictionary associated with the signed on user. In installations that do not use CA OLQ security features, lists all qfiles defined in the data dictionary.

dictionary-specification—Specifies the dictionary and dictionary node containing the named qfile.

QFILE= qfile-name

Displays the CA OLQ commands that make up the named qfile.

(version)—Specifies the version number of the named qfile.
dictionary-specification—Specifies the dictionary and dictionary node containing the named qfile.

RECORDS

Lists all database record types and set relationships defined in the current subschema.

Access mode: This parameter is invalid when the access switch is set to IDMS.

VIEW=view-id—The qualifying ID for the record or logical record name. Use view-id when you are signed on to multiple subschemas. View-id refers to the subschema where the record (or logical record) can be found.

RECORD=

Lists subschema fields and their usage.

Access mode: This parameter is invalid when the access switch is set to IDMS.

record-name—Specifies the data record type.
logical-record-name—Specifies the logical record type.
- VIEW=view-id—The qualifying ID for the record or logical record name. Use view-id when you are signed on to multiple subschemas. View-id refers to the subschema where the record (or logical record) can be found.

REPORT= report-name

Displays a detailed description of the named report. When not specified, report-name defaults to the name of the current report.

USER=user-name— Optional qualifier that allows a user to view report files saved by other users. This parameter is effective only if the user has been assigned the passkeys necessary for accessing other user's reports.

SUBSCHEMAS

Lists the subschemas available to the current user.

DICTNAME= dictionary-name—Specifies the dictionary containing the specified subschemas. DICTNAME can be used to list information saved in other dictionaries without requiring you to sign on to them.
DICTNODE= dictionary-node—Specifies the dictionary node. DICTNODE can be used to list information saved in other dictionaries without requiring you to sign on to them.
dictionary-specification—Specifies the dictionary and dictionary node containing the named qfile.

TABLES

Lists the tables saved by the current or named user.

When the access switch is set to idms, CA OLQ only lists SQL schema entries to which the user has access.

Note: For more information about access switch, see, SET later in this chapter.

table-options

Explicitly identifies where the list of tables originates:

DICTNAME/CATALOG=dictionary-name —Specifies the dictionary under which the tables are saved.
LOCATION=dictionary-node —Specifies the dictionary node name.
Access mode:This parameter is invalid when the access switch is set to IDMS.
OWNER=user-name—Allows you to view the ASF tables of a specific user. To view another user's tables, you must have BROWSE passkey authorization for the user's directory.
Access mode: This parameter is invalid when the access switch is set to IDMS.

Note: For further information on passkeys, see &U$ICMSAD.
SCHEMA=schema-name—Allows you to view the SQL tables and views associated with the schema-name.
Access mode: This parameter is invalid when the access switch is set to OLQ.

Examples:

HELP DESTINATION

The following HELP DESTINATION command lists available printer classes and destinations:

help destination

PRINT CLASSES/DESTINATIONS     PAGE 1.1
                               LINE 1
(LTERM) (CLASS/DESTINATION)

PRT7026     CLASS=06
PRT7025     CLASS=63
PRT7024     CLASS=01
PRT7023     CLASS=05
PRT7022     CLASS=60
PRT7021     CLASS=02
PRT7020     CLASS=23
PRT7019     CLASS=25
PRT7018     CLASS=54
PRT7017     CLASS=53
PRT7016     CLASS=52
PRT7015     CLASS=51
PRT7014     CLASS=11
PRT7013     CLASS=02
PRT7012     CLASS=02
PRT7011     CLASS=02,04
PRT7010     CLASS=24
PRT7009     CLASS=07,21
            DEST=01,02,03,04,05

HELP QFILES

In the example below, a HELP QFILES command displays the qfiles available to the user currently signed on:

help qfiles

AVAILABLE QFILES     PAGE 1.1
                     LINE 1
  (QFILE NAME)

DICTIONARY NAME   *DEFAULT*
DICTIONARY NODE   *DEFAULT*

SRKITEM(1)
CNUMORD(1)
CNAMORD(1)
CUSTITEM(1)
ORDITEM(1)
EMP-REPT-01(100)
EMP-REPT(100)
EMP-REPT(1)
EMP-PROF(1)
DENTAL(1)
EMP-SKILL(1)

HELP RECORDS

The following HELP RECORDS command displays all database record types and set relationships defined in the current subschema:

help records RECORDS IN EMPSS01 PAGE 1.1 LINE 1 (RECORD NAME) (OWNS SETS) (MEMBER OF SETS) STRUCTURE MANAGES VIA MANAGES REPORTS-TO SKILL SKILL-EXPERTISE SKILL-NAME-NDX CALC: SKILL-ID-0455 OFFICE OFFICE-EMPLOYEE CALC: OFFICE-CODE-0450 NON-HOSP-CLAIM COVERAGE-CLAIMS VIA COVERAGE-CLAIMS JOB JOB-EMPOSITION JOB-TITLE-NDX CALC: JOB-ID-0440 INSURANCE-PLAN CALC: INS-PLAN-CODE-0435 PF 08

RECORDS IN EMPSS01 PAGE 2.1 LINE 18 (RECORD NAME) (OWNS SETS) (MEMBER OF SETS) HOSPITAL-CLAIM COVERAGE-CLAIMS VIA COVERAGE-CLAIMS EXPERTISE EMP-EXPERTISE VIA EMP-EXPERTISE SKILL-EXPERTISE EMPOSITION EMP-EMPOSITION VIA EMP-EMPOSITION JOB-EMPOSITION EMPLOYEE EMP-COVERAGE DEPT-EMPLOYEE CALC: EMP-ID-0415 EMP-EMPOSITION EMP-NAME-NDX EMP-EXPERTISE OFFICE-EMPLOYEE MANAGES REPORTS-TO DEPARTMENT DEPT-EMPLOYEE

HELP RECORD=EMPLOYEE

The following HELP RECORD=EMPLOYEE command displays the subschema fields and descriptions for the EMPLOYEE database record:

help record=employee

                EMPLOYEE      PAGE 1.1
                              LINE 1
(LEVEL)      (FIELD NAME)      (USAGE) (PICTURE)

  02    EMP-ID-0415             DISPLAY   9(4)
  02    EMP-NAME-0415           GROUP
  03    EMP-FIRST-NAME-0415     DISPLAY   X(10)
  03    EMP-LAST-NAME-0415      DISPLAY   X(15)
  02    EMP-ADDRESS-0415        GROUP
  03    EMP-STREET-0415         DISPLAY   X(20)
  03    EMP-CITY-0415           DISPLAY   X(15)
  03    EMP-STATE-0415          DISPLAY   X(2)
  03    EMP-ZIP-0415            DISPLAY   X(5)
  02    EMP-HOME-PHONE-0415     DISPLAY   9(10)
  02    STATUS-0415             DISPLAY   X(2)
  02    SS-NUMBER-0415          DISPLAY   9(9)
  02    START-DATE-0415         GROUP
  03    START-YEAR-0415         DISPLAY   9(2)

HELP SUBSCHEMAS

The following HELP SUBSCHEMAS command lists the subschemas available to the current user:

help subschemas dictname=docanwk

    AVAILABLE SUBSCHEMAS     PAGE 1.1
                             LINE 1
    (SCHEMA)     (SUBSCHEMA)

 DICTIONARY NAME  DOCANWK
 DICTIONARY NODE  *DEFAULT*

 EMPSCHM(2)       EMPSS01
 EMPSCHM(100)     EMPSS01
                  EMPSS09
                  NEWVIEW
                  OLDVIEW
 TEST(100)        SUBTEST

For more information:

Built-In Functions and Syntax