Histórico da Página
Integração PROTHEUS (SIGAJURI) X RM (Simplificado)
Contexto de negócio
O intuito deste manual e validar a integração do Ambiente RM X Protheus via envio de mensagem única EAI.
O objetivo da integração do PROTHEUS x BackOffice RM é viabilizar que de forma automática os cadastros gerenciados pelo BackOffice sejam replicados. Desta forma as bases de dados se mantém espelhadas.
Âncora Sistemas Envolvidos Sistemas Envolvidos
Sistemas Envolvidos | |
Sistemas Envolvidos |
Sistemas Envolvidos
Descrição dos sistemas envolvidos no contexto de negócio (e que serão envolvidos na integração).
...
Atender a demanda de clientes que possuem o BackOffice RM, sincronizando as informações entre os módulos a partir da integração por Mensagem Única TOTVS.
Âncora Modelo de Mensagem Única TOTVS Modelo de Mensagem Única TOTVS
Modelo de Mensagem Única TOTVS
Durante o processo de consolidação de marcas, iniciado pela TOTVS, várias empresas diferentes foram adquiridas e com elas vários produtos passaram a compor o portfólio de ofertas disponível aos clientes. Esta expansão de ofertas permitiu que clientes de uma marca, antes limitados pelas opções com aquela “etiqueta”, pudessem agora compor o seu ambiente de TI utilizando produtos de origens diferentes (Exemplo: BackOffice RM + Protheus).
Esta mesma iniciativa já era uma prática comum nos clientes, porém todo o custo envolvido na integração entre estes aplicativos era visto pelo cliente como parte da escolha de utilizar-se de produtos de diferentes fornecedores. Uma vez que estes produtos passam a fazer parte de uma mesma oferta, os clientes TOTVS passam a demandar que estes produtos sejam naturalmente integrados. Isto significa que se antes o cliente arcava com o custo e o risco envolvido em uma integração (como corrupção da base de dados, por exemplo), ele agora entende que a TOTVS deve prover soluções já integradas, independente da origem dos produtos oferecidos.
Com o objetivo de padronizar as integrações com os produtos TOTVS, foi definida uma nova diretriz para os projetos de integração: A de que todos os produtos TOTVS devam trabalhar com uma mensagem XML único evitando, desta forma, o processo de transformação de mensagens. Neste cenário, teríamos o seguinte quadro:
...
Além de questões referentes ao formato das mensagens, a mensagem única também torna uniforme o tratamento destas mensagens XML pelos aplicativos, principalmente no que diz respeito à capacidade de rastreamento.
Âncora Pré-requisitos instalação/implantação/utilização Pré-requisitos instalação/implantação/utilização
...
O compartilhamento de tabelas deve ser coerente com a forma como o BackOffice RM trabalha, conforme descrita tabela abaixo.
Cadastro Empresa Filial Tabela RM Tabela Protheus Moeda Compartilhado Compartilhado GMOEDA CTO Unidade de Medida Compartilhado Compartilhado TUND SAH Centro de Custo Exclusivo Compartilhado GCCUSTO CTT Projeto Exclusivo Exclusivo MPRJ AF8 Obra Exclusivo Exclusivo MTAREFA AFC Tarefa Exclusivo Exclusivo MTAREFA AF9 Etapa Exclusivo Exclusivo MTAREFA AFC Condição de Pagamento Exclusivo Compartilhado TCPG SE4 Produto Exclusivo * Compartilhado TPRODUTO SB1 Cliente/Fornecedor Compartilhado ** Compartilhado FCFO SA1 (Cliente) e SA2 (Fornecedor) Patrimônio Exclusivo Exclusivo IPATRIMONIO SN1 Funcionário Exclusivo Compartilhado PFUNC SRA | SRF | SR3 | SR7 Local de Estoque Exclusivo Exclusivo TLOC NNR * Independentemente se for utilizado produto global no RM, a tabela referente no Protheus deve ser exclusiva por empresa, ficando a cargo do RM replicar os produtos globais para cada filial no Protheus.
** Mesmo que a empresa não utilize Cliente/Fornecedor global no RM, deve-se compartilhar a tabela referente no Protheus por empresa. Será enviado concatenado ao código do cliente/fornecedor o código da coligada, conforme a mascara “[CODCOLIGADA]|[CODCFO]”.- Configuração dos adapters utilizados na integração TOTVS PROTHEUS x BackOffice RM, assim como toda a configuração do EAI Protheus.
- Acessar o SIGACFG
- Ambiente > Schedule > Adapter E.a.I.
- Incluir uma nova Rotina para os adapters do sistema Protheus
- Configurar a Rotina do Adapter de acordo com os dados abaixo fornecidos e que já foram pré estabelecidos na aplicação do patch de atualização do Protheus:
Mensagem Única | Rotina Protheus | Mensagem | Descrição | Envia | Recebe | Método Protheus | Operação | Canal de Envio | Adapter Protheus | Versão |
Sim | NGMUAmpPat | ASSETSVALUATION | Ampliação Patrimonial | Sim | Não | Síncrono | Todas | EAI | NGMUAmpPat | 1.000 |
Sim | NGMUAprCst | APPOINTMENTCOST | Apropriação de Custo | Sim | Não | Síncrono | Todas | EAI | NGMUAprCst | 1.000 |
Sim | ATFA010 | ASSETS | Ativo Fixo | Não | Sim | Síncrono | Todas | EAI | ATFA012 | 1.001 |
Sim | NGMUStoTuO | STOCKTURNOVER | Baixa de Estoque | Sim | Sim | Síncrono | Todas | EAI | NGMUStoTuO | 1.002 |
Sim | NGMUCanMnO | CANCELMAINTENANCEORD | Cancelamento de OS | Sim | Não | Síncrono | Todas | EAI | NGMUCanMnO | 1.000 |
Sim | NGMUCanReq | CANCELREQUEST | Cancelamento de Requisição | Sim | Sim | Síncrono | Todas | EAI | NGMUCanReq | 1.000 |
Sim | GPEA370 | EMPLOYEEPOSITION | Cargo | Não | Sim | Síncrono | Todas | EAI | GPEA370 | 1.000 |
Sim | CTBA030 | COSTCENTER | Centro de Custo | Não | Sim | Síncrono | Todas | EAI | CTBA030 | 2.000 |
Sim | MATA030 | CUSTOMERVENDOR | Cliente | Não | Sim | Síncrono | Todas | EAI | MATA030 | 2.002 |
Sim | MATA360 | PAYMENTCONDITION | Condição de Pagamento | Não | Sim | Síncrono | Todas | EAI | MATA360 | 2.000 |
Sim | NGMUStoLvl | STOCKLEVEL | Consulta de Saldo | Sim | Não | Síncrono | Todas | EAI | NGMUStoLvl | 1.001 |
Sim | PMSA201 | STEPPROJECT | Etapa (EDT) | Não | Sim | Síncrono | Todas | EAI | PMSA201 | 2.000 |
Sim | MATA020 | CUSTOMERVENDOR | Forncecedor | Não | Sim | Síncrono | Todas | EAI | MATA020 | 2.002 |
Sim | GPEA030 | ROLE | Função | Não | Sim | Síncrono | Todas | EAI | GPEA030 | 1.000 |
Sim | GPEA010 | EMPLOYEE | Funcionário | Não | Sim | Síncrono | Todas | EAI | GPEA010 | 2.001 |
Sim | NGMUGETSIT | GETEMPLOYEESITUATIONS | Situação do Funcionário | Sim | Não | Síncrono | Todas | EAI | NGMUGETSIT | 1.000 |
Sim | NGMUInfPar | INFOOFPARCELVALUES | Informações de Parcelas | Não | Sim | Síncrono | Todas | EAI | NGMUInfPar | 1.000 |
Sim | AGRA045 | WAREHOUSE | Local de Estoque | Não | Sim | Síncrono | Todas | EAI | AGRA045 | 1.000 |
Sim | CTBA140 | CURRENCY | Moeda | Não | Sim | Síncrono | Todas | EAI | CTBA140 | 2.000 |
Sim | PMSA201 | SUBPROJECT | Obra (EDT) | Não | Sim | Síncrono | Todas | EAI | Obra (EDT) | 2.000 |
Sim | NGMUOrder | ORDER | Ordem | Sim | Sim | Síncrono | Todas | EAI | NGMUOrder | 3.002 |
Sim | NGMUMntOrd | MAINTENANCEORDER | Ordem de Serviço | Sim | Sim | Síncrono | Todas | EAI | NGMUMntOrd | 1.000 |
Sim | MATA010 | ITEM | Produto | Não | Sim | Síncrono | Todas | EAI | MATA010 | 2.000 |
Sim | PMSA200 | PROJECT | Projeto | Não | Sim | Síncrono | Todas | EAI | PMSA200 | 2.000 |
Sim | NGMUReques | REQUEST | Solicitação | Sim | Sim | Síncrono | Todas | EAI | NGMUReques | 1.000 |
Sim | PMSA203 | TASKPROJECT | Tarefa | Não | Sim | Síncrono | Todas | EAI | PMSA203 | 2.000 |
Sim | GPEA080 | SHIFTWORK | Turno | Não | Sim | Síncrono | Todas | EAI | GPEA080 | 1.000 |
Sim | QIEA030 | UNITOFMEASURE | Unidade de medida | Não | Sim | Síncrono | Todas | EAI | QIEA030 | 2.000 |
...
Âncora Configurar os Parametros Protheus Configurar os Parametros Protheus - Acessar o SigaCFG
- Ambiente > Cadastros > Parametros
Configurar os parâmetros abaixo no Protheus para a integração do BackOffice RM x Protheus
a) MV_EAIURL2
Host do RM configurado (Procedimento futuro)
2. MV_EAIMETH
Método padrão
3. MV_EAIUSER
4. MV_EAIPASS
. MV_EAIPORT
po Porta padrão
Âncora CheckList Protheus CheckList Protheus
CheckList Protheus | |
CheckList Protheus |
Protheus
Visando maior facilidade na implantação da integração está disponível abaixo um CheckList com os passos padrão necessários para implantação e parametrização da integração no Protheus.
...
Neste passo, vamos realizar a configuração HTTP por parte do Protheus, bem como configurar os Adapters e Rotas para comunicação com RM via EAI.
- Utilizar um ambiente Protheus existente.
...
ENVIRONMENT=p12117 ;ambiente
RESPONSEJOB=JOB_WS_0101
;webservice para o MU usando o nome
...
RESPONSEJOB=JOB_WS_0101
DEFAULTPAGE=wsindex.apw
[JOB_WS_0101] ;webservice para o MU
...
namespace=http://www.totvs.com.br/rm/
trace=1
;WEBSERVICELocation=http://SPOD2896:86
;URLLocation=http://SPOD2896:86
;WEBSERVICELocation=http://SPON5101:81
;URLLocation=http://SPON5101:81
- Subir o serviço ambiente Protheus.
- Verificar acesso ao Host no caminho: http://localhost:12001/
- Será utilizado o método EAI SERVICE: http://localhost:12001/EAISERVICE.apw?WSDL
...
Exemplo: http://localhost:12001/EAISERVICE.apw?WSDL
- Realizar a configuracao dos parâmetros listados anteriormente.
- Ainda no SIGACFG, acessar a rotina de Schedule e realizar os seguintes cadastros:
- Cadastro de Rotas EAI (será feita uma única vez)
*URL (Método Host do RM – Service EAI RM)
...
*Cliente WS e método (padrão)
- Adapter EAI (É feita para cada rotina integrada ao RM)
*Mensagem única – Sim
...
*Roteamento de mensagens – Apontar Rota e envia – Sim.
*Funcionários
*atenção na versao de envio utilizada.
Acessando http://api.totvs.com.br/#/ , é possivel veriricar a lista de servicos referentes a integração bem como as entidades (transactionID) e as versoes liberadas referentes ao RM, no menu > mensagem padronizada.
- Schedule (verificação futura do monitor de comunicação de EAI entre os sistemas.
*clicando na lupa, e possivel ver o log de execução das mensagens.
- Emp. Filial Mensagem Única (de para de empresas para referência ao RM)
Será feita a referencia de empresas ao RM.
...
*Mais informaçõesno tópico: Transações/Entidades/Mensagens únicas
Âncora CheckList RM CheckList RM
CheckList RM | |
CheckList RM |
RM
Utilizado um banco de dados e uma Biblioteca de teste para simulacao do Ambiente. (Verificar padroes padrões RM de acordo com Cliente e o administrador responsável do local a ser implementado)
...
Passo 1: Instalar uma base de dados RM
a) Executar o setup Base de Dados SQL - 12.1.17.msi
...
d) No SQL, restaurar o arquivo exemplo.
e) Apontar o arquivo. bak no dispositivo de origem.
Passo 2: Instalar Biblioteca RM
a) Executar o setup BibliotecaRM - 12.1.17.msi
...
h) Neste ponto o RM.EXE já pode ser executado.
- Configurando Host RM:
a) Editar os arquivos de configuração de Host para comunicação do XML entre sistemas.
b) Replicar as alterações de Host do RM.HOST.SERVICE.EXE.CONFIG para o arquivo RM.HOST.EXE.CONFIG (caso suba o ambiente pelo executável)
- Seguir o seguinte modelo para configuração do Host RM:
...
<?xml version="1.0" encoding="utf-8"?>
...
<add key="Host" value="SPON010108074localhost" />
<add key="SERVICESHOSTNAME" value="SPON010108074localhost" />
<add key="HTTPPort" value="8051" />
...
- Após subir o ambiente, verificar o acesso ao Host no browser de internet: http://localhost:8051/wspageindex/
*Criação feita em ambiente local, alterar “localhost” para local especifico. O restante refere-se aos métodos default.
Será utilizado o método EAI SERVICE para comunicação com o Protheus.
Abrindo RM:
Utilizado um usuário padrão de testes.
...
Controle de Versão
O grupo TOTVS, representado por suas marcas, irá administrar as demandas de evolução dos layouts e demais ajustes, acordando junto aos solicitantes o prazo de liberação de release.
Todas as evoluções programadas deverão ser discutidas e aprovadas pelas marcas antes do início do desenvolvimento e somente serão desenvolvidas em caso de concordância das marcas e alinhamento com as diretivas definidas pelo Comitê de Integração TOTVS.
Suporte
O suporte aos recursos da Integração será de responsabilidade de todas as linhas, sendo assim as equipes de suporte dos produtos BackOffice RM, Backoffice Protheus e SigaMNT estarão aptas a fazer a primeira análise e, quando necessário, repassar para a equipe mais adequada em cada caso.
Escopo
O escopo deste projeto se restringe aos processos de integração com o SigaMNT Protheus e os cadastros utilizados por estes.
Todos os processamentos de BackOffice se manterão no RM, sendo eles a geração de escrituração, relatórios, emissão de notas fiscais e outros.
...
Usuário: mestre
Senha: totvs
Para primeiro acesso deve ser configurado o alias clicando no botão ao lado.
- Ver permissões:
Menu > Serviços globais > ver permissões em perfis e Usuário
- Acessar guia segurança.
Opção Perfis.
Neste caso, o usuário possui perfis de acesso DBA e DP.
Criar um perfil adicional
Exemplo Perfil mestre:
Clicar em incluir.
Identificação:
Nesta parte e possível delegar acessos a campos e menus.
*Verificar com o Administrador do RM, o acesso as rotinas que serão integradas leitura e gravação e também a opção de Integrações do menu.
*permitido acesso a todos serviços para o usuário Mestre.
- Opção Usuários.
Localizar e editar o usuário.
Identificação:
Associar os perfis, na aba Segurança:
- Menu Integração
- Acessar a guia EAI 2.0
Nesta área, será feita a configuracao dos seguintes itens:
- Aplicativos
- Transações
- Rotas (Transação/App)
- De/Para
- Aplicativos
Incluir um aplicativo de conexão para o Protheus e RM.
*Será apontado o Host de comunicação do protheus para o RM
*Utilizado coligadas por Empresa.
Criado um aplicativo para o próprio RM.
*Host do RM
*usuário de autenticação RM.
*aplicativo interno.
- Transações
Será configurado cada entidade que fará a comunicação entre os módulos.
*Suportado – forma de envio.
*mensagem síncrono.
*compartilhamento das tabelas.
- Anexos> versão.
Incluir.
Definir a versão que sera utilizada.
*de acordo com a versão XSD de mensagens homologadas. http://api.totvs.com.br/#/
- Rotas
Definição das Rotas de comunicação.
*Aplicativo - Apontar o aplicativo de comunicação
*Trasação – Rotina RM que sera comunicada.
*habilitação – Forma de envio
*Por padrão funcionários por parte do RM esta habilitado para somente recebimento.
- De/Para
Cadastramos o de/para por parte do RM, similares ao Protheus, referenciando as Coligadas.
Os passos a seguir devem se repetir para todas as coligadas e filiais.
Efetue o cadastramento do De-Para de Coligadas conforme imagem abaixo, substituindo os valores entre chaves com o valor correspondente pelo código da coligada.
Tabela RM: Fixo valor 'GCOLIGADA'
Chave Primária RM: Fixo valor 'CODCOLIGADA'
Valor Chave Primária RM: Código da coligada referente
Sistema Integrado: Fixo valor 'PROTHEUS'
Valor Chave Integração: Código da coligada referente (mesma do campo Valor Chave Primária RM)
Efetue o cadastramento do De-Para de Filiais conforme imagem abaixo, substituindo os valores entre chaves com o valor correspondente ao descrito internamente a ele.
Tabela RM: Fixo valor 'GFILIAL'
Chave Primária RM: Fixo valor 'CODCOLIGADA|CODFILIAL'
Valor Chave Primária RM: Código da coligada + '|' + Código da filial
Sistema Integrado: Fixo valor 'PROTHEUS'
Valor Chave Integração: Código do grupo de empresa do Protheus + '|' + Código completo da filial no Protheus (composto por Empresa + Filial)
- Gerenciamento de Mensagens (por parte do RM)
Acompanhamento das mensagens de entrada e saída.
Bem como, os dados da Mensagem, Rota e execução.
Âncora Controle de Versão / Suporte / Escopo Controle de Versão / Suporte / Escopo
Controle de Versão / Suporte / Escopo | |
Controle de Versão / Suporte / Escopo |
Controle de Versão
O grupo TOTVS, representado por suas marcas, irá administrar as demandas de evolução dos layouts e demais ajustes, acordando junto aos solicitantes o prazo de liberação de release.
Todas as evoluções programadas deverão ser discutidas e aprovadas pelas marcas antes do início do desenvolvimento e somente serão desenvolvidas em caso de concordância das marcas e alinhamento com as diretivas definidas pelo Comitê de Integração TOTVS.
Suporte
O suporte aos recursos da Integração será de responsabilidade de todas as linhas, sendo assim as equipes de suporte dos produtos BackOffice RM, Backoffice Protheus e SigaMNT estarão aptas a fazer a primeira análise e, quando necessário, repassar para a equipe mais adequada em cada caso.
Escopo
O escopo deste projeto se restringe aos processos de integração com o Protheus e os cadastros utilizados por estes.
Todos os processamentos de BackOffice se manterão no RM, sendo eles a geração de escrituração, relatórios, emissão de notas fiscais e outros.
Âncora Transações/Entidades/Mensagens Transações/Entidades/Mensagens
Transações/Entidades/Mensagens | |
Transações/Entidades/Mensagens |
Transações/Entidades/Mensagens únicas
Segue abaixo tabela com informações sobre as entidades trafegadas na integração.
Método | ID | Descrição | Origem | Destino | Mensagem Única | Versão da Mensagem | Fórmula Visual de Gatilho | Fórmula Visual de Carga de Dados |
Cadastros | 01 | Cliente/Fornecedor | RM | Protheus | CustomerVendor | 2.002 | MOVWKF0007 - CustomerVendor |
...
Transações/Entidades/Mensagens únicas
Segue abaixo tabela com informações sobre as entidades trafegadas na integração.
Método
ID
Descrição
Origem
Destino
Mensagem Única
Cadastros
02
Moeda
RM
Protheus
Currency
05
Centro de Custo
RM
Protheus
CostCenter
MOVWKF0019 - Sincronizacao_Total_SigaMNT |
02 |
Moeda | RM | Protheus |
Currency | 2.000 |
MOVWKF0006 - |
Currency | MOVWKF0019 - Sincronizacao_Total_SigaMNT |
03 |
Unidade de |
Medida | RM | Protheus |
UnitOfMeasure |
2.000 |
MOVWKF0017 - |
UnitOfMeasure | MOVWKF0019 - Sincronizacao_Total_SigaMNT |
04 |
20
Produto | RM |
Protheus |
Item |
Request
2.000 | MOVWKF0013 - Item | MOVWKF0019 - Sincronizacao_Total_SigaMNT |
05 |
Centro de Custo | RM | Protheus |
CostCenter |
2.000 | MOVWKF0005 - CostCenter | MOVWKF0019 - |
22
Sincronizacao_Total_SigaMNT | ||
06 | Ativo Fixo | RM |
Protheus |
Assets |
MaintenanceOrder
1. |
001 | MOVWKF0002 - Assets_InclusaoAlteracao | MOVWKF0019 - |
Sincronizacao_Total_SigaMNT | ||
07 | Transferência de Ativo Fixo | RM |
Protheus |
Assets | 1. |
001 | MOVWKF0003 - Assets_TransferenciaControle | - |
08 | Exclusão de Ativo Fixo |
RM | Protheus |
Assets | 1. |
001 |
MOVWKF0001 - |
Assets_ |
Delete | - |
09 | Cargo | RM |
Protheus |
EmployeePosition | 1.000 | MOVWKF0025 - Sincronização de Cargo, Função e Horário | MOVWKF0025 - |
Sincronização de Cargo, Função e Horário | ||
10 | Função | RM |
Protheus |
Role | 1. |
000 | MOVWKF0025 - Sincronização de Cargo, Função e Horário | MOVWKF0025 - |
Sincronização de Cargo, Função e Horário | |
11 | Horário |
RM | Protheus |
Shiftwork | 1. |
000 |
...
MOVWKF0025 - Sincronização de Cargo, Função e Horário | MOVWKF0025 - Sincronização de Cargo, Função e Horário | |||||||
12 | Funcionário | RM | Protheus | Employee | 2.001 | MOVWKF0008 - Employee | MOVWKF0019 - Sincronizacao_Total_SigaMNT | |
13 | Exclusão de Funcionário | RM | Protheus | Employee | 2.001 | MOVWKF0009 - Employee_Delete | - | |
14 | Projeto | RM | Protheus | Project | 2.000 | MOVWKF0016 - Project | MOVWKF0019 - Sincronizacao_Total_SigaMNT | |
15 | Obra | RM | Protheus | SubProject | 2.000 | MOVWKF0014 - Obra Etapa Tarefa | MOVWKF0019 - Sincronizacao_Total_SigaMNT | |
16 | Tarefa | RM | Protheus | TaskProject | 2.000 | MOVWKF0014 - Obra Etapa Tarefa | MOVWKF0019 - Sincronizacao_Total_SigaMNT | |
17 | Etapa | RM | Protheus | StepProject | 2.000 | MOVWKF0014 - Obra Etapa Tarefa | MOVWKF0019 - Sincronizacao_Total_SigaMNT | |
18 | Condição de Pagamento | RM | Protheus | PaymentCondition | 2.000 | MOVWKF0015 - PaymentCondition | MOVWKF0019 - Sincronizacao_Total_SigaMNT | |
19 | Local de Estoque | RM | Protheus | Warehouse | 1.000 | MOVWKF0018 - Warehouse | MOVWKF0019 - Sincronizacao_Total_SigaMNT | |
Processos | 20 | Solicitações (SA e SC) | Protheus | RM | Request | 1.000 | - | - |
21 | Cancelamento de SA/SC | Protheus | RM | CancelRequest | 1.000 | - | - | |
22 | Ordem de Serviço | Protheus | RM | MaintenanceOrder | 1.000 | - | - | |
23 | Finalizar OS | Protheus | RM | MaintenanceOrder | 1.000 | - | - | |
24 | Faturar OS | RM | Protheus | MaintenanceOrder | 1.000 | MOVWKF0010 - Faturamento_OS | - | |
25 | Cancelamento de OS | Protheus | RM | CancelMaintenanceOrder | 1.000 | - | - | |
26 | Baixa de estoque | Protheus | RM | StockTurnover | 1.002 | - | - | |
27 | Baixa de Estoque | RM | Protheus | StockTurnover | 1.002 | MOVWKF0004 - Baixa_Estoque | - | |
28 | Cancelar Baixa de Estoque | Protheus | RM | CancelRequest | 1.000 | - | - | |
29 | Consulta Saldos e Custos | Protheus | RM | StockLevel | 1.001 | - | - | |
30 | Apropriação de Custos | Protheus | RM | AppointmentCost | 1.000 | - | - | |
31 | Ampliação Patrimonial | Protheus | RM | AssetsValuation | 1.000 | - | - | |
32 | Análise técnica de pneus | Protheus | RM | StockTurnover | 1.001 | - | - | |
33 | Controle de Abastecimento | Protheus | RM | StockLevel | 1.001 | - | - | |
34 | Controle de Abastecimento | Protheus | RM | StockTurnover | 1.001 | - | - | |
35 | Controle de Abastecimento | Protheus | RM | Order | 3.002 | - | - | |
36 | Gestão de Documentos | Protheus | RM | Order | 3.002 | - | - | |
37 | Informação de Parcelas | RM | Protheus | InfoOfParcelValues | 1.000 | MOVWKF0012 - InfoOfParcelValues | - | |
38 | Gestão de Multas | Protheus | RM | Order | 3.002 | - | - | |
39 | Honorários de Despachante | Protheus | RM | Order | 3.002 | - | - | |
40 | Ordem de Serviço de Pneus | Protheus | RM | MaintenanceOrder | 1.000 | - | - | |
41 | Transferência de Pneus | Protheus | RM | StockTurnover | 1.002 | - | - | |
42 | Ordem de Serviço Terceiros | Protheus | RM | MaintenanceOrder | 1.001 | - | - |
Obs.: As Fórmulas visuais estão disponíveis na pasta de instalação do RM em (...CORPORERM/Objetos Gerenciais/Fórmulas Visuais)
Âncora Cadastros Cadastros
Cadastros | |
Cadastros |
Cadastros
Para esta integração todos os cadastros possuem sua origem no BackOffice RM, sendo enviados à retaguarda Protheus.
Cadastro de Centro de Custo
Identificador da Mensagem: CostCenter
Versão: 2.000
Mandatário: BackOffice RM
Tipo de Envio: Síncrono
Mapeamento de Campos: http://tdn.totvs.com/x/w9b0E
Notas:
Expandir | ||
---|---|---|
| ||
Os campos “Centro de Custo” e “Código Reduzido do Centro de Custo” no PROTHEUS deve ser alterado para tamanho de 20 caracteres, uma vez que no RM estes campos permitem até 25 caracteres. |
Cadastro de Cliente/Fornecedor
Identificador da Mensagem: CustomerVendor
Versão: 2.002
Mandatário: BackOffice RM
Tipo de Envio: Síncrono
Mapeamento de Campos: http://tdn.totvs.com/x/MYP6E
Notas:
Expandir | ||
---|---|---|
| ||
Ao iniciar uma base zerada do Protheus, para incluir a tabela de Municípios no Protheus é necessário acessar o Protheus no sistema 09 - Livros Fiscais. Se não acessar o sistema Fiscal do Protheus antes de enviar o cadastro do RM irá apresentar mensagem de inconsistência informando que é valor inválido para o campo Município. Uma vez que o Cliente e Fornecedor são tratados na mesma mensagem (CustomerVendor), é responsabilidade do destinatário ao processar a mensagem garantir a consistência dos dados na origem e no destino da melhor forma possível.Ou seja, se o destino implementa uma única tabela, terá que manipular apenas um registro e se implementa mais de uma tabela, terá que manipular quantos registros forem necessários. Para regras de negócio desta mensagem atenção ao seguinte ponto de atenção. Mesmo que a empresa não utilize Cliente/Fornecedor global no RM, deve-se compartilhar a tabela referente no Protheus por empresa. No Protheus o código do cliente/fornecedor será composto pelo código do cliente/fornecedor e da coligada, conforme a mascara “[CODCOLIGADA]|[CODCFO]”. |
Cadastro de Cargo
Identificador da Mensagem: EmployeePosition
Versão: 1.000
Mandatário: BackOffice RM
Tipo de Envio: Síncrono
Mapeamento de Campos: http://tdn.totvs.com/x/04P6E
Cadastro de Função
Identificador da Mensagem: Role
Versão: 1.000
Mandatário: BackOffice RM
Tipo de Envio: Síncrono
Mapeamento de Campos: http://tdn.totvs.com/x/7IP6E
Cadastro de Funcionário
Identificador da Mensagem: Employee
Versão: 2.001
Mandatário: BackOffice RM
Tipo de Envio: Síncrono
Mapeamento de Campos: http://tdn.totvs.com/x/9Yv6E
Notas:
Expandir | ||
---|---|---|
| ||
A informação de centro de custo é obtida a partir da seção do funcionário. Sendo assim, é necessário atentar ao cadastramento das seções, pois esta entidade ocupa no RM o mesmo nível hierárquico do centro de custo no Protheus. O cadastro de centros de custo do Labore (tabela PCCUSTO) deve trabalhar conforme o processo “Sincronização Centro de Custo Global”, que mantém o cadastro da tabela PCCUSTO espelhada com a tabela de centro de custo global (“GCCUSTO”). Para integrar a entidade Funcionário, o PROTHEUS exige que sejam cadastrados valores defaults para Banco/Agência/Conta. Estes registro devem ser cadastrados com o seguintes códigos abaixo: A exclusão de funcionário é executada via processo, assim sendo, caso haja algum erro na integração a exclusão não será desfeita, sendo necessário seguir o seguinte processo: Para que a exclusão seja efetuada com sucesso no Protheus é necessário executar o update “RHUPDMOD” no mesmo para normalizar a base de dados para integração. Serão integrados somente funcionários cujo Tipo de Recebimento for igual à Mensalista ou Semanalista. O rateio de funcionário por centro de custos não será integrado, pois o mesmo não é utilizado pelo sistema SigaMNT. Caso a chapa do funcionário no RM seja maior que 6 caracteres, este campo no PROTHEUS deve ser configurado como autoincremento. |
Âncora Links úteis de Refências Links úteis de Refências
Links úteis de Refências | |
Links úteis de Refências |
Links úteis de Refências
Abaixo, alguns links para visualização sobre a configuração validada em cliente para os mesmos cadastros citados nesta documentação.
Informações | ||
---|---|---|
| ||
Página: Mensagem Única - RH Protheus Página: Como Fazer - Configuração do Protheus para a Integração Mensagens de cadastro Mensagens de Processos Modelos mensagem única - XSD |
Como funciona a camada EAI.
Informações | ||
---|---|---|
| ||
Âncora Checklist de suporte da aplicação Checklist de suporte da aplicação
Checklist de suporte da aplicação | |
Checklist de suporte da aplicação |
Checklist de suporte da aplicação
Crie um check-list de verificação de alguns pontos importantes para o funcionamento e atendimento da integração.
Instalação/Configuração
Relacione itens de verificação para garantir que a integração está corretamente instalada e configurada. Isto não pode ser uma cópia do procedimento de instalação/configuração, mas verificações pontuais que podem remeter aos itens da instalação.
Checklist de Verificações:
Relacione itens de verificações para que o atendente possa:
Identificar o funcionamento da integração;
Identificar a ocorrências de problemas;
Coletar evidências do mau funcionamento relatado pelo cliente;
Realizar possíveis ajustes na integração quanto à configuração ou negócio.
...
...
Cadastros
Para esta integração todos os cadastros possuem sua origem no BackOffice RM, sendo enviados à retaguarda Protheus.
Cadastro de Centro de Custo
Identificador da Mensagem: CostCenter
Versão: 2.000
Mandatário: BackOffice RM
Tipo de Envio: Síncrono
Mapeamento de Campos: http://tdn.totvs.com/x/w9b0E
Notas:
Expandir | ||
---|---|---|
| ||
Os campos “Centro de Custo” e “Código Reduzido do Centro de Custo” no PROTHEUS deve ser alterado para tamanho de 20 caracteres, uma vez que no RM estes campos permitem até 25 caracteres. |
Cadastro de Cliente/Fornecedor
Identificador da Mensagem: CustomerVendor
Versão: 2.002
Mandatário: BackOffice RM
Tipo de Envio: Síncrono
Mapeamento de Campos: http://tdn.totvs.com/x/MYP6E
Notas:
Expandir | ||
---|---|---|
| ||
Ao iniciar uma base zerada do Protheus, para incluir a tabela de Municípios no Protheus é necessário acessar o Protheus no sistema 09 - Livros Fiscais. Se não acessar o sistema Fiscal do Protheus antes de enviar o cadastro do RM irá apresentar mensagem de inconsistência informando que é valor inválido para o campo Município. Uma vez que o Cliente e Fornecedor são tratados na mesma mensagem (CustomerVendor), é responsabilidade do destinatário ao processar a mensagem garantir a consistência dos dados na origem e no destino da melhor forma possível.Ou seja, se o destino implementa uma única tabela, terá que manipular apenas um registro e se implementa mais de uma tabela, terá que manipular quantos registros forem necessários. Para regras de negócio desta mensagem atenção ao seguinte ponto de atenção. Mesmo que a empresa não utilize Cliente/Fornecedor global no RM, deve-se compartilhar a tabela referente no Protheus por empresa. No Protheus o código do cliente/fornecedor será composto pelo código do cliente/fornecedor e da coligada, conforme a mascara “[CODCOLIGADA]|[CODCFO]”. |
Cadastro de Cargo
Identificador da Mensagem: EmployeePosition
Versão: 1.000
Mandatário: BackOffice RM
Tipo de Envio: Síncrono
Mapeamento de Campos: http://tdn.totvs.com/x/04P6E
Cadastro de Função
Identificador da Mensagem: Role
Versão: 1.000
Mandatário: BackOffice RM
Tipo de Envio: Síncrono
Mapeamento de Campos: http://tdn.totvs.com/x/7IP6E
Cadastro de Funcionário
Identificador da Mensagem: Employee
Versão: 2.001
Mandatário: BackOffice RM
Tipo de Envio: Síncrono
Mapeamento de Campos: http://tdn.totvs.com/x/9Yv6E
Notas:
Expandir | ||
---|---|---|
| ||
A informação de centro de custo é obtida a partir da seção do funcionário. Sendo assim, é necessário atentar ao cadastramento das seções, pois esta entidade ocupa no RM o mesmo nível hierárquico do centro de custo no Protheus. O cadastro de centros de custo do Labore (tabela PCCUSTO) deve trabalhar conforme o processo “Sincronização Centro de Custo Global”, que mantém o cadastro da tabela PCCUSTO espelhada com a tabela de centro de custo global (“GCCUSTO”). Para integrar a entidade Funcionário, o PROTHEUS exige que sejam cadastrados valores defaults para Banco/Agência/Conta. Estes registro devem ser cadastrados com o seguintes códigos abaixo: A exclusão de funcionário é executada via processo, assim sendo, caso haja algum erro na integração a exclusão não será desfeita, sendo necessário seguir o seguinte processo: Para que a exclusão seja efetuada com sucesso no Protheus é necessário executar o update “RHUPDMOD” no mesmo para normalizar a base de dados para integração. Serão integrados somente funcionários cujo Tipo de Recebimento for igual à Mensalista ou Semanalista. O rateio de funcionário por centro de custos não será integrado, pois o mesmo não é utilizado pelo sistema SigaMNT. Caso a chapa do funcionário no RM seja maior que 6 caracteres, este campo no PROTHEUS deve ser configurado como autoincremento. |
...
Processos
...
Checklist de suporte da aplicação
Crie um check-list de verificação de alguns pontos importantes para o funcionamento e atendimento da integração.
Instalação/Configuração
Relacione itens de verificação para garantir que a integração está corretamente instalada e configurada. Isto não pode ser uma cópia do procedimento de instalação/configuração, mas verificações pontuais que podem remeter aos itens da instalação.
Checklist de Verificações:
Relacione itens de verificações para que o atendente possa:
Identificar o funcionamento da integração;
Identificar a ocorrências de problemas;
Coletar evidências do mau funcionamento relatado pelo cliente;
Realizar possíveis ajustes na integração quanto à configuração ou negócio.
O intuito deste manual e validar a integração do Ambiente RM X Protheus via envio de mensagem única EAI.
Passo 1: Instalar uma base de dados RM
a) Executar o setup Base de Dados SQL - 12.1.17.msi b) No caminho apontado no setup da base, usar o arquivo exemplo “.bak”. c) Caminho: C:\TOTVS\CorporeRM\BaseDados\SQL\EXEMPLO12117. d) No SQL, restaurar o arquivo exemplo.
e) Apontar o arquivo. bak no dispositivo de origem.
Passo 2: Instalar Biblioteca RM
a) Executar o setup BibliotecaRM - 12.1.17.msi b) Seguir os passos a passos padrões do assistente. c) Avançar e aceitar os termos de uso. d) Marcar opção de Usuário (aceitar todos usuários da máquina). e) Criar uma pasta padrão no “C: TOTVS/CorporeRM” e apontar a instalação nela. f) A instalação padrão incluirá o RM.Host.Service.exe na lista de serviços do Windows, com start automático na porta padrão 8050.
OBS: Ver passo para configuração de Host.
g) Além do serviço, e possível subir o host do ambiente RM pelo executável RM.HOST.EXE (na pasta C:\TOTVS\CorporeRM\RM.Net). h) Neste ponto o RM.EXE já pode ser executado.
Ø Configurando Host RM:
i) Editar os arquivos de configuração de Host para comunicação do XML entre sistemas. j) Replicar as alterações de Host do RM.HOST.SERVICE.EXE.CONFIG para o arquivo RM.HOST.EXE.CONFIG (caso suba o ambiente pelo executável)
Ø Seguir o seguinte modelo para configuração do Host RM:
<?xml version="1.0" encoding="utf-8"?> <configuration> <appSettings> <add key="JobServer3Camadas" value="false" /> <add key="Port" value="8050" /> <add key="Host" value="SPON010108074" /> <add key="SERVICESHOSTNAME" value="SPON010108074" /> <add key="HTTPPort" value="8051" /> <add key="ActionsPath" value="C:\totvs\CorporeRM\RM.Net;C:\totvs\CorporeRM\Corpore.Net\Bin" /> <add key="LibPath" value="C:\totvs\CorporeRM\RM.Net" /> <add key="EnableDynamicLocalization" value="false" /> <add key="EnableCompression" value="false" /> <add key="LocalizationLanguage" value="pt-BR" /> <add key="defaultdb" value="CorporeRM" /> <add key="FrameHTMLUser" value="mestre" /> <add key="FrameHTMLPassword" value="totvs" /> </appSettings> <runtime> <gcServer enabled="true" /> </runtime> </configuration>
Ø Check: 1. Checar as tags marcadas em negrito conforme configuração local. 2. Usuário e senha de acordo com usuário administrador do RM 3. Definir uma httpporta diferente para o serviço e host pelo executável.
Ø Após subir o ambiente, verificar o acesso ao Host no browser de internet.
http://localhost:8051/wspageindex/
*Criação feita em ambiente local, alterar “localhost” para local especifico. O restante refere-se aos métodos default.
Será utilizado o método EAI SERVICE para comunicação com o Protheus.
Passo 3: Ambiente Protheus
Neste passo, vamos realizar a configuração HTTP por parte do Protheus, bem como configurar os Adapters e Rotas para comunicação com RM via EAI.
a) Utilizar um ambiente Protheus existente b) Na pasta bin, editar o arquivo appserver.ini
Ø Incluir o seguinte bloco para conexão web service Protheus:
;================== webservice ======================== [HTTP] ENABLE=1 PORT=12001 ;definir porta para http Protheus PATH=\web\WS ENVIRONMENT=p12117 ;ambiente RESPONSEJOB=JOB_WS_0101
;webservice para o MU usando o nome
[LOCALHOST:12001] ;webservice para o MU ENABLE=1 ;PATH=M:\Protheus11\web\WS ENVIRONMENT=p12117 INSTANCENAME=JOB_WS_0101 RESPONSEJOB=JOB_WS_0101 DEFAULTPAGE=wsindex.apw
[JOB_WS_0101] ;webservice para o MU TYPE=WEBEX ENVIRONMENT=p12117 INSTANCES=1,10 SIGAWEB=JOB_WS_0101 INSTANCENAME=JOB_WS_0101 ONSTART=__WSSTART ONCONNECT=__WSCONNECT XMLSAVEALL=1 namespace=http://www.totvs.com.br/rm/ trace=1 ;WEBSERVICELocation=http://SPOD2896:86 ;URLLocation=http://SPOD2896:86 ;WEBSERVICELocation=http://SPON5101:81 ;URLLocation=http://SPON5101:81
c) Subir o serviço ambiente Protheus. d) Verificar acesso ao Host no caminho: http://localhost:12001/ e) Será utilizado o método EAI SERVICE: http://localhost:12001/EAISERVICE.apw?WSDL
Exemplo: http://localhost:12001/EAISERVICE.apw?WSDL
f) Abrir o Protheus via SmartClient utilizando SIGACFG. g) Verificar e configurar os seguintes parâmetros:
1. MV_EAIURL2 2. MV_EAIMETH 3. MV_EAIUSER 4. MV_EAIPASS 5. MV_EAIPORT
Host do RM configurado:
Método padrão:
Usuário RM:
Senha RM:
Porta padrão:
h) Ainda no SIGACFG, acessar a rotina de Schedule e realizar os seguintes cadastros:
1. Cadastro de Rotas EAI (será feita uma única vez) 2. Adapter EAI (É feita para cada rotina integrada ao RM) 3. Schedule (verificação futura do monitor de comunicação de EAI entre os sistemas. 4. Emp. Filial Mensagem Única (de para de empresas para referência ao RM)
Ø Cadastro de Rotas EAI
Seguir as seguintes informações.
*URL (Método Host do RM – Service EAI RM) *Usuário e senha RM *Cliente WS e método (padrão)
Ø Adapter EAI
Seguir as seguintes informações.
*Mensagem única – Sim *Rotina a ser integrada (exemplo clientes) *Envia mensagens – Sim *Recebe mensagem - Sim *Método - Síncrono *Canal de envio – EAI *Versão de envio (de acordo com RM) *Rota padrão (de acordo com parâmetros) *Roteamento de mensagens – Apontar Rota e envia – Sim.
Adapter para Funcionários.
*atenção na versao de envio utilizada.
Acessando http://api.totvs.com.br/#/ , é possivel veriricar a lista de servicos referentes a integração bem como as entidades (transactionID) e as versoes liberadas referentes ao RM, no menu > mensagem padronizada.
Ø Emp. Filial Mensagem Única(De/para)
Seguir as seguintes informações.
Será feita a referencia de empresas ao RM. *empresa/filial – referentes a RM. *grupo empresa/Filial Protheus - referentes a RM.
Ø Exemplo de monitoramento EAI.
É pilhado as execucoes de envio das mensagens únicas.
*clicando na lupa, e possivel ver o log de execução das mensagens.
Passo 4: Abrir RM
Utilizado um usuário padrão de testes.
Usuário: mestre Senha: totvs
Para primeiro acesso deve ser configurado o alias clicando no botão ao lado.
Ø Ver permissões:
Menu > Serviços globais > ver permissões em perfis e Usuário
Ø Acessar guia segurança.
Opção Perfis.
Neste caso, o usuário possui perfis de acesso DBA e DP.
Criar um perfil adicional
Exemplo Perfil mestre:
Clicar em incluir.
Identificação:
Nesta parte e possível delegar acessos a campos e menus.
*Verificar com o Administrador do RM, o acesso as rotinas que serão integradas leitura e gravação e também a opção de Integrações do menu.
*permitido acesso a todos serviços para o usuário Mestre.
Ø Opção Usuários.
Localizar e editar o usuário.
Identificação:
Associar os perfis, na aba Segurança:
Ø Menu Integração
Acessar a guia EAI 2.0
Nesta área, será feita a configuracao dos seguintes itens:
- Aplicativos - Transações - Rotas (Transação/App) - De/Para
Ø Aplicativos
Incluir um aplicativo de conexão para o Protheus e RM.
|
*Será apontado o Host de comunicação do protheus para o RM *Utilizado coligadas por Empresa.
|
Criado um aplicativo para o próprio RM.
*Host do RM
*usuário de autenticação RM.
*aplicativo interno.
Ø Transações
Será configurado cada entidade que fará a comunicação entre os módulos.
*Suportado – forma de envio.
*mensagem síncrono.
*compartilhamento das tabelas.
Anexos> versão.
Incluir.
Definir a versão que sera utilizada.
*de acordo com a versão XSD de mensagens homologadas. http://api.totvs.com.br/#/
Ø Rotas
Definicao das Rotas de comunicação.
*Aplicativo - Apontar o aplicativo de comunicação
*Trasação – Rotina RM que sera comunicada.
*habilitação – Forma de envio
...