Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | cpp/cpapi019.p |
Objetivo: Realizar a troca do tipo de formulação do item no Fator de Concentração.
Considerações Gerais:
- Devem ser passadas 2 (duas) temp-tables como parâmetro, sendo uma de entrada e outra de entrada e saída, e mais um parâmetro lógico (yes/no) que define se os erros já existentes na temp-table de erros serão eliminados no início da execução.
- Exemplo de execução da API:
run cpp/cpapi019.p (input table tt-troca,
input-output table tt-erro,
input yes).
- A API funciona da seguinte forma: Recebe como parâmetros as temp-tables, faz as criticas das mesmas, caso não tenha ocorrido nenhum problema realiza a alteração dos itens informados;
- Se o programa chamador necessita executar a api para vários itens pode-se criar um registro na temp-table tt-troca com cada item, para depois executar a API.
- Tipo de Formulação existentes: 1- Não Utiliza, 2- Concentração, 3- PPM, 4- Veículo.
Parâmetros de Entrada
Temp-table tt-troca: nesta temp-table deverão ser armazenados os itens que terão o seu tipo de formulação alterado, o campo per-ppm será necessário apenas quando o novo tipo o for Concentração ou PPM.
TEMP-TABLE TT-TROCA | ||||
Atributo | Tipo | Formato | Valor Inicial | Obrigatório |
It-codigo | Character | “x(16)” | ? | Sim |
n-tipo-formula | Integer | “9” | ? | Sim |
per-ppm | Decimal | “>>>>,>>9.9999” | ? | Não |
carrega-dados | Logical | “Sim/Não” | Sim | Sim |
cod-Versão-Integracao | Integer | “999” | 0 | Sim |
Obs.: O campo carrega-dados deve sempre ser passado como Sim
Parâmetros de Saída
Temp-table tt-erro: Para cada troca de tipo de formulação serão executadas validações para consistir os registros, os erros encontrados serão gravados na temp-table tt-erro.
TEMP-TABLE TT-ERRO | |||
Atributo | Tipo | Formato | Valor Inicial |
i-sequen | Integer |
| 0 |
cd-erro | Integer |
| 0 |
Mensagem | Character | “x(255)” | ? |
|
|
|
|
Obs: O campo cd-erro possui o número do erro do cadastro de mensagem; O campo mensagem possui a descrição da mensagem do cadastro de mensagem; O campo i-sequen possui o número sequencial do erro;
Execução
Execução:
- O programa cpp/cpapi019.p irá executar as seguintes validações:
Número do Erro | Mensagem | Ajuda |
16 | Parâmetros globais não cadastrados | Parâmetros globais não cadastrados. |
200 | Parâmetros da Produção não cadastrados | Os Parâmetros da Produção devem ser cadastrados |
27372 | Função não implantada | A Função de Fator de Concentração deve estar implantada |
3941 | Versão de integração incorreta | A versão de integração informada através dos parâmetros internos é incompatível com a versão atual da API. Favor contatar suporte técnico. |
3662 | &1 deve estar entre &2 e &3 | O novo tipo de formulação do item deve estar entre 1 e 4 |
27382 | Concentração / PPM do item &1 deve ser maior que Zero | Quando o tipo de formulação for 2 ou 3 o campo per-ppm deve ser maior que 0 |
27283 | Tipo de controle de estoque deve ser por lote | Quanto o tipo de formulação dor 2 ou 3 o tipo de controle de estoque do item deve ser por Lote. |
27371 | Tipo de formulação do item &1 não pode ser alterado | Se o item possui reservas com quantidades atendidas, ou Alocações de Material, o seu tipo de formulação não pode ser alterado |