Copyright © Xerox Corporation, Codendi Team, 2001-2006. All Rights Reserved

3.4 Fonction du Gestionnaire de Documents

Ce module fonctionne avec le plugin docman et nécessite que le plugin soit installé.

3.4.1 list

list : Affiche la liste des items contenus dans un dossier

  • --id* : l'identifiant du dossier.

  • --project : nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login, une erreur sera affichée.

[terzino@linux tuleap-cli]$ ./tuleap.php docman list --id=110418 --project=myproject
+---------+-----------+----------+--------------+-------------+-------------+-------------+---------+--...
| item_id | parent_id | group_id |    title     | create_date | update_date | delete_date | user_id | s...
+---------+-----------+----------+--------------+-------------+-------------+-------------+---------+--...
| 110493  | 110418    | 1        | testSoap     | 1293189073  | 1293189073  |             | 101     | 1...
| 110491  | 110418    | 1        | CLI Document | 1293188351  | 1293188351  |             | 101     | 1...
+---------+-----------+----------+--------------+-------------+-------------+-------------+---------+--...
                        

Exemple 43. commande list

3.4.2 getRoot

getRoot: Retourne l'id de la racine du service Documents pour un projet donné

  • --project : nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login, une erreur sera affichée.

[terzino@linux tuleap-cli]$ ./tuleap.php docman getRoot --project=myproject 
+--------+
| Result |
+--------+
| 2      |
+--------+

                        

Exemple 44. Commande getRoot

3.4.3 createEmbeddedFile

createEmbeddedFile: Ajoute un embedded document au gestionnaire de documents

  • --parent_id*: identifiant du parent dans lequel le document sera créé

  • --project*: Nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login, une erreur sera affichée.

  • --title*: Titre de nouveau document

  • --description: La description du nouveau document

  • --status: Le status du nouveau item. Les status possibles sont "none", "draft", "approved", et "rejected"

  • --content*: Le contenu brut pour le type "embedded_file"

  • --perm_read: Les Groupes IDs qui vont avoir la permission de lecture, séparés par des virgules

  • --perm_write: Les Groupes IDs qui vont avoir la permission d'écriture, séparés par des virgules

  • --perm_manage: Les Groups IDs qui vont avoir la permission de gestion, séparés par des virgules

  • --perm_none: Les Groups IDs qui n'auront pas de permission, séparés par des virgules(ces groupes ne vont pas hériter les permissions de l'item parent)

  • --properties: Le fichier qui contient les propriétés qui seront appliquées sur l'item.

  • --obsolescence_date: Date à laquelle le document sera obsolète (aa-mm-jj|aaaa-mm-jj)

  • --ordering: place du document dans le dossier parent. Les valeurs possibles sont "begin" et "end"

[terzino@linux tuleap-cli]$ ./tuleap.php docman createEmbeddedFile --project=myproject --parent_id=110418 --title="EmbeddedFile sample" --content="It is just a sample to describe how  we add an embedde file to the docman manager"
+--------+
| Result |
+--------+
| 110499 |
+--------+
                        

Exemple 45. Commande createEmbeddedFile

3.4.4 createFile

Support des gros fichiers: CLI peut ajouter des fichiers supérieurs à 2Go lorsque que la machine cliente (qui exécute CLI) et le serveur sont des machines 64 bits.

createFile: Ajoute un fichier au gestionnaire de documents

  • --parent_id*: identifiant du parent dans lequel le document sera créé

  • --project*: Nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login, une erreur sera affichée.

  • --title*: Titre de nouveau document

  • --description: La description du nouveau document

  • --status: Le status du nouveau item. Les status possibles sont "none", "draft", "approved", et "rejected"

  • --content*: L'emplacement du fichier pour le type "file"

  • --perm_read: Les Groupes IDs qui vont avoir la permission de lecture, séparés par des virgules

  • --perm_write: Les Groupes IDs qui vont avoir la permission d'écriture, séparés par des virgules

  • --perm_manage: Les Groups IDs qui vont avoir la permission de gestion, séparés par des virgules

  • --perm_none: Les Groups IDs qui n'auront pas de permission, séparés par des virgules(ces groupes ne vont pas hériter les permissions de l'item parent)

  • --properties: Le fichier qui contient les propriétés qui seront appliquées sur l'item.

  • --obsolescence_date: Date à laquelle le document sera obsolète (aa-mm-jj|aaaa-mm-jj)

  • --ordering: place du document dans le dossier parent. Les valeurs possibles sont "begin" et "end"

