Documento de API

Produto:	Datasul
Ocorrência:	Documentação de API
Nome Físico	inbo/boin724.p

RecordSet

tt-layout-import

tt-evolucao-setup
Atributo	Tipo	Formato	Descrição	Obr.
Prg-importador	Char	X(8)	Programa importador	Yes
Banco	Char	X(32)	Banco de dados	yes
Tabela	Char	X(32)	Tabela do banco	Yes
Sequencia	Int	>>>9	Sequência	Yes
Campo	Char	X(32)	Nome do campo	Yes
Tamanho	Int	>>>>9	Tamanho do campo	Yes
Pos-inic	Int	>>>9	Posição inicial	Yes
Pos-fin	Int	>>>9	Posição final	Yes
Tipo	Char	X(12)	Tipo de dado	Yes
Qtd-decimais	Int	>9	Quantidade casas decimais	Yes
Mandatorio	Log	Yes/no	Indica se campo é obrigatório	Yes
Char-1	Char	X(100)
Char-2	Char	X(100)
Dec-1	dec	->>>>>>>>>>>9.99999999
Dec-2	Dec	->>>>>>>>>>>9.99999999
Int-1	Int	->>>>>>>>>9
Int-2	Int	->>>>>>>>>9
Log-1	Log	Sim/não
Log-2	Log	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:

getCharField

Descrição:

Retorna valor de campos do tipo caracter.

Requisitos:

Nenhum

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
PFieldName	Char		X			Campo
PfieldValue	Char			X		Valor

Método:

getDateField

Descrição:

Retorna o valor de campos do tipo data.

Requisitos:

Nenhum

Parâmetros:

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

Método:

getDecField

Descrição:

Retorna o valor de campos do tipo decimal.

Requisitos:

Nenhum

Parâmetros:

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

Método:

getIntField

Descrição:

Retorna o valor de campo do tipo inteiro.

Requisitos:

Nenhum

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
PfieldName	Char		X			Campo
PfieldValue	Int			X		Valor

Método:

getKey

Descrição:

Retorna o valor dos campos do índice id.

Requisitos:

Nenhum

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
Pprg-importador	Char			X		Programa importador
Pbanco	Char			X		Banco de dados
Ptabela	Char			X		Tabela do banco
Psequencia	Int			X		Sequencia

Método:

getLogField

Descrição:

Retorna o valor de campos do tipo lógico.

Requisitos:

Nenhum

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
PfieldName	Char		X			Campo
PfieldValue	Log			X		Valor

Método:

getRawField

Descrição:

Retorna o valor de campos do tipo raw.

Requisitos:

Nenhum

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
PfieldName	Char		X			Campo
PfieldValue	Raw			X		Valor

Método:

getRecidField

Descrição:

Retorna o valor de campos do tipo recid.

Requisitos:

Nenhum

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
PfieldName	Char		X			Campo
PfieldValue	recid			X		Valor

Método:

goToKey

Descrição:

Reposiciona registro com base no índice id.

Requisitos:

Nenhum

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
Pprg-importador	Char			X		Programa importador
Pbanco	Char			X		Banco de dados
Ptabela	Char			X		Tabela do banco
Psequencia	Int			X		Sequencia

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:

OpenQueryMain

Descrição: Abre a query com todos os registros de data inicial e data de termino existentes da tabela layout-import

Método:

openQueryPrograma

Descrição: Abre a query com os registros do filtro programa importador, banco e tabela existentes da tabela layout-import

Método:

SetConstraintPrograma

Descrição:

Seta as variáveis de controle para queries com o filtro área produção, agrupamento e data inicial e final.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
p-banco	Char		X			Banco de dados
p-tabela	Char		X			Tabela do banco
p-programa	Char		X			Programa importador

Métodos Negócio

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

Método:

CreateDefaultCS0110

Descrição: Cria os dados padrões da tabela layout-import para o programa CS0110 – Importação Custos Horários.

Método:

CreateDefaultSF0330

Descrição: Cria os dados padrões da tabela layout-import para o programa SF0330 – Importação Reporte Operação.

Método:

CreateDefaultSF0331

Descrição: Cria os dados padrões da tabela layout-import para o programa SF0331– Importação Reporte Operação.

Método:

CreateDefaultSF0332

Descrição: Cria os dados padrões da tabela layout-import para o programa SF0332 – Importação Reporte Operação.

Método:

CreateLayout

Descrição:

Atualiza a tabela de acordo com os dados recebidos de sua temp-table.

Requisitos:

Nemhum.

Parâmetros:

Parâmetro	Tipo		I	O	IO	Descrição
tt-layout-import	Table	X				Temp Table Layout de Importação
p-program	Char	X				Programa importador
p-banco	Char	X				Banco de dados
p-tabela	Char	X				Tabela do banco

Método:

FindPosicao

Descrição:

Procura a posição inicial e o tamanho original do registro.

Requisitos:

Nenhum.

Parâmetros:

Parâmetro	Tipo		I	O	IO	Descrição
p-programa	Char	X				Programa importador
p-banco	Char	X				Banco de dados
p-tabela	Char	X				Tabela do banco
p-sequencia	Int	X				Sequencia
p-posicao	Int			X		Posicao inicial
p-tamanho	Int			X		Tamanho

Método:

ValidaTamanho

Descrição:

Informa o tamanho máximo que o campo pode Ter.

Parâmetros:

Parâmetro	Tipo		I	O	IO	Descrição
PProgram	Char	X					Programa de importação
PSequencia	Int	X					Sequência do campo
PTamanho	Int			X			Tamanho do campo

Método:

ValidateRecord

Descrição:

Validações pertinentes ao DBO.

Requisitos:

Parâmetros:

Parâmetro	Tipo		I	O	IO		Descrição
PType	Char	X					Recebe o tipo de validação

Árvore de páginas

BOIN724 - Layout Importação.

Documento de API

Métodos Básicos

Queries e Constraints

Métodos Negócio