DocumentationAEM 6.5Guide de l’utilisateur

Description de l’objet JSON de l’espace de travail AEM Forms aem-forms-workspace-json-object-description

Last update: Sun Jul 14 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Rubriques :

Créé pour :

  • Administration
  • Utilisateur ou utilisatrice
  • Développeur

Les objets JSON utilisés dans l’espace de travail AEM Forms sont décrits ci-dessous.

  1. Catégorie

    Les catégories sont présentes dans l’onglet Démarrer le processus de Workspace. Ces catégories sont utilisées pour classer les points de départ.

Propriété
Client uniquement
Commentaires
name
F
Nom de la catégorie
id
F
ID de la catégorie
description
F
Description de la catégorie
parentOid
F
Contient l’OID de la catégorie parente
.
startPointsList
T
Contient la liste de tous les points de départ présents dans une catégorie.
categoryList
T
Contient la liste des catégories enfants directes d’une catégorie
.
NOTE
Tous les points de départ et favoris sont des catégories qui sont définies côté client. La catégorie Favoris contient tous les points de départ qui sont marqués par l’utilisateur comme favoris. La catégorie Tous les points de départ contient tous les points de départ.

  1. Point de départ

    Le point de départ permet de démarrer un processus à partir de l’espace de travail lors de l’appel.

    table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 6-row-3 7-row-3 8-row-3 9-row-3 10-row-3
    Propriété Client uniquement Commentaires
    categoryId F Contient l’identifiant de la catégorie à laquelle appartient le point de départ.
    description F Contient la description d’un point de départ.
    name F Contient le nom du point de départ.
    serializedImageTicket F Contient le ticket de l’image correspondant au point de départ. Le ticket de cette image est utilisé dans le champ imageUrl du point de départ, pour obtenir l’image pour le point de départ à partir du serveur.
    serviceName F Contient le nom du service pour le point de départ.
    startpointId F Contient l’identifiant du point de départ.
    isFavorite T Indique si le point de départ est un favori ou non. True si le point de départ est favori, sinon false.
    isDefaultImage T Indique s’il existe une image spécifiée pour le processus ou non. True si aucune image n’est associée au processus, sinon false.
    task T Contient la tâche créée lorsque le point de départ est appelé.
    imageUrl T Contient l’URL de l’image correspondant au point de départ.

  2. Tâche

    Les tâches sont attribuées aux utilisateurs/groupes et comprennent une interface utilisateur (un formulaire ou un guide - déconseillé) qui peut être renseignée avec des données. Lorsque des utilisateurs et des utilisatrices se voient attribuer une tâche, ils reçoivent le formulaire ou le guide à remplir et à envoyer.

