logi.CAD 3 provides a tool for the automated import of logi.CAD 3 projects from a TC6 XML file. This file might have been created by logi.CAD 3 when performing a TC6 export .

Good to know

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 an existing directory that will be used as the workspace
  If the optional parameter -checkEmptyWorkspace is used (see the description of this parameter below), the directory must be empty.
- The path to the file that 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.exportimport.plcopen.tc6.importer.lc3.application [-noSplash] [-projectPath <PROJECTPATH>] -data <WORKSPACE> -xmlFilePath <XMLFILEPATH> [-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 that should be imported If the target folder does not exist, it is automatically created. Without this parameter, the project is automatically created in the workspace (see the following description for `<WORKSPACE>`).	`C:\LC3Projects\MyProject`
`<WORKSPACE>`	absolute path to a workspace to which the project should be imported Please note: The directory of the workspace must not be located within a directory that is a logi.CAD 3 project. The directory might have to be empty – depending on the optional parameter `-checkEmptyWorkspace` (see the description of this parameter below). After the invocation, the workspace will contain a reference to the logi.CAD 3 project. That means that the logi.CAD 3 project is not copied into the workspace. This is the same behavior as within the graphical user interface of logi.CAD 3 when you would use the command Import... and the import type Existing Projects into Workspace with the disabled option Copy projects into workspace.	`C:\temp\LC3Workspace`
`<LOG-CONFIGURATION>`	path to the log configuration file All messages of the tool will be output to the device as specified in 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 .

Example for invocation, incl. check of the empty workspace

logiCAD3c --launcher.ini logiCAD3.ini -application com.logicals.exportimport.plcopen.tc6.importer.lc3.application -noSplash -projectPath C:\LC3Projects\MyProject -data C:\temp\LC3Workspace -xmlFilePath C:\lc3\Counter.xml -checkEmptyWorkspace -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.

Sample log configuration file

<?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)`
`-1`	`Import failed (Parameter Error, -1): Name`	An argument or parameter is missing.	Invoke the tool as specified above.
`-6`	`Import failed (-6): Workspace not empty`	The workspace already contains data (e.g. one or more logi.CAD 3 projects).	If you have specified the parameter `-checkEmptyWorkspace`: Use an empty workspace or remove all existing data from the current one. Alternative: Invoke the tool without the parameter `-checkEmptyWorkspace`.
`-8`	`Import failed (-6): xml file not found`	The specified XML-file does not exist.	Specify an existing XML-file.
`-127`	`(Details: exception message)`	An unexpected error has occurred.	Contact logi.cals.