AEM Forms Workspace – JSON-Objektbeschreibung aem-forms-workspace-json-object-description

CAUTION
AEM 6.4 hat das Ende der erweiterten Unterstützung erreicht und diese Dokumentation wird nicht mehr aktualisiert. Weitere Informationen finden Sie in unserer technische Unterstützung. Unterstützte Versionen suchen here.

Die in AEM Forms Workspace verwendeten JSON-Objekte werden unten beschrieben.

  1. Kategorie

    Kategorien sind auf der Registerkarte "Startprozess"des Arbeitsbereichs vorhanden. Diese Kategorien werden verwendet, um die Startpunkte zu klassifizieren.

Eigenschaft
Nur Client
Kommentare
name
F
Kategoriename
id
F
Kategorie-ID
description
F
Kategorienbeschreibung
parentOid
F
Enthält OID der übergeordneten Kategorie
startPointsList
T
Enthält eine Liste aller Startpunkte, die in einer Kategorie vorhanden sind
categoryList
T
Enthält eine Liste der direkt untergeordneten Kategorien einer Kategorie
NOTE
Alle Startpunkte und Favoriten sind Kategorien, die clientseitig definiert werden. Die Kategorie "Favorit"enthält alle Startpunkte, die vom Benutzer als Favorit markiert werden. Die Kategorie "Alle Startpunkte"enthält alle Startpunkte.
  1. Startpunkt

    Startpunkt wird verwendet, um einen Prozess aus dem Arbeitsbereich zu starten, wenn er aufgerufen wird.

    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
    Eigenschaft Nur Client Kommentare
    categoryId F Sie enthält die ID der Kategorie, zu der der Startpunkt gehört.
    description F Es enthält eine Beschreibung für einen Startpunkt.
    name F Es enthält den Namen des Startpunkts.
    serializedImageTicket F Es enthält das Bild-Ticket, das dem Startpunkt entspricht. Dieses Bild-Ticket wird im imageUrl-Feld des Startpunkts verwendet, um vom Server ein Bild für den Startpunkt zu erhalten.
    serviceName F Es enthält den Namen des Diensts für den Startpunkt.
    startpointId F Es enthält die ID des Startpunkts.
    isFavorite T Gibt an, ob der Startpunkt ein Favorit ist oder nicht. True , wenn der Startpunkt der Favorit ist, sonst false.
    isDefaultImage T Gibt an, ob für den Prozess ein Bild angegeben ist oder nicht. "True", wenn kein Bild mit dem Prozess verknüpft ist, andernfalls "false".
    Aufgabe T Es enthält Aufgaben, die erstellt werden, wenn der Startpunkt aufgerufen wird.
    imageUrl T Sie enthält die URL des Bildes, das dem Startpunkt entspricht.
  2. Aufgabe

    Aufgaben werden Benutzern/Gruppen zugewiesen und enthalten eine Benutzeroberfläche - ein Formular oder ein Guide (nicht mehr unterstützt) -, die mit Daten gefüllt werden kann. Wenn Benutzern eine Aufgabe zugewiesen wird, erhalten sie das Formular oder den Guide zum Ausfüllen und Senden.

