Especificação Agente Integrador

ESPECIFICAÇÃO
TÉCNICA
Agente de Integração do Software Plano –
aplicativo que integra as informações do
realizado com o Plano.
Responsável: Lúcio Vicente de Faria

Data da atualização: 19/04/2022
Rua Gen. Mário Tourinho, 1746 - 11º andar - Bigorrilho, Curitiba/PR
Classificação: Público
contato@allstrategy.com.br | 41 3013 2254
Sumário
1. Compatibilidade com o sistema Plano ................................................................... 3
2. Requisitos de hardware ........................................................................................... 3
3. Arquitetura da integração ........................................................................................ 3
3.1. Segurança ............................................................................................................ 3
3.2. Fluxo da integração.............................................................................................. 4
4. Instalando o aplicativo ............................................................................................. 5
4.1. Download do aplicativo ........................................................................................ 5
4.2. Executando o instalador do aplicativo.................................................................. 5
5. Utilizando o aplicativo .............................................................................................. 6
5.1. Configurando a origem da integração .................................................................. 7
5.2. Configurando as conexões de banco de dados ................................................... 9
5.3. Configurando a pasta destino para processamento de arquivos ....................... 11
5.4. Configurando o acesso ao sistema Plano.......................................................... 11
5.5. Configurando o servidor de e-mail ..................................................................... 12
5.5.1. Definindo os destinatários dos e-mails ........................................................ 13
5.6. Configurando um servidor proxy para as conexões HTTP ................................ 13
5.7. Definição da estrutura das tabelas/views da integração .................................... 14
5.7.1. Estrutura da tabela/view para integração do DRE ...................................... 14
5.7.2. Estrutura da tabela/view para integração do Fluxo de caixa ....................... 15
5.7.3. Estrutura da tabela/view para integração de Vendas .................................. 15
5.7.4. Estrutura da tabela/view para integração do Balanço ................................. 18
5.7.5. Estrutura da tabela/view para integração do RH ......................................... 18
5.7.6. Estrutura da tabela/view para integração de Volumes e Custos – Produto
acabado ................................................................................................................. 18
5.7.7. Estrutura da tabela/view para integração de Volumes e Custos – Matéria
prima...................................................................................................................... 19
5.7.8. Estrutura da tabela/view para integração de Investimentos ........................ 19
5.7.9. Estrutura da tabela/view para integração de Indicadores ........................... 20
5.7.10. Estrutura da tabela/view para integração de Contratos ............................ 20
5.7.11. Nomes customizados para as tabelas/views............................................. 20
5.7.12. Layout dos arquivos processados pelo integrador .................................... 21
5.8. Executando os processos de integração ...................................................... 23
5.8.1. Agendar execução da integração ................................................................ 25
5.9. Utilizando o mesmo arquivo de configuração para instalação em outros
computadores ......................................................................................................... 27

1. Compatibilidade com o sistema Plano
Compatível com a versão 3.0.9 ou superior.
A compatibilidade com as versões superiores será válida enquanto não forem

realizadas alterações nas estruturas das integrações. Esta compatibilidade deve ser
observada em futuras liberações.
2. Requisitos de hardware
Sistema Operacional: Windows Desktop ou Server
Memória RAM: 4GB livres para o aplicativo
Espaço em disco: 250MB
3. Arquitetura da integração
3.1. Segurança
Toda a comunicação com o Plano é feita através do protocolo https e o algoritmo de
assinatura do certificado é com criptografia SHA-256 - RSA 2048 bits.
A instituição certificadora é a Site Blindado (www.siteblindado.com.br).

3.2. Fluxo da integração
Existem 2 maneiras para realizar a integração dos dados, através de views/tabelas do

banco de dados ou arquivos:
Tabelas/Views:
Nesta modalidade, as tabelas/views devem ser disponibilizadas nos layouts descritos

neste documento na seção 5.7.
Com as views disponíveis, ao executar a integração, o agente irá buscar as

informações, gerar um arquivo em background e enviá-lo ao plano através de um
POST HTTP em ambiente seguro (HTTPS).

Arquivo:
Nesta modalidade, os dados devem ser gerados para arquivos .csv nos layouts
descritos neste documento no item 5.7.12.
Os arquivos devem ser disponibilizados na pasta configurada no item 5.3.
Quando o arquivo estiver disponível na pasta e o usuário ou o sistema de agenda de

