Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | wmp/wm9291.p |
API BO |
WM9091.p |
Descrição: Transferência Endereço - Confirmação |
Nome Físico | wmp/wm9091.p |
Includes com Parâmetros | - |
Release Inicial | 2.06B |
Versão de Integração | - |
Data de Liberação | - |
Banco | - |
Tabela | - |
Aplicativo | - |
Evolução | |
Versão | Programa |
{include/i-prgvrs.i WM9091 2.00.00.055 } | Wm9091 |
Uma API (Application Programming Interface) é um programa que recebe parâmetros específicos e executa uma tarefa determinada no Datasul EMS Framework. A tarefa pode ser uma atualização ou pode retornar informações, resultados de um cálculo ou um gráfico. Uma API é uma interface aberta para as funções de negócio do Datasul EMS Framework.
O DBO é um programa Progress que contém a lógica de negócio e acesso a dados para uma tabela do banco de dados. É uma evolução das APIs dos produtos Datasul.
Responsável por efetivar as transferências entre os endereços, executando a saída do saldo do endereço selecionado e gerando a entrada do saldo no novo endereço.
Esta API receberá vários parâmetros e entre eles uma tabela com todas as etiquetas que podem ser transferidas.
DEF INPUT PARAM pRwMovto AS ROWID NO-UNDO. → ID da tabela wm-box-movto.
DEF INPUT PARAM pIdBoxDestino LIKE wm-box.id-box NO-UNDO. → Informe o ID box destino, qdo saída = 0.
DEF INPUT PARAM pCodUsuario LIKE usuario-scm.usuario NO-UNDO. → Usuário da movimentação wm-box-movto.
DEF INPUT PARAM pCodEqpto LIKE wm-tarefa-docto.cod-equipamento NO-UNDO. → Código do equiámento.
DEF INPUT PARAM pCodColetor LIKE wm-tarefa-docto.cod-coletor NO-UNDO. → Código do coletor.
DEF INPUT PARAM pHoraInicio LIKE wm-tarefa-docto.hr-inicio-tarefa NO-UNDO. → Hora de início Tarefa.
DEF INPUT PARAM pSobreporBox AS LOGICAL NO-UNDO. → True ou false: Define se sobrepoe o id do Box.
DEF INPUT PARAM pIdAgrupador LIKE wm-etiqueta.id-etiqueta NO-UNDO. → Informar 0, parâmetro não usado.
DEF INPUT PARAM i-ind-status-saldo-origem LIKE wm-box-saldo.ind-status-saldo NO-UNDO. → informar Status do movimento de origem.
DEF OUTPUT PARAM o-ind-status-saldo-origem LIKE wm-box-saldo.ind-status-saldo NO-UNDO. → Parâmetro devolve o status do saldo.
DEF INPUT PARAM i-id-movto-box-saldo LIKE wm-box-saldo.id-movto NO-UNDO. → Informar o id do movimento da box saldo.
DEF OUTPUT PARAM o-id-movto-box-saldo LIKE wm-box-saldo.id-movto NO-UNDO. → Devolve o id da box saldo.
DEF INPUT PARAM TABLE FOR tt-etiqueta. → informar a TempTable com todas as Etiquetas da transferência.
DEF OUTPUT PARAM TABLE FOR RowErrors. → Devolve a RowErrors, caso tenha ocorrido erros no processo.
A API realizará uma séria de validações para determinar se a transferência é válida. Ao final, caso não ocorra nenhum erro, irá gerar uma saída no endereço origem selecionado com a quantidade digitada e uma entrada desta quantidade no endereço destino informado.
A sintaxe para a chamada da API/BO é:
RUN wmp/wm9091.p (INPUT r-box-movto,
INPUT 0, /* box destino */
INPUT c-usuario,
INPUT "", /* equipamento */
INPUT "", /* coletor */
INPUT TIME, /* hora inicio */
INPUT NO, "Indica se é para sobrepor box"
INPUT 0, Id do agrpador
INPUT i-ind-status-saldo-origem,
OUTPUT o-ind-status-saldo-origem,
INPUT i-id-movto-box-saldo,
OUTPUT o-id-movto-box-saldo,
INPUT TABLE tt-etiqueta,
OUTPUT TABLE RowErrors).
Temp-Table tt-etiqueta: Informações da wm-etiqueta.
TEMP-TABLE TT-ETIQUETA | |||||
Atributo | Tipo | Formato | Inicial | Obrigatório | Observação |
Id-etiqueta | Dec | >>>>>>>>>>>>>9 | Sim | Identificador Etiqueta | |
Cod-estabel | Char | X(3) | Não | Estabelecimento | |
Cod-item | Char | X(16) | Não | Item | |
Cod-refer | Char | X(8) | Não | Referência | |
Cod-lote | Char | X(10) | Não | Lote | |
Dt-validade-lote | Date | 99/99/9999 | Não | Data de validade do lote | |
Ind-leitura-etiqueta | Int | >9 | Não | Situação etiqueta: 1 – Não Lido 2 – Lido 3 – Inutilizado 4 – Estornado | |
Qtd-item | Dec | >>>,>>>,>>9.999 | Sim | Quantidade do item | |
Qtd-peso | Dec | >,>>>,>>9.9999 | Sim | Quantidade do peso | |
Cod-cliente | Int | >>>>>>>>9 | Não | Cliente | |
Cod-embalagem | Char | X(10) | Não | Embalagem | |
Nr-pedido | Int | >>>,>>>,>>9 | Não | Número do pedido | |
Cod-estabel-pedido | Char | X(3) | Não | Estabelecimento do pedido | |
Nr-pedcli | Char | X(12) | Não | Número do pedido do cliente | |
Nome-abrev | char | X(12) | Não | Nome abreviado | |
Nr-ord-prod | Int | >>>,>>>,>>9 | Não | Número da ordem de produção | |
Cod-estabel-ord | Char | X(3) | Não | Estabelecimento da ordem | |
Dt-geracao | Date | 99/99/9999 | Não | Data de geração | |
Hr-geracao | Int | >>>>9 | Não | Hora de geração | |
Dt-leitura | Date | 99/99/9999 | Não | Data de leitura | |
Cod-usuario | Char | X(12) | Não | Usuário | |
Id-agrupador | Dec | >>>>>>>>>>>>>9 | Não | Agrupador | |
Ind-sit-agrupador | Int | >9 | Sim | Situação Agrupador: 1 – Não Agrupa 2 – Agrupador Etiquetas 3 – Agrupador Próprio | |
Id-carga | Dec | >>>>>>>>>>>>>9 | Não | Carga | |
Log-impressa | Log | Yes/No | Não | Etiqueta impressa | |
Log-reportada | Log | Yes/No | Não | Etiqueta reportada | |
Ind-sit-estorno | Int | >9 | Não | Situação Estorno: 1 – Não Estornado 2 – Lido para Estorno 3 – Estornado | |
Log-rel-movto-etiqueta | Log | Yes/No | Não | Gera Relacionamento Movto Etiqueta | |
Qtd-item-retirado | Dec | >>>,>>>,>>9.999 | Não | Quantidade do item retirado | |
Cod-usuario-ult-acesso | Char | X(12) | Não | Usuário último acesso | |
Dt-ult-acesso | Date | 99/99/9999 | Não | Data último acesso | |
Hr-ult-acesso | Int | >>>>9 | Não | Hora último acesso | |
Cod-lote-orig | Char | X(10) | Não | Lote original | |
RowNum | Int | Não | Número sequencial de registros (será atualizado pela API) | ||
r-Rowid | Rowid | Não | Este campo será atualizado pela API. |
Tabela Temporária | Descrição | Entrada/Saída |
RowErrors | Tem a finalidade de retornar os erros ocorridos durante o armazenamento das etiquetas | Saída |
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
ErrorSequence | Integer | ||||
ErrorNumber | Integer | ||||
ErrorDescription | character | ||||
ErrorParameters | character | ||||
ErrorType | character | ||||
ErrorHelp | character | ||||
ErrorSubType | character |
©2002 Datasul. Todos os direitos reservados.