> Source: https://docs.cyberelements.io/identity/7.0/pt/UserDocumentation/WorkflowManagement/WorkflowConfiguration/WorkflowParameters/

# Definições do workflow

Um modelo de workflow é definido por:

- As suas definições gerais,
- As suas definições de inicialização,
- Os seus utilizadores reais ou de sistema autorizados a iniciá-lo,
- Uma autorização de execução sobre o requerente,
- Os seus managers,
- O seu âmbito: pessoas destinatárias do workflow (por exemplo: internos, pessoas de um departamento),
- A sua regra de validação, que depende do estado das etapas,
- As suas etapas,
- As suas ações e tarefas.

![](https://docs.cyberelements.io/identity/7.0/img/Identity/IdU_ConfigDetailsWorkflow.png)

## Definições gerais

![](https://docs.cyberelements.io/identity/7.0/img/Identity/IdU_ConfigWorkflowParametresGeneraux.png)

| Parameter | Description | Tipo e valores possíveis |
|---|---|---|
| Created by | Nome de apresentação do criador do modelo de workflow. | Visível apenas em modo de consulta.  Não editável. |
| Put into production by | Nome de apresentação da identidade que colocou o workflow em produção. | Visível apenas em modo de consulta.  Não editável. |
| Workflow ID | Identificador único atribuído pelo CyberElements Identity. | Visível apenas em modo de consulta.  Não editável. |
| Version | Identificador único atribuído pelo CyberElements Identity.  Incrementado automaticamente cada vez que o modelo de workflow é modificado. | Visível apenas em modo de consulta.  Não editável. |
| Category | Permite classificar o modelo de workflow numa categoria. | Lista de valores definidos pelas categorias de workflow. |
| Name | Nome do workflow.  É apresentado na lista Workflows da interface de administração e na interface de utilizador.  É possível personalizar o nome com um valor específico da instância de workflow, incluindo uma palavra-chave. | Obrigatório.  Cadeia de caracteres que pode conter palavras-chave. Nesse caso, a cadeia de caracteres não deve conter espaços nem caracteres especiais.  Exemplo:  Request_Right_#TARGET#ATTRIBUTE#displayname#  Cada pedido de direitos será sufixado com os nomes das pessoas para as quais os pedidos de direitos foram efetuados.  ![](https://docs.cyberelements.io/identity/7.0/img/Identity/IdU_SuffixeDemandeDroitsParametresGeneraux.png) |
| Code | Código que identifica a configuração de um Workflow; deve ser único. | Obrigatório.  Character string, sem espaços nem caracteres especiais. |
| Description | Descrição do workflow.  Será apresentada na interface de utilizador para os workflows de pedido de utilizador. | Cadeia de caracteres. |
| Title | Título do Workflow tal como será apresentado na interface de utilizador. | Cadeia de caracteres. |
| Allow note(s) to be added | Permite autorizar ou proibir a adição de notas às instâncias de workflow a partir da interface de utilizador. | Yes/No.  Valor predefinido = No |
| Archiving period (days) | Define o tempo durante o qual as instâncias de workflow arquivadas permanecem na base de dados. | Numérico.  O período de arquivo começa assim que o workflow é concluído. Depois de expirado o período de arquivo, a instância de workflow é automaticamente eliminada da base de dados. (Não válido para os workflows diferidos, que nunca são eliminados)  Valor predefinido = 0. |

## Definições de inicialização

As definições de inicialização permitem definir o tipo de workflow e as suas características, bem como o modo de desencadeamento. Os campos de configuração variam em função do tipo de workflow selecionado.

![](https://docs.cyberelements.io/identity/7.0/img/Identity/IdU_ConfigWorkflowParametresInitialisation.png)

As definições de inicialização comuns a todos os tipos de workflow são as seguintes:

| Parameter | Description | Tipo e valores possíveis |
|---|---|---|
| Statut | Parâmetro que indica o estado do workflow. Apenas os workflows em produção serão executados pelo motor de workflows e estarão disponíveis na lista de pedidos de um utilizador. | Under construction  In production  Suspended  Enabled |
| Workflow type | Escolha do tipo de workflow. | A pedido dos utilizadores: está disponível um formulário de pedido de utilizador no menu «workflow» da consola de exploração.  Sobre um evento: desencadeamento do workflow condicionado por um evento do CyberElements Identity que pode ser submetido a validação, como as atribuições ou desatribuições (contas, perfis, delegação, recursos, pessoas), as criações, modificações ou eliminações (pessoas, direitos, estruturas, regras de autorização, enumerados, sincronizações), as delegações e eliminações de delegação, as certificações e descertificações de direitos, as mudanças de contexto, as reconciliações de identidades e as transferências de pessoal.  Desencadeamento diferido: desencadeamento do workflow a partir de um atributo de tipo data da pessoa (por exemplo: data de entrada, data de saída, data de nascimento), ou a partir da data de expiração de um direito.  Periódico: workflow desencadeado a partir de uma frequência de execução. |

Os parâmetros de inicialização em função do tipo de workflow são descritos a seguir:

- Tipo de workflow «User request»: estão disponíveis vários tipos de workflows «user request» e a configuração dos parâmetros de inicialização difere em função do tipo escolhido.

  | Parameter | Description | Tipo e valores possíveis |
  |---|---|---|
  | Request | Natureza do pedido de utilizador. | Rights request |
  | Check SOD | Exige a verificação das regras de separação de direitos ao preencher o formulário de pedido. O utilizador não poderá validar o seu pedido se os direitos pedidos não cumprirem as regras SOD. | Yes/No |
  | Right | Lista de direitos que o utilizador que inicia o workflow pode pedir. | Lista de direitos. |
  | Additional fields | Permite configurar campos de texto ou enumerados adicionais no formulário de pedido. | Seleção de um ou vários atributos (apenas de tipo cadeia de caracteres ou enumerado) na lista de atributos existentes. |

  | Parameter | Description | Tipo e valores possíveis |
  |---|---|---|
  | Request | Natureza do pedido de utilizador. | Pedido de modificação de atributos |
  | Attribute selection | Lista de atributos que o utilizador que inicia o workflow pode modificar. | Lista de atributos.  Visível se: Request = «Request to modify attributes» |

  | Parameter | Description | Tipo e valores possíveis |
  |---|---|---|
  | Request | Natureza do pedido de utilizador. | Resource request |
  | Resource type | Tipo de recursos que o utilizador que inicia o workflow pode pedir. | Tipo de recurso. (Tenha em atenção que, para utilizar corretamente esta funcionalidade, deve selecionar apenas um tipo de recurso por workflow) |

  | Parameter | Description | Tipo e valores possíveis |
  |---|---|---|
  | Request | Natureza do pedido de utilizador. | Pedido de aprovisionamento manual |
  | Check SOD | Exige a verificação das regras de separação de direitos ao preencher o formulário de pedido. O utilizador não poderá validar o seu pedido se os direitos pedidos não cumprirem as regras SOD. | Yes/No |
  | Right | Lista de direitos que o utilizador que inicia o workflow pode pedir. | Lista de direitos. |
  | Additional fields | Permite configurar campos de texto ou enumerados adicionais no formulário de pedido. | Seleção de um ou vários atributos (apenas de tipo cadeia de caracteres ou enumerado) na lista de atributos existentes. |

  | Parameter | Description | Tipo e valores possíveis |
  |---|---|---|
  | Request | Natureza do pedido de utilizador. | Other request |
  | Descrição do pedido | Description | Cadeia de caracteres. |
    - Pedido de direitos: permite a um utilizador pedir direitos através de um formulário. Pode efetuar o pedido para si mesmo ou para uma ou várias outras pessoas.
    - Pedido de modificação de atributos: permite a um utilizador pedir a alteração do valor de um ou vários atributos através de um formulário. Pode efetuar o pedido para si mesmo ou para uma ou várias outras pessoas.
    - Pedido de recursos: permite a um utilizador submeter um pedido de atribuição de recursos através de um formulário. Pode efetuar o pedido para si mesmo ou para uma ou várias outras pessoas.
    - Pedido de aprovisionamento manual: permite a um utilizador submeter um pedido de aprovisionamento manual através de um formulário. Pode efetuar o pedido para si mesmo ou para uma ou várias outras pessoas.
    - Outro pedido: permite a um utilizador efetuar um pedido personalizado através de um formulário. O pedido é efetuado em forma de texto. Pode efetuá-lo para si mesmo ou para uma ou várias outras pessoas.
- Tipo de workflow «On an event»: os eventos são gerados pelo CyberElements Identity para cada operação incluída na lista seguinte.

| Parameter | Description | Tipo e valores possíveis |
|---|---|---|
| Event | Parâmetro que indica o evento ou os eventos que desencadeiam o workflow. | Lista de eventos (ver a lista seguinte) |
| Opção de desencadeamento em função do estado da ação | Condição de desencadeamento ligada ao estado da ação que gerou o evento. | Success/Failure/Both |
| Opção de desencadeamento do workflow em função da cronologia da ação | Condição de desencadeamento do workflow | Before/After/Both.  Before: marque esta opção para criar uma validação antes de o evento ocorrer efetivamente (exemplo: validação da criação de uma pessoa).  After: marque esta opção para que a primeira etapa seja desencadeada depois de o evento ter ocorrido. |
| Conditions to be validated | Workflow desencadeado se todos os eventos enviados, ou parte deles, forem validados. | Pelo menos uma das condições deve ser validada,  Todas as condições devem ser validadas. |
| Grouping | Permite desencadear um único workflow quando é enviado ao mesmo tempo um lote de eventos semelhantes. | Yes/No.  Esta opção está disponível para os seis eventos seguintes:  Atribuição de direitos  Modificação de direitos  Modificação de uma pessoa  Reconciliação das identidades de uma pessoa  Retirada de direitos  Eliminação da reconciliação de identidades de uma pessoa |

Lista de eventos e parâmetros opcionais

- Tipo de workflow «Delayed Trigger»: é possível desencadear um workflow X dias antes ou depois da data de um atributo definido ou da data de fim de um direito indicado.

| Parameter | Description | Tipo e valores possíveis |
|---|---|---|
| Based on | Parâmetro que permite indicar o atributo de tipo data no qual o workflow se baseará | «On attribute»: lista de atributos de tipo data.  «On expiration of a right»: aplica-se a todos os direitos que tenham uma data de fim indicada. |
| Time period | «Before» (número de dias): execução antecipada do workflow a partir do valor do atributo de data destinatário.  «After» (número de dias): execução diferida do workflow a partir do valor do atributo de data destinatário. | Número inteiro. |

- Tipo de workflow «Periodic»: permite enviar workflows com uma frequência determinada

| Parameter | Description | Tipo e valores possíveis |
|---|---|---|
| Every | Parâmetros que permitem indicar a frequência com que um workflow periódico é desencadeado. | Frequência a selecionar na lista: - Dia(s) - Semana(s) - Mês - Hora(s) |
| Sending time | Hora a que o workflow periódico é desencadeado. | Números inteiros. Definem a hora de envio quando a frequência selecionada é dia, semana ou mês, ou a hora do primeiro envio quando a frequência é do tipo «hora». |

## User(s)

A secção «Users» permite definir que pessoas ou identidades podem executar um workflow. As possibilidades variam em função do tipo de workflow escolhido.

![](https://docs.cyberelements.io/identity/7.0/img/Identity/IdU_ConfigWorkflowUtilisateurs.png)

| Parameter | Description | Tipo e valores possíveis |
|---|---|---|
| Authorized user(s) | Pessoa ou pessoas, reais ou de sistema, autorizadas a iniciar o workflow. | - Todos (pessoas reais), - Uma lista de pessoas (válido para os workflows por evento ou por pedido de utilizador), - Uma avaliação SQL (válido para os workflows por evento), - Sistema (HPP, ILM - válido apenas para os workflows por evento, de desencadeamento diferido ou periódicos), - Qualquer pessoa (sistema + pessoas reais. Válido apenas nos workflows por evento ou de desencadeamento diferido). |
| Filter | Tipo de filtro que define como é obtida a lista de pessoas autorizadas a iniciar o workflow.  Exemplo: utilizadores com direitos de administração do CyberElements Identity ou responsáveis por um serviço. | Visível se «Authorized user(s)» = «A list of persons»: - Lista (IDs), - Lista de IDs devolvidos por uma avaliação SQL. |
| Selection | Lista resultante da seleção de pessoas efetuada durante a configuração. | Visível se «Authorized user(s)» = «A list of persons» e se «Filter» = «List (ids)».  Lista de pessoas a selecionar. ![](https://docs.cyberelements.io/identity/7.0/img/Identity/IdU_SelectionUtilisateurs.png) |
| Filter query | Parâmetro que permite indicar uma consulta SQL para filtrar as pessoas desejadas. | Visível se «Authorized user(s)» = «A list of persons» e se «Filter» = «List of IDs returned by an SQL evaluation».  Cadeia de caracteres: consulta SQL utilizada para filtrar as pessoas desejadas. Consulte [esta página](https://docs.cyberelements.io/identity/7.0/pt/UserDocumentation/GeneralConfigurations/ManagingKeywordsInWorkflows/) para a utilização das palavras-chave. ![](https://docs.cyberelements.io/identity/7.0/img/Identity/IdU_ConfigRequeteFiltreUtilisateurs.png) |

## Permitir a execução para si mesmo?

Esta opção só é visível se o tipo de workflow estiver definido como «On User Request». Permite autorizar ou proibir que um utilizador submeta um pedido para si mesmo.

O número de utilizadores autorizados a submeter um pedido para si mesmos também pode ser reduzido através de filtros.

Também é possível configurar um workflow para permitir a execução apenas para si mesmo. As configurações a aplicar são detalhadas a seguir.

![](https://docs.cyberelements.io/identity/7.0/img/Identity/IdU_ConfigWorkflowAutoriserExecutionPourMoiMeme.png)

| Parameter | Description | Tipo e valores possíveis |
|---|---|---|
| Allow | Parâmetro que indica se o utilizador que efetua um pedido o pode fazer em seu próprio nome. | - Yes (selecionada), - No (não selecionada). |
| Filter | Tipo de filtro que define como é obtida a lista de pessoas autorizadas a efetuar um pedido.  Exemplo: utilizadores com direitos de administração do CyberElements Identity ou responsáveis por um serviço. | Visível se «Allow» = Yes (selecionada). - Lista (IDs) - Lista de IDs devolvidos por uma avaliação SQL: opção que deve ser selecionada se o workflow só pode ser executado para si mesmo. |
| Selection | Lista resultante da seleção de pessoas efetuada durante a configuração. | Visível se «Authorized user(s)» = «A list of persons» e se «Filter» = «List (ids)».  Lista de pessoas a selecionar. ![](https://docs.cyberelements.io/identity/7.0/img/Identity/IdU_SelectionUtilisateurs.png) |
| Filter query | Parâmetro que permite indicar uma consulta SQL para filtrar as pessoas desejadas. | Visível se «Authorized User(s)» = «A list of persons» e se «Filter» = «List of IDs returned by an SQL evaluation».  Cadeia de caracteres: consulta SQL utilizada para filtrar as pessoas desejadas.  ![](https://docs.cyberelements.io/identity/7.0/img/Identity/IdU_ConfigRequeteFiltreUtilisateurs.png)  Se o workflow só pode ser executado para si mesmo, utilize a sintaxe seguinte:  §PERSON§ATTRIBUTE§UID§=#STARTER#ATTRIBUTE#UID#  Consulte [esta página](https://docs.cyberelements.io/identity/7.0/pt/UserDocumentation/GeneralConfigurations/ManagingKeywordsInWorkflows/) para a utilização das palavras-chave. |

## Manager

A secção «Manager» permite definir que pessoas podem gerir as instâncias deste workflow, ou seja, essas pessoas estarão autorizadas a consultar as instâncias de workflow e a atuar sobre elas enquanto o workflow não estiver no estado concluído/arquivado.

![](https://docs.cyberelements.io/identity/7.0/img/Identity/IdU_ConfigWorkflowManager.png)

| Parameter | Description | Tipo e valores possíveis |
|---|---|---|
| Workflow administrator(s) | Pessoa ou pessoas reais autorizadas a gerir o workflow, ou seja, a pausá-lo, reiniciá-lo, pará-lo e validar ações como as aprovações. | Lista de pessoas. |
| Filter | Filtro que define como é obtida a lista de pessoas autorizadas a administrar o workflow. | - Lista (IDs) - Lista de IDs devolvidos por uma avaliação SQL. |
| Selection | Lista resultante da seleção de pessoas efetuada durante a configuração. | Visível se «Authorized user(s)» = «A list of persons» e se «Filter» = «List (ids)».  Lista de pessoas a selecionar. ![](https://docs.cyberelements.io/identity/7.0/img/Identity/IdU_SelectionUtilisateurs.png) |
| Filter query | Parâmetro que permite indicar uma consulta SQL para filtrar as pessoas desejadas. | Visível se «Authorized user(s)» = «A list of persons» e se «Filter» = «List of IDs returned by an SQL evaluation».  Cadeia de caracteres: consulta SQL utilizada para filtrar as pessoas desejadas. Consulte [esta página](https://docs.cyberelements.io/identity/7.0/pt/UserDocumentation/GeneralConfigurations/ManagingKeywordsInWorkflows/) para a utilização das palavras-chave.  -->![](https://docs.cyberelements.io/identity/7.0/img/Identity/IdU_ConfigRequeteFiltreUtilisateurs.png) |

## Scope

A secção «Scope» permite definir condições para filtrar as identidades que podem ser destinatárias do workflow. O âmbito do workflow aplica-se apenas aos workflows dos tipos «On event», «Delayed trigger» ou «On user request».

![](https://docs.cyberelements.io/identity/7.0/img/Identity/IdU_ConfigWorkflowPerimetre.png)

| Parameter | Description | Tipo e valores possíveis |
|---|---|---|
| Âmbito do workflow: | Pessoa ou pessoas reais sobre as quais o workflow é executado (permite filtrar o destinatário do workflow). | - «All»: todas as identidades, - «List»: permite limitar o âmbito Exemplo: para um workflow sobre um evento de criação de pessoa, poderia limitar-se o âmbito às criações de pessoas externas. Para os pedidos de direitos, os pedidos poderiam limitar-se aos utilizadores de um serviço. |
| Filter | Tipo de filtro que define como é obtida a lista de pessoas destinatárias do workflow. | - Lista (IDs) - Lista de IDs devolvidos por uma avaliação SQL. |
| Selection | Lista resultante da seleção de pessoas efetuada durante a configuração. | Visível se «Authorized user(s)» = «A list of persons» e se «Filter» = «List (ids)».  Lista de pessoas a selecionar. ![](https://docs.cyberelements.io/identity/7.0/img/Identity/IdU_SelectionUtilisateurs.png) |
| Filter query | Parâmetro que permite indicar uma consulta SQL para filtrar as pessoas desejadas. | Visível se «Authorized user(s)» = «A list of persons» e se «Filter» = «List of IDs returned by an SQL evaluation».  Cadeia de caracteres: consulta SQL utilizada para filtrar as pessoas desejadas. Consulte [esta página](https://docs.cyberelements.io/identity/7.0/pt/UserDocumentation/GeneralConfigurations/ManagingKeywordsInWorkflows/) para a utilização das palavras-chave.  ![](https://docs.cyberelements.io/identity/7.0/img/Identity/IdU_ConfigRequeteFiltreUtilisateurs.png) |

## Validação do workflow

A secção «Workflow validation» consiste em definir o estado da instância de workflow a partir dos estados das etapas que compõem o workflow. Os managers do workflow também podem ser autorizados a validar (as etapas de validação) em nome dos validadores (para desbloquear workflows em caso de ausência, por exemplo).

![](https://docs.cyberelements.io/identity/7.0/img/Identity/IdU_ConfigWorkflowValidationWorkflow.png)

| Parameter | Description | Tipo e valores possíveis |
|---|---|---|
| Allow validation by manager | Permite a validação do workflow pelos managers do workflow (além dos validadores definidos nas etapas do workflow). | - Yes (selecionada), - No (não selecionada). |
| Validation rule | Parâmetro que permite definir a regra a verificar para indicar se o workflow foi bem-sucedido ou falhou. | - O workflow é bem-sucedido se a última etapa foi bem-sucedida, - O workflow falha se pelo menos uma etapa falhar, - Regra de avaliação que determina se o workflow foi bem-sucedido. |
| Query | Parâmetro que permite indicar uma consulta SQL para definir com maior precisão os elementos que determinarão se um workflow ficará no estado «Successful». | Visível se «Validation Rule» = «Evaluation rule determining whether the workflow succeeds».  Cadeia de caracteres: consulta SQL utilizada para extrair os elementos que determinarão se um workflow está no estado «Successful» ou «Failed». A consulta deve devolver um valor booleano. Se o valor devolvido for 1, o workflow ficará no estado «Successful»; caso contrário, ficará no estado «Failed». Consulte [esta página](https://docs.cyberelements.io/identity/7.0/pt/UserDocumentation/GeneralConfigurations/ManagingKeywordsInWorkflows/) para a utilização das palavras-chave. ![](https://docs.cyberelements.io/identity/7.0/img/Identity/IdU_ConfigWorkflowValidationWorkflowRequete.png) |

Nota sobre a validação do workflow:

Quando uma ação (ou uma etapa) não é executada porque o contexto não cumpre as condições de execução da ação (ou da etapa), não é criada nenhuma instância de ação (ou de etapa) na base de dados.

Por conseguinte, não é possível obter o estado da ação ou da etapa.

Se, para uma determinada etapa sem condições de execução, nenhuma das suas ações foi executada, a instância de etapa existe na base de dados e o seu estado é bem-sucedido.

As operações submetidas a validação só são validadas se o workflow terminar com êxito.
