Documento de BO
Produto: | Datasul |
Ocorrência: | Documentação de BO |
Nome Físico | dibo/bodi233.p |
RecordSet
Tabela principal utilizada para comunicação dos métodos da BO com o mundo externo e suas respectivas definições.
tt-descontos | |||||
Atributo | Tipo | Formato | Descrição | Obr. | |
Cod-cond-pag | inte | >>9 | Código Condição Pagamento |
| |
Cod-emitente | inte | >>>>>>>>9 | Código Cliente |
| |
it-codigo | char | x(16) | Código Item |
| |
Cod-refer | char | x(8) | Código Referência |
| |
Cod-rep | inte | >>>>9 | Código Representante |
| |
fm-codigo | char | x(8) | Código Família |
| |
fm-cod-com | char | x(8) | Código Família Comercial |
| |
Cdn-cliente-matriz | inte | >>>>>>>>9 | Código do cliente matriz |
| |
Nome-ab-reg | char | x(12) | Região |
| |
Situacao | inte | >9 | Situação do desconto |
| |
qt-minima | deci-4 | >>>,>>>,>>9.999 | Quantidade mínima |
| |
vl-desconto | deci-2 | >>,>>9.99 | Valor do desconto |
| |
Perc-desconto | deci-2 | >>9.99 | Percentual de desconto |
| |
Ind-frete | inte | >9 | Tipo de frete |
| |
Cod-canal-venda | inte | >>9 | Código do canal de venda |
| |
Char-1 | char | x(100) |
|
| |
Char-2 | char | x(100) |
|
| |
Dec-1 | deci-8 | ->>>>>>>>>>>9.9 |
|
| |
Dec-2 | deci-8 | ->>>>>>>>>>>9.9 |
|
| |
int-1 | inte | ->>>>>>>>>9 |
|
| |
int-2 | inte | ->>>>>>>>>9 |
|
| |
Log-1 | logi | Sim/Não |
|
| |
Log-2 | logi | Sim/Não |
|
| |
Data-1 | date | 99/99/9999 |
|
| |
Data-2 | date | 99/99/9999 |
|
| |
Cod-desconto | inte | >,>>>,>>>,>>9 | Campo interno para controlar qual desconto foi aplicado no pedido/nota fiscal/cotação | Sim | |
Check-sum | char | x(20) |
|
| |
Dat-ult-atualiz | date | 99/99/9999 | Data da última atualização do desconto |
| |
Cod-usuario-atualiz | char | x(12) | Código do usuário da última atualização |
| |
Hra-ult-atualiz | char | x(8) | Hora da última atualização |
| |
Dat-ini-val | date | 99/99/9999 | Data de inicio de validade | Sim | |
Val-faturamento | deci-2 | >>>,>>>,>>>,>>9 | Volume de faturamento que deve ser verificado para concessão ou não de descontos - verificado nas estatísticas de faturamento (tabela fat-estat) pela quantidade de meses parametrizada no módulo |
| |
Dat-fim-validade | date | 99/99/9999 | Data de fim de validade | Sim | |
Cdn-desconto-pgto | inte | >>,>>>,>>9 | Código do desconto por prazo de pagamento |
| |
Cdn-desconto-periodo | inte | >>,>>>,>>9 | Código do desconto por período |
| |
Log-concede-bonif-qtd | logi | Sim/Não | Indica se será concedida bonificação em quantidade, ou seja, se a quantidade vendida deste item implicará em bonificação de um outro item numa quantidade proporcional a essa |
| |
Val-desconto | deci-5[5] | >>>,>>>,>>9.999 | Desconto Período Descontos da tabela de descontos, em percentual ou valor, conforme parâmetros do módulo. Descontos parametrizados (de 1 a 5) da tabela de descontos | Sim | |
Cod-moeda | inte | >9 | Código da moeda |
| |
Cod-produto-coml | char | x(16) | Código do produto comercial |
| |
Atributo | Tipo | Formato | Descrição |
| |
Destino | Integer |
| Valor da impressão (Arquivo/Impressora) |
| |
arquivo | Char |
| Local onde o programa irá gerar o arquivo |
| |
usuario | char |
| Usuário que acessou o sistema |
| |
data-exec | Date |
| Data de execução do programa |
| |
hora-exec | Integer |
| Hora de execução do programa |
| |
c-cgc-ini | Char | X(19) | C.G.C. inicial |
| |
c-cgc-fim | Char | X(19) | C.G.C. final |
| |
i-emitente-ini | Integer | >>>>>>>>9 | Código Emitente Inicial |
| |
tt-desconto |
| ||||
i-emitente-fim | Integer | >>>>>>>>9 | Código Emitente Final |
| |
c-cod-produto-ini | Char | X(19) | Produto Inicial |
| |
c-cod-produto-fim | char | X(19) | Produto Final |
| |
c-item-ini | Char | X(16) | Item Inicial |
| |
c-item-fim | Char | X(16) | Item Final |
| |
c-refer-ini | Char | X(8) | Referência Inicial |
| |
c-refer-fim | Char | X(8) | Referência Final |
| |
c-fm-com-ini | Char | X(8) | Família Comercial Inicial |
| |
c-fm-com-fim | Char | X(8) | Família Comercial Final |
| |
c-fm-cod-ini | Char | X(8) | Família Inicial |
| |
c-fm-cod-fim | Char | X(8) | Família Final |
| |
c-cdn-cliente-matriz-ini | Integer | >>>>>>>>9 | Código Cliente Matriz Inicial |
| |
c-cdn-cliente-matriz-fim | Integer | >>>>>>>>9 | Código Cliente Matriz Final |
| |
i-canal-ini | Integer | >>9 | Código Canal Venda Inicial |
| |
i-canal-fim | Integer | >>9 | Código Canal Venda Final |
| |
i-cond-pag-ini | Integer | >>9 | Código Condição Pagamento Inicial |
| |
i-cond-pag-fim | Integer | >>9 | Código Condição Pagamento Final |
| |
i-cod-rep-ini | Integer | >>>>9 | Código Representante Inicial |
| |
i-cod-rep-fim | Integer | >>>>9 | Código Representante Final |
| |
c-nome-reg-ini | Char | X(12) | Região Inicial |
| |
c-nome-reg-fim | Char | X(12) | Região Final |
| |
d-qt-minima-ini | Decimal | >>>,>>>,>>9.9999 | Quantidade Mínima Inicial |
| |
d-qt-minima-fim | Decimal | >>>,>>>,>>9.9999 | Quantidade Mínima Final |
| |
de-val-faturamento-ini | Decimal | >>>,>>>,>>9.99 | Valor Faturamento Inicial |
| |
de-val-faturamento-fim | Decimal | >>>,>>>,>>9.99 | Valor Faturamento Final |
| |
i-frete | Integer | >9 | Frete |
| |
i-situacao | Integer | >9 | Situação |
| |
t-atualiza | Logical | Sim/Não | Atualiza Data Validade |
| |
d-data | Date |
| Data Validade a ser Atualizada |
| |
l-perc-sobre-perc | Logical | Sim/Não | Atualiza percentual de correção sobre percentual |
| |
d-corr-perc | Decimal |
| Percentual de correção sobre percentual |
| |
l-perc-valor | Logical | Sim/Não | Atualiza percentual de correção sobre valor |
| |
d-corr-valor | Decimal |
| Valor de correção sobre valor |
| |
i-trunca | Integer |
| Valor Final |
| |
l-vl-corr | Logical | Sim/Não |
|
| |
d-valor-corr | Decimal |
|
|
| |
l-cond-pag | Logical | Sim/Não |
|
| |
l-desc-periodo | Logical | Sim/Não | Atualiza Desconto Período |
| |
i-cdn-desconto-periodo | Integer | >>,>>>,>>9 | Valor Desconto Período |
| |
l-desc-pgto | Logical | Sim/Não | Atualiza Desconto Pagamento |
| |
i-cdn-desconto-pgto |
|
| Valor Desconto Pagamento |
| |
l-cons-info-bonif | Logical | Sim/Não | Atualiza Informações Bonificações |
| |
l-cons-desc-zerado | Logical | Sim/Não | Considera Descontos Zeros |
| |
i-opcao-perc | Integer |
| Opções para Percentual |
| |
i-opcao-valor | Integer |
| Opções para Valor |
| |
l-atu-desc-11 | Logical | Sim/Não | Atualiza Desconto 1 |
| |
l-atu-desc-12 | Logical | Sim/Não | Atualiza Desconto 2 |
| |
l-atu-desc-13 | Logical | Sim/Não | Atualiza Desconto 3 |
| |
l-atu-desc-14 | Logical | Sim/Não | Atualiza Desconto 4 |
| |
l-atu-desc-15 | logical | Sim/Não | Atualiza Desconto 5 |
| |
l-atu-desc-21 | logical | Sim/Não | Atualiza Desconto 1 |
| |
l-atu-desc-22 | logical | Sim/Não | Atualiza Desconto 2 |
| |
l-atu-desc-23 | logical | Sim/Não | Atualiza Desconto 3 |
| |
l-atu-desc-24 | logical | Sim/Não | Atualiza Desconto 4 |
| |
l-atu-desc-25 | logical | Sim/Não | Atualiza Desconto 5 |
| |
l-atu-desc-31 | logical | Sim/Não | Atualiza Desconto 1 |
| |
l-atu-desc-32 | logical | Sim/Não | Atualiza Desconto 2 |
| |
l-atu-desc-33 | Logical | Sim/Não | Atualiza Desconto 3 |
| |
l-atu-desc-34 | Logical | Sim/Não | Atualiza Desconto 4 |
| |
l-atu-desc-35 | Logical | Sim/Não | Atualiza Desconto 5 |
|
Métodos Básicos
Métodos básicos de acesso ao banco de dados.
Método:
goToKey
Descrição:
Reposiciona o registro da tabela desconto através da chave primária código do desconto passado como parâmetro.
Requisitos:
Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
i-cod-deconto | Char | X(4) | X |
|
| Número Desconto |
Método:
goToChDesconto
Descrição:
Reposiciona o registro da tabela desconto através dos parâmetros do índice ch-desconto.
Requisitos:
Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
i-cod-emitente | Int |
| X |
|
| Cliente |
c-it-codigo | Char |
| X |
|
| Item |
c-fm-cod-com | Char |
| X |
|
| Família Comercial |
i-cod-canal-venda | Int |
| X |
|
| Canal Venda |
i-cod-produto | Int |
| X |
|
| Produto |
i-cdn-cliente-matriz | Int |
| X |
|
| Cliente matriz |
c-fm-codigo | Chart |
| X |
|
| Família |
i-cod-cond-pag | Int |
| X |
|
| Condição de pagamento |
i-cod-rep | Int |
| X |
|
| Representante |
c-nome-ab-reg | Char |
| X |
|
| Região |
c-cod-refer | Char |
| X |
|
| Referência |
i-ind-frete | Int |
| X |
|
| Frete |
De-qt-minima | Dec |
| X |
|
| Quantidade Mínima |
De-val-faturamento | Dec |
| X |
|
| Faturamento |
i-situacao | Int |
| X |
|
| Situação |
Da-dat-ini-val | Date |
| X |
|
| Data inicial da validade |
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:
openQueryStatic (“ByChDesconto”)
Descrição:
Busca um conjunto de registros da tabela desconto a partir dos campos do índice ch-desconto passados como parâmetro.
Constraints Associados:
setconstraintByChDesconto
Método:
setconstraintByChDesconto
Descrição:
Recebe os parâmetros para reposicionar a query.
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
P-cod-emit-ini | Int |
| X |
|
| Cliente inicial |
p-cond-pag-ini | Int |
| X |
|
| Cond Pgto |
p-familia-ini | Char |
| X |
|
| Família |
p-famili-com-ini | Char |
| X |
|
| Família Comercial |
p-regiao-ini | Char |
| X |
|
| Região |
p-repres-ini | Int |
| X |
|
| Representante |
p-item-ini | Char |
| X |
|
| Item |
p-refer-ini | Char |
| X |
|
| Referência |
p-cod-canal-venda-ini | Int |
| X |
|
| Canal Venda |
p-quant-min-ini | Dec |
| X |
|
| Qt Mínima |
p-tipo-frete-ini | Int |
| X |
|
| Frete |
p-dt-ini-l | Date |
| X |
|
| Dat inicial |
p-cod-produto-ini | Char |
| X |
|
| Produto |
p-cliente-matriz-ini | Int |
| X |
|
| Cliente Matriz |
p-situacao-ini | Int |
| X |
|
| Situação |
p-valor-fat-ini | Dec |
| X |
|
| Volume Faturamento |
Método:
openQueryStatic (“PerfilCliente”)
Descrição:
Busco um conjunto de registro da tabela desconto a partir do cod-emitente passado como parâmetro.
Constraints Associados:
setconstraintPerfilCliente
Método:
SetconstraintPerfilCliente
Descrição:
Recebe o parâmetro da tabela desconto.
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
P-cod-emit | Char |
| X |
|
| Codigo do Cliente |
Método:
openQueryPerfilRepresentante
Descrição:
Busca um conjunto de registro da tabela desconto a partir do cod-rep passado como parâmetro.
Constraints Associados:
setconstraintPerfilRepresentante
Método:
setconstraintPerfilRepresentante
Descrição:
Recebe o parâmetro da tabela desconto.
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
P-cod-rep | Char |
| X |
|
| Representante |
Métodos Negócio
Métodos adicionais de atualização e acesso a base de dados.
Método:
chamarRealizacaoCalculosTabelaDescontos
Descrição:
Método para chamar a procedure "realizarCalculosTabelaDescontos" que está na extensão do bodi233, chamada bodi233q01.p. Esse bo de extensão faz os cálculos de descontos , conforme solicitados pelo CD1520.
Requisitos:
Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
Tt-param | Temp table |
| X |
|
| Temp table c/ informações da template de relatório. |
Tt-bo-erro | Temp Table |
|
| X |
| Temp table de erro |
Método:
incrementarSequenciaCodigoDesconto
Descrição:
Método implementado para incrementar a seqüência do código de desconto. Será chamado a cada nova inclusão de um desconto. Estará enviando para a interface o parâmetro nr-sequencia-cod, que contém a última seqüência mais um. Numa inclusão, deverá ser sugerido no campo desconto.cod-desconto.
Requisitos:
Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
nr-sequencia-cod | Int |
|
| X |
| Seqüência do código de desconto |
Método:
testarModuloDescontoseBonificoes
Descrição
Método implementado para que, caso o modulo de Descontos e Bonificações não esteja implantado, retornar essa mensagem para a interface. Dois parâmetros são enviados para a interface :
* O número da mensagem
* O texto que é usado como parâmetro para montar a mensagem.
Requisitos:
Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
Cod-mensa | Int |
|
| X |
| Código Mensagem |
c-texto | char |
|
| X |
| Retorna Texto |
Método:
pesquisarDescontoTabelaDesconto
Descrição:
Método para pesquisar o desconto conforme a politica dos param bonif. Os descontos podem ser : melhor, somatório e cascata. O parametro de entrada é uma temp table com os campos chaves para pesquisar a tabela desconto. Os parametros de saida são duas temp tables : uma com a soma dos descontos encontrados ( tt-resultado-desconto ) e outra com todos os descontos encontrados (tt-desc-ped-item). Essa procedure é baseada no programa pd0508r.p.
Requisitos:
Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
Tt-param-desconto | Temp Table |
| X |
|
| Temp table param desconto |
Tt-desc-ped-item | Temp Table |
|
| X |
| Temp Table desconto pedido item |
Tt-resultado-desconto | Temp table |
|
| X |
| Temp Table resultado desconto |
Método:
validarCamposTabelaDesconto
Descrição
Método de validação dos campos da tabela de descontos que não forem chaves.
Requisitos:
Nenhum
Parâmetros:
Nenhum
Método:
validarChaveDesconto
Descrição
Método para validação dos campos da tabela de descontos que são chave da tabela.
Requisitos:
Nenhum
Parâmetros:
Nenhum
Método:
validarInformacoesRelatorio
Descrição:
Método para validar as informações que foram enviadas na tt-param (procedure receberParametrosCalculo)
Requisitos:
Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
tt-param | Temp Table |
| X |
|
| Temp Table com parametros de seleção |
tt-bo-erro | Temp Table |
|
| X |
| Temp table com erros |
Método:
verificarRelacoesDesconto
Descrição
Método implementado para realizar a validação na eliminação da tabela desconto e verificar se
o desconto está sendo usado nas tabelas desc-cot-ped-i, desc-it-nota-fisc e desc-ped-item. Caso esteja , não será possível eliminar o registro e será retornado uma mensagem de erro para a temp-table de erros tt-bo-erros.
Requisitos:
Nenhum
Parâmetros:
Nenhum
Método:
validarInformacoesRelatorio
Descrição:
Método para validar as informações que foram enviadas na tt-param ( procedure receberParametrosCalculo ). Essa procedure é usada pelo CD1520.
Requisitos:
Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
tt-param | Temp Table |
| X |
|
| Temp Table com parametros de seleção |
tt-bo-erro | Temp Table |
|
| X |
| Temp table com erros |
Método:
deletettboerro
Descrição
Método criado para limpar a tabela tt-bo-erro antes de eliminar algum registro. Criado para ser utilizado em Thin Templates.
Requisitos:
Nenhum
Parâmetros:
Nenhum