7.12.1 Schema file for defining fault messages

This sub-section describes the schema file that defines general fault messages.

The schema file defines exception information, information to identify the activity in business process in which failure has occurred, and the item (root application information) that is to be used to provide message (KDEC20087-W), which is output in message log for identifying the failure location.

Organization of this subsection

(1) File storage location
(2) Format

(1) File storage location

The schema file that defines general fault messages is stored in the following location:

<Installation directory of Service Platform>CSC\schema\fault\generic_fault.xsd

To Page Top

(2) Format

<?xml version="1.0" encoding="UTF-8"?>
<xsd:schema elementFormDefault="qualified" targetNamespace="http://www.msg.csc.soft.Hitachi.co.jp/cscGenericFault" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <xsd:element name="fault">
    <xsd:complexType>
      <xsd:sequence>
        <xsd:element name="exception-name"       type="xsd:string"/>
        <xsd:element name="exception-message"    type="xsd:string"/>
        <xsd:element name="scope-name"           type="xsd:string"/>
        <xsd:element name="activity-name"        type="xsd:string"/>
        <xsd:element name="activity-type"        type="xsd:string"/>
        <xsd:element name="process-instance-id"  type="xsd:string"/>
        <xsd:element name="root-ap-info"         type="xsd:string"/>
        <xsd:element name="extensions" minOccurs="0">
          <xsd:complexType>
            <xsd:sequence>
              <xsd:element name="extension" maxOccurs="unbounded">
                <xsd:complexType>
                  <xsd:simpleContent>
                    <xsd:extension base="xsd:string">
                      <xsd:attribute name="name" type="xsd:string" use="optional"/>
                    </xsd:extension>
                  </xsd:simpleContent>
                </xsd:complexType>
              </xsd:element>
            </xsd:sequence>
          </xsd:complexType>
        </xsd:element>
      </xsd:sequence>
    </xsd:complexType>
  </xsd:element>
</xsd:schema>

The settings for general fault messages are as follows:

Tag	Description
exception-name	Used to set exception name. Set the values for Exception.getClass().getName().
exception-message	Set exception information. Set by connecting the string returned by Exception.toString() with a semicolon.
scope-name	Set the scope name to which the activity in which fault has occurred belongs.
activity-name	Set the activity name in which fault has occurred.
activity-type	Set the type name of activity in which fault has occurred. Data transformation activity: convert Assign activity: assign Switch activity: switch Validate activity: validate
process-instance-id	Set process instance identifier.
root-ap-info	Set root application information.
Extensions^#	Extension area to output specialized information in each activity.

Note #

The format of extension element is as follows:

<extensions>
  <extension name="(extension information name)">(extension information contents)</extension>
</extensions>

Set the following for the variable item in extension element.

Activity name	(Extension information name)	(Extension information contents)
Validate activity	variable-name	Variable name of validation error

To Page Top