DocumentatieAEM 6.5Handboek

JSON-objectbeschrijving in de AEM Forms-werkruimte aem-forms-workspace-json-object-description

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

Gemaakt voor:

  • Beheerder
  • Gebruiker
  • Ontwikkelaar

JSON-objecten die in de AEM Forms-werkruimte worden gebruikt, worden hieronder beschreven.

  1. Categorie

    Categorieën bevinden zich op het tabblad Start van de werkruimte. Deze categorieën worden gebruikt om de startpunten te classificeren.

Eigenschap
Alleen client
Opmerkingen
name
F
Categorienaam
id
F
Categorie-id
description
F
Categoriebeschrijving
parentOid
F
Bevat id van oudercategorie
startPointsList
T
Bevat een lijst met alle startpunten die in een categorie aanwezig zijn
categoryList
T
Bevat lijst van directe kindcategorieën van een categorie
NOTE
Alle beginpunten en Favorieten zijn categorieën die aan clientzijde zijn gedefinieerd. De categorie Favorieten bevat alle startpunten die door de gebruiker als favoriet zijn gemarkeerd. Alle beginpunten-categorieën bevatten alle beginpunten.

  1. Startpoint

    Het beginpunt wordt gebruikt om een proces van de werkruimte te beginnen wanneer aangeroepen.

    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
    Bezit slechts Cliënt Commentaren
    categoryId F Het bevat id van de categorie waartoe het startpunt behoort.
    beschrijving F Het bevat een beschrijving voor een startpunt.
    name F Deze bevat de naam van het startpunt.
    serializedImageTicket F Het bevat een afbeeldingsticket dat overeenkomt met het startpunt. Dit beeldkaartje wordt gebruikt in imageUrl gebied van startpoint, om beeld voor startpunt van de server te krijgen.
    serviceName F Het bevat naam van de dienst voor startpunt.
    startpointId F Het bevat id van startpunt.
    isFavorite T Geeft aan of het startpunt favoriet is of niet. True if startpoint is preferred else false.
    isDefaultImage T Geeft aan of er een afbeelding is opgegeven voor proces of niet. True if there is no image associated with process else false.
    taak T Deze bevat een taak die wordt gemaakt wanneer het startpunt wordt aangeroepen.
    imageUrl T Deze bevat URL van de afbeelding die overeenkomt met het startpunt.

  2. Taak

    Taken worden toegewezen aan gebruikers/groepen en bevatten een gebruikersinterface (een formulier of een hulplijn (afgekeurd)) die kan worden gevuld met gegevens. Wanneer gebruikers een taak krijgen toegewezen, ontvangen zij het formulier of de gids om in te vullen en te verzenden.

