Throw Error

Conheça o componente e saiba como utilizá-lo.

Micaella Mazoni avatar
Escrito por Micaella Mazoni
Atualizado há mais de uma semana

IMPORTANTE: Esta documentação foi descontinuada. Leia a documentação Throw Error atualizada no nosso novo portal de documentação.

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

Dê uma olhada nos parâmetros de configuração desse componente:

  • Error Code: define o código do erro (utilizamos como base códigos de erro HTTP).

  • Error Message: define a mensagem de erro que acompanha o código de erro.

  • Custom Error Enabled: define que o usuário deseja utilizar um erro customizado.

  • Custom Error: pode ser usado para definir uma mensagem customizada de erro (nesse caso, “Error Code” e “Error Message” são ignorados).

  • Fail on Error: se a opção estiver habilitada, a execução do pipeline com erro será interrompida; do contrário, a execução do pipeline continua, mas o resultado vai mostrar um valor falso para a propriedade "success".

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 Plataforma Digibee 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.

IMPORTANTE: 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” for preenchida, então o conteúdo do objeto JSON é igual ao descrito na seção "Utilização do Throw Error para o tratamento de erros padrão" ou "Utilização do Throw Error para o tratamento de erros customizados".

Para entender melhor o conceito de subpipelines, clique aqui.

Respondeu à sua pergunta?