Histórico da Página

Introdução

O Web Service wsProcess é o responsável pela execução de processos do sistema

Como funciona

Estão expostos no wsProcess 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.

Serviços Disponíveis

Expandir

title	ExecuteWithXmlParams

Serviço responsável por executar processos com parâmetros XML.

Deck of Cards

id	1

Os parâmetros solicitado pelo ExecuteWithXmlParams são:

ProcessServerName tipo String

strXmlParams tipo String

Expandir

title	Parâmetro strXmlParams

Para pegar o parâmetro XML é necessário executar o processo através da biblioteca.

Deck of Cards

id	2

Card

label	Passo 1

Acesse a biblioteca e execute o processo que deseja utilizar

Deck of Cards

id	3

Card

label	Selecionar Processo

No exemplo foi utilizado o processo de Cópia de Consultas SQL entre Coligadas

Card

label	Parâmetros da Cópia

Selecionar para qual Coligada deseja copiar a consulta SQL e execute o processo.

Card

label	Processo Executado

Após o processo ter sido executado com sucesso siga para o passo 2

Card

label	Passo 2

Agora é necessário pegar o ID do Job que foi gerado pelo processo

Acesse o menu "Ambiente | Gerenciamento de Jobs"

Após saber qual é o ID do Job siga para o Passo 3

Card

label	Passo 3

Sabendo qual é o ID do Job é necessário utilizar a ferramenta TotvsWSClient.

Informações

title	Informação

Saiba como configurar e utilizar a ferramenta através do link TotvsWSClient

Card

label	Passo 4

Após executar o TotvsWsClient acesse a visão de processos

Deck of Cards

id	8

Card

label	Processos

Card

label	Informar o Job

Informe o Job do processo e clique em carregar

Será exibido o registro equivalente ao ID Job informado

Dê dois cliques no registro e siga para o próximo passo

Card

label	Visualizar Parâmetro XML

Após abrir o registro serão exibidos os dados do registro, Propriedades e o XML

Acesse a Aba XML, clique na opção de "Codificar como CDATA" e copie o XML, pois é ele que será passado como parâmetro do processo

Card

label	Passo 5

Deck of Cards

id	3

Card

label	Request

Bloco de código

language	xml

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tot="http://www.totvs.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <tot:ExecuteWithXmlParams>
         <!--Optional:-->
         <tot:ProcessServerName>GlbProcCopyConsSQL</tot:ProcessServerName>
         <!--Optional:-->
         <tot:strXmlParams>&lt;?xml version=&quot;1.0&quot; encoding=&quot;utf-16&quot;?&gt;
