Altova MapForce 2022 Professional Edition

Example: Using File Names as Mapping Parameters

Home Prev Top Next

This example walks you through the steps required to execute a mapping that takes input parameters at runtime. The mapping design file used in this example is available at the following path: <Documents>\Altova\MapForce2022\MapForceExamples\FileNamesAsParameters.mfd.

 

This mapping reads data from a source XML file and writes it to a target XML file. The data is written to the target file almost unchanged; only the attributes PrimaryKey and Name are populated with some constant values from the mapping. The main goal of the mapping is to enable the caller to specify the name of the input file and the name of the output file, as mapping parameters, at mapping runtime.

 

To achieve this, the mapping has two input components: InputFileName and OutputFileName. These supply the input file name (and the output file name, respectively) of the source and target XML file. For this reason, they are connected to the File: <dynamic> item. You can switch a component to this mode by clicking the File/String ( btn_file_string ) button, and selecting Use Dynamic File Names Supplied by Mapping.

mf_simple_input_03

FileNamesAsParameters.mfd (MapForce Enterprise Edition)

If you double-click the title bar of either of the InputFileName and OutputFileName components, you can view or edit their properties. For example, you can specify the data type of the input parameter or change the input parameter name, as described in Simple Input Component Settings. In this example, the input and output parameters are configured as follows:

 

The InputFileName parameter is of type "string" and it has a default value supplied by a constant defined in the same mapping. The constant is of type "string" and its value is "Altova_Hierarchical.xml". Therefore, when this mapping runs, it will attempt to read data from a file called "Altova_Hierarchical.xml", assuming that you do not supply some other value as parameter.

The OutputFileName parameter is of type "string" and it also has a default value supplied by a constant defined in the same mapping. The constant is of type "string" and its value is "Altova_Hierarchical_output.xml". Therefore, the mapping will create an XML output file called "Altova_Hierarchical_output.xml" when it runs, assuming that you do not supply some other value as parameter.

 

The following sections illustrate how to run the mapping and supply parameters in the following transformation languages:

 

XSLT 2.0, using RaptorXML Server

Built-in (MapForce Server Execution File), using MapForce Server

Java

C#

C++

 

XSLT 2.0

If you generate code in XSLT 1.0, XSLT 2.0, or XSLT 3.0, a DoTransform.bat batch file is generated in the chosen target directory, in addition to the XSLT file. The DoTransform.bat lets you execute the mapping with RaptorXML Server, see Automation with RaptorXML Server.

 

To use a different input (or output) file, edit the DoTransform.bat file to include the required parameters, as follows:

 

1.First, generate the XSLT code. For example, to generate XSLT 2.0, select the menu command File | Generate Code In | XSLT 2.0.

2.Copy the Altova_Hierarchical.xml file from <Documents>\Altova\MapForce2022\MapForceExamples\ to the directory where you generated the XSLT 2.0 code (in this example, c:\codegen\examples\xslt2 ). As stated previously, the mapping will attempt to read this file if you do not supply a custom value to the InputFileName parameter.

3.Edit DoTransform.bat to include the custom input parameter either before or after %*. Note that the parameter value is enclosed with single quotes. The available input parameters are listed in the rem (Remark) section. Let's suppose that you would like to generate an output file called output.xml. To achieve this, change the DoTransform.bat file as follows:

@echo off

 

RaptorXML xslt --xslt-version=2
 --input="MappingMapToAltova_Hierarchical.xslt"
 --param=OutputFileName:'output.xml' %* "MappingMapToAltova_Hierarchical.xslt"

rem --param=InputFileName:

rem --param=OutputFileName:

IF ERRORLEVEL 1 EXIT/B %ERRORLEVEL%

When you run the DoTransform.bat file, RaptorXML Server completes the transformation using Altova_Hierarchical.xml as input. If you followed the steps above, the name of the generated output file will be output.xml.

mf_simple_input_04

 

MapForce Server Execution File

To supply custom input parameters to a MapForce Server execution file:

 

1.If you haven't done that already, open the FileNamesAsParameters.mfd example from the <Documents>\Altova\MapForce2022\MapForceExamples\ directory.

2.On the File menu, click Compile to MapForce Server Execution File, see also Compiling Mappings to MapForce Server Execution Files. When prompted, save the .mfx execution file to a directory on your computer (in this example, c:\codegen\examples\mfx ).

3.Copy the Altova_Hierarchical.xml file from the <Documents>\Altova\MapForce2022\MapForceExamples\ directory to the directory where you saved the .mfx file.

4.Run MapForce Server with the following command:

MapForceServer.exe run "C:\codegen\examples\mfx\FileNamesAsParameters.mfx"
 -p=InputFileName:"C:\codegen\examples\mfx\Altova_Hierarchical.xml"
 -p=OutputFileName:"C:\codegen\examples\mfx\OutputFile.xml"

In the MapForce Server command above, -p=InputFileName and -p=OutputFileName are the input parameters to the mapping. You can use any file name as the value of -OutputFileName. However, the file name supplied in -InputFileName parameter must exist as a physical file; otherwise, the mapping will fail.

 

Note:If you see the message "MapForceServer.exe is not recognized as an internal or external command, operable program, or batch file", change the current directory to the one where the MapForce Server executable is installed. To avoid changing the path every time when you run a mapping, add to your operating system's PATH environment variable the path of the directory where the MapForce Server executable is installed (for example, C:\Program Files (x86)\Altova\MapForceServer2022\bin).

 

With MapForce Server, running a mapping is also possible by calling the MapForce Server API (which is invokable from languages such as C++, C#, or Java). For further information about this scenario, refer to the MapForce Server documentation (https://www.altova.com/documentation).

 

Java

To supply a custom input parameter to a Java .jar application:

 

1.If you haven't done that already, open the FileNamesAsParameters.mfd example from the <Documents>\Altova\MapForce2022\MapForceExamples\ directory.

2.On the File menu, click Generate Code In | Java.

3.Compile the Java code into an executable JAR file. For an example of how to do this in Eclipse, see Example: Generate and Run Java Code.

4.Copy the Altova_Hierarchical.xml file from <Documents>\Altova\MapForce2022\MapForceExamples\ to the directory where the .jar file is. As stated previously, the mapping will attempt to read this file if you do not supply a custom value to the InputFileName parameter.

5.Run the Java application with the following command:

 

java -jar Mapping.jar /OutputFileName "output.xml"

 

In the command above, the input parameter /OutputFileName supplies the name of the output file to be generated.

 

Note:If you use wildcards when passing parameters to .jar files, enclose the wildcard parameters within quotes, for example:

 

java -jar Mapping.jar /InputFileName "altova-*.xml"

 

C#

To supply a custom input parameter to a C# command line application generated by MapForce:

 

1.If you haven't done that already, open the FileNamesAsParameters.mfd example from the <Documents>\Altova\MapForce2022\MapForceExamples\ directory.

2.On the File menu, click Generate Code In | C#, and select a target directory (C:\codegen\examples\cs, in this example).

3.Open the solution in Visual Studio and build it (Ctrl + Shift + B).

4.Copy the Altova_Hierarchical.xml file from <Documents>\Altova\MapForce2022\MapForceExamples\ to the directory where Mapping.exe was generated (in this example, C:\codegen\examples\cs\Mapping\bin\Debug). As stated previously, the mapping will attempt to read this file if you do not supply a custom value to the InputFileName parameter.

5.Open a Command Prompt window and change to the directory where Mapping.exe is.

 

cd C:\codegen\examples\cs\Mapping\bin\Debug

 

6.Run the application with the following command:

 

Mapping.exe /OutputFileName output.xml

 

In the command above, the input parameter /OutputFileName supplies the name of the output file to be generated.

 

C++

To supply a custom input parameter to a C++ command line application generated by MapForce:

 

1.If you haven't done that already, open the FileNamesAsParameters.mfd example from the <Documents>\Altova\MapForce2022\MapForceExamples\ directory.

2.On the File menu, click Generate Code In | C++, and select a target directory (C:\codegen\examples\cpp, in this example).

3.Open the solution in Visual Studio and build it (Ctrl + Shift + B).

4.Copy the Altova_Hierarchical.xml file from <Documents>\Altova\MapForce2022\MapForceExamples\ to the directory where Mapping.exe was generated (in this example, C:\codegen\examples\cpp\Mapping\Debug). As stated previously, the mapping will attempt to read this file if you do not supply a custom value to the InputFileName parameter.

5.Open a Command Prompt window and change to the directory where Mapping.exe is.

 

cd C:\codegen\examples\cpp\Mapping\Debug

 

6.Run the application with the following command:

 

Mapping.exe /OutputFileName output.xml

 

In the command above, the input parameter /OutputFileName supplies the name of the output file to be generated.

© 2016-2022 Altova GmbH