Indice:

Introdução:

O Web Service Fórmula Visual 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.

Como Funciona:

Estão expostos no wsFormulaVisual alguns serviços, onde para consumi-los, é necessário enviar através de uma requisição um envelope SOAP passando os parâmetros de cada serviço.

O serviço é exposto pelo host conforme documentação abaixo:

Como Expor os Web Services do RM através do Host

Segue abaixo o detalhamento e exemplos de utilização dos serviços em envelope SOAP:

FVWebService »

RM_IRMSServer »

CheckServiceActivity

Modelo XML

CheckServiceActivity (Requisição e Resposta)

Descrição: Serviço que permite verificar o status da Atividade.

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tot="http://www.totvs.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <tot:CheckServiceActivity/>
   </soapenv:Body>
</soapenv:Envelope>

Response

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tot="http://www.totvs.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <tot:CheckServiceActivity/>
   </soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tot="http://www.totvs.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <tot:CheckServiceActivity/>
   </soapenv:Body>
</soapenv:Envelope>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <GetReportListResponse xmlns="http://www.totvs.com/"> <GetReportListResult>0,TOTVS Educacional,306,Boletim,Boletim,06/10/2010 15:43:00,597e2978-351d-4629-a2fb-b57432cad210;,0,TOTVS Educacional,30,Contrato,Contrato,06/10/2010 15:43:00,71eff25f-0960-4ab7-bbc9-564044dde0fe;,0,TOTVS Gestão Financeira,312,Boleto Itaú.2.1,Cópia de Cópia de Boleto Itaú,08/04/2016 07:49:00,c9c51350-3cfa-410e-b818-224a013d0296;,0,TOTVS Inteligência de Negócios,316,filtrosNomeados,filtrosNomeados,11/04/2016 10:37:12,d19713e7-eda0-4bf1-8e92-140714240c16;,0,TOTVS Educacional,31,EDUREL002,Listagem de Alunos com foto,06/10/2010 15:43:00,b84b941c-54e5-43c1-996b-3e9eae05e902....... </GetReportListResult> </GetReportListResponse> </s:Body> </s:Envelope>

Parâmetros

Esse método não possui parâmetros

FVWebService »

RM_IRMSServer »

Implements

Modelo XML

Implements (Requisição e Resposta)

Descrição: Serviço que permite implementar uma propriedade tipada.

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tot="http://www.totvs.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <tot:Implements>
         <!--Optional:-->
         <tot:type/>
      </tot:Implements>
   </soapenv:Body>
</soapenv:Envelope>

Response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <GetReportListResponse xmlns="http://www.totvs.com/"> <GetReportListResult>0,TOTVS Educacional,306,Boletim,Boletim,06/10/2010 15:43:00,597e2978-351d-4629-a2fb-b57432cad210;,0,TOTVS Educacional,30,Contrato,Contrato,06/10/2010 15:43:00,71eff25f-0960-4ab7-bbc9-564044dde0fe;,0,TOTVS Gestão Financeira,312,Boleto Itaú.2.1,Cópia de Cópia de Boleto Itaú,08/04/2016 07:49:00,c9c51350-3cfa-410e-b818-224a013d0296;,0,TOTVS Inteligência de Negócios,316,filtrosNomeados,filtrosNomeados,11/04/2016 10:37:12,d19713e7-eda0-4bf1-8e92-140714240c16;,0,TOTVS Educacional,31,EDUREL002,Listagem de Alunos com foto,06/10/2010 15:43:00,b84b941c-54e5-43c1-996b-3e9eae05e902....... </GetReportListResult> </GetReportListResponse> </s:Body> </s:Envelope>

Parâmetros

Type (Opcional)

Descrição: Tipo

FVWebService »

RM_IwsBase »

AutenticaAcesso

Modelo XML

AutenticaAcesso (Requisição e Resposta)

Descrição: Serviço que permite autenticar o acesso ao servidor, cujo resposta SOAP será enviada.

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tot="http://www.totvs.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <tot:AutenticaAcesso/>
   </soapenv:Body>
</soapenv:Envelope>