&lt;GlbParamsProcCopyColig xmlns:i=&quot;http://www.w3.org/2001/XMLSchema-instance&quot; z:Id=&quot;i1&quot; xmlns:z=&quot;http://schemas.microsoft.com/2003/10/Serialization/&quot; xmlns=&quot;http://www.totvs.com.br/RM/&quot;&gt;
  &lt;CanParallelize xmlns=&quot;http://www.totvs.com/&quot;&gt;true&lt;/CanParallelize&gt;
  &lt;Context xmlns:d2p1=&quot;http://www.totvs.com.br/RM/&quot; z:Id=&quot;i2&quot; xmlns=&quot;http://www.totvs.com/&quot;&gt;
    &lt;d2p1:_params xmlns:d3p1=&quot;http://schemas.microsoft.com/2003/10/Serialization/Arrays&quot;&gt;
      &lt;d3p1:KeyValueOfanyTypeanyType&gt;
        &lt;d3p1:Key xmlns:d5p1=&quot;http://www.w3.org/2001/XMLSchema&quot; i:type=&quot;d5p1:string&quot;&gt;$CODUNIDADEBIB&lt;/d3p1:Key&gt;
        &lt;d3p1:Value xmlns:d5p1=&quot;http://www.w3.org/2001/XMLSchema&quot; i:type=&quot;d5p1:int&quot;&gt;1&lt;/d3p1:Value&gt;
      &lt;/d3p1:KeyValueOfanyTypeanyType&gt;
      &lt;d3p1:KeyValueOfanyTypeanyType&gt;
        &lt;d3p1:Key xmlns:d5p1=&quot;http://www.w3.org/2001/XMLSchema&quot; i:type=&quot;d5p1:string&quot;&gt;$CHAPAFUNCIONARIO&lt;/d3p1:Key&gt;
        &lt;d3p1:Value xmlns:d5p1=&quot;http://www.w3.org/2001/XMLSchema&quot; i:type=&quot;d5p1:string&quot;&gt;00001&lt;/d3p1:Value&gt;
      &lt;/d3p1:KeyValueOfanyTypeanyType&gt;
      &lt;d3p1:KeyValueOfanyTypeanyType&gt;
        &lt;d3p1:Key xmlns:d5p1=&quot;http://www.w3.org/2001/XMLSchema&quot; i:type=&quot;d5p1:string&quot;&gt;$EXERCICIOFISCAL&lt;/d3p1:Key&gt;
        &lt;d3p1:Value xmlns:d5p1=&quot;http://www.w3.org/2001/XMLSchema&quot; i:type=&quot;d5p1:int&quot;&gt;2&lt;/d3p1:Value&gt;
      &lt;/d3p1:KeyValueOfanyTypeanyType&gt;
      &lt;d3p1:KeyValueOfanyTypeanyType&gt;
        &lt;d3p1:Key xmlns:d5p1=&quot;http://www.w3.org/2001/XMLSchema&quot; i:type=&quot;d5p1:string&quot;&gt;$CODFILIAL&lt;/d3p1:Key&gt;
        &lt;d3p1:Value xmlns:d5p1=&quot;http://www.w3.org/2001/XMLSchema&quot; i:type=&quot;d5p1:int&quot;&gt;1&lt;/d3p1:Value&gt;
      &lt;/d3p1:KeyValueOfanyTypeanyType&gt;
      &lt;d3p1:KeyValueOfanyTypeanyType&gt;
        &lt;d3p1:Key xmlns:d5p1=&quot;http://www.w3.org/2001/XMLSchema&quot; i:type=&quot;d5p1:string&quot;&gt;$RHTIPOUSR&lt;/d3p1:Key&gt;
        &lt;d3p1:Value xmlns:d5p1=&quot;http://www.w3.org/2001/XMLSchema&quot; i:type=&quot;d5p1:string&quot;&gt;01&lt;/d3p1:Value&gt;
      &lt;/d3p1:KeyValueOfanyTypeanyType&gt;
      &lt;d3p1:KeyValueOfanyTypeanyType&gt;
        &lt;d3p1:Key xmlns:d5p1=&quot;http://www.w3.org/2001/XMLSchema&quot; i:type=&quot;d5p1:string&quot;&gt;$CODCOLIGADA&lt;/d3p1:Key&gt;
        &lt;d3p1:Value xmlns:d5p1=&quot;http://www.w3.org/2001/XMLSchema&quot; i:type=&quot;d5p1:int&quot;&gt;1&lt;/d3p1:Value&gt;
      &lt;/d3p1:KeyValueOfanyTypeanyType&gt;
      &lt;d3p1:KeyValueOfanyTypeanyType&gt;
        &lt;d3p1:Key xmlns:d5p1=&quot;http://www.w3.org/2001/XMLSchema&quot; i:type=&quot;d5p1:string&quot;&gt;$EDUTIPOUSR&lt;/d3p1:Key&gt;
        &lt;d3p1:Value xmlns:d5p1=&quot;http://www.w3.org/2001/XMLSchema&quot; i:type=&quot;d5p1:string&quot;&gt;F&lt;/d3p1:Value&gt;
      &lt;/d3p1:KeyValueOfanyTypeanyType&gt;
      &lt;d3p1:KeyValueOfanyTypeanyType&gt;
        &lt;d3p1:Key xmlns:d5p1=&quot;http://www.w3.org/2001/XMLSchema&quot; i:type=&quot;d5p1:string&quot;&gt;$CODLOCPRT&lt;/d3p1:Key&gt;
        &lt;d3p1:Value xmlns:d5p1=&quot;http://www.w3.org/2001/XMLSchema&quot; i:type=&quot;d5p1:int&quot;&gt;5&lt;/d3p1:Value&gt;
      &lt;/d3p1:KeyValueOfanyTypeanyType&gt;
      &lt;d3p1:KeyValueOfanyTypeanyType&gt;
        &lt;d3p1:Key xmlns:d5p1=&quot;http://www.w3.org/2001/XMLSchema&quot; i:type=&quot;d5p1:string&quot;&gt;$CODUSUARIO&lt;/d3p1:Key&gt;
        &lt;d3p1:Value xmlns:d5p1=&quot;http://www.w3.org/2001/XMLSchema&quot; i:type=&quot;d5p1:string&quot;&gt;mestre&lt;/d3p1:Value&gt;
      &lt;/d3p1:KeyValueOfanyTypeanyType&gt;
      &lt;d3p1:KeyValueOfanyTypeanyType&gt;
        &lt;d3p1:Key xmlns:d5p1=&quot;http://www.w3.org/2001/XMLSchema&quot; i:type=&quot;d5p1:string&quot;&gt;$CODUSUARIOSERVICO&lt;/d3p1:Key&gt;
        &lt;d3p1:Value xmlns:d5p1=&quot;http://www.w3.org/2001/XMLSchema&quot; i:type=&quot;d5p1:string&quot;&gt;&lt;/d3p1:Value&gt;
      &lt;/d3p1:KeyValueOfanyTypeanyType&gt;
      &lt;d3p1:KeyValueOfanyTypeanyType&gt;
        &lt;d3p1:Key xmlns:d5p1=&quot;http://www.w3.org/2001/XMLSchema&quot; i:type=&quot;d5p1:string&quot;&gt;$CODSISTEMA&lt;/d3p1:Key&gt;
        &lt;d3p1:Value xmlns:d5p1=&quot;http://www.w3.org/2001/XMLSchema&quot; i:type=&quot;d5p1:string&quot;&gt;G&lt;/d3p1:Value&gt;
      &lt;/d3p1:KeyValueOfanyTypeanyType&gt;
      &lt;d3p1:KeyValueOfanyTypeanyType&gt;
        &lt;d3p1:Key xmlns:d5p1=&quot;http://www.w3.org/2001/XMLSchema&quot; i:type=&quot;d5p1:string&quot;&gt;$CODTIPOCURSO&lt;/d3p1:Key&gt;
        &lt;d3p1:Value xmlns:d5p1=&quot;http://www.w3.org/2001/XMLSchema&quot; i:type=&quot;d5p1:int&quot;&gt;2&lt;/d3p1:Value&gt;
      &lt;/d3p1:KeyValueOfanyTypeanyType&gt;
      &lt;d3p1:KeyValueOfanyTypeanyType&gt;
        &lt;d3p1:Key xmlns:d5p1=&quot;http://www.w3.org/2001/XMLSchema&quot; i:type=&quot;d5p1:string&quot;&gt;$CODIGOEXTERNO&lt;/d3p1:Key&gt;
        &lt;d3p1:Value xmlns:d5p1=&quot;http://www.w3.org/2001/XMLSchema&quot; i:type=&quot;d5p1:string&quot;&gt;-1&lt;/d3p1:Value&gt;
      &lt;/d3p1:KeyValueOfanyTypeanyType&gt;
      &lt;d3p1:KeyValueOfanyTypeanyType&gt;
        &lt;d3p1:Key xmlns:d5p1=&quot;http://www.w3.org/2001/XMLSchema&quot; i:type=&quot;d5p1:string&quot;&gt;$IDPRJ&lt;/d3p1:Key&gt;
        &lt;d3p1:Value xmlns:d5p1=&quot;http://www.w3.org/2001/XMLSchema&quot; i:type=&quot;d5p1:int&quot;&gt;2&lt;/d3p1:Value&gt;
      &lt;/d3p1:KeyValueOfanyTypeanyType&gt;
    &lt;/d2p1:_params&gt;
    &lt;d2p1:Environment&gt;DotNet&lt;/d2p1:Environment&gt;
  &lt;/Context&gt;
  &lt;Initialized xmlns=&quot;http://www.totvs.com/&quot;&gt;true&lt;/Initialized&gt;
  &lt;IsolateProcess xmlns=&quot;http://www.totvs.com/&quot;&gt;false&lt;/IsolateProcess&gt;
  &lt;MaximumQuantityOfPrimaryKeysPerProcess xmlns=&quot;http://www.totvs.com/&quot;&gt;1000&lt;/MaximumQuantityOfPrimaryKeysPerProcess&gt;
  &lt;MinimumQuantityOfPrimaryKeysPerProcess xmlns=&quot;http://www.totvs.com/&quot;&gt;1&lt;/MinimumQuantityOfPrimaryKeysPerProcess&gt;
  &lt;PrimaryKeyList xmlns:d2p1=&quot;http://schemas.microsoft.com/2003/10/Serialization/Arrays&quot; xmlns=&quot;http://www.totvs.com/&quot;&gt;
    &lt;d2p1:ArrayOfanyType&gt;
      &lt;d2p1:anyType xmlns:d4p1=&quot;http://www.w3.org/2001/XMLSchema&quot; i:type=&quot;d4p1:short&quot;&gt;1&lt;/d2p1:anyType&gt;
      &lt;d2p1:anyType xmlns:d4p1=&quot;http://www.w3.org/2001/XMLSchema&quot; i:type=&quot;d4p1:string&quot;&gt;G&lt;/d2p1:anyType&gt;
      &lt;d2p1:anyType xmlns:d4p1=&quot;http://www.w3.org/2001/XMLSchema&quot; i:type=&quot;d4p1:string&quot;&gt;Exemplo&lt;/d2p1:anyType&gt;
    &lt;/d2p1:ArrayOfanyType&gt;
  &lt;/PrimaryKeyList&gt;
  &lt;PrimaryKeyNames xmlns:d2p1=&quot;http://schemas.microsoft.com/2003/10/Serialization/Arrays&quot; xmlns=&quot;http://www.totvs.com/&quot;&gt;
    &lt;d2p1:string&gt;CODCOLIGADA&lt;/d2p1:string&gt;
    &lt;d2p1:string&gt;APLICACAO&lt;/d2p1:string&gt;
    &lt;d2p1:string&gt;CODSENTENCA&lt;/d2p1:string&gt;
  &lt;/PrimaryKeyNames&gt;
  &lt;QuantityOfSplits xmlns=&quot;http://www.totvs.com/&quot;&gt;0&lt;/QuantityOfSplits&gt;
  &lt;ShouldParallelize xmlns=&quot;http://www.totvs.com/&quot;&gt;false&lt;/ShouldParallelize&gt;
  &lt;IsReplaceExistingRecordsVisible&gt;true&lt;/IsReplaceExistingRecordsVisible&gt;
  &lt;ReplaceExistingRecords&gt;false&lt;/ReplaceExistingRecords&gt;
  &lt;TargetColigadas xmlns:d2p1=&quot;http://schemas.microsoft.com/2003/10/Serialization/Arrays&quot;&gt;
    &lt;d2p1:int&gt;6&lt;/d2p1:int&gt;
  &lt;/TargetColigadas&gt;
