DocumentaciónAEM 6.4Guía de Forms

Descripción de los objetos JSON de AEM Forms Workspace aem-forms-workspace-json-object-description

Last update: Fri May 05 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

Creado para:

  • User
CAUTION
AEM 6.4 ha llegado al final de la compatibilidad ampliada y esta documentación ya no se actualiza. Para obtener más información, consulte nuestra períodos de asistencia técnica. Buscar las versiones compatibles here.

A continuación, se describen los objetos JSON utilizados en AEM Forms Workspace.

  1. Categoría

    Las categorías se encuentran en la pestaña Iniciar proceso del espacio de trabajo. Estas categorías se utilizan para clasificar los puntos de inicio.

Propiedad
Solo cliente
Comentarios
name
F
Nombre de categoría
id
F
ID de categoría
Descripción
F
Descripción de la categoría
parentOid
F
Contiene el OID de la categoría principal.
startPointsList
T
Contiene una lista de todos los puntos de inicio presentes en una categoría.
categoryList
T
Contiene la lista de categorías secundarias directas de una categoría.
NOTE
Todos los puntos de inicio y Favoritos son categorías que se definen en el lado del cliente. La categoría Favorito contiene todos los puntos de inicio que el usuario ha marcado como favoritos. La categoría Todos los puntos de inicio contiene todos los puntos de inicio.

  1. Punto de inicio

    Un punto de inicio se utiliza para iniciar un proceso desde el espacio de trabajo cuando se invoca.

    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
    Propiedad Solo cliente Comentarios
    categoryId F Contiene el ID de la categoría a la que pertenece el punto de inicio.
    description F Contiene la descripción de un punto de inicio.
    name F Contiene el nombre del punto de inicio.
    serializedImageTicket F Contiene un ticket de imagen correspondiente al punto de inicio. Este ticket de imagen se utiliza en el campo imageUrl del punto de inicio para obtener la imagen del punto de inicio desde el servidor.
    serviceName F Contiene el nombre del servicio del punto de inicio.
    startpointId F Contiene el ID del punto de inicio.
    isFavorite T Indica si el punto de inicio ha sido agregado a Favoritos o no. El valor es True si el punto de inicio ha sido agregado a Favoritos; en caso contrario, es False.
    isDefaultImage T Indica si hay una imagen especificada para el proceso o no. El valor es True si no hay ninguna imagen asociada con el proceso; en caso contrario, es False.
    task T Contiene la tarea creada cuando se invoca el punto de inicio.
    imageUrl T Contiene la URL de la imagen correspondiente al punto de inicio.

  2. Tarea

    Las tareas se asignan a usuarios o grupos e incluyen una interfaz de usuario (un formulario o una guía [obsoleta]) que se puede cumplimentar con datos. Cuando a los usuarios se les asigna una tarea, se les proporciona el formulario o la guía para que los cumplimenten y los envíen.

Propiedad
Solo cliente
Comentarios
classOfTask
F
La clase de tarea es "LC8" cuando la tarea es "lc8 task"; en caso contrario, es "Standard".
completeTime
F
Contiene la marca de tiempo del momento en el que se completa la tarea.
consultGroupId
F
Contiene el ID del grupo al que se puede consultar la tarea. Se configura durante el diseño del proceso.
createTime
F
Contiene la marca de tiempo del momento en el que se crea la tarea.
creationId
F
Contiene el ID del usuario que creó la tarea.
currentAssignment
F
Contiene detalles sobre la asignación actual de tareas.
deadline
F
Contiene la marca de tiempo del momento en el que una tarea alcanzará su fecha límite.
description
F
Contiene la descripción de la tarea.
displayName
F
Contiene el nombre para mostrar de la tarea.
forwardGroupId
F
Contiene el ID del grupo al que se puede reenviar la tarea. Se configura durante el diseño del proceso.
instructions
F
Contiene las instrucciones de una tarea.
isLocked
F
El valor es True si la tarea está bloqueada.
isMustOpenToComplete
F
El valor es True si se debe abrir el formulario de la tarea para completar la tarea.
isOpenFullScreen
F
Si el valor es True, al abrir la tarea, el formulario se muestra en pantalla completa la primera vez.
isRouteSelectionRequired
F
Si el valor es True, se debe seleccionar una ruta para completar la tarea.
isShowAttachments
F
Los archivos adjuntos se muestran si el valor es True.
isStartTask
F
Si el valor es True, la tarea se crea desde el punto de inicio.
isVisible
F
El valor es True si la tarea es visible en Workspace.
nextReminder
F
La marca de tiempo del siguiente recordatorio.
priority
F
Contiene la prioridad de la tarea.
1 = Prioridad más alta
2 = Prioridad alta
3 = Prioridad Normal
4 = Prioridad baja
5 = Prioridad más baja
processInstanceId
F
El ID de la instancia de proceso de la que forma parte la tarea.
processInstanceStatus
F
El estado de la instancia de proceso de la tarea.
reminderCount
F
Contiene un recuento de los recordatorios de la tarea.
routeList
F
Contiene la lista de rutas asociadas con la tarea. El usuario puede completar la tarea seleccionando cualquiera de las rutas de la lista de rutas.
selectedRoute
F
Contiene el nombre de la ruta seleccionada cuando se completó la tarea.
serializedImageTicket
F
Contiene el ticket de imagen correspondiente a la tarea. Este ticket de imagen se utiliza en el campo de tarea imageUrl para obtener la imagen de la tarea del servidor.
serviceName
F
Contiene el nombre del servicio de la tarea.
serviceTitle
F
Contiene el título del servicio de la tarea.
status
F
1 = Creada (la tarea se ha creado desde el punto de inicio).
2 = Creada y guardada (la tarea se ha creado desde el punto de inicio y se ha guardado).
3 = Asignada (la tarea se ha asignado al usuario una vez iniciado el proceso).
4 = Asignada y guardada (la tarea se ha asignado y guardado).
100 = Completada (la tarea se ha completado).
101 = Con fecha límite (la tarea ha alcanzado la fecha límite).
102 = Terminada
stepName
F
Contiene el nombre del conjunto de tareas durante el diseño del proceso.
summaryUrl
F
Contiene la URL de resumen de la tarea.
taskACL
F
Es la lista de control de acceso de una tarea.
taskId
F
El ID de una tarea.
updateTime
F
La marca de tiempo del momento en el que se actualizó la tarea por última vez.
formUrl
T
Contiene la URL del formulario de una tarea.
taskFormType
T
Contiene el tipo de formulario de la tarea. Con este campo, la tarea se procesa en el cliente como un formulario pdf, swf, etc.
showDirectActions
T
Si el valor es True, las acciones de ruta son visibles en Workspace.
showACLActions
T
Si el valor es True, las acciones como Reenviar, Consultar y Compartir son visibles en Workspace.
supportsOffline
T
Si el valor es True, el formulario se puede cumplimentar sin conexión. Disponible únicamente para formularios pdf.
supportsSave
T
Si el valor es True, el usuario puede guardar la tarea.
readerSubmitOptions
T
Este objeto contiene opciones que se utilizan para enviar formularios pdf a través de Reader cuando el formulario no contiene un botón de envío.
isDefaultImage
T
Indica si hay una imagen especificada para el proceso o no. El valor es True si no hay ninguna imagen asociada con el proceso; en caso contrario, es False.
historyTaskList
T
Contiene la lista de tareas que se utilizan en la pestaña del historial de detalles de las tareas.
isOwner
T
El valor es True si el usuario que ha iniciado sesión es el propietario de la tarea.
availableCommands
T
Contiene todas las acciones que se pueden realizar en una tarea.
availableCommands.directCommands
T
Contiene todas las acciones de ruta disponibles para una tarea.
availableCommands.taskACLCommands
T
Contiene comandos como Reenviar, Compartir y Consultar si están disponibles para una tarea.
availableCommands.otherCommands
T
Contiene comandos como Bloquear, Desbloquear, Abandonar, Devolver, Reclamar, etc., según estén disponibles.
processInstanceInfo
T
Contiene información sobre la instancia de proceso de la tarea.
processVariables
T
Contiene una matriz de objetos de variables de proceso, si los hay.
pendingTasks
T
Contiene la lista de tareas pendientes de la instancia de proceso de la tarea.
userActions
T
Es una matriz de objetos. Cada objeto contiene detalles sobre la ruta y el mensaje de confirmación correspondiente, si lo hay.
dataUrl
T
Es la URL de los datos del formulario de una tarea.
externalAppConfig
T
Se trata de la configuración de los formularios de aplicaciones de terceros.
submitted
T
El valor es True si se envía la tarea.
attachments
T
La lista de archivos adjuntos de una tarea.
assignments
T
La lista de asignaciones de una tarea.

  1. Filter

    Filter es básicamente la cola de un usuario o grupo. Cuando se asigna una tarea al usuario o grupo, esta se agrega a la cola correspondiente.

Propiedad
Solo cliente
Comentarios
isDefault
F
El valor es True si la cola es la cola predeterminada del usuario que ha iniciado sesión; en caso contrario, es False.
name
F
El nombre del propietario de la cola.
qid
F
El ID de la cola.
type
F
Contiene el tipo de la cola.
0 - Cola de usuario
1. Cola compartida
2. Cola de grupo
query
T
Contiene una consulta asociada a un filtro. Esta consulta se utiliza para buscar tareas de la lista de tareas completa.
tasks
T
Contiene una lista de todas las tareas que pertenecen a un filtro.

  1. Fuera de la oficina

    Puede administrar la programación de Fuera de la oficina y controlar el flujo de tareas que le han sido asignadas en su ausencia.

Propiedad
Solo cliente
Comentarios
dateRanges
F
Contiene los objetos de matriz de programación de Fuera de la oficina de un usuario. En cada objeto de programación, el campo startDate contiene la fecha de inicio de la programación y el campo endDate contiene la fecha de finalización. Si endDate es nulo en la programación, significa que el usuario no ha programado la fecha de finalización de la programación de Fuera de la oficina.
isNoPrimaryDesignate
F
El valor es True si no hay ningún designado principal en el caso de que el usuario esté fuera de la oficina.
isOutOfOffice
F
El valor es True si el usuario está fuera de la oficina.
outOfOfficeDesignate
F
Contiene detalles del usuario que el usuario asigna como designado principal.
processSpecificDesignates
F
Contiene una matriz de objetos para las designaciones Fuera de la oficina específicas del proceso. En cada objeto designado específico del proceso, processName contiene el nombre del proceso, isNotDesignated es True si no se asigna ningún usuario al proceso correspondiente y userDesignated es Null si no se asigna ningún otro detalle al usuario asignado al proceso correspondiente.
processes
T
Contiene una lista de todos los procesos disponibles para el usuario.
initialOutOfOfficeSettings
T
Contiene la configuración inicial de Fuera de la oficina del usuario que se recuperó inicialmente.
outOfOfficeSettings
T
Contiene configuraciones de Fuera de la oficina modificadas.
userSearchHistory
T
Contiene la lista de usuarios que han buscado los usuarios que han iniciado sesión hasta la fecha.

  1. Instancia de proceso

    Se crea una instancia de proceso cuando se invoca un proceso mediante Workspace o Workbench.

Propiedad
Solo cliente
Comentarios
description
F
La descripción de la instancia de proceso
initiator
F
El nombre del iniciador de la instancia de proceso
initiatorId
F
El ID del iniciador de la instancia de proceso
processCompleteTime
F
La marca de tiempo del momento en el que se completó el proceso
processInstanceId
F
El ID de la instancia de proceso
processInstanceStatus
F
0 = Iniciado
1 = En ejecución
2 = Completo
3 = Finalizado
4 = Terminado
5 = Finalización
6 = Suspendido
7 = Suspender
8 = Sin suspensión
processName
F
El nombre del proceso.
processStartTime
F
La marca de tiempo del momento en el que se inició el proceso
processVariables
F
La matriz de objetos de variables de proceso. Cada objeto de variable de proceso contiene un nombre, que es el nombre de la variable de proceso; un valor, que es el valor de la variable de proceso, y un tipo, que es el tipo de variable de proceso.
tasklist
T
Las tareas generadas por esta instancia de proceso
  1. Nombre del proceso
Propiedad
Solo cliente
Comentarios
processMajorVersion
F
La versión principal de un proceso
processMinorVersion
F
La versión menor de un proceso
processName
F
El nombre del proceso.
processTitle
F
El título del proceso
processInstanceList
T
La lista de instancias de proceso de este proceso

  1. Objeto Task Assignment

    El objeto Task Assignment contiene información sobre la asignación de la tarea. A continuación, se muestran las propiedades de la asignación de la tarea.

