Histórico da Página
API responsável pela geração da tabela de documento pendente de aprovação
Características do Requisito
Linha de Produto: | Datasul |
Segmento: | Manufatura |
Módulo: | MLA |
Banco(s) de Dados: | MOVIND |
Tabelas Utilizadas: | doc-pend-aprov |
Release inicial | EMS 2.06B |
Considerações Gerais
Objetivo
Geração de pendências de aprovação para os documentos conforme listagem abaixo.
Pré-requisito: Aprovação de compras ou MLA configurado para gerar pendências para os documentos em questão.
Funcionamento
A API irá receber como parâmetros o Tipo de Documento, Tipo de transação e o Rowid do documento o qual será gerada a pendência de aprovação.
A sintaxe para a chamada da API é:
run cdp/cdapi171.p (input i-tipo, input i-transacao, r-documento). |
Exemplo da utilização:
run cdp/cdapi171.p (input 1, /* 1 - Solicitação de compra*/ input 1, /* 1 - Inclusão */ input rowid(it-requisicao) /* Rowid do registro que deverá ser gerada a pendência */ ). |
A execução na forma persistente é realizada através da chamada de um comando RUN conforme exemplo a seguir.
A sintaxe para executar a API em modo persistente é:
RUN cdp\cdapi171.p PERSISTENT SET h-handle. |
A variável denominada h-handle irá receber o “handle” do programa, permitindo o acesso aos “métodos” internos da API.
Informações referentes aos parâmetros:
i-tipo | Entrada/Saída | ||||
Tipo do Documento | Entrada | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
i-tipo | Inteiro | Tipo do Documento | Sim |
Utilizar:
1 - Solicitiação de compra
2 - Requisição de estoque
3 - Cotação
4 - Pedido de compra
5 - Solicitação de cotação
6 - Pedido emergencial
7 - Processo de compra
8 - Contrato de compra
9 - Solicitação de serviço
10 - Contrato de compra
11 - Evento de contrato
12 - Medição de contrato
i-transacao | Entrada/Saída | ||||
Tipo da Transação | Entrada | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
i-transacao | Inteiro | Tipo da Transação | Sim |
Utilizar:
1 - Inclusão
2 - Modificação
3 - Exclusão
r-documento | Entrada/Saída | ||||
Rowid do documento | Entrada | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
r-documento | rowid | Rowid do documento | Sim |
Informações complementares:
- Documento "1 - Solicitação de compra" passar o rowid do item da solcitação (it-requisicao)
- Documento "2 - Requisição de estoque" passar o rowid do item da solcitação(it-requisicao)
- Documento "3 - Cotação" passar o rowid da cotação (cotacao-item)
- Documento "4 - Pedido de compra" passar o rowid da ordem de compra (ordem-compra)
- Documento "5 - Solicitação de cotação" passar o rowid do item da solicitação(it-requisicao)
- Documento "6 - Pedido emergencial" passar o rowid da ordem de compra (ordem-compra)
- Documento "7 - Processo de compra" passar o rowid da cotação (cotacao-item)
- Documento "8 - Contrato de compra" passar o rowid do item do contrato (item-contrat)
- Documento "9 - Solicitação de serviço" passar o rowid da solicitação de serviço (solic-serv)
- Documento "10 - Contrato de compra" passar o rowid do contrato (contrato-for)
- Documento "11 - Evento de contrato" passar o rowid do evento (evento-ped)
- Documento "12 - Medição de contrato" passar o rowid da medição (medicao-contrat)
Metodo Negócio
Quando a API for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:
pi-executar | ||
Requisito | Nenhum | |
Sintaxe | RUN pi-executar in handle (INPUT i-tipo, INPUT i-transacao, INPUT r-documento). | |
Descrição | Geração da tabela de documentos pendentes de aprovação. | |
Parâmetros | Descrição | |
i-tipo
i-transacao
r-documento | 1-Solicitação 2-Requisição 3-Cotação 4-Pedido 5-Solicitação Cotação 6-Pedido Emergencial 7-Processo Compras 8-Contrato Fornec 9-Manutenção Industrial 10-Documento Contrato 11-Evento de Contrato 12-Medição de Contrato 1-Inclusão 2-Modificação 3-Exclusão Rowid do documento | |
Retorno | Retorna um return-value “OK” se o processo foi executado corretamente. |
pi-executar-2 | ||
Requisito | Nenhum | |
Sintaxe | RUN pi-executar-2 in handle (INPUT i-tipo, INPUT i-transacao, INPUT r-documento, OUTPUT TABLE RowErrors). | |
Descrição | Geração da tabela de documentos pendentes de aprovação, retornando erro caso ocorra | |
Parâmetros | Descrição | |
i-tipo
i-transacao
r-documento | 1-Solicitação 2-Requisição 3-Cotação 4-Pedido 5-Solicitação Cotação 6-Pedido Emergencial 7-Processo Compras 8-Contrato Fornec 9-Manutenção Industrial 10-Documento Contrato 11-Evento de Contrato 12-Medição de Contrato 1-Inclusão 2-Modificação 3-Exclusão Rowid do documento | |
Retorno | RowErrors | Tabela temporária de retorno dos possíveis erros que possam terem ocorridos durante a execução do método. |
getRowErrors | ||
Requisito | Nenhum | |
Sintaxe | RUN getRowErrors in handle (OUTPUT TABLE RowErrors). | |
Descrição | Retorno dos possíveis erros que possam terem ocorridos na execução dos métodos | |
Retorno | RowErrors | Tabela temporária padrão de erros |
setShowErrorsMLAAPI010 | ||
Requisito | Nenhum | |
Sintaxe | RUN setShowErrorsMLAAPI010 in handle (INPUT l-exibir-erros). | |
Descrição | Indicar para a MLAAPI010 se deverá exibir os erros em tela ou não | |
Parâmetros | Descrição | |
l-exibir-erros | Variável lógica que indicará para a MLAAPI010 se os erros deverão serem exibidos em tela ou apenas retornados na tabela temporária de erros. |