DocumentazioneAEM 6.5Guida utente

Descrizione oggetto JSON dell’area di lavoro di AEM Forms aem-forms-workspace-json-object-description

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

Creato per:

  • Amministratore
  • Utente
  • Sviluppatore

Di seguito sono descritti gli oggetti JSON utilizzati nell’area di lavoro di AEM Forms.

  1. Categoria

    Le categorie sono presenti nella scheda del processo iniziale dell'area di lavoro. Queste categorie vengono utilizzate per classificare i punti d'inizio.

Proprietà
Solo client
Commenti
nome
V
Nome categoria
id
V
ID categoria
descrizione
V
Descrizione categoria
parentOid
V
Contiene un ID della categoria padre
startPointsList
M
Contiene un elenco di tutti i punti d'inizio presenti in una categoria
categoryList
M
Contiene l'elenco delle categorie figlio dirette di una categoria
NOTE
Tutti i punti iniziali e i Preferiti sono categorie definite sul lato client. La categoria Preferiti contiene tutti i punti d'inizio contrassegnati dall'utente come preferiti. La categoria Tutti i punti iniziali contiene tutti i punti iniziali.

  1. Punto d'inizio

    Il punto iniziale viene utilizzato per avviare un processo dall'area di lavoro quando viene richiamato.

    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
    Proprietà Solo client Commenti
    categoryId V Contiene l’ID della categoria a cui appartiene il punto d’inizio.
    descrizione V Contiene la descrizione di un punto d'inizio.
    nome V Contiene il nome del punto d'inizio.
    serializedImageTicket V Contiene un ticket immagine corrispondente al punto iniziale. Questo ticket di immagine viene utilizzato nel campo imageUrl del punto d’inizio per ottenere l’immagine del punto d’inizio dal server.
    serviceName V Contiene il nome del servizio per il punto d'inizio.
    startpointId V Contiene l’ID del punto d’inizio.
    isFavorite M Indica se il punto d'inizio è preferito o meno. True se il punto d'inizio è il preferito, altrimenti false.
    isDefaultImage M Indica se esiste un'immagine specificata per il processo. True se non è presente alcuna immagine associata al processo else false.
    attività M Contiene l'attività creata quando viene richiamato il punto d'inizio.
    imageUrl M Contiene l’URL dell’immagine corrispondente al punto d’inizio.

  2. Attività

    Le attività vengono assegnate a utenti/gruppi e includono un’interfaccia utente, un modulo o una Guida TV (obsoleta) che può essere compilata con i dati. Quando agli utenti viene assegnata un’attività, viene fornito loro il modulo o la Guida per completare e inviare.