[terzino@linux tuleap-cli]$ ./tuleap.php docman createFile --project=myproject --parent_id=110418 --title="CLi user guide" --content="cli_user_guide.pdf"
Sending file (100%)
File uploaded successfully
+--------+
| Result |
+--------+
| 110498 |
+--------+
                        

Exemple 46. Commande createFile

3.4.5 createEmptyDocument

createEmptyDocument: Ajoute un document vide au gestionnaire de documents

  • --parent_id*: identifiant du parent dans lequel le document sera créé

  • --project*: Nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login, une erreur sera affichée.

  • --title*: Titre de nouveau document

  • --description: La description du nouveau document

  • --status: Le status du nouveau item. Les status possibles sont "none", "draft", "approved", et "rejected"

  • --perm_read: Les Groupes IDs qui vont avoir la permission de lecture, séparés par des virgules

  • --perm_write: Les Groupes IDs qui vont avoir la permission d'écriture, séparés par des virgules

  • --perm_manage: Les Groups IDs qui vont avoir la permission de gestion, séparés par des virgules

  • --perm_none: Les Groups IDs qui n'auront pas de permission, séparés par des virgules(ces groupes ne vont pas hériter les permissions de l'item parent)

  • --properties: Le fichier qui contient les propriétés qui seront appliquées sur l'item.

  • --obsolescence_date: Date à laquelle le document sera obsolète (aa-mm-jj|aaaa-mm-jj)

  • --ordering: place du document dans le dossier parent. Les valeurs possibles sont "begin" et "end"

[terzino@linux tuleap-cli]$ ./tuleap.php docman createEmptyDocument --project=myproject --parent_id=110418 --title="user guide help" 
+--------+
| Result |
+--------+
| 110500 |
+--------+
                        

Exemple 47. Commande createEmptyDocument

3.4.6 createLink

createLink: Ajoute un lien au gestionnaire de documents

  • --parent_id*: identifiant du parent dans lequel le document sera créé

  • --project*: Nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login, une erreur sera affichée.

  • --title*: Titre de nouveau document

  • --description: La description du nouveau document

  • --status: Le status du nouveau item. Les status possibles sont "none", "draft", "approved", et "rejected"

  • --content*: L'URL pour le type "link"

  • --perm_read: Les Groupes IDs qui vont avoir la permission de lecture, séparés par des virgules

  • --perm_write: Les Groupes IDs qui vont avoir la permission d'écriture, séparés par des virgules

  • --perm_manage: Les Groups IDs qui vont avoir la permission de gestion, séparés par des virgules

  • --perm_none: Les Groups IDs qui n'auront pas de permission, séparés par des virgules(ces groupes ne vont pas hériter les permissions de l'item parent)

  • --properties: Le fichier qui contient les propriétés qui seront appliquées sur l'item.

  • --obsolescence_date: Date à laquelle le document sera obsolète (aa-mm-jj|aaaa-mm-jj)

  • --ordering: place du document dans le dossier parent. Les valeurs possibles sont "begin" et "end"

[terzino@linux tuleap-cli]$ ./tuleap.php docman createLink --project=myproject --parent_id=110418 --title="user guide link" --content="codendi.org"
+--------+
| Result |
+--------+
| 110501 |
+--------+

                        

Exemple 48. createLink command

3.4.7 createWikiPage

