Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Variável

Tipo do parâmetroTipo do dado

Descrição

Exemplo
pathFileINPUTCHARACTER

<Diretório-arquivo>/<arquivo>

c:\temp\btr002aa.txt


Retorno

Tipo

Descrição
OKArquivo enviado com sucesso à Central de Documentos.
NOKArquivo não enviado a Central de Documentos.
ERROR

Problemas ao executar a API. 

Possíveis causas:

  • Indisponibilidade do serviço.
  • Endereço do arquivo inválido.
  • URL inválida cadastrada para conexão CFG - Gerais.
Bloco de código
themeRDark
titleExemplo de implementação
RUN btb\btapi003.r (INPUT "c:\temp\BTR002AA.LST").

IF RETURN-VALUE = 'ERROR' THEN DO:

    Run utp/ut-msgs.p ( Input "show",
                        Input 17006,
                        Input "Central de Documentos ~~Problema ao executar API de envio.").
END.
ELSE DO:
    IF RETURN-VALUE = 'OK' THEN
        Run utp/ut-msgs.p ( Input "show",
                            Input 15825,
                            Input "Central de Documentos~~Arquivo enviado para Central de Documentos.").
    ELSE
        Run utp/ut-msgs.p ( Input "show",
                            Input 27979,
                            Input "Central de Documentos~~O arquivo não foi envidado para Central de Documentos").
END.

Exemplo de chamada da API (usuário interno)

Bloco de código
themeRDark
Run btb/btapi910za.p ( Input "super":U, /* Usuário Interno do produto */
                       Input "super@123":U,
                       Output Table tt-erros).
For Each tt-erros:
    Message "Erro: "
            String(tt-erros.cod-erro) + " - ":U +
            tt-erros.desc-erro
            View-as Alert-box Information.
End.

Exemplo de chamada da API (usuário externo)

Bloco de código
themeRDark
Run btb/btapi910za.p ( Input "totvs/fulano":U, /* Usuário externo/rede */
                       Input "senhafulano":U,
                       Output Table tt-erros).
For Each tt-erros:
    Message "Erro: "
            String(tt-erros.cod-erro) + " - ":U +
            tt-erros.desc-erro
            View-as Alert-box Information.
End.

Exemplo de chamada da API com controle de abertura do cliente Progress (usuário interno)

Bloco de código
themeRDark
DEFINE VARIABLE hTeste AS HANDLE      NO-UNDO.

IF NOT VALID-HANDLE(hTeste) THEN
RUN fwk/utils/ValidateClientExec.p PERSISTENT SET hTeste.

// True indica a opção por controlar a abertura de clients Progress
RUN isValidateClientExec IN hTeste (INPUT TRUE).

Run btb/btapi910za.p ( Input "super":U, /* Usuário Interno do produto */
                       Input "super@123":U,
                       Output Table tt-erros).
For Each tt-erros:
    Message "Erro: "
            String(tt-erros.cod-erro) + " - ":U +
            tt-erros.desc-erro
            View-as Alert-box Information.
End.
IF VALID-HANDLE(hTeste) THEN
    DELETE OBJECT hTeste.