tarefas do Windows executar a integração, o arquivo é enviado para o Plano através
de um POST HTTP em ambiente seguro (HTTPS).
Para agendar uma tarefa do Windows que irá executar o agente de integração em
determinados períodos, é só seguir os passos descritos no item 5.8.1.
4. Instalando o aplicativo
4.1. Download do aplicativo
O aplicativo está disponível para download em:
https://downloads.planoparasuaempresa.com.br/PlanoAgenteSetup_2.1.15.exe (x86)
ou https://downloads.planoparasuaempresa.com.br/PlanoAgenteSetup_2.1.15-x64.exe
(x64)
A versão 64bits só deve ser instalada em casos onde o driver de conexão ao banco de
dados também é 64bits.
O antivírus pode apontar o aplicativo como um falso positivo, mas caso isso aconteça,
é necessário desabilitar o antivírus por alguns instantes. O aplicativo está totalmente
sem infecção.
Ele pode ser instalado em servidores ou desktops com sistema operacional Windows.
4.2. Executando o instalador do aplicativo

Após baixar o aplicativo, basta executar e seguir os passos para instalação.
O aplicativo necessita que a pasta destino e todas as outras abaixo dela, tenham
permissões de leitura e escrita, pois o sistema grava alguns arquivos nas pastas.

Ele também necessita do Microsoft .Net Framework 4.5 e se não estiver instalado, o
setup não será finalizado.
Obs.: A sugestão é não instalar na pasta Arquivos De Programas ou Arquivos De

Programas (x86) e sim instalar na raiz do C: para facilitar as permissões que são
concedidas à pasta.
5. Utilizando o aplicativo
Ao executar o aplicativo, o usuário irá ver as telas abaixo e ela será diferente
dependendo do tipo de integração:
Integração por tabelas/views:

Integração por arquivos:
O usuário também poderá selecionar a competência base para execução do processo

no canto superior direito do aplicativo caso a origem dos dados seja do “Banco de
dados”.
5.1. Configurando a origem da integração

O integrador pode importar informações diretamente de tabelas/views, consultas
especiais do banco de dados ou processar arquivos.
Para selecionar a origem da integração, o usuário irá clicar em Configurações,

selecionar a aba Configurações e alterar a “Origem das informações” conforme mostra
a imagem abaixo:
Quando a origem for banco de dados, a opção “Definir consultas especiais” ficará
disponível. Nesta opção o usuário poderá incluir consultas SQL para serem utilizadas

no lugar das tabelas/views, porém, o resultado da consulta deve ter a mesma estrutura
definida no item 5.7.
Não é necessário criar tabela/view para a integração selecionada, pois quando uma
consulta especial é definida, ela substitui sua utilização. A consulta especial é por tipo
de integração, ou seja, o usuário pode continuar utilizando tabela/view para alguns
tipos e definir consultas especiais para outros.
Para não utilizar consultas especiais basta deixar o campo destinado à consulta em
branco.
Ao clicar na opção, o usuário irá visualizar a tela abaixo:
Poderá ser definida uma consulta para cada tipo de integração.
Existem 2 parâmetros que devem ser passados na consulta para o integrador poder
filtrar a competência no momento da sua execução. Os parâmetros são: “:MES” e
“:ANO” como pode ser observado na tela acima. Após criar a consulta, o usuário
poderá testar selecionando a competência desejada e clicando na opção “Executar
consulta”. A tela abaixo mostra o resultado:

Obs: Para executar as consultas, a configuração de acesso ao banco de dados deverá
estar criada conforme instruções no item 5.2
5.2. Configurando as conexões de banco de dados

O integrador irá utilizar estas configurações se a origem da integração for “Banco de
dados” conforme item 5.1.
Para configurar as conexões o usuário irá clicar em Configurações e selecionar a aba

Origem das informações. Neste local existem outras 2 abas e a que deve estar
selecionada é a aba “Banco de dados”.
O usuário irá clicar no botão incluir, preencher os campos e depois clicar em Salvar.
Caso algum campo obrigatório não seja informado, o aplicativo irá avisar e solicitar o
preenchimento.
Após cadastrada a conexão, o usuário poderá clicar no botão “Testar conexão” e

verificar se tudo está OK.
Para cada conexão criada, o usuário irá selecionar um ou mais processos a utilizarem
a conexão (DRE, Fluxo de caixa, Vendas, Balanço, RH, Volumes e Custos,

Investimentos, Indicadores, Contratos). Um processo poderá ser utilizado apenas em
uma conexão, ou seja, o usuário poderá criar no máximo 9 conexões e relacionar uma
para cada processo. A imagem abaixo mostra como é a tela de cadastro das
conexões:
Obs.: O acesso ao banco de dados Oracle é feito através de instância configurada no

