Produto: | Datasul |
Ocorrência: | Documentação de APi |
Nome Físico: | lap/mlaapi014.p |
...
detalheDocumento | ||||
Requisito | NenhumPendência gerada no MLA. | |||
Descrição | Busca os detalhes do documento MLA. Obs: A mlaapi014 serve como ponte de comunicação entre o Fluig e o programa Progress referente ao documento utilizado. Através do número da transação da pendência, é recuperado o código do documento e então é executada a procedure "detalheDocumento" do programa padrão referente ao documento. Por exemplo:
Para mais informações acesse a documentação específica destas API's em API - MLA. | |||
Parâmetros | Tipo | Input/Output | Descrição | |
pNrTransacao | INTEGER | INPUT | Número da transação | |
lGeracaoPend | LOGICAL | INPUT | Indica se a chamada está sendo feita pela geração da pendência (true) ou da consulta do detalhe (false) | |
| pDesTipDoc | CHARACTER | OUTPUT | Descrição do tipo do documento | |
| pSituacao | INTEGER | OUTPUT | Situação do documento | |
| ttDados | TEMP-TABLE | OUTPUT | Temp-table genérica com todas as informações referentes ao documento | |
Retorno | O retorno desta procedure será "NOK" sempre que ocorrer algum erro durante o processamento, caso contrário o retorno será "OK". | |||
detalhePendencia | ||||
Requisito | NenhumPendência gerada no MLA. | |||
Descrição | Busca os detalhes da pendência do MLA | |||
Parâmetros | Tipo | Input/Output | Descrição | |
pNrTransacao | INTEGER | INPUT | Número da transação | |
ttDados | TEMP-TABLE | OUTPUT | Temp-table com as informações detalhadas da pendência e chave formatada do documento | |
Retorno | O retorno desta procedure será "NOK" sempre que ocorrer algum erro durante o processamento, caso contrário o retorno será "OK". | |||
historicoDocumento | ||||
Requisito | NenhumPendência gerada no MLA. | |||
Descrição | Busca o histórico de aprovação do documento. | |||
Parâmetros | Tipo | Input/Output | Descrição | |
pNrTransacao | INTEGER | INPUT | Número da transação | |
ttDados | TEMP-TABLE | OUTPUT | Temp-table com as informações detalhadas da pendência e chave formatada do documento | |
Retorno | O retorno desta procedure será "NOK" sempre que ocorrer algum erro durante o processamento, caso contrário o retorno será "OK" | |||
...
aprovarDocumento | ||||
Requisito | Nenhum. | |||
Descrição | Aprova/Reprova o documento MLA | |||
Parâmetros | Tipo | Input/Output | Descrição | |
pUsuario | CHARACTER | INPUT | Usuário que está realizando a aprovação/reprovação do documento. | |
pSelecionados | CHARACTER | INPUT | Transações selecionadas que serão aprovadas/reprovadas. Obs: separadas por "," | |
| pAcao | INTEGER | INPUT | 1 - Aprovar; 2 - Reprovar | |
| pNarrativa | CHARACTER | INPUT | Narrativa de aprovação/reprovação. | |
| pCodRejeicao | INTEGER | INPUT | Código da rejeição. Obs: Passar 0 caso seja aprovação. | |
| pLote | LOGICAL | INPUT | Flag que indica se a aprovação está sendo feito em lote ou individualmente. Obs: Quando o valor desta flag for verdadeiro (movimentação em lote), o sistema usará a narrativa e código de rejeição padrão. | |
| pLogErro | LOGICAL | OUTPUT | Flag que indica se houve erro no processamento | |
| RowErrors | TEMP-TABLE | OUTPUT | Temp-table com os erros do processamento | |
Retorno | O retorno desta procedure será "NOK" sempre que ocorrer algum erro durante o processamento, caso contrário o retorno será "OK". | |||
startProcessFluig | ||||
Requisito | NenhumPendência gerada no MLA. | |||
Descrição | Inicia uma solicitação no Fluig | |||
Parâmetros | Tipo | Input/Output | Descrição | |
iNrTransacao | INTEGER | INPUT | Número da transação que dará inicio a solicitação no Fluig | |
iNrSolicFluig | INTEGER | OUTPUT | Número da solicitação criada no Fluig | |
| RowErrors | TEMP-TABLE | OUTPUT | Temp-table com os erros do processamento | |
Retorno | O retorno desta procedure será "NOK" sempre que ocorrer algum erro durante o processamento, caso contrário o retorno será "OK". | |||
cancelProcessFluig | ||||
Requisito | NenhumPendência gerada no MLA. | |||
Descrição | Cancelar uma solicitação no Fluig | |||
Parâmetros | Tipo | Input/Output | Descrição | |
iNrTransacao | INTEGER | INPUT | Número da transação que terá a solicitação Fluig cancelada | |
iTipo | INTEGER | INPUT | 1 - Cancelado pois o documento originador foi alterado 2 - Cancelado pois o documento originador foi removido | |
| RowErrors | TEMP-TABLE | OUTPUT | Temp-table com os erros do processamento | |
Retorno | O retorno desta procedure será "NOK" sempre que ocorrer algum erro durante o processamento, caso contrário o retorno será "OK". | |||
changeStateFluig | ||||
Requisito | Nenhum. | |||
Descrição | Movimentar uma solicitação no Fluig | |||
Parâmetros | Tipo | Input/Output | Descrição | |
iNrTransacao | INTEGER | INPUT | Número da transação MLA | |
iAtividade | INTEGER | INPUT | Número da atividade: 6 - Aprovar; 7 - Reprovar | |
| RowErrors | TEMP-TABLE | OUTPUT | Temp-table com os erros do processamento | |
Retorno | O retorno desta procedure será "NOK" sempre que ocorrer algum erro durante o processamento, caso contrário o retorno será "OK". | |||
trocaAprovador | ||||
Requisito | NenhumPendência gerada no Fluig e já alterada no MLA. | |||
Descrição | Altera o aprovador da solicitação Fluig. Obs: O novo aprovador é recuperado da tabela mla-doc-pend-aprov, por isso não há necessidade de passá-lo como parâmetro para a procedure. Porém é necessário passar o usuário original da pendência, que era o aprovador antes da troca. | |||
Parâmetros | Tipo | Input/Output | Descrição | |
iNrTransacao | INTEGER | INPUT | Número da transação MLA | |
cUserOrig | CHARACTER | INPUT | Código do usuário ERP Origem (antigo responsável da pendência) | |
| RowErrors | TEMP-TABLE | OUTPUT | Temp-table com os erros do processamento | |
Retorno | O retorno desta procedure será "NOK" sempre que ocorrer algum erro durante o processamento, caso contrário o retorno será "OK". | |||
...
setHandleFluig | ||||
Requisito | Nenhum. | |||
Descrição | Inicia o handle da api de integração com o Fluig. | |||
Retorno | O retorno desta procedure será "NOK" sempre que ocorrer algum erro durante o processamento, caso contrário o retorno será "OK". | |||
setHandleFluigunsetHandleFluig | ||||
Requisito | Nenhum. | |||
Descrição | Encerra e elimina o handle da api de integração com o Fluig. | |||
Retorno | O retorno desta procedure será "NOK" sempre que ocorrer algum erro durante o processamento, caso contrário o retorno será "OK". | |||
Documentação das temp-tables usadas na MLAAPI014:
ttDados | Entrada/Saída | |||
Temp-table com dados agrupados das tabelas que trafegam entre o ERP e o Fluig. | Saída | |||
Atributo | Tipo | Descrição | Obrigatório | Evolução |
cTable | CHARACTER | Nome da tabela
| Sim | Não se aplica |
iRow | INTEGER
| Número da linha/registro. Usa este campo para indicar quais campos pertencem ao mesmo registro
| Sim | Não se aplica |
| cField | CHARACTER | Nome do campo da tabela | Sim | Não se aplica |
| cValue | CHARACTER | Valor do campo | Sim | Não se aplica |
ttCodRejeita | Entrada/Saída | |||
Temp-table com dados das rejeições cadastradas no ERP | Saída | |||
Atributo | Tipo | Descrição | Obrigatório | Evolução |
codRejeita | INTEGER | Código da rejeição | Sim | Não se aplica |
descRejeita | CHARACTER | Descrição da rejeição | Sim | Não se aplica |
| obrigaNarrativa | LOGICAL | Flag que indica se é necessário informar a narrativa para a rejeição selecionada. | Sim | Não se aplica |
ttUsuarMestre | Entrada/Saída | |||
Temp-table com dados dos usuários mestres cadastrados no ERP | Saída | |||
Atributo | Tipo | Descrição | Obrigatório | Evolução |
codUsuar | CHARACTER | Código do usuário mestre | Sim | Não se aplica |
nomeUsuar | CHARACTER | Nome do usuário mestre | Sim | Não se aplica |
| CHARACTER | E-mail do usuário mestre | 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 |
