Manipuler les pièces jointes
Afin de contextualiser le traitement d’une tâche, des composants peuvent être attachés à une tâche. C’est la notion de pièce jointe. Les pièces jointes d’une tâche peuvent être manipulées à l’aide de l’API Javascript.
L’ajout de composants en tant que pièces jointes d’une tâche peut être réalisé à l’aide des deux fonctions suivantes :
addAttachment(attachmentId, componentId, category)
pour attacher un seul composant à partir de son identifiantcomponentId
addAttachments(attachmentId, componentIds, category)
pour attacher plusieurs composants à partir de leur identifiant fourni dans un tableaucomponentIds
L’utilisation de ces fonctions nécessitent en entrée l’identifiant de la pièce jointe et la catégorie de composant attendue (définies sur la classe de tâche).
Les modifications des pièces jointes d’une tâche nécessitent d’être sauvegardées à l’aide des fonctions create
ou update
exposées par l’objet JSAPI.get().task()
.
JSAPI.get().task().get([id], function (tasks) {
let task = tasks[0];
task.addAttachments('Appendices', documentId, 'DOCUMENT');
JSAPI.get().task().update([task], function (updated) {
console.info('The document has been attached to task');
});
});
Sur le même principe, les identifiants des composants attachés à une tâche peuvent être récupérés à l’aide de la fonction getAttachmentIds()
exposée sur l’objet Task
.
Répondre à des tâches
La notion de réponses à une tâche permet aux utilisateurs de prendre des décisions sur le traitement de tâches. Pour chaque décision prise, un comportement spécifique peut être ainsi ajouté pour prendre en compte cette décision et appliquer le traitement adéquat.
Une réponse peut être appliquée à une ou plusieurs tâches à l’aide de la fonction answer(ids, answer)
avec pour paramètres :
- un tableau d’identifiants de tâches
- un objet
Answer
(ouReasonedAnswer
) représentant la réponse à appliquer
var taskAPI = JSAPI.get().task();
taskAPI.answer([id], new Answer("Validate"), function(){
JSAPI.get().getNotificationAPI().sendInformation("Answer was applied");
});
Assignation de tâches
Assigner des tâches
Pour pouvoir être traitée par un utilisateur, une tâche doit lui être assignée par un des mécanismes à disposition.
L’API Javascript fait partie de ces mécanismes à disposition. La fonction assign(ids, userId)
permet d’assigner une ou plusieurs tâches à un utilisateur à l’aide de :
- un tableau d’identifiants de tâches
- l’identifiant de l’utilisateur auquel assigner les tâches
JSAPI.get().task().assign([id], 'sarah.hubert', function () {
console.info('The task ' + id + ' has been assigned');
});
L’utilisateur auquel une tâche est assignée peut être récupéré grâce à la fonction getAssignee()
exposée sur l’objet Task
.
Informations liées à un processus
Fonctions | Description |
---|---|
getWorkflow() | Déterminer l’identifiant du traitement de la tâche |
setWorkflow(String workflow) | Définir l’identifiant du traitement de la tâche |
getParticipants() | Déterminer les identités ayant participées au traitement |
addParticipant(String participant) | Ajout d’un participant à une tâche |