Eigenschaft
Nur Client
Kommentare
classOfTask
F
Die Aufgabenklasse ist "LC8", wenn die Aufgabe lc8 ist, sonst "Standard".
completeTime
F
Sie enthält den Zeitstempel, mit dem die Aufgabe abgeschlossen ist.
consultGroupId
F
Es enthält die Kennung einer Gruppe, zu der die Aufgabe gehört werden kann. Sie wird während der Prozessentwicklung festgelegt.
createTime
F
Sie enthält den Zeitstempel, mit dem die Aufgabe erstellt wird.
creationId
F
Es enthält die ID des Benutzers, der die Aufgabe erstellt hat.
currentAssignment
F
Es enthält Details zur aktuellen Zuweisung der Aufgabe.
deadline
F
Er enthält den Zeitstempel, der angibt, wann eine Aufgabe ihren Termin erreicht.
description
F
Es enthält eine Beschreibung der Aufgabe.
displayName
F
Es enthält den Anzeigenamen der Aufgabe.
forwardGroupId
F
Es enthält die Kennung einer Gruppe, an die die Aufgabe weitergeleitet werden kann. Sie wird während der Prozessentwicklung festgelegt.
instructions
F
Es enthält Anweisungen für eine Aufgabe.
isLocked
F
True , wenn die Aufgabe gesperrt ist.
isMustOpenToComplete
F
True , wenn das Aufgabenformular zum Abschließen der Aufgabe geöffnet werden muss.
isOpenFullScreen
F
Wenn "true", nimmt das Formular beim Öffnen der Aufgabe beim ersten Mal den Vollbildmodus vor.
isRouteSelectionRequired
F
Wenn "true", muss die Route ausgewählt werden, um die Aufgabe abzuschließen.
isShowAttachments
F
Anlagen werden angezeigt, wenn sie wahr sind.
isStartTask
F
Wenn "true", wird die Aufgabe vom Startpunkt aus erstellt.
isVisible
F
True , wenn die Aufgabe im Arbeitsbereich sichtbar ist.
nextReminder
F
Zeitstempel für die nächste Erinnerung.
priority
F
Sie enthält die Priorität der Aufgabe.
1 = höchste Priorität
2 = Hohe Priorität
3 = Mittlere Priorität
4 = Niedrige Priorität
5 = Niedrigste Priorität
processInstanceId
F
ID der Prozessinstanz, zu der die Aufgabe gehört.
processInstanceStatus
F
Status der Prozessinstanz der Aufgabe.
reminderCount
F
Es enthält die Anzahl der Erinnerungen für die Aufgabe.
routeList
F
Es enthält eine Liste der Routen, die mit der Aufgabe verknüpft sind. Der Benutzer kann die Aufgabe abschließen, indem er eine der Routen aus der Routenliste auswählt.
selectedRoute
F
Es enthält den Namen der Route, die zum Zeitpunkt der Aufgabenfertigstellung ausgewählt wurde.
serializedImageTicket
F
Es enthält ein Bild-Ticket, das der Aufgabe entspricht. Dieses Bild-Ticket wird im imageUrl-Feld der Aufgabe verwendet, um vom Server ein Bild für die Aufgabe zu erhalten.
serviceName
F
Es enthält den Namen des Diensts für die Aufgabe.
serviceTitle
F
Es enthält den Titel des Diensts für die Aufgabe.
status
F
1 = Erstellt (Aufgabe wird vom Startpunkt erstellt.)
2 = Erstellt und gespeichert (Aufgabe wird vom Startpunkt erstellt und gespeichert.)
3 = Zugewiesen (Aufgabe wird dem Benutzer zugewiesen, nachdem der Prozess gestartet wurde.)
4 = Zugeordnet und gespeichert (Aufgabe wird zugewiesen und gespeichert.)
100 = Abgeschlossen (Aufgabe ist abgeschlossen.)
101 = Terminiert (Aufgabe hat den Termin erreicht.)
102 = Beendet
stepName
F
Es enthält den Namen der Aufgabe, die während der Prozessgestaltung festgelegt wurde.
summaryUrl
F
Sie enthält die Aufgabenzusammenfassungs-URL.
taskACL
F
Es handelt sich um eine Zugriffssteuerungsliste für eine Aufgabe.
taskId
F
ID einer Aufgabe.
updateTime
F
Zeitstempel der letzten Aktualisierung der Aufgabe.
formUrl
T
Sie enthält die URL des Formulars für eine Aufgabe.
taskFormType
T
Enthält den Aufgabenformulartyp. Mithilfe dieses Felds wird die Aufgabe auf dem Client als pdf für , SWF-Formular usw. wiedergegeben.
showDirectActions
T
Wenn "true", sind Route-Aktionen im Arbeitsbereich sichtbar.
showACLActions
T
Wenn "true", sind Aktionen wie "forward", "consult", "share"im Arbeitsbereich sichtbar.
supportsOffline
T
Wenn "true", kann das Formular offline geschaltet werden. Dies gilt nur für PDF-Formulare.
supportsSave
T
Wenn "true", kann der Benutzer die Aufgabe speichern.
readerSubmitOptions
T
Dieses Objekt enthält Optionen, die zum Senden von PDF-Formularen per Leser verwendet werden, falls das PDF-Formular keine Senden-Schaltfläche enthält.
isDefaultImage
T
Gibt an, ob für den Prozess ein Bild angegeben ist oder nicht. "True", wenn kein Bild mit dem Prozess verknüpft ist, andernfalls "false".
historyTaskList
T
Er enthält eine Liste der Aufgaben, die auf der Registerkarte Verlauf der Aufgabendetails verwendet werden.
isOwner
T
True , wenn der angemeldete Benutzer Eigentümer der Aufgabe ist.
availableCommands
T
Es enthält alle Aktionen, die für die Aufgabe ausgeführt werden können.
availableCommands.directCommands
T
Sie enthält alle Route-Aktionen, die für eine Aufgabe verfügbar sind.
availableCommands.taskACLCommands
T
Es enthält Befehle wie Weiterleiten, Freigeben und Besprechen, falls für eine Aufgabe verfügbar.
availableCommands.otherCommands
T
Sie enthält Befehle wie Sperren, Entsperren, Abbrechen, Zurückgeben, Anfordern usw., sofern verfügbar.
processInstanceInfo
T
Es enthält Informationen zur Prozessinstanz der Aufgabe.
processVariables
T
Es enthält ein Array von Objekten aus Prozessvariablen, sofern vorhanden.
pendingTasks
T
Sie enthält eine Liste der ausstehenden Aufgaben für die Prozessinstanz der Aufgabe.
userActions
T
Es handelt sich um eine Gruppe von Objekten. Jedes Objekt enthält Details zur Route und die entsprechende Bestätigungsmeldung, sofern vorhanden.
dataUrl
T
Dies ist die URL für die Daten des Aufgabenformulars.
externalAppConfig
T
Dies ist die Konfiguration für Formulare von Drittanbieteranwendungen.
Gesendet
T
True , wenn die Aufgabe gesendet wird.
Anlagen
T
Liste der Anlagen für eine Aufgabe.
Zuweisungen
T
Liste der Zuweisungen einer Aufgabe.
  1. Filter

    Der Filter ist im Grunde eine Benutzerwarteschlange oder eine Gruppe. Wenn eine Aufgabe einem Benutzer/einer Gruppe zugewiesen wird, wird die Aufgabe der entsprechenden Warteschlange hinzugefügt.

