Propriedades da instância do fluxo

As propriedades da instância do Flow são utilizadas para a troca de dados entre diferentes tarefas e pontos de decisão, a fim de alcançar a função de negócios desejada.

Introdução

O sistema compartilha um arquivo de execução ( URL ) após a orquestração e publicação de um fluxo específico, seguindo as instruções documentadas em “Gerenciamento do Flow Designer ”. Uma nova instância do fluxo é gerada sempre que se clica no botão “ URL ”. Para cada uma dessas instâncias, é preenchido um conjunto de propriedades padrão ou integradas. Além das propriedades padrão, a tarefa em questão pode incluir uma série de propriedades personalizadas.

Essas propriedades são utilizadas para a troca de dados entre diferentes tarefas e pontos de decisão, a fim de ajudar a criar a função de negócios adequada.

Propriedades da instância do fluxo

Consulte a lista a seguir de propriedades padrão que são inicializadas a cada instância acionada.

Nome do Atributo Descrição Tipo
__tenantid O nome do locatário ao qual o usuário pertence. Sequência
__locale O conjunto de preferências relacionadas ao idioma ou ao país para uma interface de usuário. Sequência
status O status da tarefa (sucesso ou falha). Sequência
statusDetails A descrição do status da tarefa. Sequência
error O objeto para obter detalhes sobre os erros encontrados pelo fluxo. JSON
themeId O UUID de um tema personalizado que o usuário deseja configurar para o fluxo. Ele deve ser declarado como um parâmetro de consulta, enquanto o fluxo URL é acionado. Sequência
user Os dados do usuário foram obtidos do CD. SCIM
Nota:
  • Durante a execução da tarefa, os parâmetros de saída de determinadas tarefas são adicionados ao contexto do fluxo de trabalho.
  • O status das propriedades, os detalhes do status e o erro são reinicializados no início de cada tarefa. No caso da página, é possível utilizar esses valores para exibir ao usuário o erro relevante ou os detalhes do status.
  • O arquivo de execução URL pode ser aprimorado com parâmetros de consulta adicionais para inserir novas propriedades, além das padrão.
  • Os campos de entrada configurados na tarefa Página também são mantidos na instância do fluxo. Por exemplo, se uma tarefa de página tiver um campo de entrada,
<input type="text" name="username"></input> , a propriedade "username" é armazenada na instância do fluxo, correspondendo ao nome mencionado no campo de entrada.
Consulte a lista a seguir de propriedades sujeitas a aprovação.
Nome do Atributo Descrição Tipo
applicationId O ID do aplicativo para o qual o acesso é solicitado. Sequência
requestorId O ID do usuário que solicitou acesso. Sequência
requestId O ID da solicitação gerada ao iniciar tarefas de aprovação. Sequência
entitlementId O ID do direito para o qual o acesso é solicitado. Sequência

Propriedade de erro na instância do fluxo

Se o fluxo encontrar algum erro durante sua execução, uma propriedade de erro é gerada na instância do fluxo. O erro é do tipo JSON.

Em caso de erros irrecuperáveis, o fluxo é redirecionado para a página de erro padrão e a instância é encerrada. No caso de um erro recuperável, cabe ao usuário decidir qual será a próxima ação. A decisão pode ser tomada com base nos valores messageId,, messageDescription, ou taskName, presentes na propriedade error.

Quando uma determinada tarefa apresenta algum erro, o status dessa tarefa é failed.

Uso de propriedades durante a renderização de modelos

Assim como nas outras tarefas, as propriedades da instância do fluxo estão disponíveis para uso durante a tarefa Página. Essas propriedades podem ser usadas para substituir macros e gerar páginas de erro ou formulários de entrada relevantes, necessários para diferentes cenários de negócios. As propriedades podem ser usadas como macros da seguinte forma: @context.propertyName@.

A macro pode ser escrita da seguinte forma, caso uma propriedade específica esteja aninhada: @context.propertyName.nestedPropertyName@.

Vamos considerar um exemplo de uma propriedade de erro. É possível acessar a propriedade da seguinte forma enquanto o fluxo está sendo projetado: @context.error@. Da mesma forma, é possível acessar o arquivo de log do servidor ( messageId ) correspondente ao erro usando: @context.error.messageId@.

O usuário pode acessar o nó do enésimo nível dentro da propriedade por meio de uma macro, definindo o nome da propriedade e “.” sendo o delimitador.

Observação: se, por algum motivo, for utilizada uma macro inválida, ela será exibida tal como está e não será convertida em nenhuma sequência válida.