Aller au contenu

CRTSCHIDX

Créer un index d'aide

En bref

La commande CRTSCHIDX crée un index d'aide.

CRTSCHIDX se lit CRT (Créer) + SCHIDX. Sur IBM i, le nom d'une commande associe presque toujours un verbe et un objet.

Syntaxe minimale

CRTSCHIDX SCHIDX(…) TITLE(…)

Paramètres

  • SCHIDX Index d'aide obligatoire
  • TITLE Titre à afficher obligatoire
  • TEXT Texte 'descriptif'
  • CHRID Identificateur de caractères
  • AUT Droits

Astuce : dans une session 5250, tapez CRTSCHIDX puis F4 pour l'invite de saisie, et F1 sur un paramètre pour son aide.

Aide IBM i de la commande

Texte du F1, IBM i 7.5 en français (bibliothèque QSYS)

Où s'exécute : Tous les environnements (*ALL)
Compatible multitâche : Non

La commande CRTSCHIDX crée un index d'aide. Un index d'aide fait référence à l'aide en ligne contenue dans un ou plusieurs groupes de panneaux.

Vous pouvez accéder à l'index d'aide au moyen des DDS (Spécifications de description de données), de la touche d'aide ou de la commande STRSCHIDX (Démarrer l'index d'aide) via la fonction d'aide par index.

Un index d'aide créé à l'aide de la commande CRTSCHIDX ne contient pas de données. Pour ajouter des données, utilisez la commande ADDSCHIDXE (Ajouter un poste d'index d'aide).

Restrictions :

  • Vous devez disposer du droit d'ajout (*ADD) sur la bibliothèque qui contient l'index d'aide.
  • Les groupes de panneaux fournis par IBM ne peuvent pas être ajoutés dans un index d'aide créé avec la commande CRTSCHIDX ; seuls les groupes de panneaux créés à l'aide de la commande CRTPNLGRP (Créer un groupe de panneaux) peuvent être ajoutés dans un index d'aide créé avec la commande CRTSCHIDX.

Paramètres

Mot-clé Description Valeurs possibles Remarques
SCHIDX Index d'aide Nom d'objet qualifié Obligatoire, positionnel 1
Qualificatif 1: Index d'aide Nom
Qualificatif 2: Biblio Nom, *CURLIB
TITLE Titre à afficher Valeur caractère Obligatoire, positionnel 2
TEXT Texte 'descriptif' Valeur caractère, *TITLE, *BLANK Facultatif
CHRID Identificateur de caractères Valeurs uniques: *SYSVAL
Autres valeurs: Liste d'éléments
Facultatif
Élément 1: Jeu de caractères graphiques Entier
Élément 2: Page de codes Entier
AUT Droits Nom, *LIBCRTAUT, *CHANGE, *ALL, *USE, *EXCLUDE Facultatif

Index d'aide (SCHIDX)

Indique l'index d'aide à modifier.

Ce paramètre est obligatoire.

Qualificatif 1 : Index d'aide

nom
Indiquez le nom de l'index d'aide.

Qualificatif 2 : Biblio

*CURLIB
La bibliothèque en cours du travail est utilisée pour créer l'index d'aide. Si aucune bibliothèque en cours n'est précisée pour le travail, QGPL est prise par défaut.
nom
Indiquez le nom de la bibliothèque où l'index d'aide doit être créé.

Titre à afficher (TITLE)

Indique le titre que vous souhaitez voir apparaître en haut de l'écran des sujets choisis sur lequel les informations de recherche sont affichées.

Ce paramètre est obligatoire.

valeur-alphanumérique
Indiquez, entre apostrophes, un texte de 55 caractères au maximum.

Texte 'descriptif' (TEXT)

Texte décrivant brièvement l'objet.

*TITLE
Il s'agit des 50 premiers caractères du titre.
*BLANK
Aucun texte n'est précisé.
valeur-alphanumérique
Indiquez, entre apostrophes, un texte de 50 caractères au maximum.

Identificateur de caractères (CHRID)

Indique le jeu de caractères et la page de codes utilisés pour l'index d'aide. La valeur de ce paramètre doit correspondre à celle du paramètre TXTCHRID des groupes de panneaux ajoutés à cet index d'aide.

Valeurs uniques

*SYSVAL
Le système détermine les valeurs de jeu de caractères graphiques et de page de codes pour les paramètres de commande à partir de la valeur système QCHRID.

Elément 1 : Jeu de caractères graphiques

entier
Indiquez la valeur du jeu de caractères graphiques correspondant au jeu de caractères des synonymes utilisés dans l'index d'aide.

Elément 2 : Page de codes

entier
Indiquez la valeur de la page de codes correspondant à la page de codes des synonymes utilisés dans l'index d'aide.

Droits (AUT)

Indique les droits que vous accordez aux utilisateurs qui n'ont pas de droits spécifiques sur l'objet, qui ne figurent pas sur une liste d'autorisation ou dont le profil de groupe ou les profils du groupe supplémentaire ne disposent pas de droits spécifiques sur l'objet.

*LIBCRTAUT
Le système détermine les droits sur l'objet à l'aide de la valeur spécifiée à l'invite Droits pour objets créés (paramètre CRTAUT) dans la commande CRTLIB pour la bibliothèque contenant l'objet à créer. Si la valeur précisée au paramètre CRTAUT est modifiée, la nouvelle valeur n'affecte pas les objets existants.
*CHANGE
L'utilisateur peut effectuer toutes les opérations sur l'objet, à l'exception de celles réservées au propriétaire ou contrôlées par les droits d'existence de l'objet (*OBJEXIST) et de gestion de l'objet (*OBJMGT). L'utilisateur peut réaliser des fonctions de base sur l'objet et le modifier. Le droit *CHANGE fournit le droit d'opération sur l'objet (*OBJOPR) ainsi que les droits sur toutes les données. Si l'objet est une liste d'autorisation, vous pouvez ajouter, modifier ou supprimer des utilisateurs dans cette liste.
*ALL
L'utilisateur peut effectuer toutes les opérations, à l'exception de celles réservées au propriétaire ou soumises au droit de gestion de la liste d'autorisation (*AUTLMGT). L'utilisateur a un droit d'existence sur l'objet Il peut également effectuer des fonctions de base sur ce dernier, le modifier, définir son niveau de protection et en transférer la propriété.
*USE
L'utilisateur peut effectuer des opérations de base sur l'objet, telles que l'exécution d'un programme ou la lecture d'un fichier. Il ne peut pas le modifier. Le droit d'utilisation (*USE) fournit le droit d'opération sur l'objet (*OBJOPR) ainsi que le droit d'exécution (*EXECUTE).
*EXCLUDE
L'utilisateur n'a pas accès à l'objet.
nom
Indiquez le nom d'une liste d'autorisation permettant de déterminer les droits sur l'objet. Les droits sur l'objet précisés dans la liste sont accordés aux utilisateurs qui figurent sur cette liste. La liste d'autorisation doit exister à la création de l'objet.

Exemples

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

Cette commande permet de créer l'index d'aide ACCOUNTING dans la bibliothèque en cours.

Messages d'erreur

Messages *ESCAPE

CPF6E11
Index d'aide &2 non créé dans la bibliothèque &3.

© Copyright IBM Corp. Texte d'aide reproduit à des fins de formation.