Adding Details to Error Code Descriptions

Error codes are defined in HTTP protocol. Each error code has a certain use that is predefined in the HTTP protocol specification. TIBCO Business Studio for BusinessWorks allows you to add more details to the description of an error code that might help in debugging the error.

Error codes are defined per operation. If the same error code is defined in multiple operations, you can define the error details that are specific to the operation within each operation.
Note: You can edit error codes only in projects that were created ground up in the TIBCO Business Studio for BusinessWorks. In projects that were created using an imported Swagger file, you can only view the error code details.

To add an error code to an operation or to edit the error code description, follow these steps:

Procedure

  1. In the Bindings tab of the process, expand the Operations tree in the left pane.
  2. Click the operation for which you want to add an error code or modify an existing error code description.
  3. Click the Response Status tab in the right pane.
  4. Click the Add Response Status button () to add an error code.
    The Reason Phrase that is shown by default in the default description for that error code. You can click on it to add more details to the error description.

  5. Click the code, type, or reason phrase to edit the field.

Result

The newly added error code will be available for you to select.