...
Aviso |
---|
icon | false |
---|
title | Importante: |
---|
|
Marcando a opção "Executa em API(Poco)", somente será permitido executar Fórmulas Visuais em API's construídas no padrão "POCO". API's construídas no padrão "DataServerData Server" não aparecerão para serem usadas nesse modelo. Portanto, Api's no padrão "DataServerData Server" continuam podendo ser usadas no modelo antigo (DataSet). |
04. COMO CADASTRAR UMA FÓRMULA VISUAL PARA EXECUTAR EM UMA API
A Fórmula Visual deve estar cadastrada com a opção "Executa em API (POCO)" habilitada, conforme exibido na imagem abaixo.
![](/download/attachments/547851509/image2020-5-11_12-16-30.png?version=2&modificationDate=1648495605757&api=v2)
Ao marcar a opção opção "Executa em API (POCO)", automaticamente o campo "Visível para todas as coligadas" será habilitado e não é possível desmarcá-lo.
...
Veja no exemplo abaixo, uma Fórmula Visual onde foi selecionado o contexto da API de usuários (Controller de usuários) para que seja gerada uma exceção com o valor do campo userName.
- Primeiro: Selecionar o contexto para a Fórmula Visual:
Image Removed
Image Added
- Segundo: Adicionar a atividade de Gerar exceção, clicar em Ligações, na propriedade
...
...
- ", clicar em reticências.
Será exibido o Editor de Ligações, ao expandir a propriedade '"Fields'", serão listados todos os campos da API que podem ser usados no contexto. Basta selecionar um campo/valor desejado. No exemplo abaixo será a propriedade userName.
Obs.: As propriedades das APIs serão sempre listadas abaixo da hierarquia de _Items.
Image Removed
Image Added
- Terceiro: Adicionar um gatilho para essa Fórmula Visual.
Importante: Os valores de contexto estarão disponíveis no sistema depois que a requisição da API for feita. Então, para usar o contexto com valores, é necessário utilizar gatilhos de Depois dos métodos.
Isso porque se forem usados gatilhos de antes, o sistema ainda não terá executado o endpoint e não terá os valores das propriedades.
- Quarto: Adicionar um gatilho para a Fórmula Visual. Neste exemplo, adicionamos o gatilho
...
- "Depois de recuperar (Get)
...
No Postman, aplicativo que usamos para realizar testes de APIs, chamamos o endpoint de usuários, buscando o usuário mestre.
Image Removed
Image Added
Veja que o retorno foi uma exceção, contendo na mensagem o valor do campo userName (do contexto) e o nome da Fórmula Visual.
...
Informações |
---|
|
Deck of Cards |
---|
| Card |
---|
| Ao cadastrar uma Fórmula Visual com a opção Executa em API (POCO) habilitada (como mostrado anteriormente) é necessário adicionar os objetos que serão utilizados ao gatilho. Para nosso exemplo, vamos utilizar a API de Usuários (Controller de Usuários) nos gatilhos "Depois de recuperar todos (get)" e "Depois de recuperar (get)". Image Removed Image Added
|
Card |
---|
| Em seguida na estrutura da fórmula, vamos adicionar as atividades "Para Cada Iteração (API)" e "Expression" no Fluxo de Trabalho Sequencial da fórmula, como mostra imagem abaixo: Aviso |
---|
É necessário que seja preenchido o contexto da fórmula para capturar ou manipular os valores das propriedades da API utilizada. |
Image Removed Image Added
|
Card |
---|
| - Configurando a Atividade de Foreach
Nas propriedades da atividade, clique em Ligações ( ) e selecione o lookup do campo "Lista de Items". Na tela "Editor de Ligações", selecione a seguinte ligação: "RMSWorkflow | [] Fields | _Items". Essa configuração é necessária, por que temos que selecionar o objeto ao qual queremos percorrer, no nosso exemplo, selecionamos o "_items", por que queremos percorrer todos os resultados da API. Image Removed Image Added
|
Card |
---|
| - Configurando a Atividade de Expression
Nas propriedades da atividade, selecione o lookup do campo "Expressões" e adicione a seguinte expressão: "'Teste FV: ' + rmsForEachApiActivity1._Items.Name.FamilyName". Essa expressão irá concatenar a string "Teste FV:" com o campo "familyName" depois de executar um "GetAll" ou "GetOne" na API. Image Removed Image Added
Em seguida, é necessário configurar o valor calculado, pois é ele quem vai receber a expressão criada acima. Para realizar a configuração, clique em Ligações ( ) e selecione o lookup do campo "Valor Calculado". Na tela "Editor de Ligações", selecione a seguinte ligação: "rmsForEachApiActivity1 | [] Fields | _Items | Name | Formatted | AsString". Image Removed Image Added
|
Card |
---|
| Após realizar todas as configurações necessárias na formula, acesse a API de Usuários (utilizada no exemplo) e execute um "GetAll" ou "GetOne". Verifique que ao executar o "GetAll", o campo "familyName" está sendo concatenado corretamente com a string "Teste FV" (condição criada na expressão da formula). Image Removed
Image AddedNa execução do "GetOne", foi passado como parâmetro o usuário "mestre", verifique que regra também é aplicada corretamente.
Image Removed Image Added
|
|
|
...