TNSNAMES. O usuário deve preencher os campos Servidor e Banco de dados com o
nome da instância configurada.
Para a conexão do tipo ODBC, os bancos homologados são Progress, HANA e

PostgreSQL.
Para configurar o acesso ao banco de dados Progress, é necessário selecionar ODBC

no tipo de banco de dados e informar no campo Servidor, o Data Source Name
seguido de “|” e depois o IP do servidor. Ex: PlanoProgress|192.168.10.155
Para acesso ao banco de dados PostgreSQL, basta colocar o Data Source Name no
campo Servidor.
Para acesso ao banco de dados HANA, basta colocar o Data Source Name nos
campos Servidor e Banco de dados.

A fonte de dados ODBC deve ser criada na plataforma 32bits. Para utilizar a versão
x64, instalar o agente baixado pelo link da versão 64bits.
5.3. Configurando a pasta destino para processamento de arquivos

O integrador irá utilizar estas configurações se a origem da integração for “Arquivo”
conforme item 5.1.
Para configurar a pasta destino, o usuário irá clicar em Configurações e selecionar a

aba Origem das informações. Neste local, existem outras 2 abas e a que deve estar
selecionada é a aba “Arquivo“.
O usuário irá clicar no botão com o sinal “...” e selecionar o caminho que o integrador
irá buscar os arquivos para o processamento.
Esta opção permite o processamento de vários arquivos com processos diferentes

(DRE, FLUXO, VENDAS, BALANCO, RH, VOLUMESECUSTOSPA,
VOLUMESECUSTOSMP, INVESTIMENTOS, INDICADORES, CONTRATOS) e
também competências diferentes, ou seja, o usuário poderá importar um ano inteiro
apenas colocando todos os arquivos na pasta destino e depois basta acionar o
processo de execução.
O agendamento de tarefas do Windows também pode ser utilizado nesta opção

conforme descrito no item 5.8.1
O agente irá armazenar os arquivos processados em uma pasta chamada

“Processados” no caminho definido na configuração. O sistema não elimina os
arquivos após o processamento.
5.4. Configurando o acesso ao sistema Plano

A configuração do acesso ao sistema Plano será utilizada para enviar e processar o
arquivo gerado para a integração.
Para configurar o acesso, o usuário irá abrir o menu “Configurações” e selecionar a

aba “Outras informações”
As informações que devem ser preenchidas estão demonstradas na imagem abaixo:

Após preencher as informações, o usuário poderá verificar se está tudo OK clicando
no botão “Testar conexão”. Se tudo estiver OK, o usuário irá clicar em salvar para
finalizar o cadastro.
5.5. Configurando o servidor de e-mail

Em caso de falha no processo, o aplicativo dispara um e-mail notificando os
destinatários sobre o problema. Para que o aplicativo envie o e-mail, o usuário deverá
configurar o servidor de saída de e-mails.
Para configurar o servidor de saída de e-mails, o usuário irá abrir o menu

“Configurações” e selecionar a aba “Outras informações”
As informações que devem ser preenchidas estão demonstradas na imagem abaixo:
Após preencher os campos, o usuário irá clicar em Salvar para finalizar o processo.

O campo remetente deve ser utilizado caso o servidor de e-mail exija um endereço de
e-mail para remetente.
O usuário poderá também enviar um e-mail teste para validar o processo.
5.5.1. Definindo os destinatários dos e-mails

A definição dos destinatários para os e-mails enviados deve ser configurada clicando
em Configurações no menu principal e selecionando a aba Configurações.
Dentro da aba configurações o usuário deverá preencher a área Resultado do

processo como mostra a figura a seguir:
5.6. Configurando um servidor proxy para as conexões HTTP

É possível definir um servidor proxy HTTP para as conexões com o Plano clicando na
opção Configurações no menu principal.
Dentro da aba configurações, o servidor pode ser configurado conforme mostra a

imagem abaixo:

O usuário irá marcar a opção “Utiliza proxy HTTP”, informar o servidor, porta e caso
utilize autenticação, o usuário e a senha.
5.7. Definição da estrutura das tabelas/views da integração

O aplicativo, para processar a integração, irá buscar os dados de algumas tabelas ou
views através das conexões que foram cadastradas.
Os dados das tabelas/views não podem conter caracteres especiais de quebra de

linha ou qualquer outro que comprometa a linha de dados. Para os campos destinados
a histórico ou identificação do documento, o texto não pode conter o caractere “;”, pois
ele é utilizado como delimitador dos campos.
5.7.1. Estrutura da tabela/view para integração do DRE

