Documento de BO
Produto: | Datasul |
Ocorrência: | Documentação de BO |
Nome Físico | dibo/bodi00800.p |
Considerações Gerais
Objetivo
Esta BO é destinada à tratativa dos dados de saída/entrada de documentos realizados DATASUL. Suas informações são visualizadas pelo programa CD0950.
Funcionamento
Na forma padrão, realiza-se a chamada por meio de um comando RUN normal, passando-se as temp-tables carregadas com as informações necessárias.
A execução na forma persistente é realizada via chamada de um comando RUN conforme exemplo a seguir.
A sintaxe para executar a API/BO em modo persistente é:
RUN dibo/bodi00800.p PERSISTENT SET h-bodi00800. |
A variável denominada h-handle irá receber o “handle” do programa, permitindo o acesso aos “métodos” internos da API.
Tabelas Temporárias
Nos atributos das tabelas temporárias de entrada e saída:
tt-integr-totvs-colab | Entrada/Saída | ||||
- | Entrada/Saída | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
cod-edi | char | x(30) | - | Sim | - |
cod-docto | char | x(200) | - | Não | - |
cod-evento | char | x(50) | - | Não | - |
log-lido | logical | Sim/Não | - | Não | - |
cod-dat-hora | char | x(50) | - | Sim | - |
dat-reg | date | 99/99/9999 | - | Não | - |
hra-reg | char | x(8) | - | Não | - |
log-con | logical | Sim/Não | - | Não | - |
cod-msg | char | x(2000) | - | Não | - |
cod-origem | int | >9 | - | Sim | - |
raw-contdo | raw | x(15000) | - | Não | - |
dat-leitura-reg | date | 99/99/9999 | - | Não | - |
hra-leitura-reg | char | 99:99:99 | - | Não | - |
nom-usuar-reg | char | x(50) | - | Não | - |
dat-reativ-reg | date | 99/99/9999 | - | Não | - |
hra-reativ-reg | char | 99:99:99 | - | Não | - |
nom-reativ-reg | char | x(50) | - | Não | - |
cod-livre-1 | char | x(2000) | - | Não | - |
cod-livre-2 | char | X(500) | - | Não | - |
cod-livre-3 | char | X(1000) | - | Não | - |
cod-livre-4 | char | X(1000) | - | Não | - |
cod-livre-5 | char | X(100) | - | Não | - |
dat-livre-1 | date | 99/99/9999 | - | Não | - |
dat-livre-2 | date | 99/99/9999 | - | Não | - |
dat-livre-3 | date | 99/99/9999 | - | Não | - |
dat-livre-4 | date | 99/99/9999 | - | Não | - |
dat-livre-5 | date | 99/99/9999 | - | Não | - |
val-livre-1 | deci-8 | ->>>>>>>>>>>9.99999999 | - | Não | - |
val-livre-2 | deci-8 | ->>>>>>>>>>>9.99999999 | - | Não | - |
val-livre-3 | deci-8 | ->>>>>>>>>>>9.99999999 | - | Não | - |
val-livre-4 | deci-8 | ->>>>>>>>>>>9.99999999 | - | Não | - |
val-livre-5 | deci-8 | ->>>>>>>>>>>9.99999999 | - | Não | - |
log-livre-1 | logical | Sim/Não | - | Não | - |
log-livre-2 | logical | Sim/Não | - | Não | - |
log-livre-3 | logical | Sim/Não | - | Não | - |
log-livre-4 | logical | Sim/Não | - | Não | - |
log-livre-5 | logical | Sim/Não | - | Não | - |
num-livre-1 | int | >>>>>>>>9 | - | Não | - |
num-livre-2 | int | >>>>>>>>9 | - | Não | - |
num-livre-3 | int | >>>>>>>>9 | - | Não | - |
num-livre-4 | int | >>>>>>>>9 | - | Não | - |
num-livre-5 | int | >>>>>>>>9 | - | Não | - |
Método Básico
Quando a API/BO for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:
goToKey | ||
Requisito | Nenhum | |
Sintaxe | goToKey (input pcod-edi, input pcod-dat-hora) | |
Descrição | Reposiciona registro com base no índice CODIGO e retorna o status do processo. | |
Parâmetros | Descrição | |
pcod-edi | Código do tipo de documento | |
pcod-dat-hora | Data e hora | |
Retorno | - |
openQueryMain | ||
Requisito | Nenhum | |
Sintaxe | - | |
Descrição | Busca todas as informações da tabela integr-totvs-colab para abertura da query. | |
Parâmetros | Descrição | |
- | - | |
Retorno | - |
openQueryProcessa | ||
Requisito | Nenhum | |
Sintaxe | - | |
Descrição | Busca um conjunto de dados da tabela integr-totvs-colab de acordo com o tipo de documento, código do documento, faixa de datas, status de leitura do coumento e origem. | |
Parâmetros | Descrição | |
- | - | |
Retorno | - |
setConstraintProcessa | ||
Requisito | Nenhum | |
Sintaxe | setConstraintProcessa(input p-c-cod-docto, input p-d-data-ini, input p-d-data-fim, input p-rd-log-lido, input p-rd-origem, input p-tipo) | |
Descrição | Seta as variáveis de controle para queries contendo tipo de documento, código do documento, faixa de datas, status de leitura do coumento e origem. | |
Parâmetros | Descrição | |
p-c-cod-docto | Código do documento | |
| p-d-data-ini | Data inicial |
| p-d-data-fim | Data final |
| p-rd-log-lido | Status de leitura |
| p-rd-origem | Origem |
| p-tipo | Tipo de documento |
Retorno | - |