Descrição do objeto JSON do espaço de trabalho do AEM Forms

Última atualização em 2023-12-01

Os objetos JSON usados no espaço de trabalho do AEM Forms 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 de partida presentes em uma categoria
categoryList T Contém a lista de categorias filho diretas de uma categoria
OBSERVAÇÃO

Todos os pontos iniciais e favoritos são categorias definidas no lado do cliente. A categoria Favorito contém todos os pontos iniciais marcados pelo usuário como favoritos. A categoria Todos os pontos iniciais contém todos os pontos iniciais.

  1. Ponto inicial

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

    Propriedade Somente Cliente Comentários
    categoryId F Ele contém a ID da categoria à qual o ponto inicial pertence.
    descrição F Contém a descrição de um ponto inicial.
    name F Contém o nome do ponto inicial.
    serializedImageTicket F Ele contém um tíquete de imagem correspondente ao ponto inicial. Este tíquete de imagem é usado no campo imageUrl do ponto inicial, para obter a imagem do ponto inicial do servidor.
    serviceName F Ele contém o nome do serviço para o ponto inicial.
    startpointId F Ele contém a ID do ponto inicial.
    isFavorite T Indica se o ponto inicial é favorito ou não. Verdadeiro se o ponto inicial for favorito ou falso.
    isDefaultImage T Indica se há uma imagem especificada para o processo ou não. Verdadeiro se não houver imagem associada ao processo; caso contrário, é falso.
    tarefa T Ela contém tarefas criadas quando o ponto inicial é chamado.
    imageUrl T Ele contém o url da imagem correspondente ao ponto inicial.
  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 uma tarefa é atribuída a um usuário, ele recebe o formulário ou Guia para preencher e enviar.

Propriedade
Somente Cliente
Comentários
classOfTask F A classe de tarefa é 'LC8' quando a tarefa é lc8 e não 'Standard'.
completeTime
F Ele contém o carimbo de data e hora de conclusão da tarefa.
consultGroupId
F Ela contém a ID de um grupo para o qual a tarefa pode ser consultada. Ele é definido durante o design do processo.
createTime
F Ela contém o carimbo de data e hora de criação da tarefa.
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 Ela contém o carimbo de data e hora que quando uma tarefa atingirá seu prazo final.
descrição
F Contém a descrição da tarefa.
displayName
F Ele contém o nome de exibição da tarefa.
forwardGroupId
F Ela 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 Verdadeiro se o formulário de tarefa deve ser aberto para concluir a tarefa.
isOpenFullScreen
F Se verdadeiro, ao abrir a tarefa, o formulário ocupa tela completa na primeira vez.
isRouteSelectionRequired
F Se verdadeiro, a rota deve ser selecionada para concluir a tarefa.
isShowAttachments
F Os anexos serão exibidos se for verdadeiro.
isStartTask
F Se verdadeiro, a tarefa é criada a partir do ponto inicial.
isVisible
F True se a tarefa estiver visível no espaço de trabalho.
nextReminder
F Carimbo de data/hora para o próximo lembrete.
prioridade
F Ela contém a prioridade da tarefa.
1 = Maior prioridade
2 = Alta Prioridade
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 do processo da tarefa.
reminderCount
F Contém a contagem de lembretes para a tarefa.
routeList
F Ela contém a lista de rotas associadas à tarefa. O usuário pode concluir a tarefa selecionando qualquer um dos roteiros na lista de roteiros.
seletedRoute
F Contém o nome da rota selecionada quando a tarefa foi concluída.
serializedImageTicket
F Ele contém um tíquete de imagem correspondente à tarefa. Este tíquete de imagem é usado no campo imageUrl da tarefa, para obter imagem para tarefa do servidor.

serviceName
F Ele contém o nome do serviço da tarefa.
serviceTitle
F Ela contém o título do serviço da tarefa.
status
F 1 = Criada (a tarefa é criada a partir do ponto inicial.)
2 = Criada e salva (a tarefa é criada a partir do ponto inicial e salva).
3 = Atribuída (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 (a tarefa está concluída.)
101 = Prazo final (a tarefa atingiu o prazo final).
102 = Encerrado
stepName
F Ele contém o nome do conjunto de tarefas durante o design do processo.
summaryUrl
F Ele contém o URL de resumo da tarefa.
taskACL
F É uma lista de controle de acesso para uma tarefa.
taskId
F Id de uma tarefa.
updateTime
F Carimbo de data/hora da última atualização da tarefa.
formUrl
T Ele contém a URL do formulário de 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 e assim por diante.
showDirectActions
T Se verdadeiro, as ações de roteiro são visíveis no espaço de trabalho.
showACLActions
T Se true, ações como encaminhar, consultar, compartilhar estarão visíveis no espaço de trabalho.
supportedOffline
T Se verdadeiro, o formulário pode ser usado offline. Isso é somente para formulários pdf.
supportedSave
T Se verdadeiro, o usuário pode salvar a tarefa.
readerSubmitOptions
T Esse objeto contém opções que são usadas para enviar formulários pdf por meio do reader quando o formulário pdf não contém um botão de envio.
isDefaultImage
T Indica se há uma imagem especificada para o 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 de detalhes da tarefa.
isOwner
T Verdadeiro se o usuário conectado for o proprietário da tarefa.
availableCommands
T Ele contém todas as ações que podem ser executadas na tarefa.
availableCommands.directCommands
T Ele contém todas as ações de roteiro disponíveis para uma tarefa.
availableCommands.taskACLCommands
T Ela contém comandos como forward, share e consult, se disponíveis 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 Ela contém informações sobre a instância do processo da tarefa.
processVariables
T
Ela contém a matriz de objetos de variáveis de processo, se presentes.
pendingTasks
T Ela contém uma lista de tarefas pendentes para a instância do 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 É o URL para os dados do formulário de uma tarefa.
externalAppConfig
T Essa é a configuração para formulários de aplicativos de terceiros.
enviado
T Verdadeiro se a tarefa for enviada.
anexos
T Lista de anexos de uma tarefa.
Atribuições
T Lista de atribuições de uma tarefa.
  1. Filtro

    O filtro é basicamente uma fila de usuário ou grupo. Quando uma tarefa é atribuída a um usuário/grupo, ela é adicionada à fila correspondente.

Propriedade Somente Cliente Comentários
isDefault
F True se a fila for a 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 de usuários.
1. Fila compartilhada.
2. Fila de grupo.
query T Ele contém query associada a um filtro. Esta consulta é usada para pesquisar tarefas a partir da 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 sua programação de ausência temporária e controlar o fluxo de tarefas atribuídas a você em sua ausência.

Propriedade
Somente Cliente
Comentários
dateRanges
F Ele contém objetos de matriz de agendamentos de um usuário fora do escritório. Em cada objeto de agendamento, o campo startDate contém a data inicial do agendamento e o campo endDate contém a data final do agendamento. Se endDate for nulo na programação, isso implica que o usuário não programou a data final da programação fora do escritório.
isNoPrimaryDesignate
F Verdadeiro se não houver um representante principal no caso de o usuário estar ausente do escritório.
isOutOfOffice
F Verdadeiro se o usuário estiver ausente do escritório.
outOfOfficeDesignate
F Ele contém detalhes do usuário que é atribuído como designado principal pelo usuário.
processSpecificDesignates
F Ele contém uma matriz de objetos para designados fora do escritório específicos do processo. Em cada objeto designado específico do processo, processName contém o nome do processo, isNotDesignated é verdadeiro se nenhum usuário for atribuído ao processo correspondente e userDesignated é nulo se nenhum usuário tiver atribuído outros detalhes do usuário para o processo correspondente.
processos
T Ela 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 fora do escritório do usuário, que são buscadas inicialmente.
outOfOfficeSettings
T Ele contém configurações fora do escritório modificadas.
userSearchHistory
T Ela contém uma lista de usuários que são pesquisados por um usuário conectado até a data.
  1. Instância do processo

    Uma instância de processo é criada quando um processo é chamado por meio de um espaço de trabalho ou bancada.

Propriedade Somente Cliente Comentários
descrição
F Descrição da instância do processo
iniciador F Nome do iniciador de uma instância do 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 = Encerrando
6 = Suspenso
7 = Suspensão
8 = Cancelando Suspensão
processName
F Nome do processo.
processStartTime
F Carimbo de data/hora de início do processo.
processVariables
F Matriz de objetos de variáveis de processo. Cada objeto de variável de processo contém um nome que é o nome da variável de processo, um valor que é o valor da variável de processo e um tipo que é o tipo da variável de processo.
lista de tarefas
T Tarefas geradas por essa instância do 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 deste processo.
  1. Objeto de Atribuição de Tarefa

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

Propriedade Somente Cliente Comentários
assignmentCreateTime
F Carimbo de data/hora quando esta atribuição de uma tarefa é criada.
assignmentType
F 0 = Atribuição inicial
1 = Encaminhar (a tarefa foi encaminhada ao proprietário atual da tarefa.)
2 = Retornado (a tarefa foi retornada ao proprietário atual da tarefa pelo proprietário anterior da tarefa).
3 = Reclamado (a tarefa foi reclamada pelo proprietário atual da tarefa.)
4 = Escalação (a tarefa foi atribuída ao proprietário atual da tarefa após a escalação.)
5 = Administrador atribuído (a tarefa foi atribuída pelo administrador ao proprietário atual da tarefa.)
6 = Consultado ( a tarefa foi consultada para o proprietário atual da tarefa.)
assignmentUpdateTime
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 de Tarefa

    O objeto de ACL da tarefa contém informações sobre permissões como encaminhamento, compartilhamento, consulta e assim por diante 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 verdadeiro, as observações podem ser adicionadas à tarefa.
canClaim
F Se verdadeiro, a tarefa pode ser solicitada.
canConsult
F Se verdadeiro, a tarefa pode ser consultada.
canForward
F Se verdadeiro, a tarefa pode ser encaminhada.
canShare
F Se verdadeiro, a tarefa pode ser compartilhada.
  1. Anexo da tarefa

    Os anexos podem ser adicionados a uma tarefa. O anexo pode ser do tipo anexo e nota. A seguir estão as propriedades do objeto de anexo.

Propriedade Somente Cliente Comentários
creationDate
F Carimbo de data/hora quando o anexo foi criado.
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/hora da última modificação do anexo.
noteExtended
F Se verdadeiro, a nota será uma nota 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 foi adicionado.
tipo
F Tipo é o anexo para arquivos e Tipo é uma observação 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.
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.
directGroupMemberships
F Lista do grupo do usuário.
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 ausente 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 usuário.
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.

Nesta página