Creating data schemas for event data and event message data

Data schemas for event data
Data schemas for event message data

When you create an event type, you specify an XML Schema Definition (XSD) file as data schema for event data and for event message data. Data schemas define the format of the data and data elements. These XSD files define the data structure displayed as navigation trees t in the event configuration dialog boxes. The data structure determines the elements you can use to filter events and map to values to when events are thrown or received.

You create or modify a data schema using an XML or text editor and then import it as an asset to an application. You can also use a similar existing data schema from another event type. The data schema must adhere to standard XML syntax rules.

When you create an event type, you can import data schemas for the event data and event message data. The data schema is available immediately after you save the event type and the data trees are visible in the event configuration dialog boxes.

For example, consider the following partial data schema for event data:

<?xml version="1.0" encoding="UTF-8"?> 
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" 
    elementFormDefault="unqualified" attributeFormDefault="unqualified"> 
    <xs:element name="PurchaseOrderEventTemplate"> 
        <xs:complexType> 
            <xs:sequence> 
                <xs:element name="PONumber" type="xs:short"/> 
                <xs:element name="Sender" type="xs:string"/> 
                <xs:element name="PartNumber" type="xs:long"/> 
                <xs:element name="Quantity" type="xs:long"/> 
                ... 
            </xs:sequence> 
         </xs:complexType> 
    </xs:element> 
</xs:schema>

That data schema results in the following data navigation tree in all related event configuration dialog boxes.

Data schemas for event data

* New for 9.5 *

To specify the data elements, create a data schema for the event data. The data schema is useful when you filter event data from event receives. The data schema can also be used to define the data that is exchanged between processes. For ease of use, a simple structure with a small set of data elements is recommended.

To throw an event, you assign values to the data elements by specifying the XPath in the XML Schema Definition (XSD). Any such data assignment must conform to the XSD restrictions. For example, if an element is specified as a mandatory element in the XSD, the value must be provided. Similarly, if an element has length restrictions in the XSD, that length restriction must be adhered to.

To filter data, an event receive or event catch can use elements in the XSD for event data to compare values with other data.

Note: The XML representing the event data that an event throw generates does not support namespaces.

Data schemas for event message data

* New for 9.5 *

Data schemas for event message data only apply to asynchronous events and are optional. The XSD for these data schemas identify the event message data that an asynchronous event receives or throws.

The XSD for the event message data can be a relatively complex data structure, such as the data definition for a purchase order or sales order. The event message data is not generated by a process. Instead, the event message data is assigned to the event when it is thrown from a process variable of type xml . The event message data can be copied as a whole into the process variable. Alternatively, specific data from the xml variable can be introduced into the process. Event filters can be specified on the elements specified in the data schema for event receives.

In contrast to event data, the event message data does support namespaces. Register the namespace in the Process Properties dialog box to use namespaces. (See Creating processes using the New Process wizard .)