Create Search Index (CRTSCHIDX)

The Create Search Index (CRTSCHIDX) command creates a search index. A search index is used to refer to the help information contained in one or more panel groups.

You can access a search index through data description specifications (DDS) by pressing the HELP key, or through the index search function using the Start Search Index (STRSCHIDX) command.

A search index created by the CRTSCHIDX command does not contain any data. Add data using the Add Search Index Entry (ADDSCHIDXE) command.

Restrictions:

You must have add (*ADD) authority for the library where the search index is to be located.
IBM-supplied panel groups cannot be added to a search index created with the CRTSCHIDX command; only panel groups created with the Create Panel Group (CRTPNLGRP) command can be added to a search index created with the CRTSCHIDX command.

Parameters

Keyword	Description	Choices	Notes
SCHIDX	Search index	Qualified object name	Required, Positional 1
	Qualifier 1: Search index	Name
	Qualifier 2: Library	Name, *CURLIB
TITLE	Display title	Character value	Required, Positional 2
TEXT	Text 'description'	Character value, TITLE, BLANK	Optional
CHRID	Character identifier	Single values: SYSVAL Other values: Element list*	Optional
	Element 1: Graphic character set	Integer
	Element 2: Code page	Integer
AUT	Authority	Name, LIBCRTAUT, CHANGE, ALL, USE, *EXCLUDE	Optional

Top

Search index (SCHIDX)

Specifies the search index to be created.

This is a required parameter.

Qualifier 1: Search index

name: Specify the name of the search index.

Qualifier 2: Library

*CURLIB: The current library for the job is used to create the search index. If no library is specified as the current library for the job, QGPL is used.
name: Specify the name of the library where the search index is to be created.

Character identifier (CHRID)

Specifies the graphic character set and code page values used for the search index. The value specified for this parameter must match the TXTCHRID parameter value of panel groups added to this search index.

Single values

*SYSVAL: The system determines the graphic character set and code page values for the command parameters from the QCHRID system value.

Element 1: Graphic character set

integer: Specify the graphic character set value that matches the character set of the synonyms that will be used in the search index.

Element 2: Code page

integer: Specify the code page value that matches the code page of the synonyms that will be used in the search index.

Authority (AUT)

Specifies the authority you are giving to users who do not have specific authority for the object, who are not on an authorization list, and whose group profile or supplemental group profiles do not have specific authority for the object.

*LIBCRTAUT: The system determines the authority for the object by using the value specified for the Create authority (CRTAUT) parameter on the Create Library command (CRTLIB) for the library containing the object to be created. If the value specified for the CRTAUT parameter is changed, the new value will not affect any existing objects.

*CHANGE: The user can perform all operations on the object except those limited to the owner or controlled by object existence (*OBJEXIST) and object management (*OBJMGT) authorities. The user can change and perform basic functions on the object. *CHANGE authority provides object operational (*OBJOPR) authority and all data authority. If the object is an authorization list, the user cannot add, change, or remove users.

*ALL: The user can perform all operations except those limited to the owner or controlled by authorization list management (*AUTLMGT) authority. The user can control the object's existence, specify the security for the object, change the object, and perform basic functions on the object. The user also can change ownership of the object.

*USE: The user can perform basic operations on the object, such as running a program or reading a file. The user cannot change the object. Use (*USE) authority provides object operational (*OBJOPR), read (*READ), and execute (*EXECUTE) authorities.

*EXCLUDE: The user cannot access the object.

name: Specify the name of an authorization list to be used for authority to the object. Users included in the authorization list are granted authority to the object as specified in the list. The authorization list must exist when the object is created.

Examples

CRTSCHIDX   SCHIDX(ACCOUNTING)  TITLE('Accounting Help Index')
            TEXT('Accounting Help Index')

This command creates a search index named ACCOUNTING in the current library.