pub.event.eda:eventToDocument
WmPublic. Deprecated - There is no replacement service.
Converts an EDA event in the form of an XML string to a document instance in the form of pub.event.eda:event.
Note: | The pub.event.routing:subscribe service, which replaces the removed pub.event.nerv:subscribe service, handles the conversion of an EDA event into an IS document (IData). Hence, you no longer have to run the pub.event.eda:eventToDocument service to convert an EDA event before it can be processed. |
Input Parameters
xmldata | String XML string containing the event to convert to a document (IData object). The XML string must conform to the Event element structure declared in the Envelope.xsd schema. |
documentTypeName | String Optional. Fully qualified name of the IS document type that specifies the structure to impose on the body of the event. By specifying a document type, you can identify:  The order and dimensionality of elements. The prefix associated with each namespace in the instance document. The document type specified in documentTypeName does not need to specify every element that will appear in the resulting document. At a minimum, the document type needs to specify the elements whose structure you want to explicitly set and the elements that you want to use in pipeline mapping. If you do not specify documentTypeName, the structure of the event body is determined solely by the event document. |
Output Parameters
evt:Event | Document A document reference to the pub.event.eda:event document type which specifies the structure of an event as a Document (IData object). |
Usage Notes
This service transforms each element and attribute in the EDA event to an element in an IData object.
This service always converts XML nodes to String or Document object fields. It does not generate constrained objects (for example, Floats or Integers), even if the fields in the specified document are defined as constrained objects.
The
pub.event.eda:event document type determines the overall structure of the
evt:Event IData object that this service returns.
The document type specified for documentTypeName determines the structure of the event body contained in the evt:Body field. If you do not specify documentTypeName, the structure of the event body is determined by the event.
The document type in documentTypeName identifies the namespace prefixes to use for the conversion. Integration Server determines the namespace prefix information through the association of the prefix in the field name with the URI in the XML namespace property of the field. For example, suppose that a field in documentTypeName is named SAG:account and the XML namespace property of that field is http://www.softwareag.com. In the resulting IData object for the event body, Integration Server will use the prefix SAG with any element that belongs to the http://www.softwareag.com namespace.
If documentTypeName does not specify namespace prefixes or documentTypeName is not specified, the prefixes used in conversion depend on the event document.
If the event contains namespace qualified elements and uses prefixes, the resulting IData object for the event body uses the prefixes from the instance document.
If the event contains elements qualified with a default namespace and the elements do not use prefixes, the resulting IData object for the event body does not use prefixes. Only the local name appears in the resulting event body.
In a document type that represents a namespace qualified XML document, it is considered good practice for the document type and its contents to account for all of the namespaces in the XML document. That is, the document type should include namespace prefixed fields associated with the namespaces for all of the possible namespace qualified elements in the XML document.
When documentTypeName is provided, the server parameter watt.server.xml.xmlNodeToDocument.keepDuplicates determines whether or not Integration Server keeps additional occurrences of an element in an XML document. When set to true, the document produced by the pub.event.eda:eventToDocument service contains multiple occurrences of the element. When set to false, the document keeps only the last occurrence of the element. The default is true.