A definição dos destinatários para os e-mails enviados deve ser configurada clicando
em Configurações no menu principal e selecionando a aba Configurações.
Nome da Tabela/View: INT_REALIZADODRE
Aceita
Campo Tipo Tam Observações
nulo
MES Inteiro N
ANO Inteiro N
Data de entrada do documento. Se não for
DATA Data e hora S
informada, o sistema irá preencher com a data atual
CODUNIDADE Texto 50 N Código da Unidade de negócio
CODCENTRODECUSTO Texto 50 N Código do centro de custo
DESCCENTRODECUSTO Texto 50 S Descrição do centro de custo
CODCONTACONTABIL Texto 50 N Código da conta contábil
DESCCONTACONTABIL Texto 50 S Descrição da conta contábil
DOCUMENTO Texto 50 N Número ou identificação do documento
D - Débito | C – Crédito | A – Ambos. Quando utilizar
NATUREZA Texto 1 N a natureza A, o sistema irá considerar valores
negativos como débito e positivos como crédito
VALOR Número 14,2 N O valor deve ser diferente de zero.
HISTORICO Texto 250 S
CODPROJETO Texto 50 S Código de projeto
GERADOR Texto 100 S Nome do fornecedor/cliente que gerou lançamento

Esta informação somente é obrigatória caso o
DIMENSAO Texto 50 S
sistema esteja utilizando Dimensão
Utilizado para identificar se o registro foi gerado
RATEIO Texto 1 S
através de rateio. O valor do campo deve ser S ou N
5.7.2. Estrutura da tabela/view para integração do Fluxo de caixa

Nome da Tabela/View: INT_REALIZADOFLUXO
Aceita
nulo
MES Inteiro N
ANO Inteiro N
Data de entrada do documento. Se não for informada,
DATA Data e hora S
o sistema irá preencher com a data atual
DIMENSAO Texto 50 S
CODCONTAFINANCEIRA Texto 50 N Código da conta financeira
DESCCONTAFINANCEIRA Texto 50 S Descrição da conta financeira
DOCUMENTO Texto 50 N Número ou identificação do documento
DESCCENTRODECUSTO Texto 50 S Descrição do centro de custo
DESCCONTACONTABIL Texto 50 S Descrição da conta contábil
D - Débito | C – Crédito | A – Ambos. Quando utilizar
NATUREZA Texto 1 N a natureza A, o sistema irá considerar valores
negativos como débito e positivos como crédito
VALOR Número 14,2 N O valor deve ser diferente de zero.
HISTORICO Texto 250 S
DATALIQUIDACAO Data e hora S
GERADOR Texto 100 S Nome do fornecedor/cliente que gerou lançamento
O campo TIPODOCUMENTO só é exigido quando
TIPODOCUMENTO Texto 50 S existem tipos de documento de fluxo de caixa
cadastrados no Plano
5.7.3. Estrutura da tabela/view para integração de Vendas

Nome da Tabela/View: INT_REALIZADOVENDAS
Aceita
nulo
MES Inteiro N

ANO Inteiro N
Data de entrada do documento. Se não for
DATA Data e hora S informada, o sistema irá preencher com a data
atual
CODPRODUTO Texto 50 N Código do produto
QUANTIDADE Número 14,2 N
VALORUNITARIO Número 14,2 N
DIMENSAO Texto 50 S
CODCATEGORIA1 S Código da categoria 1**
CODITEMVALORIZACAO Texto 50 S Código do item da valorização
Este campo só será necessário incluir na
CUSTOUNITARIOAQUISICAO Número 20,6 S tabela/view caso o cliente utilize produtos com
modelo de precificação tipo Margem
** O módulo de vendas do Plano pode ter até 10 categorias cadastradas para
identificar as vendas por Cliente, Vendedor, Região, etc.
Não é necessária a criação de todos os campos referentes as categorias e sim apenas

aqueles que forem necessários conforme o número de categorias cadastradas no
sistema.
A tela abaixo mostra o cadastro das categorias no sistema Plano:

Para o caso acima, devem ser criados pelo menos os campos CODCATEGORIA1,
CODCATEGORIA2 e CODCATEGORIA3 que é o número de categorias cadastradas
no sistema.
Os dados também devem obedecer à ordem cadastrada no sistema. Para o exemplo

