Setembro/2014
Ttulo do documento
Sumrio
1.
2.
3.
Integrao .................................................................................................................................................. 3
4.
Escopo ....................................................................................................................................................... 4
5.
5.1.
Datasul ....................................................................................................................................................... 6
5.2.
Logix........................................................................................................................................................... 6
5.3.
Protheus ..................................................................................................................................................... 6
5.4.
RM .............................................................................................................................................................. 6
6.
Instalao/Atualizao ............................................................................................................................... 6
6.1.
Datasul ....................................................................................................................................................... 6
6.2.
Logix........................................................................................................................................................... 6
6.3.
Protheus ..................................................................................................................................................... 7
RM .............................................................................................................................................................. 8
7.
8.
Suporte ....................................................................................................................................................... 8
9.
10.
12.
Como Fazer................................................................................................................................................ 12
13.
14.
15.
Anexos ....................................................................................................................................................... 14
2. Sistemas Envolvidos
TOTVS Planning O TOTVS Planning um sistema de modelos de deciso aberto, que permite ao usurio, por meio
de frmulas e outras caractersticas comuns s planilhas eletrnicas, fazer o planejamento de diversas atividades de
negcio, inclusive planejamento oramentrio, utilizando dados locais de outros fontes, como bancos de dados de
ERPs.
Protheus/PCO O Planejamento e Controle Oramentrio (PCO) um sistema que permite o controle do oramento
por meio de movimentos de realizao do oramento e bloqueio de seu oramento, quando necessrio e configurado
pelo usurio, o incio do processo de controle ocorre na incluso das planilhas oramentria.
Nos prximos captulos, utilizaremos o nome PCO para representar o sistema Protheus PCO e Planning para representar o
sistema TOTVS Planning.
3. Integrao
Essa integrao diz respeito possibilidade do usurio utilizar o Planning como ferramenta para fazer o planejamento e utilizar o
PCO como ferramenta para fazer o controle e execuo oramentria.
No lado do PCO, o usurio alimentar as planilhas oramentrias e seus cadastros relacionados, como, contas oramentrias,
classe oramentria, operao unidade oramentria, centros de custos, item conta e classe de valor.
No lado do Planning, o usurio poder buscar essas informaes cadastrais e associ-las aos valores que sero orados, durante
certo perodo. Depois de realizar a fase de planejamento, a integrao permitir que esses valores estejam disponveis no PCO
para posterior controle e execuo oramentria.
Embora todo o processo de planejamento e controle possa ser feito no PCO, a integrao tem o objetivo de permitir ao usurio
utilizar um produto de planejamento mais robusto e flexvel. Ao mesmo tempo, embora o Planning no possa fazer o controle e
execuo oramentria, poder por meio de seus painis, apresentar esses resultados do controle, opcionalmente.
Premissas
o Pacote A38 (ou superior) do Planning instalado.
o Integrao configurada e habilitada no mdulo Metadata Manager do Planning.
o Cadastros de Planilha, Conta e Classe Oramentrias realizados no mdulo PCO.
o Acesso de conexo ao banco de dados do Protheus pelo Planning para leitura.
o Verso 11.80 ou superior.
o Fonte PCOI100 com data igual ou superior a 04/08/2014.
Ttulo do documento
o
o
Arquitetura (Tecnologia)
o Servidor de aplicao do Planning ter acesso a rede do servidor de EAI do PCO.
o Banco de dados do ERP Protheus deve ser MS SQL Server ou Oracle.
4. Escopo
O escopo da integrao entre os dois produtos est apenas na fase de planejamento do processo de oramento. Ela ocorre no
momento em que o usurio termina o planejamento e precisa atualizar as informaes oradas no PCO a fim de iniciar a fase de
controle do oramento em questo.
Embora exista uma comunicao entre os dois sistemas para que se possa iniciar o planejamento do oramento, momento esse
em que o Planning carrega as informaes de cadastros do PCO, no esse processo que caracteriza a integrao entre os
sistemas j que isso ocorre por meio de uma conexo direta ao banco de dados do PCO, que um caracterstica do prprio
Planning. A integrao caracterizada pelo envio das informaes de oramento j planejadas para o PCO por intermdio de
mecanismo de mensagem nica e o servio de EAI.
Como o Planning um sistema aberto, o usurio pode relacionar, na mesma planilha em que faz a entrada dos valores orados,
outras informaes como valores e frmulas que no sero enviadas ao PCO. A rea de dados a ser enviada definida apenas
pela interseo de coluna de perodo e uma linha de dados da estrutura de informao que foi criada a partir da importao dos
cadastros do PCO. Esse processo ser detalhado no item Fluxo das Informaes.
O PCO receber do Planning os itens do oramento na planilha oramentria previamente cadastrada, retornar apenas
confirmao de recebimento ou algum problema ocorrido no processo de importao.
No haver retorno para o Planning, sobre o controle do oramento efetuado no PCO, sobre alteraes nos itens da planilha
originados do Planning, validao de controle de usurio e acesso as entidades da planilha como ocorre na incluso manual.
No processo de integrao, do lado do Planning existem trs papis importantes:
1. Papel de usurio administrador do sistema: precisa habilitar a integrao do produto com o PCO. Essa configurao
pelo mdulo Metadata Manager. O administrador responsvel por criar uma conexo com o banco de dados do PCO,
criar uma configurao de destino para o EAI, informando o endereo do web service, definir uma empresa padro para
checagem das tabelas e definir um tamanho de pacote para as mensagens do EAI.
2. Papel de usurio planejador: esse papel responsvel por determinar o plano que ir conter os dados de integrao a
uma verso de uma planilha de oramento. O usurio determina, nesse momento, qual a empresa, filial, planilha, verso,
contas oramentrias e outros filtros que iro compor a pasta, no Planning, em que sero associados os valores a serem
enviados ao PCO.
3. Papel de usurio integrador: esse papel responsvel por selecionar os planos que tero seus dados enviados ao PCO.
Esse envio pode ser manual, plano a plano, como tambm ser agendado para envio em lote.
No processo de integrao, do lado do Protheus so os seguintes papeis:
1. Papel de usurio administrador do sistema: ser responsvel pela configurao do servidor EAI, configurar o JOB
PCOA100.
2. Papel de usurio PCO: efetuar cadastros bsicos como conta oramentria, classe oramentria, unidade oramentria,
operao, centro de custo, item conta, classe de valor e planilha oramentria, analisar, simular, revisar a planilha e
controlar o oramento.
Para um entendimento geral do escopo da integrao, abaixo sero apresentadas as telas dos produto em que a integrao atual
efetivamente.
Ttulo do documento
5. Pr-requisitos Instalao/Implantao/Utilizao
5.1.
Datasul
Para o Planning, a integrao est disponvel a partir do pacote A38. A instalao padro do produto j inclui todos os itens
necessrios para o funcionamento da integrao, no entanto, ela est desabilitada por padro sendo necessrio fazer a sua
configurao para ativ-la.
5.2.
Logix
No se aplica.
5.3.
Protheus
Para o PCO, ser necessrio ter incluso as planilhas oramentrias e seus cadastros relacionados, como, contas oramentrias,
classe oramentria, operao unidade oramentria, centros de custos, item conta e classe de valor.
5.4.
RM
No se aplica.
6. Instalao/Atualizao
6.1.
Datasul
O Planning possui um instalador que faz tanto a instalao do produto como sua atualizao em um ambiente com uma verso
anterior. O processo de instalao automtico e prepara todos os arquivos e instala todos os servios necessrios para o
funcionamento da integrao.
Para utilizar a integrao acessar o mdulo Metadata Manager.
a) Configurar um escopo para conexo ao banco de dados do ERP Protheus.
b) Configurar ao menos um destino EAI, informando um nome, o tempo mximo de espera em segundos (normalmente 30)
e o endereo do servidor EAI do ERP Protheus no formato
http://[endereo]:porta/EAISERVICE.apw.
c) Configurar os parmetros de integrao, como empresa padro, tamanho do pacote em Kilo Bytes (KB), sugerido um
valor de 50 a 900, nome do destino EAI configurado no item b e escopo de conexo com banco de dados do PCO
configurado no item c. O manual de uso do produto contm as informaes para efetuar essa configurao.
6.2.
Logix
No se aplica.
6.3.
Protheus
Esse documento no visa descrever os procedimentos de instalao do Protheus padro e suas configuraes. Neste documento
so passadas informaes referentes ao EAI da Linha Protheus.
6.3.1
Entre no mdulo Configurador (SIGACFG), em Ambiente | Schedule | Adapter EAI, e preencha da seguinte maneira:
Mensagem nica
Rotina
Mensagem
Envia
Recebe
Mtodo
Operao
Canal
Sim
PCOA100
BUDGETITEMS
Sim
Sim
Sncrono
Todas
EAI
6.3.2
6.3.3
1.
2.
3.
4.
6.3.4
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
Cadastrar Agent
Cadastrar Agendamento
6.3.5
So apresentadas duas telas, sendo a de Transaes na parte superior, e a tela de Eventos da Tarefa na parte inferior.
Na tela de Transaes:
1. Posicione na linha da mensagem gerada.
2. Clique na Lupa azul, na parte superior da tela.
3. aberto o arquivo XML no navegador padro da estao de trabalho.
Protheus PCO x TOTVS Planning
7
Ttulo do documento
Na tela de Eventos da Tarefa, ao clicar na linha da mensagem apresentada as informaes de incio de processamento,
Falhas, Processo interrompido, Fim do Processo conforme consta na mensagem.
Importante:
Para identificar a cor da Legenda com o tipo de mensagem, necessrio clicar duas vezes na bolinha colorida.
6.3.6
Opo Limpeza de Tabelas: Caso queira realizar uma limpeza dos histricos das mensagens.
Ao clicar nesta opo, apresentada a tela Tabelas com a opo Selecione a Tabela.
Clique na seta preta que aponta para baixo do lado esquerdo.
So apresentadas as opes: Tarefas ou EAI.
Para a utilizao, clique em EAI.
Marque um tipo de mensagem que deseja limpar do histrico.
Clique no check-box ao lado esquerdo da opo para marcar ou desmarcar. Sendo elas:
Aguardando Execuo.
Executando.
Finalizada.
Falhou.
Bloqueado.
6.4.
RM
No se aplica.
7. Controle de Verso
O grupo TOTVS representado por suas marcas 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.
8. Suporte
O suporte aos recursos da Integrao ser de responsabilidade de todas as linhas, sendo assim as equipes de suporte dos
produtos Planning e PCO estaro aptas a fazer a primeira anlise e, quando necessrio, repassar para a equipe mais adequada
em cada caso.
Observao: Este modelo de suporte est sendo revisado pela TOTVS.
9. Transaes/Entidades/Mensagens nicas
O fluxo de dados da integrao, para cada um dos sistemas, apresentado abaixo:
Importar
Oramento
PCO
Protheus
Valores Orados
Exportar
Oramento
PCO
Protheus
EAI
Confirmao
TOTVS
Planning
Adapter
Itens do
Oramento
EAI
AK2
Confirmao
Mtodo
Cadastros
ID
01
Descrio
Itens de Oramento
Mensagem nica
Origem
Planning
Destino
PCO
XSD
BudgetItems_1_000.xsd
Ttulo do documento
Para a mensagem utilizada nessa integrao, a relao entre entidades nos dois sistemas so caracterizadas por uma relao de
um registro no PCO para muitos registros no Planning e isso inviabiliza a utilizao de sincronizao de entidades. A figura abaixo
ilustra com um dado de oramento no Planning armazenado na tabela do PCO e em uma das tabelas do Planning (as tabelas
complementares foram suprimidas para facilitar o entendimento).
ERP Prottheus
1234
1
10001
TOTVS Planning
AK2
AK2_ORCAME AK2_VERSAO AK2_CO AK2_PERIOD AK2_VALOR
1234
1
10001 01/01/2014
100,00
Cell
Item_Id Time_Id
1
2
3
5
10
Value
2
1234
2
1
2
10001
2 01/01/2014
2
100,00
100,00
Assim, a construo de um mecanismo de sincronizao entre os dois sistemas foi descartada pela complexidade e baixo
desempenho, justificada pelo prazo de implementao da soluo sem uma contrapartida funcional para ambos os sistemas.
Dessa forma, o Planning no recebe dados do PCO nesse processo de integrao. A integrao de itens de oramento ocorre
apenas no sentido Planning => PCO, onde as informaes so enviadas atravs do servio de EAI 2 e posteriormente gravadas
na tabela de itens de oramento do PCO.
TOTVS
Planning
BudgetItems
PCO
Protheus
10.1. Cadastros
<BudgetItems>
Identificador da Mensagem: BudgetItems_1_000
Verso: 1.000
Tipo de Envio: Sncrona
10
TAG
PCO
Planning
Origem1
Tabela
Campo
CompanyId
SM0 Cadastro de empresas
M0_CODIGO
Clula do Plano
BranchId
SM0 Cadastro de empresas
M0_FILIAL
Clula do Plano
BudgetWorksheet
AK2 Itens do Oramento
AK2_ORCAME Clula do Plano
WorksheetVersion
AK2 Itens do Oramento
AK2_VERSAO
Clula do Plano
AccountId
AK2 Itens do Oramento
AK2_CO
Estrutura de informao
CostCenter
AK2 Itens do Oramento
AK2_CC
Clula ou estrutura de informao
AccountItem
AK2 Itens do Oramento
AK2_ITCTB
Clula ou estrutura de informao
ClassValue
AK2 Itens do Oramento
AK2_CLVLR
Clula ou estrutura de informao
ClassBudget
AK2 Itens do Oramento
AK2_CLASSE
Clula ou estrutura de informao
Operation
AK2 Itens do Oramento
AK2_OPER
Clula ou estrutura de informao
Currency
AK2 Itens do Oramento
AK2_MOEDA
Importao do oramento
BudgetUnit
AK2 Itens do Oramento
AK2_UNIORC
Clula ou estrutura de informao
AccountEnt05
AK2 Itens do Oramento
AK2_ENT05
N/A
AccountEnt06
AK2 Itens do Oramento
AK2_ENT06
N/A
AccountEnt07
AK2 Itens do Oramento
AK2_ENT07
N/A
AccountEnt08
AK2 Itens do Oramento
AK2_ENT08
N/A
AccountEnt09
AK2 Itens do Oramento
AK2_ENT09
N/A
DatePeriod
AK2 Itens do Oramento
AK2_PERIOD
Tabulao da estrutura de informao
Amount
AK2 Itens do Oramento
AK2_VALOR
Clula interna a estrutura de informao
(1) A origem se refere ao plano utilizado para importar a integrao. Como o usurio pode configurar a planilha de entrada de
dados de diversas formas no h um local determinado para a origem do dado.
Notas:
O valor de InternalId da mensagem composto pelo cdigo da empresa + cdigo da filial que so cdigos informados pelo prprio
usurio.
Embora o ERP Protheus possa ser implantado em modo de Grupo de Empresa + Mscara de unidades de negcio em vez de
Empresa + Filial, a mensagem identifica apenas cdigo para campo Empresa e Filial. Dessa forma, o usurio determina os valores
a serem enviados nesses campos e deve ser compatvel com a forma de implantao do ERP Protheus.
Apenas um plano oramentrio enviado por vez ao PCO. Como um plano pode conter vrias contas, centros de custo e outras
informaes e a mensagem tem um limite de tamanho configurado pelo usurio, pode ser necessrio o envio de vrias
mensagens para completar os dados de um plano.
Limitaes/Restries
10.2. Processos
No se aplica. No h mensagens de processo nessa integrao.
Ttulo do documento
11. Fluxo das Informaes
Mensagem BudgetItems no modo Sncrono:
Planning seleciona o plano com integrao configurada e bloqueia o plano.
Planning seleciona as contas oramentrias e outros parmetros configurados pelo usurio no plano de integrao.
Planning seleciona as clulas que possuem valores associados ao oramento. As clulas sem valor so ignoradas.
Planning faz a validao dos dados informados nos parmetros quanto ao tamanho permitido e os parmetros que so
obrigatrios. Caso no sejam vlidos, encerra.
Planning calcula, de acordo com o tamanho de mensagem configurado pelo usurio, as mensagens nicas que sero
enviadas ao PCO.
Para cada uma das mensagens:
o Planning envia a mensagem ao PCO ao mecanismo do EAI 2 do Planning.
o EAI do Planning envia a mensagem ao EAI do ERP Protheus e aguarda.
o EAI do ERP Protheus recebe a mensagem nica e entrega ao adapter do PCO.
o PCO recebe a mensagem.
o Efetua a leitura da mensagem e faz as verificaes se os dados do oramento esto corretos, caso alguma
informao, como planilha, verso, conta oramentria, centro de custo, classe oramentria, item conta, classe
de valor, unidade oramentria, operao estiver inconsistente , ele retorna a mensagem de erro.
o Caso todas as informaes estejam consistentes, ele grava o item do oramento na tabela AK2.
o PCO retorna uma mensagem de resposta por meio do EAI.
o Planning recebe a mensagem de resposta que estava aguardando. Caso confirme que os itens de oramento
foram atualizados, o processo continua at terminar todas as mensagens. Caso haja erro, o envio
interrompido.
Planning desbloqueia o plano e termina o processo.
Mensagem BudgetItems no modo Assncrono:
O modo assncrono no est implementado.
12
Erros de Tamanho
o Situao: O sistema faz uma validao nos parmetros informados na pasta do plano que contm o oramento a
ser enviado. A validao ocorre pela comparao ao tamanho mximo do cdigo que pode ser informado em um
parmetro.
o Soluo: Ajustar o valor para o tamanho correto e reiniciar a exportao.
Erros de Validao
o Situao: Ao informar cdigos de Unidade Oramentria, Classe Valor, Item Contbil e outros que so
parmetros de cabealho da importao, o sistema no pode validar esses valores com o PCO antes da
mensagem de integrao ser enviada. Dessa forma, pode ocorrer um erro de valor invlido indicando que o
PCO no aceitou o cdigo.
o Soluo: Ao receber o erro, verifique a mensagem e altere o valor do parmetro que est invlido. importante
verificar se a formatao da clula que tem o valor est como formatao tipo Texto. Alguns cdigos, embora
numricos, contm zeros na esquerda e s possvel ter esse tipo de valor na clula se a clula estiver
formatada como texto.
Erros de Estouro de Tempo
o Situao: Ao enviar os dados por meio da exportao de oramento, o sistema demora e retorna uma
mensagem de estouro de tempo ou time out.
o Soluo 1: Verifique o parmetro de tempo na configurao de Destinos EAI no mdulo Metadata Manager.
Ele deve ter um valor em segundos, normalmente 30. Se o tempo que o sistema est esperando antes da
mensagem for igual ao valor configurado antes de retornar o erro, verifique as prximas solues.
o Soluo 2: Pode ser um problema de endereo de rede. Verifique o endereo do EAI na tela de Destinos EAI
do Metadata Manager e confirme com o administrador se os endereos esto corretos.
o Soluo 3: Pode ser um problema de firewall de rede. Verifique junto ao administrador se as portas dos servios
no esto com restrio de uso.
o Soluo 4: Pode ser que o servidor de EAI do ERP Protheus est realmente carregado e no consegue
responder no tempo configurado na tela Destinos EAI. Nesse caso aumente o tempo de espera e investigue o
problema no servidor de EAI do ERP Protheus.
Outros Erros no previstos
o Situao: Ao enviar os dados uma mensagem de falha do tipo No foi possvel enviar a mensagem seguida de
um texto aparentemente tcnico como resultado.
o Soluo: Em algumas situaes, erros ocorridos no processamento da mensagem no PCO so retornados como
mensagem de erro. Nesse caso, verifique o erro junto ao administrador do sistema.
Verificar a presena dos seguintes arquivos na pasta de instalao DM\bin no servidor de aplicao:
o Integracaoorcamento.xml
o Integracaopco.txt
o totvsmsg.xsd
Ttulo do documento
o ListOfInternalid_1_000.xsd
o BudgetItems_1_000.xsd
No arquivo de configurao do servidor de aplicao (Datasul.ApplicationManager.config), verificar se o adapter para a
mensagem est configurado corretamente, verificando o seguinte item abaixo para o produto Datasul.Planning.
Checklist de Verificaes:
Planning:
Abrir o mdulo Metadata Manager e verificar se a integrao com o PCO est habilitada e configurada corretamente.
Verificar se o plano em que o problema est ocorrendo teve uma importao de oramento na mesma base do ERP
Protheus para o qual est tentando exportar.
o Uma forma de fazer a verificao criar um plano novo e configurar uma nova importao com os mesmos
parmetros e verificar se os cdigos de planilhas, verso e contas oramentrias so iguais.
o Outra verificao que pode ser feita consultar a string de conexo associada ao escopo configurado para a
integrao, se ela aponta para o mesmo ERP Protheus que o servio EAI configurado na janela de Destinos
EAI.
Verificar se os valores informados no plano de integrao correspondem cdigos vlidos no PCO.
PCO:
Para verificar porque os itens oramentrios no foram integrados:
15. Anexos
14