Tempo aproximado para leitura: 00:02:40 min
Dúvida
Como utilizar o Web Service wsFormulaVisual?
Ambiente
Cross Segmentos - Backoffice RM - Integração - Todas as versões.
Solução
O Web Service wsFormulaVisual, fornece serviços para executar uma Fórmula Visual de forma síncrona e assíncrona. O modelo de autenticação utilizado é o Basic Authentication.
Estão expostos no wsFormulaVisual alguns serviços, onde para consumi-los, é necessário enviar por meio de uma requisição um envelope SOAP, passando os parâmetros de cada serviço.
Serviços do WsFormulaVisual desta documentação:
1. Método - Execute
2. Método - GetParameters
1. Método - Execute:
Serviço responsável por executar a Fórmula Visual.
Para os testes criamos uma Fórmula Visual simples com a atividade de "Gerar Exceção", ao qual irá gerar a mensagem para os testes:
Serviço Execute:
Parâmetros:
codColigada - Obrigatório - Código da Coligada em que a Fórmula Visual foi criada.
idFormula - Obrigatório - Código Identificador da Fórmula Visual.
context - Contexto do RM
dataSetXML - Fonte de Dados em formato XML.
parametersXML - Parâmetros da Fórmula Visual em formato XML.
ownerData - Dados do Usuário.
Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tot="http://www.totvs.com/">
<soapenv:Header/>
<soapenv:Body>
<tot:Execute>
<!--Optional:-->
<tot:codColigada>0</tot:codColigada>
<!--Optional:-->
<tot:idFormula>229</tot:idFormula>
<!--Optional:-->
<tot:context></tot:context>
<!--Optional:-->
<tot:dataSetXML></tot:dataSetXML>
<!--Optional:-->
<tot:parametersXML></tot:parametersXML>
<!--Optional:-->
<tot:ownerData></tot:ownerData>
</tot:Execute>
</soapenv:Body>
</soapenv:Envelope>
Response:
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<ExecuteResponse xmlns="http://www.totvs.com/">
<ExecuteResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<DataSetXML i:nil="true"/>
<ErrorMessage>Teste WsFormulaVisual!
Fórmula Visual: 'WsFormulaVisual - Exceção'.</ErrorMessage>
<ErrorType>RM.Lib.Workflow.RMSWorkflowException</ErrorType>
</ExecuteResult>
</ExecuteResponse>
</s:Body>
</s:Envelope>
Requisição sendo realizada corretamente, executando a Fórmula e retornando a mensagem de erro configurada:
2. Método - GetParameters:
Serviço responsável por recuperar os Parâmetros de uma Fórmula Visual.
Para os testes criamos uma Fórmula Visual simples com a atividade de "Gerar Exceção", ao qual irá gerar a mensagem para os testes, recebendo os dados desta mensagem como um Parâmetro:
No fluxo de trabalho da Fórmula Visual, crie a coleção de definição de parâmetros:
Definindo as propriedades de mostrar o esquema e de incluir novo registro na tabela de parâmetros como "True":
Adicione a atividade de Gerar Exceção e para a mensagem busque o testo do Parâmetro:
Salve a Fórmula Visual.
Serviço Execute:
Parâmetros:
codColigada - Obrigatório - Código da Coligada em que a Fórmula Visual foi criada.
idFormula - Obrigatório - Código Identificador da Fórmula Visual.
Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tot="http://www.totvs.com/">
<soapenv:Header/>
<soapenv:Body>
<tot:GetParameters>
<!--Optional:-->
<tot:codColigada>0</tot:codColigada>
<!--Optional:-->
<tot:idFormula>99</tot:idFormula>
</tot:GetParameters>
</soapenv:Body>
</soapenv:Envelope>
Response:
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<GetParametersResponse xmlns="http://www.totvs.com/">
<GetParametersResult>
<Parameters>
<PARAMETRO>
<MENSAGEM>TESTE wsFormulaVisual Exceção</MENSAGEM>
</PARAMETRO>
</Parameters>
</GetParametersResult>
</GetParametersResponse>
</s:Body>
</s:Envelope>
Requisição sendo realizada corretamente, retornando o Response dos parâmetros da Fórmula:
Copie todo o retorno do <Parameters> para ser utilizado como <![CDATA[]]> dos parâmetros de sua fórmula visual.
Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tot="http://www.totvs.com/">
<soapenv:Header/>
<soapenv:Body>
<tot:Execute>
<!--Optional:-->
<tot:codColigada>0</tot:codColigada>
<!--Optional:-->
<tot:idFormula>99</tot:idFormula>
<!--Optional:-->
<tot:context></tot:context>
<!--Optional:-->
<tot:dataSetXML></tot:dataSetXML>
<!--Optional:-->
<tot:parametersXML><![CDATA[<Parameters>
<PARAMETRO>
<MENSAGEM>TESTE wsFormulaVisual Exceção</MENSAGEM>
</PARAMETRO>
</Parameters>]]></tot:parametersXML>
<!--Optional:-->
<tot:ownerData></tot:ownerData>
</tot:Execute>
</soapenv:Body>
</soapenv:Envelope>
Como exemplo segue abaixo realizando o método Execute, com estes parâmetros:
Saiba Mais:
Para mais informações sobre o WsFormulaVisual, segue documentação abaixo:
TBC - Web Services Fórmula Visual (Workflow)
0 Comentários