Response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <GetReportListResponse xmlns="http://www.totvs.com/"> <GetReportListResult>0,TOTVS Educacional,306,Boletim,Boletim,06/10/2010 15:43:00,597e2978-351d-4629-a2fb-b57432cad210;,0,TOTVS Educacional,30,Contrato,Contrato,06/10/2010 15:43:00,71eff25f-0960-4ab7-bbc9-564044dde0fe;,0,TOTVS Gestão Financeira,312,Boleto Itaú.2.1,Cópia de Cópia de Boleto Itaú,08/04/2016 07:49:00,c9c51350-3cfa-410e-b818-224a013d0296;,0,TOTVS Inteligência de Negócios,316,filtrosNomeados,filtrosNomeados,11/04/2016 10:37:12,d19713e7-eda0-4bf1-8e92-140714240c16;,0,TOTVS Educacional,31,EDUREL002,Listagem de Alunos com foto,06/10/2010 15:43:00,b84b941c-54e5-43c1-996b-3e9eae05e902....... </GetReportListResult> </GetReportListResponse> </s:Body> </s:Envelope>

Parâmetros

Esse método não possui parâmetros

FVWebService »

RM_IwsBase »

CheckServiceActivity

Modelo XML

CheckServiceActivity (Requisição e Resposta)

Descrição: Serviço que permite verificar o status da Atividade.

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tot="http://www.totvs.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <tot:CheckServiceActivity/>
   </soapenv:Body>
</soapenv:Envelope>

Response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <GetReportListResponse xmlns="http://www.totvs.com/"> <GetReportListResult>0,TOTVS Educacional,306,Boletim,Boletim,06/10/2010 15:43:00,597e2978-351d-4629-a2fb-b57432cad210;,0,TOTVS Educacional,30,Contrato,Contrato,06/10/2010 15:43:00,71eff25f-0960-4ab7-bbc9-564044dde0fe;,0,TOTVS Gestão Financeira,312,Boleto Itaú.2.1,Cópia de Cópia de Boleto Itaú,08/04/2016 07:49:00,c9c51350-3cfa-410e-b818-224a013d0296;,0,TOTVS Inteligência de Negócios,316,filtrosNomeados,filtrosNomeados,11/04/2016 10:37:12,d19713e7-eda0-4bf1-8e92-140714240c16;,0,TOTVS Educacional,31,EDUREL002,Listagem de Alunos com foto,06/10/2010 15:43:00,b84b941c-54e5-43c1-996b-3e9eae05e902....... </GetReportListResult> </GetReportListResponse> </s:Body> </s:Envelope>

Parâmetros

Esse método não possui parâmetros

FVWebService »

RM_IwsBase »

Implements

Modelo XML

Implements (Requisição e Resposta)

Descrição: Serviço que permite implementar uma propriedade tipada.

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tot="http://www.totvs.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <tot:Implements>
         <!--Optional:-->
         <tot:type/>
      </tot:Implements>
   </soapenv:Body>
</soapenv:Envelope>

Response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <GetReportListResponse xmlns="http://www.totvs.com/"> <GetReportListResult>0,TOTVS Educacional,306,Boletim,Boletim,06/10/2010 15:43:00,597e2978-351d-4629-a2fb-b57432cad210;,0,TOTVS Educacional,30,Contrato,Contrato,06/10/2010 15:43:00,71eff25f-0960-4ab7-bbc9-564044dde0fe;,0,TOTVS Gestão Financeira,312,Boleto Itaú.2.1,Cópia de Cópia de Boleto Itaú,08/04/2016 07:49:00,c9c51350-3cfa-410e-b818-224a013d0296;,0,TOTVS Inteligência de Negócios,316,filtrosNomeados,filtrosNomeados,11/04/2016 10:37:12,d19713e7-eda0-4bf1-8e92-140714240c16;,0,TOTVS Educacional,31,EDUREL002,Listagem de Alunos com foto,06/10/2010 15:43:00,b84b941c-54e5-43c1-996b-3e9eae05e902....... </GetReportListResult> </GetReportListResponse> </s:Body> </s:Envelope>

Parâmetros

Type (Opcional)

Descrição: Tipo

FVWebService »

RM_IwsFormulaVisual »

CheckServiceActivity

Modelo XML

CheckServiceActivity (Requisição e Resposta)

Descrição: Serviço que permite verificar o status da Atividade.

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tot="http://www.totvs.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <tot:CheckServiceActivity/>
   </soapenv:Body>
</soapenv:Envelope>

Response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <GetReportListResponse xmlns="http://www.totvs.com/"> <GetReportListResult>0,TOTVS Educacional,306,Boletim,Boletim,06/10/2010 15:43:00,597e2978-351d-4629-a2fb-b57432cad210;,0,TOTVS Educacional,30,Contrato,Contrato,06/10/2010 15:43:00,71eff25f-0960-4ab7-bbc9-564044dde0fe;,0,TOTVS Gestão Financeira,312,Boleto Itaú.2.1,Cópia de Cópia de Boleto Itaú,08/04/2016 07:49:00,c9c51350-3cfa-410e-b818-224a013d0296;,0,TOTVS Inteligência de Negócios,316,filtrosNomeados,filtrosNomeados,11/04/2016 10:37:12,d19713e7-eda0-4bf1-8e92-140714240c16;,0,TOTVS Educacional,31,EDUREL002,Listagem de Alunos com foto,06/10/2010 15:43:00,b84b941c-54e5-43c1-996b-3e9eae05e902....... </GetReportListResult> </GetReportListResponse> </s:Body> </s:Envelope>

