DokumentationAEM 6.5Benutzerhandbuch

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

Last update: Mon Jul 15 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Themen:

Erstellt für:

  • Admin
  • Benutzende
  • Entwickler

JSON-Objekte, die in AEM Forms Workspace verwendet werden, werden unten beschrieben.

  1. Kategorie

    Kategorien sind auf der Workspace-Registerkarte „Prozess starten“ zu finden. Diese Kategorien werden verwendet, um die Startpunkte zu klassifizieren.

Eigenschaft
Nur Client
Kommentare
name
F
Kategoriename.
id
F
Kategorie-ID.
description
F
Kategoriebeschreibung.
parentOid
F
Enthält die 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 Client-seitig definiert werden. Die Kategorie „Favoriten“ enthält alle Startpunkte, die Benutzende als Favoriten markieren. Die Kategorie „Alle Startpunkte“ enthält alle Startpunkte.

  1. Startpoint

    Ein 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 Enthält die ID der Kategorie, zu der der Startpunkt gehört.
    description F Enthält die Beschreibung eines Startpunkts.
    name F 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 Enthält den Namen des Dienstes für den Startpunkt.
    startpointId F Enthält die ID des Startpunkts.
    isFavorite T Gibt an, ob der Startpunkt ein Favorit ist oder nicht. „True“, wenn der Startpunkt ein Favorit ist, sonst „false“.
    isDefaultImage T Gibt an, ob für den Prozess ein Bild angegeben wurde oder nicht. „True“, wenn dem Prozess kein Bild zugeordnet ist, sonst „false“.
    task T Enthält eine Aufgabe, die beim Aufrufen des Startpunkts erstellt wird.
    imageUrl T Enthält die URL des Bildes, das dem Startpunkt entspricht.

  2. Aufgabe

    Aufgaben werden Benutzenden/Gruppen zugewiesen und umfassen eine Benutzeroberfläche – ein Formular oder einen Leitfaden (veraltet) –, die mit Daten gefüllt werden kann. Wenn Benutzenden eine Aufgabe zugewiesen wird, erhalten sie das Formular bzw. den Leitfaden zum Ausfüllen und Absenden.

Eigenschaft
Nur Client
Kommentare
classOfTask
F
Die Aufgabenklasse ist „LC8“, wenn es sich um eine LC8-Aufgabe handelt, andernfalls „Standard“.
completeTime
F
Enthält den Zeitstempel, wenn die Aufgabe abgeschlossen ist.
consultGroupId
F
Enthält die ID einer Gruppe, für die die Aufgabe konsultiert werden kann. Wird während des Prozessentwurfs festgelegt.
createTime
F
Enthält den Zeitstempel, wenn die Aufgabe erstellt wird.
creationId
F
Enthält die ID der Person, die die Aufgabe erstellt hat.
currentAssignment
F
Enthält Details zur aktuellen Aufgabenzuweisung.
deadline
F
Enthält den Zeitstempel, wann eine Aufgabe ihre Frist erreicht.
description
F
Enthält die Beschreibung der Aufgabe.
displayName
F
Enthält den Anzeigenamen der Aufgabe.
forwardGroupId
F
Enthält die ID einer Gruppe, an die die Aufgabe weitergeleitet werden kann.  Wird während des Prozessentwurfs festgelegt.
instructions
F
Enthält Anweisungen für eine Aufgabe.
isLocked
F
„True“, wenn die Aufgabe gesperrt ist.
isMustOpenToComplete
F
„True“, wenn das Aufgabenformular geöffnet werden muss, um die Aufgabe abzuschließen.
isOpenFullScreen
F
Wenn „true“, nimmt das Formular beim erstmaligen Öffnen den vollständigen Bildschirm ein.
isRouteSelectionRequired
F
Wenn „true“, muss die Route ausgewählt werden, um die Aufgabe abzuschließen.
isShowAttachments
F
Wenn „true“, werden Anhänge angezeigt.
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
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
Enthält die Anzahl der Erinnerungen für die Aufgabe.
routeList
F
Enthält eine Liste der mit der Aufgabe verbundenen Routen. Benutzende können die Aufgabe abschließen, indem sie eine Route aus der Liste der Routen auswählen.
selectedRoute
F
Enthält den Namen der Route, die beim Abschließen der Aufgabe ausgewählt wurde.
serializedImageTicket
F
Enthält das 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
Enthält den Namen des Dienstes für die Aufgabe.
serviceTitel
F
Enthält den Titel des Dienstes 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 der Person zugewiesen, nachdem der Prozess gestartet wurde.)
4 = Zugewiesen und gespeichert (Aufgabe wird zugewiesen und gespeichert.)
100 = Abgeschlossen (Aufgabe wird abgeschlossen.)
101 = Termin erreicht (Aufgabe hat den Termin erreicht.)
102 = Beendet
stepName
F
Enthält den Namen der Aufgabe, die während der Entwicklung des Prozesses festgelegt wurde.
summaryUrl
F
Enthält die Aufgabenzusammenfassungs-URL.
taskACL
F
Die Zugriffssteuerungsliste für eine Aufgabe.
taskId
F
Die ID einer Aufgabe.
updateTime
F
Der Zeitstempel der letzten Aufgabenaktualisierung.
formUrl
T
Enthält die URL des Formulars für eine Aufgabe.
taskFormType
T
Enthält den Formulartyp der Aufgabe. Wenn dieses Feld verwendet wird, wird die Aufgabe auf dem Client als PDF-Formular, SWF-Formular usw. gerendert.
showDirectActions
T
Wenn „true“, sind Route-Aktionen in Workspace sichtbar.
showACLActions
T
Wenn „true“, sind Aktionen wie Weiterleiten, Beraten und Freigeben in Workspace sichtbar.
supportsOffline
T
Wenn „true“, kann das Formular offline verwendet werden. Dies gilt nur für PDF-Formulare.
supportsSave
T
Wenn „true“, können Benutzende die Aufgabe speichern.
readerSubmitOptions
T
Dieses Objekt enthält Optionen, die verwendet werden, um PDF-Formulare über den Reader zu senden, wenn das PDF-Formular keine Schaltfläche zum Senden enthält.
isDefaultImage
T
Gibt an, ob für den Prozess ein Bild angegeben wurde oder nicht. „true“, wenn kein Bild mit dem Prozess verknüpft ist, andernfalls „false“.
historyTaskList
T
Enthält eine Liste von Aufgaben, die auf der Verlaufsregisterkarte der Aufgabendetails verwendet werden.
isOwner
T
„true“, wenn die angemeldete Person für die Aufgabe verantwortlich ist.
availableCommands
T
Enthält alle Aktionen, die für eine Aufgabe ausgeführt werden können.
availableCommands.directCommands
T
Enthält alle Route-Aktionen, die für eine Aufgabe verfügbar sind.
availableCommands.taskACLCommands
T
Enthält Befehle wie „Weiterleiten“, „Freigeben“ und „Besprechen“, wenn sie für eine Aufgabe verfügbar sind.
availableCommands.otherCommands
T
Enthält Befehle wie „Sperren“, „Sperre aufheben“, „Abbrechen“, „Zurückgeben“ und „Anfordern“ usw.
processInstanceInfo
T
Enthält Informationen über die Prozessinstanz der Aufgabe.
processVariables
T
Enthält ein Array von Objekten aus Prozessvariablen, sofern vorhanden.
pendingTasks
T
Enthält eine Liste der ausstehenden Aufgaben für die Aufgabenprozessinstanz.
userActions
T
Ein Array von Objekten. Jedes Objekt enthält Informationen über eine Route und die entsprechende Bestätigungsmeldung, sofern vorhanden.
dataUrl
T
Die URL für die Daten eines Aufgabenformulars.
externalAppConfig
T
Dies ist die Konfiguration für Anwendungsformulare von Drittanbietern.
submitted
T
„True“, wenn die Aufgabe übermittelt wird.
attachments
T
Liste der Anhänge für eine Aufgabe.
assignments
T
Liste der Zuweisungen einer Aufgabe.

  1. Filter

    „Filter“ ist im Grunde eine Warteschlange von Benutzenden oder Gruppen. Wenn eine Aufgabe einer Person oder einer Gruppe zugewiesen wird, wird die Aufgabe zur entsprechenden Warteschlange hinzugefügt.

Eigenschaft
Nur Client
Kommentare
isDefault
F
„True“, wenn die Warteschlange die Standardwarteschlange der angemeldeten Person ist, sonst „false“.
name
F
Name der Inhaberin oder des Inhabers der Warteschlange.
qid
F
ID der Warteschlange.
Typ
F
Enthält den Typ der Warteschlange.
0 – Benutzerwarteschlange.
1. Freigegebene Warteschlange.
2. Gruppenwarteschlange.
query
T
Enthält eine Abfrage, die einem Filter zugeordnet ist.  Diese Abfrage wird verwendet, um Aufgaben aus der vollständigen Aufgabenliste zu durchsuchen.
tasks
T
Enthält eine Liste aller Aufgaben, die zu einem Filter gehören.

  1. Out-of-Office

    Sie können Ihren Abwesenheitsplan verwalten und den Ablauf der Ihnen zugewiesenen Aufgaben während Ihrer Abwesenheit steuern.

Eigenschaft
Nur Client
Kommentare
dateRanges
F
Enthält Array-Objekte von Abwesenheitsplänen von Benutzenden. 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 es keine primären Beauftragten gibt, falls die Person nicht im Büro ist.
isOutOfOffice
F
„True“, wenn die Person nicht im Büro ist.
outOfOfficeDesignate
F
Enthält Details zur Person, die als primär Beauftragte zugewiesen wurde.
processSpecificDesignates
F
Enthält eine Reihe von Objekten für prozessspezifische Abwesenheitsnotizen.  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.
processes
T
Enthält eine Liste aller Prozesse, die der Person stehen.
initialOutOfOfficeSettings
T
Enthält anfängliche Abwesenheitseinstellungen der Person, die zunächst abgerufen werden.
outOfOfficeSettings
T
Enthält geänderte Abwesenheitseinstellungen.
userSearchHistory
T
Enthält eine Liste der Benutzenden, die von einer angemeldeten Person bis zum Datum gesucht wurden.

  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 der Initiatorin bzw. des Initiators einer Prozessinstanz.
initiatorId
F
ID der Initiatorin bzw. des Initiators der Prozessinstanz.
processCompleteTime
F
Zeitstempel, wenn der Prozess abgeschlossen ist.
processInstanceId
F
ID der Prozessinstanz.
processInstanceStatus
F
0 = Initiiert
1 = Wird ausgeführt
2 = Abgeschlossen
3 = Wird abgeschlossen
4 = Beendet
5 = Wird beendet
6 = Ausgesetzt
7 = Wird ausgesetzt
8 = Aussetzung wird aufgehoben
processName
F
Name des Prozesses.
processStartTime
F
Zeitstempel des Prozessstarts.
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 generierte Aufgaben.
  1. Prozessname
Eigenschaft
Nur Client
Kommentare
processMajorVersion
F
Hauptversion eines Prozesses.
processMinorVersion
F
Nebenversion eines Prozesses.
processName
F
Name des Prozesses.
processTitle
F
Titel des Prozesses.
processInstanceList
T
Liste der Prozessinstanzen für diesen Prozess.

  1. Aufgabenzuweisungsobjekt

    Ein Aufgabenzuweisungsobjekt enthält Informationen über die Zuweisung einer Aufgabe. Im Folgenden sind die Eigenschaften der Zuweisung einer Aufgabe aufgeführt.

