Descrição do objeto JSON do espaço de trabalho do AEM Forms aem-forms-workspace-json-object-description

CAUTION
AEM 6.4 chegou ao fim do suporte estendido e esta documentação não é mais atualizada. Para obter mais detalhes, consulte nossa períodos de assistência técnica. Encontre as versões compatíveis here.

Os objetos JSON usados no AEM Forms workspace são descritos abaixo.

  1. Categoria

    As categorias estão presentes na guia Iniciar processo do espaço de trabalho. Essas categorias são usadas para classificar os pontos de partida.

Propriedade
Somente cliente
Comentários
name
F
Nome da categoria
id
F
ID da categoria
descrição
F
Descrição da categoria
parentOid
F
Contém oid da categoria principal
startPointsList
T
Contém a lista de todos os pontos iniciais presentes em uma categoria
categoryList
T
Contém a lista de categorias secundárias diretas de uma categoria
NOTE
Todos os pontos de partida e Favoritos são categorias definidas no lado do cliente. A categoria favorita contém todos os pontos de partida que são marcados pelo usuário como favorito. A categoria Todos os pontos de partida contém todos os pontos de partida.
  1. Ponto de partida

    O ponto de partida é usado para iniciar um processo do espaço de trabalho quando chamado.

    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
    Propriedade Somente cliente Comentários
    categoryId F Ele contém o ID da categoria à qual o ponto de partida pertence.
    descrição F Ele contém a descrição de um ponto de partida.
    name F Ele contém o nome do ponto de partida.
    serializedImageTicket F Ele contém o tíquete de imagem correspondente ao ponto de partida. Esse tíquete de imagem é usado no campo imageUrl do ponto de partida para obter a imagem do ponto de partida do servidor.
    serviceName F Ele contém o nome do serviço para ponto de partida.
    startpointId F Ele contém ID do ponto de partida.
    isFavorite T Indica se o ponto de partida é favorito ou não. Verdadeiro se o ponto de partida for o favorito ou falso.
    isDefaultImage T Indica se há uma imagem especificada para processo ou não. Verdadeiro se não houver imagem associada ao processo; caso contrário, falso.
    tarefa T Ela contém a tarefa criada quando o ponto de partida é chamado.
    imageUrl T Ele contém o url da imagem correspondente ao ponto de partida.
  2. Tarefa

    As tarefas são atribuídas a usuários/grupos e incluem uma interface de usuário — um formulário ou um Guia (obsoleto) — que pode ser preenchida com dados. Quando os usuários recebem uma tarefa, eles recebem o formulário ou o Guia para concluir e enviar.

