Boletim Tcnico

Integrao Protheus TOTVS Reports

Produto

Microsiga Protheus Configurador

Chamado

TEPVU3

Data da publicao

13/09/12

Pas(es)

Todos

Banco(s) de Dados

Todos

Disponibilizado o processo de integrao entre o Protheus e o RM Reports que foi desenvolvida para que seja possvel gerar
relatrios atravs do RM, utilizando as fontes de dados do Protheus. Desta forma, possvel utilizar o gerenciador de relatrios do RM
para desenhar o relatrio e execut-lo atravs do Protheus.

A construo do relatrio dentro do RM, acessando os dados do Protheus est descrita no documento fornecido pela RM.

O processo de gerao de relatrios do sistema RM suporta os seguintes formatos de arquivos:

PDF: Portable Document Format

TXT: Texto plano

XLS: Microsoft Excel

XLSX: Microsoft Excel (2007 e posteriores)

RTF: Rich Text Format

CSV: Comma-Separated Values (Valores separados por vrgula)

HTML: HyperText Markup Language

MHT: MIME HTML (pgina web completa, container)

Quando solicitada a gerao de um relatrio, o Protheus gera um token referente ao usurio atual e o envia nas requisies feitas
ao RM. Com o Token, sempre que o RM precisar, consulta informaes sobre as informaes que podem ser exibidas ou no, o token
devolvido ao Protheus, que identifica o usurio e responde as requisies com as informaes corretas.

Durante a modelagem do relatrio no RM, se for necessrio obter alguma informao do Protheus, feita a autenticao em que
o RM informa usurio e senha criptografados com algoritmo AES, recebendo o token caso o login seja realizado com sucesso.

A seguir esto os diagramas de atividades que demonstram as integraes entre os sistemas.

WebService de integrao com o RM

Desenvolvido o webservice para a integrao com o servidor do RM, em que foram criados os seguintes mtodos:

SIGACFG Integrao Protheus TOTVS Reports

Boletim Tcnico

GetTableList
Retorna a lista de tabelas (SX2), podendo filtr-las de acordo com o parmetro (opcional) recebido. A lista de tabelas
criada a partir da leitura sequencial do SX2 da empresa relacionada ao WebService.

GetTableColumns
Retorna uma lista com o nome, descrio e o tipo das colunas da tabela informada no parmetro

GetTableChilds
Retorna a lista de tabelas relacionadas tabela informada no parmetro. So listadas tambm as chaves da tabela pai e
sua ligao respectiva na tabela filha. Para construir esta lista utilizada a tabela SX9 do Protheus.

GetDisabledColumns
Retorna a listagem de colunas que no devem ser exibidas para um determinado usurio, baseado no nivel global do
prprio usurio e nas propriedades do campo no dicionrio de dados (campo X3_USADO).

GetToken
Retorna um token relacionado a um usurio, para utilizacao em mtodos que validam as permisses do usurio.

IsValidUser
Define se o token associado a um usuario ainda est ativo.

Funcionamento do webservice (Protheus)

Na gerao do relatrio, o RM executa os mtodos GetTableList, GetTableColumns e GetTableChilds. Com base nestas
informaes, o usurio pode selecionar as tabelas e campos desjados para construir um relatrio.
Tambm possvel realizar um preview do mesmo para visualizar como ser a sua apresentao. Neste momento o RM solicita
uma chave de usurio e senha, para autenticao no Protheus, utilizando o mtodo GetToken. Estas informaes so enviadas de forma
criptografada ao Protheus, que verifica se o usurio vlido e retorna um token ao RM. Com o token do usurio, o sistema RM solicita ao
Protheus que retorne a relao de campos no permitidos para visualizao do usurio, atravs do mtodo GetDisabledColums.
Quando a execuo do relatrio for disparada pelo Protheus, a chamada inicial do Protheus ao webservice do servidor do RM
envia o token relacionado ao usurio. Este token utilizado pelo RM durante a gerao do relatrio.

SIGACFG Integrao Protheus TOTVS Reports

Boletim Tcnico

Criao do menu no Protheus

Protheus

RM

Incluso de novo item de menu

(RM Report)

Consulta a listagem de
relatrios disponveis

Retorna a listagem de
relatrios

Permite ao usurio selecionar

o relatrio desejado

Preenche o novo item de menu

com o link para o relatrio RM

SIGACFG Integrao Protheus TOTVS Reports

Boletim Tcnico

Processo de gerao do relatrio

Protheus

RM

Incio da execuo do relatrio

Solicitao dos parmetros do relatrio

Retorno dos parmetros (quando hover)

Solicitao das tabelas utilizadas para

pemitir a filtragem dos dados

Retorno dos dados do relatrio

Exibe a interface para o usurio

selecionar o tipo de arquivo gerado, o
local onde o mesmo ser gravado e as
opes de filtragem

Solicita ao RM que gere o relatrio

Retorna o ID do relatrio gerado

Inicia o download do arquivo

Fornece o contedo do relatrio gerado

Grava o arquivo localmente

Inicia o aplicativo associado pelo sistema

operacional, exibindo o arquivo gerado

SIGACFG Integrao Protheus TOTVS Reports

Boletim Tcnico

PROCEDIMENTO PARA IMPLEMENTAO

Os dois sistemas trocaro informaes atravs de WebServices. Portanto, necessrio configurar o servidor do Protheus para
ativar o webservice responsvel pelo fornecimento dos dados do Protheus ao RM e tambm configurar os parmetros que armazenam o
endereo e porta do servidor do WebService do sistema RM.
Aps a atualizao da LIB, os fontes devem estar atualizados sendo igual ou superior as datas para cada fonte: CallRM.prw
(22/08/12), FwDictionary.prw (11/05/12), RptWebServicesCliente.prw (11/05/12), ApLib090.prw (11/05/12), ApWiz020.prw (14/05/12)
ApWizLIB.prw (14/05/12), em que adicionado um novo webservice chamado FwDictionary que

responsvel pelo envio de

informaes referentes aos dicionrios Protheus ao RM Reports. Sua funo disponibilizar informaes sobre os dicionrios do
Protheus, como tabelas, campos, etc.
Durante a execuo do relatrio, o nvel dos campos considerado para limitar as informaes exibidas para o usurio o nvel
global do mesmo, configurado no cadastro de senhas, no mdulo Configurador (SIGACFG).
Para que o Protheus possa solicitar e enviar informaes durante a gerao dos relatrios, os parmetros MV_RMWSURL e
MV_RMWSPRT devem ser configurados com o endereo do servidor de WebServices do RM e a porta, respectivamente.
No Protheus, mesmo que j haja uma instncia de webservices configuradas no arquivo appserver.ini, deve-se criar uma nova
instncia dedicada para execuo do FwDictionary. Isto se deve ao controle de licenas diferenciado para este servio, uma vez que o RM
Reports tambm consome licenas.
Caso esta configurao no seja feita, haver o consumo de licenas pelas duas partes da integrao, RM e Protheus. O
gerenciador do webservice est protegido para aceitar apenas requisies do servio destinado a esta integrao.
Esta instncia deve vincula-se a empresa/filial que ser integrada ao Totvs Report, lembrando que os campos e tabelas so os
mesmos para todas as filiais. O cdigo da empresa o dado mais importante na clusula PREPAREIN da sesso do webservice.
Utilize o assistente de configurao do servidor (SrvWizard) para incluir este webservice, selecionando a opo WSR Web
Service de integrao RMReports, ao incluir um novo mdulo web. As demais configuraes so as mesmas do mdulo WS comum.
Exemplo de configurao do webservice para utilizao do Totvs Report:
[HTTP]
ENABLE=1
PORT=80
[localhost/wsdictionary]
ENABLE=1
PATH=c:\Protheus11\Protheus_Data\web\ws
ENVIRONMENT=P11
INSTANCENAME=ws
RESPONSEJOB=JOB_WSDIC_9901
DEFAULTPAGE=wsindex.apw
[JOB_WSDIC_9901]
TYPE=WEBEX
ENVIRONMENT=P11
INSTANCES=1,10
SIGAWEB=WS
INSTANCENAME=ws
ONSTART=__WSSTARTFW
ONCONNECT=__WSCONNECT
SIGACFG Integrao Protheus TOTVS Reports

Boletim Tcnico

PREPAREIN=99,01
Aps a gerao, o relatrio transferido do servidor do RM para o servidor do Protheus sendo possvel salvar na estao.

PROCEDIMENTOS PARA UTILIZAO

O relatrio deve ser construdo dentro da ferramenta RM, conforme orientao do produto RM.
Aps o desenvolvimento do relatrio, o mesmo pode ser acionado pelo Protheus, inserindo no menu utilizado pelo usurio
conforme o procedimento abaixo:

1.

No Configurador (SIGACFG), acesse Ambiente/Cadastros/Menus (CFGX013).

2.

Selecione os menus a serem editados e Confirme.

3.

Adicione o novo item de menu que inicia o relatrio.

4.

No campo Tipo selecione RM Report.

5.

No campo Programa selecione a opo de pesquisa representado por ... (trs pontos).

6.

apresentada a listagem dos relatrios disponveis no sistema RM.

7.

Selecione o relatrio desejado e Confirme.

8.

Finalize a edio do menu.

Para gerar o relatrio, o procedimento semelhante gerao de um relatrio do Protheus, acesse o mdulo que foi
configurado o relatrio e selecione no menu. Aps a gerar o relatrio, o Protheus executa a abertura do arquivo, que solicita ao sistema
operacional que utilize o aplicativo associado ao tipo de arquivo em uso.

INFORMAES TCNICAS

Tabelas Utilizadas

Rotinas Envolvidas
Sistemas Operacionais

SX2 Tabelas
SX3 Campos
FWDICTIONARY.PRW
APLIB090.PRW
Windows

SIGACFG Integrao Protheus TOTVS Reports