Histórico da Página

...

Produto:	Datasul
Ocorrência:	Documentação de BO
Nome Físico	inbo/boin00951.p
Data Liberação	07/2015
Banco	MOVIND
Tabela	pendcia-integr-mes
Aplicativo	Manufatura

Considerações Gerais

Objetivo

Manter e fornecer integrações sobre pendências de integração MES.

...

run xxx/xxapinnn.p (input-output table tt-...,
                    input        table tt-...,
                    ...,
                    ...).

A A sintaxe para executar a BO em modo persistente é:

run xxx/xxapinnn.p persistent set h-handle (input-output table tt-...,
                                            input        table tt-...,
                                            ...,
                                            ...).

A 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-pendcia-integr-mes					Entrada/Saída
					-
Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
num-id-pendcia-integr-mes	Int	999999999	Identificador único da pendência
cod-trans	Char	x(40)	Descrição da transação
idi-tip-status	Int	>9	Status da pendência
cod-chave-ident	Char	x(100)	Código identificador da transação
dat-envio	Date	99/99/9999	Data de envio da transação
hra-envio	Char	x(8)	Hora de envio da transação
cod-usuar	Char	x(100)	Código do usuário
des-msg-ret	Char	X(300)	Msg Retorno
cod-livre-1	Char	x(100)	Campo Livre
codcod-livre-2	Char	x(100)	Campo Livre
codcod-livre-3	Char	x(100)	Campo Livre
codcod-livre-4	Char	x(100)	Campo Livre
datdat-livre-1			Date	99/99/9999	Campo Livre
datdat-livre-2			Date	99/99/9999	Campo Livre
datdat-livre-3			Date	99/99/9999	Campo Livre
datdat-livre-4			Date	99/99/9999	Campo Livre

Execução

RecordSet tt-periodo

tt-periodo
Atributo	Tipo	Formato	Descrição	Obr.
cd-tipo	inte	>9	Tipo Período	Sim
ano	inte	9999	Ano	Sim
nr-periodo	inte	>>9	Período	Sim
dt-inicio	date	99/99/9999	Data Início
dt-termino	date	99/99/9999	Data Término	Sim
char-1	char	x(100)	?
char-2	char	x(100)	?
dec-1	deci-2	->>>>>>>>>>>9.9	?
dec-2	deci-2	->>>>>>>>>>>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	?
check-sum	char	x(20)	Check-sum

Métodos Básicos

Métodos básicos de acesso ao banco de dados.

Método:

goToKey

Descrição: Reposiciona registro com base no índice ANO

Requisitos: Nenhum

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
pano	int		X			Ano
pcd-tipo	int		X			Tipo Período
pnr-periodo	int		X			Período

Método:

getKey

Descrição: Retorna valores dos campos do índice ANO

Requisitos: Nenhum

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
pano	int			X		Ano
pcd-tipo	int			X		Tipo Período
pnr-periodo	int			X		Período

Método:

goToCh_termino

Descrição: Procura pelo índice, caso não ache, retorna mensagem de erro padrão do EMS

Requisitos: Nenhum

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
pcd-tipo	int		X			Tipo Período
pdt-termino	date		X			Data Término

Método:

goToInicio

Descrição: Reposiciona registro com base no Tipo e na Data de Início

Requisitos: Nenhum

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
pcd-tipo	int		X			Tipo Período
pdt-inicio	date		X			Data início

Método:

goToInicioMaior

Descrição: Reposiciona registro com base no Tipo e na Data de Início

Requisitos: Nenhum

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
pcd-tipo	int		X			Tipo Período
pdt-inicio	date		X			Data início

Método:

goToIniFim

Descrição: Reposiciona registro com base no com base no índice CODIGO

Requisitos: Nenhum

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
pcd-tipo	int		X			Tipo Período
pda-ini	date		X			Data início
pda-fim	date		X			Data Fim

Método:

goToKeyLast

Descrição: Reposiciona no último registro pela chave.

Requisitos: Nenhum

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
pano	int					Ano
pcd-tipo	int		X			Tipo Período
pnr-periodo	int		X			Período

Método:

goToPeriodo

Descrição: Reposiciona no registro conforme data.

