As with any application, Zapps will occasionally run into errors. Errors may be due to source application issues, network issues, or, as detailed in the Errors article, design gaps that lead Capriza to return a Context Not Found (CNF) error. While Capriza provides default messaging for errors, you may also customize these messages to provide the user with more context or instructions about the error and better reflect your corporate language. This article provides step-by-step instructions for managing custom error messages.
Managing Error Messages
Within the Capriza Dashboard, you can configure custom error messages for each type of network and CNF error your users may encounter. To create a custom error message, first navigate to the Diagnostics page for the desired Zapp. Select the correct Zapp version from the menu.
Scroll down to the Zapp Errors section, and click the three dots icon in the upper right hand corner of the graph. Select "Manage Custom Messages."
Note: If the "Manage Custom Messages" option is greyed out it is because a specific Zapp version is not selected. Please select a version and proceed.
A dialog will open with a list of existing messages as well as the option to create a new message.
Click the "New Message" button to add a new message. Two options are included in the dropdown: New Network Message and New Custom Message.
New Network Message enables you to specify messaging for standard HTTP error, such as 404. To create a new message enter the:
- Network error number
The latter two items will appear in your Zapp when the specific network error occurs.
Once finished, click "Add" and then "Save" to save your message.
Custom messages can be for any type of CNF error detected by Capriza, based on content of the web page of the source application. To configure a custom message, you must enter three fields:
- Text on the web page.
The text on the web page should be text unique to that type of error. Once the error occurs, Capriza will look for that specific text on the web page to determine which message to display. You can decide which text to include by examining the runtime screenshot within the feedback associated with that particular error signature. Please see Monitoring Errors and Feedback for more information.
For example, the below feedback screenshot shows that a particular error results in the following text on the web page: "No switch to HTTPS occurred, so it is not secure to send a password."
You would, therefore, include this text as in "Text on the web page" field.
Note: It is recommended that you examine several feedback screenshots to ensure that text does not vary based on user role, privileges, etc. If it does, you should create several custom messages.
Then, add your message's Title and Subtitle. Both of these will be displayed to the user within the Zapp.
Once finished, click "Add" and then "Save."
Custom error messages will be automatically propagated to future versions of your Zapp but are not retroactively applied to earlier versions.