- Criado por Fábio Augusto Amaral Melo Nunes, última alteração por Stella Gleyse Macedo Vilaca em 08 out, 2018
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
Os parâmetros solicitado pelo ExecuteWithXmlParams são:
ProcessServerName tipo String
strXmlParams tipo String
Para pegar o parâmetro XML é necessário executar o processo através da biblioteca.
Acesse a biblioteca e execute o processo que deseja utilizar
No exemplo foi utilizado o processo de Cópia de Consultas SQL entre Coligadas

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


Após o processo ter sido executado com sucesso siga para o 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
Sabendo qual é o ID do Job é necessário obter o XML de processo. Ele pode ser obtido de duas formas:
- Utilizando a ferramenta TotvsWSClient, como descrito no Passo 4
- Localizando o ID do Job na tela de XML de Parâmetros de Jobs, na MDI, como descrito no link.
Após executar o TotvsWsClient acesse a visão de processos

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
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

<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><?xml version="1.0" encoding="utf-16"?>
<GlbParamsProcCopyColig xmlns:i="http://www.w3.org/2001/XMLSchema-instance" z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" xmlns="http://www.totvs.com.br/RM/">
<CanParallelize xmlns="http://www.totvs.com/">true</CanParallelize>
<Context xmlns:d2p1="http://www.totvs.com.br/RM/" z:Id="i2" xmlns="http://www.totvs.com/">
<d2p1:_params xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfanyTypeanyType>
<d3p1:Key xmlns:d5p1="http://www.w3.org/2001/XMLSchema" i:type="d5p1:string">$CODUNIDADEBIB</d3p1:Key>
<d3p1:Value xmlns:d5p1="http://www.w3.org/2001/XMLSchema" i:type="d5p1:int">1</d3p1:Value>
</d3p1:KeyValueOfanyTypeanyType>
<d3p1:KeyValueOfanyTypeanyType>
<d3p1:Key xmlns:d5p1="http://www.w3.org/2001/XMLSchema" i:type="d5p1:string">$CHAPAFUNCIONARIO</d3p1:Key>
<d3p1:Value xmlns:d5p1="http://www.w3.org/2001/XMLSchema" i:type="d5p1:string">00001</d3p1:Value>
</d3p1:KeyValueOfanyTypeanyType>
<d3p1:KeyValueOfanyTypeanyType>
<d3p1:Key xmlns:d5p1="http://www.w3.org/2001/XMLSchema" i:type="d5p1:string">$EXERCICIOFISCAL</d3p1:Key>
<d3p1:Value xmlns:d5p1="http://www.w3.org/2001/XMLSchema" i:type="d5p1:int">2</d3p1:Value>
</d3p1:KeyValueOfanyTypeanyType>
<d3p1:KeyValueOfanyTypeanyType>
<d3p1:Key xmlns:d5p1="http://www.w3.org/2001/XMLSchema" i:type="d5p1:string">$CODFILIAL</d3p1:Key>
<d3p1:Value xmlns:d5p1="http://www.w3.org/2001/XMLSchema" i:type="d5p1:int">1</d3p1:Value>
</d3p1:KeyValueOfanyTypeanyType>
<d3p1:KeyValueOfanyTypeanyType>
<d3p1:Key xmlns:d5p1="http://www.w3.org/2001/XMLSchema" i:type="d5p1:string">$RHTIPOUSR</d3p1:Key>
<d3p1:Value xmlns:d5p1="http://www.w3.org/2001/XMLSchema" i:type="d5p1:string">01</d3p1:Value>
</d3p1:KeyValueOfanyTypeanyType>
<d3p1:KeyValueOfanyTypeanyType>
<d3p1:Key xmlns:d5p1="http://www.w3.org/2001/XMLSchema" i:type="d5p1:string">$CODCOLIGADA</d3p1:Key>
<d3p1:Value xmlns:d5p1="http://www.w3.org/2001/XMLSchema" i:type="d5p1:int">1</d3p1:Value>
</d3p1:KeyValueOfanyTypeanyType>
<d3p1:KeyValueOfanyTypeanyType>
<d3p1:Key xmlns:d5p1="http://www.w3.org/2001/XMLSchema" i:type="d5p1:string">$EDUTIPOUSR</d3p1:Key>
<d3p1:Value xmlns:d5p1="http://www.w3.org/2001/XMLSchema" i:type="d5p1:string">F</d3p1:Value>
</d3p1:KeyValueOfanyTypeanyType>
<d3p1:KeyValueOfanyTypeanyType>
<d3p1:Key xmlns:d5p1="http://www.w3.org/2001/XMLSchema" i:type="d5p1:string">$CODLOCPRT</d3p1:Key>
<d3p1:Value xmlns:d5p1="http://www.w3.org/2001/XMLSchema" i:type="d5p1:int">5</d3p1:Value>
</d3p1:KeyValueOfanyTypeanyType>
<d3p1:KeyValueOfanyTypeanyType>
<d3p1:Key xmlns:d5p1="http://www.w3.org/2001/XMLSchema" i:type="d5p1:string">$CODUSUARIO</d3p1:Key>
<d3p1:Value xmlns:d5p1="http://www.w3.org/2001/XMLSchema" i:type="d5p1:string">mestre</d3p1:Value>
</d3p1:KeyValueOfanyTypeanyType>
<d3p1:KeyValueOfanyTypeanyType>
<d3p1:Key xmlns:d5p1="http://www.w3.org/2001/XMLSchema" i:type="d5p1:string">$CODUSUARIOSERVICO</d3p1:Key>
<d3p1:Value xmlns:d5p1="http://www.w3.org/2001/XMLSchema" i:type="d5p1:string"></d3p1:Value>
</d3p1:KeyValueOfanyTypeanyType>
<d3p1:KeyValueOfanyTypeanyType>
<d3p1:Key xmlns:d5p1="http://www.w3.org/2001/XMLSchema" i:type="d5p1:string">$CODSISTEMA</d3p1:Key>
<d3p1:Value xmlns:d5p1="http://www.w3.org/2001/XMLSchema" i:type="d5p1:string">G</d3p1:Value>
</d3p1:KeyValueOfanyTypeanyType>
<d3p1:KeyValueOfanyTypeanyType>
<d3p1:Key xmlns:d5p1="http://www.w3.org/2001/XMLSchema" i:type="d5p1:string">$CODTIPOCURSO</d3p1:Key>
<d3p1:Value xmlns:d5p1="http://www.w3.org/2001/XMLSchema" i:type="d5p1:int">2</d3p1:Value>
</d3p1:KeyValueOfanyTypeanyType>
<d3p1:KeyValueOfanyTypeanyType>
<d3p1:Key xmlns:d5p1="http://www.w3.org/2001/XMLSchema" i:type="d5p1:string">$CODIGOEXTERNO</d3p1:Key>
<d3p1:Value xmlns:d5p1="http://www.w3.org/2001/XMLSchema" i:type="d5p1:string">-1</d3p1:Value>
</d3p1:KeyValueOfanyTypeanyType>
<d3p1:KeyValueOfanyTypeanyType>
<d3p1:Key xmlns:d5p1="http://www.w3.org/2001/XMLSchema" i:type="d5p1:string">$IDPRJ</d3p1:Key>
<d3p1:Value xmlns:d5p1="http://www.w3.org/2001/XMLSchema" i:type="d5p1:int">2</d3p1:Value>
</d3p1:KeyValueOfanyTypeanyType>
</d2p1:_params>
<d2p1:Environment>DotNet</d2p1:Environment>
</Context>
<Initialized xmlns="http://www.totvs.com/">true</Initialized>
<IsolateProcess xmlns="http://www.totvs.com/">false</IsolateProcess>
<MaximumQuantityOfPrimaryKeysPerProcess xmlns="http://www.totvs.com/">1000</MaximumQuantityOfPrimaryKeysPerProcess>
<MinimumQuantityOfPrimaryKeysPerProcess xmlns="http://www.totvs.com/">1</MinimumQuantityOfPrimaryKeysPerProcess>
<PrimaryKeyList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://www.totvs.com/">
<d2p1:ArrayOfanyType>
<d2p1:anyType xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:short">1</d2p1:anyType>
<d2p1:anyType xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string">G</d2p1:anyType>
<d2p1:anyType xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string">Exemplo</d2p1:anyType>
</d2p1:ArrayOfanyType>
</PrimaryKeyList>
<PrimaryKeyNames xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://www.totvs.com/">
<d2p1:string>CODCOLIGADA</d2p1:string>
<d2p1:string>APLICACAO</d2p1:string>
<d2p1:string>CODSENTENCA</d2p1:string>
</PrimaryKeyNames>
<QuantityOfSplits xmlns="http://www.totvs.com/">0</QuantityOfSplits>
<ShouldParallelize xmlns="http://www.totvs.com/">false</ShouldParallelize>
<IsReplaceExistingRecordsVisible>true</IsReplaceExistingRecordsVisible>
<ReplaceExistingRecords>false</ReplaceExistingRecords>
<TargetColigadas xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>6</d2p1:int>
</TargetColigadas>
</GlbParamsProcCopyColig></tot:strXmlParams>
</tot:ExecuteWithXmlParams>
</soapenv:Body>
</soapenv:Envelope>
<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>
Serviço responsável por executar processos com parâmetros XML de forma assíncrona, isto é, o serviço submeterá a execução do processo e devolverá um id de job que pode ser passado como parâmetro para o serviço GetProcessStatus para consultar o andamento do processo.
Os passos a serem seguidos são idênticos ao serviço ExecuteWithXmlParams, porém o retorno do método é diferente. Disponibilizado a partir da versão 12.1.20.
Os parâmetros solicitado pelo ExecuteWithXmlParamsAsync são:
ProcessServerName tipo String
strXmlParams tipo String
Para pegar o parâmetro XML é necessário executar o processo através da biblioteca.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tot="http://www.totvs.com/">
<soapenv:Header/>
<soapenv:Body>
<tot:ExecuteWithXmlParamsAsync>
<!--Optional:-->
<tot:ProcessServerName>GlbCopyPermisUsrProc</tot:ProcessServerName>
<!--Optional:-->
<tot:strXmlParams><![CDATA[<?xml version="1.0" encoding="utf-16"?>
<GlbParamsProcCopyPermisUsr z:Id="i1" xmlns="http://www.totvs.com.br/RM/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/">
<ActionModule xmlns="http://www.totvs.com/">G</ActionModule>
<ActionName xmlns="http://www.totvs.com/">GlbActionProcCopyPermisUsr</ActionName>
<CodUsuario xmlns="http://www.totvs.com/">mestre</CodUsuario>
<Context z:Id="i2" xmlns="http://www.totvs.com/" xmlns:a="http://www.totvs.com.br/RM/">
<a:_params xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<b:KeyValueOfanyTypeanyType>
<b:Key i:type="c:string" xmlns:c="http://www.w3.org/2001/XMLSchema">$EXERCICIOFISCAL</b:Key>
<b:Value i:type="c:int" xmlns:c="http://www.w3.org/2001/XMLSchema">22</b:Value>
</b:KeyValueOfanyTypeanyType>
<b:KeyValueOfanyTypeanyType>
<b:Key i:type="c:string" xmlns:c="http://www.w3.org/2001/XMLSchema">$CODLOCPRT</b:Key>
<b:Value i:type="c:int" xmlns:c="http://www.w3.org/2001/XMLSchema">12</b:Value>
</b:KeyValueOfanyTypeanyType>
<b:KeyValueOfanyTypeanyType>
<b:Key i:type="c:string" xmlns:c="http://www.w3.org/2001/XMLSchema">$CODTIPOCURSO</b:Key>
<b:Value i:type="c:int" xmlns:c="http://www.w3.org/2001/XMLSchema">1</b:Value>
</b:KeyValueOfanyTypeanyType>
<b:KeyValueOfanyTypeanyType>
<b:Key i:type="c:string" xmlns:c="http://www.w3.org/2001/XMLSchema">$EDUTIPOUSR</b:Key>
<b:Value i:type="c:string" xmlns:c="http://www.w3.org/2001/XMLSchema">A</b:Value>
</b:KeyValueOfanyTypeanyType>
<b:KeyValueOfanyTypeanyType>
<b:Key i:type="c:string" xmlns:c="http://www.w3.org/2001/XMLSchema">$CODUNIDADEBIB</b:Key>
<b:Value i:type="c:int" xmlns:c="http://www.w3.org/2001/XMLSchema">5</b:Value>
</b:KeyValueOfanyTypeanyType>
<b:KeyValueOfanyTypeanyType>
<b:Key i:type="c:string" xmlns:c="http://www.w3.org/2001/XMLSchema">$CODCOLIGADA</b:Key>
<b:Value i:type="c:int" xmlns:c="http://www.w3.org/2001/XMLSchema">1</b:Value>
</b:KeyValueOfanyTypeanyType>
<b:KeyValueOfanyTypeanyType>
<b:Key i:type="c:string" xmlns:c="http://www.w3.org/2001/XMLSchema">$RHTIPOUSR</b:Key>
<b:Value i:type="c:string" xmlns:c="http://www.w3.org/2001/XMLSchema">01</b:Value>
</b:KeyValueOfanyTypeanyType>
<b:KeyValueOfanyTypeanyType>
<b:Key i:type="c:string" xmlns:c="http://www.w3.org/2001/XMLSchema">$CODIGOEXTERNO</b:Key>
<b:Value i:type="c:string" xmlns:c="http://www.w3.org/2001/XMLSchema">-1</b:Value>
</b:KeyValueOfanyTypeanyType>
<b:KeyValueOfanyTypeanyType>
<b:Key i:type="c:string" xmlns:c="http://www.w3.org/2001/XMLSchema">$CODSISTEMA</b:Key>
<b:Value i:type="c:string" xmlns:c="http://www.w3.org/2001/XMLSchema">G</b:Value>
</b:KeyValueOfanyTypeanyType>
<b:KeyValueOfanyTypeanyType>
<b:Key i:type="c:string" xmlns:c="http://www.w3.org/2001/XMLSchema">$CODUSUARIOSERVICO</b:Key>
<b:Value i:type="c:string" xmlns:c="http://www.w3.org/2001/XMLSchema" />
</b:KeyValueOfanyTypeanyType>
<b:KeyValueOfanyTypeanyType>
<b:Key i:type="c:string" xmlns:c="http://www.w3.org/2001/XMLSchema">$CODUSUARIO</b:Key>
<b:Value i:type="c:string" xmlns:c="http://www.w3.org/2001/XMLSchema">mestre</b:Value>
</b:KeyValueOfanyTypeanyType>
<b:KeyValueOfanyTypeanyType>
<b:Key i:type="c:string" xmlns:c="http://www.w3.org/2001/XMLSchema">$IDPRJ</b:Key>
<b:Value i:type="c:int" xmlns:c="http://www.w3.org/2001/XMLSchema">2</b:Value>
</b:KeyValueOfanyTypeanyType>
<b:KeyValueOfanyTypeanyType>
<b:Key i:type="c:string" xmlns:c="http://www.w3.org/2001/XMLSchema">$CHAPAFUNCIONARIO</b:Key>
<b:Value i:type="c:string" xmlns:c="http://www.w3.org/2001/XMLSchema">00001</b:Value>
</b:KeyValueOfanyTypeanyType>
<b:KeyValueOfanyTypeanyType>
<b:Key i:type="c:string" xmlns:c="http://www.w3.org/2001/XMLSchema">$CODFILIAL</b:Key>
<b:Value i:type="c:int" xmlns:c="http://www.w3.org/2001/XMLSchema">1</b:Value>
</b:KeyValueOfanyTypeanyType>
</a:_params>
<a:Environment>DotNet</a:Environment>
</Context>
<PrimaryKeyList xmlns="http://www.totvs.com/" xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a:ArrayOfanyType>
<a:anyType i:type="b:string" xmlns:b="http://www.w3.org/2001/XMLSchema">1Teste</a:anyType>
</a:ArrayOfanyType>
</PrimaryKeyList>
<PrimaryKeyNames xmlns="http://www.totvs.com/" xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a:string>CODUSUARIO</a:string>
</PrimaryKeyNames>
<CodSistema>S</CodSistema>
<CopyToAllApplications>true</CopyToAllApplications>
<NewUser>
<Email i:nil="true" />
<Nome i:nil="true" />
<Senha i:nil="true" />
<Usuario i:nil="true" />
<UsuariodeRede i:nil="true" />
<codAcesso i:nil="true" />
</NewUser>
<RemoveOldPermissions>false</RemoveOldPermissions>
<SourceUsuario>mestre</SourceUsuario>
</GlbParamsProcCopyPermisUsr>]]></tot:strXmlParams>
</tot:ExecuteWithXmlParamsAsync>
</soapenv:Body>
</soapenv:Envelope>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<ExecuteWithXmlParamsAsyncResponse xmlns="http://www.totvs.com/">
<ExecuteWithXmlParamsAsyncResult><![CDATA[<?xml version="1.0" encoding="utf-16"?>
<ProcessID>
<JobID>104863</JobID>
<ExecID>1</ExecID>
</ProcessID>]]></ExecuteWithXmlParamsAsyncResult>
</ExecuteWithXmlParamsAsyncResponse>
</s:Body>
</s:Envelope>
Serviço responsável por retornar as informações de um processo. Os parâmetros podem ser capturados pelo método ExecuteWithXmlParamsAsync.
Os parâmetros solicitado pelo ExecuteWithXmlParams são:
jobId tipo String
execId tipo String
Para pegar o parâmetro XML é necessário executar o processo através da biblioteca.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tot="http://www.totvs.com/">
<soapenv:Header/>
<soapenv:Body>
<tot:GetProcessStatus>
<!--Optional:-->
<tot:jobId>104863</tot:jobId>
<!--Optional:-->
<tot:execId>1</tot:execId>
</tot:GetProcessStatus>
</soapenv:Body>
</soapenv:Envelope>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<GetProcessStatusResponse xmlns="http://www.totvs.com/">
<GetProcessStatusResult><![CDATA[<?xml version="1.0" encoding="utf-16"?>
<ProcessInfo>
<ProcessID>
<JobID>104863</JobID>
<ExecID>1</ExecID>
</ProcessID>
<Message />
<Progress>-1</Progress>
<Status>Finished</Status>
</ProcessInfo>]]></GetProcessStatusResult>
</GetProcessStatusResponse>
</s:Body>
</s:Envelope>
Observação
Os outros métodos expostos foram descontinuados, e encontram-se disponíveis somente por motivo de compatibilidade.
Para maiores informações:
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: | Finalizado |
|---|---|
| Data: | 30/06/2015 |
| Versão: | 11.82.XX |
| Versão Anterior: | 11.82.XX |
| Autores: |