Propriété
Client uniquement
Commentaires
classOfTask
F
La classe de tâche est « LC8 » lorsque la tâche est lc8, sinon « standard ».
completeTime
F
Contient l’horodatage de fin de la tâche.
consultGroupId
F
Contient l’ID d’un groupe dont la tâche peut être consultée. Il est défini lors de la conception du processus.
createTime
F
Contient l’horodatage de création de la tâche.
createdId
F
Contient l’identifiant de la personne qui a créé la tâche.
currentAssignment
F
Contient des informations sur l’affectation actuelle de la tâche.
deadline
F
Contient l’horodatage d’échéance d’une tâche.
description
F
Contient la description de la tâche.
displayName
F
Contient le nom d’affichage de la tâche.
forwardGroupId
F
Contient l’ID d’un groupe auquel la tâche peut être transmise. Il est défini lors de la conception du processus.
instructions
F
Contient des instructions pour une tâche.
isLocked
F
True si la tâche est verrouillée.
isMustOpenToComplete
F
True si le formulaire de tâche doit être ouvert pour terminer la tâche.
isOpenFullScreen
F
Si la valeur est true, à l’ouverture de la tâche, le formulaire occupe l’écran tout entier la première fois.
isRouteSelectionRequired
F
Si la valeur est true, l’itinéraire doit être sélectionné pour terminer la tâche.
isShowAttachments
F
Les pièces jointes s’affichent si la valeur est true.
isStartTask
F
Si la valeur est true, la tâche est créée à partir du point de départ.
isVisible
F
True si la tâche est visible dans l’espace de travail.
nextReminder
F
Horodatage pour le rappel suivant.
priority
F
Contient la priorité de la tâche.
1 = priorité la plus élevée
2 = priorité élevée
3 = priorité normale
4 = faible priorité
5 = priorité la plus faible
processInstanceId
F
ID de l’instance de processus dont la tâche fait partie.
processusInstanceStatus
F
Statut de l’instance de processus de la tâche.
reminderCount
F
Contient le nombre de rappels pour la tâche.
routeList
F
Contient la liste des itinéraires associée à la tâche. L’utilisateur ou l’utilisatrice peut effectuer la tâche en sélectionnant l’un des itinéraires dans la liste des itinéraires.
selectedRoute
F
Il contient le nom de l’itinéraire sélectionné une fois la tâche terminée.
serializedImageTicket
F
Contient le ticket de l’image correspondant à la tâche. Le ticket de cette image est utilisé dans le champ imageUrl de la tâche, pour obtenir l’image pour la tâche à partir du serveur.
serviceName
F
Il contient le nom du service pour la tâche.
serviceTitle
F
Il contient le titre du service pour la tâche.
status
F
1 = Créé (la tâche est créée à partir du point de départ.)
2 = Créé et enregistré (la tâche est créée à partir du point de départ et enregistrée.)
3 = Affecté (la tâche est affectée à l’utilisateur ou l’utilisatrice une fois le processus démarré.)
4 = Affecté et enregistré (la tâche est affectée et enregistrée.)
100 = Terminé (la tâche est terminée.)
101 = Date limite (la tâche a atteint la date limite.)
102 = Terminé
stepName
F
Il contient le nom de la tâche définie lors de la conception du processus.
summaryUrl
F
Il contient l’URL du résumé de la tâche.
taskACL
F
Il s’agit d’une liste de contrôle d’accès pour une tâche.
taskId
F
ID d’une tâche.
updateTime
F
Horodatage de la dernière mise à jour de la tâche.
formUrl
T
Il contient l’URL du formulaire d’une tâche.
taskFormType
T
Contient un type de formulaire de tâche. En utilisant ce champ, la tâche est rendue sur le client sous forme de pdf, de formulaire swf, etc.
showDirectActions
T
Si True, les actions d’itinéraire sont visibles dans l’espace de travail.
showACLActions
T
Si True, les actions telles que transférer, consulter et partager sont visibles dans l’espace de travail.
supportsOffline
T
Si la valeur est true, le formulaire peut être déconnecté. Ceci concerne uniquement les formulaires PDF.
supportsSave
T
Si true, l’utilisateur ou l’utilisatrice peut enregistrer la tâche.
readerSubmitOptions
T
Cet objet contient des options qui sont utilisées pour soumettre des formulaires PDF via un lecteur dans le cas où le formulaire PDF ne contient pas de bouton de soumission.
isDefaultImage
T
Indique s’il existe une image spécifiée pour le processus ou non. True s’il n’y a pas d’image associée au processus, sinon false.
historyTaskList
T
Contient la liste des tâches utilisées dans l’onglet historique des détails des tâches.
isOwner
T
True si la personne connectée est propriétaire de la tâche.
availableCommands
T
Contient toutes les actions qui peuvent être entreprises sur la tâche.
availableCommands.directCommands
T
Contient toutes les actions d’itinéraire disponibles pour une tâche.
availableCommands.taskACLCommands
T
Contient des commandes telles que transférer, partager et consulter si disponible pour une tâche.
availableCommands.otherCommands
T
Contient des commandes telles que verrouiller, déverrouiller, abandonner, retourner, réclamer, etc., selon leur disponibilité.
processInstanceInfo
T
Contient des informations sur l’instance de processus de la tâche.
processVariables
T
Contient un tableau d’objets de variables de processus, le cas échéant.
pendingTasks
T
Contient la liste des tâches en attente pour l’instance de processus de la tâche.
userActions
T
Tableau d’objets. Chaque objet contient des informations sur l’itinéraire et son message de confirmation correspondant, le cas échéant.
dataUrl
T
URL des données du formulaire d’une tâche.
externalAppConfig
T
Il s’agit d’une configuration pour les formulaires de candidature tiers.
submitted
T
True si la tâche est envoyée.
attachments
T
Liste des pièces jointes pour une tâche.
assignments
T
Liste des affectations d’une tâche.

  1. Filtrer

    Le filtre est en principe la file d’attente de l’utilisateur ou du groupe. Lorsqu’une tâche est attribuée à une personne/un groupe, celle-ci est ajoutée dans la file d’attente correspondante.