Parâmetros

Esse método não possui parâmetros

FVWebService »

RM_IwsFormulaVisual »

Execute

Fórmula Visual: Configuração de Atividades

Fórmula Visual "teste_formula"

Foi adicionado uma Atividade de Gerar Exceção "rmsThrowActivity".

Configuração da Atividade:

Web Service: Modelo XML

Execute (Requisição e Resposta)

Descrição: Executa uma 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>
         <tot:codColigada>1</tot:codColigada>
         <tot:idFormula>2</tot:idFormula>
         <tot:context>[Parâmetro Opcional --> Adicione aqui o contexto de execução da fórmula visual]</tot:context>
         <tot:dataSetXML>[Parâmetro Opcional --> Adicione o xml do dataSet que será utilizado na execução da fórmula visual]</tot:dataSetXML>
         <tot:parametersXML>[Parâmetro Opcional --> Adicione o xml dos parâmetros utilizados na execução da fórmula visual]</tot:parametersXML>
         <tot:ownerData>[Parâmetro Opcional --> Adicione um valor específico que será utilizado na execução da fórmula visual]</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>Mensagem de Erro Customizada: Fórmula executada com sucesso!
Fórmula Visual: 'teste_formula'.</ErrorMessage>
            <ErrorType>RM.Lib.Workflow.RMSWorkflowException</ErrorType>
         </ExecuteResult>
      </ExecuteResponse>
   </s:Body>
</s:Envelope>

Web Service: Parâmetros

CodColigada (Obrigatório)

Descrição: Código da Coligada em que a Fórmula Visual foi criada.
Tipo: Inteiro
Como Usar: Esse parâmetro é do tipo Inteiro, ou seja, deve-se utilizar um valor numérico que represente uma coligada cadastrada na base do RM, em conjunto com o IdFormula, retornam um XML contendo todas as informações dos parâmetros presentes na Fórmula Visual demandada.
Valor Utilizado na Requisição: 1

IdFormula (Obrigatório)

Descrição: Código Identificador da Fórmula Visual.
Tipo: Inteiro
Como Usar: Esse parâmetro é do tipo Inteiro, ou seja, deve-se utilizar um valor numérico que represente o número identificador de uma Fórmula Visual, em conjunto com o parâmetro CodColigada retornam um XML contendo todas as informações dos parâmetros presentes na Fórmula Visual demandada.
Valor Utilizado na Requisição: 2

Context (Opcional)

Descrição: Contexto do RM.
Tipo: Cadeia de Caracteres (String)
Como Usar: Esse parâmetro é do tipo Cadeia de Caracteres, ou seja, deve-se utilizar um valor alfanumérico que represente o contexto do RM em que a Fórmula Visual será executada.
Valor Utilizado na Requisição: N/A
Exemplo de Utilização: CODSISTEMA=G,CODUSUARIO=mestre,CODCOLIGADA=1

DataSetXML (Opcional)

Descrição: Fonte de Dados em formato XML.
Tipo: Cadeia de Caracteres (String)
Como Usar: Esse parâmetro é do tipo Cadeia de Caracteres, ou seja, deve-se utilizar um valor alfanumérico (XML) que represente a fonte de dados (DataSet) cuja Fórmula Visual irá utilizar, seja como fonte principal de dados, seja como fonte de pesquisa, seja como fonte alternativa de dados.
Valor Utilizado na Requisição: N/A
Alerta de valores a ser utilizados: Os valores utilizados devem ser válidos como o exemplo abaixo, ou o campo em branco. Exemplo de Utilização:

Exemplo de XML de Fonte de Dados

<![CDATA[<NewDataSet>
  <GUSUARIO>
    <CODUSUARIO>mestre</CODUSUARIO>
    <NOME>Usuário Mestre</NOME>
    <CODACESSO>Acesso02</CODACESSO>
    <STATUS>1</STATUS>
    <DATAINICIO>1997-01-01T00:00:00</DATAINICIO>
    <DATAULTIMOACESSO>2015-07-03T14:48:08.447</DATAULTIMOACESSO>
    <EMAIL>[email protected]</EMAIL>
  </GUSUARIO>
</NewDataSet>]]>

