CTB0150_Layouts dos Arquivos de Importação dos Rateios (Online, Externo e Offline)

Produto:

Microsiga Protheus

Versões:

12.1.17

Ocorrência:

Informativo do Layout de importação csv Rateios

Procedimento

Não conformidades apontadas

Ações Tomadas

Necessidade de dados informativos sobre o procesomento de importação referentes ao Layout

Criado o procedimento para utilização da rotina conforme dados da processados e validados.

Feito documentação que atenda a necessidade.

Objetivo

Permitir que o usuário por meio das rotinas Rateio Online (CTBA100), Rateio Externo (CTBA120) e Rateio Offline (CTBA270) importe as regras de rateio.

Definição da Regra de Negócio

Nas rotinas de cadastro de rateio (Online, Offline e Externo) o sistema permite a inclusão manual e unitária das definições. Para clientes que trabalham com as regras em planilhas ou outras formas e necessitam incluir as definições finais no Protheus, foi disponibilizado o processo de importação das definições de rateio.

O arquivo possui estrutura especifica, com alguns dados de informação obrigatórios e outros opcionais, de acordo com o tipo de rateio desejado (Online, Offline ou Externo).

A importação ocorre diretamente nas rotinas de cadastro de rateio, acessando Outras Ações→Importar é apresentado os parâmetros necessários para importação e na conclusão, o log do processamento. O log registra as inconsistências que impossibilitaram a importação ou o sucesso e dados resumidos sobre a importação (arquivo, data do processamento, etc.).

O arquivo para importação deve ter o formato Comma-separated values (CSV), utilizando o sinal de ponto e vírgula (;) como separador dos dados.

A primeira linha do arquivo possuirá os campos da tabela do rateio (CT9 – Rateio Online, CTJ – Rateio Offline ou CTQ – Rateio Externo), sem necessidade de ordem especifica. As demais linhas serão os dados dos rateios, sendo informados de acordo com o cabeçalho.

Exemplos:

Online

Exemplo visual:

Arquivo:

Externo

Exemplo visual

Arquivo:

Offline

Exemplo visual:

Arquivo:

Abaixo o Dados da estrutura

Rateio Online

Campo	ID no Arquivo	Descrição
Empresa, Unid. Negócio e Filial	CT9_FILIAL*	Empresa, Unidade de Negócio e Filial para importação
Código do Rateio	CT9_RAT_ON	Código do rateio
Descrição do Rateio	CT9_DESC	Descrição do rateio
Percentual Base	CT9_PERBAS	Percentual Base para o Rateio. O sistema permite que se rateiem valores inferiores a 100%. O sistema aplicará o percentual aqui digitado ao valor a ser rateado, o valor resultante é que será rateado.
Moeda do Rateio	CT9_MOEDAS	Moeda do Lançamento contábil a ser gerado.
Saldo	CT9_TPSALD	Tipo do Saldo a ser gerado.
Tipo de Lançamento	CT9_DC	É o Tipo do lançamento contábil que será gerado ao se utilizar este rateio. Poderá ser: 1 - Débito 2 - Crédito 3 - Partida Dobrada
Débito	CT9_DEBITO	Esta é a Conta Débito do lançamento que será gerado a partir deste rateio.
Crédito	CT9_CREDIT	Esta é a Conta Crédito do lançamento que será gerado a partir deste rateio.
Percentual	CT9_PERCEN	Informa o percentual que será rateado para as Entidades selecionadas nesta linha do rateio. Este valor será aplicado ao percentual base, para se determinar o valor correto do Rateio. Exemplo: Percentual-Base: 80% Valor a Ratear: 1000,00 Percentual da Linha 001 do Rateio: 20% O valor rateado para a Linha 001 será de: 1000 * (80 / 100) * (20/100) = 160,00
Histórico Lançamento	CT9_HIST	Indica qual o Histórico que o Lançamento Contábil gerado a partir do rateio terá.
Lançamento nas Moedas	CT9_MOEDLC	Indica em quais moedas será efetuado o Rateio Online. Informe “1” (Sim) para as moedas nas quais deverão ser efetuados os lançamentos contábeis. Cada “1” corresponde a uma moeda utilizada no sistema. Caso não deseje o lançamento numa moeda, coloque “2” na posição relativa a ela.
Critério de Conversão	CT9_CRITER	Indica o critério de Conversão que será utilizado para cada uma das moedas na Conversão dos Valores rateados.
C Cust Debito	CT9_CCD	Este é o Centro de Custo Débito do lançamento que será gerado a partir do rateio.
C Cust Credito	CT9_CCC	Este é o Centro de Custo Crédito do lançamento que será gerado a partir do rateio.
Item Debito	CT9_ITEMD	Este é o Item Contábil Débito do lançamento que será gerado a partir do rateio.
Item Credito	CT9_ITEMC	Este é o Item Contábil Crédito do lançamento que será gerado a partir do rateio.
Cl VlrDeb	CT9_CLVLDB	Esta é a Classe de Valor Débito do lançamento que será gerado a partir do rateio.
Cl VlrCrd	CT9_CLVLCR	Esta é a Classe de Valor Crédito do lançamento que será gerado a partir do rateio.

* Dados conforme gestão corporativa

Rateio Externo

Campo	ID no Arquivo	Descrição
Empresa, Unid. Negócio e Filial	CTJ_FILIAL*	Empresa, Unidade de Negócio e Filial para importação
Código do Rateio	CTJ_RATEIO	Código do rateio
Descrição do Rateio	CTJ_DESC	Descrição do rateio
Moeda do Rateio	CTJ_MOEDLC	Moeda do Lançamento contábil a ser gerado.
Saldo	CTJ_TPSALD	Tipo do Saldo a ser gerado.
Quantidade Total	CTJ_QTDTOT	Quantidade total do rateio.
Débito	CTJ_DEBITO	Esta é a Conta Débito do lançamento que será gerado a partir deste rateio.
Crédito	CTJ_CREDIT	Esta é a Conta Crédito do lançamento que será gerado a partir deste rateio.
Percentual	CTJ_PERCEN	Informa o percentual que será rateado para as Entidades selecionadas nesta linha do rateio
Histórico Lançamento	CTJ_HIST	Indica qual o Histórico que o Lançamento Contábil gerado a partir do rateio terá.
Critério de Conversão	CRIT_CONV	Indica o critério de Conversão que será utilizado para cada uma das moedas na Conversão dos Valores rateados.
C Cust Debito	CTJ_CCD	Este é o Centro de Custo Débito do lançamento que será gerado a partir do rateio.
C Cust Credito	CTJ_CCC	Este é o Centro de Custo Crédito do lançamento que será gerado a partir do rateio.
Item Debito	ITEM_DEST_DB	Este é o Item Contábil Débito do lançamento que será gerado a partir do rateio.
Item Credito	ITEM_DEST_CR	Este é o Item Contábil Crédito do lançamento que será gerado a partir do rateio.
Cl VlrDeb	CTJ_CLVLDB	Esta é a Classe de Valor Débito do lançamento que será gerado a partir do rateio.
Cl VlrCrd	CTJ_CLVLCR	Esta é a Classe de Valor Crédito do lançamento que será gerado a partir do rateio.

* Dados conforme gestão corporativa

Rateio Offline

