Service COM form - Completing the Exceptions tab

The rule type rule-service-COM is deprecated. As appropriate, migrate to Service dotNET rules.

Use the Exceptions tab to specify the exception information returned to the client-side proxy when the service encounters a fatal processing error. You can also specify in the Exceptions tab other conditions that cause exception information to be returned to the client.

An exception is a fatal processing error in the service, such that valid data cannot be returned using the normal return value process. The system can return other, non-fatal activity status information to the client as part of the return value.

All fields are optional.

Field Description
Condition Select the condition that causes the system to return the specified data:
  • When — The system evaluates the when condition rule specified by the When Key. If the condition evaluates to true, the system returns an exception with the specified data. If the condition evaluates to false, the system continues evaluating the next when condition rule in the list. If all specified when conditions are false, the system returns the normal response data specified on the Parameters tab to the client application. Use this feature to extend the normal set of fatal error conditions that result in exceptions being returned to the client.
  • Mapping Error — If an error occurs while mapping incoming data from the request message to the clipboard, the system returns an exception with the specified data. If the list of response conditions does not include an entry for mapping errors, the system returns a standard exception to the client application.
  • Security Error — If an error occurs while authenticating the application client credentials, the system returns an exception with the specified data. If the list of response conditions does not include an entry for security errors, the system returns a standard exception to the client application.
  • Service Error — If a service error occurs, the system returns an exception with the specified data. If the list of response conditions does not include an entry for service errors, the system returns a standard exception to the client application.
    Note: It is a best practice to configure the error conditions to ensure that the system notifies an administrator about the error.
When Key If the condition value is When, specify the second key part of the when condition rule to be evaluated.

If the condition value is Mapping Error, Security Error or Service Error, leave this field blank.

Map From Select how the system maps the output data from the clipboard data:
  • Clipboard — The system maps the data value from the scalar property specified by the Map From key.
  • Constant — The system returns a fixed value.
  • XML Stream — The system composes a stream of XML text formatted by an XML Stream rule.
  • HTML Stream — The system composes a stream of HTML text formatted by an HTML rule.
  • HTML Frame — The system returns a stream of HTML data generated by the service activity.
Key Identify a source for the Map From value:
  • If the Map From value is Clipboard, enter the property name to which the data is to be mapped.
  • If the Map From value is Constant, enter a literal string. To include blank spaces in your text string, surround the string with double quotes.
  • If the Map From value is XML Stream, enter a Stream Name key part of the XML Stream rule that is to generate the data. The system uses the Primary Page Class of the service as the Applies To key part of the XML Stream rule.
  • If the Map From value is HTML Stream, enter the Stream Name key part of the HTML rule that is to generate the data stream. The system uses the Primary Page Class of the service as the Applies To key part.
  • If the Map From value is HTML Frame, enter the name of the frame specified in the Show-HTML step of the service activity. Use this to return data from activities that were originally written for interactive browser clients and use the Show-HTML method.