acima, o campo CODCATEGORIA1 está relacionado à categoria Cliente,
CODCATEGORIA2 está relacionado ao Vendedor e CODCATEGORIA3 está
relacionado ao Representante.
Á medida que novas categorias vão sendo cadastradas no Plano, novos campos
deverão ser criados nesta tabela/view, mas nada impede a criação dos 10 campos
para categoria de uma só vez.
Caso a ordem dos campos seja alterada no cadastro das categorias no Plano, uma
adequação na tabela/view destinada à integração também deverá ser realizada para
que os dados sejam colocados no campo correto.
Agrupamento de vendas e valorizações:
Para o correto funcionamento da importação, as vendas que ocorrem no mesmo dia,

na mesma Unidade de negócio e no mesmo Produto, devem ser agrupadas em um
único registro na tabela/view e as valorizações devem ser cadastradas logo abaixo do
registro da venda preenchendo o campo CODITEMVALORIZACAO.

5.7.4. Estrutura da tabela/view para integração do Balanço
Nome da Tabela/View: INT_REALIZADOBALANCO
Aceita
nulo
MES Inteiro N
ANO Inteiro N
DIMENSAO Texto 50 S
SALDO Número 14,2 N O saldo deve ser diferente de zero
5.7.5. Estrutura da tabela/view para integração do RH

Nome da Tabela/View: INT_REALIZADORH
Aceita
nulo
MES Inteiro N
ANO Inteiro N
VALOR Número 20,6 N O valor deve ser diferente de zero
CODFUNCIONARIO Texto 50 N Código do funcionário
NOMEFUNCIONARIO Texto 100 S Nome do funcionário
CODCARGO Texto 50 N Código do cargo
CODSINDICATO Texto 50 N Código do sindicato
CODEVENTO Texto 50 N Código do evento (Nome para fórmula)
DIMENSAO Texto 50 S
CONSIDERARHEADCOUNT Texto 3 N Sim | Não
HISTORICO Texto 250 S Histórico
5.7.6. Estrutura da tabela/view para integração de Volumes e Custos – Produto

acabado
Nome da Tabela/View: INT_REALIZADOVOLUMESECUSTOSPA

Aceita
nulo
MES Inteiro N
ANO Inteiro N
CODPRODUTO Texto 50 N Código do produto
DIMENSAO Texto 50 S
Código da estrutura de custo. Caso este campo não
seja preenchido, será considerado como
CODESTRUTURADECUSTO Texto 50 S
lançamento de volume e não de valor para o campo
VALOROUVOLUME
Lançamento do valor ou volume e deve ser
VALOROUVOLUME Número 20,6 N
diferente de zero
5.7.7. Estrutura da tabela/view para integração de Volumes e Custos – Matéria

prima
Nome da Tabela/View: INT_REALIZADOVOLUMESECUSTOSMP
Aceita
nulo
MES Inteiro N
ANO Inteiro N
CODMATERIAPRIMA Texto 50 N Código da matéria prima
DIMENSAO Texto 50 S
VALORUNITARIO Número 20,6 N Valor unitário
VOLUME Número 20,6 N Volume
CODPRODUTO Texto 100 N Código do produto acabado
5.7.8. Estrutura da tabela/view para integração de Investimentos

Nome da Tabela/View: INT_REALIZADOINVESTIMENTOS
Aceita
nulo
MES Inteiro N
ANO Inteiro N
CODIGO Texto 50 N Código do investimento
CODCENTRODECUSTO Texto 50 N Estrutura ou código do centro de custo
CODPROJETO Texto 30 S Código do projeto

DESCRICAO Texto 100 N Descrição do investimento
CODTIPO Texto 50 N Código do tipo do investimento
VALORTOTAL Número 14,2 N Valor total do investimento
EXIGENCIASLEGAIS Texto 1 N Preencher com S ou N
DIMENSAO Texto 50 S
5.7.9. Estrutura da tabela/view para integração de Indicadores

Nome da Tabela/View: INT_REALIZADOINVESTIMENTOS
Aceita
nulo
NOME Texto 50 S Nome do indicador
M – Mensal | B – Bimestral | T – Trimestral | S –
PERIODOMEDICAO Texto 1 N
Semestral | A - Anual
TIPO Texto 1 N M – Mês | A – Acumulado
MES Inteiro N
ANO Inteiro N
VALOR Número 14,4 N Valor da medição
5.7.10. Estrutura da tabela/view para integração de Contratos

Nome da Tabela/View: INT_REALIZADOCONTRATOS
Aceita
nulo
MES Inteiro N
ANO Inteiro N
CODCENTRODECUSTO Texto 50 N Estrutura ou código do centro de custo
DIMENSAO Texto 50 S
CODPROJETO Texto 30 S Código do projeto
VALOR Número 20,2 N Valor da medição
5.7.11. Nomes customizados para as tabelas/views

