$ged.getDocumentRendition

Description

Cette méthode gère les renditions, c'est-à-dire des "produits dérivés" d'un document de base. Ces renditions peuvent être de différentes formes (pdf, doclib, avatar, etc.), le plus courant étant de générer une version PDF du document de base (pour autant que ce dernier ne soit pas déjà un PDF).

La méthode supporte deux types d'actions concernant les renditions:

1. create demande à la GED de démarrer un processus de rendition
2. get demande à la GED d'obtenir un type de rendition donné

La méthode autorise d'invoquer les deux méthodes en un seul appel. Dans ce cas, le create sera toujours exécuté avant le get.

Syntaxe

$ged.getDocumentRendition( nodeid , action , renditionId [ , options ] )

Paramètres

nodeid string

Identifiant du document à récupérer

options map

Les propriétés reconnues sont:

connection string

Nom de connexion à utiliser. Fait référence à un name d'entrée ged.connection du config.

destination file / string

Path de destination dans lequel enregistrer le rendering. La propriété doit désigner un dossier car la méthode peut potentiellement générer plusieurs fichiers en sortie.

Alfresco

maxduration number

Durée d'attente maximale en millisecondes pour obtenir les renditions demandés.

Il se peut que les renditions ne soient pas encore disponibles au moment où la méthode les demande. Cela dépend de la charge du serveur de GED et de la taille du document à traiter.

La propriété maxwait permet d'indiquer un délai d'attente en millisecondes pour le cas où les renditions ne sont pas disponibles afin de laisser à Alfresco le temps de les générer. La méthode retournera les renditions obtenues après le délai d'attente. La méthode les retourne bien entendu avant le délai si les renditions sont disponibles avant.

Par défaut la durée d'attente max est 0 ce qui signifie que la méthode n'effectue qu'un seul essai d'obtention des renditions et retourne le résultat obtenu.

interval number

Intervalle en millisecondes entre deux tentatives d'obtention des renditions.

La méthode effectue un polling à intervalle régulier pour tenter d'obtenir les renditions. La propriété interval indique la durée d'attente en millisecondes entre deux requêtes de polling.

Par défaut l'intervalle est 1000 (1 seconde).

Retour

Map reprenant l'id de rendition en clé et le fichier correspondant en valeur. Si le rendition n'a pas pu être obtenu, la valeur est null.

Exemple

Exemple d'appel et de réponse obtenue sur Alfresco:

$ged.getNodeInfos("b8a4f19a-f7c7-4015-bf5f-3836cbd0a87c");

Affiche la trace suivante (ici mise en forme pour faciliter la lecture):

{
    "entry": {
        "aspectNames": [
            "cm:titled",
            "cm:auditable"
        ],
        "createdAt": "2025-04-16T07:11:01.020+0000",
        "isFolder": true,
        "isFile": false,
        "createdByUser": {
            "id": "admin",
            "displayName": "Administrator"
        },
        "modifiedAt": "2025-04-16T07:11:01.020+0000",
        "modifiedByUser": {
            "id": "admin",
            "displayName": "Administrator"
        },
        "name": "myfolder",
        "id": "b8a4f19a-f7c7-4015-bf5f-3836cbd0a87c",
        "nodeType": "cm:folder",
        "parentId": "22024b00-86ce-4f5c-95dc-a4d7b5ba3033"
    }
}