&lt;/GlbParamsProcCopyColig&gt;</tot:strXmlParams>
      </tot:ExecuteWithXmlParams>
   </soapenv:Body>
</soapenv:Envelope>

Card

label	Response

Bloco de código

language	xml

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <ExecuteWithXmlParamsResponse xmlns="http://www.totvs.com/">
         <ExecuteWithXmlParamsResult>1</ExecuteWithXmlParamsResult>
      </ExecuteWithXmlParamsResponse>
   </s:Body>
</s:Envelope>

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

Informações

title	Para maiores informações:

@FRAMEWORK

Canais de Atendimento

Chamado: Através do Portal TOTVS - www.suporte.totvs.com.br

Telefônico: 4003-0015 Escolhendo as opções 2-2-3-9-5 (Framework) ou 2-2-3-9-4 (BI)

Produto	Framework
Versão	11.82.XX
Processo	Web Services
Subprocesso	Utilizando o Web Service wsProcess

Status do Documento:	Produção
Data:	30/06/2015
Versão:	11.82.XX
Versão Anterior:	11.82.XX
Autores:	Diego Henrique Pener Fábio Augusto Amaral Melo Nunes Welbert Marques Silva Wesley Avelino De Carvalho

...

Atalhos

Páginas filhas

Versões comparadas

Versão antiga 18

Nova versão 19

Chave

Introdução

Como funciona

Serviços Disponíveis