Throw Error

Descubra mais sobre o componente Throw Error e saiba como utilizá-lo na Digibee Integration Platform.

O Throw Error emite um erro dentro de um pipeline ou subpipeline. Ele pode ser usado para:

• interromper um pipeline com erro.

• interromper um componente que utilize subpipelines para processamento.

Parâmetros

Dê uma olhada nas opções de configuração do componente. Parâmetros suportados por expressões Double Braces estão marcados com (DB).

Parâmetro	Descrição	Valor padrão	Tipo de dado
Error Message	Define a mensagem de erro que acompanha o código de erro.	N/A	String
HTTP Status Code	Define o código do erro (utilizamos como base códigos de erro HTTP).	500-Internal Server Error	Inteiro
Enable Custom Error	Define que o usuário deseja utilizar um erro customizado.	False	Booleano
Custom Error (JSON)	Pode ser usado para definir uma mensagem customizada de erro (neste caso, HTTP Status Code e Error Message são ignorados).	N/A	String

Throw Error em ação

Tratamento de erros padrão (customErrorEnabled)

O Throw Error pode ser utilizado para o tratamento de erros padrão. Erro padrão é aquele que segue as definições da Digibee Integration Platform e que contém um código e uma mensagem.

Quando esse tipo de erro resulta na interrupção do pipeline, então a seguinte saída é produzida:

{
  "timestamp": <um número longo informando o timestamp de quando o erro foi gerado>,
  "error": <a mensagem configurada>,
  "exception": "PipelineEngineRuntimeException",
  "code": <o código configurado>
}

Tratamento de erros customizados

O Throw Error também pode ser utilizado para o tratamento de erros customizados. Nesse caso, um objeto JSON completo é informado na configuração do componente e posteriormente informado na saída do pipeline que resultou em erro.

Alguns triggers, como por exemplo REST, HTTP e HTTP File, necessitam receber uma propriedade code e uma propriedade error na saída do pipeline para preparar o código de retorno da chamada HTTP.

Componentes que utilizam subpipelines

Quando o Throw Error é utilizado em um componente que utiliza o subpipeline onProcess, o erro configurado é informado como entrada do subpipeline onException. Se a opção Custom Error (JSON) for preenchida, então o conteúdo do objeto JSON é igual ao descrito nas seções Tratamento de erros padrão ou Tratamento de erros customizados.

Para entender melhor o conceito, leia o artigo Subpipelines.