Propriété
Client uniquement
Commentaires
isDefault
F
True si la file d'attente est la file d’attente par défaut de la personne connectée, sinon false.
name
F
Nom du ou de la propriétaire de la file d'attente.
qid
F
Identifiant de la file d’attente.
type
F
Contient le type de file d’attente.
0 - File d’attente de l’utilisateur ou de l’utilisatrice.
1. File d’attente partagée.
2. File d’attente de groupe.
query
T
Contient la requête associée à un filtre. Cette requête est utilisée pour rechercher des tâches dans une liste de tâches complète.
tasks
T
Contient la liste de toutes les tâches appartenant à un filtre.

  1. Absence du bureau

    Vous pouvez gérer votre planning d'absence du bureau et contrôler le flux des tâches qui vous sont affectées en votre absence.

Propriété
Client uniquement
Commentaires
dateRanges
F
Contient des objets de tableau des plannings d’absences du bureau d’un utilisateur. Dans chaque objet de planning, le champ startDate contient la date de début du planning et le champ endDate contient la date de fin du planning. Si endDate est null dans le planning, cela implique que l’utilisateur n’a pas planifié la date de fin du planning d’absences du bureau.
isNoPrimaryDesignate
F
True s’il n’y a pas de désignation principale si l’utilisateur ou l’utilisatrice n’est pas au bureau.
isOutOfOffice
F
True si l’utilisateur ou l’utilisatrice n’est pas au bureau.
outOfOfficeDesignate
F
Contient les informations sur l’utilisateur ou l’utilisatrice désignés comme responsable principal par l’utilisateur ou l’utilisatrice.
processSpecificDesignates
F
Contient un tableau d’objets pour la désignation d’absence du bureau propre à un processus. Dans chaque objet de désignation propre à un processus, processName contient le nom du processus, isNotDesignated est défini sur true si aucun utilisateur n’est affecté au processus correspondant, et userDesignated est défini sur null si aucun utilisateur n’a affecté de détails else de l’utilisateur affecté au processus correspondant.
processes
T
Contient une liste de tous les processus disponibles pour l’utilisateur ou l’utilisatrice.
initialOutOfOfficeSettings
T
Contient les paramètres d’absence du bureau initiaux de l’utilisateur ou de l’utilisatrice qui sont récupérés au départ.
outOfOfficeSettings
T
Contient les paramètres d’absence du bureau modifiés.
userSearchHistory
T
Contient une liste d’utilisateurs et d’utilisatrices recherchés par un utilisateur ou une utilisatrice connecté jusqu’à ce jour.

  1. Instance de processus

    Une instance de processus est créée lorsqu’un processus est appelé via un espace de travail ou un workbench.

Propriété
Client uniquement
Commentaires
description
F
Description de l’instance de processus
initiator
F
Nom de l’initiateur ou de l’initiatrice d’une instance de processus.
initiatorId
F
ID de l’initiateur ou de l’initiatrice de l’instance de processus.
processCompleteTime
F
Horodatage lorsque le processus est terminé.
processInstanceId
F
Identifiant de l’instance de processus.
processInstanceStatus
F
0 = initié
1 = en cours d’exécution
2 = terminé
3 = en cours d’achèvement
4 = interrompu
5 = en cours d’interruption
6 = suspendu
7 = en cours de suspension
8 = en cours d’annulation de la suspension
processName
F
Nom du processus.
processStartTime
F
Horodatage du démarrage du processus.
processVariables
F
Tableau d’objets de variables de processus. Chaque objet de variable de processus contient les paramètres Nom (nom de la variable de processus), Valeur (valeur de variable de processus) et Type (type de variable de processus).
tasklist
T
Tâches générées par cette instance de processus.
  1. Nom du processus
Propriété
Client uniquement
Commentaires
processMajorVersion
F
Version majeure d’un processus.
processMinorVersion
F
Version mineure d’un processus.
processName
F
Nom du processus.
processTitle
F
Titre du processus.
processInstanceList
T
Liste des instances de processus pour ce processus.

  1. Objet d’affectation de tâches

    L’objet Affectation de tâche contient des informations sur l’affectation d’une tâche. Voici les propriétés de l’affectation de la tâche.

Propriété
Client uniquement
Commentaires
assignmentCreateTime
F
Horodatage de la création de cette affectation de tâche.
assignmentType
F
0 = affectation initiale
1 = Transférer (la tâche a été transférée à la propriétaire ou au propriétaire actuel de la tâche.)
2 = Renvoyé (la tâche a été renvoyée à la propriétaire ou au propriétaire actuel de la tâche par la ou le propriétaire précédent de la tâche.)
3 = Réclamé (la tâche a été réclamée par la ou le propriétaire actuel de la tâche.)
4 = Réaffectation (la tâche a été affectée à la propriétaire ou au propriétaire actuel de la tâche après réaffectation.)
5 = Administrateur ou administratrice attribué (la tâche a été attribuée par l’administrateur ou l’administratrice à la propriétaire ou au propriétaire actuel de la tâche.)
6 = Consulté (la tâche a été consultée par la ou le propriétaire actuel de la tâche.)
assignmentUpdateTime
F
Horodatage de la mise à jour de cette affectation d’une tâche.
queueId
F
ID de la file d’attente de la ou du propriétaire actuel de la tâche.
queueOwner
F
Nom de la propriétaire ou du propriétaire actuel de la tâche.
queueOwnerId
F
ID de la propriétaire ou du propriétaire actuel de la tâche.

  1. Objet ACL de tâche

    L’objet ACL de tâche contient des informations sur les autorisations telles que le transfert, le partage, la consultation, etc., d’une tâche. Voici les propriétés de l’ACL de la tâche.

Propriété
Client uniquement
Commentaires
canAddAttachments
F
Si true, les pièces jointes peuvent être ajoutées à la tâche.
canAddNotes
F
Si true, des notes peuvent être ajoutées à la tâche.
canClaim
F
Si true, la tâche peut être réclamée.
canConsult
F
Si true, la tâche peut être consultée.
canForward
F
Si true, la tâche peut être transférée.
canShare
F
Si true, la tâche peut être partagée.

  1. Pièce jointe de la tâche

    Des pièces jointes peuvent être ajoutées à une tâche. Une pièce jointe peut être de type pièce jointe et note. Voici les propriétés de l’objet de pièce jointe.

Propriété
Client uniquement
Commentaires
creationDate
F
Horodatage lors de la création de la pièce jointe.
creatorId
F
ID de la personne qui a ajouté la pièce jointe.
creatorName
F
Nom de la personne qui a ajouté la pièce jointe.
description
F
Description de la pièce jointe.
fileName
F
Nom de la pièce jointe.
id
F
ID de la pièce jointe.
lastModifiedDate
F
Horodatage de la dernière modification de la pièce jointe.
noteExtended
F
Si true, la note est une note étendue (longue).
autorisations ;
F
Autorisations associées à une pièce jointe. Le champ allowRead représente l’autorisation de lire, allowWrite l’autorisation d’écrire et allowDelete l’autorisation de supprimer.
size
 ;
F
Taille de la pièce jointe en octets.
taskId
F
ID de la tâche à laquelle la pièce jointe est ajoutée.
type
F
Le type est « attachment » pour les fichiers et « note » pour les notes.
formattedCreationDate
T
Contient la date de création de la pièce jointe en fonction des paramètres de l'interface utilisateur de la personne.
formattedDescription
T
Description de la pièce jointe formatée. Utilisé pour afficher les caractères spéciaux présents dans la description de la pièce jointe dans l’espace de travail AEM Forms.
formattedFileName
T
Nom de la pièce jointe formatée. Utilisé pour afficher les caractères spéciaux présents dans le nom de la pièce jointe dans l’espace de travail AEM Forms. Ceci est uniquement destiné aux notes.

  1. User

    Voici les propriétés de l’objet utilisateur.

Propriété
Client uniquement
Commentaires
address
F
Adresse de la personne.
commonName
F
Nom commun de l’utilisateur ou de l’utilisatrice.
description
F
Description de l’utilisateur ou de l’utilisatrice.
directGroupMemberships
F
Liste du groupe de l’utilisateur ou de l’utilisatrice.
displayName
F
Nom d’affichage de l’utilisateur ou de l’utilisatrice.
email
F
Identifiant e-mail de l’utilisateur ou de l’utilisatrice.
isOutOfOffice
F
True si la personne est absente du bureau.
lastName
F
Nom de famille de la personne.
firstName
F
Prénom de la personne.
oid
F
ID de l’utilisateur ou de l’utilisatrice.
org
F
Nom de l’organisation de l’utilisateur ou de l’utilisatrice.
postalAddress
F
Adresse postale de la personne.
telephone
F
Numéro de contact de la personne.
telephoneNumber
F
Numéro de contact de la personne.
userid
F
Identifiant de connexion de l’utilisateur ou de l’utilisatrice.
recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2