Eigenschap
Alleen client
Opmerkingen
classOfTask
F
De klasse van taak is "LC8"wanneer de taak lc8 taak anders "Standaard"is.
completeTime
F
Het bevat de tijdstempel wanneer de taak wordt voltooid.
consultGroupId
F
Het bevat id van een groep waarvoor de taak kan worden geraadpleegd. Het wordt geplaatst tijdens het proces het ontwerpen.
createTime
F
Het bevat de tijdstempel wanneer de taak wordt gecreeerd.
creationId
F
Het bevat identiteitskaart van de gebruiker die de taak creeerde.
currentAssignment
F
Het bevat details over huidige taak.
deadline
F
Het bevat de tijdzegel dat wanneer een taak zijn deadline zal bereiken.
description
F
Het bevat beschrijving van de taak.
displayName
F
Het bevat vertoningsnaam van de taak.
forwardGroupId
F
Het bevat identiteitskaart van een groep waaraan de taak kan worden door:sturen. Het wordt geplaatst tijdens het proces het ontwerpen.
instructies
F
Het bevat instructies voor een taak.
isLocked
F
True if task is locked.
isMustOpenToComplete
F
True if task form must be opened to complete the task.
isOpenFullScreen
F
Indien waar (true), neemt het formulier bij het openen van de taak de eerste keer een volledig scherm in.
isRouteSelectionRequired
F
Indien waar, moet de route worden geselecteerd om de taak te voltooien.
isShowAttachments
F
Bijlagen worden getoond als het waar is.
isStartTask
F
Indien waar, wordt de taak gecreeerd van beginpunt.
isVisible
F
True if task is visible in workspace.
nextReminder
F
Tijdstempel voor de volgende herinnering.
priority
F
Het bevat een prioriteit.
1 = Hoogste prioriteit
2 = Hoge Prioriteit
3 = Normale Prioriteit
4 = Lage Prioriteit
5 = Laagste Prioriteit
processInstanceId
F
Identiteitskaart van de procesinstantie waarvan taak deel uitmaakt.
processInstanceStatus
F
Status van de procesinstantie van de taak.
reminderCount
F
Het bevat telling van herinneringen voor de taak.
routeList
F
Het bevat lijst van routes verbonden aan taak. De gebruiker kan de taak voltooien door om het even welke route van routenelijst te selecteren.
selectedRoute
F
Het bevat naam van de geselecteerde route toen de taak werd voltooid.
serializedImageTicket
F
Het bevat een afbeeldingsticket dat overeenkomt met een taak. Dit afbeeldingskaartje wordt gebruikt in het taakveld imageUrl om een afbeelding voor taak op te halen van de server.
serviceName
F
Het bevat naam van de dienst voor taak.
serviceTitle
F
Het bevat titel van de dienst voor taak.
status
F
1 = Gemaakt (Taak wordt gemaakt vanaf beginpunt.)
2 = Gemaakt en Opgeslagen (Taak wordt gemaakt vanaf het beginpunt en opgeslagen.)
3 = Toegewezen (Taak wordt toegewezen aan de gebruiker nadat het proces is begonnen.)
4 = Toegewezen en Opgeslagen (Taak wordt toegewezen en opgeslagen.)
100 = Voltooid (Taak is voltooid.)
101 = Gedetailleerd (Taak heeft de deadline bereikt.)
102 = beëindigd
stepName
F
Het bevat naam van de taakreeks tijdens proces het ontwerpen.
summaryUrl
F
Het bevat taak summiere url.
taskACL
F
Het is toegangsbeheerlijst voor een taak.
taskId
F
Id van een taak.
updateTime
F
Tijdstempel wanneer taak voor het laatst is bijgewerkt.
formUrl
T
Het bevat url van vorm voor een taak.
taskFormType
T
Het bevat het type taakformulier. Gebruikend dit gebied, wordt de taak teruggegeven op cliënt als pdf voor, swf vorm, etc.
showDirectActions
T
Indien waar, zijn de routeacties zichtbaar in werkruimte.
showACLActions
T
Indien waar, zijn de acties zoals voorwaarts, raadpleeg, aandeel zichtbaar in werkruimte.
supportsOffline
T
Indien waar (true), kan het formulier offline worden genomen. Dit is alleen voor PDF-formulieren.
supportsSave
T
Indien waar (true), kan de gebruiker de taak opslaan.
readerSubmitOptions
T
Dit object bevat opties waarmee u PDF-formulieren via het leesprogramma kunt verzenden als het PDF-formulier geen verzendknop bevat.
isDefaultImage
T
Geeft aan of er een afbeelding is opgegeven voor proces of niet. True if there is no image associated with process else false.
historyTaskList
T
Het bevat een lijst van taken die in geschiedenislusje van taakdetails worden gebruikt.
isOwner
T
Waar als het programma geopende gebruiker eigenaar van taak is.
availableCommands
T
Het bevat alle acties die op taak kunnen worden genomen.
availableCommands.directCommands
T
Het bevat alle routeacties die voor een taak beschikbaar zijn.
availableCommands.taskACLCommands
T
Het bevat bevelen als voorwaarts, deel en raadpleeg als beschikbaar voor een taak.
availableCommands.otherCommands
T
Het bevat bevelen zoals slot, ontgrendelen, verlaten, terugkeer, eis, etc., zoals beschikbaar.
processInstanceInfo
T
Het bevat informatie over de procesinstantie van de taak.
processVariables
T
Het bevat serie van voorwerpen van procesvariabelen als heden.
pendingTasks
T
Het bevat een lijst van hangende taken voor de het procesinstantie van de taak.
userActions
T
Het is een array van objecten. Elk voorwerp bevat details over route en zijn overeenkomstige bevestigingsbericht indien aanwezig.
dataUrl
T
Het is url voor de gegevens van de vorm van een taak.
externalAppConfig
T
Dit is configuratie voor derdetoepassingsvormen.
submit
T
Waar als de taak wordt voorgelegd.
bijlagen
T
Lijst van gehechtheid voor een taak.
toewijzingen
T
Lijst van taken van een taak.

  1. Filter

    Filter is in feite een wachtrij van een gebruiker of groep. Wanneer een taak aan gebruiker/groep wordt toegewezen, wordt de taak toegevoegd in overeenkomstige rij.