Eigenschaft
Nur Client
Kommentare
isDefault
F
True , wenn die Warteschlange die Standardwarteschlange des angemeldeten Benutzers ist, andernfalls false.
name
F
Name des Eigentümers der Warteschlange.
qid
F
Kennung der Warteschlange.
Typ
F
Enthält den Typ der Warteschlange.
0 - Benutzerwarteschlange.
1. Freigegebene Warteschlange.
2. Gruppenwarteschlange.
Abfrage
T
Dies enthält eine Abfrage, die mit einem Filter verknüpft ist. Diese Abfrage wird verwendet, um Aufgaben aus der vollständigen Aufgabenliste zu durchsuchen.
Aufgaben
T
Er enthält eine Liste aller Aufgaben, die zu einem Filter gehören.
  1. Abwesenheit

    Sie können Ihren Abwesenheitszeitplan verwalten und den Ablauf der Ihnen zugewiesenen Aufgaben in Ihrer Abwesenheit steuern.

Eigenschaft
Nur Client
Kommentare
dateRanges
F
Sie enthält Array-Objekte aus Abwesenheitszeitplänen eines Benutzers. In jedem Zeitplanobjekt enthält das Feld startDate das Startdatum des Zeitplans und endDate das Enddatum des Zeitplans. Wenn im Zeitplan das Feld endDate den Wert Null enthält, bedeutet dies, dass der Benutzer das Enddatum des Abwesenheitszeitplans nicht geplant hat.
isNoPrimaryDesignate
F
"true", wenn kein primärer Vertreter vorhanden ist, falls der Benutzer abwesend ist.
isOutOfOffice
F
"true", wenn der Benutzer abwesend ist.
outOfOfficeDesignate
F
Es enthält Details zu Benutzern, die vom Benutzer als primäre Benennung zugewiesen werden.
processSpecificDesignates
F
Sie enthält eine Gruppe von Objekten für prozessspezifische Abwesenheitsvertretungen. In jedem prozessspezifischen designierten Objekt enthält processName den Namen des Prozesses; isNotDesignated hat den Wert „true“, wenn dem entsprechenden Prozess kein Benutzer zugeordnet ist; userDesignated hat den Wert Null, wenn kein Benutzer Details dem Benutzer zugeordnet hat, der für den entsprechenden Vorgang vorgesehen war.
Prozesse
T
Es enthält eine Liste aller Prozesse, die für den Benutzer verfügbar sind.
initialOutOfOfficeSettings
T
Sie enthält die anfänglichen Abwesenheitseinstellungen des Benutzers, die zunächst abgerufen werden.
outOfOfficeSettings
T
Sie enthält geänderte Abwesenheitseinstellungen.
userSearchHistory
T
Es enthält eine Liste der Benutzer, die vom angemeldeten Benutzer bis dato durchsucht werden.
  1. Prozessinstanz

    Eine Prozessinstanz wird erstellt, wenn ein Prozess über Workspace oder Workbench aufgerufen wird.

