Copyright © Cloud Software Group, Inc. All Rights Reserved

Parse XML

Activity

The Parse XML activity takes a binary XML file or an XML string and processes it, turning it into an XML schema tree based on the XSD or DTD specified.

The preferred way to parse XML files is to use a Read File activity set to binary mode to read the XML file. Then pass the binary file contents to the Parse XML activity.

Parsing Date and Datetime Strings

In XML documents parsed by the XML Parser activity, datetime values are read in according to the ISO-8601 standard, as described in the XML Schema specification. For example, the value:

 

2002-02-10T14:55:31.112-08:00

is 55 minutes, 31 seconds, and 112 milliseconds after 2PM on February 10th, 2002 in a time zone that is 8 hours, 0 minutes behind UTC.

If no time zone field is present, the value is interpreted in the time zone of the machine that is performing the parsing. This can lead to complications if you are processing XML from different time zones, so you are encouraged to always use time zones.

Configuration

The Configuration tab has the following fields.

Field	Global Var?	Description
Name	No	The name to appear as the label for the activity in the process definition.
Description	No	Short description of the activity.
Input Style	No	Can be binary, text, or dynamic. In binary mode (the default and preferred choice), the binary content is read. The encoding used for parsing the content is either the value specified in the forceEncoding input item, the encoding specified in the XML header of the xmlBinary input item, or UTF-8 (the default encoding, if no encoding is specified). In text mode, an XML string is passed as an input item. In dynamic mode, a choice is offered for input. You can either supply binary or text input. You can use a choice statement and set substitution in the mapping to supply the correct type of input at run time.
Validate Output	No	When checked, specifies that the output of the activity should be validated against the schema specified in the Output Editor tab.

Input

See TIBCO ActiveMatrix BusinessWorks Process Design for more information about mapping and transforming input data.

The input for the activity is the following.

Input Item	Datatype	Description
xmlString	string	The XML string to parse. This input element is available when the Input Style configuration field is set to text.
xmlBinary	complex	Available when the Input Style configuration field is set to binary. This input item contains a required bytes item for which you specify the input XML bytes. This input item also contains an optional forceEncoding item. This specifies the encoding to use when parsing the XML. If this element is not specified, the encoding specified in the XML header of the byte element is used to parse the XML. If the encoding value is not specified in the XML header, the default encoding (UTF-8) is used. You can specify any valid XML encoding value listed in IANA-Charsets. See http://www.iana.org/assignments/character-sets for a complete list. Encoding names are case insensitive.
xmlBinary|xmlString	choice	Available when the Input Style configuration field is set to dynamic. This allows you to specify a choice statement and set substitution and supply the correct input type at runtime.

Output Editor

The Output Editor tab allows you to define a schema for the XML output. See Appendix A, Specifying Data Schema for a complete description of using the Output Editor tab.

Output

The output for the activity is the following.

Output Item	Datatype	Description
XML Schema	complex	The parsed XML schema is the output of this activity. The contents of the schema are determined by the schema defined on the Output Editor tab.

Error Output

The Error Output tab lists the possible exceptions that can be thrown by this activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information about error codes and corrective action to take.

Exception	Thrown When...
XMLParseException	An exception occurred when parsing the data.
UnsupportedEncodingException	An unsupported encoding was specified in the forceEncoding input item. You can specify any encoding supported by Java on the system where TIBCO ActiveMatrix BusinessWorks is running.
MissingByteCountException

 

Copyright © Cloud Software Group, Inc. All Rights Reserved