Histórico da Página
...
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | mip/miapi010.p |
Objetivo
Gerar o Movimento de Histórico do Equipamento, e enviar e-mail ao responsável pelo equipamento.
Exemplo de chamada:
run mip/miapi010.p (input table tt_trans_bem,
output table RowErrors).
Funcionamento
A API irá validar os dados e manutenir as tabelas “mi-histor-eqpto” e “equipto”.
...
A variável denominada h-handle irá receber o “handle” do programa, permitindo o acesso aos “métodos” internos da API.
Tabelas Temporárias
Nos atributos das tabelas temporárias:
...
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
ErrorSequence | integer | padrão | Seqüência dos erros | Sim | 001 |
ErrorNumber | integer | padrão | Número do erro | Sim | 001 |
ErrorDescription | char | padrão | Descrição do erro | Sim | 001 |
ErrorParameters | char | padrão | Parâmetros passados para criar mensagem | Não | 001 |
ErrorType | char | padrão | Tipo do erro: WARNING: Aviso ERROR: Erro | Sim | 001 |
ErrorHelp | char | padrão | Texto de ajuda do erro | Sim | 001 |
ErrorSubType | char | padrão | Sub Tipo da mensagem de erro | Não | 001 |
Métodos
Quando a API for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:
...
emptyRowErrors
Requisito | Nenhum | |||
Sintaxe | run emptyRowErrors in h-handle. | |||
Descrição | Limpa a temp-table de erros da API. | |||
|
| Parâmetros | Descrição | |
| Não Contém |
| ||
Retorno | A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors. |
| ||
getRowErrors
Requisito | Nenhum |
| |||||
Sintaxe | run getRowErrors in h-handle (output table RowErrors). | ||||||
Descrição | Retorna os erros ocorridos na API. | ||||||
|
| Parâmetros | Descrição | ||||
| RowErrors | Temp-Table de Erros da API | |||||
Retorno | A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors. |
|
Métodos de Negócio
piCriaPendencia
Requisito | Nenhum |
| ||
Sintaxe | run piCriaPendencia. |
| ||
Descrição | Cria pendência no Histórico do Equipamento. | |||
| Parâmetros | Descrição | ||
| Não Contém |
| ||
Retorno | A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors. | |||
piEnviaEmail
Requisito | Nenhum |
| ||||||
Sintaxe | run piEnviaEmail. |
| ||||||
Descrição | Envia e-mail para o responsável pelo equipamento, sobre pendência deste. | |||||||
|
| Parâmetros | Descrição | |||||
| Não Contém |
| ||||||
Retorno | A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors. |
|