Histórico da Página
...
| Índice | ||||
|---|---|---|---|---|
|
Falando de componente Atividade de serviço...
...
O componente Atividade de serviço representa um ponto do processo onde será feita uma consulta aos dados de um serviço externo repassando esses dados para o processo.
...
| Painel | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
Desta forma, quando a última etapa de aprovação for concluída, a solicitação seguirá para uma atividade de serviço que, utilizando as APIs da plataforma, criará a pasta no recurso Documentos com base nas informações fornecidas e nas permissões de acesso definidas no formulário, garantindo que a pasta será única para cada contrato. Um exemplo de código que poderia ser utilizado como script na atividade de serviço é:
|
Execução automatizada
...
A execução automatizada determina que a execução do script será feita de forma assíncrona e sem a necessidade de uma interação manual de uma pessoa. Nesse tipo de execução, é possível definir o número de tentativas de execução e uma mensagem de sucesso que será exibida quando a execução for concluída sem inconsistências.
...
O fluxo de contingência é criado anexando um evento intermediário de captura de erro à atividade de serviço (o evento deve ser colocado em cima da atividade). Esse fluxo de saída será utilizando quando todas as tentativas de integração falharem.
Execução imediata
...
A execução imediata determina que a execução do script será feita de forma síncrona, logo depois do evento afterStateEntry do processo em questão, ou seja, será executado no momento em que a solicitação chegar na atividade de serviço.
...
| Informações | ||
|---|---|---|
| ||
Atualmente, o tipo de execução imediata não é muito recomendado por ter seu desempenho reduzidos. |
Headers
| Âncora | ||||
|---|---|---|---|---|
|
...
No contexto do componente Atividade de serviço, os headers (cabeçalhos) representam informações adicionais ou metadados que são enviados junto com a requisição de um serviço. Eles são usados para fornecer contexto ou parâmetros extras que o serviço ou a operação que está sendo chamada pode precisar para processar a requisição.
...
Autenticação e autorização: pode ser um token de autenticação, uma chave de API ou credenciais de um usuário.
Painel borderColor #ebecf0 Estado subtle true title Exemplo Chave:
AuthorizationValor:
Bearer token_de_acessoInformações de rastreio: dados sobre a requisição que podem ser usados para monitoramento ou rastreamento da chamada do serviço.
Painel borderColor #ebecf0 Estado subtle true title Exemplo Chave:
X-Request-IDValor:
12345Informações de contexto: dados que definem o contexto da requisição, tais como o idioma, a localidade ou a versão da API.
Painel borderColor #ebecf0 Estado subtle true title Exemplo Chave:
Accept-LanguageValor:
pt-BRFormato dos dados: definição sobre como os dados devem ser interpretados ou enviados, como o tipo de conteúdo (Content-Type) ou a versão da API.
Painel borderColor #ebecf0 Estado subtle true title Exemplo Chave:
Content-TypeValor:
application/json
Parâmetros
| Âncora | ||||
|---|---|---|---|---|
|
...
No contexto do componente Atividade de serviço, os parâmetros são valores ou variáveis que o método/operação precisa receber para funcionar corretamente. Cada método/operação de um serviço geralmente tem uma lista de parâmetros que precisam ser fornecidos para que a execução da ação seja bem sucedida. Sendo assim, o objetivo de configurar esses parâmetros é fornecer as informações necessárias para que o método/operação seja executado.
...
Por isso, a configuração dos parâmetros do método/operação é essencial para a correta execução da ação e comunicação entre os sistemas envolvidos.
Retorno
| Âncora | ||||
|---|---|---|---|---|
|
...
No contexto do componente Atividade de serviço, o retorno são os dados que a operação retorna depois de ser executada. Ao chamar um método/operação dentro de uma atividade de serviço, em muitos casos, a operação não só executa uma ação, mas também retorna um ou mais valores que podem ser usados em outras partes do processo. Esse retorno pode ser uma resposta simples – como um código de status ou uma mensagem – ou dados mais complexos – como um objeto JSON, uma lista ou um valor calculado.
Quando o método/operação é chamado, ele processa os dados de entrada, que são os parâmetros. Durante sua execução, o método/operação pode realizar cálculos, consultas a um banco de dados ou algum outro processamento de dados. Depois de processar os parâmetros e realizar suas funções internas, o serviço gera um retorno. Esse retorno pode ser algo simples – como um código de sucesso – ou pode ser um conjunto de dados mais complexo – como o resultado de uma busca ou a confirmação de que uma ação foi realizada.
...
Dessa forma, o retorno de uma operação é essencial para capturar os resultados de um serviço e usá-los de maneira eficaz dentro do fluxo do processo. Ele pode ser utilizado para tomar decisões, realizar ações subsequentes ou simplesmente para fornecer informações úteis para a continuação do processo.
Configurar componente Atividade de serviço – Rest
...
01. No diagrama do processo, clique no componente Atividade de serviço que deseja configurar com um serviço do tipo Rest.
...
| Painel | ||||
|---|---|---|---|---|
| ||||
Os headers ou cabeçalhos são informações adicionais ou metadados que são enviados juntos com a requisição do serviço para que a integração funcione corretamente. Mais detalhes e exemplos podem ser obtidos em Headers. |
06. Informe os dados necessários para cada header.
| Painel | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||
Chave Valor
Veja mais exemplos em Headers. |
07. Clique na aba Parâmetros para configurar os parâmetros do método/operação do serviço.
| Painel | ||||
|---|---|---|---|---|
| ||||
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. |
08. Na coluna Origem do valor de cada parâmetro, selecione de onde será obtido o valor que será passado para esse parâmetro do método/operação.
...
| Painel | ||||
|---|---|---|---|---|
| ||||
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. |
22. Na coluna Atribuição de cada retorno, selecione para onde o dado retornado pelo método/operação deve ser enviado ou armazenado para ser usado no processo.
...
28. Na mensagem exibida, clique em Ok, entendi.
** Configurar integração
...
01. No diagrama do processo, clique no componente Atividade de serviço para o qual deseja configurar a execução automatizada.
...
09. Na mensagem exibida, clique em Ok, entendi.
** Editar integração
...
01. No diagrama do processo, clique no componente Exclusivo do qual deseja editar uma condição simples.
...
10. Na mensagem exibida, clique em Ok, entendi.
Dúvidas frequentes
...
Confira aqui algumas dúvidas frequentes sobre o componente Atividade de serviço.
...
| Section | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...