Eigenschaft
Nur Client
Kommentare
description
F
Beschreibung der Prozessinstanz
Initiator
F
Name des Initiators einer Prozessinstanz.
initiatorId
F
ID des Initiators der Prozessinstanz.
processCompleteTime
F
Zeitstempel zum Zeitpunkt, zu dem der Prozess abgeschlossen ist.
processInstanceId
F
ID der Prozessinstanz.
processInstanceStatus
F
0 = Initiiert
1 = Läuft
2 = Abgeschlossen
3 = Abgeschlossen
4 = Beendet
5 = Beenden
6 = Ausgesetzt
7 = Aussetzen
8 = Aufhebung der Aussetzung
processName
F
Name des Prozesses.
processStartTime
F
Zeitstempel zum Zeitpunkt, zu dem der Prozess gestartet wurde.
processVariables
F
Array von Objekten aus Prozessvariablen. Jedes Objekt einer Prozessvariable enthält name, den Namen der Prozessvariable, value, den Wert der Prozessvariable und type, den Typ der Prozessvariable.
tasklist
T
Von dieser Prozessinstanz erzeugte Aufgaben.
  1. Prozessname
Eigenschaft
Nur Client
Kommentare
processMajorVersion
F
Hauptversion eines Prozesses.
processMinorVersion
F
Geringfügige Version eines Prozesses.
processName
F
Name des Prozesses.
processTitle
F
Titel des Prozesses.
processInstanceList
T
Liste der Prozessinstanzen für diesen Prozess.
  1. Aufgabenzuweisungsobjekt

    Das Aufgabenzuweisungsobjekt enthält Informationen zur Aufgabenzuweisung. Im Folgenden finden Sie die Eigenschaften der Aufgabenzuweisung.

Eigenschaft
Nur Client
Kommentare
assignmentCreateTime
F
Zeitstempel der Erstellung dieser Aufgabenzuweisung.
assignmentType
F
0 = Erstzuweisung
1 = Weiterleiten (Aufgabe wurde an den aktuellen Eigentümer der Aufgabe weitergeleitet.)
2 = Zurückgegeben (Aufgabe wurde vom vorherigen Eigentümer der Aufgabe an den aktuellen Eigentümer der Aufgabe zurückgegeben.)
3 = Angefordert (Aufgabe wurde vom aktuellen Eigentümer der Aufgabe angefordert.)
4 = Eskalation (Aufgabe wurde nach der Eskalation dem aktuellen Eigentümer der Aufgabe zugewiesen.)
5 = Zugewiesener Administrator (Administrator hat die Aufgabe dem aktuellen Eigentümer der Aufgabe zugewiesen.)
6 = Consulted (Aufgabe wurde zum aktuellen Eigentümer der Aufgabe konsultiert.)
assignmentUpdateTime
F
Zeitstempel der Aktualisierung dieser Aufgabenzuweisung.
queueId
F
Kennung der Warteschlange des aktuellen Eigentümers der Aufgabe.
queueOwner
F
Name des aktuellen Eigentümers der Aufgabe.
queueOwnerId
F
ID des aktuellen Eigentümers der Aufgabe.
  1. Task ACL Object

    Das Task ACL-Objekt enthält Informationen zu Berechtigungen wie Weiterleiten, Freigeben, Besprechen usw. einer Aufgabe. Im Folgenden finden Sie die Eigenschaften der ACL der Aufgabe.

Eigenschaft
Nur Client
Kommentare
canAddAttachments
F
Wenn "true", können der Aufgabe Anlagen hinzugefügt werden.
canAddNotes
F
Wenn "true", können der Aufgabe Notizen hinzugefügt werden.
canClaim
F
Wenn "true", kann die Aufgabe angefordert werden.
canConsult
F
Wenn "true", kann die Aufgabe besprochen werden.
canForward
F
Wenn "true", kann die Aufgabe weitergeleitet werden.
canShare
F
Wenn "true", kann die Aufgabe freigegeben werden.
  1. Aufgabenanlage

    Anlagen können einer Aufgabe hinzugefügt werden. Anlage kann vom Typ Anlage und Notiz sein. Im Folgenden finden Sie die Eigenschaften des Anlagenobjekts.

Eigenschaft
Nur Client
Kommentare
creationDate
F
Zeitstempel der Anlagenerstellung.
creatorId
F
Kennung des Benutzers, der die Anlage hinzugefügt hat.
creatorName
F
Name des Benutzers, der den Anhang hinzugefügt hat.
description
F
Beschreibung der Anlage.
fileName
F
Name des Anhangs.
id
F
Kennung des Anhangs.
lastModifiedDate
F
Zeitstempel der letzten Anlagenänderung.
noteExtended
F
Wenn "true", ist die Notiz eine erweiterte (lange) Notiz.
Berechtigungen
F
Berechtigungen, die mit einer Anlage verknüpft sind. Das Feld allowRead steht für die Leseberechtigung; allowWrite steht für die Schreibberechtigung, allowDelete steht für die Berechtigung zum Löschen.
size
F
Größe des Anhangs in Byte.
taskId
F
Kennung der Aufgabe, der ein Anhang hinzugefügt wird.
Typ
F
Der Typ ist „attachment“ für Dateien und „note“ für Anmerkungen.
formattedCreationDate
T
Es enthält das Erstellungsdatum des Anhangs entsprechend den Benutzeroberflächeneinstellungen des Benutzers.
formattedDescription
T
Formatierte Anlagenbeschreibung Wird verwendet, um Sonderzeichen anzuzeigen, die in der Anlagenbeschreibung in AEM Forms Workspace vorhanden sind.
formattedFileName
T
Formatierter Anlagenname Wird verwendet, um Sonderzeichen im Anlagennamen in AEM Forms Workspace anzuzeigen. Dies gilt nur für Notizen.
  1. User

    Im Folgenden finden Sie die Eigenschaften des Benutzerobjekts.

Eigenschaft
Nur Client
Kommentare
Adresse
F
Adresse des Benutzers.
commonName
F
Allgemeiner Name des Benutzers.
description
F
Beschreibung des Benutzers.
directGroupMemberships
F
Liste der Benutzergruppe.
displayName
F
Anzeigename des Benutzers.
email
F
E-Mail-ID des Benutzers.
isOutOfOffice
F
"true", wenn der Benutzer abwesend ist.
lastName
F
Nachname des Benutzers.
firstName
F
Vorname des Benutzers.
oid
F
Kennung des Benutzers.
org
F
Name der Organisation des Benutzers.
postalAddress
F
Postanschrift des Benutzers.
Telefon
F
Kontaktnummer des Benutzers.
telephoneNumber
F
Kontaktnummer des Benutzers.
userid
F
Anmelde-ID des Benutzers.
recommendation-more-help
a6ebf046-2b8b-4543-bd46-42a0d77792da