Assunto

Produto:	Datasul
Ocorrência:	Documentação de API
Nome físico:	lap/mlaapi016.p

Objetivo

Esta api tem como objetivo realizar as ações da tela de integrações do MLA x Fluig (html.mla0172).

Funcionamento

REST_POST_getListIntegrationErrors
Requisito	Nenhum.
Descrição	Retornar lista de erros de integração do MLA com o Fluig
	Parâmetros	Tipo	Input/Output	Descrição
	ttListParameters	TEMP-TABLE	INPUT	Parâmetros dos filtros
	currentTTIntegrationErrorsList	TEMP-TABLE	INPUT	Registros consultados - Paginação
	iCount	INTEGER	OUTPUT	Quantidade total de registros
	rLastIntegrationErrorRowid	ROWID	OUTPUT	Último rowid consultado dos erros de integração - Paginação
	rLastUnintegratedPendencyRowid	ROWID	OUTPUT	Último rowid consultado das pendências não integradas - Paginação
	ttIntegrationErrors	TEMP-TABLE	OUTPUT	Erros de integração encontrados
Retorno	O retorno desta procedure será "NOK" sempre que ocorrer algum erro durante o processamento, caso contrário o retorno será "OK".

REST_GET_getDocumentKeyComposition
Requisito	Nenhum.
Descrição	Retornar uma lista com a composição da chave do documento consultado.
	Parâmetros	Tipo	Input/Output	Descrição
	QP_pDocumentCode	INTEGER	INPUT	Código do documento
	ttDocumentKeyComposition	TEMP-TABLE	OUTPUT	Lista com os elementos da chave do documento
Retorno	O retorno desta procedure será "NOK" sempre que ocorrer algum erro durante o processamento, caso contrário o retorno será "OK".

REST_POST_executeFluigIntegration
Requisito	Nenhum.
Descrição	Executa a integração com o Fluig através do monitor de erros de integração.
	Parâmetros	Tipo	Input/Output	Descrição
	ttIntegrateTransactionFluig	TEMP-TABLE	INPUT	Registros que irão ser reprocessados
	RowErrors	TEMP-TABLE	OUTPUT	Erros que ocorreram durante o processamento
Retorno	O retorno desta procedure será "NOK" sempre que ocorrer algum erro durante o processamento, caso contrário o retorno será "OK".

getDocumentKeyComposition
Requisito	Nenhum.
Descrição	Retornar uma lista com a composição da chave do documento consultado.
	Parâmetros	Tipo	Input/Output	Descrição
	piDocumentCode	INTEGER	INPUT	Código do documento
	ttDocumentKeyComposition	TEMP-TABLE	OUTPUT	Lista com os elementos Chave
Retorno	O retorno desta procedure será "NOK" sempre que ocorrer algum erro durante o processamento, caso contrário o retorno será "OK".

ttIntegrationErrorsBeforeRowFill
Requisito	Nenhum.
Descrição	Realizar as validações necessárias antes de incluir um registro no dataset.
	Parâmetros	Tipo	Input/Output	Descrição
	dsIntegrationErrors	DATASET	INPUT	Dataset contendo as informações da integração
Retorno	O retorno desta procedure será "NOK" sempre que ocorrer algum erro durante o processamento, caso contrário o retorno será "OK".

ttIntegrationErrorsAfterRowFill.
Requisito	Nenhum.
Descrição	Setar os campos necessários após a criação do registro no dataset.
	Parâmetros	Tipo	Input/Output	Descrição
	dsIntegrationErrors	DATASET	INPUT	Dataset contendo as informações dos erros de integração do monitor
Retorno	O retorno desta procedure será "NOK" sempre que ocorrer algum erro durante o processamento, caso contrário o retorno será "OK".

countTotalRows
Requisito	Nenhum.
Descrição	Realizar a contagem de registros de uma query.
	Parâmetros	Tipo	Input/Output	Descrição
	c-table	CHARACTER	INPUT	Tabela utilizada na busca dos registros
	c-query	CHARACTER	INPUT	Query utilizada para a busca dos registros
	i-count	INTEGER	OUTPUT	Quantidade de registros na query
Retorno	O retorno desta procedure será "NOK" sempre que ocorrer algum erro durante o processamento, caso contrário o retorno será "OK".

ttIntegrationErrors				Entrada/Saída
Temp-table com dados dos erros da integração				Saída
Atributo	Tipo	Descrição	Obrigatório	Evolução
cdn-mensagem	INTEGER	Código do erro	Sim	Não se aplica
cdn-seq	INTEGER	Sequência do erro	Sim	Não se aplica
cdn-sit	INTEGER	Situação do erro	Sim	Não se aplica
cdn-tip-docto	INTEGER	Documento	Sim	Não se aplica
cdn-tip-erro	INTEGER	Tipo do erro de integração	Sim	Não se aplica
cdn-workflow-fluig	INTEGER	Código do Workflow Fluig	Sim	Não se aplica
cod-chave-docto	CHARACTER	Chave do documento	Sim	Não se aplica
cod-usuar	CHARACTER	Aprovador	Sim	Não se aplica
cod-usuar-reproces	CHARACTER	Código do usuário reprocessamento	Sim	Não se aplica
dat-cancel	DATE	Data cancelamento	Sim	Não se aplica
dat-rej	DATE	Data rejeição	Sim	Não se aplica
des-mensagem	CHARACTER	Descrição do erro	Sim	Não se aplica
dt-aprov	DATE	Data Aprovação	Sim	Não se aplica
dt-geracao	DATE	Data geração	Sim	Não se aplica
dtm-reproces	DATETIME	Data/hora do reprocessamento	Sim	Não se aplica
nr-trans	INTEGER	Número da transação	Sim	Não se aplica
desc-tip-docto	CHARACTER	Descrição do tipo do erro	Sim	Não se aplica

currentTTIntegrationErrorsList				Entrada/Saída
Temp-table com dados dos registros consultados (Paginação)				Entrada
Atributo	Tipo	Descrição	Obrigatório	Evolução
cdn-seq	INTEGER	Código do erro	Sim	Não se aplica
nr-trans	INTEGER	Número da transação	Sim	Não se aplica
cdn-tip-erro	INTEGER	Tipo do erro de integração	Sim	Não se aplica

ttListParameters				Entrada/Saída
Temp-table com dados dos filtros selecionados em tela				Entrada
Atributo	Tipo	Descrição	Obrigatório	Evolução
sortBy	CHARACTER	Data Geração, Documento, Tipo de Pendência, Chave	Sim	Não se aplica
orderAsc	LOGICAL	true: ASC \| false: DESC	Sim	Não se aplica
basicFilter	CHARACTER	Chave Documento ou Nr Transação	Sim	Não se aplica
sendError	LOGICAL	Erro de envio	Sim	Não se aplica
handlingError	LOGICAL	Erro de movimentação	Sim	Não se aplica
cancelError	LOGICAL	Erro de cancelamento	Sim	Não se aplica
unintegrated	LOGICAL	Não integrado	Sim	Não se aplica
rLastIntegrationErrorRowid	ROWID	Último rowid de registros de erros consultado(Paginação	Sim	Não se aplica
rLastUnintegratedPendencyRowid	ROWID	Último rowid de registros não integrados consultado(Paginação)	Sim	Não se aplica
transactionNumberIni	INTEGER	Número da transação - Inicial	Sim	Não se aplica
transactionNumberEnd	INTEGER	Número da transação - Final	Sim	Não se aplica
documentCodeIni	INTEGER	Código do tipo de documento - Inicial	Sim	Não se aplica
documentCodeEnd	INTEGER	Código do tipo de documento - Final	Sim	Não se aplica
generationDateIni	DATE	Data de geração - Inicial	Sim	Não se aplica
generationDateEnd	DATE	Data de geração - Final	Sim	Não se aplica
approvalDateIni	DATE	Data de aprovação - Inicial	Sim	Não se aplica
approvalDateEnd	DATE	Data de aprovação - Final	Sim	Não se aplica
rejectionDateIni	DATE	Data de rejeição - Inicial	Sim	Não se aplica
rejectionDateEnd	DATE	Data de rejeição - Final	Sim	Não se aplica
approvalUserIni	CHARACTER	Aprovador - Inicial	Sim	Não se aplica
approvalUserEnd	CHARACTER	Aprovador - Final	Sim	Não se aplica
documentKey	CHARACTER	Chave do documento	Sim	Não se aplica

ttDocumentKeyComposition				Entrada/Saída
Temp-table com dados da composição da chave do documento				Saída
Atributo	Tipo	Descrição	Obrigatório	Evolução
sequence	INTEGER	Sequência	Sim	Não se aplica
fieldSize	INTEGER	Tamanho do campo	Sim	Não se aplica
fieldDescription	CHARACTER	Descrição do campo	Sim	Não se aplica
positionIni	INTEGER	Posição inicial da chave	Sim	Não se aplica
positionEnd	INTEGER	Posição final da chave	Sim	Não se aplica

dsIntegrationErrors				Entrada/Saída
Dataset que contém as informações dos erros de integração do monitor				Entrada
Atributo	Tipo	Descrição	Obrigatório	Evolução
ttIntegrationErrors	temp-table	Temp-table com dados dos erros da integração	Sim	Não se aplica

RowErrors				Entrada/Saída
Temp-table com dados dos erros ocorridos durante o processo				Saída
Atributo	Tipo	Descrição	Obrigatório	Evolução
ErrorSequence	INTEGER	Número da sequência do erro	Sim	Não se aplica
ErrorNumber	INTEGER	Código do erro	Sim	Não se aplica
ErrorDescription	CHARACTER	Descrição do erro	Sim	Não se aplica
ErrorParameters	CHARACTER	Parâmentros da mensagem de erro	Sim	Não se aplica
ErrorType	CHARACTER	Tipo do erro	Sim	Não se aplica
ErrorHelp	CHARACTER	Texto de ajuda da mensagem de erro	Sim	Não se aplica
ErrorSubType	CHARACTER	Subtipo do erro	Sim	Não se aplica

Árvore de páginas

MLAAPI016 - Monitor de integrações MLA x Fluig

Assunto