Histórico da Página
Integração Backoffice Protheus x TOTVS Hospitalar
2. Sistemas Envolvidos
3. Integração
4. Escopo
5. Pré-requisitos instalação/implantação/utilização
5.1. Protheus
5.2. RM
6. Instalação/Atualização
6.1. Protheus
6.1.1. Cadastrar/Configurar Adapter para Integração no Protheus
6.1.2. Configurar o EAI para Integração no Protheus
6.1.2.1. Cadastrar Agent
6.1.2.2. Cadastrar Agendamento
6.1.2.3. EAI – Como visualizar os arquivos XML criados pelas rotinas
6.1.2.4. Limpar Histórico de Mensagens
6.1.2.5. Configurar Parâmetros da Integração
6.2. RM
6.2.1. Pré-requisitos
6.2.2. Instalar os WebServices de Integração (TBC)
6.2.3. Instalar a Biblioteca RM
6.2.4. Configurar a Integração
6.2.5. Requisitos Básicos da integração
6.2.6. Parametrizar a integração
6.2.6.1. Primeira parte – Identificação
6.2.6.2. Segunda parte – (Anexo) Mapeamento de Entidades
6.2.6.3. Terceira parte – (Anexo) Parâmetros
6.2.6.4. Configuração de-para de Coligada e Filial
6.2.6.5. Fórmulas Visuais
6.2.6.6. No RMSaude.exe
6.2.6.7. Definição de Integração em Sistemas da linha RM
6.3. EAI – Fila de Mensagens Únicas
7. Controle de Versão
8. Suporte
9. Transações/Entidades/Mensagens únicas
10. Fluxo das Informações
10.1. Cadastros
10.1.1. Empresa / Filial
10.1.2. Banco
10.1.3. Centro de Custo
10.1.4. Moeda
10.1.5. Cliente/Fornecedor
10.1.6. Família de Materiais
10.1.7. Produto/Serviço
10.1.8. Condição de pagamento
10.1.9. Unidade de medida
10.1.10. Local de Estoque
10.2. Processos
10.2.1. Título a pagar
10.2.2. Título a receber
10.2.3. Baixa de títulos
10.2.4. Cancelamento de Baixa de títulos
10.2.5. Inventário
10.2.6. Nota fical de entrada
10.2.7. Pedido de venda
10.2.8. Saldo em estoque
10.2.9. Movimentação de estoque
10.2.10. Transferência
11. Checklist de suporte da aplicação
Introdução
Este documento tem por objetivo reunir todas as informações relevantes sobre a Integração do BackOffice Protheus x TOTVS Hospitalar (RM Saúde).
...
- Premissas
- Esta solução deve primar pela simplicidade e facilidade de uso, facilidade de manutenção e facilidade de atualização.
- Deve respeitar os sistemas operacionais utilizados pelas soluções software das marcas: WINDOWNS
- Utilizar o Protheus versão 11.7 (e patchs específicos para esta integração) e o RM versão 11.82 (último patch disponível). Observação: Ambos utilizam o modelo de licenciamento TOTVS padrão (Licence Server).
- Bancos de dados homologados: SQL Server 2005 ou 2008 e Oracle 10g ou 11g.
- Se o cliente já possui base de dados implantada do RM ou do Protheus será responsabilidade da equipe de implantação efetuar a carga inicial e/ou sincronismo dos cadastros. A integração irá efetuar o sincronismo automático de novos registros ou alterações posteriores à ativação da integração.
- Por padrão, todos os cadastros mantidos pelo Backoffice Protheus deverão ser desabilitados (manualmente) no controle de segurança do RM. Exceções serão destacadas ao longo do documento.
...
- Na tela de transações são exibidas as mensagens que foram geradas.
- Para visualizar o arquivo XML criado pela mensagem, clique na linha da mensagem e em seguida clique na Lupa azul que se encontra na parte superior da tela, será aberto o arquivo XML no browser do Internet Explorer.
- Ao clicar na linha da Mensagem, na tela de Eventos da Tarefa podem ser exibidas as seguintes informações de acordo com o status da mensagem:
- Início de Processamento.
- Falhas.
- Processo Interrompido.
- Fim de Processamento.
- Nota:
Para identificar a Cor da Legenda com o tipo de mensagem, clique duas vezes na bolinha colorida que será exibida a tela de legenda com a identificação do tipo com a Cor.
...
- Nome Integração: Este é um campo meramente informativo, recomendamos uma descrição curta, mas clara, para este pacote de integração. Por padrão este nome já vem preenchido como: TOTVS Hospitalar x BackOffice Protheus.
- Nome Reduzido: Também é um campo apenas informativo, insira um bem curto. Por padrão vem preenchido como: THPROT.
- Sistema Integrado: Informe PROTHEUS. Este é um mnemônico que identifica a aplicação de origem e será enviado no atributo "name" da tag <Product> no XML trafegado.
- URL WebService: Informe o endereço do WebService Protheus para envio de mensagens. Utilize o formato http://\[servidor\]:\[porta\]/EAIService.apw . Para verificar se o WS Protheus está disponível digite o endereço do mesmo no seu navegador (no formato http://\[servidor\]:\[porta\]), na página apresentada procure pelo texto EAISERVICE).
- Usuário Autenticação: Informe o nome do usuário para autenticação pelo WebService Protheus.
- Senha Autenticação: Informe a senha para autenticação pelo WebService Protheus.
Segunda parte – (Anexo) Mapeamento de Entidades
...
Segunda parte – (Anexo) Mapeamento de Entidades
...
É possível realizar um mapeamento de cada entidade (cada mensagem única) que faz parte do pacote de integração.
O script de Configuração irá fazer o mapeamento padrão automaticamente. Alterações só devem ser feitas com critério. Caso seja necessário acrescentar uma entidade à integração que não esteja no pacote padrão, clique em Anexos e escolha "Mapeamento de Entidades". Na tela que é apresentada informe o código ou nome da mensagem. Clique no botão reticências (...) para localizar a mensagem na lista de mensagens pré-cadastradas.
...
...
Terceira parte – (Anexo) Parâmetros
Aqui estão disponíveis os parâmetros utilizados na integração. Este parâmetro já vem preenchidos pelo script de inicialização. Os parâmetros de tipo de movimento não devem ser alterados. Já os parâmetros TIPOSAIDAPEDIDOVENDA, TIPODOCMOVFATURA, TIPODOCFOLHAPAGTO, SERIEDOCMOVFATURA e SERIEDOCFOLHAPAGTO devem ser alterados para os valores de cada cliente.
...
- TMVDEVOLUCAOCC: tipo de movimento do Nucleus utilizado nas movimentações de devolução para centro de custo
- TMVDEVOLUCAO: tipo de movimento do Nucleus utilizado nas movimentações de devolução
- TMVBAIXA: tipo de movimento do Nucleus utilizado nas movimentações de baixa de estoque. Requisições para paciente, prescrição
- TIPOSAIDAPEDIDOVENDA: código do tipo de saída do Protheus para emissão de pedidos de venda
- TIPODOCMOVFATURA: tipo de documento do Protheus utilizado para o envio de título a receber, relacionado ao movimento de fatura
- TIPODOCFOLHAPAGTO: tipo de documento do Protheus utilizado para o envio de título a receber relacionado ao movimento de folha de pagamento
- SERIEDOCMOVFATURA: série utilizada para enviar o título a receber para o Protheus
- SERIEDOCFOLHAPAGTO: série utilizada para enviar o título a pagar para o Protheus
...
Configuração de-para de Coligada e Filial
Acesse RM.exe / Segmento Integrações / Aba Integração / Mensagem Única / De-Para.
Inclua o registro de correspondência entre os códigos das empresas do Protheus com as coligadas do RM conforme imagem.
Faça o mesmo procedimento para as filiais.
...
Fórmulas Visuais
Realize a importação das fórmulas visuais necessárias para a integração de convênios, prestadores, produtos e grupos de estoque.
...
- Após isso acesse o RM.exe / Segmento Saúde / Gestão Hospitalar / Gestão / Fórmula Visual.
- Em Fórmula visual execute o processo Importação de Fórmula visual.
- Clique em Adicionar Objetos.
- Selecione o arquivo IntegracaoProtheus.TotvsWF.
- Na página Seleção de Coligadas, deixa a Coligada Atual.
- Para cada fórmula e necessário informar na página Parâmetros a categoria cadastrada anteriormente e marcar a opção Importar Gatilho.
...
No RMSaude.exe
- Acesse o menu Opções/Parâmetros/Parâmetros de integração.
...
- A filial de integração é necessária para enviar para qual filial o cliente/fornecedor pertence.
- A quantidade de dias é utilizada para o cálculo de vencimento do pagamento a prestadores.
- A forma de baixa é necessária para informar o tipo de baixa que será feita durante a integração de recebimento de valores das faturas.
...
Definição de Integração em Sistemas da linha RM
- No RM.exe, acesse Ambiente / Parâmetros / Integrações de Sistemas.
- Localize o registro abaixo e marque o campo Integrado. Isso fará com que alguns cadastros compartilhados sejam acessíveis no RM Saúde.
...
EAI – Fila de Mensagens Únicas
- Acesse RM.exe / Segmento Integrações / Aba Integração / Mensagem Única / Fila de mensagens únicas.
- Nesta tela serão registradas as informações de envio e recebimento de mensagens XML trafegadas pela integração.
- Para ver mais detalhes da mensagem trafegada de um duplo clique no registro, para detalhes de execução (erro ou sucesso) selecione o registro e clique em Anexos / Informações de execução de mensagem, neste anexo é possível visualizar a mensagem de resposta.
Dados da mensagem trocada entre o RM e o Protheus
Detalhes da execução da mensagem. O campo Mensagem transformada corresponde ao xml que foi enviado para o outro EAI e o campo Mensagem de resposta corresponde ao xml que o outro EAI retornou mediante ao xml recebido.
...
...
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 TOTVS Hospitalar (RM Saúde) e Backoffice Protheus estarão aptas a fazer a primeira análise e, quando necessário, repassar para a equipe mais adequada em cada caso.
Nota: a versão atualizada deste fluxo pode ser consultada no TDN (TOTVS Developer Network), acesse o caminho http://tdn.totvs.com, faça o login e acesse Qualidade de Software Corporativa / Metodologia de Desenvolvimento de Produtos TOTVS / Processo de Sustentação / Subprocesso de Suporte Técnico / Fluxo de Integração de Produtos.
...
Integração de Produtos.
Transações/Entidades/Mensagens únicas
Método | ID |
|
| Descrição |
| Origem | Destino | XSD (versões podem variar) | |
|
| 01 | Local de estoque |
| Protheus |
| RM | Warehouse_1_000.xsd |
|
|
| 02 | Cliente-Fornecedor |
| Protheus |
| RM | CustomerVendor_2_002.xsd |
|
|
| 03 | Família |
| RM |
| Protheus | Family_2_000.xsd |
|
|
| 04 | Moeda |
| Protheus |
| RM | Currency_2_000.xsd |
|
|
| 05 | Condição de pagamento |
| Protheus |
| RM | PaymentCondition_2_000.xsd |
|
|
| 06 | Banco |
| Protheus |
| RM | Bank_2_000.xsd |
|
|
| 07 | Centro de Custo |
| Protheus |
| RM | CostCenter_2_000.xsd |
|
|
| 08 | Produto |
| RM |
| Protheus | Item_2_001.xsd |
|
|
| 09 | Unidade de Medida |
| Protheus |
| RM | UnitOfMeasure_2_000.xsd |
|
|
| 10 | Coligada*
|
|
|
|
|
|
|
|
| 11 | Filial*
|
|
|
|
|
|
|
|
| 12 | Prestadores |
| RM |
| Protheus | CustomerVendor_2_002.xsd |
|
|
| 13 | Convênios |
| RM |
| Protheus | CustomerVendor_2_002.xsd |
|
|
| 14 | Título a receber |
| RM |
| Protheus | AccountReceivableDocument_3_000.xsd |
|
|
| 15 | Título a pagar |
| RM |
| Protheus | AccountPayableDocument_2_000.xsd |
|
|
| 16 | Baixa de títulos |
| RM |
| Protheus | AccountReceivableDocumentDischarge_2_000.xsd |
|
|
| 17 | Cancelamento de baixa |
| RM |
| Protheus | ReversalOfAccountReceivableDocumentDischarge_2_000.xsd |
|
|
| 18 | Nota fiscal de entrada |
| Protheus |
| RM | Invoice_3_001.xsd |
|
|
| 19 | Saldo |
| RM |
| Protheus | STOCKLEVEL_1_000.xsd |
|
|
| 20 | Movimentação de estoque |
| RM/ Protheus |
| Protheus/ RM | STOCKTURNOVER_1_003.xsd |
|
|
| 21 | Transferências |
| RM/ Protheus |
| Protheus/ RM | TRANSFERWAREHOUSE_1_001.xsd |
|
|
| 22 | Inventário |
| Protheus |
| RM | INVENTORY_1_000.xsd |
|
|
| 23 | Pedido de venda |
| RM |
| Protheus | ORDER_3_002.xsd |
|
...
...
Fluxo das Informações
O fluxo básico desta integração está em definir a origem da informação, enviar para o EAI da linha do produto e este se comunica com o EAI da outra linha. Ambos os produtos possuirão as mesmas informações, porém podem possuir códigos diferentes. Cada sistema possui uma tabela de de-para onde são armazenados os códigos de origem e os códigos de destino e a entidade correspondente. Com isso, cada sistema envia o seu código e o outro sistema faz a troca assim que receber a mensagem. Abaixo serão detalhados cada entidade envolvida nesta integração.
...
...
Cadastros
Os cadastros são a base da integração entre os sistemas. Foi definido o sistema de origem para cada cadastro, portanto qualquer alteração nesta origem pode impactar na integração padrão. A alteração de sistema de origem impacta na configuração da mensagem utilizada em ambos os sistemas e pode envolver algum tipo de desenvolvimento, seja uma fórmula visual, um complemento na mensagem na parte de envio ou recebimento da mensagem, no caso da linha RM.
...
Empresa / Filial
É o primeiro cadastro que deve ser realizado nesta integração. No RM esta entidade é um cadastro comum. Mas no Protheus a Empresa é definida no Arquivo Sigamat.emp que fica no System do ambiente do Protheus e não faz parte de uma tabela de banco de dados. Este é o arquivo que permite à empresa utilizar o sistema. Isto faz parte da implantação do Protheus padrão.
Este cadastro deverá ser feito manualmente no Protheus e no RM, e depois configurar o "de/para" de integração correspondente (RM e Protheus possuem interfaces específicas para este fim). Neste caso, não será utilizada nenhuma mensagem para o sincronismo deste cadastro.
O cadastro de filial também deve ser feito manualmente na tabela de "de-para" de integração.
De-para RM (Empresa) |
|
| De-Para Protheus (Empresa)/(FILIAL) |
|
Tabela RM | GCOLIGADA | Referência |
| RM |
Chave Primária RM | CODCOLIGADA | Company |
| <Valor da Empresa RM> |
Valor Chave Primária RM | <Valor CODCOLIGADA> | Branch |
| <Valor da Coligada RM> |
Sistema Integrado | PROTHEUS | Emp. Protheus |
| <Empresa do Protheus> |
Valor Chave Integração | < Valor recebido pelo InternalId > | Fil.Protheus |
| <Filial do Protheus> |
...
Banco
O cadastro de bancos, agências e conta caixa devem ser cadastrados somente no BackOffice Protheus através do módulo SIGAFIN. Esta informação é utilizada somente na integração financeira quando se deve informar a conta caixa no processo de baixa.
Identificador da Mensagem: BANK
Versão: 2.000
Módulo RM: BackOffice – Gestão Contábil
Módulo Protheus: SIGAFIN
Tipo de Envio: Síncrono.
Mensagem Padrão | PROTHEUS |
| RM |
|
| Tabela | Campo | Tabela | Campo |
Code | SA6010 | A6_CODE | GBANCO | NUMBANCO |
Name | SA6010 | A6_NOME | GBANCO | NOME |
ShortName | SA6010 | A6_NREDUZ | GBANCO | NOMEREDUZIDO |
Febraban | SA6010 | A6_NUMBCO | GBANCO | NUMEROOFICIAL |
Code | SA6010 | A6_CODE | GAGENCIA | NUMBANCO |
Agency/Number | SA6010 | A6_AGENCIA | GAGENCIA | NUMAGENCIA |
Address/Number |
|
| GAGENCIA | NUMERO |
Address/Complement | SA6010 | A6_END | GAGENCIA | COMPLEMENTO |
Address/City/Description | SA6010 | A6_MUN | GAGENCIA | CIDADE |
Address/State/Code | SA6010 | A6_EST | GAGENCIA | ESTADO |
Address/District | SA6010 | A6_BAIRRO | GAGENCIA | BAIRRO |
Address/ZIPCode | SA6010 | A6_CEP | GAGENCIA | CEP |
ContactInformation/ CommunicationInformation/PhoneNumber | SA6010 | A6_TEL | GAGENCIA | TELEFONE |
Account/Number |
|
| FCONTA | NROCONTA |
CompanyId |
|
| FCONTA | CODCOLIGADA |
CompanyId |
|
| FCXA | CODCOLIGADA |
Account/Number |
|
| FCXA | CODCXA |
- |
| concat('Conta Caixa - ',Number) | FCXA | DESCRICAO |
CompanyId |
|
| FCXA | CODCOLPROP |
CompanyId |
|
| FCXA | CODCOLCONTA |
...
Centro de Custo
Os Centros de Custos devem ser cadastrados somente no BackOffice Protheus através do SIGACTB (Atualizações / Entidades / Custos) e serão sincronizados automaticamente para o RM.
Identificador da Mensagem: COSTCENTER
Versão: 2.000
Módulo RM: BackOffice – Gestão de Estoque, Compras e Faturamento /Cadastros / Centro de Custo
Módulo Protheus: SIGACTB
Tipo de Envio: Síncrono.
...
Notas:
RM: Deve-se definir a máscara do código do centro de custo. O código no Protheus é um campo livre, podendo assim enviar um valor que o RM não possa aceitar, o RM faz a validação do código do Protheus de acordo com a máscara e retorna um erro quando existir.
A tag <SPED> da mensagem única é do tipo boolean (true/false) que será gravado no campo "SPED" do RM os valores "T" para true e "F" para false.
A tag <RegisterSituation> da mensagem única é um Enumerado (Active/Inactive) que será gravado no campo "ATIVO" os valores "T" para Active e "F" para Inactive.
A tag <Class> será gravada no campo "PERMITELANCAMENTO". Quando o valor da tag for 1 (Sintético) será gravado 0, se o valor da tag for 2 (Analítico) será gravado 1.
Importante:
Após cadastrar os centros de custos, acessar o RMSaude.exe / Opções / Parâmetros / Funções Automáticas, cadastrar a função Importação de Centro de Custo, definir um período, salvar e em seguida clicar no botão Executa.
...
Moeda
As Moedas devem ser cadastrados somente no BackOffice Protheus através do SIGACTB (Atualizações / Cadastros / Moedas Contábeis) e serão sincronizados automaticamente para o RM.
Não é permitido alterar o símbolo de uma moeda já cadastrada.
Identificador da Mensagem: CURRENCY
Versão: 2.000
Módulo RM: BackOffice – Gestão de Estoque, Compras e Faturamento /Cadastros / Financeiro / Moedas e Índices
Módulo Protheus: SIGACTB
Tipo de Envio: Síncrono.
...
Mensagem Padrão | PROTHEUS |
| RM |
| |
|
| Tabela | Campo | Tabela | Campo |
Code | SAH | AH_UNIMED | TUND | CODUND | |
InternalId | SAH | Empresa/AH_FILIAL/ AH_UNIMED | HCINTEGRACAOID | IDINTEGRACAO | |
Description | SAH | AH_DESCPO | TUND | DESCRICAO | |
|
|
| TUND | CODUNDBASE | |
|
|
| TUND | FATORCONVERSAO |
Notas:
No Protheus a unidade de medida é um cadastro por empresa e no RM o cadastro de unidade de medida é um cadastro compartilhado, para solucionar esse caso as unidades de medida com mesmo símbolo no Protheus irão apontar para uma mesma unidade de medida do RM
No RM deve ser informada uma Unidade Base, porém não temos esta informação no Protheus, desta forma, este campo será preenchido com o valor do campo <Code>.
O campo "FATORCONVERSAO" receberá sempre o valor 1, pois a Unidade Base será sempre o mesmo código da Unidade Principal.
...
Local de Estoque
Os Locais de Estoque devem ser cadastrados somente no BackOffice Protheus no SIGACOM (Atualizações / Cadastros / Locais de Estoque) e sincronizados automaticamente para o RM através de mensagem única.
Identificador da Mensagem: WAREHOUSE
Versão: 1.000
Módulo RM: BackOffice – Gestão de Estoque, Compras e Faturamento /Cadastros / Local de Estoque
Módulo Protheus: SIGACOM
Tipo de Envio: Síncrono
...
Tipo de Fluxo: RM Protheus
Mensagem: ACCOUNTRECEIVABLEDOCUMENTDISCHARGE
Versão: 2.000
A baixa de títulos é realizada nas faturas dos convênios. Após gerado o movimento de fatura e consequentemente gerado no Protheus o título a receber, basta acessar o menu Tesouraria/Controle de Recebimentos, página inferior Fatura, subpágina Fatura. Informe a competência, o convênio e a unidade de faturamento e clique no botão Pesquisar. Selecione a fatura desejada, clique na subpágina Recebimentos e inclua o valor recebido. Neste momento é solicitada a conta-caixa deste recebimento e a baixa será efetuada no Protheus.
...
...
Cancelamento de Baixa de títulos
Tipo de Fluxo: RM Protheus
Mensagem: REVERSALOFACCOUNTRECEIVABLEDOCUMENTDISCHARGE
Versão: 2.000
O cancelamento de baixa de títulos deve ser realizado quando o valor informado está incorreto ou algum outro motivo que leve a exclusão do recebimento. Feito isso, a baixa associada será excluída no Protheus.
...
Tipo de Fluxo: RM Protheus e Protheus RM
Mensagem: STOCKTURNOVER
Versão: 1.003
Esta mensagem é utilizada em toda movimentação que envolve mudança de saldo no estoque. Tanto as Âncora
Devolução
...