This article covers some advanced error-handling techniques that involve filtering and nesting.
There are 2 kinds of filtering that can take place on an error handler route:
- Adding a filter to the error handler route
- Adding a Router followed by filters to the error handler route
Adding a filter to the error handler route
Users may use a filter to control which errors are handled by the error handler route. This allows you to process only specific types of errors. If an error does not pass through the filter, it will be treated as if there is no error handler route defined for the given module.
Adding a Router followed by filters to the error handler route
As can be seen, the error takes place at the "Create a folder module (A)", which has a regular route and an error handler route. The latter is followed by a router with one route that has a filter that defines a specific type of error (in this case, Data Error), and the other which is the default route for all other errors. The first route ends with the "Resume" directive which contains substitute values for the scenario to resume from module A (Create a folder), while the second route ends with the "Rollback" directive which stops the scenario execution immediately.
Read this article to learn more about error types.
For the above data error scenario, it was created because the Create a folder module on Dropbox and a folder with the same name already exists. As such, the module threw a Data Error as shown below.
The complete scenario is shown below.
- The Tools > Set Variable module contains the folder name
- The HTTP > Get a file module fetches the file that needs to be uploaded to the folder
- The Dropbox > Create a folder module throws an error when a folder already exists, with the same name as the one mapped in the module
- The error handler route (transparent bubbles) contains a router to filter the errors
- The first route is for a specified type of error called "Data Error".
- If a Data Error takes place and the error details pass through the filter, the Dropbox > List all files/subfolders in a folder module lists all folders in Dropbox
- The subsequent filter matches the folder names
- The Resume directive specifies the folder ID and folder path of the existing folder and the scenario execution resumes from the Dropbox > Create a folder module but instead of trying to create a new folder, this time it uses the values from the Resume directive to move to the next module and upload the file in the existing folder
- The second route is for all other errors and ends with the Rollback directive which results in stopping the scenario immediately.
To further explain step #5 above, in order to use the existing folder in your subsequent modules, you need to add an error handler route to the module and fetch the folder path to be mapped into the Resume directive module that follows. Visualize this step below:
Please note that the filter on the first route is set to only handle the particular error (Data Error) that appears when a folder with the same name already exists.
The Dropbox > List all files in a folder module is configured to return all the folders in the target folder. The following filter only passes on the one we were originally trying to create (the folder name is stored in the
33. Folder Name item).
Eventually, the "Resume"directive supplies the Folder path as the output for the failed module. Note that the Folder ID has been left blank since it is not needed by the 'Upload a file' module.
Regardless of where a module is located, error handler routes can be created and implemented on all modules, except routers. It is therefore possible to create an error handler route for a module that is already part of an existing error handler route with another module. See below for an example.
In the above scenario, the second error handler route is nested under the first error handler route. So, if the Dropbox > Create a folder module encounters an error, the execution moves to Route 1, if the Data Error Takes Place filter is passed, the next module is executed followed by the Resume directive module if an error does not take place with the Dropbox > List all files/subfolders in a folder module.
If an error does take place with this Dropbox module, then the execution moves to Error Handler Route 2 and ends with the "Ignore" directive. It is obvious that the "Resume" directive module is not executed in this case.