O usuário também pode definir nomes customizados para as tabelas/views da
integração. Para isso, basta acessar o menu “Configurações” e selecionar a aba
“Outras informações”. A imagem abaixo mostra o local onde cadastrar os nomes:

As siglas PA e MP na importação de Volumes e Custos são “Produto acabado” e
“Matéria prima” respectivamente.
Caso o usuário não forneça o nome de alguma tabela/view, o aplicativo assume o

nome padrão conforme mostrado nos itens 5.7.1, 5.7.2, 5.7.3, 5.7.4, 5.7.5, 5.7.6, 5.7.7,
5.7.8, 5.7.9, 5.7.10.
O usuário poderá customizar apenas o nome das tabelas/views. Os campos deverão

seguir o padrão especificado.
5.7.12. Layout dos arquivos processados pelo integrador

O layout dos arquivos é dividido em 2 partes: Cabeçalho e Detalhe.
No cabeçalho devem ser informados os parâmetros abaixo separados por “|”:
Campo Tipo Detalhe

Deverá conter DRE, FLUXO, VENDAS, BALANCO, RH,
Tipo de processo Texto VOLUMESECUSTOSPA, VOLUMESECUSTOSMP,
INVESTIMENTOS, INDICADORES, CONTRATOS
Mês Inteiro 1 a 12
Ano Inteiro
Parâmetro opcional para identificar que a carga é adicional. O
Carga adicional Texto valor deve ser CARGA_ADICIONAL. Este parâmetro é válido
apenas para processos que possuem a opção carga adicional.
No detalhe, as informações deverão obedecer às estruturas das tabelas definidas nos

itens 5.7.1, 5.7.2, 5.7.3, 5.7.4, 5.7.5, 5.7.6, 5.7.7, 5.7.8, 5.7.9, 5.7.10 e devem ser

separadas por ponto e vírgula, ou seja, o padrão do detalhe é de um arquivo .csv. A
ordem dos campos no arquivo também deve seguir a ordem de definição dos campos
das tabelas.
Obs.: A linha de detalhe do arquivo só deve terminar com “;” se a última informação for
vazia, pois o sistema faz uma validação na quantidade de pontos e vírgulas do arquivo
e falha se não estiver correto.
5.7.12.1. Download de exemplos de arquivos
DRE: https://downloads.planoparasuaempresa.com.br/plano/layouts/integracao-
dre.csv
DRE Carga adicional:

https://downloads.planoparasuaempresa.com.br/plano/layouts/integracao-dre-
adicional.csv
Investimentos:
https://downloads.planoparasuaempresa.com.br/plano/layouts/integracao-
investimentos.csv
Indicadores: https://downloads.planoparasuaempresa.com.br/plano/layouts/integracao-
indicadores.csv
Contratos: https://downloads.planoparasuaempresa.com.br/plano/layouts/integracao-
contratos.csv
Contratos Carga adicional:

https://downloads.planoparasuaempresa.com.br/plano/layouts/integracao-contratos-
adicional.csv
Fluxo: https://downloads.planoparasuaempresa.com.br/plano/layouts/integracao-
fluxo.csv
Fluxo com Tipo de documento:

https://downloads.planoparasuaempresa.com.br/plano/layouts/integracao-fluxo-com-
tipo-documento.csv

Balanço: https://downloads.planoparasuaempresa.com.br/plano/layouts/integracao-
balanco.csv
Balanço Carga adicional:

https://downloads.planoparasuaempresa.com.br/plano/layouts/integracao-balanco-
adicional.csv
RH: https://downloads.planoparasuaempresa.com.br/plano/layouts/integracao-rh.csv
RH Carga adicional:
https://downloads.planoparasuaempresa.com.br/plano/layouts/integracao-rh-
adicional.csv
Volumes e Custos PA:

https://downloads.planoparasuaempresa.com.br/plano/layouts/integracao-volumes-e-
custos-pa.csv
O layout de Vendas acima, contém 3 categorias que estão identificadas no final da

linha como 001, 001 e 002 antes do código do projeto e código do item da valorização.
Caso o cliente utilize produto com precificação tipo Margem, pode ser passado o custo
unitário de aquisição incluindo o campo como último parâmetro do arquivo logo após o
código do item de valorização.
A descrição da utilização das categorias de venda está no item 5.7.3.
5.8. Executando os processos de integração

