ADDSCHIDXE (Add Search Index Entry)

ADDSCHIDXE Command syntax diagram

 

Purpose

The Add Search Index Entry (ADDSCHIDXE) command is used to load help text topics into a search index.

A search index refers to help text from one or more panel groups. A panel group contains help text, which the user can access from display panels by pressing the Help key, or through the information search function using the Start Search Index (STRSCHIDX) command.

The sequence in which panel groups are loaded into a search index controls the sequence in which topic entries are presented when an information search is requested. The topics (ISCH tag entries) from the first-loaded panel group are presented first.

 

Restrictions

1. The user must have *CHANGE authority for the search index that is being loaded and *USE authority for the panel group.
   
2. Only user-created panel groups can be added to user-created search indexes and only IBM-supplied panel groups can be added to IBM-supplied search indexes.
   
3. Panel group names must be unique within a search index.

 

Required Parameters

SCHIDX

Specifies the qualified name of the search index into which entries are loaded.

The name of the search index can be qualified by one of the following library values:

*LIBL: All libraries in the job's library list are searched until the first match is found.

*CURLIB: The current library for the job is searched. If no library is specified as the current library for the job, the QGPL library is used.

library-name: Specify the name of the library to be searched.

search-index-name: Specify the name of the search index.

PNLGRP

Specifies the qualified name of the panel group that contains the help text for which entries are to be loaded into the search index.

The search index object contains the name and library of the panel group. When help text is displayed for a search index, the name and library of the panel group that is contained in the search index object is used to find the panel group.

When *LIBL is used to qualify the panel group name, *LIBL is saved in the search index object. When the panel group name is qualified with either a library name or *CURLIB, the name of the library containing the panel group is saved in the search index object.

The names of panel groups added to the search index must be unique.

The name of the panel group can be qualified by one of the following library values:

*LIBL: All libraries in the job's library list are searched until the first match is found.

*CURLIB: The current library for the job is searched. If no library is specified as the current library for the job, the QGPL library is used.

library-name: Specify the name of the library to be searched.

panel-group-name: Specify the name of the panel group.

Example for ADDSCHIDXE

ADDSCHIDXE   SCHIDX(ACCOUNTING)  PNLGRP(PAYROLL)

This command adds panel group PAYROLL to search index ACCOUNTING. Both the panel group and the search index must exist in the library list.

Error messages for ADDSCHIDXE

*ESCAPE Messages

CPF6E07

Panel group cannot be added to search index.

CPF6E08

Panel group cannot be added to search index.

CPF6E09

Panel group does not contain any synonyms or root words.

CPF6E12

Panel group not added to search index.

CPF6E47

Panel group &1 cannot be added to search index &3

CPF6E48

Panel group &1 cannot be added to search index &3

CPF6E49

Panel group &1 cannot be added to search index &3

CPF6E61

Panel group &1 cannot be added to search index &3.

CPF6E62

Panel group &1 already exists in search index &3.

CPF6E63

Error occurred while trying to recover from another error.