Árvore de páginas

Documento de BO

Produto:

Datasul

Ocorrência:

Documentação de BO

Nome Físicodibo/bodi272.p

 

RecordSet

 

Tabela principal utilizada para comunicação dos métodos da BO com o mundo externo e suas respectivas definições.

Param Bonif

Atributo

Tipo

Formato

Descrição

Obr.

Cod-estabel

Char

X(3)

Código Estabelecimento

Sim

Ind-tipo-desc-tabela-desc

Integer

>9

Tipo de aplicação dos descontos da tabela de descontos

 

Ind-data-validade-desconto

Integer

>9

Consistência a ser feita  com relação às datas de validade

 

Ind-bloqueio-desc-max

Integer

>9

Ação tomada quando o desconto máximo do usuário for superado

 

Qtd-meses-avalia-fatur

Integer

>9

Quantidade de meses das estatísticas do faturamento (tabela fat-estat) que serão avaliadas para a concessão de descontos pelo volume do faturamento – conforme tabela descontos.

 

Val-fator-peso-desc-cliente

Integer

>>9

Se a pesquisa da tabela de desconto tiver que considerar somente “o melhor” desconto, este será o peso atribuído ao cliente no momento do cálculo

 

Val-fator-peso-desc-item

Integer

>>9

Se a pesquisa da tabela de desconto tiver que considerar somente “o melhor” desconto, este será o peso atribuído ao item no momento do cálculo

 

Val-fator-peso-desc-refer

Integer

>>9

Se a pesquisa da tabela de descontos tiver que considerar  somente "o melhor" desconto, este será o peso atribuído à referência no momento do cálculo

 

Val-fator-peso-desc-prod

Integer

>>9

Se a pesquisa da tabela de descontos tiver que considerar somente "o melhor" desconto, este será o peso atribuído ao  produto no momento do cálculo

 

Val-fator-peso-desc-fm-com

Integer

>>9

Se a pesquisa da tabela de descontos tiver que considerar somente "o melhor" desconto, este será o peso atribuído à família comercial no momento do cálculo

 

Val-fator-peso-desc-fm

Integer

>>9

Se a pesquisa da tabela de descontos tiver que considerar somente "o melhor" desconto, este será o peso atribuído à família no momento do cálculo

 

Val-fator-peso-desc-matriz

Integer

>>9

Se a pesquisa da tabela de descontos tiver que considerar somente "o melhor" desconto, este será o peso atribuído ao cliente matriz no momento do cálculo

 

Val-fator-peso-desc-canal

Integer

>>9

Se a pesquisa da tabela de descontos tiver que considerar somente "o melhor" desconto, este será o peso atribuído ao canal no momento do cálculo

 

Val-fator-peso-desc-pgto

Integer

>>9

Se a pesquisa da tabela de descontos tiver que considerar somente "o melhor" desconto, este será o peso atribuído à condição de pagamento no momento do cálculo

 

Val-fator-peso-desc-repre

Integer

>>9

Se a pesquisa da tabela de descontos tiver que considerar somente "o melhor" desconto, este será o peso atribuído ao representante no momento do cálculo

 

Val-fator-peso-desc-regiao

Integer

>>9

Se a pesquisa da tabela de descontos tiver que considerar somente "o melhor" desconto, este será o peso atribuído à região no momento do cálculo

 

Val-fator-peso-desc-frete

Integer

>>9

Se a pesquisa da tabela de descontos tiver que considerar somente "o melhor" desconto, este será o peso atribuído ao frete no momento do cálculo

 

Val-fator-peso-desc-qt-min

Integer

>>9

Se a pesquisa da tabela de descontos tiver que considerar somente "o melhor" desconto, este será o peso atribuído à quantidade mínima no momento do cálculo

 

Val-fator-peso-desc-val-fat

Integer

>>9

Se a pesquisa da tabela de descontos tiver que considerar somente "o melhor" desconto, este será o peso atribuído ao volume do faturamento no momento do cálculo

 

Log-bonif-junto-venda

Logical

Sim/Não

Utilizado para indicar se a bonificação e a venda serão

tratados no mesmo pedido através do rateio dos valores

 

Des-sufixo-ped-bonif

Char

X(3)

Sufixo a ser incorporado ao número do pedido de venda do cliente para a geração do pedido de bonificação. Quando esta informação não estiver preenchida, será gerado o próximo número da seqüência.

 