Eigenschaft
Nur Client
Kommentare
assignmentCreateTime
F
Zeitstempel der Erstellung einer Aufgabenzuweisung.
assignmentType
F
0 = Erste Zuweisung
1 = Weiterleiten (Aufgabe wurde an die aktuell für die Aufgabe verantwortliche Person weitergeleitet.)
2 = Zurückgegeben (Die zuvor für die Aufgabe verantwortliche Person hat die Aufgabe der aktuell für die Aufgabe verantwortlichen Person zurückgegeben.)
3 = Angefordert (Aufgabe wurde von der aktuell für die Aufgabe verantwortlichen Person angefordert.)
4 = Eskalation (Aufgabe wurde nach der Eskalation der aktuell für die Aufgabe verantwortlichen Person zugewiesen.)
5 = Administratorseitig zugewiesen (Admin hat die Aufgabe der aktuell für die Aufgabe verantwortlichen Person zugewiesen.)
6 = Besprechen (Aufgabe wurde der aktuell für die Aufgabe verantwortlichen Person zum Besprechen zugewiesen.)
assignmentUpdateTime
F
Zeitstempel, wenn diese Zuweisung einer Aufgabe aktualisiert wird.
queueId
F
ID der Warteschlange der aktuellen Inhaberin bzw. des aktuellen Inhabers der Aufgabe.
queueOwner
F
Name der aktuellen Inhaberin bzw. des aktuellen Inhabers der Aufgabe.
queueOwnerId
F
ID der aktuellen Inhaberin bzw. des aktuellen Inhabers der Aufgabe.

  1. Aufgaben-ACL-Objekt

    Das Aufgaben-ACL-Objekt enthält Informationen zu Berechtigungen wie Weiterleiten, Freigeben und Konsultieren einer Aufgabe. Im Folgenden sind die Eigenschaften der ACL der Aufgabe aufgeführt.

Eigenschaft
Nur Client
Kommentare
canAddAttachments
F
Wenn „true“, können Anhänge zur Aufgabe hinzugefügt werden.
canAddNotes
F
Wenn „true“, können der Aufgabe Anmerkungen hinzugefügt werden.
canClaim
F
Wenn „true“ kann die Aufgabe beansprucht werden.
canConsult
F
Wenn „true“, kann die Aufgabe konsultiert werden.
canForward
F
Wenn „true“, kann die Aufgabe weitergeleitet werden.
canShare
F
Wenn „true“, kann die Aufgabe freigegeben werden.

  1. Aufgabenanhang

    Einer Aufgabe können Anhänge hinzugefügt werden.  Der Anhang kann vom Typ „Anhang“ und „Anmerkung“ sein. Im Folgenden sind die Eigenschaften des Anhangsobjekts aufgeführt.

Eigenschaft
Nur Client
Kommentare
creationDate
F
Zeitstempel, wann der Anhang erstellt wurde.
creatorId
F
ID der Person, die den Anhang hinzugefügt hat.
creatorName
F
Name der Person, die den Anhang hinzugefügt hat.
description
F
Beschreibung der Anlage.
fileName
F
Name der Anlage.
id
F
ID der Anlage.
lastModifiedDate
F
Zeitstempel der letzten Anlagenänderung.
noteExtended
F
Wenn „true“, ist die Anmerkung eine erweiterte (lange) Anmerkung.
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 der Anlage in Byte.
taskId
F
ID der Aufgabe, der die Anlage hinzugefügt wird.
Typ
F
Der Typ ist „attachment“ für Dateien und „note“ für Anmerkungen.
formattedCreationDate
T
Enthält das Erstellungsdatum der Anlage, entsprechend den Benutzeroberflächeneinstellungen der Person.
formattedDescription
T
Formatierte Anlagenbeschreibung. Wird verwendet, um Sonderzeichen in der Anlagenbeschreibung in AEM Forms Workspace anzuzeigen.
formattedFileName
T
Formatierter Anlagenname. Wird verwendet, um Sonderzeichen im Anlagennamen in AEM Forms Workspace anzuzeigen. Dies ist nur für Anmerkungen verfügbar.

  1. User

    Im Folgenden sind die Eigenschaften des Benutzerobjekts aufgeführt.

Eigenschaft
Nur Client
Kommentare
address
F
Adresse der Person.
commonName
F
Allgemeiner Name der Person.
description
F
Beschreibung der Person.
directGroupMemberships
F
Liste der Gruppe der Person.
displayName
F
Anzeigename der Person.
email
F
E-Mail-ID der Person.
isOutOfOffice
F
„True“, wenn die Person nicht im Büro ist.
lastName
F
Nachname der Person.
firstName
F
Vorname der Person.
oid
F
ID der Person.
org
F
Name des Unternehmens der Person.
postalAddress
F
Postanschrift der Person.
telephone
F
Kontaktnummer der Person.
telephoneNumber
F
Kontaktnummer der Person.
userid
F
Anmelde-ID der Person.
recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2