DC 12.3 | XML-DMS Multimode

User Guide > Map Connectors > Source and Target Map Connectors > XML-DMS Multimode

Was this helpful?

XML-DMS Multimode

XML-DMS Multimode is a multimode connector that provides target connections to XML files. The XML-DMS connector provides none of the usual multimode capabilities and supports only insert operation, hence the single-mode version of the connector is recommended for new development.

Note: This connector appeared in DataConnect 11.6 and earlier versions as the XML-DMS connector. When you load an existing Map that was created when XML-DMS referred to a multimode connector, the target will automatically select XML-DMS Multimode connector.

Note: When creating a new map (manually or using the Map Wizard) and the target has no schema, DataConnect attempts to create one using the source schema. This is a straightforward process with a single record source to a single record target. The process differs with a multi-record (or hierarchical) source to multi-record target. In this case, DataConnect locates the first “flat” source record type (a record where none of the fields are themselves a record) and uses it to generate a basic schema for the target. Users can then build out the schema.

Tip... On the Mapping Tab, In the target grid, when there are multiple record types and the filter is selected as “All Fields”, editing is disabled because this can create a mix of records and fields. You need to select a specific record type in the filter box and then you can edit that record type's fields.

The XML-DMS Multimode connector differs from other Multimode connectors as follows:

• If the target file exists, the UI connects using a source XML-DMS connection and then the schema is copied to the target. The schema is built from the data, which may be a subset of the actual schema.

• If the target file does not exist, then a basic schema is created based on the source. The schema can be edited in advance mode, or an external schema can be configured.

Namespace support

Field names include the namespace prefix (if it is provided). When reading, namespace declarations (xmlns attributes) are ignored. When writing, check is not performed. Therefore, the schema may provide namespace declarations as appropriately named or typed fields.

Connector Parts

Connector parts are the fields you configure to connect with a data source or target. The fields that are available depend on the connector you select. Multimode connectors are target only connectors. For a list of all parts for target connectors, see Specifying Target Connector, Parts, and Properties.

Connection Properties

You can specify the following target properties:

Property	Type	Description
FlushFrequency	Number	Number of records buffered in the memory before being written to the target connector. Default value is 0 (all records are written at once). When inserting many records, change the default to a higher value to improve performance.
Batch Response	Filename	Sets the path name for a batch response file. Caution! Do not use this property. It is included only for backward compatibility.
Formatted	Boolean	Determines whether the output should be formatted. • TRUE (default): Each element starts on a new line, with the hierarchy shown by indentation of two spaces per level. • FALSE: Output is written in the XML document body without line breaks or indentation.
Use Empty Tag	Boolean	Determines the syntax for empty elements. • TRUE (default): Empty elements are written as <element/>. • FALSE: Empty elements are written as <element></element>.
Write Empty Fields	Boolean	Determines whether empty fields are written. Empty means they contain an empty string, are null, or are not set. • TRUE (default): Empty fields are written. • FALSE: No elements are written for empty fields.
Write Empty Attributes	Boolean	Determines whether empty attribute fields are written as an attribute. Empty means they contain an empty string, are null, or are not set. • TRUE (default): Empty attribute fields are written. • FALSE: A tag is not written if it contains no data.
Encode all special characters	Boolean	Determines whether to encode all special characters: • TRUE: Encodes all five special characters (plus CR/LF/TAB in attributes), not just those necessary for valid XML. • FALSE (default): Does not encode the five special characters.
HTTP Write Method	-	Determines the write method for an HTTP or HTTPS target. You can choose from POST (default) or PUT. This property is only used when the output file is a URL.
Write Namespaces	Boolean	Enforces writing of namespace attributes or prefixes. Default value is TRUE.
Namespace Map	Text	Allows you to enter the namespace mappings of the form pfx:namespace. Separate multiple values with newlines or spaces.
Default Namespace	Text	(Optional) Sets the default namespace for the xmlns attribute.
Schema Location	Text	(Optional) Sets the xsi:schemaLocation attribute on the root element.
No Namespace Schema Location	Text	(Optional) Sets the xsi:noNamespaceSchemaLocation attribute on the root element.
Generate Prefixes	Boolean	Generates namespace prefixes or redefine the default namespace as needed. Default value is TRUE.
Prefer Type Substitution	Boolean	Enables type substitution or element substitution for polymorphism if both are usable. Default value is TRUE.
Write XML Decl	Boolean	Enables writing of first line of XML encoding declaration. Default value is TRUE.

Supported Operations

XML-DMS Multimode connector supports only Insert operations.

Supported Data Types

The following data types are supported. For each type, there is a corresponding "attribute" type to indicate the field is an attribute rather than an element. An example of this is a Boolean attribute.

• Boolean

• Byte

• Bytes (base64-encoded)

• Char

• Date

• DateTime

• Decimal

• Double

• Float

• Int

• Long

• Short

• String

• Time

Error Conditions, Handling, and Recovery

The following are the most common errors when working with XML as a target.

• Sequencing issue: Records are inserted in an incorrect order.

• Cardinality issue: Multiple instances of a record type are written when only one record type is allowed.

Using a DJMessage Object as a Target

You can use DJMessage objects as target files for the XML-DMS Multimode connector. When you create the dataset, use the DJMessage:///[name of message object] URI scheme in the File/URI field for the dataset. You cannot establish a connection to the data source because the integration platform engine cannot connect directly to the message object.

You can save the dataset with the DJMessage URI reference or specify the DJMessage URL with a macro that points to the DJMessage object file. If you use a macro, you must change the macro value to the DJMessage URL in the run-time configuration. For information about DJMessage Object Types, see DJMessage Object Type.

Using a URL as a Target

You can use HTTP and HTTPS URLs as source and target files for the XML-DMS connector. When writing to a URL, you can set the HTTP Write Method property to POST (default) or PUT.

Last modified date: 10/22/2024