XML Component Settings

www.altova.com Print this Topic Previous Page Up One Level Next page

Home >  Data Sources and Targets > XML and XML schema >

XML Component Settings

After you add an XML component to the mapping area, you can configure the settings applicable to it from the Component Settings dialog box. You can open the Component settings dialog box in one of the following ways:

 

Select the component on the mapping, and, on the Component menu, click Properties.
Double-click the component header.
Right-click the component header, and then click Properties.

xml_component_settings_dialog_box

XML Component Settings dialog box

The available settings are as follows.

 

Component name

The component name is automatically generated when you create the component. However, you can change the name at any time.

 

The component name can contain spaces and full stop characters. It may not contain slashes, backslashes, colons, double quotes, leading or trailing spaces. If you want to change the name of the component, be aware of the following:

 

If you intend to deploy the mapping to FlowForce Server, the component name must be unique.
It is recommended to use only characters that can be entered at the command line. National characters may have a different encoding in Windows and at the command line.

Schema file

Specifies the name or path of the XML schema file used by MapForce to validate and map data.

 

To change the schema file, click Browse and select the new file. To edit the file in XMLSpy, click Edit.

Input XML file

Specifies the XML instance file from which MapForce will read data. This field is meaningful for a source component and is filled when you first create the component and assign to it an XML instance file.

 

In a source component, the instance file name is also used to detect the XML root element and the referenced schema, and to validate against the selected schema.

 

To change the location of the file, click Browse and select the new file. To edit the file in XMLSpy, click Edit.

Output XML file

Specifies the XML instance file to which MapForce will write data. This field is meaningful for a target component.

 

To change the location of the file, click Browse and select the new file. To edit the file in XMLSpy, click Edit.

Prefix for target namespace

Allows you to enter a prefix for the target namespace. Ensure that the target namespace is defined in the target schema, before assigning the prefix.

Add schema/DTD reference

Adds the path of the referenced XML Schema file to the root element of the XML output. The path of the schema entered in this field is written into the generated target instance files in the xsi:schemaLocation attribute, or into the DOCTYPE declaration if a DTD is used.

 

Note that, if you generate code in XQuery or C++, adding the DTD reference is not supported.

 

Entering a path in this field allows you to define where the schema file referenced by the XML instance file is to be located. This ensures that the output instance can be validated at the mapping destination when the mapping is executed. You can enter an http:// address as well as an absolute or relative path in this field.

 

Deactivating this option allows you to decouple the XML instance from the referenced XML Schema or DTD (for example, if you want to send the resulting XML output to someone who does not have access to the underlying XML Schema).

Write XML declaration

This option enables you to suppress the XML declaration from the generated output. By default, the option is enabled, meaning that the XML declaration is written to the output.

 

This feature is supported as follows in MapForce target languages and execution engines.

 

Target language / Execution engine

When output is a file

When output is a string

Built-in

Yes

Yes

MapForce Server

Yes

Yes

XSLT, XQuery

Yes

No

Code generator (C++, C#, Java)

Yes

Yes

 

Cast values to target types

Allows you to define if the target XML schema types should be used when mapping, or if all data mapped to the target component should be treated as string values. By default, this setting is enabled.

 

Deactivating this option allows you to retain the precise formatting of values. For example, this is useful to satisfy a pattern facet in a schema that requires a specific number of decimal digits in a numeric value.

 

You can use mapping functions to format the number as a string in the required format, and then map this string to the target.

 

Note that disabling this option will also disable the detection of invalid values, e.g. writing letters into numeric fields.

Pretty print output

Reformats the output XML document to give it a structured look. Each child node is offset from its parent by a single tab character.

Create digital signature

Allows you to add a digital signature to the XML output instance file. Adding a digital signature is possible when you select "Built-in" as transformation language (see also Digital Signatures).

Output Encoding

Allows you specify the following settings of the output instance file:

 

Encoding name
Byte order
Whether the byte order mark (BOM) character should be included.

 

By default, any new components have the encoding defined in the Default encoding for new components option. You can access this option from Tools | Options, General tab.

 

If the mapping generates XSLT 1.0/2.0, activating the Byte Order Mark check box does not have any effect, as these languages do not support Byte Order Marks.

StyleVision Power Stylesheet file

This option allows you to select or create an Altova StyleVision stylesheet file. Such files enable you to output data from the XML instance file to a variety of formats suitable for reporting, such as HTML, RTF, and others.

 

See also Using Relative Paths on a Component.

Enable input processing optimizations based on min/maxOccurs

This option allows special handling for sequences that are known to contain exactly one item, such as required attributes or child elements with minOccurs and maxOccurs="1". In this case, the first item of the sequence is extracted, then the item is directly processed as an atomic value (and not as a sequence).

 

If the input data is not valid against the schema, an empty sequence might be encountered in a mapping, which stops the mapping with an error message. To allow the processing of such invalid input, disable this check box.

Save all file paths relative to MFD file

When this option is enabled, MapForce saves the file paths displayed on the Component Settings dialog box relative to the location of the MapForce Design (.mfd) file. See also Using Relative Paths on a Component.


© 2019 Altova GmbH