RTVDOC
Extraire un document
En bref
La commande RTVDOC permet d'extraire des informations d'un document particulier.
RTVDOC se lit RTV
(Extraire (récupérer)) + DOC.
Sur IBM i, le nom d'une commande associe presque toujours un verbe et un objet.
Syntaxe minimale
RTVDOC FROMDOC(…)
Paramètres
-
FROMDOCDocument d'origine obligatoire -
FROMFLRDossier d'origine -
OUTFILEFichier recevant la sortie -
OUTMBROptions pour membre de sortie -
OUTDTATYPType de données en sortie -
USRIDIdentificateur utilisateur -
DOCIDIdentificateur du document -
CHKOUTIndicateur de sortie -
CMDCHRIDID caractères pour commande
Astuce : dans une session 5250, tapez RTVDOC 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 RTVDOC permet d'extraire des informations d'un document particulier.
Restrictions :
- Pour extraire un enregistrement du document destiné à un fichier base de données, vous devez disposer du droit d'utilisation *USE pour ce document ou travailler pour le compte d'un utilisateur ayant ce droit.
- Pour réserver le document, vous devez disposer du droit *CHANGE (modification) au minimum sur ce document ou agir pour le compte d'un utilisateur qui possède ce droit.
- Pour agir pour le compte d'un autre utilisateur, vous devez disposer du droit spécial *ALLOBJ (tous les objets) ou d'une procuration spéciale (accordée à l'aide de la commande GRTUSRPMN).
Paramètres
| Mot-clé | Description | Valeurs possibles | Remarques |
|---|---|---|---|
| FROMDOC | Document d'origine | Valeur caractère, *DOCID | Obligatoire, positionnel 1 |
| FROMFLR | Dossier d'origine | Valeur caractère, *NONE | Facultatif, positionnel 2 |
| OUTFILE | Fichier recevant la sortie | Valeurs uniques: *NONE Autres valeurs: Nom d'objet qualifié |
Facultatif |
| Qualificatif 1: Fichier recevant la sortie | Nom | ||
| Qualificatif 2: Biblio | Nom, *LIBL, *CURLIB | ||
| OUTMBR | Options pour membre de sortie | Liste d'éléments | Facultatif |
| Élément 1: Membre recevant la sortie | Nom, *FIRST | ||
| Élément 2: Remplacement ou ajout enregs | *REPLACE, *ADD | ||
| OUTDTATYP | Type de données en sortie | Valeurs uniques: *DFT, *ALL Autres valeurs (jusqu'à 21 répétitions): *DOCD, *DOCCLS, *SUBJECT, *AUTHOR, *FILCAB, *CPYLST, *KWD, *DOCDATE, *FILDATE, *CRTDATE, *CHGDATE, *EXPDATE, *ACTDATE, *CMPDATE, *REF, *STATUS, *PROJECT, *IDP, *DOC |
Facultatif |
| USRID | Identificateur utilisateur | Valeurs uniques: *CURRENT Autres valeurs: Liste d'éléments |
Facultatif |
| Élément 1: ID utilisateur | Valeur caractère | ||
| Élément 2: Adresse | Valeur caractère | ||
| DOCID | Identificateur du document | Valeur caractère, *NONE | Facultatif |
| CHKOUT | Indicateur de sortie | *NO, *YES | Facultatif |
| CMDCHRID | ID caractères pour commande | Valeurs uniques: *SYSVAL, *DEVD Autres valeurs: Liste d'éléments |
Facultatif |
| Élément 1: Jeu de caractères graphiques | Entier | ||
| Élément 2: Page de codes | Entier |
Document d'origine (FROMDOC)
Nom du document à extraire.
- nom
- Indiquez le nom, attribué par un utilisateur, du document à extraire.
- *DOCID
- Le document à extraire est identifié par le nom système du document en bibliothèque, précisé dans le paramètre Identificateur du document (DOCID).
Dossier d'origine (FROMFLR)
Nom du dossier contenant le document à extraire. Il s'agit du nom attribué au dossier lors de sa création. Ce paramètre doit être précisé si un nom de document est indiqué.
- *NONE
- Aucun nom de dossier n'est précisé lorsque le document est identifié par un nom système de document en bibliothèque.
- nom
- Indiquez le nom du dossier contenant le document à extraire.
Fichier recevant la sortie (OUTFILE)
Indique le fichier de base de données vers lequel la sortie générée par la commande est dirigée. Si ce fichier n'existe pas, la commande en crée un dans la bibliothèque précisée. S'il existe déjà, les droits publics sur le fichier sont les mêmes que le droit de création de la pour la bibliothèque contenant le fichier. Pour afficher ce droit, utilisez la commande DSPLIBD (Afficher une description de bibliothèque).
Qualificatif 1 : Fichier recevant la sortie
- nom
- Indiquez le nom du fichier de base de données vers lequel la sortie générée de la commande est dirigée.
Qualificateur 2: Biblio
- *LIBL
- Le fichier est recherché dans la liste des bibliothèques. Si le système ne le trouve pas, il en crée un dans la bibliothèque en cours. S'il n'existe pas de bibliothèque en cours, le fichier est créé dans la bibliothèque QGPL.
- *CURLIB
- Bibliothèque de l'unité d'exécution en cours utilisée pour localiser le fichier. Si cette bibliothèque n'est pas indiquée, QGPL est utilisée par défaut.
- nom
- Indiquez le nom de la bibliothèque dans laquelle doit s'effectuer la recherche.
Remarque :Pour créer un nouveau fichier, le système utilise le fichier modèle QAOSIRTV de la bibliothèque QSYS, avec un nom de format OSRTVD.
Ce fichier peut être réutilisé lorsque d'autres commandes RTVDOC sont exécutées. La sortie peut être ajoutée au fichier ou remplacer les enregistrements existants. Le fichier base de données QAOSIRTV de QSYS fourni par IBM ne peut être indiqué.
Options pour membre de sortie (OUTMBR)
Indique le nom du membre de fichier base de données dans lequel est envoyée la sortie de la commande.
Elément 1 : Membre recevant la sortie
- *FIRST
- Le premier membre du fichier reçoit la sortie. Si OUTMBR(*FIRST) est indiqué et que le membre n'existe pas, le système en crée un du nom indiqué à l'invite Fichier recevant la sortie (paramètre OUTFILE). Si le membre existe, vous avez la possibilité d'ajouter de nouveaux enregistrements à la fin du membre existant ou de le mettre à blanc et de lui ajouter les nouveaux enregistrements.
- nom
- Indiquez le nom du membre de fichier destiné à recevoir la sortie. Si aucun membre de ce nom n'existe, le système le crée.
Elément 2 : Remplacement ou ajout enregs
- *REPLACE
- Le système met à blanc le membre existant et ajoute les nouveaux enregistrements.
- *ADD
- Le système ajoute les nouveaux enregistrements à la suite des enregistrements existants.
Type de données en sortie (OUTDTATYP)
Informations relatives au document à écrire dans le fichier base de données.
- *DFT
- L'enregistrement d'informations sur le document est écrit. Cette opération équivaut à indiquer *DOCD et *DOC.
- Code d'enregistrement - 105, Description du document
- Code d'enregistrement - 800, Données du document
- *ALL
- Tous les enregistrements d'informations sont écrits.
- *ACTDATE
- L'enregistrement de la date d'échéance est écrit (code 135).
- *AUTHOR
- L'enregistrement de l'auteur est écrit (code 145).
- *CHGDATE
- L'enregistrement de la date de dernière modification est écrit (code 130).
- *CMPDATE
- L'enregistrement de la date d'achèvement est écrit (code 140).
- *CPYLST
- Les enregistrements de liste de copie sont écrits (code 150).
- *CRTDATE
- L'enregistrement de la date de création est écrit (code 110).
- *DOCCLS
- L'enregistrement de la classe du document est écrit (code 155).
- *DOCD
- L'enregistrement de descriptions sur le document est écrit. Le code d'enregistrement est 105.
- *DOCDATE
- L'enregistrement de la date du document est écrit (code 120).
- *EXPDATE
- L'enregistrement de la date de péremption est écrit (code 115).
- *FILCAB
- L'enregistrement de la référence du classeur est écrit (code 160).
- *FILDATE
- L'enregistrement de la date du fichier est écrit (code 125).
- *IDP
- L'enregistrement relatif au profil d'échange du document (IDP) est écrit (code 500).
- *IDXDATE
- L'enregistrement de dernière date d'indexation est écrit dans le fichier de sortie.
- *KWD
- Les enregistrements de mot clé sont écrits (code 170).
- *PROJECT
- L'enregistrement relatif au projet est écrit (code 185).
- *REF
- L'enregistrement de la référence est écrit (code 175).
- *REVDATE
- La date de dernière révision du contenu du document est écrite dans le fichier de sortie.
- *STATUS
- L'enregistrement de l'état est écrit (code 180).
- *SUBJECT
- L'enregistrement du sujet est écrit (code 165).
- *USEDATE
- L'enregistrement de la date de dernière utilisation est écrit (code 200).
- *DOC
- L'enregistrement de données du document est écrit (code 800).
Identificateur utilisateur (USRID)
ID utilisateur et adresse à associer à la demande.
Valeurs uniques
- *CURRENT
- Vous exécutez la demande pour votre compte.
Elément 1 : ID utilisateur
- caractère
- Indiquez l'ID d'un autre utilisateur ou le vôtre. Vous devez disposer d'une procuration de cet utilisateur ou du droit spécial *ALLOBJ (tous les objets).
Elément 2 : Adresse
- caractère
- Indiquez l'adresse d'un autre utilisateur ou la vôtre. Si vous indiquez l'ID d'un autre utilisateur, vous devez avoir une procuration de cet utilisateur ou un droit *ALLOBJ.
Identificateur du document (DOCID)
Indique le nom attribué au document par la bibliothèque. Il s'agit en fait du nom que le système a attribué au document lors de la création de ce dernier. Les documents classés hors du système local ont exclusivement ce type de nom. Les noms de documents attribués par la bibliothèque peuvent être déterminés à l'aide de la commande QRYDOCLIB (Interroger une bibliothèque de documents) ou à l'aide du message renvoyé par la commande FILDOC (Classer un document).
Les noms de documents attribués par la bibliothèque ont une longueur de 24 caractères, et doivent se conformer au format suivant :
AAAAMMJJHHMNSSCSNSNSNSNS
dans lequel :
AAAA = année
MM = mois
JJ = jour
HH = heures
MN = minutes
SS = secondes
CS = centièmes de seconde
NSNSNSNS = nom système
- *NONE
- Aucun nom système de document en bibliothèque n'est obligatoire lorsque le document est identifié dans le paramètre Document (DOC).
- nom
- Indiquez le nom système du document en bibliothèque à envoyer.
Indicateur de sortie (CHKOUT)
Indique si le document à extraire peut être remplacé par des données nouvelles ou modifiées. Si le document est uniquement lu, indiquez *NO. Si le document à extraire ne peut être remplacé et que *YES soit précisé, il se produira une erreur.
- *NO
- Les données dont l'extraction est demandée seront lues seulement. Les utilisateurs demandant cette fonction n'ont ainsi besoin que d'un droit de lecture *READ sur le document. Le droit public donne le droit *READ.
- *YES
- Les données du document peuvent être modifiées et remplacées ultérieurement. Les utilisateurs demandant cette fonction doivent disposer du droit *CHANGE (modification). Les autres utilisateurs ne pourront modifier ce document qu'une fois le remplacement effectué. Le remplacement peut être fait à l'aide de la commande RPLDOC (Remplacer un document).
ID caractères pour commande (CMDCHRID)
Identificateur de caractères (jeu de caractères graphiques et page de codes) correspondant aux données saisies comme valeurs des paramètres de la commande. Cet identificateur dépend de l'écran utilisé pour l'entrée de la commande.
La valeur indiquée dans le paramètre Identificateur utilisateur (USRID) est convertie en jeu de caractères et page de codes '930 500'.
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.
- *DEVD
- Le système détermine le jeu de caractères graphiques et la page de codes applicables à partir de la description d'unité écran sur laquelle la commande a été entrée. Cette option ne peut être utilisée que pour un travail interactif. Si elle est indiquée pour un travail par lots, une erreur se produit.
Elément 1 : Jeu de caractères graphiques
- 1 à 32767
- Indiquez le jeu de caractères graphiques à utiliser.
Elément 2 : Page de codes
- 1 à 32767
- Indiquez la page de codes à utiliser.
Exemples
Exemple 1 : Copie de toutes les informations
RTVDOC FROMDOC(MYDOC) FROMFLR(PERSONAL) USRID(*CURRENT)
OUTFILE(*CURLIB/MYFILE) OUTMBR(*FIRST) MBROPT(*ADD)
OUTDTATYP(*ALL)
Cette commande copie toutes les informations relatives au document MYDOC situé dans le dossier PERSONAL s'appliquant à l'utilisateur en cours. L'instruction CHECKOUT(*NO) est sous-entendue, ce qui implique que les données du document sont accessibles uniquement en lecture. La sortie est dirigée vers le fichier base de données MYFILE dans la bibliothèque en cours de l'utilisateur et elle est ajoutée au premier membre de ce fichier.
Exemple 2 : Copie des informations par défaut
RTVDOC FROMDOC(SECOP) FROMFLR(PERSONAL) USRID(MARY SYSTEM1 )
CHKOUT(*YES)
OUTFILE(MARLIB/SECFILE) OUTMBR(*FIRST *ADD)
Cette commande copie les informations par défaut (*DOCD et *DOC) du document SECOP situé dans le dossier PERSONAL de l'utilisateur MARY. De nouvelles données peuvent remplacer les anciennes dans ce document. L'utilisateur en cours de la commande doit avoir reçu de MARY une procuration octroyée à l'aide de la commande GRTUSRPMN. La sortie est dirigée vers le fichier base de données SECFILE dans la bibliothèque de MARY appelée MARLIB. Elle est ajoutée au premier membre de SECFILE.
Messages d'erreur
Messages *ESCAPE
- CPF900B
- ID util et adresse &1 &2 introuvables dans répertoire système.
- CPF900C
- L'ouverture de session et la vérification d'inscription de l'util ont échoué.
- CPF905C
- Erreur lors de la recherche d'une table de conversion.
- CPF905F
- L'extraction du document de la bibliothèque a échoué.
- CPF9096
- Impossible utiliser CMDCHRID(*DEVD) ou DOCCHRID(*DEVD) en traitement par lots.
- CPF9860
- Erreur lors du traitement du fichier de sortie.
© Copyright IBM Corp. Texte d'aide reproduit à des fins de formation.