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

CAUTION
AEM 6.4 a atteint la fin de la prise en charge étendue et cette documentation n’est plus mise à jour. Pour plus d’informations, voir notre période de support technique. Rechercher les versions prises en charge here.

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 catégorie
description
F
Description de la catégorie
parentOid
F
Contient l’ID 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

    Startpoint 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 Il 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.
    tâche 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 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 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. Il est défini lors de la conception du processus.
createTime
F
Contient l’horodatage de création de la tâche.
createdId
F
Il contient l’identifiant de l’utilisateur qui a créé la tâche.
currentAssignment
F
Il contient des détails sur l’affectation actuelle de la tâche.
échéance
F
Il contient l’horodatage qui indique quand une tâche atteindra son délai d’expiration.
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
Il 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, lors de l’ouverture de la tâche, le formulaire s’exécute à l’écran 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 du prochain rappel.
priorité
F
Contient la priorité de la tâche.
1 = Priorité la plus élevée
2 = Priorité élevée
3 = Priorité normale
4 = priorité faible
5 = Priorité la plus faible
processInstanceId
F
Identifiant de l’instance de processus dont la tâche fait partie.
processInstanceStatus
F
État de l’instance de processus de la tâche.
rappderCount
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 de 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. Ce ticket d’image est utilisé dans le champ imageUrl de la tâche, pour obtenir l’image de 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 une fois le processus démarré.)
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 la date limite.)
102 = Interrompu
stepName
F
Contient le nom du jeu de tâches lors de la conception du processus.
summaryUrl
F
Contient l’URL de résumé de la tâche.
taskACL
F
Il s’agit de la liste de contrôle d’accès d’une tâche.
taskId
F
Identifiant d’une tâche.
updateTime
F
Horodatage de la dernière mise à jour de la tâche.
formUrl
T
Contient l’URL du formulaire pour 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 au format pdf pour, swf form, etc.
showDirectActions
T
Si la valeur est true, les actions d’itinéraire sont visibles dans Workspace.
showACLActions
T
Si la valeur est true, des actions telles que transférer, consulter, partager sont visibles dans Workspace.
supportsOffline
T
Si la valeur est true, le formulaire peut être déconnecté. Il s’agit uniquement de formulaires PDF.
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 par lecteur lorsque le formulaire pdf ne contient pas de 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
Elle contient la liste des tâches 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
Il contient toutes les actions qui peuvent être entreprises sur tâche.
availableCommands.directCommands
T
Elle contient toutes les actions d’itinéraire disponibles pour une tâche.
availableCommands.taskACLCommands
T
Il contient des commandes telles que transférer, partager et consulter si elles sont disponibles pour une tâche.
availableCommands.otherCommands
T
Il contient des commandes telles que verrouiller, déverrouiller, abandonner, revenir, demander, etc., si possible.
processInstanceInfo
T
Il contient des informations sur l’instance de processus de la tâche.
processVariables
T
Il 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 détails sur l’itinéraire et son message de confirmation correspondant, le cas échéant.
dataUrl
T
Il s’agit de l’URL pour les données du formulaire d’une tâche.
externalAppConfig
T
Il s’agit de la configuration des formulaires d’application tiers.
submit
T
True si la tâche est envoyée.
attachments
T
Liste des pièces jointes pour une tâche.
affectations
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 assignée à un utilisateur/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
Identifiant 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 à partir d’une liste de tâches complète.
tâches
T
Elle 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’existe 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 les détails de l’utilisateur désigné comme Principal 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
Elle contient la liste de tous les processus disponibles pour l’utilisateur.
initialOutOfOfficeSettings
T
Il contient les paramètres d’absence du bureau initiaux de l’utilisateur, qui sont récupérés initialement.
outOfOfficeSettings
T
Contient les paramètres d’absence du bureau modifiés.
userSearchHistory
T
Il contient la liste des utilisateurs qui sont recherchés par l’utilisateur connecté jusqu’à la date.
  1. Instance de processus

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

Propriété
Client uniquement
Commentaires
description
F
Description de l’instance de processus
initiateur
F
Nom de l’initiateur d’une instance de processus.
initiatorId
F
ID de l’initiateur de l’instance de processus.
processCompleteTime
F
Horodatage à la fin du processus.
processInstanceId
F
ID de l’instance de processus.
processInstanceStatus
F
0 = Lancé
1 = En cours
2 = Terminé
3 = Fin
4 = Interrompu
5 = Arrêt
6 = Suspendu
7 = Suspendre
8 = Sans suspension
processName
F
Nom du processus.
processStartTime
F
Horodatage au début 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â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 de la tâche.

Propriété
Client uniquement
Commentaires
assignmentCreateTime
F
Horodatage de création de cette affectation de tâche.
assignmentType
F
0 = Attribution 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 = Réaffectation (la tâche a été affectée au propriétaire actuel de la tâche après la réaffectation.)
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
Identifiant 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. Voici 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 à la tâche.
canAddNotes
F
Si la valeur est true, des notes peuvent être ajoutées à la tâche.
canClaim
F
Si la valeur est true, la tâche peut ê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 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 attachment.

Propriété
Client uniquement
Commentaires
createdDate
F
Horodatage lors de la 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 la 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
Identifiant 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
Il contient la date de création des pièces jointes 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. Cette option est réservée aux notes.
  1. User

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

Propriété
Client uniquement
Commentaires
adresse
F
Adresse de l’utilisateur.
commonName
F
Nom commun de l’utilisateur.
description
F
Description de l’utilisateur.
directGroupMemberships
F
Liste du groupe 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 l’utilisateur.
firstName
F
Prénom de l’utilisateur.
oid
F
ID de l’utilisateur.
org
F
Nom de l’organisation de l’utilisateur.
postalAddress
F
Adresse postale de l’utilisateur.
téléphone
F
Numéro de contact de l’utilisateur.
telephoneNumber
F
Numéro de contact de l’utilisateur.
userid
F
Identifiant de connexion de l’utilisateur.
recommendation-more-help
a6ebf046-2b8b-4543-bd46-42a0d77792da