createWikiPage: Ajoute un wiki document au gestionnnaire de documents

  • --parent_id*: identifiant du parent dans lequel le document sera créé

  • --project*: Nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login, une erreur sera affichée.

  • --title*: Titre de nouveau document

  • --description: La description du nouveau document

  • --status: Le status du nouveau item. Les status possibles sont "none", "draft", "approved", et "rejected"

  • --content*: Le nom de la page wiki pour le type "wiki"

  • --perm_read: Les Groupes IDs qui vont avoir la permission de lecture, séparés par des virgules

  • --perm_write: Les Groupes IDs qui vont avoir la permission d'écriture, séparés par des virgules

  • --perm_manage: Les Groups IDs qui vont avoir la permission de gestion, séparés par des virgules

  • --perm_none: Les Groups IDs qui n'auront pas de permission, séparés par des virgules(ces groupes ne vont pas hériter les permissions de l'item parent)

  • --properties: Le fichier qui contient les propriétés qui seront appliquées sur l'item.

  • --obsolescence_date: Date à laquelle le document sera obsolète (aa-mm-jj|aaaa-mm-jj)

  • --ordering: place du document dans le dossier parent. Les valeurs possibles sont "begin" et "end"

[terzino@linux tuleap-cli]$ ./tuleap.php docman createWikiPage --project=myproject --parent_id=110418 --title="user guide wiki" --content="user_guide_wiki"
+--------+
| Result |
+--------+
| 110502 |
+--------+
                        

Exemple 49. Commande createWikiPage

3.4.8 createFolder

createFolder : Ajoute un dossier au gestionnaire de documents

  • --parent_id* : identifiant du parent danslequel le dossier sera créé

  • --title* : Titre du nouveau dossier

  • --description : Description du nouveau dossier

  • --ordering : place du dossier dans le dossier parent. Les valeurs possibles sont "begin" et "end"

  • --project : nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login, une erreur sera affichée.

[terzino@linux tuleap-cli]$ ./tuleap.php docman createFolder --project=myproject --parent_id=110480 --title="Tech docs folder"
+--------+
| Result |
+--------+
| 110503 |
+--------+
                        

Exemple 50. createFolder command

3.4.9 getFile

getFile: Download document (Fichier/Embedded fichier)

  • --id*: L'ID de l'item à télécharger

  • --output: Nom du fichier

  • --remote_name: Pour retrouver le nom de fichier depuis le serveur au lieu d'utiliser --output.

  • --version: Le numéro de la version qu'on veut télécharger. Si la version n'est pas spécifiée, la version sera la courante.

  • --project : nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login, une erreur sera affichée.

[terzino@linux tuleap-cli]$ ./tuleap.php docman getFile --project=myproject --id=110493 --version_number=1 --output=document_cli.doc
File retrieved successfully.
                        

Exemple 51. getFile command

3.4.10 delete

delete : Supprime un item

  • --id* : identifiant de l'item à supprimer

  • --project : nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login, une erreur sera affichée.

[terzino@linux tuleap-cli]$ ./tuleap.php docman delete --project=myproject --id=110502
1
                        

Exemple 52. commande delete

3.4.11 monitor

monitor : Surveiller un item

  • --id* : identifiant de l'item à surveiller

  • --project : nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login, une erreur sera affichée.

[terzino@linux tuleap-cli]$ ./tuleap.php docman monitor --project=myproject --id=110501
+--------+
| Result |
+--------+
| 1      |
+--------+
                        

Exemple 53. commande monitor

3.4.12 move

move : Déplace un item

  • --id* : identifiant de l'item à déplacer

  • --parent* : identifiant du dossier dans lequel l'item sera déplacé

  • --project : nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login, une erreur sera affichée.

[terzino@linux tuleap-cli]$ ./tuleap.php docman move --project=myproject --id=110501 --parent=110503
+--------+
| Result |
+--------+
| 1      |
+--------+

                        

Exemple 54. move command


Copyright © Xerox Corporation, Codendi Team, 2001-2006. All Rights Reserved