Requisitos: Nenhum

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
pcd-tipo	int		X			Tipo Período
pdt-periodo	date		X			Data de Movimentação

Método:

goToTermino

Descrição: Procura o registro utilizando o tipo do período e com a data de termino maior ou igual a data Informada.

Requisitos: Nenhum

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
pcd-tipo	int		X			Tipo Período
pdt-termino	date		X			Data Referência

Método:

goToTipoIniFim

Descrição: Reposiciona o registro com base no Tipo do Período, com a Data de Início (menor ou igual a informada) e com a Data de Término (maior ou igual a informada).

Requisitos: Nenhum

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
pcd-tipo	int		X			Tipo Período
pdt-inicio	date					Data Inicio
pdt-termino	date		X			Data Término

Método:

validateRecord

Descrição: Valida temptable RowObject.

Requisitos: Nenhum

Parâmetros:

Recebe o tipo de validação (Create, Delete, Update)

Parâmetro	Tipo	Formato	I	O	IO	Descrição
pType	char		X			Recebe o tipo de validação

Método:

getCharField

Descrição:

Retorna o valor de um campo character.

Requisitos: Nenhum

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
pFieldName	char		X			Nome Campo
pFieldValue	char			X		Valor Campo

Método:

getDecField

Descrição: Retorna o valor de um campo decimal.

Requisitos: Nenhum

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
pFieldName	char		X			Nome Campo
pFieldValue	decimal			X		Valor Campo

Método:

getIntField

Descrição: Retorna o valor de um campo inteiro.

Requisitos: Nenhum

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
pFieldName	char		X			Nome Campo
pFieldValue	integer			X		Valor Campo

Método:

getDateField

Descrição: Retorna o valor de um campo date.

Requisitos: Nenhum

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
pFieldName	char		X			Nome Campo
pFieldValue	date			X		Valor Campo

Método:

getLogField

Descrição: Retorna o valor de um campo logical.

Requisitos: Nenhum

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
pFieldName	char		X			Nome Campo
pFieldValue	logical			X		Valor Campo

Método:

getRawField

Descrição: Retorna valor de campos do tipo raw.

Requisitos: Nenhum

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
pFieldName	char		X			Nome Campo
pFieldValue	raw			X		Valor Campo

Método:

getRecidField

Descrição: Retorna valor de campos do tipo recid.

Requisitos: Nenhum

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
pFieldName	char		X			Nome Campo
pFieldValue	recid			X		Valor Campo

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 ("Main")

Descrição: Busca conjunto de registros da tabela periodo.

Método:

OpenQueryStatic ("FiltroData")

Descrição: Busca conjunto de registros da tabela periodo considerando o tipo de período e uma faixa de data de início e data de término.

Constraints Associados:

Executar o método setConstraintFiltroData.

Método:

OpenQueryStatic ("FiltroCdTipo")

Descrição: Busca conjunto de registros da tabela periodo considerando uma faixa de tipo de período inicial e final.

Constraints Associados:

Executar o método setConstraintFiltroCdTipo.

Método:

SetConstraintFiltroData

Descrição: Seta as variáveis de controle para queries contendo a data de início e de término e o tipo de período.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
p-inicial	char		X			Data Início
p-final	char		X			Data Término
p-cd-tipo	char		X			Tipo Período

Método:

SetConstraintFiltroCdTipo

Descrição: Seta as variáveis de controle para queries contendo o tipo de período inicial e final.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
p-inicial	char		X			Período Inicial
p-final	char		X			Período Final

Métodos Negócio

Métodos adicionais de atualização e acesso a base de dados.

Método:

canFindPeriodo

Descrição:

Verifica se existe período com a seleção enviada.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
pcd-tipo	inte		X			Tipo Período
p-ano-ini	inte		X			Ano Inicial
p-ano-fim	inte		X			Ano Final
p-per-ini	inte		X			Período Inicial
p-per-fim	inte		X			Período Final

Método:

processaDatas

Descrição:

Este procedimento tem por finalidade processar a faixa de datas e de períodos de acordo com o que for informado. Caso seja informado as datas inicial e final, então este procedimento retornará os períodos (inicial e final). Caso sejam informados os períodos (inicial e final) então este retornará as datas (inicial e final).