Após realizar as configurações do aplicativo, o usuário poderá executar os processos,
selecionando a competência desejada (Caso a importação seja por banco de dados) e
clicando no processo a ser executado. Quando um processo é executado, o usuário
poderá visualizar um log das etapas que o processo passa até ser finalizado. Os
processos disponíveis no menu são:
 Integrar DRE;
 Integrar Fluxo de Caixa;
 Integrar Vendas;
 Integrar Balanço;
 Integrar RH;
 Integrar Volumes e Custos (Produto acabado e Matéria prima);
 Integrar Investimentos;

 Integrar Indicadores;
 Integrar Contratos;
 Integrar arquivos.
Obs.: As 9 primeiras opções só irão aparecer quando a origem da integração for

“Banco de dados” e a última opção só aparece quando a origem for “Arquivo”.
A tela abaixo mostra o log que foi criado:
Todas as informações sobre o processo são gravadas no log e disponibilizadas a

qualquer momento. Caso o usuário queira verificar o log de um processo basta dar um
duplo clique em um processo na seção de processos executados ou último processo
executado. Também poderá acessar o menu opções localizado no canto superior e
selecionar a opção “Ver log do processo selecionado”. Ainda sobre a lista de
processos, os que foram executados com sucesso são marcados com uma bolinha
verde e os que falharam são marcados com uma bolinha vermelha.
Caso ocorra algum erro durante a execução do processo, ele será reportado na tela e
através do envio de um e-mail para o destinatário cadastrado nas configurações do
integrador.

5.8.1. Agendar execução da integração
O usuário poderá ainda criar uma tarefa agendada no Windows para cada processo a
ser executado.
Para isso, basta criar a tarefa que executa um aplicativo e nos argumentos de
execução do aplicativo informar qual processo será executado “DRE”, “FLUXO”,
“VENDAS”, “BALANCO”, “RH”, “VOLUMESECUSTOSPA”, “VOLUMESECUSTOSMP”,
“INVESTIMENTOS”, INDICADORES, CONTRATOS para a origem “Banco de dados” e
“ARQUIVO” para a origem “Arquivo”.
Os processos VOLUMESECUSTOSPA e VOLUMESECUSTOSMP são o

processamento da integração de Volumes e Custos produto acabado e Volumes e
Custos matéria prima respectivamente.
A tela abaixo mostra uma tarefa que executa o aplicativo e está preparada para
processar o DRE:
Atenção: O preenchimento do campo “Iniciar em (opcional)” é obrigatório, por mais

que esteja informado como opcional. O que deve conter nesse campo é o caminho da
pasta onde o arquivo PlanoAgente.exe está localizado.

Quando a origem é “Banco de dados”, o usuário ainda tem a opção de processar
registros de competências anteriores. Para isto basta informar um outro parâmetro
informando quantas competências a partir da atual, o sistema deve retroagir.
A tela abaixo dá o exemplo de um processamento da competência anterior. Entre o

DRE e o -1, deve haver um espaço.
Outro parâmetro que pode ser passado quando a origem é “Banco de dados” é se a
integração será com carga adicional. Para que a carga seja adicional, basta passar o
parâmetro CARGA_ADICIONAL conforme exemplos abaixo:
“DRE -1 CARGA_ADICIONAL”: Executa a integração do mês anterior com carga

adicional
“DRE CARGA_ADICIONAL”: Executa a integração do mês atual com carga adicional
Este parâmetro só é valido para processos que possuem a opção Carga adicional.
Atenção: Não configurar uma periodicidade inferior à 1 hora, pois podem ocorrer
problemas na integração caso seja iniciada antes de ser finalizada outra integração em
andamento.

5.9. Utilizando o mesmo arquivo de configuração para instalação em
outros computadores
Após configuradas as conexões, acesso ao sistema Plano e o servidor para saída de
e-mails, caso o usuário queira instalar o aplicativo em outro computador e reaproveitar
o arquivo de configuração, basta copiar o arquivo Config.agp, localizado no diretório
de instalação do sistema, para a pasta de instalação do sistema no computador em
que o aplicativo foi instalado.
Recomendamos incluir o arquivo Config.agp no processo de backup, pois este arquivo

contém todas as configurações do agente de integração e caso venha a ser
corrompido ou excluído, não será possível recuperar as informações.


Especificação Agente Integrador

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Especificação Agente Integrador

Uploaded by

Copyright:

Available Formats

ESPECIFICAÇÃO

Responsável: Lúcio Vicente de Faria

Rua Gen. Mário Tourinho, 1746 - 11º andar - Bigorrilho, Curitiba/PR

A compatibilidade com as versões superiores será válida enquanto não forem

A instituição certificadora é a Site Blindado (www.siteblindado.com.br).

Rua Gen. Mário Tourinho, 1746 - 11º andar - Bigorrilho, Curitiba/PR