Proprietà
Solo client
Commenti
classOfTask
V
La classe dell'attività è 'LC8' quando l'attività è lc8, altrimenti 'Standard'.
completeTime
V
Contiene il timestamp del completamento dell'attività.
consultGroupId
V
Contiene l’ID di un gruppo a cui è possibile consultare l’attività. Viene impostato durante la progettazione del processo.
createTime
V
Contiene la marca temporale al momento della creazione dell'attività.
createId
V
Contiene l'ID dell'utente che ha creato l'attività.
currentAssignment
V
Contiene dettagli sull'assegnazione corrente dell'attività.
scadenza
V
Contiene la marca temporale che indica quando un'attività raggiungerà la scadenza.
descrizione
V
Contiene la descrizione dell'attività.
displayName
V
Contiene il nome visualizzato dell'attività.
forwardGroupId
V
Contiene l’ID di un gruppo a cui è possibile inoltrare l’attività. Viene impostato durante la progettazione del processo.
istruzioni
V
Contiene istruzioni per un'attività.
isLocked
V
True se l'attività è bloccata.
isMustOpenToComplete
V
True se è necessario aprire il modulo attività per completare l'attività.
isOpenFullScreen
V
Se è true, all'apertura dell'attività la schermata completa del modulo viene visualizzata per la prima volta.
isRouteSelectionRequired
V
Se è true, la route deve essere selezionata per completare l'attività.
isShowAttachments
V
Gli allegati vengono visualizzati se è vero.
isStartTask
V
Se true, l'attività viene creata dal punto iniziale.
isVisible
V
True se l'attività è visibile nell'area di lavoro.
nextReminder
V
Timestamp del prossimo promemoria.
priorità
V
Contiene la priorità dell'attività.
1 = Priorità più alta
2 = Priorità alta
3 = Priorità normale
4 = Priorità bassa
5 = Priorità più bassa
processInstanceId
V
ID dell'istanza del processo di cui fa parte l'attività.
processInstanceStatus
V
Stato dell'istanza di processo dell'attività.
reminderCount
V
Contiene il numero di promemoria per l'attività.
routeList
V
Contiene un elenco di route associate all'attività. L'utente può completare l'attività selezionando una delle route dall'elenco route.
selectedRoute
V
Contiene il nome della route selezionata al completamento dell'attività.
serializedImageTicket
V
Contiene il ticket immagine corrispondente all’attività. Questo ticket immagine viene utilizzato nel campo imageUrl dell'attività per ottenere l'immagine per l'attività dal server.
serviceName
V
Contiene il nome del servizio per l'attività.
serviceTitle
V
Contiene il titolo del servizio per l'attività.
stato
V
1 = Creato (l'attività viene creata dal punto iniziale).
2 = Creato e salvato (l'attività viene creata dal punto iniziale e salvata).
3 = Assegnato (l'attività viene assegnata all'utente dopo l'avvio del processo).
4 = Assegnato e salvato (l'attività viene assegnata e salvata)
100 = Completata (attività completata).
101 = Scaduto (l'attività ha raggiunto la scadenza).
102 = Terminato
stepName
V
Contiene il nome dell'attività impostata durante la progettazione del processo.
summaryUrl
V
Contiene l'URL di riepilogo attività.
taskACL
V
È un elenco di controllo di accesso per un'attività.
taskId
V
ID di un'attività.
updateTime
V
Timestamp dell'ultimo aggiornamento dell'attività.
formUrl
M
Contiene l'URL del modulo per un'attività.
taskFormType
M
Contiene il tipo di modulo attività. Utilizzando questo campo, l'attività viene rappresentata sul client come PDF per, modulo SWF e così via.
showDirectActions
M
Se true, le azioni di instradamento sono visibili nell'area di lavoro.
showACLActions
M
Se true, azioni quali inoltra, consulta e condividi sono visibili nell'area di lavoro.
supportedOffline
M
Se è true, il modulo può essere portato offline. Solo per moduli PDF.
supportedSave
M
Se true, l'utente può salvare l'attività.
readerSubmitOptions
M
Questo oggetto contiene opzioni utilizzate per inviare moduli PDF tramite lettore nel caso in cui il modulo PDF non contenga alcun pulsante di invio.
isDefaultImage
M
Indica se esiste un'immagine specificata per il processo. True se non è presente alcuna immagine associata al processo else false.
historyTaskList
M
Contiene un elenco di attività utilizzate nella scheda della cronologia dei dettagli dell'attività.
isOwner
M
True se l'utente connesso è il proprietario dell'attività.
availableCommands
M
Contiene tutte le azioni che possono essere eseguite sull'attività.
availableCommands.directCommands
M
Contiene tutte le azioni di route disponibili per un'attività.
availableCommands.taskACLCommands
M
Contiene comandi come inoltra, condividi e consulta se disponibili per un'attività.
availableCommands.otherCommands
M
Contiene comandi come lock, unlock, abandon, return, claim e così via, se disponibili.
processInstanceInfo
M
Contiene informazioni sull'istanza del processo dell'attività.
processVariables
T
Contiene la matrice di oggetti delle variabili di processo, se presenti.
pendingTasks
M
Contiene l'elenco delle attività in sospeso per l'istanza di processo dell'attività.
userActions
M
È un array di oggetti. Ogni oggetto contiene dettagli sulla route e il messaggio di conferma corrispondente, se presente.
dataUrl
M
URL per i dati del modulo di un'attività.
externalAppConfig
M
Questa è la configurazione per i moduli applicativi di terze parti.
inviato
M
True se l'attività viene inviata.
allegati
M
Elenco degli allegati per un'attività.
assegnazioni
M
Elenco delle assegnazioni di un'attività.

  1. Filtro

    Il filtro è fondamentalmente una coda di utenti o gruppi. Quando un’attività viene assegnata a un utente/gruppo, viene aggiunta nella coda corrispondente.

Proprietà
Solo client
Commenti
isDefault
V
True se la coda è la coda predefinita dell'utente connesso, altrimenti false.
nome
V
Nome del proprietario della coda.
qid
V
ID della coda.
tipo
V
Contiene il tipo di coda.
0 - Coda utenti.
1 Coda condivisa.
2. Coda gruppo.
query
M
Contiene una query associata a un filtro. Questa query viene utilizzata per cercare le attività dall'elenco attività completo.
attività
M
Contiene l'elenco di tutte le attività che appartengono a un filtro.

  1. Fuori sede

    È possibile gestire la pianificazione fuori sede e controllare il flusso di attività assegnate all'utente in assenza dell'utente.

Proprietà
Solo client
Commenti
dateRanges
V
Contiene oggetti array di pianificazioni fuori sede di un utente. In ogni oggetto di pianificazione, il campo startDate contiene la data di inizio della pianificazione e il campo endDate contiene la data di fine della pianificazione. Se endDate è null nella pianificazione, significa che l'utente non ha pianificato la data di fine della pianificazione fuori sede.
isNoPrimaryDesignate
V
True se non è presente alcun designato primario nel caso in cui l'utente sia fuori sede.
isOutOfOffice
V
True se l'utente è fuori sede.
outOfOfficeDesignate
V
Contiene i dettagli dell'utente assegnato come primario designato dall'utente.
processSpecificDesignates
V
Contiene un array di oggetti per designare fuori sede specifico per il processo. In ogni oggetto designato specifico del processo, processName contiene il nome del processo, isNotDesignated è true se nessun utente è assegnato per il processo corrispondente e userDesignated è null se nessun altro utente ha assegnato i dettagli dell'utente assegnato per il processo corrispondente.
processi
M
Contiene un elenco di tutti i processi disponibili per l'utente.
initialOutOfOfficeSettings
M
Contiene le impostazioni fuori sede iniziali dell'utente recuperate inizialmente.
outOfOfficeSettings
M
Contiene le impostazioni fuori sede modificate.
userSearchHistory
M
Contiene un elenco di utenti in cui un utente connesso esegue la ricerca fino alla data corrente.

  1. Istanza processo

    Quando un processo viene richiamato tramite l'area di lavoro o il workbench, viene creata un'istanza di processo.

Proprietà
Solo client
Commenti
descrizione
V
Descrizione dell'istanza del processo
iniziatore
V
Nome dell'iniziatore di un'istanza del processo.
initiatorId
V
ID dell'iniziatore dell'istanza del processo.
processCompleteTime
V
Timestamp al completamento del processo.
processInstanceId
V
ID dell'istanza del processo.
processInstanceStatus
V
0 = Avviato
1 = In Esecuzione
2 = Completato
3 = Completato
4 = Terminato
5 = Terminato
6 = Sospeso
7 = In Sospensione
8 = In Sospensione
processName
V
Nome del processo.
processStartTime
V
Timestamp all'avvio del processo.
processVariables
V
Array di oggetti delle variabili di processo. Ogni oggetto variabile di processo contiene il nome, che è il nome della variabile di processo, il valore, che è il valore della variabile di processo e il tipo, che è il tipo della variabile di processo.
elenco attività
M
Attività generate da questa istanza del processo.
  1. Nome processo
Proprietà
Solo client
Commenti
processMajorVersion
V
Versione principale di un processo.
processMinorVersion
V
Versione secondaria di un processo.
processName
V
Nome del processo.
processTitle
V
Titolo del processo.
processInstanceList
M
Elenco delle istanze di processo per questo processo.

  1. Oggetto assegnazione attività

    L'oggetto assegnazione attività contiene informazioni sull'assegnazione dell'attività. Di seguito sono riportate le proprietà dell'assegnazione dell'attività.

Proprietà
Solo client
Commenti
assignmentCreateTime
V
Timestamp della creazione di questa assegnazione di un'attività.
assignmentType
V
0 = Assegnazione iniziale
1 = Inoltra (l'attività è stata inoltrata al proprietario corrente dell'attività).
2 = Restituita (l'attività è stata restituita al proprietario corrente dell'attività dal proprietario precedente).
3 = Richiesto (l'attività è stata richiesta dal proprietario corrente dell'attività).
4 = riassegnazione (l'attività è stata assegnata al proprietario corrente dell'attività dopo l'escalation)
5 = Amministratore assegnato (l'attività è stata assegnata dall'amministratore al proprietario corrente dell'attività).
6 = Consultato ( L'attività è stata consultata dall'attuale proprietario)
assignmentUpdateTime
V
Timestamp dell'aggiornamento dell'assegnazione di un'attività.
queueId
V
ID coda del proprietario corrente dell'attività.
queueOwner
V
Nome del proprietario corrente dell'attività.
queueOwnerId
V
ID del proprietario corrente dell'attività.

  1. Oggetto ACL attività

    L'oggetto ACL dell'attività contiene informazioni su autorizzazioni quali inoltro, condivisione, consultazione e così via di un'attività. Di seguito sono riportate le proprietà dell'ACL dell'attività.

Proprietà
Solo client
Commenti
canAddAttachments
V
Se è true, è possibile aggiungere allegati all'attività.
canAddNotes
V
Se è true, è possibile aggiungere note all'attività.
canClaim
V
Se true, l'attività può essere reclamata.
canConsult
V
Se true, è possibile consultare l'attività.
canForward
V
Se true, l'attività può essere inoltrata.
canShare
V
Se true, l'attività può essere condivisa.

  1. Allegato attività

    È possibile aggiungere allegati a un'attività. L'allegato può essere di tipo allegato e nota. Di seguito sono riportate le proprietà dell'oggetto allegato.

Proprietà
Solo client
Commenti
creationDate
V
Timestamp al momento della creazione dell'allegato.
creatorId
V
ID dell'utente che ha aggiunto l'allegato.
creatorName
V
Nome dell'utente che ha aggiunto l'allegato.
descrizione
V
Descrizione dell'allegato.
nomeFile
V
Nome dell'allegato.
id
V
ID dell'allegato.
lastModifiedDate
V
Timestamp dell'ultima modifica dell'allegato.
noteExtended
V
Se true, la nota è una nota estesa (lunga).
autorizzazioni
V
Autorizzazioni associate a un allegato. Il campo allowRead è per l'autorizzazione di lettura, allowWrite è per l'autorizzazione di scrittura, allowDelete è per l'autorizzazione di eliminazione.
dimensione
V
Dimensione dell'allegato in byte.
taskId
V
ID dell'attività a cui viene aggiunto l'allegato.
tipo
V
Il tipo è allegato per i file e il tipo è nota per le note.
formattedCreationDate
M
Contiene la data di creazione dell'allegato in base alle impostazioni dell'interfaccia utente dell'utente.
formattedDescription
M
Descrizione dell'allegato formattato. Utilizzato per visualizzare caratteri speciali presenti nella descrizione dell'allegato nell'area di lavoro AEM Forms.
formattedFileName
M
Nome allegato formattato. Utilizzato per visualizzare i caratteri speciali presenti nel nome dell’allegato nell’area di lavoro di AEM Forms. Solo per le note.

  1. User

    Di seguito sono riportate le proprietà dell'oggetto utente.

Proprietà
Solo client
Commenti
indirizzo
V
Indirizzo dell'utente.
commonName
V
Nome comune dell'utente.
descrizione
V
Descrizione dell'utente.
directGroupMemberships
V
Elenco del gruppo di utenti.
displayName
V
Nome visualizzato dell'utente.
e-mail
V
ID e-mail dell'utente.
isOutOfOffice
V
True se l'utente è fuori sede.
lastName
V
Cognome dell'utente.
firstName
V
Nome dell'utente.
oid
V
ID dell'utente.
org
V
Nome dell'organizzazione dell'utente.
postalAddress
V
Indirizzo postale dell'utente.
telefono
V
Numero di contatto dell'utente.
phoneNumber
V
Numero di contatto dell'utente.
id utente
V
ID di accesso dell'utente.
recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2