Eigenschap
Alleen client
Opmerkingen
isDefault
F
Waar als de rij standaardrij van de het programma geopende gebruiker is, anders vals.
name
F
Naam van de eigenaar van de rij.
qid
F
Id van de wachtrij.
type
F
Het bevat het type van de rij.
0 - Gebruikerswachtrij.
1 Gedeelde wachtrij.
2. Groepswachtrij.
query
T
Dit bevat query die aan een filter is gekoppeld. Deze vraag wordt gebruikt om taken van volledige tasklist te zoeken.
taken
T
Het bevat een lijst van alle taken die tot een filter behoren.

  1. Buiten het bureau

    U kunt uw uit-van-bureauprogramma beheren en de stroom van taken controleren die aan u in uw afwezigheid worden toegewezen.

Bezit
slechts Cliënt
Commentaren
dateRanges
F
Het bevat arrayvoorwerpen van uit-van-bureauprogramma's van een gebruiker. In elk planningsvoorwerp, bevat het begingebied van startDate de begindatum van het programma en einddatum het gebied bevat de einddatum van het programma. Als endDate in programma ongeldig is, impliceert het dat de gebruiker niet de einddatum van uit-van-bureauprogramma heeft gepland.
isNoPrimaryDesignate
F
Waar als er geen primaire aanwijzen in als de gebruiker buiten-van-bureau is.
isOutOfOffice
F
True if user is out-of-office.
outOfOfficeDesignate
F
Het bevat details van gebruiker die als primaire aanwijzen door gebruiker wordt toegewezen.
processSpecificDesignates
F
Het bevat serie van voorwerpen voor proces-specifieke uit-van-bureau aangewezen. In elk proces-specifiek wijs voorwerp toe, bevat processName de naam van het proces, isNotDesignated is waar als geen gebruiker voor het overeenkomstige proces wordt toegewezen, en userDesignated is ongeldig als geen gebruiker anders details van de gebruiker toegewezen voor het overeenkomstige proces.
processen
T
Het bevat een lijst van alle processen die aan de gebruiker beschikbaar zijn.
initialOutOfOfficeSettings
T
Het bevat aanvankelijke out-of-office montages van gebruiker die aanvankelijk worden gehaald.
outOfOfficeSettings
T
Het bevat gewijzigde uit-van-bureaumontages.
userSearchHistory
T
Het bevat een lijst van gebruikers die door een het programma geopende gebruiker tot datum worden gezocht.

  1. Procesinstantie

    Een procesinstantie wordt gecreeerd wanneer een proces via werkruimte of werkbank wordt aangehaald.

Eigenschap
Alleen client
Opmerkingen
description
F
Beschrijving van procesinstantie
initiator
F
Naam van initiatiefnemer van een procesinstantie.
initiatorId
F
Id van initiator van procesinstantie.
processCompleteTime
F
Tijdstempel wanneer het proces is voltooid.
processInstanceId
F
Id van procesinstantie.
processInstanceStatus
F
0 = geïnitieerd
1 = Lopend
2 = Volledig
3 = Voltooiend
4 = Beëindigd
5 = Beëindigd
6 = Opgeschort
7 = Opgeschort
8 = Onophoudelijk
processName
F
Naam van het proces.
processStartTime
F
Tijdstempel wanneer het proces is gestart.
processVariables
F
Array van objecten met procesvariabelen. Elk voorwerp van de procesvariabele bevat naam die naam van procesvariabele is, waarde die waarde van procesvariabele is en type dat type van procesvariabele is.
tasklist
T
Taken die door deze procesinstantie worden geproduceerd.
  1. Procesnaam
Eigenschap
Alleen client
Opmerkingen
processMajorVersion
F
Belangrijke versie van een proces.
processMinorVersion
F
Kleine versie van een proces.
processName
F
Naam van het proces.
processTitle
F
Titel van het proces.
processInstanceList
T
Lijst van procesinstanties voor dit proces.

  1. Taaktoewijzingsobject

    Taaktoewijzingsobject bevat informatie over de taaktoewijzing. Hieronder vindt u de eigenschappen van de taaktoewijzing.

