...
02. Na aba Geral, defina as informações gerais para o componente que representa uma consulta de dados a execução de um serviço externo.
| Painel |
|---|
| borderColor | #f2f2f2 |
|---|
| bgColor | #f2f2f2 |
|---|
|
Título
Nome da etapa que representa uma consulta de dados a execução de um serviço externo. O O nome também pode ser alterado diretamente no componente, clicando sobre seu nome atual e depois em 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, 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 fazer a consulta de dados externosexecutar 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 o script 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 script de consulta ao serviço. |
03. Clique em Configurar integração.
04. Na aba Geral, defina as informações solicitadas para configurar a integração com o 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 com o serviço selecionado. 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 selecionado. 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. |
...
| Painel |
|---|
| borderColor | #f2f2f2 |
|---|
| bgColor | #f2f2f2 |
|---|
|
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. Insira Informe os dados necessários para cada header.
...
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. |
...