Comentário Importante: O período prevalece sobre a data.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
p-cd-tipo	char		X			Tipo Período
p-ano-ini	char		X			Ano Inicial
p-ano-fim	char		X			Ano Final
p-periodo-ini	char		X			Período Inicial
p-periodo-fim	char		X			Período Final
p-data-ini	char		X			Data Inicial
p-data-fim	char		X			Data Final
r-data-ini	char			X		Data Inicial
r-data-fim	char			X		Data Final
r-periodo-ini	char			X		Período Inicial
r-periodo-fim	char			X		Período Final
table for RowErrors				X

log-livre-1	Log	Sim/Não	Campo Livre
log-livre-2	Log	Sim/Não	Campo Livre
log-livre-3	Log	Sim/Não	Campo Livre
log-livre-4	Log	Sim/Não	Campo Livre
num-livre-1	Int	>>>>>>>>9	Campo Livre
num-livre-2	Int	>>>>>>>>9	Campo Livre
num-livre-3	Int	>>>>>>>>9	Campo Livre
num-livre-4	Int	>>>>>>>>9	Campo Livre
val-livre-1	Dec	->>>>>>>>>>>9.99999999	Campo Livre
val-livre-2	Dec	->>>>>>>>>>>9.99999999	Campo Livre
val-livre-3	Dec	->>>>>>>>>>>9.99999999	Campo Livre
val-livre-4	Dec	->>>>>>>>>>>9.99999999	Campo Livre

Método Básico

Quando a BO for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:

goToKey
Requisito	Busca de registro pela chave primária.
Sintaxe	run goToKey in h-handle (input num-id-pendcia-integr-mes).
Descrição	Posiciona na chave indicada por parâmetro
	Parâmetros	Descrição
	num-id-pendcia-integr-mes	ID da pendência.
Retorno	Não se aplica.

Método Negócio

deleteRecordByIdentif
Requisito	Eliminar pendências com chave de transação.
Sintaxe	deleteRecordByIdentif (input cod-chave-ident)
Descrição	Elimina pendências por meio da chave de identificação dela, todas as pendências que possuem essa chave de transação serão eliminadas.
	Parâmetros	Descrição
	pendcia-integr-mes.cod-chave-ident	Chave de identificação da transação
Retorno	A BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas).

pi-retorna-xml
Requisito	Busca XML com a chave da pendência (rowid).
Sintaxe	pi-retorna-xml (input rRowid, output stringXML)
Descrição	Retorna string LONGCHAR com o XML da pendencia desejada.
	Parâmetros	Descrição
	rRowid	ROWID da pendência
Retorno	LONGCHAR contendo XML da pendência enviada no INPUT do método.

OpenQuery / SetConstraint / LinkTo

setConstraintFiltro
Requisito	Seta constraint de filtros básicos para a pendência.
Sintaxe	run setConstraintFiltro in h-handle (input pdt-dat-envio-ini, input pdt-dat-envio-fim, input pc-cod-trans-ini, input pc-cod-trans-fim, input pidi-tip-status, input pc-usuario-ini, input pc-usuario-fim).
Descrição	Filtros para abertura de Query.
	Parâmetros	Descrição
	pdt-dat-envio-ini	Inicial de faixa de data da transação.
	pdt-dat-envio-fim	Término de faixa de data de transação.
	pc-cod-trans-ini	Inicio de faixa de código de transação.
	pc-cod-trans-fim	Término de faixa de código de transação.
	pidi-tip-status	Status da transação.
	pc-usuario-ini	Inicio de faixa de código de usuário.
	pc-usuario-fim	Término de faixa de código de usuário.
Retorno	Não se aplica.

openQueryFiltro
Requisito	Abertura de Query com utilização de constraints de Filtro
Sintaxe	run openQueryFiltro in h-handle ().
Descrição	Abertura de query utilizando filtros setados pelo método setConstraintFiltro.
	Parâmetros	Descrição
	Não se aplica.	ROWID da pendência
Retorno	Não se aplica.

...

Árvore de páginas

Versões comparadas

Versão antiga 4

Nova versão Atual

Chave

Tabelas Temporárias

Execução

Métodos Básicos

Queries e Constraints

Métodos Negócio

Método Básico

Método Negócio

OpenQuery / SetConstraint / LinkTo