Árvore de páginas


Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físico

 mip/miapi076.p

 

Objetivo

A API faz através das temp-tables passadas como parâmetro, o detalhamento das informações das ordens de compra ou ordens de produção geradas através do planejamento de materiais.

 

Funcionamento

Através dos registros da tabela de Planejamento do Período são informados os detalhes das ordens de compra ou ordens de produção geradas através do planejamento de materiais.

A sintaxe para executar a API em modo persistente é:

run mip\miapi076.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

ttDemonstrativo

Tabela temporária com a seleção do usuário

Entrada

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

item

Char

Padrão

Item

Sim

001

itemDescription

Char

Padrão

Descrição do Item

Não

001

date

date

99/99/9999

Data

Sim

001

establishment

Char

Padrão

Estabelecimento

Sim

001

establishmentDescription

Char

Padrão

Descrição do Estabelecimento

Não

001

compromissedOrders

Integer

Padrão

Ordens Comprometidas

Não

001

plannedOrders

Integer

Padrão

Ordens Planejadas

Não

001

compromissedReserves

decimal

Padrão

Reservas Comprometidas

Não

001

plannedReserves

decimal

Padrão

Reservas Planejadas

Não

001

itemAvailable

decimal

Padrão

Quando de Itens disponiveis

Não

001

itemValue

decimal

Padrão

Valor dos Itens

Não

001

dimension

Char

Padrão

Utilizado para posicionar o registro

Não

001

Tabela Temporária

Descrição

Entrada/Saída

ttOrdensProdComprometidas

Tabela temporária com as Ordens Comprometidas

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

item

char

padrão

Valor que informa se as ordens reprogramadas serão apresentadas

Não

001

productionOrder

integer

padrão

Considerar Consumo Previsto

Não

001

orderQuantity

decimal

padrão

Considerar Necessidade das Ordens de Produção, para o planejamento dos Materiais

Não

001

initial

date

padrão

Considerar Itens com Demanda Dependente

Não

001

finised

date

padrão

Considerar Itens com Demanda Independente

Não

001

planner

char

99/99/9999

Data de Consumo Inicial

Não

001

Tabela Temporária

Descrição

Entrada/Saída

ttMateriaisComprometidos

Tabela temporária com os Materiais Comprometidos

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

item

Char

padrão

Item

Não

001

produtionOrder

integer

padrão

Ordem

Não

001

itemParent

char

padrão

Item Pai

Não

001

quantity

decimal

padrão

Quantidade

Não

001

quantityAnswered

decimal

99/99/9999

Quantidade Atendida

Não

001

reservedDate

date

99/99/9999

Data da Reserva

Não

001

origin

Char

padrão

Origem

Não

001

Tabela Temporária

Descrição

Entrada/Saída

ttMateriaisPlanejados

Tabela temporária com os Materiais Planejados

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

item

Char

padrão

Item

Não

001

produtionOrder

integer

padrão

Ordem

Não

001

quantity

decimal

padrão

Quantidade

Não

001

date

date

99/99/9999

Data

Não

001

origin

Char

padrão

Origem

Não

001

Tabela Temporária

Descrição

Entrada/Saída

ttOrdensCompraComprometidas

Tabela temporária com as Ordens de Compra Comprometidas

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

item

Char

padrão

Item

Não

001

orderNumber

integer

padrão

Ordem

Não

001

installment

decimal

padrão

Parcela

Não

001

quantity

decimal

padrão

Quantidade

Não

001

delivery

date

99/99/9999

Entrega

Não

001

buyer

Char

 

Comprador

Não

001

emissionDate

date

99/99/9999

Data da Emissão

Não

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

detailOrders

Requisito

Handles estarem inicializados.

Sintaxe

RUN detailOrders IN h-handle (INPUT TABLE ttDemonstrativo,

                              OUTPUT TABLE ttOrdensProdComprometidas,

                              OUTPUT TABLE ttOrdensCompraComprometidas,

                              OUTPUT TABLE ttMateriaisPlanejados,

                              OUTPUT TABLE ttMateriaisComprometidos,

                              OUTPUT TABLE RowErrors).

Descrição

Retornar os detalhes sobre as ordens de compra e ordens de produção geradas através do planejamento de materiais.

 

Parâmetros

Descrição

 

ttDemonstrativo

ttOrdensProdComprometidas

ttOrdensCompraComprometidas

ttMateriaisPlanejados

ttMateriaisComprometidos

RowErrors

Tabela Temporária com as informações do filtro realizado

 

Tabela Temporária com as informações das Ordens de Produção Comprometidas

Tabela Temporária com as informações das Ordens de Compras Comprometidas

Tabela Temporária com as informações dos Materiais Planejados

 

Tabela Temporária com as informações dos Materiais Comprometidos

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.