Ind-qtd-bonific

Integer

>9

Cálculo a ser feito na apuração das quantidades de

bonificação

 

Log-gera-ped-bonif-autom

Logical

Sim/Não

Pedidos de bonificação devem ser gerados automaticamente?

 

Ind-geracao-ped-bonif

Integer

>9

Forma de geração do pedido de bonificação quando esta for feita automaticamente pelo sistema

 

Log-atualiz-sit-bonif

Logical

Sim/Não

Indica se, na atualização da situação dos pedidos de venda (suspensão, cancelamento, reativação, etc), o

correspondente pedido de bonificação também deve ser atualizado da mesma forma

 

Cod-tabela-preco-bonif

Char

X(8)

Tabela de preços padrão para pedidos de bonificação

 

Ind-desconto-ped-bonif

Integer

>9

Concessão de descontos a ser dado aos pedidos de bonificação

 

Char-1

Char

X(100)

?

 

Char-2

Char

X(100)

?

 

Log-1

Logical

Sim/Não

?

 

Log-2

Logical

Sim/Não

?

 

Dec-1

Deci-8

->>>>>>>>>>>9.9

?

 

Dec-2

Deci-8

->>>>>>>>>>>9.9

?

 

Int-1

Integer

->>>>>>>>>9

?

 

Int-2

Integer

->>>>>>>>>9

?

 

Data-1

Date

99/99/9999

?

 

Data-2

Date

99/99/9999

?

 

Des-col-label-desconto-desc

Char[5]

X(10)

Nome abreviado, dado pelo usuário, para caracterizar os descontos da tabela de descontos. Utilizado em relatórios e tabelas.

 

Des-labe-desconto

Char[5]

X(25)

Nome dado pelo usuário para caracterizar os descontos da tabela de descontos. Utilizado em cadastros e consultas.

 

Ind-tipo-desconto

Inte[5]

>9

Tipo de tratamento dado aos descontos

 

 

Métodos Básicos

 

Métodos básicos de acesso ao banco de dados, que serão utilizados na base EMS 2.0.

 

 

Método:

GotoKey

 

Descrição:

Reposiciona o registro da tabela param-bonif através da código do estabelecimento

(pcod-estabel).

 

Requisitos: 

Nenhum

 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

c-cod-estabel

Char

 

X

 

 

Código Emitente

 

Queries e Constraints

   

Definição das Queries (acesso ao banco de dados) e Contraints (regras de leitura)  utilizadas para buscar grupos de registros da base de dados.

 

 

Método:

openQueryByCodigo

 

Descrição: 

Busca um conjunto de registro  da tabela param-bonif a partir do código do estabelecimento  passado como parâmetro.

 

Constraints Associados:

setConstraintByCodigo

 

 

Método:

setConstraintByCodigo

 

Descrição:

Recebe os parâmetros da tabela canal-cliente.


Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

c-cod-estabel

Char

 

X

 

 

Código Estabelecimento

 

 

Método:

openQueryByFaixa

 

Descrição: 

Busca um conjunto de registros da tabela param-bonif a partir do c-cod-estabel (inicial e final) passado como parâmetro.

 

Constraints Associados:

setConstraintByFaixa

 

 

Método:

setConstraintByFaixa

 

Descrição: 

Recebe o parâmetro da tabela param-bonif.


Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

p-cod-estabel-ini

Char

 

X

 

 

Código Estabelecimento Inicial

p-cod-estabel-fim

Char

 

X

 

 

Codigo Estabelecimento Final

 

Métodos Negócio

 

Métodos adicionais de atualização e acesso a base de dados .

 

Método: 

validarCamposNaoChave

 

Descrição: 

Método criado para validar os campos que não fazem parte da chave da tabela.

Validações:

  • No folder Descontos pelo menos as informações de um dos descontos deve ser informada;
  • No folder Bonificações, se a tabela de preços para bonificação for preenchida, esta deve estar cadastrada.
  • No folder Fatores, se estiver parametrizado que o tipo de desconto da tabela de desconto

como "o melhor" (param-bonif.tipo-desc-tabela-desc = 1), então todas as informações deste folder, com exceção da quantidade de meses para avaliação do faturamento, são obrigatórias. Caso, contrário devem estar zeradas.

Requisitos:

Nenhum

 


Método: 

validarCamposChave

 

Descrição:

Método criado para validar os campos que fazem parte da chave da tabela.

Validações:

  • Se o Código Estabelecimento estiver preenchido, esta deve estar cadastrada.


Requisitos:

Nenhum

 


Método: 

CriarRegistroParamBonif

 

Descrição:

Na criação de um registro:

Ler o primeiro registro da tabela para-ped.

Se o param-bonif.cod-estabel = para-ped.estab-padrao e existe pelo menos um registro na tabela desconto então o conteúdo do ind-tipo-desconto [1] deve ser igual a 1 e do ind-tipo-desconto [2] deve ser igual a 2.


Requisitos: 

Nenhum 

 


Método: 

ValidarIndTipoDesconto

 

Descrição:

Método implementado para validar os campos ind-tipo-desconto, para que não possa ser informado um registro com mais de um Tipo de Desconto = Bonificação em Percentual (ind-tipo-desconto = 3).


Requisitos: 

Nenhum

 


Método: 

InicializarCamposParamBonif

 

Descrição:

Procedure criada para inicialização dos campos encontrados na tabela param-bonif. Esta procedure utiliza a include dibo/bodi272.i1 que define a temp-table tt-RowObject

Na inclusão de um novo registro:

Inicializa o campo ind-tipo-desconto da tabela param-bonif. 

 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

tt-RowObject

Temp-table

 

 

X

 

Tabela Temporária RowObject

Ini-ind-tipo-desconto

Integer

 

 

X

 

Variável para inicialização do campo ind-tipo-desconto

Requisitos: Nenhum

 

 

Método: 

eliminarRegistroParamBonif

 

Descrição: 

Na eliminação do registro, se param-bonif.cod-estabel = para-ped.estab-padrao e existir pelo menos um registro na tabela desconto, não permitir.


Requisitos: 

Nenhum

 

 

Método: 

alterarRegistroParamBonif

 

Descrição:

Na alteração de um registro:

O usuario somente podera alterar o conteudo do ind-tipo-desconto, se nao existir nenhuma

ocorrencia na tabela desconto cujo conteúdo do respectivo val-desconto seja maior que zeros e se estiver sendo feita alteração no estabelecimento padrão dos parâmetros de pedidos.

Exemplo: Se o usuario quiser alteraro ind-tipo-desconto [4] de 1 para 3, ele so podera faze-lo se nao houver nenhum desconto.val-desconto [4] maior que zeros.


Requisitos: 

Nenhum

 

 

Método: 

retornarLabelsColumnLabelsTiposTabela

 

Descrição:

Método criado para retornar labels, column labels e Tipos de descontos da tabela param-bonif, que serão enviados como parâmetros para interface.


Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

p-label-1

Char

 

 

X

 

Label Desconto 1

p-label-2

Char

 

 

X

 

Label Desconto 2

p-label-3

Char

 

 

X

 

Label Desconto 3

p-label-4

Char

 

 

X

 

Label Desconto 4

p-label-5

Char

 

 

X

 

Label Desconto 5

p-col-label-1

Char

 

 

X

 

Column Label Desconto 1

p-col-label-2

Char

 

 

X

 

Column Label Desconto 2

p-col-label-3

Char

 

 

X

 

Column Label Desconto 3

p-col-label-4

Char

 

 

X

 

Column Label Desconto 4

p-col-label-5

Char

 

 

X

 

Column Label Desconto 5

p-tipo-1

Integer

 

 

X

 

Tipo Desconto 1

p-tipo-2

Integer

 

 

X

 

Tipo Desconto 2

p-tipo-3

Integer

 

 

X

 

Tipo Desconto 3

p-tipo-4

Integer

 

 

X

 

Tipo Desconto 4

p-tipo-5

Integer

 

 

X

 

Tipo Desconto 5

Requisitos: Nenhum

 

 

Método: 

retornarAlertaInterface

 

Descrição:

Método criado para verificar se o módulo está implantado ou não.


Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

i-cod-mensa

integer

 

 

X

 

Recebe mensagem de alerta para o usuário

c-texto

Char

 

 

X

 

Retorna Status

Requisitos: Nenhum

 


Método: 

deleteRowErrors

 

Descrição:

Método criado para limpar a tabela de erros antes de eliminar algum registro. Somente será utilizado em Thin Templates.


Requisitos: 

Nenhum