Campo	ID no Arquivo	Descrição
Empresa, Unid. Negócio e Filial	CTQ_FILIAL*	Empresa, Unidade de Negócio e Filial para importação
Código do Rateio	CTQ_RATEIO	Código do rateio
Descrição do Rateio	CTQ_DESC	Descrição do rateio
Percentual Base	CTQ_PERBAS	Percentual Base para o Rateio. O sistema permite que se rateiem valores inferiores a 100%. O sistema aplicará o percentual aqui digitado ao valor a ser rateado, o valor resultante é que será rateado.
Bloqueado	CTQ_MSBLQL	Indica se o rateio será considerado no processamento de rateios off-line.
Tipo do Rateio	CTQ_TIPO	Tipo do Rateio Off-Line. Pode ser: 1=Movimento do Mês 2=Saldo Acumulado
Origem Conta	CTQ_CTORI	Conta Origem dos valores a ratear.
Origem C Custo	CTQ_CCORI	Centro de Custo origem dos valores a ratear.
Origem Item Conta	CTQ_ITORI	Item Origem dos valores a ratear.
Origem Cod Cl Val	CTQ_CLORI	Classe de Valor dos valores a ratear.
Partida Conta	CTQ_CTPAR	Conta Contábil partida do lançamento de rateio.
Partida C Custo	CTQ_CCPAR	Centro de Custo partida do lançamento de rateio.
Partida Item Conta	CTQ_ITPAR	Item Contábil partida do lançamento de rateio.
Partida Cod Cl Val	CTQ_CLPAR	Classe de valor partida do lançamento de rateio.
Débito	CTQ_CTCPAR	Esta é a Conta Débito do lançamento que será gerado a partir deste rateio.
Percentual	CTQ_PERCEN	Informa o percentual que será rateado para as Entidades selecionadas nesta linha do rateio. Este valor será aplicado ao percentual base, para se determinar o valor correto do Rateio. Exemplo: Percentual-Base: 80% Valor a Ratear: 1000,00 Percentual da Linha 001 do Rateio: 20% O valor rateado para a Linha 001 será de: 1000 * (80 / 100) * (20/100) = 160,00
C Cust Debito	CTQ_CCCPAR	Este é o Centro de Custo Débito do lançamento que será gerado a partir do rateio.
Item Debito	CTQ_ITCPAR	Este é o Item Contábil Débito do lançamento que será gerado a partir do rateio.
Cl VlrDeb	CTQ_CLCPAR	Esta é a Classe de Valor Débito do lançamento que será gerado a partir do rateio.
Unidade de Medida	CTQ_UM	Unidade de medida do valor informado na linha de rateio. Estas unidades de medida são as mesmas utilizadas no cadastro de produtos.
Valor	CTQ_VALOR	Valor na unidade de medida para cada linha do rateio cadastrada. Por exemplo: Se cadastrada a unidade caixa (CX) no campo CTQ_UM, pode-se informar o valor igual a 100, indicando 100 caixas de rateio para a conta posicionada.
Fórmula de Atualização	CTQ_FORMUL	Fórmula utilizada para determinar o fator da linha de detalhe do rateio. Para atualizar o fator da linha com o resultado da fórmula é necessário utilizar o botão Recalcular. Somente serão aceitos retornos numéricos.
Lançamentos com Intercompany	CTQ_INTERC	Indica se as linhas geradas pela execução do rateio serão marcadas para exportação através da rotina de intercompany.

* Dados conforme gestão corporativa

A opção de importação (Importar) está disponivel no grupo Outras Ações nas rotinas de cadastro de rateio (Protótipo 01):

Rateio Online – CTBA100;
Rateio Externo – CTBA120;
Rateio Offline – CTBA270.

As definições para importação ocorrerem por meio de tela de parâmetros (Protótipo 02), onde são definidas as seguintes informações:

Arquivo para importação (busca por diretório);

Este parâmetro possibilita indicar o arquivo para importação, com extensão .CSV, por meio de busca por diretório.

Sobrescreve regras existentes (Sim/Não):

Este parâmetro define se o sistema ao localizar um código de rateio já existente excluirá ou não o atual para a inclusão do contido no arquivo da importação.

No processamento do arquivo, o sistema efetuará as seguintes validações:

Verificar se o arquivo de importação foi informado;
Verificar se o cabeçalho foi informado;
Verificar se os dados do cabeçalho existem na tabela SX3;
Verificar se os itens foram informados;
Verificar se o tamanho de cada dado não extrapola a capacidade do campo;
Verificar o parâmetro que define se rateios existentes na base serão sobrescritos com rateios presentes no arquivo de importação (com mesmo código de rateio);
Validações padrões da rotina.

O processo de importação possuirá um ponto de entrada, com a seguinte finalidade:

Tratamento dos campos lidos, possibilitando editar por exemplo uma filial obtida de outro sistema.

A importação deverá utilizar o processamento automatizado (MsExecAuto), já existente na rotina Rateio Offline(CTBA270) e que deverá ser desenvolvida para as rotinas Rateio Online(CTBA100) e Rateio Externo(CTBA120).

Na conclusão, havendo sucesso ou falha, será apresentado o log de processamento (Protótipo 03). O log do arquivo processado apresentará os seguintes dados (Protótipo 04):

O arquivo processado;
O usuário que executou a importação;
A data e hora da importação;
As falhas identificadas ou o sucesso da importação.

Os logs de processamento poderão ser consultados executando a opção Log Processamento, que será inclusa no grupo Outras Ações nas rotinas de cadastro de rateio (Protótipo 01).

Cadastro de Evento de Rateio

Existem casos onde os critérios de rateio são os mesmos para um conjunto de contas contábeis como por exemplo contas de água, eletricidade e internet. Para esses casos será criado o cadastro de Eventos de Rateio.

Com essa rotina será possível cadastrar as entidades contábeis (Débito e Crédito) do evento e no processo de importação do arquivo texto (Rateio Online e Rateio Externo), o sistema irá utilizar esse cadastro para complementar as regras de rateio incluídas no arquivo, simplificando o processo.

Importante: Essa opção será disponível apenas para os rateios online e externos.

Exemplo:

Cadastro de Evento:

Código do Evento	Descrição do Evento
0001	Infraestrutura

Item	Código Rateio	Descrição	Conta Débito	Conta Crédito	Entidade Base
001	INF001	Agua	31001	11001	Crédito
002	INF002	Energia Elétrica	31002	11001	Crédito
003	INF003	Internet	31003	11001	Crédito

CT9_EVENTO	CT9_DC	CT9_CCD	CT9_PERCEN
0001	1	111200203	11.34
0001	1	111300304	11.32
0001	1	111300303	12.54
0001	1	530306000	15.90
0001	1	111500300	20.00
0001	1	111500301	5.00
0001	1	111500304	23.90

O sistema irá cadastrar as seguintes regras de rateio:

CT9_RAT_ON	CT9_DESC	CT9_DC	CT9_DEBITO	CT9_CREDIT	CT9_CCD	CT9_PERCEN
INF001	Agua	2		11001		100
INF001	Agua	1	31001		111200203	11.34
INF001	Agua	1	31001		111300304	11.32
INF001	Agua	1	31001		111300303	12.54
INF001	Agua	1	31001		530306000	15.90
INF001	Agua	1	31001		111500300	20.00
INF001	Agua	1	31001		111500301	5.00
INF001	Agua	1	31001		111500304	23.90

CT9_RAT_ON	CT9_DESC	CT9_DC	CT9_DEBITO	CT9_CREDIT	CT9_CCD	CT9_PERCEN
INF002	Energia Elétrica	2		11001		100
INF002	Energia Elétrica	1	31002		111200203	11.34
INF002	Energia Elétrica	1	31002		111300304	11.32
INF002	Energia Elétrica	1	31002		111300303	12.54
INF002	Energia Elétrica	1	31002		530306000	15.90
INF002	Energia Elétrica	1	31002		111500300	20.00
INF002	Energia Elétrica	1	31002		111500301	5.00
INF002	Energia Elétrica	1	31002		111500304	23.90

CT9_RAT_ON	CT9_DESC	CT9_DC	CT9_DEBITO	CT9_CREDIT	CT9_CCD	CT9_PERCEN
INF003	Internet	2		11001		100
INF003	Internet	1	31003		111200203	11.34
INF003	Internet	1	31003		111300304	11.32
INF003	Internet	1	31003		111300303	12.54
INF003	Internet	1	31003		530306000	15.90
INF003	Internet	1	31003		111500300	20.00
INF003	Internet	1	31003		111500301	5.00
INF003	Internet	1	31003		111500304	23.90

Tabelas Utilizadas

· CT9 – Rateio Online

· CTJ – Critérios de Rateio

· CTQ – Rateio Offline

Dicionário de Dados

Dicionário de Dados

Arquivo: CQJ – Cabeçalho do Evento

Índice	Chave
01	CQJ_FILIAL+ CQJ_CODEVE
02	CQJ_FILIAL+ CQJ_DESC

Campo	CQJ_FILIAL
Tipo	Caracter
Tamanho	2
Decimal	0
Contexto	Real
Propriedade	Alterar
Título	Filial
Descrição	Filial do Sistema
Obrigatório	Não
Usado	Não
Browse	Não
Grupo de Campos	033
Help	Filial do Sistema

Campo	CQJ_CODEVE
Tipo	Caracter
Tamanho	6
Decimal	0
Contexto	Real
Propriedade	Alterar
Título	Código
Descrição	Código do Evento
Obrigatório	Sim
Usado	Sim
Browse	Sim
Help	Código do Evento do Rateio
When	INCLUI

Campo	CQJ_DESC
Tipo	Caracter
Tamanho	40
Decimal	0
Contexto	Real
Propriedade	Alterar
Título	Descrição
Descrição	Descrição do Evento
Obrigatório	Sim
Usado	Sim
Browse	Sim
Help	Descrição do Evento do Rateio

Arquivo: CQK – Itens do Evento

Índice	Chave
01	CQK_FILIAL+ CQK_CODEVE+ CQK_ITEM

Campo	CQK_FILIAL
Tipo	Caracter
Tamanho	2
Decimal	0
Contexto	Real
Propriedade	Alterar
Título	Filial
Descrição	Filial do Sistema
Obrigatório	Não
Usado	Não
Browse	Não
Grupo de Campos	033
Help	Filial do Sistema

Campo	CQK_CODEVE
Tipo	Caracter
Tamanho	6
Decimal	0
Contexto	Real
Propriedade	Alterar
Título	Código
Descrição	Código do Evento
Obrigatório	Não
Usado	Não
Browse	Não
Help	Código do Evento do Rateio

Campo	CQK_CODRAT
Tipo	Caracter
Tamanho	6
Decimal	0
Contexto	Real
Propriedade	Alterar
Título	Cód Rateio
Descrição	Código do Rateio
Obrigatório	Sim
Usado	Sim
Browse	Nâo
Help	Código do rateio para a geração da regra de rateio.

Campo	CQK_DESC
Tipo	Caracter
Tamanho	40
Decimal	0
Contexto	Real
Propriedade	Alterar
Título	Descrição
Descrição	Descrição do Item
Obrigatório	Sim
Usado	Sim
Browse	Sim
Help	Descrição do Item do Rateio

Campo	CQK_ITEM
Tipo	Caractere
Tamanho	4
Decimal	0
Contexto	Real
Propriedade	Visualizar
Título	Item
Descrição	Item do Evento
Obrigatório	Sim
Usado	Sim
Browse	Sim
Help	Item do Evento do Rateio

Campo	CQK_ENTBAS
Tipo	Caractere
Tamanho	1
Decimal	0
Contexto	Real
Propriedade	Alterar
Título	Ent Base
Descrição	Entidade Base
Obrigatório	Sim
Usado	Sim
Browse	Sim
Help	Indica qual entidade que o sistema irá gerar a linha que não está no arquivo de importação
Validação	Pertence(‘123’)
Inicializador	‘1’
Combo Box	1=Débito;2=Crédito;3=Não Utiliza

Campo	CQK_DEBITO
Tipo	Caractere
Tamanho	20
Decimal	0
Contexto	Real
Propriedade	Alterar
Título	Conta Debito
Descrição	Conta Debito
Obrigatório	Não
Usado	Sim
Browse	Não
Help	Conta Debito
F3	CT1
Validação	ValidaConta(M->CQK_DEBITO,"1",,,.T.)
Grupo Campo	003

Campo	CQK_CREDIT
Tipo	Caractere
Tamanho	20
Decimal	0
Contexto	Real
Propriedade	Alterar
Título	Conta Credit
Descrição	Conta Credito
Obrigatório	Não
Usado	Sim
Browse	Não
Help	Conta Credito
F3	CT1
Validação	ValidaConta(M->CQK_CREDIT,"1",,,.T.)
Grupo Campo	003

Campo	CQK_CCD
Tipo	Caractere
Tamanho	09
Decimal	0
Contexto	Real
Propriedade	Alterar
Título	C Custo Deb
Descrição	Centro de Custo Debito
Obrigatório	Não
Usado	Sim
Browse	Não
Help	Centro de Custo Debito
F3	CTT
Validação	ExistCPO(‘CTT’)
Grupo Campo	004

Campo	CQK_CCC
Tipo	Caractere
Tamanho	09
Decimal	0
Contexto	Real
Propriedade	Alterar
Título	C Custo Crd
Descrição	Centro de Custo Credito
Obrigatório	Não
Usado	Sim
Browse	Não
Help	Centro de Custo Credito
F3	CTT
Validação	ExistCPO(‘CTT’)
Grupo Campo	004

Campo	CQK_ITEMD
Tipo	Caractere
Tamanho	09
Decimal	0
Contexto	Real
Propriedade	Alterar
Título	Item Debito
Descrição	Item Contabil Debito
Obrigatório	Não
Usado	Sim
Browse	Não
Help	Item Contabil Debito
F3	CTD
Validação	ExistCPO(‘CTD’)
Grupo Campo	005

Campo	CQK_ITEMC
Tipo	Caractere
Tamanho	09
Decimal	0
Contexto	Real
Propriedade	Alterar
Título	Item Credito
Descrição	Item Contabil Credito
Obrigatório	Não
Usado	Sim
Browse	Não
Help	Item Contabil Credito
F3	CTD
Validação	ExistCPO(‘CTD’)
Grupo Campo	005

Campo	CQK_CLVLDB
Tipo	Caractere
Tamanho	09
Decimal	0
Contexto	Real
Propriedade	Alterar
Título	Cl Valor Deb
Descrição	Classe de Valor Debito
Obrigatório	Não
Usado	Sim
Browse	Não
Help	Classe de Valor Debito
F3	CTH
Validação	ExistCPO(‘CTH’)
Grupo Campo	006

Campo	CQK_CLVLCR
Tipo	Caractere
Tamanho	09
Decimal	0
Contexto	Real
Propriedade	Alterar
Título	Cl Valor Crd
Descrição	Classe de Valor Credito
Obrigatório	Não
Usado	Sim
Browse	Não
Help	Classe de Valor Credito
F3	CTH
Validação	ExistCPO(‘CTH’)
Grupo Campo	006

Arquivo: CT9 – Rateio On-Line

Campo	CT9_EVENTO
Tipo	Caractere
Tamanho	6
Decimal	0
Contexto	Real
Propriedade	Alterar
Título	Cod. Evento
Descrição	Código do Evento
Obrigatório	Não
Usado	Não
Browse	Não
Help	Código do Evento do Rateio que será utilizado para a importação da regra de rateio.

Arquivo: CTJ – Critérios de Rateio

Campo	CTJ_EVENTO
Tipo	Caractere
Tamanho	6
Decimal	0
Contexto	Real
Propriedade	Alterar
Título	Cod. Evento
Descrição	Código do Evento
Obrigatório	Não
Usado	Não
Browse	Não
Help	Código do Evento do Rateio que será utilizado para a importação da regra de rateio.

Regras de Integridade

Inclusão

Verificar se existem regras de rateio cadastradas com o mesmo código, se positivo avaliar se o usuário definiu se serão sobrescritas, excluindo a anterior e cadastrando a presente no arquivo de importação; caso contrário não permitir a inclusão.

Exclusão

Verificar se existem regras de rateio cadastradas com o mesmo código, se positivo avaliar se o usuário definiu se serão sobrescritas, excluindo a anterior; caso contrário não excluir.

Árvore de páginas

CTB0150_Layouts dos Arquivos de Importação dos Rateios (Online, Externo e Offline)

Objetivo

Regras de Integridade