Existem 2 maneiras para realizar a integração dos dados, através de views/tabelas do

Nesta modalidade, as tabelas/views devem ser disponibilizadas nos layouts descritos

Com as views disponíveis, ao executar a integração, o agente irá buscar as

Rua Gen. Mário Tourinho, 1746 - 11º andar - Bigorrilho, Curitiba/PR

Os arquivos devem ser disponibilizados na pasta configurada no item 5.3.

Quando o arquivo estiver disponível na pasta e o usuário ou o sistema de agenda de

4.2. Executando o instalador do aplicativo

Rua Gen. Mário Tourinho, 1746 - 11º andar - Bigorrilho, Curitiba/PR

Obs.: A sugestão é não instalar na pasta Arquivos De Programas ou Arquivos De

Integração por tabelas/views:

Rua Gen. Mário Tourinho, 1746 - 11º andar - Bigorrilho, Curitiba/PR

O usuário também poderá selecionar a competência base para execução do processo

5.1. Configurando a origem da integração

Para selecionar a origem da integração, o usuário irá clicar em Configurações,

Rua Gen. Mário Tourinho, 1746 - 11º andar - Bigorrilho, Curitiba/PR

Ao clicar na opção, o usuário irá visualizar a tela abaixo:

Poderá ser definida uma consulta para cada tipo de integração.

Rua Gen. Mário Tourinho, 1746 - 11º andar - Bigorrilho, Curitiba/PR

5.2. Configurando as conexões de banco de dados

Para configurar as conexões o usuário irá clicar em Configurações e selecionar a aba

Após cadastrada a conexão, o usuário poderá clicar no botão “Testar conexão” e

Rua Gen. Mário Tourinho, 1746 - 11º andar - Bigorrilho, Curitiba/PR

Obs.: O acesso ao banco de dados Oracle é feito através de instância configurada no

Para a conexão do tipo ODBC, os bancos homologados são Progress, HANA e

Para configurar o acesso ao banco de dados Progress, é necessário selecionar ODBC

Rua Gen. Mário Tourinho, 1746 - 11º andar - Bigorrilho, Curitiba/PR

5.3. Configurando a pasta destino para processamento de arquivos

Para configurar a pasta destino, o usuário irá clicar em Configurações e selecionar a

Esta opção permite o processamento de vários arquivos com processos diferentes

O agendamento de tarefas do Windows também pode ser utilizado nesta opção

O agente irá armazenar os arquivos processados em uma pasta chamada

5.4. Configurando o acesso ao sistema Plano

Para configurar o acesso, o usuário irá abrir o menu “Configurações” e selecionar a

As informações que devem ser preenchidas estão demonstradas na imagem abaixo:

Rua Gen. Mário Tourinho, 1746 - 11º andar - Bigorrilho, Curitiba/PR

5.5. Configurando o servidor de e-mail

Para configurar o servidor de saída de e-mails, o usuário irá abrir o menu

As informações que devem ser preenchidas estão demonstradas na imagem abaixo:

Rua Gen. Mário Tourinho, 1746 - 11º andar - Bigorrilho, Curitiba/PR

O usuário poderá também enviar um e-mail teste para validar o processo.

5.5.1. Definindo os destinatários dos e-mails

Dentro da aba configurações o usuário deverá preencher a área Resultado do

5.6. Configurando um servidor proxy para as conexões HTTP

Dentro da aba configurações, o servidor pode ser configurado conforme mostra a

Rua Gen. Mário Tourinho, 1746 - 11º andar - Bigorrilho, Curitiba/PR

5.7. Definição da estrutura das tabelas/views da integração

Os dados das tabelas/views não podem conter caracteres especiais de quebra de

5.7.1. Estrutura da tabela/view para integração do DRE

Nome da Tabela/View: INT_REALIZADODRE

Rua Gen. Mário Tourinho, 1746 - 11º andar - Bigorrilho, Curitiba/PR

5.7.2. Estrutura da tabela/view para integração do Fluxo de caixa

5.7.3. Estrutura da tabela/view para integração de Vendas

Rua Gen. Mário Tourinho, 1746 - 11º andar - Bigorrilho, Curitiba/PR

Não é necessária a criação de todos os campos referentes as categorias e sim apenas

A tela abaixo mostra o cadastro das categorias no sistema Plano:

Rua Gen. Mário Tourinho, 1746 - 11º andar - Bigorrilho, Curitiba/PR

Os dados também devem obedecer à ordem cadastrada no sistema. Para o exemplo

Agrupamento de vendas e valorizações: