Produto: | Datasul |
Ocorrência: | Documentação de API |
| Nome Físico | cdp/cdapi0301ga.p |
Objetivo
Importar demandas do S&OP (Neogrid) no formato XML para uma temp-table do Progress.
Funcionamento
A API deve ser executada de modo persistente com um handle que deverá ser definido para executar o método pi-readXml, de acordo com a sessão de métodos definidos nesse documento.
A sintaxe para a chamada da API é:
run cdp/cd0301ga.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.
Nos atributos das tabelas temporárias de saída:
tt-integracao | Entrada/Saída | ||||
Retorna as informações das demandas do arquivo XML | Saída | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
it-codigo | Char |
| Código do item |
|
|
cod-estabel | Char |
| Código do estabelecimento do item |
|
|
cod-refer | Char |
| Código da referência do item |
|
|
período | Int |
| Período, sendo 0 o mês atual, 1 o próximo mês e assim sucessivamente |
|
|
quantidade | Int |
| Quantidade da demanda |
|
|
RowErrors | Entrada/Saída | ||||
Retorna os erros de execução da API. Os possíveis erros são: - Arquivo XML não encontrado no diretório informado. - Estrutura do XML inválida. | Saída | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
ErrorSequence | Int |
| Número da sequência do erro |
|
|
ErrorNumber | Int |
| Número do erro |
|
|
ErrorDescription | Char |
| Descrição do erro |
|
|
ErrorParameters | Char |
| Parâmetros do erro |
|
|
ErrorType | Char |
| Tipo de erro |
|
|
ErrorHelp | Char |
| Mensagem de ajuda do erro |
|
|
ErrorSubType | Char |
| Subtipo do erro |
|
|
Quando a API for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:
pi-readXml | ||
Requisito | pi-readXml | |
Sintaxe | pi-readXml (input c-arquivo, output tt-integracao, output RowErrors) | |
Descrição | Lê as demandas de um arquivo XML utilizando as rotinas padrões do foundation xmlutp\ut-genxml.p e salva em uma temp-table Progress | |
Parâmetros | Descrição | |
c-arquivo | Caminho completo e nome do arquivo XML com as informações das demandas | |
tt-integracao | Informações das demandas, de acordo com o arquivo XML (c-arquivo) | |
RowErrors | Erros que ocorreram durante a importação | |
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 possíveis erros de importação estão especificados na descrição da temp-table RowErrors. As mensagens possíveis para este método são: - Não foi encontrado o arquivo no diretório de entrada. Verifique os parâmetros de integração (CD0193). - Estrutura do XML inválida. | |
