Identificador de Regra

GER-000PRRAT01

Módulo: GER - Gerais.

Finalidade: Consistir o rateio através de uma regra que será chamada quando houver o recálculo de rateio ou o usuário clicar no botão "OK" na tela de rateio.

Características: Os valores das variáveis: "VSContaFinLinha, VSContaCtbLinha e VSCCustoLinha" somente estarão disponíveis quando o tipo da regra for "VSRECALCULALINHA ou VSTELALINHA".
Este identificador está ligado à uma regra. Disponibilizada a função "TotalRateado" (Projeto, Fase, Cta.Financeira, Cta.Contábil, CentroCusto, Retorno ValorTotal). Esta função retorna o valor total rateado e pode ser utilizado independente da empresa possuir projeto e plano financeiro, basta nestes casos passar o valor 0 (zero) para o Projeto, Fase e Conta Financeira.

Transação: Pode ser utilizado uma transação específica para a regra.

Regra:

Segue exemplo de uma regra:
Definir Alfa VSAbreTelaViaRegra;
Definir Alfa VSTipoRegra;
Definir Alfa VSOrigem;
Definir Alfa VSTipoObservacao;
Definir Alfa VSObrigaRateio;
Definir Numero vValorNumero;
Definir Alfa vValorAlfa;
Definir Alfa vMensagem;
Definir Alfa VSTransacao;
Definir Alfa VSCCustoLinha;
Definir Numero VSContaFinLinha;
Definir Numero VSContaCtbLinha;
Se (VSTipoRegra = "TELALINHA")
inicio
Se (VSCCustoLinha = "112")
Mensagem(Erro,"Não é possível informar manualmente o centro de custo 112.");
Se (VSContaFinLinha = 80)
Mensagem(Erro,"Não é possível informar manualmente a conta financeira 80.");
Se (VSContaCtbLinha = 1010)
Mensagem(Erro,"Não é possível informar manualmente a conta contábil 1010.");
fim;
Se ((VSOrigem = "E600RAT") ou ((VSOrigem = "E600RCH") e (VSObrigaRateio = "SIM")))
inicio
TotalContasCentroCusto(0,0,"111",vValorNumero);
Se (vValorNumero > 50)
inicio
ConverteMascara(2, vValorNumero, vValorAlfa, "ZZZ.ZZZ.ZZZ.ZZ9,99");
LimpaEspacos(vValorAlfa);
vMensagem = "Valor do centro de custo '111' é de R$ " + vValorAlfa + " e o máximo permitido é R$ 50,00.";
VSAbreTelaViaRegra = "SIM";
Se (VSTipoRegra = "TELA")
Mensagem(Erro, vMensagem);
Senao
inicio
vMensagem = vMensagem + "[&OK]";
Mensagem(Retorna, vMensagem);
fim;
fim;
Se ((VSTipoRegra = "TELA") e (VSTipoObservacao <> "COMPLETO"))
inicio
vMensagem = "O tipo da observação do rateio é '" + VSTipoObservacao + "', é necessário informar todas as observações para os centro de custos !";
Mensagem(Erro,vMensagem);
fim;
fim;

Variáveis Disponibilizadas:

Nome	Tipo	Observações	Retorna Valor
VSTIPOREGRA	ALFA	Indica qual é o ponto de onde a regra está sendo chamada. Valores: RECALCULA - É chamado em vários pontos do sistema e de diversas formas. Nem sempre quando é chamado a regra com o tipo recalcula será mostrada a tela para confirmação do rateio. Caso encontrar alguma inconsistência no rateio no recalcula, sugerimos mostrar mensagem de aviso com a consistência e setar o valor da variável VSAbreTelaRateioViaRegra = SIM. RECALCULALINHA - É chamado para cada linha do rateio antes de chamar o tipo RECALCULA. TELA - É chamado quando o usuário clicar no botão OK na tela de rateio. TELALINHA - É chamado para cada linha do rateio antes de chamar o tipo TELA.	N
VSVALORBASE	NÚMERO	Indica qual o valor/quantidade para fechamento do rateio	N
VSCRITERIO	ALFA	Indica qual o critério para busca dos rateios definidos	N
VSDATABASE	DATA	Indica qual é a data base para atualização do plano financeiro.	N
VSMESANO	DATA	É automaticamente calculado após informar a DataBase. Serve para facilitar a atualização do saldo financeiro (caso for necessário atualizar)	N
VSCONTAFINCLASSIFICA	NÚMERO	Indica qual a conta financeira a classificar	N
VSCONTACTBCLASSIFICA	NÚMERO	Indica qual a conta contábil a classificar	N
VSCCUSTOCLASSIFICAR	ALFA	Indica qual é o centro de custo a classificar	N
VSTIPORATEIO	ALFA	Indica qual é o tipo do rateio: Valores: FINANCEIRO - Possui plano financeiro ligado a empresa. CONTABIL - Não possui plano financeiro, mas possui plano contábil ligado a empresa. CENTRO CUSTO - Não possui plano financeiro e contábil, mas possui plano de centro de custos ligado a empresa.	N
VSORIGEM	ALFA	Nome da tabela de rateio que está sendo rateada.	N
VSTRANSACAO	ALFA	Código da transação passado para o rateio	N
VSCONTAFINLINHA	NÚMERO	Código da conta financeira da linha do rateio	N
VSCONTACTBLINHA	NÚMERO	Código da conta contábil da linha do rateio	N
VSCCUSTOLINHA	ALFA	Código do centro de custo da linha do rateio	N
VSTIPOACAO	ALFA	Indica qual a ação que será realizada na atualização do saldo do plano financeiro. Valores: SOMAR COMPETÊNCIA - O campo SomSub da tabela de rateio será igual a 1. SOMAR CAIXA - O campo SomSub da tabela de rateio será igual a 2. SOMAR COMPETÊNCIA/CAIXA - O campo SomSub da tabela de rateio será igual a 3. SUBTRAIR COMPETÊNCIA - O campo SomSub da tabela de rateio será igual a 4. SUBTRAIR CAIXA - O campo SomSub da tabela de rateio será igual a 5. SUBTRAIR COMPETÊNCIA/CAIXA - O campo SomSub da tabela de rateio será igual a 6. NÃO CONSIDERAR - O campo SomSub da tabela de rateio será igual a 7.	N
VSRATEIOALTERADO	ALFA	Indica se o rateio foi alterado após mostrar a tela. Valores: SIM - Houve alteração. NÃO - Não houve alteração.	N
VSOPERACAORATEIO	ALFA	Indica qual é o tipo da operação do rateio. Valores: INCLUSÃO - O rateio está sendo incluído. ALTERAÇÃO - O rateio está sendo alterado. EXCLUSÃO - O rateio está sendo excluído. CONSULTA - O rateio somente está sendo consultado, o usuário não possui permissão para alterar o rateio ou o mesmo está contabilizado.	N
VSATUALIZASALDOS	ALFA	Indica se o saldo do plano financeiro será atualizado. Valores: SIM - O plano financeiro será alterado. NÃO - O plano financeiro não será alterado.	N
VSUSUARIOALTERARATEI	ALFA	Indica se o usuário possui permissão para ver o rateio. Valores: SIM - Usuário pode ver a tela de rateio. NÃO - Usuário não pode ver a tela de rateio.	N
VSTIPOVALOR	ALFA	Indica qual é o tipo do valor para fechamento. Valores: VALOR - Utilizado em todo o financeiro e parte do comercial. QUANTIDADE - Utilizado em parte do comercial para ratear produtos/serviços.	N
VSPRECISAO	ALFA	Indica qual é a precisão decimal para o fechamento do rateio.	N
VSPRODUTO	ALFA	Indica qual é código do produto do item do rateio a ser rateado.	N
VSSERVICO	ALFA	Indica qual é o código do serviço do item do rateio a ser rateado	N
VSDERIVACAO	ALFA	Indica qual é o código da derivação do item do rateio a ser rateada	N
VSSEQUENCIA	NÚMERO	Indica qual é a sequencia do item do rateio a ser rateado	N
VSTIPONATUREZACONTAS	ALFA	Indica qual é o tipo da natureza das contas, é utilizado na consistências das contas e atualização do saldo financeiro. Valores: CREDORA - Contas de receitas. DEVEDORA - Contas de despesas.	N
VSFORMARATEIO	ALFA	Indica qual é a forma de rateio da transação. Valores: SEM RATEIO - O campo ForRat da tabela de transação é igual = 0. COM CONFIRMAÇÃO - O campo ForRat da tabela de transação é igual = 1. SEM CONFIRMAÇÃO - O campo ForRat da tabela de transação é igual = 2. MANUAL - O campo ForRat da tabela de transação é igual = 3. NENHUMA - O campo ForRat da tabela de transação é igual = 0.	N
VSOBRIGARATEIO	ALFA	Indicativo se a rotina esta obrigando o rateio. Valores: SIM - O rateio é obrigatório. NÃO - O rateio não é obrigatório.	N
VSTIPOSALDO	ALFA	Indicativo do tipo do saldo para atualizar o saldo do plano financeiro. Valores: PLANO FINANCEIRO - Todas as tabelas que movimentam o financeiro (E301RAT, E501RAT, E504RAT e E600RAT). FORMA RATEIO - Nestes tabelas que movimentam o plano financeiro, deve considerar-se a forma de rateio da transação e possui o identificador GER - 000PLANO01 ativo. NENHUM - Não atualiza o plano financeiro.	N
VSTIPOOBSERVACAO	ALFA	Indicativo de como está as observações do rateio. Valores: COMPLETO - Todas as linhas dos centro de custos possuem rateio. INCOMPLETO - Pelo menos uma das linhas possui rateio e outra não possui. NÃO	N
VSCHAVEORIGEM	ALFA	Contém o valor da chave da tabela de rateio que está sendo rateada.	N
VSNUMEROPRJLINHA	NÚMERO	Código do projeto da linha do rateio	N
VSFASEPRJLINHA	NÚMERO	Código da fase do projeto da linha do rateio	N
VSCOMPLEMENTO	ALFA	Indica qual é o complemento do item do rateio a ser rateado	N
VSQTDREGRATEIO	NÚMERO	Quantidade de rateio	N
VSABRETELAVIAREGRA	ALFA	Indica se após recalcular o rateio, deverá abrir a tela de rateio. Valores: SIM - Abre a tela de rateio após o recálculo independente das parametrizações (forma rateio, etc). NÃO - É o valor padrão e continua o processo normalmente. Se o rateio for executado a partir da integração contábil o valor da variável será fixado como NÃO.	S

Atenção

Caso o parâmetro global LisVarReg esteja habilitado, a variável ListaVariaveis estará disponível em todos os identificadores de regras do sistema. O conteúdo desta variável lista os campos disponibilizados no identificador de regras em questão.

Não é aconselhada a ativação desse parâmetro global para o uso cotidiano. Esse recurso de listagem dos campos de identificadores auxilia a construção de regras e o Suporte para, por exemplo, depuração ou quando não houver acesso à documentação dos identificadores de regras.

PORTAL DE DOCUMENTAÇÃO
Gestão Empresarial \| ERP - versão 5.10.2 (XTended)