Propiedad
Solo cliente
Comentarios
assignmentCreateTime
F
La marca de tiempo del momento en el que se crea la asignación de una tarea
assignmentType
F
0 = Asignación inicial
1 = Reenviada (la tarea se ha reenviado al propietario actual de la tarea)
2 = Devuelta (el propietario anterior de la tarea ha devuelto la tarea a su propietario actual)
3 = Reclamada (la tarea ha sido reclamada por el propietario actual de la tarea)
4 = Escalación (la tarea se ha asignado al propietario actual de la tarea después de la escalación)
5 = Administrador asignado (el administrador ha asignado la tarea a su propietario actual)
6 = Consultada (Se ha consultado la tarea a su propietario actual)
assignmentUpdateTime
F
La marca de tiempo del momento en el que se actualiza la asignación de una tarea
queueId
F
El ID de cola del propietario actual de la tarea
queueOwner
F
El nombre del propietario actual de la tarea
queueOwnerId
F
El ID del propietario actual de la tarea

  1. Objeto Task ACL

    El objeto Task ACL contiene información sobre los permisos de una tarea, como Reenviar, Compartir, Consultar, etc. A continuación se muestran las propiedades del ACL de la tarea.

Propiedad
Solo cliente
Comentarios
canAddAttachments
F
Si el valor es True, es posible agregar archivos adjuntos a la tarea.
canAddNotes
F
Si el valor es True, es posible agregar notas a la tarea.
canClaim
F
Si el valor es True, es posible reclamar la tarea.
canConsult
F
Si el valor es True, es posible consultar la tarea.
canForward
F
Si el valor es True, es posible reenviar la tarea.
canShare
F
Si el valor es True, es posible compartir la tarea.

  1. Archivo adjunto de tarea

    Es posible agregar archivos adjuntos a una tarea. El archivo adjunto puede ser de tipo adjunto y nota. A continuación, se muestran las propiedades del objeto attachment.

Propiedad
Solo cliente
Comentarios
creationDate
F
La marca de tiempo del momento en el que se creó el archivo adjunto.
creatorId
F
El ID del usuario que agregó el archivo adjunto.
creatorName
F
El nombre del usuario que agregó el archivo adjunto.
Descripción
F
La descripción del archivo adjunto.
fileName
F
El nombre del archivo adjunto.
id
F
El ID del archivo adjunto.
lastModifiedDate
F
La marca de tiempo del momento en el que el archivo adjunto se modificó por última vez.
noteExtended
F
Si el valor es True, la nota es una nota ampliada (larga).
permissions
F
Los permisos asociados a un archivo adjunto. allowRead es para el permiso de lectura, allowWrite es para el permiso de escritura y allowDelete es para el permiso de eliminación.
size
F
El tamaño del archivo adjunto en bytes.
taskId
F
El ID de la tarea a la que se agrega el archivo adjunto.
type
F
El tipo es un archivo adjunto para archivos y una nota para notas.
formattedCreationDate
T
Contiene la fecha de creación del archivo adjunto según la configuración de la interfaz de usuario del usuario.
formattedDescription
T
La descripción formateada del archivo adjunto. Se utiliza para mostrar los caracteres especiales presentes en la descripción del archivo adjunto en AEM Forms Workspace.
formattedFileName
T
El nombre formateado del archivo adjunto. Se utiliza para mostrar los caracteres especiales presentes en el nombre del archivo adjunto en AEM Forms Workspace. Disponible únicamente para notas.

  1. Usuario

    A continuación, se muestran las propiedades del objeto user.

Propiedad
Solo cliente
Comentarios
address
F
La dirección del usuario
commonName
F
El nombre común del usuario
description
F
La descripción del usuario
directGroupMemberships
F
La lista del grupo del usuario
displayName
F
El nombre para mostrar del usuario
email
F
El ID de correo electrónico del usuario
isOutOfOffice
F
El valor es True si el usuario está fuera de la oficina
lastName
F
El apellido del usuario
firstName
F
El nombre del usuario
oid
F
El ID del usuario
org
F
El nombre de la organización del usuario
postalAddress
F
La dirección postal del usuario
telephone
F
El número de contacto del usuario
telephoneNumber
F
El número de contacto del usuario
userid
F
El ID de inicio de sesión del usuario
recommendation-more-help
a6ebf046-2b8b-4543-bd46-42a0d77792da