Propriedade
Somente cliente
Comentários
classOfTask
F
A classe de tarefa é 'LC8' quando a tarefa é lc8 task else 'Standard'.
completeTime
F
Ele contém o carimbo de data e hora em que a tarefa é concluída.
consultGroupId
F
Ele contém a ID de um grupo para o qual a tarefa pode ser consultada. Ele é definido durante o design do processo.
createTime
F
Ele contém o carimbo de data e hora em que a tarefa é criada.
creationId
F
Ele contém a id do usuário que criou a tarefa.
currentAssignment
F
Ele contém detalhes sobre a atribuição atual da tarefa.
prazo
F
Ele contém o carimbo de data e hora que uma tarefa atingirá seu prazo final.
descrição
F
Ele contém a descrição da tarefa.
displayName
F
Ele contém o nome de exibição da tarefa.
forwardGroupId
F
Ele contém a ID de um grupo para o qual a tarefa pode ser encaminhada. Ele é definido durante o design do processo.
instruções
F
Ele contém instruções para uma tarefa.
isLocked
F
True se a tarefa estiver bloqueada.
ismustOpenToComplete
F
True se o formulário de tarefa tiver de ser aberto para concluir a tarefa.
isOpenFullScreen
F
Se verdadeiro, ao abrir a tarefa, o formulário ocupa a tela completa primeiro.
isRouteSelectionRequired
F
Se true, a rota deverá ser selecionada para concluir a tarefa.
isShowAttachments
F
Os anexos são mostrados se for verdadeiro.
isStartTask
F
Se true, a tarefa será criada a partir do ponto de início.
isVisible
F
True se a tarefa estiver visível no espaço de trabalho.
nextLembreder
F
Carimbo de data/hora do próximo lembrete.
prioridade
F
Ele contém prioridade de tarefa.
1 = Prioridade mais alta
2 = Prioridade alta
3 = Prioridade normal
4 = Prioridade baixa
5 = Prioridade mais baixa
processInstanceId
F
Id da instância do processo da qual a tarefa faz parte.
processInstanceStatus
F
Status da instância de processo da tarefa.
reminderCount
F
Ele contém a contagem de lembretes para a tarefa.
routeList
F
Ele contém a lista de rotas associadas à tarefa. O usuário pode concluir a tarefa selecionando qualquer uma das rotas da lista de rotas.
seletedRoute
F
Ele contém o nome da rota selecionada quando a tarefa foi concluída.
serializedImageTicket
F
Ele contém o tíquete de imagem correspondente à tarefa. Esse tíquete de imagem é usado no campo imageUrl da tarefa para obter a imagem da tarefa do servidor.
serviceName
F
Ele contém o nome do serviço para a tarefa.
serviceTitle
F
Ele contém o título do serviço para a tarefa.
status
F
1 = Criado (a tarefa é criada a partir do ponto de início.)
2 = Criada e salva (a tarefa é criada a partir do ponto de início e salva.)
3 = Atribuído (a tarefa é atribuída ao usuário após o início do processo.)
4 = Atribuído e salvo (a tarefa é atribuída e salva.)
100 = Concluído (Tarefa concluída.)
101 = Prazo final (a tarefa atingiu o prazo final.)
102 = Terminado
stepName
F
Ele contém o nome do conjunto de tarefas durante a criação do processo.
summaryUrl
F
Ele contém o url de resumo de tarefa.
taskACL
F
É uma lista de controle de acesso para uma tarefa.
taskId
F
ID de uma tarefa.
updateTime
F
Carimbo de data/hora em que a tarefa foi atualizada pela última vez.
formUrl
T
Ele contém url de formulário para uma tarefa.
taskFormType
T
Ele contém o tipo de formulário de tarefa. Usando esse campo, a tarefa é renderizada no cliente como pdf para, formulário swf etc.
showDirectActions
T
Se true, as ações de rota estarão visíveis no espaço de trabalho.
showACLActions
T
Se verdadeiro, ações como encaminhar, consultar, compartilhar ficam visíveis no espaço de trabalho.
supportOffline
T
Se verdadeiro, o formulário pode ser colocado offline. Isso é somente para formulários pdf.
supportSave
T
Se true, o usuário poderá salvar a tarefa.
readerSubmitOptions
T
Esse objeto contém opções usadas para enviar formulários pdf pelo leitor, caso o formulário pdf não contenha nenhum botão Enviar.
isDefaultImage
T
Indica se há uma imagem especificada para processo ou não. Verdadeiro se não houver imagem associada ao processo; caso contrário, falso.
historyTaskList
T
Ele contém a lista de tarefas que são usadas na guia Histórico dos detalhes da tarefa.
isOwner
T
True se o usuário conectado for proprietário da tarefa.
availableCommands
T
Ele contém todas as ações que podem ser realizadas na tarefa.
availableCommands.directCommands
T
Ele contém todas as ações de rota disponíveis para uma tarefa.
availableCommands.taskACLCommands
T
Ele contém comandos como encaminhar, compartilhar e consultar se disponível para uma tarefa.
availableCommands.otherCommands
T
Ele contém comandos como bloquear, desbloquear, abandonar, retornar, reivindicar e assim por diante, conforme disponível.
processInstanceInfo
T
Ele contém informações sobre a instância do processo da tarefa.
processVariables
T
Ela contém matriz de objetos de variáveis de processo, se presentes.
pendingTasks
T
Ele contém uma lista de tarefas pendentes para a instância de processo da tarefa.
userActions
T
É uma matriz de objetos. Cada objeto contém detalhes sobre a rota e sua mensagem de confirmação correspondente, se presente.
dataUrl
T
É url para os dados do formulário de uma tarefa.
externalAppConfig
T
Essa é a configuração para formulários de aplicativos de terceiros.
submetido
T
True se a tarefa for enviada.
anexos
T
Lista de anexos para uma tarefa.
Atribuições
T
Lista de atribuições de uma tarefa.
  1. Filtro

    O filtro é basicamente a fila de usuários ou grupos. Quando uma tarefa é atribuída ao usuário/grupo, a tarefa é adicionada na fila correspondente.

Propriedade
Somente cliente
Comentários
isDefault
F
True se a fila for uma fila padrão do usuário conectado, caso contrário false.
name
F
Nome do proprietário da fila.
qid
F
Id da fila.
tipo
F
Ele contém o tipo da fila.
0 - Fila do usuário.
1. Fila compartilhada.
2. Fila de grupo.
query
T
Isso contém uma consulta associada a um filtro. Esta consulta é usada para pesquisar tarefas a partir de uma lista de tarefas completa.
tarefas
T
Ele contém uma lista de todas as tarefas que pertencem a um filtro.
  1. Fora do escritório

    Você pode gerenciar seu agendamento de ausência do escritório e controlar o fluxo de tarefas atribuídas a você na sua ausência.

Propriedade
Somente cliente
Comentários
dateRanges
F
Ele contém objetos de matriz de agendamentos esgotados de um usuário. Em cada objeto de programação, o campo startDate contém a data inicial da programação e o campo endDate contém a data final da programação. Se endDate for nulo na programação, isso significa que o usuário não agendou a data final da programação de ausência do escritório.
isNoPrimaryDesignate
F
Verdadeiro se não houver um designado principal caso o usuário esteja fora do escritório.
isOutOfOffice
F
Verdadeiro se o usuário estiver fora do escritório.
outOfOfficeDesignate
F
Ele contém detalhes do usuário atribuído como principal designado pelo usuário.
processSpecificDesigates
F
Ele contém vários objetos para designar fora do escritório específico do processo. Em cada objeto designado específico do processo, processName contém o nome do processo, isNotDesignated será verdadeiro se nenhum usuário for atribuído ao processo correspondente e userDesignated será nulo se nenhum usuário tiver atribuído mais detalhes do usuário atribuído para o processo correspondente.
processos
T
Ele contém uma lista de todos os processos que estão disponíveis para o usuário.
initialOutOfOfficeSettings
T
Ele contém as configurações iniciais de ausência do escritório do usuário que são buscadas inicialmente.
outOfOfficeSettings
T
Ele contém configurações remotas do escritório modificadas.
userSearchHistory
T
Ele contém a lista de usuários pesquisados pelo usuário conectado até a data.
  1. Instância do processo

    Uma instância do processo é criada quando um processo é chamado pelo espaço de trabalho ou pelo workbench.

Propriedade
Somente cliente
Comentários
descrição
F
Descrição da instância do processo
iniciador
F
Nome do iniciador de uma instância de processo.
initiatorId
F
ID do iniciador da instância do processo.
processCompleteTime
F
Carimbo de data/hora quando o processo é concluído.
processInstanceId
F
ID da instância do processo.
processInstanceStatus
F
0 = Iniciado
1 = Em Execução
2 = Concluído
3 = Concluindo
4 = Terminado
5 = Terminando
6 = Suspenso
7 = Suspensão
8 = Suspensão
processName
F
Nome do processo.
processStartTime
F
Carimbo de data/hora quando o processo foi iniciado.
processVariables
F
Matriz de objetos de variáveis de processo. Cada objeto de variável de processo contém o nome que é a variável de processo, o valor que é o valor da variável de processo e o tipo que é o tipo de variável de processo.
lista de tarefas
T
Tarefas geradas por esta instância de processo.
  1. Nome do processo
Propriedade
Somente cliente
Comentários
processMajorVersion
F
Versão principal de um processo.
processMinorVersion
F
Versão secundária de um processo.
processName
F
Nome do processo.
processTitle
F
Título do processo.
processInstanceList
T
Lista de instâncias de processo para esse processo.
  1. Objeto de Atribuição de Tarefa

    O objeto de atribuição de tarefa contém informações sobre a atribuição de tarefa. A seguir estão as propriedades da atribuição da tarefa.

