Escolar Documentos
Profissional Documentos
Cultura Documentos
DocumentoIntegracao ProtheusXTIN
DocumentoIntegracao ProtheusXTIN
x BackOffice Protheus
23/07/2012 Wilson Possani de Godoi, Reynaldo Tetsu Miyashita, Viviane Torres Reviso 2
SUMRIO
Este documento tem por objetivo reunir as informaes relevantes sobre a Integrao do BackOffice Protheus e
TOTVS Incorporao (TIN).
A integrao respeita todos os pr-requisitos definidos pelas linhas de produto TOTVS envolvidos. Para mais
detalhes sobre configurao de hardware recomendada, sistema operacional, bancos de dados suportados e
demais dados, consulte os seguintes documentos no TDN:
Documento de Portabilidade da Linha RM
Documento TOTVS Application Server - 29289 da Linha Protheus
Os produtos envolvidos utilizam o modelo de licenciamento padro (License Server). Para pleno funcionamento,
as licenas (Hard Lock) devem ser providenciadas junto a TOTVS com antecedncia. Vale ressaltar que esta
integrao est de acordo com as boas prticas recomendadas pelo Comit de Integrao TOTVS e utiliza a
arquitetura Mensagem nica e comunicao via WebServices.
Nota:
responsabilidade da equipe de implantao executar a carga inicial e/ou sincronismo dos cadastros, para os
clientes que j possuem bases de dados RM ou Protheus implantadas. A integrao realiza o sincronismo
automtico dos novos registros ou das alteraes posteriores aps sua ativao. Para facilitar o sincronismo dos
dados tanto a linha RM quanto a linha Protheus implementam interfaces especficas.
Esse documento no visa a descrio dos procedimentos de instalao do Protheus padro e suas configuraes.
Neste documento sero passadas informaes referentes ao EAI da Linha Protheus, que o responsvel pela
comunicao com o TOTVS Incorporao. Para esclarecimentos sobre demais produtos da Linha Protheus,
consulte a documentao deste.
Na tela de Transaes aparecem s mensagens que foram geradas (Enviadas ou recebidas), e para visualizar o
arquivo XML criado pela mensagem, clique na linha da mensagem e em seguida clique na Lupa azul que est na
parte superior da tela, ser aberto o arquivo XML no browser do Internet Explorer.
Clicando na linha da Mensagem na tela de Eventos da Tarefa aparecem as seguintes informaes de Incio de
Processamento, Falhas, Processo Interrompido, Fim de Processamento, conforme o ocorrido com a mensagem.
Nota:
Para identificar a Cor da Legenda com o tipo de mensagem, clicar duas vezes na bolinha colorida que abre a tela
de legenda com a identificao do tipo com a Cor.
Esse documento no visa descrio dos procedimentos de instalao do TOTVS Incorporao (TIN) e suas
configuraes. Sero destacadas as informaes referentes ao TOTVS Business Conector (TBC) que a
ferramenta EAI da Linha RM, responsvel pela comunicao com o BackOffice Protheus.
Para demais esclarecimentos sobre demais produtos da Linha RM, consulte o help online disponvel no endereo:
wikihelp.totvs.com.br
3.1. Pr-requisitos
Nesta verso os WebServices de Integrao da linha RM devem ser hospedados no Microsoft IIS. Alm disto a
Biblioteca RM necessita da Microsoft .NET Framework. Assim, os pr-requisitos de instalao para o EAI RM so
os seguintes:
Microsoft .NET Framework 4.0
Internet Information Services (IIS)
4. Contexto de negcio
O TIN o sistema de gesto de empreendimentos da TOTVS. Com ele o cliente far a gesto de
Empreendimentos, disponibilidade de subunidades e seus contratos de venda e planos de financiamento,
enviando e recebendo informaes do mdulo financeiro. Esta integrao foi feita para viabilizar a
comercializao do TIN integrado ao mdulo financeiro do BackOffice Protheus. A seguir mais detalhes sobre o
escopo da integrao.
5. Escopo e Finalidade
Os cadastros comuns sero feitos no BackOffice Protheus pelos mdulos: SIGACOM, SIGAFIN, SIGACTB) e
sincronizados para o RM. Os cadastros e processos de gesto imobiliria - exemplo plano de financiamento e
negociao de contrato sero feitos no TIN e sincronizados para mdulo financeiro do Protheus. O processo de
comissionamento ser sincronizado com o mdulo de Compras. Processos estritamente financeiros - exemplo
baixa de ttulos (pagar / receber), sero realizados no Protheus.
6. Transaes/Entidades
Ateno: Sempre que cadastrar uma nova coligada no De/Para RM o cdigo informado para Valor da Chave
Primria RM e Valor da Chave Integrao deve ser o cdigo da Coligada RM para os dois campos.
De-Para RM (Filial)
Tabela RM GFILIAL
Chave Primria RM CODCOLIGADA|CODFILIAL
Valor Chave Primria RM <Valor CODCOLIGADA> + <|> + < Valor CODFILIAL>
Sistema Integrado PROTHEUS
Valor Chave Integrao <Company Internal ID> + <|> + <Internal ID>
6.1.2. Moeda
Na fase 1 deste projeto no est contemplado o sincronismo automtico de Moeda. Mas as mensagens
referentes ao Plano de Financiamento (Financing) e a mensagem de Comisso/Pedido de Compra (Order) faro
referncia a moeda R$. Ento a moeda R$ deve ser cadastrada (manualmente) nos 2 sistemas e o de/para
deve ser configurado dos dois lados.
De-Para RM De-Para Protheus
Tabela RM GMOEDA Referncia RM
Chave Primria RM SIMBOLO Alias CTO
Valor Chave Primria RM <Valor CODCOLIGADA> Campo CTO_MOEDA
Sistema Integrado PROTHEUS Valor Externo <Valor Recebido pelo InternalId>
Valor Chave Integrao < Valor recebido pelo InternalId > Valor Interno (CTO_FILIAL+CTO_MOEDA)
6.2.1. Cliente/Fornecedor
O Os Clientes devem ser cadastrados somente no BackOffice Protheus atravs do SIGAFAT (Atualizaes |
Cadastros | Cliente).
Os Fornecedores devem ser cadastrados somente no BackOffice Protheus atravs do SIGAFIN (Atualizaes |
Cadastros | Fornecedor).
O sincronismo de Cliente e Fornecedor ser de forma automtica para o RM utilizando a mesma estrutura de
mensagem. O que os difere a Tag <EntityType>.
As configuraes iniciais desta integrao ir criar um parmetro que ir definir se utiliza Auto incremento ou
no, e de acordo com este parmetro, ir definir a mscara do cdigo do Cliente/Fornecedor para ##########
e para que seja utilizado Auto incremento (parmetro do sistema financeiro RM); Caso contrrio, ir definir a
mscara do cdigo do Cliente/Fornecedor para e para que no seja utilizado Auto incremento (parmetro do
sistema financeiro RM)
No RM sero gravados com o Tipo de Cli/For marcado com o tipo exato cadastrado no Protheus e, caso seja
feito aditivo ou distrato que necessite de parcelas a pagar (devoluo), no respectivo processo dever ser
selecionado o Fornecedor correspondente ao cliente, sendo que o sistema ir tentar buscar automaticamente
conforme CPF / CNPJ.
Nota:
O Cdigo do Cliente no RM, caso utilize o auto-incremento ser com um valor a partir da tabela GAUTOINC, caso
contrrio, ser uma composio de TIPO (C para cliente e F para fornecedor), NUMERO DA LOJA (quando existir),
; e o cdigo cadastrado no Protheus (exemplos: C02;005896, F01;0189753); O default que no se utilize
auto-incremento.
A tag <EntityType> ser enviado um Enumerator (Person/Company) e ser gravado no campo
FCFO.PESSOAFISOUJUR o valor F quando Person e J quando Company.
As informaes recebidas da tag <MarketSegment> devero ser gravadas na tabela TSEGMENTO.
O CPF/CNPJ sero recebidos atravs da tag <GovernamentalInformation>
No EAI RM / XSL os campos Estado e Pas no sero recebidos porque no so de carter obrigatrio.
Futuramente esses campos sero tratados, quando o preenchimento das tabelas GPAIS, GMUNICIPIO e GETD
forem verificadas.
Nota:
O parmetro de Integrao CENTROCUSTOAUTOINC define:
Se desmarcado: O Cdigo do Centro de Custo no RM ser sempre o cdigo informado na mensagem nica;
porm, o implantador deve limpar a mscara do centro de custo, para que a integrao use o cdigo exato do
Protheus. (Fica no parametrizados do mdulo Financeiro ou via script, limpando o campo MASCARACC da tabela
GCCUPAR). Feito isto, necessrio apagar o _Broker e reiniciar o host.
Se marcado: O Cdigo do Centro de Custo no RM ser com um valor a partir da tabela GAUTOINC, sempre
ignorando o cdigo informado na mensagem nica.
6.2.3. Banco
O Banco, Agncia, Conta Corrente e Conta Caixa devem ser cadastrados no BackOffice Protheus (acesse SIGAFIN
| Atualizaes | Cadastros | Bancos) e sero sincronizados automaticamente para o RM.
O BackOffice Protheus possui apenas uma tabela que contm todas as informaes Cdigo do Banco, Nome,
Agncia, Conta, entre outros.
Na linha RM podem ser consultados na viso de Bancos e Agencias (acesse RM.exe | BackOffice | Gesto
Contbil | Cadastro | Bancos e Agncias ou RM.exe | Executar | Localizar = Banco, e escolha Financeiro |
Banco). Agncia um anexo da viso de Banco, assim como Conta Corrente um anexo da viso de Agncia.
Na Linha RM so tabelas independentes: Banco (GBANCO), Agncia (GAGENCIA), Conta Corrente (FCONTA) e
Conta Caixa (FCXA). Com isso, a excluso da entidade banco no Protheus, reflete na excluso de Conta caixa e
Conta do Lado RM; A entidade Agencia no RM a penas ser excluda se no houverem outras contas associadas
a ela, e Banco apenas ser excludo se no houver agencia.
Mensagem nica: Bank_2_000
PROTHEUS RM
Mensagem Padro
Tabela Campo Tabela Campo
GBANCO NUMBANCO
Code SA6 A6_COD FCONTA NUMBANCO
FCXA NUMBANCO
Febraban SA6 A6_NUMBCO GBANCO NUMEROOFICIAL
Name SA6 A6_NOME GBANCO NOME
ShortName SA6 A6_NREDUZ GBANCO NOMEREDUZIDO
GAGENCIA NUMAGENCIA
Agency/Number SA6 A6_AGENCIA
FCONTA NUMAGENCIA
FCXA NUMAGENCIA
Agency/Name SA6 A6_NOMEAGE GAGENCIA concat('Agncia ', Agency/Number)
Agency/Address SA6 A6_END GAGENCIA ENDERECO
Agency/Address/Number - - GAGENCIA NUMERO
Agency/Address/Complement - - GAGENCIA COMPLEMENTO
Agency/Address/City/Descriptio
SA6 A6_MUN GAGENCIA CIDADE
n
Agency/Address/State/Descripti
SA6 A6_EST GAGENCIA ESTADO
on
Agency/Address/District SA6 A6_BAIRRO GAGENCIA BAIRRO
Agency/Address/ZIPCode SA6 A6_CEP GAGENCIA CEP
Agency/ContactInformation/
ComunicationInformation/Phon SA6 A6_TEL GAGENCIA TELEFONE
eNumber
Agency/ ListOfAccount/Account FCONTA CODCOLIGADA
SA6 cEmpAnt
/CompanyId FCXA CODCOLIGADA
FCONTA NROCONTA
Agency/
SA6 A6_NUMCON FCXA CODCXA
ListOfAccount/Account/Number
FCXA NROCONTA
Agency/
- - FCXA concat('Conta Caixa ', Number)
ListOfAccount/Account/Name
Ateno:
O parmetro de Integrao CONTACAIXAAUTOINC define:
Se desmarcado: O Cdigo da Conta / Caixa no RM ser sempre o cdigo informado na mensagem nica;
Se marcado: O Cdigo da Natureza Financeira no RM ser com um valor a partir da tabela GAUTOINC, sempre
ignorando o cdigo informado na mensagem nica, e na descrio sero exibidas as informaes Nmero do
banco, nmero da Agencia e nmero da conta do Protheus.
Este parmetro deve ser utilizado quando no Protheus o dicionrio de dados alterado para permitir cadastrar
um nmero de conta maior que 10 caracteres
Natureza Financeira
As Naturezas Financeiras devem ser cadastradas no BackOffice Protheus (acesse SigaFin | Atualizaes |
Cadastros | Naturezas) e sero sincronizados automaticamente para o RM.
Nota:
Importante usar este cadastro compartilhado para todas as filiais, pois na linha RM a tabela correspondente no
possui Filial.
Na linha RM podem ser consultadas na viso de Natureza Oramentria Financeira (acesse RM.exe | BackOffice
| Gesto Financeira | Cadastro | Natureza Oramentria Financeira ou RM.exe | Executar | Localizar =
Natureza, e escolha Movimento | Natureza Oramentria/Financeira).
Mensagem nica: FinancialNature _2_000
Mensagem Padro PROTHEUS RM
Ateno:
O parmetro de Integrao NATUREZAFISCALAUTOINC define:
Se desmarcado: O Cdigo da Natureza Financeira no RM ser sempre o cdigo informado na mensagem nica;
Neste caso o cadastro de Natureza Financeira deve seguir o padro dos Cdigos para pais e filhos (o Protheus
permite que a Natureza X001.005 seja filha da G006, o que no funciona no RM. O pai deve ser X001 e o filho
X001.001)
Se marcado: O Cdigo da Natureza Financeira no RM ser com um valor a partir da tabela GAUTOINC, sempre
ignorando o cdigo informado na mensagem nica.
6.3. Processos
Os processos podero ser gerados atravs de dois Tipos de Fluxo:
RM Protheus: O RM ir consumir um WebService do EAI Protheus para envio da(s) mensagem(s) e o Protheus
ir retornar uma mensagem com o status do processamento, aps a resposta do Protheus, o RM atualizar o
registro no Monitor da Fila de Integrao.
Protheus RM: O Protheus ir consumir um WebService do EAI RM para envio da(s) mensagem(s) e o RM ir
retornar uma mensagem com o status do processamento.
A seguir sero descritos os processos do TIN integrados diretamente com o BackOffice Protheus.
Para alterar uma parcela do tipo PR para NF necessrio executar o processo de Reajuste de Parcelas do
TIN todo ms, para a regra citada no pargrafo acima seja aplicada. (Ver tpico 6.3.1.2 Reajuste de Parcela)
Ateno:
Caso o parmetro GERATITULONF esteja igual a True todas as parcelas sero geradas como NF
independentemente da data de vencimento. (Este parmetro est localizado na tela RM | Integrao |
Mensagem nica | Integraes anexo Parmetros da Integrao).
E2_FILIAL,
E2_PREFIXO,
E2_NUM,
InternalId* SE2 E2_PARCELA, FLAN CODCOLIGADA ,| ,IDLAN
E2_TIPO,
E2_FORNEC,
E2_LOJA
Ttulo a pagar (NF) = 1;
FlagAccount SE2 E2_TIPO(PR/NF)
Ttulo Provisrio a pagar (PR) = 0
Type - No se aplica FLAN PAGREC=2 ento Payable
E2_FORNECE +
CustomerVendorId SE2 FLAN CODCOLIGADA,'|',CODCFO
E2_LOJA
DocumentPrefix SE2 E2_PREFIXO FLAN SERIEDOCUMENTO
No corresponde no
DocNumber - FLAN NUMERODOCUMENTO
Protheus
DocParcel SE2 E2_PARCELA FLAN PARCELA
IssueDate SE2 E2_EMISSAO FLAN DATAEMISSAO
DueDate SE2 E2_VENCTO FLAN DATAVENCIMENTO
S
NetValue E2_VALOR FLAN CVALORLIQUIDO
E2
CurrencyCode SE2 E2_MOEDA FLAN CODMOEDAVALORORIGINAL
ApportDistribution/Apport/CostCenterCode CTJ CTJ_CC FLANRATCCU CODCOLIGADA,'|',CODCCUSTO
ApportDistribution/Apport/Value CTJ CTJ_VALOR FLANRATCCU VALOR
ListOfComponent/Component/Code FRU FRU_COD FLANINTEGRACAO IDCAMPO
ListOfComponent/Component/Name FRU FRU_DESC FLANINTEGRACAO DESCRICAO
ListOfComponent/Component/Value FRU FRU_VALOR FLANINTEGRACAO VALOR
History FLAN HISTORICO
No RM a Natureza Financeira de um Ttulo Financeiro fica armazenada somente no Rateio de Centro de custo,
desta forma, para que seja enviado o cdigo da natureza financeira nas parcelas de um financiamento
necessrio que o parmetro USAR RATEIO PARA (Parmetros | TOTVS Gesto Financeira | Lanamento |
Recursos Adicionais | parmetro Usar rateio para: AMBOS) do financeiro RM esteja permitindo o uso de Rateio
de Centro de Custo.
As parcelas ficaro em aberto no RM enquanto os ttulos correspondentes no forem baixados. O processo de
baixa ser descrito em outro ponto neste documento.
No Protheus o nico processo que pode ser executado sobre o ttulo gerado a partir do TIN a Baixa. Demais
processos esto bloqueados.
Todos os processos a seguir, quando efetivados no TIN iro gerar uma mensagem Financing para integrao com
o mdulo financeiro do BackOffice Protheus.
Nota
Para facilitar a localizao no Protheus dos ttulos financeiros gerados pelo TIN, deve-se alterar o
histrico dos Tipos de Parcelas no RM, colocando a varivel pr-definida Nmero da Venda.
Com isso ser possvel filtrar os ttulos de uma venda no Protheus atravs do Histrico,
informando o nmero da venda.
Juros e Multa s podero ser utilizados/informados nos componentes da parcela, nos parmetros
do Fluxus e do TIN sero desconsiderados.
Juros e Multa sero utilizados nos ttulos a Pagar e a Receber. Nos ttulos a Receber, os valores de
Juros e Multa podero ser alterados. A alterao no ser permitida nos ttulos a Pagar.
Nota
No Protheus existe um limite de tamanho para campo Memo, que pode ser contornado alterando a configurao
do AppServer, vide http://tdn.totvs.com/display/tec/TOPMemoMega
Caso esta parametrizao no seja feita, o Protheus ir recusar mensagens de criao de lanamentos para
vendas com muitas parcelas.
6.3.1.3. Aditivos
As alteraes contratuais aps a assinatura do Contrato so denominadas Aditivos de Contrato. Qualquer tipo
de negociao de Ttulos (exemplos: aumentar o prazo do financiamento, adoo de novo modelo de
financiamento, aumento do valor financiado, etc.) um processo que deve sempre iniciar no TIN, gerando
aditivos de contrato. Assim como a venda o aditivo no TIN possui situaes, entre elas a situao Em preparao
e a Efetivada. Sempre que um Aditivo for efetivado no TIN e que gere atualizaes no financeiro, o EAI RM ir
enviar uma nova mensagem de financiamento para o Protheus.
Os seguintes tipos de Aditivos do TIN esto integrados ao RM:
Prorrogao de Vencimento: Ser enviada uma mensagem Financing com as parcelas que tiveram o
vencimento prorrogado, est mensagem ser enviada como alterao (upsert).
Renegociao de Contrato: Este aditivo possibilita inmeros tipos de combinaes: exluir parcelas,
incluir parcelas e alterar parcelas, tanto parcelas a receber quanto parcelas a pagar. Sero enviadas
uma mensagem Financing para cada operao (incluir/alterar/excluir) definida na renegociao. Ex.:
Excluir 2 (duas) parcelas do contrato atual e incluir 4 (quatro) novas parcelas a receber, sero geradas
2 (duas) mensagem financing, uma com as duas parcelas excluidas como delete e outra com as quatro
novas parcelas a receber como upsert.
Alterao de Valor da Parcela: Ser enviada uma mensagem Financing com as parcelas que tiveram
o valore alterado, est mensagem ser enviada como alterao (upsert).
Alterao de Vencimento: Ser enviada uma mensagem Financing com as parcelas que tiveram o
vencimento alterado, est mensagem ser enviada como alterao (upsert). Caso a parcela que teve
o vencimento alterado esteja como Proviso no Protheus e teve sua data de vencimento alterada para
menor que a data atual + 1 ms, ela ser passada de Proviso (PR) para Nota Fiscal (NF). Este aditivo
tambem poder ser utilizado para que o cliente possa pagar uma parcela que ainda no venceu e que
esteja como Proviso (PR) no Protheus.
Antecipao de Parcela: Ser enviada uma mensagem Financing com as parcelas que tiveram o
vencimento alterado, est mensagem ser enviada como alterao (upsert). Caso a parcela que teve
o vencimento alterado esteja como Proviso no Protheus e teve sua data de vencimento alterada para
menor que a data atual + 1 ms, ela ser passada de Proviso (PR) para Nota Fiscal (NF). Este aditivo
poder ser utilizado para que o cliente possa pagar uma parcela que ainda no venceu e que esteja
como Proviso (PR) no Protheus.
Troca de Comprador: A quantidade de mensagens Financing que sero geradas para o Protheus
epender dos dois casos que existem neste aditivo. 1 - Troca de Comprador com todas parcelas em
aberto: Ser enviada uma mensagem Financing de excluso (delete) para cada grupo de parcelas do
TIN (Ex.: grupo sinal e grupo mensal) das parcelas em aberto com o comprador antigo, e gerada uma
mensagem Financing de incluso (upsert) para as parcelas com o novo comprador. 2 Troca de
Comprador com parcelas parcialmente baixadas: O TIN enviar uma mensagem de Delete para as
parcelas parcialmente baixadas e o Protheus e far uma baixa total do saldo com motivo TIN. Esta
baixa no poder ser cancelada no Protheus. O TIN ser o responsvel por enviar uma nova mensagem
de incluso, com os valores atuais para o novo comprador.
6.3.1.4. Distrato
O distrato um contrato que tem por objeto extinguir as obrigaes estabelecidas em um contrato anterior, que
ainda no foi executado na sua totalidade. Depende do consentimento entre as partes, mas pode se operar
tambm por resilio unilateral (por apenas uma das partes). Determina a lei que o distrato seja feito pela mesma
forma dos contratos. Este processo deve ser iniciado no TIN. O EAI RM ir enviar uma nova mensagem Financing
que far com que o Protheus faa estorno de ttulos/provises existentes e incluso novos ttulos/provises se
necessrio. Este processo pode eventualmente gerar um valor a devolver ao cliente, neste caso a parcela ir
gerar um Ttulo a Pagar no Protheus.
Nota
Atualmente o TIN s trabalha com a moeda R$. No existe sincronismo de moedas nesta
integrao
Cadastro de Centro de Custo: O BackOffice envia para o TIN, quem pode alterar ou excluir o Centro de Custo
ser somente o Protheus, o TIN s pode receber o cadastro do Protheus.
Cadastro de Bancos: O BackOffice envia para o TIN, quem pode alterar ou excluir o Banco ser somente o
Protheus, o TIN s pode receber o cadastro do Protheus.
Cadastro de Clientes: O BackOffice envia para o TIN, quem pode alterar ou excluir este cliente ser somente o
Protheus, o TIN s pode receber o cadastro do Protheus.
Cadastro de Fornecedores: O BackOffice envia para o TIN, quem pode alterar ou excluir este Fornecedor ser
somente o Protheus, o TIN s pode receber o cadastro do Protheus.
Cadastro de Naturezas: O BackOffice envia para o TIN, quem pode alterar ou excluir a Natureza ser somente o
Protheus, o TIN s pode receber o cadastro do Protheus.
Financiamento: Ser enviado na Mensagem de Financiamento Ttulos a Pagar/Receber. Ttulos que vierem
identificados como FlagAccount = 1 sero criados no Protheus como Ttulos a Pagar/Receber NF (por padro,
podendo ser alterado). Ttulos que no vierem identificados como FlagAccount = 0 sero gerados como Ttulos
a Pagar/Receber PR. A mensagem de Financiamento tambm pode fazer a substituio de um ttulo provisrio
no Protheus para um ttulo NF, o contrrio no ser possvel. Os ttulos somente podero ser excludos ou
alterados pelo TIN:
Pedido de Compra: O pedido ser enviado pelo TIN e recebido pelo Protheus atravs de Rotina Automtica.
Comisso: o TIN envia para o BackOffice Protheus, esta integrao no ser sincronizada Forma de Pagamento,
sendo assim o TIN ir enviar a Forma de Pagamento Dinheiro como padro.
Baixa de ttulos a Receber: No Protheus acontecer o recebimento da parcela do Ttulo pago pelo cliente, e ser
dado a Baixa Manual deste Ttulo, no mesmo momento da baixa o Protheus enviar o XML com as informaes
para o TIN baixar esta parcela nos seus controles. Este ttulo pode ser baixado pelo TIN via mensagem nica por
Distrato ou Aditivo, esta baixa no poder ser cancelada pelo Protheus. Ele ser baixado pelo motivo TIN.
Baixa de ttulos a Pagar: No Protheus acontecer o pagamento da parcela do Ttulo por exemplo de um distrato
de contrato com o cliente, e ser dado a Baixa Manual deste Ttulo, no mesmo momento da baixa o Protheus
enviar o XML com as informaes para o TIN baixar esta parcela nos seus controles. Este Ttulo pode ser baixado
pelo TIN via mensagem nica, por Distrato ou Aditivo, esta baixa no poder ser cancelada pelo Protheus, e ser
baixado pelo motivo TIN.
Cancelamento da Baixa do ttulo a Receber: No protheus possvel Cancelar a baixa de um ttulo j baixado, este
cancelamento enviar um XML para o TIN cancelar a baixa em seus controles.
Cancelamento da Baixa do ttulo a Pagar: No protheus possvel Cancelar a baixa de um ttulo j baixado, este
cancelamento enviar um XML para o TIN cancelar a baixa em seus controles.
9. Limitaes/Restries
Cadastre no Configurador do Protheus, no menu De/para Msg. nica, uma Condio de Pagamento, sendo os
campos do cadastro preenchidos da seguinte maneira: Marca Marca com a qual ser feita a integrao; Alias
Alias da tabela (neste caso, SE4); Campo Nome do campo do de/para (neste caso, E4_CODIGO); Valor Externo
O valor a ser enviado pela outra marca; Valor Interno O cdigo da Condio de pagamento, sendo este campo
formado pela Filial + Cdigo (tabelas compartilhadas possuem espaos em branco no campo filial, e estes
devem ser preenchidos).
Cadastre no Configurador do Protheus, no menu De/para Msg. nica, uma Moeda Contbil, sendo os campos do
cadastro preenchidos da seguinte maneira: Marca Marca com a qual ser feita a integrao; Alias Alias da
tabela (neste caso, CTO); Campo Nome do campo do de/para (neste caso, CTO_MOEDA); Valor Externo O
valor a ser enviado pela outra marca; Valor Interno O cdigo da Moeda Contbil, sendo este campo formado
pela Filial + Cdigo (tabelas compartilhadas possuem espaos em branco no campo filial, e estes devem ser
preenchidos).
Cadastre no Configurador do Protheus, no menu De/para Msg. nica, um Centro de Custo, sendo os campos do
cadastro preenchidos da seguinte maneira: Marca Marca com a qual ser feita a integrao; Alias Alias da
tabela (neste caso, CTT); Campo Nome do campo do de/para (neste caso, CTT_CUSTO); Valor Externo O valor
a ser enviado pela outra marca; Valor Interno O cdigo do Centro de Custo, sendo este campo formado pela
Filial + Cdigo (tabelas compartilhadas possuem espaos em branco no campo filial, e estes devem ser
preenchidos).
Cadastre no Configurador do Protheus, no menu De/para Msg. nica, um Produto, sendo os campos do cadastro
preenchidos da seguinte maneira: Marca Marca com a qual ser feita a integrao; Alias Alias da tabela (neste
caso, SB1); Campo Nome do campo do de/para (neste caso, B1_COD); Valor Externo O valor a ser enviado
pela outra marca; Valor Interno O cdigo do Produto, sendo este campo formado pela Filial + Cdigo (tabelas
compartilhadas possuem espaos em branco no campo filial, e estes devem ser preenchidos).
Cadastre no Configurador do Protheus, no menu De/para Msg. nica, uma Natureza, sendo os campos do
cadastro preenchidos da seguinte maneira: Marca Marca com a qual ser feita a integrao; Alias Alias da
tabela (neste caso, SED); Campo Nome do campo do de/para (neste caso, ED_CODIGO); Valor Externo O valor
a ser enviado pela outra marca; Valor Interno O cdigo da Natureza, sendo este campo formado pela Filial +
Cdigo (tabelas compartilhadas possuem espaos em branco no campo filial, e estes devem ser preenchidos).
No Protheus Cadastre um Cliente, ao confirmar o cadastro o EAI se encarrega de enviar o arquivo XML com os
dados do Cliente.
No Protheus Cadastre um Fornecedor, ao confirmar o cadastro o EAI se encarrega de enviar o arquivo XML com
os dados do Fornecedor.
No Protheus Cadastre um Banco, ao confirmar o cadastro o EAI se encarrega de enviar o arquivo XML com os
dados do Banco.
No Protheus Cadastre uma Natureza Financeira, ao confirmar o cadastro o EAI se encarrega de enviar o arquivo
XML com os dados da Natureza.
No Protheus Cadastre um Ttulo a Receber, depois entre em Baixa Manual, e faa uma baixa deste Ttulo, ao
confirmar o cadastro o EAI se encarrega de enviar o arquivo XML com os dados.
No Protheus Cadastre um Ttulo a Pagar, depois entre em Baixa, informe o Banco e faa uma baixa deste Ttulo,
ao confirmar o cadastro o EAI se encarrega de enviar o arquivo XML com os dados.
No Protheus, receber uma mensagem de Financiamento, verifique se foram cadastrados os ttulos que podem
ser a Receber ou a Pagar.
No Protheus, receber o Pedido de Compra, verifique se entrou corretamente no Cadastro.
Verificar com o Destinatrio se o Servio de Webservice est carregado, digite o Endereo IP e Porta do
Destinatrio no seu Browser para ver se ele est conseguindo carregar os servios do WebService destino.
Verificar em seu browser digitando o IP e Porta do seu Server para ver se seu WebService tambm est subindo
corretamente, porque ele envia pelo seu Webservice atravs do EAISERVICE.
1.1 Instalao/Configurao
Protheus:
Verificar no AppServer.INI est configurado ambiente correto, Filial, ou se a chamada do Scheduler foi
configurado.
Verificar no Adapter se a Rotina est cadastrada e se constam todas as informaes corretas como: Nome correto
do XSD, se Envia est como SIM, se o Servio est como EAI.
Outras Informaes
O grupo TOTVS representado por suas marcas ir administrar as demandas de evoluo dos layouts e
demais ajustes, acordando junto aos solicitantes o prazo de liberao de release.
Todas as evolues programadas devero ser discutidas e aprovadas pelas marcas antes do incio do
desenvolvimento e somente sero desenvolvidas em caso de concordncia das marcas e alinhamento
com as diretivas definidas pelo Comit de Integrao TOTVS.
1.4 Suporte
O suporte aos recursos da Integrao ser de responsabilidade de todas as linhas, porm a equipe de
suporte do produto Protheus Controladoria ser a responsvel a anlise em primeira instncia.
Observao: Este modelo de suporte est sendo revisado pela TOTVS.
1.5 Tecnologia
Comunicao direta do EAI RM x EAI Protheus, via WebServices. Mensagens assncronas e sncronas.
Utilizao do Monitor da Fila de Integrao para gravar todas as mensagens enviadas/recebidas para efeito de
registro e, no caso de mensagem assncrona, permitindo reprocessar.
Modelo de Mensagem nica TOTVS.
Definio de Mensagem nica TOTVSMESSAGE
Durante o processo de consolidao de marcas, iniciado pela TOTVS, vrias empresas diferentes foram
adquiridas e com elas vrios produtos passaram a compor o portflio de ofertas disponvel aos clientes.
Esta expanso de ofertas permitiu que clientes de uma marca, antes limitados pelas opes com aquela
etiqueta, pudesse agora compor o seu ambiente de TI utilizando produtos de origens diferentes
(Exemplo: BackOffice Protheus + TIN).
Esta mesma iniciativa j era uma prtica comum nos clientes, porm todo o custo envolvido na
integrao 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 integrao (como corrupo da
base de dados, por exemplo), ele agora entende que a TOTVS deve prover solues j integradas,
independente da origem dos produtos oferecidos.
Com o objetivo de padronizar as integraes com os produtos TOTVS, foi definida uma nova diretriz para
os projetos de integrao: A de que todos os produtos TOTVS devam trabalhar com uma mensagem
XML nicos evitando, desta forma, o processo de transformao de mensagens. Neste cenrio, teramos
o seguinte quadro:
Neste cenrio, qualquer produto TOTVS trabalhar com o mesmo XML para uma mesma entidade, ou
seja, supondo que tenhamos um XML correspondente mensagem de CLIENTES, ela poder ser enviada
para qualquer um dos produtos que suporte o recebimento desta entidade.
Uma vez que os vrios produtos TOTVS tero um idioma comum (o XML nico), as integraes entre
estes produtos no exigiro mais que as mensagens sejam transformadas de um formato para outro.
Com isto, ser possvel conectar diretamente dois produtos, sem a necessidade do TOTVS ESB, como no
diagrama abaixo:
Alm de questes referentes ao formato das mensagens, a mensagem nica tambm torna uniforme
o tratamento destas mensagens XML pelos aplicativos, principalmente no que diz respeito
capacidade de rastreamento.
H uma diferena na forma como a linha RM e a linha Protheus tratam o conceito de Mensagem Sncrona e
Mensagem Assncrona, como segue:
LINHA RM
Independente se Sncrono ou Assncrono, a operao iniciada no RM, mas no concluda (no comitada no
banco) enquanto no enviar mensagem de integrao e receber o retorno.
Sncrono: Antes de concluir operao no RM o EAI envia Msg BusinessMessage para o Protheus e aguarda Msg
ResponseMessage. Se status OK conclui a operao (comita transao no banco) RM. Seno, d Rollback na
transao.
Assncrono: Antes de concluir operao no RM o EAI envia Msg BusinessMessage para o Protheus e aguarda Msg
ReceiptMessage. Se receber ReceiptMessage, EAI RM conclui a operao (comita transao no banco) RM.
Seno, d Rollback na transao.
LINHA PROTHEUS
Sncrono: Aps concluda operao no Protheus o EAI envia Msg BusinessMessage para o RM e aguarda Msg
ResponseMessage, para gravar OK na sua fila ou ERRO, conforme valor da tag Status.
Assncrono: Aps concluda operao no Protheus o EAI envia Msg BusinessMessage para o RM e aguarda Msg
ReceiptMessage, para gravar OK na sua fila.