Description de l’objet JSON de l’espace de travail AEM Forms

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 parent
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
REMARQUE

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. Startpoint

    Startpoint est utilisé pour démarrer un processus à partir de Workspace en cas d’appel.

    Propriété Client uniquement Commentaires
    categoryId F Contient l’ID de la catégorie à laquelle appartient le point de départ.
    description F Contient une description pour 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’ID 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 un 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. Lorsqu’une tâche est affectée aux utilisateurs, le formulaire ou le Guide permettant de la terminer et de l’envoyer leur est fourni.

Propriété
 Client uniquement
 Commentaires
classOfTask F La classe de tâche est « LC8 » lorsque la tâche est lc8 else « 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. Défini lors de la conception du processus.
createTime
 F Contient l’horodatage de création de la tâche.
creationId
 F Contient l’ID de l’utilisateur 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. 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 la 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 prend l’écran 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 sont affichées 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 Workspace.
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 du processus dont la tâche fait partie.
processInstanceStatus
 F Etat de l’instance de processus d’une 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 peut terminer la tâche en sélectionnant l’un des itinéraires dans la liste.
selectedRoute
 F Contient le nom de l’itinéraire sélectionné lorsque la tâche a été 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 Contient le nom du service pour la tâche.
serviceTitle
 F Contient le titre du service pour la tâche.
status
 F 1 = Créée (la tâche est créée à partir du point de départ.)
2 = Créée et enregistrée (la tâche est créée à partir du point de départ et enregistrée.)
3 = Affectée (la tâche est affectée à l’utilisateur après le démarrage du processus.)
4 = Affectée et enregistrée (la tâche est affectée et enregistrée.)
100 = Terminée (la tâche est terminée.)
101 = Arrivée à échéance (la tâche a atteint l’échéance.)
102 = Interrompu
stepName
 F Contient le nom de la tâche défini lors de la conception du processus.
summaryUrl
 F Contient l’URL du résumé de la tâche.
taskACL
 F Liste de contrôle d’accès pour une tâche.
taskId
 F ID d’une tâche.
updateTime
 F Horodatage de dernière mise à jour de la tâche.
formUrl
 T Contient l’URL de formulaire pour une tâche.
taskFormType
 T Contient un type de formulaire de tâche. Grâce à ce champ, la tâche est rendue sur le client en tant que formulaire PDF, formulaire SWF, etc.
showDirectActions
 T Si la valeur est true, les actions d’itinéraire sont visibles dans Workspace.
showACLActions
 T Si la valeur est true, les actions comme transmettre, consulter partager, sont visibles dans Workspace.
supportsOffline
 T Si la valeur est true, le formulaire peut être déconnecté. Pour les formulaires PDF uniquement.
supportsSave
 T Si la valeur est true, l’utilisateur peut enregistrer la tâche.
readerSubmitOptions
 T Cet objet contient des options qui sont utilisées pour envoyer des formulaires PDF via Reader lorsque le formulaire PDF ne contient aucun bouton d’envoi.
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.
historyTaskList
 T Contient la liste des tâches qui sont utilisées dans l’onglet Historique des détails de la tâche.
isOwner
 T True si l’utilisateur connecté est propriétaire de la tâche.
availableCommands
 T Contient toutes les actions qui peuvent être prises 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 transmettre, partager et consulter si elles sont disponibles pour une tâche.
availableCommands.otherCommands
 T Contient des commandes telles que verrouiller, déverrouiller, abandonner, renvoyer, demander, etc. si elles sont disponibles.
processInstanceInfo
 T Contient des informations sur l’instance de processus de la tâche.
processVariables
 T
 Contient un tableau d’objets des variables de processus, le cas échéant.
pendingTasks
 T Contient la liste des tâches en attente pour l’instance de processus d’une tâche.
userActions
 T Tableau d’objets. Chaque objet contient des détails sur l’itinéraire et son message de confirmation correspondant, le cas échéant.
dataUrl
 T URL pour les données du formulaire d’une tâche.
externalAppConfig
 T Configuration pour les formulaires de l’application tierce.
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. Quand une tâche est affectée à l’utilisateur/au groupe, la tâche 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 l’utilisateur connecté, sinon false.
name
 F Nom du propriétaire de la file d’attente.
