`$ged.createDocument`¶

Description¶

Crée un nœud de type "fichier".

Syntaxe¶

$ged.createDocument( parentNodeid , file [ , options ] )

Paramètres¶

parentNodeid string

Identifiant du dossier dans lequel le fichier doit être placé

file file / string

Fichier à placer en GED

options map

Map d'options pouvant contenir les propriétés suivantes:

connection string

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

filename string

Nom du noeud représentant le fichier dans la GED. Si non défini, le noeud reprend le nom du fichier. Notez que le nom est commun pour toutes les versions du fichier.

mimetype string

Mime type du document. La propriété n'a pas besoin d'être renseignée si le paramètre file est un objet de type file.

updateType string

Comportement à appliquer si un fichier de même nom existe déjà dans le dossier de destination. Par défaut, le moteur effectue une montée de version mineure. Il est toutefois possible de forcer le comportement du moteur avec les valeurs suivantes:

major : le document est ajouté en tant que mise à jour majeure
minor : le document est ajouté en tant que mise à jour mineure
replace (valeur par défaut) : le document est remplacé

Les paramètres ci-dessous sont propre à chaque système GED.

FileIndexAlfresco

description string: Description du noeud. Notez que la description est commune pour toutes les versions du fichier.

renditionId string / array

Type(s) de rendition(s) à lancer immédiatement après l'upload. Une description des renditions est donnée dans la documentation de la méthode $ged.getDocumentRendition.

Par défaut, les renditions sont démarrées dans une tâche en background. Elles peuvent ainsi prendre plus ou moins de temps à être générées en fonction de la charge du serveur et de la taille du document. La propriété renditionId permet de forcer Alfresco à créer les renditions immédiatement.

Le type de rendition possible dépend du type de fichier uploadé. Alfresco reconnaît de base les renditions suivants:

pdf
doclib
avatar
avatar32
imgpreview
webpreview
medium

Pour plus de détails, veuillez vous reporter à la documentation de l'API.

Retour¶

L'identifiant du nœud représentant le nouveau document en cas de succès ou null en cas d'erreur.

Exemple¶

var newNode = $ged.createDocument("b8a4f19a-f7c7-4015-bf5f-3836cbd0a87c",
                                  $file.load("/path-to/test.docx"));

if (newNode) {
    $logger.info(newNode);
    $logger.info($ged.getNodeInfos(newNode));
}
else {
    $logger.error("->" & $script.getLastError());
}

$ged.createDocument¶