Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | mip/miapi074.p |
Objetivo
A API faz através das temp-tables passadas como parâmetro, o planejamento dos materiais necessários a Manutenção Industrial.
Funcionamento
A API faz o planejamento para compra ou produção dos materiais necessários as ordens de manutenção existentes no sistema.
Para cada Item onde, o controle de planejamento no seu estabelecimento for Manutenção Industrial e esse item se estiver dentro do filtro, é gerada a tabela de Planejamento do Item. Também são eliminados todos os Planejamentos do Período dentro do filtro passado como parâmetro.
Para todos os itens da tabela de Planejamento do Item, de acordo com as necessidades de materiais das ordens de manutenção, são gerados os planejamentos para o período informado no filtro.
A sintaxe para executar a API em modo persistente é:
run mip\miapi074.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.
Tabelas Temporárias
Nos atributos das tabelas temporárias de entrada e saída:
Tabela Temporária | Descrição | Entrada/Saída |
ttSelecao | Tabela temporária com a seleção do filtro | Entrada |
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
familyInit | Char | Padrão | Família do Item Inicial do filtro | Sim | 001 |
familyFinal | Char | Padrão | Família do Item Final do Filtro | Sim | 001 |
stockGroupInit | Integer | Padrão | Grupo de Estoque Inicial do Filtro | Sim | 001 |
stockGroupFinal | Integer | Padrão | Grupo de Estoque Final do Filtro | Sim | 001 |
itemInit | Char | Padrão | Item inicial do Filtro | Sim | 001 |
itemFinal | Char | Padrão | Item final do Filtro | Sim | 001 |
plannerInit | Char | Padrão | Planejador Inicial do Filtro | Sim | 001 |
plannerFinal | Char | Padrão | Planejador Final do Filtro | Sim | 001 |
productionLineInit | Integer | Padrão | Linha de Produção Inicial do Filtro | Sim | 001 |
productionLineFinal | Integer | Padrão | Linha de Produção Final do Filtro | Sim | 001 |
establishmentInit | Char | Padrão | Estabelecimento Inicial do Filtro | Sim | 001 |
establishmentFinal | Char | Padrão | Estabelecimento Final do Filtro | Sim | 001 |
bussinessUnitInit | Char | Padrão | Unidade de Negócio Inicial do Filtro | Sim | 001 |
bussinessUnitFinal | Char | Padrão | Unidade de Negócio Final do Filtro | Sim | 001 |
priceType | Integer | Padrão | Tipo de preço | Sim | 001 |
currency | Integer | Padrão | Moeda corrente | Sim | 001 |
dateInitial | Date | 99/99/9999 | Data Inicial do Filtro | Sim | 001 |
dateFinal | Date | 99/99/9999 | Data Final do Filtro | Sim | 001 |
Tabela Temporária | Descrição | Entrada/Saída |
ttParametros | Tabela temporária com os parâmetros informados ao gerar o planejamento dos materiais | Entrada |
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
showReprogrammedOrders | logical | padrão | Valor que informa se as ordens reprogramadas serão apresentadas | Sim | 001 |
considersPredictedConsumption | logical | padrão | Considerar Consumo Previsto | Sim | 001 |
checkNeedOrders | logical | padrão | Considerar Necessidade das Ordens de Produção, para o planejamento dos Materiais | Sim | 001 |
dependentDemand | logical | padrão | Considerar Itens com Demanda Dependente | Sim | 001 |
independentDemand | logical | padrão | Considerar Itens com Demanda Independente | Sim | 001 |
initialConsumptionDate | date | 99/99/9999 | Data de Consumo Inicial | Sim | 001 |
cutDate | date | 99/99/9999 | Data de Corte | Sim | 001 |
deleteAllPlanning | Logical | Sim/Não | Eliminar Planejamento de material para todos os estabelecimentos | Sim | 001 |
Tabela Temporária | Descrição | Entrada/Saída |
RowErrors | Contém os erros ocorridos na API (Mesma temp-table utilizada para gerar erros pelas BOs) | Saída |
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:
Método Negócio
generateMaterialPlanning
Requisito | Handles estarem inicializados. | |
Sintaxe | RUN generateMaterialPlanning IN h-handle (INPUT TABLE ttSelecao, INPUT TABLE ttParametros, OUTPUT TABLE RowErrors). | |
Descrição | Gera o Planejamento de Materiais. | |
| Parâmetros | Descrição |
| ttSelecao ttParametros RowErrors | Tabela Temporária com as informações do filtro realizado Tabela Temporária com as informações dos parâmetros ao realizar o planejamento Tabela temporária com os erros que poderão retornar 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. |