Eigenschap
Alleen client
Opmerkingen
assignCreateTime
F
Tijdstempel wanneer deze toewijzing van een taak wordt gemaakt.
assignType
F
0 = Eerste Taak
1 = Voorwaarts (De Taak is door:sturen aan huidige eigenaar van taak.)
2 = Geretourneerd (Taak is teruggekeerd aan huidige eigenaar van taak door vorige eigenaar van taak.)
3 = Gevraagd (Taak is gevorderd door huidige eigenaar van taak.)
4 = Escalatie (Taak is toegewezen aan huidige eigenaar van taak na escalatie.)
5 = Toegewezen beheerder (Taak is toegewezen door beheerder aan huidige eigenaar van taak.)
6 = Consulted (Taak is geraadpleegd aan huidige eigenaar van taak.)
assignUpdateTime
F
Tijdstempel wanneer deze toewijzing van een taak wordt bijgewerkt.
queueId
F
Identiteitskaart van Rij van huidige eigenaar van taak.
queueOwner
F
Naam van huidige eigenaar van taak.
queueOwnerId
F
Identiteitskaart van huidige eigenaar van taak.

  1. ACL-object taak

    Het ACL van de taak voorwerp bevat informatie over toestemmingen zoals voorwaarts, aandeel, raadpleeg, etc., van een taak. Na zijn de eigenschappen van ACL van taak.

Eigenschap
Alleen client
Opmerkingen
canAddAttachments
F
Indien waar, kunnen de gehechtheid aan taak worden toegevoegd.
canAddNotes
F
Indien waar (true), kunnen notities aan de taak worden toegevoegd.
canClaim
F
Indien waar (true), kan de taak worden geclaimd.
canConsult
F
Indien waar (true), kan de taak worden geraadpleegd.
canForward
F
Indien waar, kan de taak door:sturen.
canShare
F
Indien waar (true), kan de taak worden gedeeld.

  1. Taakbijlage

    U kunt bijlagen toevoegen aan een taak. Bijlage kan van het type bijlage en nota zijn. Hieronder vindt u de eigenschappen van het bijlageobject.

Eigenschap
Alleen client
Opmerkingen
creationDate
F
Tijdstempel bij maken van bijlage.
creatorId
F
Identiteitskaart van gebruiker die de gehechtheid toevoegde.
creatorName
F
Naam van de gebruiker die de gehechtheid toevoegde.
description
F
Beschrijving van de bijlage.
fileName
F
Naam van gehechtheid.
id
F
Id van bijlage.
lastModifiedDate
F
Tijdstempel bij laatste wijziging van bijlage.
noteExtended
F
Indien waar, is de nota een uitgebreide (lange) nota.
machtigingen
F
Machtigingen die aan een bijlage zijn gekoppeld. allowRead het gebied is voor gelezen toestemming, allowWrite is voor schrijftoestemming, allowDelete is voor schrappingstoestemming.
size
F
Grootte van de bijlage in bytes.
taskId
F
Identiteitskaart van taak waaraan gehechtheid wordt toegevoegd.
type
F
Het type is gehechtheid voor dossiers en het Type is nota voor nota's.
formattedCreationDate
T
Het bevat de aanmaakdatum van de gehechtheid volgens de montages UI van de gebruiker.
formattedDescription
T
Beschrijving van opgemaakte bijlage. Wordt gebruikt om speciale tekens weer te geven die aanwezig zijn in de bijlagebeschrijving in de AEM Forms-werkruimte.
formattedFileName
T
Opgemaakte bijlagenaam. Wordt gebruikt om speciale tekens weer te geven die zich in de naam van de bijlage in de AEM Forms-werkruimte bevinden. Dit is slechts voor nota's.

  1. Gebruiker

    Hieronder vindt u de eigenschappen van het gebruikersobject.

Eigenschap
Alleen client
Opmerkingen
address
F
Adres van de gebruiker.
commonName
F
Algemene naam van de gebruiker.
description
F
Beschrijving van de gebruiker.
directGroupMembership
F
Lijst van gebruikersgroep.
displayName
F
De naam van de vertoning van de gebruiker.
email
F
E-mailadres van de gebruiker.
isOutOfOffice
F
True if user is out-of-office.
lastName
F
Achternaam van de gebruiker.
firstName
F
Voornaam van de gebruiker.
oid
F
Identiteitskaart van de gebruiker.
org
F
Naam van organisatie van de gebruiker.
postalAddress
F
Postadres van de gebruiker.
Telefoon
F
Het aantal van het contact van de gebruiker.
phoneNumber
F
Het aantal van het contact van de gebruiker.
userid
F
Login identiteitskaart van de gebruiker.
recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2