qid F ID de la file d’attente.
type F Contient le type de la file d’attente.
0 - File d’attente de l’utilisateur.
1. File d’attente partagée.
2. File d’attente du groupe.
query T Contient la requête associée à un filtre. Cette requête est utilisée pour rechercher des tâches dans la liste de tâches complète.
tasks T Contient la liste de toutes les tâches qui appartiennent à un filtre.

  1. Absence du bureau

    Vous pouvez gérer votre planning d’absences du bureau et contrôler le flux des tâches qui vous sont affectées pendant 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 en cas d’absence du bureau de l’utilisateur.
isOutOfOffice
 F True si l’utilisateur est absent du bureau.
outOfOfficeDesignate
 F Contient des informations sur l’utilisateur affecté comme désignation principale par l’utilisateur.
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.
processus
 T Contient la liste de tous les processus disponibles pour l’utilisateur.
initialOutOfOfficeSettings
 T Contient les paramètres d’absence du bureau initiaux de l’utilisateur, qui sont récupérés au départ.
outOfOfficeSettings
 T Contient les paramètres d’absence du bureau modifiés.
userSearchHistory
 T Contient la liste des utilisateurs recherchés par l’utilisateur jusqu’à la date.

  1. Instance de processus

    Une instance de processus est créée lorsqu’un processus est appelé par le biais de workspace ou workbench.

Propriété Client uniquement Commentaires
description
 F Description de l’instance de processus
initiator F Nom de l’initiateur d’une instance de processus.
initiatorId F Identifiant de l’initiateur de l’instance de processus.
processCompleteTime
 F Horodatage indiquant quand le processus s’est achevé.
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 suspension
processName
 F Nom du processus.
processStartTime
 F Horodatage indiquant quand le processus a commencé.
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 du 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 Nom du processus.
processInstanceList
 T Liste des instances de processus pour ce processus.

  1. Object Affectation de tâche

    L’objet Affectation de tâche contient des informations sur l’affectation d’une tâche. Vous trouverez ci-dessous les propriétés de l’affectation d’une tâche.

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

  1. Objet ACL de la tâche

    L’objet ACL de la tâche contient des informations sur les autorisations telles que transférer, partager, consulter, etc. d’une tâche. Vous trouverez ci-dessous les propriétés de l’ACL de la tâche.

Propriété Client uniquement Commentaires
canAddAttachments
 F Si la valeur est true, des pièces jointes peuvent être ajoutées à une tâche.
canAddNotes
 F Si la valeur est true, des notes peuvent être ajoutées à une tâche.
canClaim
 F Si la valeur est true, la tâche ne peut pas être demandée.
canConsult
 F Si la valeur est true, la tâche peut être consultée.
canForward
 F Si la valeur est true, la tâche peut être transférée.
canShare
 F Si la valeur est 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. Vous trouverez ci-dessous les propriétés de l’objet pièce jointe.

Propriété Client uniquement Commentaires
creationDate
 F Horodatage de création de la pièce jointe.
creatorId
 F ID de l’utilisateur qui a ajouté la pièce jointe.
creatorName
 F Nom de l’utilisateur 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 dernière modification de la pièce jointe.
noteExtended
 F Si la valeur est 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 l’utilisateur.
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. Pour les notes uniquement.

  1. User

    Vous trouverez ci-dessous les propriétés de l’objet utilisateur.

Propriété Client uniquement Commentaires
address
 F Adresse de l’utilisateur.
commonName
 F Nom commun de l’utilisateur.
description
 F Description de l’utilisateur.
directGroupMemberships
 F Liste des groupes de l’utilisateur.
displayName
 F Nom d’affichage de l’utilisateur.
email
 F ID de courrier électronique de l’utilisateur.
isOutOfOffice
 F True si l’utilisateur est absent du bureau.
lastName
 F Nom de famille de l’utilisateur.
firstName
 F Prénom de l’utilisateur.
oid
 F ID de l’utilisateur.
org
 F Nom de l’entreprise de l’utilisateur.
postalAddress
 F Adresse postale de l’utilisateur.
telephone
 F Numéro du contact de l’utilisateur.
telephoneNumber
 F Numéro du contact de l’utilisateur.
userid
 F ID de connexion de l’utilisateur.

Sur cette page