ParametersXML (Opcional)

Descrição: Parâmetros da Fórmula Visual em formato XML.
Tipo: Cadeia de Caracteres (String)
Como Usar: Esse parâmetro é do tipo Cadeia de Caracteres, ou seja, deve-se utilizar um valor alfanumérico (XML) que represente os parâmetros que a Fórmula Visual irá utilizar.
Valor Utilizado na Requisição: N/A
Alerta de valores a ser utilizados: Os valores utilizados devem ser válidos como o exemplo abaixo, ou o campo em branco. Exemplo de Utilização:

Exemplo de XML de Fonte de Dados

<![CDATA[<Parameters>
  <GCOLIGADA>
    <CODCOLIGADA>1</CODCOLIGADA>
    </GCOLIGADA>
  <PFUNC>
    <CHAPA>00041</CHAPA>
    <NOME>AIRTON SENA JUNIOR</NOME>
  </PFUNC>	  			
</Parameters>]]>

OwnerData (Opcional)

Descrição: Dados do Usuário.
Tipo: Cadeia de Caracteres (String) Como Usar: Esse parâmetro é do tipo Cadeia de Caracteres, ou seja, deve-se utilizar um valor alfanumérico que represente dados adicionais diversos a serem utilizados na Fórmula Visual.
Valor Utilizado na Requisição: N/A
Exemplo de Utilização: (Qualquer valor, depende de várias vaiáveis, como: DataServer, Serviço de um WebService, etc...)

FVWebService »

RM_IwsFormulaVisual »

GetParams

Fórmula Visual: Configuração de Atividades

Fórmula Visual "teste_formula"

No grid principal da Fórmula Visual, existe um parâmetro "Definição dos Parâmetros de Execução", clique em [...], para definir os parâmetros que serão utilizados na Fórmula Visual .

Definindo os parâmetros da Fórmula Visual:

Definindo se deve ou não mostrar o esquema:

Definindo se a estrutura das colunas com valores padrão será apresentada:

Modelo XML

GetParams (Requisição e Resposta)

Descrição: Recupera os Parâmetros de uma 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>1</tot:codColigada>
         <!--Optional:-->
         <tot:idFormula>2</tot:idFormula>
      </tot:GetParameters>
   </soapenv:Body>
</soapenv:Envelope>

Parâmetro "Incluir Novo Registro na Tabela de Parâmetros" marcado.

Response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <GetParametersResponse xmlns="http://www.totvs.com/">
         <GetParametersResult>
	         	<Parameters>
                     <GCOLIGADA>
                           <CODCOLIGADA>0</CODCOLIGADA>
                     </GCOLIGADA>
                     <PFUNC>
                           <CHAPA>String</CHAPA>
                           <NOME>String</NOME>
                     </PFUNC>	  			
			</Parameters>
		</GetParametersResult>
      </GetParametersResponse>
   </s:Body>
</s:Envelope>

Parâmetros

CodColigada (Obrigatório)

Descrição: Código da Coligada em que a Fórmula Visual foi criada.
Tipo: Inteiro
Como Usar: Esse parâmetro é do tipo Inteiro, ou seja, deve-se utilizar um valor numérico que represente uma coligada cadastrada na base do RM, em conjunto com o IdFormula, retornam um XML contendo todas as informações dos parâmetros presentes na Fórmula Visual demandada.
Valor Utilizado na Requisição: 1

IdFormula (Obrigatório)

Descrição: Código Identificador da Fórmula Visual.
Tipo: Inteiro
Como Usar: Esse parâmetro é do tipo Inteiro, ou seja, deve-se utilizar um valor numérico que represente o número identificador de uma Fórmula Visual, em conjunto com o parâmetro CodColigada retornam um XML contendo todas as informações dos parâmetros presentes na Fórmula Visual demandada.
Valor Utilizado na Requisição: 2

Utilização do Método Get Parameters

Ao utilizar método "Get Parameters" é gerado uma estrutura (esqueleto) para que o usuário utilize-o através do método "Execute", adicionando assim os parâmetros da sua execução."

Utilização de Web Services

Para utilização dos Web Services através do aplicativo "Totvs Web Service Client", clique aqui.

Produto: Framework

Versão: 12.1.x

Processo: Web Services Fórmula Visual

Status: Finalizado

Data: //27/10/2017

Autores:

Carlos Philippe de Farias Marques

Atalhos

Páginas filhas

Indice:

Introdução:

Como Funciona:

Atalhos

Páginas filhas

TBC - Web Services Fórmula Visual (Workflow)

Indice:

Introdução:

Como Funciona: