XML Mapping Utility User Interface

Page restrictions apply
Attachments:19
Added by Barbara Weinstein, last edited by Barbara Weinstein on Aug 11, 2009

This section explains the XML Mapping Utility user interface.

To open the XML Mapping Utility, do one of the following:

Choose File > New > Mapping Rule.
Choose Tools > XML Mapping Utility.
Click the New button on the Project Files palette toolbar and choose Mapping Rule.
Double-click an existing rules file in the Project Files palette.

The XML Mapping Utility prompts you to select one or more source documents to use as the starting point for the mapping rules file. After the source documents are parsed, the XML Mapping Utility user interface is displayed.

The XML Mapping Utility has several panels and toolbars:

XML Mapping Utility Toolbar
Rules Tree Panel
Rules Tree Panel Toolbar
Rule Profile Panel
Settings Panel
Mapper Log

For definitions of fields in the XML Mapping Utility, see XML Mapping Utility.

XML Mapping Utility Toolbar

The XML Mapping Utility toolbar has buttons for creating, opening, and saving mapping rules.

For more information on toolbar buttons, see XML Mapping Utility Toolbar.

Rules Tree Panel

After the source documents are parsed, the mapping rules file displays as a tree consisting of multiple rules in the Rules Tree panel. The rules tree contains a collection of input (request) and output (response) rules, which are executed in the order they appear in the tree.

The rules in the rules file can be edited independently of the source document. After the initial parse, you can add rules to and remove rules from the file as needed. For example, unmapped rules can be removed to minimize the size of the rules file. Additional rules can be defined to customize the service interaction or account for changes to the service over time.

Icon	Rule Type	Description
(small pencil)	Attribute	A rule that maps to an attribute node.
	CDATA	A rule that maps to a CDATA (character data) node.
		A rule that maps to an element node and which has descendant element, attribute, or CDATA rules. Double-clicking the icon reveals additional rules that are defined by the source WSDL or Schema.
	Complex Type	A rule that maps to an element node and which has descendant element, attribute, or CDATA rules.
	Data Type	The XSD data type of the selected rule, such as string, boolean, decimal, and so on.
(large pencil)	Element	A rule that maps to an element node.
	Input (request)	An input or request rule.
	Mapping	A rule that has a mapping assigned to it.
	Operation	An operation or transaction rule.
	Output (response)	An output or response rule.
	Repeat When	An input rule that repeats. See Repeat When.
	Restriction	A rule that has a restriction assigned to it. Restrictions are used to validate and restrict user input. See Restrictions.
	Schema or WSDL	The root rule in the rules file.
	Service	The service, which is a collection of operations.
(1), (0 - 1), (1-unbounded)		Inclusive minimum and maximum number of times this rule can appear in the XML message.

Rules Tree Panel Toolbar

The Rules Tree panel offers a number of tools on the toolbar to edit and exercise mappings:

Test Invokes a tool to test the mappings. For more information, see Testing Outbound and Inbound Messages.
Map Automatically maps the selected rules to GUI components and CDF elements. For more information, see Automatically Generating GUI Components and Input Mappings and Mapping Response Data to CDF GUI Components.
Detach Removes mappings, restrictions, or HTTP headers for the selected rules.
Delete Deletes the selected rules or all unselected sibling rules.
Generate Generates the JavaScript code that will be needed to execute the rules file in the running application. See Calling a Data Service.

For more information on toolbar buttons, see Rules Tree Panel Toolbar.

Rule Profile Panel

The Rule Profile panel, which is below the Rules Tree panel, has two buttons:

Original Schema Source Displays the read-only Schema source for the selected rule. This binding can be updated by modifying the Source Path field in the Rule Profile panel. Maintaining this binding is only important at design time, particularly if the rule node may need to be reparsed from source.
Rule Node Profile Displays profile information for the selected rule, such as target namespace, data type, and rule name. Some of these fields are editable. For more information on these fields and how to modify profiles, see Working in the Rule Profile Panel and Rule Profile Panel.

Settings Panel

The Settings panel, to the right of the Rules Tree panel, displays fields pertinent to the type of rule selected in the rules tree. If no rule is selected in the rules tree or if multiple rules are selected, the Settings panel is blank. You can use the Settings panel to define how the rule is processed, such as add restrictions, mappings, JavaScript code, and so on.

For more information about fields in the Settings panel, see Settings Panel. For more information on using the Settings panel, see Working in the Settings Panel.

For additional information and API documentation, hover the mouse over the question mark icon and the APIs icon in the Settings panel.

APIs

CDFCONTEXT (Direction: input, output)*---CDF record node being acted upon
CDFRECORDS (Direction: input, output)* - CDF records collection being iterated
RULENODE (Direction: input, output)* - Current node in the rules tree being processed
MESSAGENODE (Direction: input, output)* - Node in the message being processed
OBJECTTYPE (Direction: input, output)* - Deprecated. Now evaluates to 'Script'
OBJECTNAME (Direction: input, output)* - Deprecated. Will always evaluate to what FILTER once evaluated to--namely the Script being evaluated
FILTER (Direction: input, output)* - Deprecated. Do not use.
setValue(strValue) (Direction: input)* - Equivalent to MESSAGENODE.setValue(strValue)
setCDFContext(strXSLQuery) (Direction: input)* - Valid selection query to update CDFCONTEXT. Must return an object reference to a CDF Record node.
setCDFRecords(strXSLQuery) (Direction: input)* - Updates record collection to be iterated. Must return a valid jsx3.util.Collection instance containing one or more CDF record nodes.
disableNamedRule(strNodeName) (Direction: input)* - Disables the named child rule, so that it does not execute until enableNamedRule is called.
enableNamedRule(strNodeName) (Direction: input)* - Re-enables the named child rule.
disableReferencedRule(objRuleChild) (Direction: input)* - Disables the child rule, so that it does not execute until enableReferencedRule is called.
enableReferencedRule(objRuleChild) (Direction: input)* - Re-enables the child rule.

*Contextual variables listed as inputs are available when creating input messages. Outputs are available when processing output messages.

Mapper Log

The Mapper Log displays information about the outcome of parsing the starting source document(s). Different log levels can be selected by clicking on the Adjust Log Level button in the Mapper Log panel. Possible levels, from most detailed to least detailed, include Trace, Debug, Info, Warn, Error, and Fatal. The default level is Info and the XML Mapping Utility resets to this value when closed.