Propriedade
Somente cliente
Comentários
assignCreateTime
F
Carimbo de data/hora quando esta atribuição de uma tarefa é criada.
assignType
F
0 = Atribuição inicial
1 = Encaminhar (A tarefa foi encaminhada para o proprietário atual da tarefa.)
2 = Retornado (a tarefa foi retornada ao proprietário atual da tarefa pelo proprietário anterior da tarefa.)
3 = Solicitado (a tarefa foi reivindicada pelo proprietário atual da tarefa.)
4 = Escalonamento (a tarefa foi atribuída ao proprietário atual da tarefa após o escalonamento.)
5 = Administrador Atribuído (a tarefa foi atribuída pelo administrador ao proprietário atual da tarefa.)
6 = Consultado ( A tarefa foi consultada ao proprietário atual da tarefa.)
assignUpdateTime
F
Carimbo de data/hora quando esta atribuição de uma tarefa é atualizada.
queueId
F
ID da Fila do proprietário atual da tarefa.
queueOwner
F
Nome do proprietário atual da tarefa.
queueOwnerId
F
ID do proprietário atual da tarefa.
  1. Objeto ACL da tarefa

    O objeto ACL de tarefa contém informações sobre permissões, como encaminhar, compartilhar, consultar etc. de uma tarefa. A seguir estão as propriedades da ACL da tarefa.

Propriedade
Somente cliente
Comentários
canAddAttachments
F
Se verdadeiro, os anexos podem ser adicionados à tarefa.
canAddNotes
F
Se true, as notas poderão ser adicionadas à tarefa.
canClaim
F
Se true, a tarefa poderá ser reivindicada.
canConsult
F
Se true, a tarefa poderá ser consultada.
canForward
F
Se true, a tarefa poderá ser encaminhada.
canShare
F
Se true, a tarefa poderá ser compartilhada.
  1. Anexo da tarefa

    Anexos podem ser adicionados a uma tarefa. O anexo pode ser do tipo anexo e nota. Veja a seguir as propriedades do objeto de anexo.

Propriedade
Somente cliente
Comentários
creationDate
F
Carimbo de data/hora ao criar o anexo.
creatorId
F
ID do usuário que adicionou o anexo.
creatorName
F
Nome do usuário que adicionou o anexo.
descrição
F
Descrição do anexo.
fileName
F
Nome do anexo.
id
F
ID do anexo.
lastModifiedDate
F
Carimbo de data e hora da última modificação do anexo.
noteExtended
F
Se true, a nota será estendida (longa).
permissões
F
Permissões associadas a um anexo. O campo allowRead é para permissão de leitura, allowWrite é para permissão de gravação, allowDelete é para permissão de exclusão.
tamanho
F
Tamanho do anexo em bytes.
taskId
F
ID da tarefa à qual o anexo é adicionado.
tipo
F
Tipo é anexo para arquivos e Tipo é nota para notas.
formattedCreationDate
T
Ele contém a data de criação do anexo de acordo com as configurações da interface do usuário do usuário.
formattedDescription
T
Descrição do anexo formatado. Usado para exibir caracteres especiais presentes na descrição do anexo no espaço de trabalho do AEM Forms.
formattedFileName
T
Nome do anexo formatado. Usado para exibir caracteres especiais presentes no nome do anexo no espaço de trabalho do AEM Forms. Isso é somente para notas.
  1. Usuário

    A seguir estão as propriedades do objeto do usuário.

Propriedade
Somente cliente
Comentários
endereço
F
Endereço do usuário.
commonName
F
Nome comum do usuário.
descrição
F
Descrição do usuário.
directGroupMembership
F
Lista do grupo de usuários.
displayName
F
Nome de exibição do usuário.
email
F
ID de email do usuário.
isOutOfOffice
F
Verdadeiro se o usuário estiver fora do escritório.
lastName
F
Sobrenome do usuário.
firstName
F
Nome do usuário.
oid
F
ID do usuário.
org
F
Nome da organização do usuário.
postalAddress
F
Endereço postal do utilizador.
telefone
F
Número de contato do usuário.
phoneNumber
F
Número de contato do usuário.
userid
F
ID de logon do usuário.
recommendation-more-help
a6ebf046-2b8b-4543-bd46-42a0d77792da