Histórico da Página
...
Produto: | Datasul |
Ocorrência: | Documentação de BO |
Nome Físico: | cxbo/bocx225.p |
Include com Parâmetros: | cxbo/bocx225.i |
Banco: | mgcex |
Tabela: | ordens-embarque |
Objetivo
...
A variável denominada h-handle irá receber o “handle” do programa, permitindo o acesso aos “métodos” internos da BO.
Tabelas Temporárias
Principais tabelas temporárias de entrada e saída e seus respectivos atributos, utilizadas para comunicação dos métodos da BO.
RowObject / tt-ordens-embarque / pTableOrd / pTableOrd2 | Entrada/Saída | ||||
Ordens/parcelas de compra relacionadas ao embarque de materiais importados | Entrada/Saída | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
cod-estabel | CHARACTER | X(05) | Código do estabelecimento | Sim | |
nr-proc-imp | CHARACTER | X(12) | Número do processo de importação | Sim | |
embarque | CHARACTER | X(16) | Código do embarque | Sim | |
numero-ordem | INTEGER | zzzzz9,99 | Número da ordem de compra | Sim | |
parcela | INTEGER | >>>>9 | Número da parcela de compra | Sim | |
quantidade | DECIMAL | >>>>>,>>9.9999 | Quantidade embarcada na unidade de medida do estoque | Sim | |
qtd-do-forn | DECIMAL | >>>>>,>>9.9999 | Quantidade embarcada na unidade de medida do fornecedor. | Sim | |
identific-container | CHARACTER | X(20) | Identificação do container | Sim | |
caracter-container | CHARACTER | X(2000) | Característica do container | Sim | |
char-1 | CHARACTER | X(100) | Campo livre do tipo carácter | Não | |
char-2 | CHARACTER | X(100) | Campo livre do tipo carácter | Não | |
dec-1 | DECIMAL | ->>>>>>>>>>>9.99999999 | Campo livre do tipo decimal | Não | |
dec-2 | DECIMAL | ->>>>>>>>>>>9.99999999 | Campo livre do tipo decimal | Não | |
int-1 | INTEGER | ->>>>>>>>>9 | Campo livre do tipo inteiro | Não | |
int-2 | INTEGER | ->>>>>>>>>9 | Campo livre do tipo inteiro | Não | |
log-1 | LOGICAL | Sim/Não | Campo livre do tipo lógico | Não | |
log-2 | LOGICAL | Sim/Não | Campo livre do tipo lógico | Não | |
data-1 | DATE | 99/99/9999 | Campo livre do tipo data | Não | |
data-2 | DATE | 99/99/9999 | Campo livre do tipo data | Não | |
check-sum | CHARACTER | X(20) | Não | ||
tipo-container | CHARACTER | X(20) | Informa o tipo do container | Não | |
nr-ato-concessorio | CHARACTER | X(20) | Informar o ato concessório | Não | |
peso-bruto | DECIMAL | >>>,>>>,>>9.99999 | Peso bruto do item | Não | |
peso-liquido | DECIMAL | >>>,>>>,>>9.99999 | Peso líquido do item | Não | |
aliquota-ipi | DECIMAL | >>9.99 | Alíquota de IPI | Não | |
cd-trib-ipi | INTEGER | >9 | Código de Tributação do IPI | Não | |
aliquota-icms | DECIMAL | >>9.99 | Alíquota de ICMS | Não | |
cd-trib-icms | INTEGER | >9 | Código de Tributação do ICMS | Não | |
aliquota-ii | DECIMAL | >>9.99 | Alíquota do imposto de importação | Não | |
cd-trib-ii | INTEGER | >9 | Tributação do imposto de importação | Não | |
val-cub-unit | DECIMAL | >>>>>,>>>,>>9.999999 | Cubagem do item na ordem/parcela do embarque | Não | |
idi-tributac-pis | INTEGER | 9 | Código de tributação do PIS | Sim | |
idi-tributac-cofins | INTEGER | 9 | Código de tributação COFINS | Sim | |
val-aliq-ext-pis | DECIMAL | >>9.99 | Alíquota do PIS para o mercado externo | Sim | |
val-aliq-ext-cofins | DECIMAL | >>9.99 | Alíquota COFINS para o mercado externo | Sim | |
log-suspens-impto-import | LOGICAL | Sim/Não | Suspensão do imposto de importação | Não | |
log-suspens-ipi-import | LOGICAL | Sim/Não | Suspensão IPI importação | Não | |
log-ja-gravad | LOGICAL | Sim/Não | Indica se os impostos já foram gravados | Sim | |
val-cub-tot | DECIMAL | >>,>>>,>>>,>>9.99 | Valo total da cubagem | Sim | |
val-peso-embal | DECIMAL | >>>,>>9.99999 | Peso líquido da embalagem | Sim | |
num-adic | INTEGER | 9999 | Número da adição da declaração de importação | Não | |
val-tax-siscomex | DECIMAL | >>>>>,>>>,>>9.99999 | Valor da taxa SISCOMEX | Não | |
log-aplica-desc-icms | LOGICAL | Sim/Não | Aplica desconto de ICMS | Não | |
r-rowid | ROWID | Sim |
tt-bo-erro | Entrada/Saída | ||||
Ordens/parcelas de compra relacionadas ao embarque de materiais importados | Saída | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
i-sequen | INTEGER | Sequência do erro | Sim | ||
cd-erro | INTEGER | Código do erro | Sim | ||
mensagem | CHARACTER | X(255) | Mensagem | Sim | |
parametros | CHARACTER | X(255) | Parâmetros | Sim | |
errorType | CHARACTER | X(20) | Tipo do Erro | Sim | |
errorHelp | CHARACTER | X(20) | Ajuda do erro | Sim | |
errorSubType | CHARACTER | Sub-tipo do erro | Sim |
pDelOrdem | Entrada/Saída | ||||
Salva o rowid da ordens-embarque manipulada na BO | Entrada/Saída | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
r-rowid | ROWID | Rowid da tabela orden-embarque | Sim |
Métodos de Leitura
Métodos Negócio
Métodos Quando a BO for executada em modo persistente, os seguintes métodos de acesso e leitura a base de dados estarão disponíveis para execução: .
Método:
findRowid
...
Requisito
...
Nenhum
...
Sintaxe
...
Descrição:
Posiciona o registro conforme rowid da tabela informado.
Requisitos:
Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
r-chave | Rowid |
Retorno
A BO irá retornar se conseguiu ou não posicionar o registro conforme rowid passado ("OK" ou "NOK").
findCodigo
Requisito
Nenhum
Sintaxe
RUN findCodigo IN handle (INPUT <integer>, INPUT <character>, OUTPUT <character>).
X |
|
| Rowid do novo registro. |
Método:
findCodigo
Descrição:
Posiciona o registro conforme parâmetros de entrada da tabela informado.
Requisitos:
Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
i-numero-ordem | Int | zzzzz9,99 | X |
|
| Número |
Descrição
i-numero-ordem
da Ordem de Compra |
c-nr-proc-imp |
Char | X(12) | X |
|
| Número do Processo de Importação | |
c-return | Char |
|
Retorno
Tratado através do OUTPUT c-return.
findEmbarque
Requisito
Nenhum
Sintaxe
RUN findEmbarque IN handle (INPUT <character>, INPUT <character>, OUTPUT <character>).
X |
| Retorna o erro. |
Método:
findEmbarque
Descrição:
Posiciona o registro conforme
...
parametros de entrada da tabela informado.
Requisitos:
Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
c-cod-estabel | Char | X(5) | X |
|
| Código do Estabelecimento |
c-embarque |
Retorno
Tratado através do OUTPUT c-return.
...
findProcesso
...
Requisito
...
Nenhum
...
Sintaxe
...
RUN findProcesso IN handle (INPUT <character>, INPUT <character>, OUTPUT <character>).
Char | X(16) | X |
|
| Embarque | |
c-return | Char |
| X |
| Retorna o erro. |
Método:
findProcesso
Descrição:
...
Posiciona o registro conforme parâmetros de entrada da tabela informado.
Requisitos:
Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
C-nr-proc-imp |
Char | X(12) | X |
|
| Número do processo de importação | |
c-return | Char |
| X |
| Retorna |
Retorno
Tratado através do OUTPUT c-return.
getCurrent
Requisito
Query posicionada no registro.
Sintaxe
RUN getCurrent IN handle (OUTPUT TABLE <temp-table>).
o erro. |
Método:
GetCurrent
Descrição:
Retorna o registro posicionado.
Requisitos:
Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
RowObject
tt-desp-embarque |
Retorno
Tratado através do OUTPUT TABLE <temp-table>.
getCharField
Requisito
Query posicionada no registro.
Sintaxe
RUN getCharField IN handle (INPUT <character>, OUTPUT <character>).
Descrição
Retorna valor dos campos do tipo carácter
Parâmetros
Descrição
c-nome-campo
Nome do campo carácter que será retornado o valor
Retorno
A BO irá retornar o valor contido no campo carácter que foi solicitado.
Temp-Table |
| X |
| Temp-Table Despesa do Embarque |
Método:
getCharfield
Descrição:
Retorna o campo solicitado do registro que estiver posicionado. Só para campos caracteres.
Requisitos:
Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
c-nome-campo | Char | X |
|
| Nome do campo. | |
c-retorno | Char |
| X |
| Campo solicitado |
Método:
getIntfield
Descrição:
Retorna o campo solicitado do registro que estiver posicionado. Só para campos inteiros.
Requisitos:
Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO |
getIntField
Requisito
Query posicionada no registro.
Sintaxe
RUN getIntField IN handle (INPUT <character>, OUTPUT <integer>).
Descrição
Retorna valor dos campos do tipo inteiro
Descrição | ||||||
c-nome-campo | Char | X |
|
| Nome do campo |
. |
i |
-retorno | Int |
| X |
| Campo solicitado |
Método:
getDecfield
Descrição:
Retorna o campo solicitado do registro que estiver posicionado. Só para campos decimais.
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
c-nome-campo | Char | X |
|
| Nome do campo. | |
De-retorno | Char |
| X |
| Campo solicitado |
Método:
getLogfield
Descrição:
Retorna o campo solicitado do registro que estiver posicionado. Só para campos lógicos.
Requisitos:
Nenhum
Parâmetros:
Valor contido no campo solicitado
Retorno
A BO irá retornar o valor contido no campo carácter que foi solicitado.
getDecField
Requisito
Query posicionada no registro.
Sintaxe
RUN getDecField IN handle (INPUT <character>, OUTPUT <decimal>).
Descrição
Retorna valor dos campos do tipo decimal
Parâmetros
Descrição
c-nome-campo
Nome do campo decimal que será retornado o valor
c-retorno
Valor contido no campo solicitado
Retorno
A BO irá retornar o valor contido no campo decimal que foi solicitado.
getLogField
Requisito
Query posicionada no registro.
Sintaxe
RUN getLogField IN handle (INPUT <character>, OUTPUT <logical>).
Descrição
Retorna valor dos campos do tipo logico
Parâmetros
Parâmetro | Tipo | Formato | I | O | IO |
Descrição | ||||||
c-nome-campo | Char | X |
|
| Nome do campo |
. |
l |
-retorno |
Valor contido no campo solicitado
Retorno
A BO irá retornar o valor contido no campo logico que foi solicitado.
getDateField
Requisito
Query posicionada no registro.
Sintaxe
RUN getDateField IN handle (INPUT <character>, OUTPUT <date>).
Descrição
Retorna valor dos campos do tipo data
Parâmetros
Descrição
c-nome-campo
Nome do campo data que será retornado o valor
c-retorno
Valor contido no campo solicitado
Retorno
A BO irá retornar o valor contido no campo data que foi solicitado.
Métodos de Negócio
Quando a BO for executada em modo persistente, os seguintes métodos de alteração, validação, criação e eliminação de registros na base de dados estarão disponíveis para execução:
Char |
| X |
| Campo solicitado |
Método:
getDatefield
Descrição:
Retorna o campo solicitado do registro que estiver posicionado. Só para campos do tipo data.
Requisitos:
Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
c-nome-campo | Char | X |
|
| Nome do campo. | |
da-retorno | Char |
| X |
| Campo solicitado |
Métodos Negócio
Métodos de atualização e acesso a base de dados.
Método:
validateCreate
Descrição:
Valida/Cria novas Cotação Despesas Adicionais do Item.
Requisitos:
Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
tt-desp-embarque | Temp-table | X |
|
| Temp-table desp-embarque | |
tt-bo-erro | Temp-table |
| X |
| Temp-table com erros | |
r-chave | Rowid |
| X |
| Rowid do novo registro criado |
Método:
validateUpdate
Descrição:
Valida/Modifica as Cotação Despesas Adicionais do Item.
Requisitos:
Nenhum.
Parâmetros:
validateCreate
Requisito
Nenhum
Sintaxe
RUN validateCreate IN handle (INPUT TABLE <temp-table>, OUTPUT TABLE <temp-table>, OUTPUT <rowid>).
Descrição
Valida/Cria um novo registro da tabela ordens-embarque
Parâmetros
Descrição
RowObject
Temp-table com o registro a ser validado/criado
tt-bo-erro
Temp-table contendo os erros ocorridos durante o processamento
Retorno
A BO irá retornar os possíveis erros ocorridos durante o processamento, e o rowid do registro criado
validateUpdate
Requisito
Nenhum
Sintaxe
RUN validateUpdate IN handle (INPUT TABLE <temp-table>, INPUT<rowid>, OUTPUT TABLE <temp-table>).
Descrição
Valida/Altera o registro passado como parâmetro
Parâmetros
Descrição
RowObject
Temp-table com o registro a ser validado/alterado
r-chave
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
tt-desp-embarque | Temp-table | X |
|
| Temp-table desp-embarque | |
r-chave | Rowid | X |
|
|
Rowid do registro a ser modificado |
tt-bo-erro | Temp-table |
Retorno
A BO irá retornar os possíveis erros ocorridos durante o processamento
validateDelete
Requisito
Nenhum
Sintaxe
RUN validateDelete IN handle (INPUT-OUPUT <rowid>, OUTPUT TABLE <temp-table>).
Descrição
Valida/Elimina o registro passado como parâmetro
Parâmetros
Descrição
| X |
| Temp-tabel com erros |
Método:
validateDelete
Descrição:
Valida/Elimina Cotação Despesas Adicionais do Item.
Requisitos:
Nenhum.
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
r-chave | Rowid |
|
| X | Rowid do registro a ser eliminado |
Retorno
. Retorna o próximo registro posicionado. | ||||||
tt-bo-erro | Temp-table |
| X |
| Temp-table com erros |
Método:
Pi-recebe-idioma
Descrição:
Recebe idioma do usuário.
Requisitos:
Nenhum.
Parâmetros:
pi-recebe-idioma
Requisito
Nenhum
Sintaxe
RUN pi-recebe-idioma IN handle (INPUT <character>).
Descrição
Recebe o idioma do usuário
Parâmetros
Descrição
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
c_cod_idiom_usuar |
Código do Idioma do usuário
Char | X(12) | X |
|
|
Requisito
Nenhum
Sintaxe
RUN calcularTotalembarque IN handle (INPUT <character>, INPUT <character>, OUTPUT <integer>, OUTPUT <decimal>).
Idioma do usuário |
Método:
calcularTotalembarque
Descrição:
Calcula o valor total das ordens de um embarque na moeda 0.
Requisitos:
Nenhum.
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO |
Descrição |
p-cod-estabel |
Char | X(05) | X |
|
| Estabelecimento | |
p-embarque |
Char | X(16) | X |
|
| Embarque |
i-mo-codigo-orig |
Int | >9 |
| X |
| Moeda Original | |
de-valor-ordens |
Retorno
Dec | >>>>>,>>>,>>9.99999 |
| X |
| Retorna valor total das ordens |
do embarque |
Método:
AtualizaOrdEmbAtoConce
Descrição:
Atualiza ato concessorio concessório no ordens embarque.
Requisitos:
...
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
r-embarque | Rowid | X |
|
| Rowid do Embarque | |
p-numero-ordem | Int | zzzzz9,99 | X |
|
| Número da Ordem |
De-quant | Deci | >>>>,>>9.9999 | X |
|
| Quantidade |
tt-bo-erro | Temp-table |
|
|
| Temp-table de erro |
Método:
createPedidosembarque createPedidosEmbarque
Descrição:
Criação das Ordens Embarque via Pedido de Compra.
...
Procedure que atualiza o identificar container com a ordem selecionada no browser.
...
Procedure que elimina o identificar container com a ordem selecionada no browser.
...
Descrição:
Procedure que autaliza atualiza todas as ordens com o identificar container com as ordens contidas no browser.
...
Descrição:
Procedure que autaliza atualiza todas as ordens com o identificar container com as ordens contidas no browser.
...
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
pCodEstabel | Char | X(05) | X |
|
| Estabelecimento |
pEmbarque | Char | X(16) | X |
|
| Embarque |
pNrProcImp | Char | X(12) | X |
|
| Número do Processo Importação |
pDtEmissao | Date | 99/99/9999 | X |
|
| Data emissão |
pCodItiner | Inte | >>,>>9 | X |
|
| Código do Itinerário |
pCodExportador | Inte | >>>>>>>>9 | X |
|
| Código do Exportador |
pCodDespachante | Inte | >>>>>>>>9 | X |
|
| Código do Despachante |
pCodAgente | Inte | >>>>>>>>9 | X |
|
| Código do Agente |
pCodFabricante | Inte | >>>>>>>>9 | X |
|
| Código do Fabricante |
pHistProcesso | Logical | Sim/Não | X |
|
| Informe se deve ser gerado histórico de processo. |
pPtoChegada | Inte | >>,>>9 | X |
|
| Ponto de Controle |
c-cod-idiom-usuar | Char | X |
|
| Código do idioma do usuariousuário | |
tt-bo-erro | Temp-table |
| X |
| Temp-Table com erros gerados. |
...
Atualização da Situação do Processo.
Requisitos:
Nenhum.
Parâmetros:
...
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
rEmbarque | Rowid | X |
|
| Rowid do Embarque | |
pNumeroOrdem | Inte | zzzzz9,99 | X |
|
| Ordem de compra |
de-quant | Deci | >>>>,>>9.9999 | X |
|
| Quantidade |
p-nova-qtde | Deci | >>>>,>>9,9999 | X |
|
| Nova quantidade |
p-data-entrega | Date | 99/99/9999 | X |
|
| Data entrega |
tt-bo-erro | Temp-table |
| X |
| Temp-Table com erros gerados. |
Método:
RetornaDataParcelaNaoEmbarcada
...
Retorna data da parcela de compra não embarcada.
Requisitos:
Nenhum.
Parâmetros:
...
Recebe parâmetros do programa , para ser utilizados no openquery.
...
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
p-numero-ordem | InteInt | Zzzzz9zzzzz9,99 | X |
|
| Numero Ordem Compra |
...
Recebe parâmetros do programa , para ser utilizados no openquery.
...
Recebe parâmetros do programa , para ser utilizados no openquery.
...
Recebe parâmetros do programa , para ser utilizados no openquery.
...
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
i-abertura | InteInt | >>9 | X |
|
| Número do OpenQuery a ser utilizado pelo programa |
...
Método:
piCancelaAlteracao
Descrição:
Desfaz as alterações realizadas na manutenção Containers do Embarque (IM0045H).
...
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
pSituacao | Logical | X |
|
| Situação | |
pAntIdent | Char | X(20) | X |
|
| Identificador do container |
pAntTipo | Char | X(20) | X | Tipo do Container | ||
pAntDataPrevDev | Date | 99/99/9999 | X | Data Prevista de Devolução | ||
pAntDataDevol | Date | 99/99/9999 | X |
| Data de Devolução | |
pDelOrdempDelOrdem | Temp-table | X | Temp-table com os registros eliminados | |||
pTableOrdpTableOrd | Temp-table | X | Temp-table de ordens de embarque | |||
pTableOrd2pTableOrd2 | Temp-table | X | Temp-table de ordens de embarque |
...