Altova MapForce 2024 Enterprise Edition

Navigation: The MapForce API > Object Reference > Interfaces

Mapping

Home Prev Top Next

A Mapping object represents a mapping in a document, either the main mapping, or a local user-defined-function mapping.

Properties to navigate the object model:

•Application

•Parent

Mapping properties:

•IsMainMapping

•Name

Components in the mapping:

•Components

Adding items:

•CreateConnection

•InsertFunctionCall

•InsertXMLFile

•InsertXMLSchema

•InsertXMLSchemaInputParameter

•InsertXMLSchemaOutputParameter

Properties

Name	Description
Application	Read-only. Retrieves the application's top-level object.
Components	Read-only. Returns a collection of all components in the current mapping.
IsMainMapping	Read-only. Indicates if the current mapping is the main mapping of the document the mapping is in. True means it is the main mapping. False means it is a user-defined function (UDF).
Name	Read-only. The name of the mapping or user defined-function (UDF).
Parent	Read-only. The parent object according to the object model.

Methods

Name	Description
CreateConnection	Creates a connection between the two supplied datapoints (DatapointFrom & DatapointTo). It will fail to do so if the DatapointFrom is not an output-side datapoint, the DatapointTo is not an input-side datapoint, or a connection between these two datapoints already exists.
InsertFunctionCall	Inserts a function call component into the current mapping. The specified library and function names indicate the function or user-defined function to be called.
InsertXMLFile	Adds a new XML schema component to the mapping. The component's internal structure is determined by the schema referenced in the specified XML file (i_strFileName) or, if the XML file does not reference a schema file, by the separately specified schema file (i_strSchemaFileName). If the XML file has a schema file reference, then the parameter i_strSchemaFileName is ignored. The root element of the XML file will be used in the component. The specified XML file is used as the input sample to evaluate the mapping.
InsertXMLSchema	Adds a new XML schema component to the mapping. The component's internal structure is determined by the schema file specified in the first parameter. The second parameter defines the root element of this schema if there is more than one candidate. If the passed root element is an empty string and more candidates are available, a Select Root Element dialog box will pop up if MapForce is visible. If MapForce is invisible, no dialog box will pop up and only an error is returned. No XML input sample is assigned to this component.
InsertXMLSchemaInputParameter	Inserts an XML schema input parameter component into the current mapping. The current mapping has to be a user-defined function. Trying to insert it (the schema input parameter) into the main mapping will fail.
InsertXMLSchemaOutputParameter	Inserts an XML schema output parameter component into the current mapping. The current mapping has to be a user-defined function. Trying to insert it (the schema output paramter) into the main mapping will fail.