Automated importing of objects from XML
logi.CAD 3 provides a tool for the automated import of ST/FBD objects based on an XML-file (= text file in XML-format) into a project. Best practice is to have this XML-file created by using the tool for the automated export.
The tool is intended for usage by an experienced user of logi.CAD 3.
A condition for the successful usage of the tool is the knowledge of the action to be executed as it would be executed in the graphical user interface of logi.CAD 3.
The output of the tool is in English only.
Preparation
Make sure that logi.CAD 3 is installed. Have the following information prepared:
The path to the logi.CAD 3 installation directory
The path to a directory that will be used as the workspace
In case the directory does not exist, the tool creates it. If the optional parameter -checkEmptyWorkspace is used (see the description of this parameter below), the directory must be empty.The path to the project into which the objects should be imported
The path to the log configuration file (see below for more information)
A sample configuration file is included in the installation of logi.CAD 3.
Open a command line: e.g. cmd.exe under Windows and navigate to the logi.CAD 3 installation directory.
Invocation
Parameters that are placed within [] are optional. That means, if you skip the parameter, the default behavior is applied (see below under "Description of parameters"). When you want to use the parameter, do not enter the character [ and ] (see the below examples).
logiCAD3c --launcher.ini logiCAD3.ini -application com.logicals.lc32.importer.application [-noSplash] -projectPath <PROJECTPATH> [-inputFolder <INPUT_FOLDER> -inputFile <INPUT_FILE> -importFolder <FOLDER_TO_IMPORT_INTO>]|[-workpackagePath <WORKPACKAGE_PATH>] [-checkEmptyWorkspace] -vmargs -Dlog4j.configuration=file:<LOG-CONFIGURATION>
Invoking the tool under Linux is not officially supported. However, if you want to try invoking the tool under Linux nevertheless, replace the part logiCAD3c --launcher.ini logiCAD3.ini -application of the above-mentioned invocation by logiCAD3 -application. The remaining part of the invocation is identical to the above-mentioned invocation.
Description of parameters:
Parameter |
Description |
Example |
<PROJECTPATH> |
absolute path to the project |
C:\LC3Projects\MyProject |
<INPUT_FOLDER> |
the following data for the XML-file:
Always use these 3 parameters together. Or use the following parameter -workpackagePath <WORKPACKAGE_PATH> as alternative. If you do not specify these 3 parameters or -workpackagePath <WORKPACKAGE_PATH>, nothing will be imported. |
C:\lc3 |
<WORKPACKAGE_PATH> |
absolute path to a CSV-file
Example for the content of a CSV-file: Objects (as specified in 2 XML-files) are imported into the project folder
C:\lc3,program.xml,src C:\lc3,EnumType.xml,src |
c:\LC3\workpackage.csv |
<LOG-CONFIGURATION> |
path to the log configuration file |
C:\LC3LogConfig\log4j.xml |
The parameter -noSplash is optional. If it is not specified, the splashscreen of logi.CAD 3 is displayed after the invocation.
The parameter -checkEmptyWorkspace is also optional. Specify this parameter to check whether the specified workspace is empty. The logi.CAD 3 project will only be imported, if the workspace is empty.
The default invocation (when this parameter is not specified) is that the logi.CAD 3 project is always imported into the workspace – regardless whether the workspace is empty or not. If the logi.CAD 3 project already exists within the workspace, the logi.CAD 3 project is imported anew.The parameter -Dlog4j.configuration is also optional . However, logi.cals recommends to specify this parameter so that log events are output .
logiCAD3c --launcher.ini logiCAD3.ini -application com.logicals.lc32.importer.application -noSplash -projectPath C:\LC3Projects\MyProject -inputFolder C:\lc3 -inputFile program.xml -importFolder src -vmargs -Dlog4j.configuration=file:C:\LC3LogConfig\log4j.xml
logiCAD3c --launcher.ini logiCAD3.ini -application com.logicals.lc32.importer.application -noSplash -projectPath C:\LC3Projects\MyProject -workpackagePath c:\LC3\workpackage.csv -vmargs -Dlog4j.configuration=file:C:\LC3LogConfig\log4j.xml
Log configuration file
This file is needed to configure the log4j logging mechanism. The file specifies how log events are output.
<?
xml
version
=
"1.0"
encoding
=
"UTF-8"
?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
<
log4j
:configuration
debug
=
"false"
xmlns:log4j
=
'http://jakarta.apache.org/log4j/'
>
<!-- This configuration logs to console. -->
<
appender
name
=
"console"
class
=
"org.apache.log4j.ConsoleAppender"
>
<
param
name
=
"target"
value
=
"System.out"
/>
<
param
name
=
"immediateFlush"
value
=
"true"
/>
<
param
name
=
"encoding"
value
=
"UTF-8"
/>
<
param
name
=
"threshold"
value
=
"info"
/>
<
layout
class
=
"org.apache.log4j.PatternLayout"
>
<
param
name
=
"ConversionPattern"
value
=
"%d{yyyy-MM-dd HH:mm:ss} %-5p: %m%n"
/>
</
layout
>
</
appender
>
<!-- This configuration logs to a file, with more information than for the console. -->
<
appender
name
=
"file"
class
=
"org.apache.log4j.DailyRollingFileAppender"
>
<
param
name
=
"file"
value
=
"C:\\temp\\logfile.log"
/>
<
layout
class
=
"org.apache.log4j.PatternLayout"
>
<
param
name
=
"ConversionPattern"
value
=
"%d{HH:mm:ss} %-5p [THREAD ID=%t] [Method:%M] %c{1}:%L - %m%n"
/>
</
layout
>
</
appender
>
<
root
>
<
level
value
=
"INFO"
/>
<
appender
-ref
ref
=
"console"
/>
<
appender
-ref
ref
=
"file"
/>
</
root
>
</
log4j
:configuration>
Troubleshooting
The file that is specified in the log configuration file contains information about the import. If the import has not been successful, fix the problem according to the following table.
Return code |
Message on STDOUT or STDERR |
Cause |
Solution |
0 |
Import successful (0) |
|
|
13 |
<no message> |
wrong value specified for -application |
Invoke the tool as specified above. |
-1 |
Import failed (Parameter Error, -1): Name |
An argument or parameter is missing. |
Invoke the tool as specified above. |
-2 |
Import failed (-2): Project not found |
The specified project does not exist. |
Specify an existing project. Or invoke the tool with the absolute path for the project. |
-6 |
Import failed (-6): Workspace not empty |
The workspace already contains data (e.g. one or more logi.CAD 3 projects). |
Use an empty workspace or remove all existing data from the current one. |
-7 |
Import failed (-7): The object "name" does not exist in the project "name". |
You have specified a folder that does not exist in the project . |
Enter an existing folder. |
-127 |
Import failed. Details: exception message |
An unexpected error has occurred. |
Contact logi.cals. |