Documento de BO
Produto: | Datasul |
Ocorrência: | Documentação de BO |
| Nome Físico | dibo/bodi605.p |
Considerações Gerais
Objetivo
Esta BO tem como objetivo a manipulação dos dados referentes a tabela histor-pdven (Histórico Pedido de Venda).
Funcionamento
Na forma padrão, realiza-se a chamada através de um comando RUN normal, passando-se as temp-tables carregadas com as informações necessárias.
A execução na forma persistente é realizada através da chamada de um comando RUN conforme exemplo a seguir.
A sintaxe para executar a BO em modo persistente é:
RUN dibo/bodi605.p PERSISTENT SET h-bodi605. |
A variável denominada h-handle irá receber o “handle” do programa, permitindo o acesso aos “métodos” internos da BO.
Tabelas Temporárias
Nos atributos das tabelas temporárias de entrada e saída:
tt-histor-pdven | Entrada/Saída | ||||
Histórico Pedido de Venda | Entrada/Saída | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
nom-abrevi-clien | character | x(12) | Nome Abreviado | Sim |
|
cod-ped-clien | character | x(12) | Pedido Cliente | Sim |
|
cdn-grp-clien | date | 99/99/9999 | Histórico | Sim |
|
hra-histor | character | 99:99:99 | Hra Histórico | Sim |
|
cod-classif | character | x(08) | Classificação | Sim |
|
cdn-tip-histor | Integer | >>>,>>9 | Tipo Histórico | Sim |
|
des-histor | character | x(2000) | Histórico | Não |
|
cod-usuar | character | x(12) | Código Usuário | Não |
|
des-compl | character | x(40) | Complemento | Sim |
|
cod-livre-1 | character | x(100) | Código Livre 1 | Não |
|
cod-livre-2 | character | x(500) | Código Livre 2 | Não |
|
dat-livre-1 | date | 99/99/9999 | Data Livre 1 | Não |
|
dat-livre-2 | date | 99/99/9999 | Data Livre 2 | Não |
|
log-livre-1 | logical | Sim/Não | Lógico Livre 1 | Não |
|
log-livre-2 | logical | Sim/Não | Lógico Livre 2 | Não |
|
num-livre-1 | integer | >>>>>>>>9 | Número Livre 1 | Não |
|
num-livre-2 | integer | >>>>>>>>9 | Número Livre 2 | Não |
|
val-livre-1 | decimal | ->>>>>>>>>>>9.99999999 | Valor Livre 1 | Não |
|
val-livre-2 | decimal | ->>>>>>>>>>>9.99999999 | Valor Livre 2 | Não |
|
r-Rowid | Rowid |
|
| Não |
|
Método Básico
getCharField | ||
Requisito | Nenhum | |
Sintaxe | RUN getCharField IN handle (INPUT <character>, OUTPUT <character>). | |
Descrição | Retorna valor dos campos do tipo caracter | |
Parâmetros | Descrição | |
pFieldName | Nome do campo caracter que será retornado o valor | |
| pFieldValue | Valor contido no campo solicitado |
Retorno | A BO irá retornar o valor contido no campo caracter que foi solicitado a BO. | |
getDateField | ||
Requisito | Nenhum | |
Sintaxe | RUN getDateField IN handle (INPUT <character>, OUTPUT <date>). | |
Descrição | Retorna valor dos campos do tipo data | |
Parâmetros | Descrição | |
pFieldName | Nome do campo data que será retornado o valor | |
| pFieldValue | Valor contido no campo solicitado |
Retorno | A BO irá retornar o valor contido no campo data que foi solicitado a BO. | |
getDecField | ||
Requisito | Nenhum | |
Sintaxe | RUN getDecField IN handle (INPUT <character>, OUTPUT <decimal>). | |
Descrição | Retorna valor dos campos do tipo decimal | |
Parâmetros | Descrição | |
pFieldName | Nome do campo decimal que será retornado o valor | |
| pFieldValue | Valor contido no campo solicitado |
Retorno | A BO irá retornar o valor contido no campo decimal que foi solicitado a BO. | |
getIntField | ||
Requisito | Nenhum | |
Sintaxe | RUN getIntField IN handle (INPUT <character>, OUTPUT <integer>). | |
Descrição | Retorna valor dos campos do tipo inteiro | |
Parâmetros | Descrição | |
pFieldName | Nome do campo inteiro que será retornado o valor | |
| pFieldValue | Valor contido no campo solicitado |
Retorno | A BO irá retornar o valor contido no campo inteiro que foi solicitado a BO. | |
getLogField | ||
Requisito | Nenhum | |
Sintaxe | RUN getLogField IN handle (INPUT <character>, OUTPUT <logical>). | |
Descrição | Retorna valor dos campos do tipo logico | |
Parâmetros | Descrição | |
pFieldName | Nome do campo logico que será retornado o valor | |
| pFieldValue | Valor contido no campo solicitado |
Retorno | A BO irá retornar o valor contido no campo logico que foi solicitado a BO. | |
getRawField | ||
Requisito | Nenhum | |
Sintaxe | RUN getRawField IN handle (INPUT <character>, OUTPUT <raw>). | |
Descrição | Retorna valor dos campos do tipo raw | |
Parâmetros | Descrição | |
| pFieldName | Nome do campo raw que será retornado o valor |
| pFieldValue | Valor contido no campo solicitado |
Retorno | A BO irá retornar o valor contido no campo raw que foi solicitado a BO. | |
getRecidField | ||
Requisito | Nenhum | |
Sintaxe | RUN getRecidField IN handle (INPUT <character>, OUTPUT <recid>). | |
Descrição | Retorna valor dos campos do tipo recid | |
Parâmetros | Descrição | |
| pFieldName | Nome do campo recid que será retornado o valor |
| pFieldValue | Valor contido no campo solicitado |
Retorno | A BO irá retornar o valor contido no campo recid que foi solicitado a BO. | |
getKey | ||
Requisito | Nenhum | |
Sintaxe | RUN getKey IN handle (OUTPUT <character>, OUTPUT <character>, OUTPUT <date>, OUTPUT <character>). | |
Descrição | Retorna a chave do registro posicionado | |
Parâmetros | Descrição | |
| pnom-abrevi-clien | Indica o nome abreviado do cliente do pedido de venda |
| pcod-ped-clien | Indica o número do pedido do cliente do pedido venda |
| pdat-histor | Indica a data do histórico |
| phra-histor | Indica a hora do histórico |
Retorno | A BO irá retornar o valor contido no campo modelo que foi solicitado a BO. | |
goToKey | ||
Requisito | Nenhum | |
Sintaxe | RUN goToKey IN h-handle (INPUT <character>, INPUT <character>, INPUT <date>, INPUT <character>). | |
Descrição | Reposiciona registro com base na chave informada | |
Parâmetros | Descrição | |
| pnom-abrevi-clien | Indica o nome abreviado do cliente do pedido de venda |
| pcod-ped-clien | Indica o número do pedido do cliente do pedido venda |
| pdat-histor | Indica a data do histórico |
| phra-histor | Indica a hora do histórico |
Retorno | A BO irá reposicionar no registro que foi solicitado a BO. | |
validateRecord | ||
Requisito | Nenhum | |
Sintaxe | RUN validateRecord IN h-handle (INPUT <character>). | |
Descrição | Efetua as validações do registro antes de ser gravado na tabela de campos do portal | |
Parâmetros | Descrição | |
| pType | Indica o o tipo de gravação do registro (Create, Delete e Update). |
Retorno | “OK” – Registro gravado corretamente “NOK” – Registro inválido, Verificar a lista de erros na temp-table RowErrors | |
Método Negócio
verifyPreApprooved | ||
Requisito | Nenhum | |
Sintaxe | RUN verifyPreApprooved IN h-handle (INPUT <character>, INPUT <character>, INPUT <integer>, INPUT <decimal> ). | |
Descrição | Verifica se no histórico do pedido especificado houve um histórico de aprovação com percentual pré-aprovado maior ou igual ao informado. | |
Parâmetros | Descrição | |
nomeAbrev | Indica o nome abreviado do cliente do pedido de venda | |
| nrPedCli | Indica o número do pedido do cliente do pedido de venda |
| processInstanceId | Indica qual o número do processo do workflow de aprovação de pedido por alçada de desconto que está sendo verificado a aprovação |
| valPctDescontoTotal | Indica o percentual de desconto do pedido solicitado pelo cliente. |
Retorno | Retorna a próxima sequencia da tabela. | |
logCreateOrder | ||
Requisito | Nenhum | |
Sintaxe | RUN logCreateOrder IN h-handle (INPUT <character>, INPUT <character> ). | |
Descrição | Gera histórico de pedido para o evento de cadastro | |
Parâmetros | Descrição | |
nrPedCli | Identifica o número do pedido do cliente | |
| nomeAbrev | Identifica o nome abreviado do pedido do cliente |
Retorno | Nenhum | |
logUpdateOrder | ||
Requisito | Nenhum | |
Sintaxe | RUN logUpdateOrder IN h-handle (INPUT <character>, INPUT <character>, INPUT <handle>, INPUT <handle>, INPUT <character>). | |
Descrição | Gera histórico de pedido para o evento de alteração. | |
Parâmetros | Descrição | |
nrPedCli | Identifica o número do pedido do cliente | |
| nomeAbrev | Identifica o nome abreviado do pedido do cliente |
| hNewBuffer | Identifica o handle do buffer alterado no pedido |
| hOldBuffer | Identifica o handle do buffer original do pedido |
| cChanges | Lista de campos alterados no registro |
Retorno | Nenhum | |
logCancelOrder | ||
Requisito | Nenhum | |
Sintaxe | RUN logCancelOrder IN h-handle (INPUT <character>, INPUT <character>, INPUT <integer>, INPUT <character>). | |
Descrição | Gera histórico de pedido para o evento de cancelamento | |
Parâmetros | Descrição | |
nrPedCli | Identifica o número do pedido do cliente | |
| nomeAbrev | Identifica o nome abreviado do pedido do cliente |
| iReason | Código do motivo de cancelamento |
| cReason | Descrição do motivo de cancelamento |
Retorno | Nenhum | |
logSuspendOrder | ||
Requisito | Nenhum | |
Sintaxe | RUN logSuspendOrder IN h-handle (INPUT <character>, INPUT <character>, INPUT <character>). | |
Descrição | Gera histórico de pedido para o evento de suspensão | |
Parâmetros | Descrição | |
nrPedCli | Identifica o número do pedido do cliente | |
| nomeAbrev | Identifica o nome abreviado do pedido do cliente |
| cReason | Descrição do motivo de suspensão |
Retorno | Nenhum | |
logReactivateOrder | ||
Requisito | Nenhum | |
Sintaxe | RUN logReactivateOrder IN h-handle (INPUT <character>, INPUT <character>, INPUT <character> ). | |
Descrição | Gera histórico de pedido para o evento de reativação | |
Parâmetros | Descrição | |
nrPedCli | Identifica o número do pedido do cliente | |
| nomeAbrev | Identifica o nome abreviado do pedido do cliente |
| cReason | Descrição do motivo de reativação |
Retorno | Nenhum | |
logCommitOrder | ||
Requisito | Nenhum | |
Sintaxe | RUN logCommitOrder IN h-handle (INPUT <character>, INPUT <character> ). | |
Descrição | Gera histórico de pedido para o evento de efetivação | |
Parâmetros | Descrição | |
nrPedCli | Identifica o número do pedido do cliente | |
| nomeAbrev | Identifica o nome abreviado do pedido do cliente |
Retorno | Nenhum | |
logUpdateOrderItem | ||
Requisito | Nenhum | |
Sintaxe | RUN logUpdateOrderItem IN h-handle (INPUT <character>, INPUT <character>, INPUT <handle>, INPUT <handle>, INPUT <character>). | |
Descrição | Gera histórico de pedido para o evento de atualização do item | |
Parâmetros | Descrição | |
nrPedCli | Identifica o número do pedido do cliente | |
| nomeAbrev | Identifica o nome abreviado do pedido do cliente |
| hNewBuffer | Identifica o handle do buffer alterado do item do pedido |
| hOldBuffer | Identifica o handle do buffer original do item do pedido |
| cChanges | Lista de campos alterados no registro |
Retorno | Nenhum | |
logAddOrderItem | ||
Requisito | Nenhum | |
Sintaxe | RUN logAddOrderItem IN h-handle (INPUT <character>, INPUT <character>, INPUT <character>, INPUT <integer> ). | |
Descrição | Gera histórico de pedido para o evento de inclusão do item | |
Parâmetros | Descrição | |
nrPedCli | Identifica o número do pedido do cliente | |
| nomeAbrev | Identifica o nome abreviado do pedido do cliente |
| cItCodigo | Código do novo item do pedido |
| iNrSequencia | Sequencia do novo item do pedido |
Retorno | Nenhum | |
logRemoveOrderItem | ||
Requisito | Nenhum | |
Sintaxe | RUN logRemoveOrderItem IN h-handle (INPUT <character>, INPUT <character>, INPUT <character>, INPUT <integer> ). | |
Descrição | Gera histórico de pedido para o evento de exclusão de item | |
Parâmetros | Descrição | |
nrPedCli | Identifica o número do pedido do cliente | |
| nomeAbrev | Identifica o nome abreviado do pedido do cliente |
| cItCodigo | Código do item do pedido |
| iNrSequencia | Sequencia do item do pedido |
Retorno | Nenhum | |
logCancelOrderItem | ||
Requisito | Nenhum | |
Sintaxe | RUN logCancelOrderItem IN h-handle (INPUT <character>, INPUT <character>, INPUT <character>, INPUT <integer>, INPUT <integer>, INPUT <character> ). | |
Descrição | Gera histórico de pedido para o evento de cancelamento do item | |
Parâmetros | Descrição | |
nrPedCli | Identifica o número do pedido do cliente | |
| nomeAbrev | Identifica o nome abreviado do pedido do cliente |
| cItCodigo | Código do item do pedido |
| iNrSequencia | Sequencia do item do pedido |
| iReason | Código do motivo do cancelamento |
| cReason | Descrição do motivo do cancelamento |
Retorno | Nenhum | |
logAllocateOrderItem | ||
Requisito | Nenhum | |
Sintaxe | RUN logAllocateOrderItem IN h-handle (INPUT <character>, INPUT <character>, INPUT <character>, INPUT <integer>, INPUT <decimal>, INPUT <character> ). | |
Descrição | Gera histórico de pedido para o evento de alocação do item | |
Parâmetros | Descrição | |
nrPedCli | Identifica o número do pedido do cliente | |
| nomeAbrev | Identifica o nome abreviado do pedido do cliente |
| cItCodigo | Código do item do pedido |
| iNrSequencia | Sequencia do item do pedido |
| qtde | Quantidade alocada do item |
| cNrEmbarque | Número do embarque onde o item foi alocado |
Retorno | Nenhum | |
logUnAllocateOrderItem | ||
Requisito | Nenhum | |
Sintaxe | RUN logUnAllocateOrderItem IN h-handle (INPUT <character>, INPUT <character>, INPUT <character>, INPUT <integer>, INPUT <decimal>, INPUT <character> ). | |
Descrição | Gera histórico de pedido para o evento de desalocação do item | |
Parâmetros | Descrição | |
nrPedCli | Identifica o número do pedido do cliente | |
| nomeAbrev | Identifica o nome abreviado do pedido do cliente |
| cItCodigo | Código do item do pedido |
| iNrSequencia | Sequencia do item do pedido |
| qtde | Quantidade alocada do item |
| cNrEmbarque | Número do embarque onde o item foi desalocado |
Retorno | Nenhum | |
logSeparateOrderShipment | ||
Requisito | Nenhum | |
Sintaxe | RUN logSeparateOrderShipmentIN h-handle (INPUT <character>, INPUT <character>, INPUT <character>,). | |
Descrição | Gera histórico de pedido para o evento de separação de embarque | |
Parâmetros | Descrição | |
nrPedCli | Identifica o número do pedido do cliente | |
| nomeAbrev | Identifica o nome abreviado do pedido do cliente |
| cNrEmbarque | Número do embarque onde o item foi alocado |
Retorno | Nenhum | |
logInvoiceOrderShipment | ||
Requisito | Nenhum | |
Sintaxe | RUN logInvoiceOrderShipment IN h-handle (INPUT <character>, INPUT <character>, INPUT <character>, INPUT <character>, INPUT <character> ). | |
Descrição | Gera histórico de pedido para o evento de faturamento de embarque | |
Parâmetros | Descrição | |
nrPedCli | Identifica o número do pedido do cliente | |
| nomeAbrev | Identifica o nome abreviado do pedido do cliente |
| cNrEmbarque | Número do embarque onde o item foi alocado |
| cNrFiscal | Número da nota fiscal que foi faturado o embarque do pedido |
| cSerie | Série da nota fiscal que foi faturado o embarque do pedido |
Retorno | Nenhum | |
logReturnToSeparationOrderShipment | ||
Requisito | Nenhum | |
Sintaxe | RUN logReturnToSeparationOrderShipment IN h-handle (INPUT <character>, INPUT <character>, INPUT <character>,). | |
Descrição | Gera histórico de pedido para o evento de retorno de separação de embarque | |
Parâmetros | Descrição | |
nrPedCli | Identifica o número do pedido do cliente | |
| nomeAbrev | Identifica o nome abreviado do pedido do cliente |
| cNrEmbarque | Número do embarque onde o item foi alocado |
Retorno | Nenhum | |
logReturnToPreparationOrderShipment | ||
Requisito | Nenhum | |
Sintaxe | RUN logReturnToPreparationOrderShipment IN h-handle (INPUT <character>, INPUT <character>, INPUT <character>,). | |
Descrição | Gera histórico de pedido para o evento de retorno de preparação de embarque | |
Parâmetros | Descrição | |
nrPedCli | Identifica o número do pedido do cliente | |
| nomeAbrev | Identifica o nome abreviado do pedido do cliente |
| cNrEmbarque | Número do embarque onde o item foi alocado |
Retorno | Nenhum | |
logSendToSeparationOrderShipment | ||
Requisito | Nenhum | |
Sintaxe | RUN logSendToSeparationOrderShipment IN h-handle (INPUT <character>, INPUT <character>, INPUT <character>,). | |
Descrição | Gera histórico de pedido para o evento de reenvio de separação de embarque | |
Parâmetros | Descrição | |
nrPedCli | Identifica o número do pedido do cliente | |
| nomeAbrev | Identifica o nome abreviado do pedido do cliente |
| cNrEmbarque | Número do embarque onde o item foi alocado |
Retorno | Nenhum | |
logInvoiceOrder | ||
Requisito | Nenhum | |
Sintaxe | RUN logInvoiceOrder IN h-handle (INPUT <character>, INPUT <character>, INPUT <character>, INPUT <character>). | |
Descrição | Gera histórico de pedido para o evento de faturamento do pedido | |
Parâmetros | Descrição | |
nrPedCli | Identifica o número do pedido do cliente | |
| nomeAbrev | Identifica o nome abreviado do pedido do cliente |
| cNrFiscal | Número da nota fiscal que foi faturado o embarque do pedido |
| cSerie | Série da nota fiscal que foi faturado o embarque do pedido |
Retorno | Nenhum | |
logCancelInvoice | ||
Requisito | Nenhum | |
Sintaxe | RUN logCancelInvoice IN h-handle (INPUT <character>, INPUT <character>, INPUT <character>, INPUT <character>, INPUT <date> INPUT <character>). | |
Descrição | Gera histórico de pedido para o evento de cancelamento do faturamento do pedido | |
Parâmetros | Descrição | |
nrPedCli | Identifica o número do pedido do cliente | |
| nomeAbrev | Identifica o nome abreviado do pedido do cliente |
| cNrFiscal | Número da nota fiscal que foi faturado o embarque do pedido |
| cSerie | Série da nota fiscal que foi faturado o embarque do pedido |
| dtCancel | Data em que a nota fiscal foi cancelada |
| cDescMotivo | Motivo do cancelamento da nota fiscal |
Retorno | Nenhum | |
logCredito | ||
Requisito | Nenhum | |
Sintaxe | RUN logCredito IN h-handle (INPUT <character>, INPUT <character>). | |
Descrição | Gera histórico de pedido para o evento de avaliação de crédito do pedido | |
Parâmetros | Descrição | |
nrPedCli | Identifica o número do pedido do cliente | |
| nomeAbrev | Identifica o nome abreviado do pedido do cliente |
Retorno | Nenhum | |
logCopyOrder | ||
Requisito | Nenhum | |
Sintaxe | RUN logCopyOrder IN h-handle (INPUT <character>, INPUT <character>, INPUT <character>, INPUT <character>). | |
Descrição | Gera histórico de pedido para o evento de cópia do pedido | |
Parâmetros | Descrição | |
nrPedCli | Identifica o número do pedido do cliente | |
| nomeAbrev | Identifica o nome abreviado do pedido do cliente |
| nrPedOrigem | Identifica o número do pedido de origem |
| nomeAbrevOrigem | Identifica o nome abreviado do pedido de origem |
Retorno | Nenhum | |
logComercial | ||
Requisito | Nenhum | |
Sintaxe | RUN logComercial IN h-handle (INPUT <character>, INPUT <character>). | |
Descrição | Gera histórico de pedido para o evento de avaliação comercial do pedido | |
Parâmetros | Descrição | |
nrPedCli | Identifica o número do pedido do cliente | |
| nomeAbrev | Identifica o nome abreviado do pedido do cliente |
Retorno | Nenhum | |
pi-calculate-time | ||
Requisito | Nenhum | |
Sintaxe | RUN pi-calculate-time IN h-handle (INPUT <character>, INPUT <character>). | |
Descrição | Ajusta o horário do histórico de pedido. | |
Parâmetros | Descrição | |
nrPedCli | Identifica o número do pedido do cliente | |
| nomeAbrev | Identifica o nome abreviado do pedido do cliente |
Retorno | Nenhum | |
OpenQuery / SetConstraint / LinkTo
openQueryMain | ||
Requisito | Nenhum | |
Sintaxe | run openQueryStatic in h-handle (input "Main":U). | |
Descrição | Faz a abertura da tabela principal. | |
Parâmetros | Descrição | |
|
| |
Retorno |
| |
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas