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 | Verifica se o tipo de documento da pendência está integrado 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 - Paginação | |
| rLastUnintegratedPendencyRowid | ROWID | OUTPUT | Último rowid consultado - 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". | |||