...
| Painel |
|---|
| borderColor | #f2f2f2 |
|---|
| bgColor | #f2f2f2 |
|---|
|
Título
Nome da etapa que representa a execução de um serviço externo. O nome também pode ser alterado diretamente no componente, clicando sobre seu nome atual e depois em Editar – localizado no lado direito. | Painel |
|---|
| | Estado |
|---|
| |
|---|
| subtle | true |
|---|
| title | Exemplo de uso |
|---|
|
Em um processo de Aprovação de contrato, o componente poderia receber o nome Criar pasta e armazenar contrato, visto que ele servirá para criar uma pasta específica para armazenar esse contrato no recurso Documentos.
|
Selecione o serviço
Serviço externo que será utilizado para executar alguma ação. É possível selecionar serviços do tipo Rest que já existem no recurso Serviços do Painel de controle. Tipo de execução
Forma como a requisição do serviço externo será executada. As opções disponíveis são: - Automatizado: a requisição é executada de forma assíncrona. Deve ser utilizado quando a execução não necessita de um retorno imediato sobre a operação ter sido ou não executada com êxito;
- Imediato: a requisição é executada de forma síncrona. Deve ser utilizado quando a execução necessita de um retorno imediato sobre a operação para que o processo possa seguir adiante.
Tentativas
Número de vezes que o componente deve tentar executar a operação do serviço antes que seja encaminhado para o evento intermediário de captura de erro. Esse campo somente é exibido ao selecionar o tipo de execução Automatizado. A cada
Intervalo que o componente deve considerar entre uma tentativa e outra de execução. Esse campo somente é exibido ao selecionar o tipo de execução Automatizado. Frequência
Unidade de tempo que o componente deve considerar para fazer os intervalos e as tentativas de execução. Esse campo somente é exibido ao selecionar o tipo de execução Automatizado. As opções disponíveis são: | Painel |
|---|
| | Estado |
|---|
| |
|---|
| subtle | true |
|---|
| title | Exemplo de configuração de tentativas |
|---|
|
→ O componente deve tentar executar o script por 10 vezes, tentando 1 vez a cada hora. Sendo assim, a configuração deve ser feita como:
| Tentativas | A cada | Frequência |
|---|
| 10 | 1 | Hora |
|
Mensagem
Mensagem que será exibida na conclusão da execução da operação do serviço. |
...
04. Na aba Geral, defina as informações solicitadas para configurar a execução do serviço.
| Painel |
|---|
| borderColor | #f2f2f2 |
|---|
| bgColor | #f2f2f2 |
|---|
|
Selecione a ação (operação)
Método do serviço correspondente à ação que será feita a partir da integração. Defina o tempo de resposta
Tempo que a requisição pode aguardar para obter resposta sobre a execução da operação do serviço. Ativar conexão segura (SSL)
Quando ativada, determina que a comunicação com o serviço será segura e evitará que terceiros acessem os dados trocados durante a integração. |
...
07. Clique na aba Parâmetros para configurar os parâmetros do método/operação do serviço.
| Painel |
|---|
| borderColor | #f2f2f2 |
|---|
| bgColor | #f2f2f2 |
|---|
|
Os parâmetros exibidos são os que pertencem ao método/operação que foi selecionado em Selecione a ação (operação) na aba Geral. Esses parâmetros são os dados que o método/operação precisa receber para ser executado. Mais detalhes e exemplos podem ser obtidos em Parâmetros. |
...
21. Clique na aba Retorno para configurar o destino dos dados retornados pelo método/operação.
| Painel |
|---|
| borderColor | #f2f2f2 |
|---|
| bgColor | #f2f2f2 |
|---|
|
Os dados de retorno exibidos são os que pertencem ao método/operação que foi selecionado em Selecione a ação (operação) na aba Geral. Eles são os dados que a operação retorna depois de ser executada. Mais detalhes e exemplos podem ser obtidos em Retorno. |
...
28. Na mensagem exibida, clique em Ok, entendi.
...
01. No diagrama do processo, clique no componente Atividade de serviço 
para o qual deseja configurar a execução automatizadaintegração depois de selecionar o serviço desejado.
02. Clique em 
Image Removed Adicionar condição Clique em Configurar integração.
03. Em Nome da condição, insira um nome para identificar a condição simples depois de criada.
04. Selecione o tipo Condição simples.
05. Xxxxxxx Defina as configurações desejadas para a integração nas abas Geral, Parâmetros e Retorno.
| Painel |
|---|
| borderColor | #f2f2f2 |
|---|
| bgColor | #f2f2f2 |
|---|
|
06. Clique em Salvar.
Obtenha informações detalhadas sobre as opções disponíveis de configuração para cada aba em Geral, Parâmetros e Retorno. |
04. Depois de definir todas as configurações desejadas em cada aba, clique em Salvar.
05. Clique em Salvar rascunho – localizado no lado direito da barra superior – para salvar as alterações feitas no componente Atividade de serviço.
06. Na mensagem exibida, clique em Ok, entendi.
Editar integração
...
01. No diagrama do processo, clique no componente Atividade de serviço Image Added para o qual deseja editar as configurações da integração.
02. Clique em Editar 
Image Added – localizado no quadro da integração configurada.
03. Edite as configurações desejadas para a integração nas abas Geral, Parâmetros e Retorno.
| Painel |
|---|
| borderColor | #f2f2f2 |
|---|
| bgColor | #f2f2f2 |
|---|
|
07. Ao concluir a inclusão de todas as condições simples desejadas, clique em Fechar
Image Removed– localizado no canto superior direito.
|
Obtenha informações detalhadas sobre as opções disponíveis de configuração para cada aba em Geral, Parâmetros e Retorno. |
04. Depois de editar todas as configurações desejadas em cada aba, clique em Salvar.
0508. Clique em Salvar rascunho – localizado no lado direito da barra superior – para salvar as alterações feitas no componente Atividade de serviço.
0906. Na mensagem exibida, clique em Ok, entendi.
...
Excluir integração
...
01. No diagrama do processo, clique no componente Exclusivo Atividade de serviço do do qual deseja editar uma condição simplesexcluir a integração configurada.
02. Em Condições criadas, localize a condição que deseja editar e clique em Ações
Image Removed Clique em Excluir 
Image Added – localizado no seu lado direitoquadro da integração configurada.
03. Clique em Editar Na mensagem exibida, clique em Excluir para confirmar a exclusão da integração.
04. Xxxxxxxxxx.09. Clique em Salvar rascunho – localizado no lado direito da barra superior – para salvar as alterações feitas no componente Atividade de serviço.
1005. Na mensagem exibida, clique em Ok, entendi.
Dúvidas frequentes
...
Confira aqui algumas dúvidas frequentes sobre o componente Atividade de serviço.
...
| Section |
|---|
| Painel |
|---|
| Quando se deve usar uma atividade de serviço?| Cloak |
|---|
|
A atividade de serviço é indicada quando o processo depende de dados externos oriundos de uma ação automatizada que pode ser executada sem a necessidade de interação direta de uma pessoa, tais como uma consulta a um banco de dados, uma chamada a uma API externa ou um cálculo automatizado. |
|
| Painel |
|---|
| Qual é a diferença da atividade de serviço e o evento de mensagem?| Cloak |
|---|
|
A principal diferença entre esses dois componentes é o papel de cada um. Enquanto a atividade de serviço executa uma ação específica – como uma consulta a um sistema externos – o evento de mensagem envia ou recebe uma mensagem durante o andamento do processo, o que pode desencadear uma ação em outro processo ou sistema. Sendo assim, pode-se dizer que o evento de mensagem é mais voltado para a comunicação entre processos ou sistemas e a atividade de serviço tem como objetivo automatizar uma ação dentro do processo. |
|
| Painel |
|---|
| O que acontece se uma atividade de serviço falhar ou gerar um erro?| Cloak |
|---|
|
Se a atividade de serviço foi configurada com a execução automatizada, é obrigatório que ela contenha um evento intermediário de captura de erro e um fluxo alternativo para onde a solicitação será direcionada em caso de falhas. Desta forma, quando a execução da atividade de serviço falhar, a solicitação será direcionada para o evento de captura de erro e, posteriormente, para o fluxo alternativo que direciona para uma etapa de tratamento da falha. Depois que a falha for solucionada, a solicitação volta para a atividade de serviço de origem e, assim que ela for executada com sucesso, segue o fluxo principal de saída. Se a atividade de serviço foi configurada com a execução imediata, quando o script for executado com sucesso, a solicitação é enviada imediatamente da atividade de serviço para a próxima etapa, dando continuidade ao fluxo de saída padrão. Porém, se ocorrer alguma inconsistência, ela apenas retornará a inconsistência encontrada, mantendo a solicitação parada até que uma pessoa interaja na solicitação para averiguar e corrigir as inconsistências que ocorreram. |
|
|
...