Documento de BO tabela ordens-embarque

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

Esta BO tem como objetivo a manipulação dos dados referentes a tabela ordens-embarque.

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 cxbo/bocx225.p PERSISTENT SET h-handle.

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 Negócio

Métodos de acesso e leitura a base de dados.

Método:

findRowid

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		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 da Ordem de Compra
c-nr-proc-imp	Char	X(12)	X			Número do Processo de Importação
c-return	Char			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	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 o erro.

Método:

GetCurrent

Descrição:

Retorna o registro posicionado.

Requisitos:

Nenhum

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
tt-desp-embarque	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	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:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
c-nome-campo	Char		X			Nome do campo.
l-retorno	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:

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			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. 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:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
c_cod_idiom_usuar	Char	X(12)	X			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	Dec	>>>>>,>>>,>>9.99999		X		Retorna valor total das ordens do embarque

Método:

AtualizaOrdEmbAtoConce

Descrição:

Atualiza ato concessório no ordens embarque.

Requisitos:

Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
i-num-ordem	Int	zzzzz9,99	X			Ordem de Compra
i-parcela	Int	>>>>9	X			Parcela de Compra
c-ato-concessorio	Char			X		Ato Concessório

Método:

createOrdensEmbarque

Descrição:

Criação das Ordens Embarque via Ordens de Compra.

Requisitos:

Nenhum.

Parâmetros:

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

Descrição:

Criação das Ordens Embarque via Pedido de Compra.

Requisitos:

Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
r-embarque	Rowid		X			Rowid do Embarque
p-pedido-compra	Int	>>>>>,>>9	X			Pedido de Compra
tt-bo-erro	Temp-table					Temp-table de erro

Método:

AddOrdemEmbarque

Descrição:

Procedure que atualiza o identificar container com a ordem selecionada no browser.

Requisitos:

Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
p-identific-container	Char	X(20)	X			Identificador do container
p-tipo-container	Char	X(20)	X			Tipo do Container
pDtPrevDev	Date	99/99/9999	X			Data Prevista de Devolução
pDtDevol	Date	99/99/9999	X			Data de Devolução
pDelOrdem	Temp-table				X	Temp-table com os registros eliminados.
pRowidOrdensEmbarque	Rowid		X			Rowid Ordens Embarque

Método:

DelOrdemEmbarque

Descrição:

Procedure que elimina o identificar container com a ordem selecionada no browser.

Requisitos:

Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
pRowidOrdensEmbarque	Rowid		X			Rowid Ordens Embarque
pDelOrdem	Temp-table				X	Temp-table com os registros eliminados.

Método:

AddAllOrdemEmbarque

Descrição:

Procedure que atualiza todas as ordens com o identificar container com as ordens contidas no browser.

Requisitos:

Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
pIdentificContainer	Char	X(20)	X			Identificador do container
pTipoContainer	Char	X(20)	X			Tipo do Container
pDtPrevDev	Date	99/99/9999	X			Data Prevista de Devolução
pDtDevol	Date	99/99/9999	X			Data de Devolução
pDelOrdem	Temp-table				X	Temp-table com os registros eliminados
pRowidOrdensEmbarque	Temp-table		X			Temp-table de ordens de embarque

Método:

DelAllOrdemEmbarque

Descrição:

Procedure que atualiza todas as ordens com o identificar container com as ordens contidas no browser.

Requisitos:

Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
pTableOrd	Temp-Table		X			Temp-table de ordens-embarque
pDelOrdem	Temp-table				X	Temp-table com os registros eliminados.

Método:

pi-createHistEmbarque

Descrição:

Criação do registro de Acompanhamento do Embarque.

Requisitos:

Nenhum.

Parâmetros:

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 usuário
tt-bo-erro	Temp-table			X		Temp-Table com erros gerados.

Método:

pi-atualizaSitProc

Descrição:

Atualização da Situação do Processo.

Requisitos:

Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
pNumPedido	Inte	>>>>>,>>9	X			Pedido de Compra

Método:

createOrdensEmbarquebyparcela

Descrição:

Criação das Ordens Embarque via Ordens de Compra.

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
pParcela	Inte	>>>>9	X			Parcela de Compra
de-quant	Deci	>>>>,>>9.9999	X			Quantidade
tt-bo-erro	Temp-table			X		Temp-Table com erros gerados.

Método:

createOrdensEmbarqueNovaParcela

Descrição:

Criação das Ordens Embarque via Ordens de Compra.

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

Descrição:

Retorna data da parcela de compra não embarcada.

Requisitos:

Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
pCodEstabel	Char	X(05)	X			Código do Estabelecimento
pEmbarque	Char	X(16)	X			Embarque
pNumeroOrdem	Inte	Zzzzz9,99	X			Numero Odem compra
p-data-entrega	Date	99/99/9999		X		Data entrega

Método:

setConstraint2

Descrição:

Recebe parâmetros do programa para ser utilizados no openquery.

Requisitos:

Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
p-numero-ordem	Int	zzzzz9,99	X			Numero Ordem Compra

Método:

SetConstraint3

Descrição:

Recebe parâmetros do programa para ser utilizados no openquery.

Requisitos:

Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
r-rowid	Rowid		X			Rowid do Embarque

Método:

SetConstraint4

Descrição:

Recebe parâmetros do programa para ser utilizados no openquery.

Requisitos:

Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
pCodEstabel	Char	X(05)	X			Estabelecimento
pEmbarque	Char	X(16)	X			Embarque

Método:

SetConstraint5

Descrição:

Recebe parâmetros do programa para ser utilizados no openquery.

Requisitos:

Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
pCodEstabel	Char	X(05)	X			Estabelecimento
pEmbarque	Char	X(16)	X			Embarque
pIdentificContainer	Char	X(20)	X			Identificador do Container

Método:

OpenQuery

Descrição:

Abre a temp-table para ser utilizada no programa.

Requisitos:

Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
i-abertura	Int	>>9	X			Número do OpenQuery a ser utilizado pelo programa

Método:

piCriaOrdensEmbarque

Descrição:

Cria o identificador do container para o embarque e estabelecimento que estão sendo sugeridos na tela.

Requisitos:

Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
pIdentificContainer	Char	X(20)	X			Identificador do container
pTipoContainer	Char	X(20)	X			Tipo do Container
pDtPrevDev	Date	99/99/9999	X			Data Prevista de Devolução
pDtDevol	Date	99/99/9999	X			Data de Devolução
pTabelOrd	Temp-table		X			Temp-table de ordens de embarque

Método:

piCancelaAlteracao

Descrição:

Desfaz as alterações realizadas na manutenção Containers do Embarque (IM0045H).

Requisitos:

Nenhum.

Parâmetros:

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
pDelOrdem	Temp-table				X	Temp-table com os registros eliminados
pTableOrd	Temp-table		X			Temp-table de ordens de embarque
pTableOrd2	Temp-table		X			Temp-table de ordens de embarque

Árvore de páginas

BOCX225 - Ordens Embarque

Documento de BO tabela ordens-embarque

Tabelas Temporárias

Métodos Negócio

Métodos Negócio