Eplan Curs

Application Example
EPLAN Command Line Parameters

Copyright  2007 by EPLAN Software & Service GmbH & Co. KG.
EPLAN Software & Service GmbH & Co. KG assumes no liability either for technical or printing errors or for defi-
ciencies in this technical information and cannot be held liable for damages that may result directly or indirectly
from delivery, performance, and use of this material.
This document contains information on the basis of a proprietary system that is protected by copyright laws. All
rights are protected. This document or part of this document may not be copied or reproduced by any other
means without the previous permission of EPLAN Software & Service GmbH & Co. KG.
The software described in this document is subject to a license agreement. Its use and reproduction are only
permitted within the framework of this agreement.
®
EPLAN is a registered trademark of EPLAN Software & Service GmbH & Co. KG.
® ® ® ® ®
MS-DOS / Windows NT / Windows 2000 / Windows XP / Microsoft Windows are registered trademarks of
Microsoft Corporation.
® ® ® ®
Microsoft Excel and Microsoft Access are registered trademarks of Microsoft Corporation.
®
RITTAL is a registered trademark of Rittal Werk Rudolf Loh GmbH & Co. KG.
®
Clip Project is a registered trademark of Phoenix Contact GmbH & Co.
®
INTERBUS is a registered trademark of Phoenix Contact GmbH & Co.
® ® ®
ÖLFLEX , ÖLFLEX-SERVO and ÖLFLEX CLASSIC are registered trademarks of U.I. LAPP GmbH.
®
AutoCAD and Volo™View Express are registered trademarks of Autodesk, Inc.
®
MS-DOS is a registered trademark of Microsoft Corporation.
®
SCAN is a registered trademark of McAfee Associates.
®
PKZIP/PKUNZIP are registered trademarks of PKWARE, Inc.
®
ObjectStore is a registered trademark of eXelon Corporation.
®
D-ISAM is a registered trademark of Informix Software, Inc.
®
Hardlock E-Y-E is a registered trademark of Aladdin Knowledge Systems, Ltd Int.
®
InstallShield is a registered trademark of InstallShield, Inc.
®
PMS is a registered trademark of PMS Compelec GmbH.
®
MicroStation is a registered trademark of Bentley Systems.
All other mentioned product names, trademarks and company names are trademarks or registered trademarks of
their respective owners.
Remark: The hardware requirements indicated by the operating system manufacturers must be consid-
ered. Hardware combinations that according to manufacturer’s specification cause malfunctions may
also have an effect on the operation of EPLAN. Therefore an accurate basic installation of hardware, op-
erating system and hardware drivers (e. g. graphics board driver etc.) is essential for a smooth operation
of EPLAN. Prerequisite. The main conditions and areas of application specified by the hardware manufac-
turers therefore also apply to the operation of EPLAN.
2 / 50
Table of Contents
EPLAN Command Line Parameters ................................................. 5
Command syntax ....................................................................................... 5
General command line parameters............................................................ 5
Automatic Actions for Command Line Operation........................... 7
Overview of the General EPLAN Command Line Parameters........ 9
Automatic Action: backup .............................................................. 10
Automatic Action: check ................................................................ 14
Automatic Action: compress.......................................................... 16
Automatic Action: devicelist .......................................................... 17
Automatic Action: edit .................................................................... 18
Automatic Action: EplApiModuleAction........................................ 20
Automatic Action: ExecuteScript................................................... 20
Automatic Action: export................................................................ 21
Automatic Action: generate............................................................ 27
Automatic Action: import ............................................................... 29
Automatic Action: label .................................................................. 35
Automatic Action: MfImportToolbarAction ................................... 37
Automatic Action: OpenWorkspaceAction ................................... 38
Automatic Action: partslist............................................................. 38
Automatic Action: print................................................................... 40
Automatic Action: ProjectAction ................................................... 42
Automatic Action: projectmanagement......................................... 42
Automatic Action: ProjectOpen ..................................................... 43
Automatic Action: reports .............................................................. 43
Automatic Action: Restore ............................................................. 44
Automatic Action: SaveWorkspaceAction .................................... 45
3 / 50
Automatic Action: search ............................................................... 45
Automatic Action: selectionset ...................................................... 47
Automatic Action: translate............................................................ 48
Automatic Action: XSDPreviewAction........................................... 50
4 / 50
EPLAN Command Line Parameters
Like many other programs, EPLAN can also be started using a non-
graphical user interface. We provide you with appropriate command-line
parameters which you can then use from the Windows input prompt,
from a different console, or with the Windows Execute command (Start
> Execute).
The actual call of EPLAN is performed by specifying the executable file

W3u.EXE. When specifying this command, you need to consider the path
where the EXE file was stored during installation.
Command syntax
W3u.EXE action /parameter1:value1 /parameter2:value2
/parameter3:value3
Command, action, and parameter are separated by spaces on the com-

mand line. For each command-line call, you may only specify one action
to be carried out. All parameters which follow the action name in the
command line and start with "/" or "-" are given to the action as parame-
ters.
EPLAN provides you with several automatic actions which you can use
to execute complete tasks from the command line without needing to see
a dialog.
General command line parameters

In addition to the parameters of an action, you can also specify multiple
general command line parameters on each command line. Without these
general parameters, like /Auto, you cannot quit EPLAN automatically or
start it invisibly. The general parameters must be given before the action
name.
W3u.EXE /GenParameter Action /Parameter1:Value1
5 / 50
Example:
Using an automatic action named print, you can print the pages of a
project or the entire project. Possible parameters of this action are, e.g.:
• /TYPE:PAGES (= type of print command, here: print pages)

• /PROJECTNAME (= project name with full path)
• /PAGENAME (= the page to be printed).
The following input in the Windows Execute command prints the page
=EB3+ET1/1 from project EPLAN-DEMO:
"<Drive>:\Programs\EPLAN\<Variants>\<Version>\BIN\W3u.exe"
/NoSplash /Frame:0 /Auto print /TYPE:PAGES /PROJECTNAME:
"<Drive>:\Programs\EPLAN\<Variants>\Projects\EPLAN\
EPLAN-DEMO.elk" /PAGENAME:=EB3+ET1/1
Due to the inclusion of the general command line parameters

/NoSplash, /Frame:0, and /Auto, EPLAN is started invisibly, and is
stopped again after the print command has been executed.
If an error occurs during the execution of a command line, it is logged in

the System Messages.
6 / 50
Automatic Actions for Command Line
Operation
When calling EPLAN from the command line, you have the option of us-
ing some automatic actions. Using these standard actions, you can exe-
cute complete program functions without needing to interact as a user.
The following automatic actions are available in EPLAN:
Action name Description
backup Backs a project or master data up.
check Checks pages or the entire project.
compress Compresses a project.
devicelist Imports, exports, or deletes a device list.
edit Opens a page or a project.
EplApiModuleAction Loads and registers an API module.
ExecuteScript Runs a specified script.
export Exports pages or projects in different formats.
generate Generates connections or cables.
import Imports projects, macros, or drawings.
label Generates the labeling for a project.
MfImportToolbarAction Imports a toolbar from a file.
7 / 50
Action name Description
OpenWorkspaceAction Opens an existing workspace.
partslist Imports or exports a parts list.
print Prints a page or the whole project.
ProjectAction
Runs an action for a specified project and clo-
ses the project after this.
projectmanagement
Loads a file with project information into the
project management.
ProjectOpen Opens a specified project.
reports Generates project reports.
restore
Restores a project or master data from back-
up.
SaveWorkspaceAction
Saves the current user interface settings as
workspace.
search
Searches for objects (devices, properties,
texts, etc.) in a project.
selectionset
Retrieves values (name, path, file extension)
from selected pages or a selected project.
Translates a project, deletes the translation
translate from the project, or exports a missing word
list.
XSDPreviewAction
Opens or closes a page or macro preview
window.
If the parameter for the project name (/PROJECTNAME) is not given for an
automatic action, the last project opened will be used.
8 / 50
Overview of the General EPLAN Command Line
Parameters
The following general command line parameters are evaluated by
EPLAN:
Parameter Description
/NoLoadWorkspace No workspace is loaded or recreated.
/NoSplash
No splash screen is displayed when the system
starts up.
Opens EPLAN with the specified dialog language
(e.g., /Language:en_US in English). The dialog
language specified in the settings dialog remains
/Language:<Value> unchanged.
EPLAN can only be opened in the specified lan-
guage if this language has also been installed and
licensed on your system.
/Auto Quits EPLAN after the command line is executed.
/Quiet
No dialogs are displayed while a command is being
executed.
Determines the main window of EPLAN.
• /Frame:0 => The EPLAN main window will
not be displayed.
/Frame:<Value> • /Frame:1 => The EPLAN main window will
be displayed in the original size and position.
be minimized.
be maximized.
9 / 50
/Setup
All settings are set to the default values of the in-
stallation.
Automatic Action: backup

Parameters Description
Type of task to be performed:

TYPE PROJECT: Backing up the entire project
MASTERDATA: Backing up the master data
Project name with full path (optional).

If not entered, the selected project is used when
the action is called from GUI (like from a script or
PROJECTNAME button bar). If called from the windows command
line, PROJECTNAME must be set or the Projec-
tAction must be used first, otherwise an Sys-
tem.ArgumentException exception is thrown.
Archive name.
ARCHIVENAME Name of the file where the backed up data is to be
saved (without path information).
DESTINATIONPATH Target directory
Remark on backup (optional).

COMMENT
The remark is written as a string to the corre-
sponding property of the backed up project.
Default = corresponding property is not set.
10 / 50
Type of saving:
BACKUPMEDIA
EMAIL: Project is sent by e-mail.
DISK: Project is backed up to a hard drive, disk-
ette, etc.
If the project to be backed up is to be packed (zip-

ped), the target file can be automatically split into
several parts to be sent by e-mail. SplitSize speci-
SPLITSIZE fies the maximum file size in megabytes. If
SPLITSIZE = 0, the file is not split up. If the pa-
rameter: BACKUPMEDIA = DISK, SPLITSIZE is
ignored. The parameter is optional (default = 0.0).
An enum constant that may assume the following

values:
BAKAMOUNT_ALL : The contents of the project
BACKUPAMOUNT
directory is backed up completely.
BAKAMOUNT_MIN : Only the database files re-
quired to restore the project are backed up; redun-
dant database files are ignored.
Default = BAKAMOUNT_ALL.
Specifies whether the database is to be com-

COMPRESSPRJ
pressed before being backed up (optional, 0 = No,
1= Yes).
Default = 0
Specifies whether external documents are to be

INCLEXTDOCS included in the backup (optional, 0 = No, 1= Yes).
Default = 0
11 / 50
Specifies whether image files are to be included in

INCLIMAGES the backup (optional, 0 = No, 1= Yes).
Default = 0
Type of backup:
BACKUP: Project is backed up
SOURCEOUT: Project is filed off
BACKUPMETHOD ARCHIVE: Project is archived. Must not be set
when "BACKUPMEDIA" parameter is "EMAIL".
SOURCEOUT_PACK: Project is packed first (zip-
ped) and then filed off
Type of master data to be backed up:

SYMBOLS,
FUNCTIONS,
MACROS,
FORMS,
MDTYPE PROJECTTEMPLATES,
ARTICLES,
RIGHTS,
LANGUAGES,
STANDARDSHEET,
STATIONDATA
SOURCEPATH
Source directory, only applies to backup of master
data.
12 / 50
Name of the file to be backed up.

- The file name can be entered with or without the
complete path.
FILENAME
- The file extension must be specified.
- A file extension with a wildcard is also possible
(for example: /FILENAME:*.fn1, /FILENAME:*.*,
/FILENAME:*sh)
This only applies to the backup of master data.
Example:
Back up project:
backup /TYPE:PROJECT
/PROJECTNAME:C:\Projects\EPLAN\DEMO2_D.elk
/DESTINATIONPATH:U:\temp /ARCHIVENAME:my_prj.zw2
/COMMENT:Hello /BACKUPMETHOD:BACKUP /BACKUPMEDIA:DISK
/SPLITSIZE:0.0 /BACKUPAMOUNT:BACKUPAMOUNT_ALL
/COMPRESSPRJ:0 /INCLEXTDOCS:1 /INCLIMAGES:1
backup /TYPE:PROJECT /COMMENT:Hello

/BACKUPMETHOD:BACKUP /BACKUPMEDIA:DISK /SPLITSIZE:0.0
/BACKUPAMOUNT:BACKUPAMOUNT_ALL /COMPRESSPRJ:0
/INCLEXTDOCS:1 /INCLIMAGES:1
Back up master data:

Back up plot frame with full path:
backup /TYPE:PROJECT
/PROJECTNAME:C:\PlotFrames\EPLAN\DEMO2_D.elk
/COMMENT:Hello /BACKUPMETHOD:BACKUP /BACKUPMEDIA:DISK
/SPLITSIZE:0.0 /BACKUPAMOUNT:BACKUPAMOUNT_ALL
/COMPRESSPRJ:0 /INCLEXTDOCS:1 /INCLIMAGES:1
13 / 50
Back up plot frame without full path:
backup /TYPE:MASTERDATA /FILENAME:ESS_A3DP.fn1
/SOURCEPATH:C:\PlotFrames\EPLAN /DESTINATIONPATH:U:\temp
/ARCHIVENAME:my_MasterData /COMMENT:"Hello world"
/BACKUPMEDIA:DISK /SPLITSIZE:0.0 /MDTYPE:STANDARDSHEET
Back up all plot frames (*.fn1):

backup /TYPE:MASTERDATA /FILENAME:*.fn1
Back up all files (*.*) in specified source directory:

backup /TYPE:MASTERDATA /FILENAME:*.*
Back up all files (*.*) in specified source directory whose file exten-
sions include 'sh':
backup /TYPE:MASTERDATA /FILENAME:*sh
Automatic Action: check

Type of task to be performed by the action.

TYPE
Possible values are:
PROJECT: project
PAGE: Check page
14 / 50

If not entered, the selected project is used
when the action is called from GUI (like from a
PROJECTNAME
script or button bar). If called from the win-
dows command line, PROJECTNAME must
be set or the ProjectAction must be used first,
otherwise an System.ArgumentException ex-
ception is thrown.
Name of scheme used for the project check

VERIFICATIONSCHEME (optional, scheme name only, without path).
Default value: Most recently used scheme.
Determines if only filtered pages should be

USEPAGEFILTER
used (optional).Corresponds to "Active"
checkbox in GUI
Default value: 1
PAGENAME Name of the page to be checked (optional).
Example:
Check project with scheme: Offline
check /TYPE:PROJECT
/VERIFICATIONSCHEME:Offline
Check most recently used project with most recently used scheme
check /TYPE:PROJECT
Check page
check /TYPE:PAGES
/PAGENAME:=AP+ST1/6
15 / 50
Check pages of the recently used project (scheme page_scheme
must be available)
check /TYPE:PAGES /USEPAGEFILTER:1
Automatic Action: compress


If not entered, the selected project is used when the
action is called from GUI (like from a script or button
PROJECTNAME bar). If called from the windows command line,
PROJECTNAME must be set or the ProjectAction
must be used first, otherwise an System.Argument
Exception exception is thrown.
Configuration scheme for project compression (op-

tional).
CONFIGSCHEME Default value: Recent configuration scheme. The
most recently used scheme is taken if an empty
string is passed.
Filter scheme for project compression (optional).

FILTERSCHEME
Default value: Most recently used filter scheme. The
most recently used scheme is taken if an empty
string is passed.
16 / 50
Example:
Compress a project.
compress /PROJECTNAME:C:\Projects\EPLAN\DEMO2_D.elk
/CONFIGSCHEME:config_scheme /FILTERSCHEME:filter_scheme
Use the most recent configuration scheme: The 'CONFIGSCHEME'

parameter is not entered.
compress /PROJECTNAME:C:\Projects\EPLAN\DEMO2_D.elk
/FILTERSCHEME:filter_scheme
Automatic Action: devicelist

Type of task to be performed by the action:

TYPE
IMPORT: Import device list
EXPORT: Export device list
DELETE: Delete device list

must be used first, otherwise an Sys-
IMPORTFILE
The directory and the file name of the device list to be
imported must be specified here.
EXPORTFILE
The directory and the file name of the device list to be
exported must be specified here.
17 / 50
Optional: File format ("XDLXmlExporter", "XDLTxtIm-

FORMAT
porterExporter", "XDLCsvImporterExporter", or user-
defined format)
Default= XDLXmlExporter
Example:
import:
devicelist /TYPE:IMPORT
/IMPORTFILE:C:\EPLAN\deviceListe.xml
export:
devicelist /TYPE:EXPORT
/EXPORTFILE:C:\EPLAN\deviceListe2.xml
delete:
devicelist /TYPE:DELETE
Automatic Action: edit


18 / 50
PAGENAME
Name of the page to be opened (optional). Required if
X, Y have been specified as parameters.
DEVICENAME Name of an item (optional).
X
X coordinate (optional). Parameter is only valid if the
PAGENAME parameter is available.
Y
Y coordinate (optional). Parameter is only valid if the
PAGENAME parameter is available.
Example:
Open project:
edit /PROJECTNAME:C:\Projects\EPLAN\DEMO2_D.elk
Open page:
/PAGENAME:=AP+ST1/7
Open page with DT:

/DEVICENAME:=AP+PT1-G1
Open page and set cursor to X, Y position:

/PAGENAME:=AP+ST1/7 /X:200 /Y:100
19 / 50
Automatic Action: EplApiModuleAction
register Full file name of the add-in dll to be registered.
unregister
Assembly file title of the add-in to be de-
registered.
Assembly file title of the add-in to be de-

unregisterInternal registered. When an error makes the unload im-
possible,the module is only deregistered.
Example:
Action call to load an add-in.
W3u.exe EplApiModuleAction /register:"C:Program Files
\EPLAN\electric P8\1.7.5\bin\Eplan.EplAddin.MyAddin3.dll"
Automatic Action: ExecuteScript

ScriptFile Script file to run.
Example:
W3u.exe ExecuteScript /ScriptFile:"C:\Program Files
\EPLAN\electric
P8\1.7.5\Scripts\EPLAN\SimpleScriptWithParameters.cs
/Param1:Hello /Param2:EPLAN /Param3:" API developer!"
20 / 50
Automatic Action: export

PXFPROJECT: Export project in PXF format.
GRAPHICPROJECT: Export project in
graphical format (TIF, GIF, PNG, JPG).
GRAPHICPAGE: Export pages in graphical
format (TIF, GIF, PNG, JPG).
TYPE DXFPROJECT: Export project in DXF format.
:DWGPROJECT Export project in DWG for-
mat.
:PDFPROJECT Export project in PDF format.
DXFPAGE: Export pages in DXF format.
DWGPAGE: Export pages in DWG format.
PDFPAGE: Export pages in PDF format.

PROJECTNAME
ception is thrown.
Name of the project to be exported (optional).

Default: Project name. This parameter is only
EXPORTFILE effective with the following value of the TYPE
parameter: PXFPROJECT. The file extension
is automatically added by the system.
21 / 50
Specifies whether master data is to be in-

cluded in the export (optional). Default =
EXPORTMASTERDATA 1(Yes). This parameter is only effective with
the following value of the TYPE parameter:
PXFPROJECT.
Specifies whether connections are to be in-

cluded in the export (optional). Default =
EXPORTCONNECTIONS 0(No). This parameter is only effective with
the following value of the TYPE parameter:
PXFPROJECT.
Name of the page to be exported (optional).

This parameter is only effective with the
PAGENAME
DXFPAGE, DXFPROJECT, DWGPAGE,
DWGPROJECT, GRAPHICPAGE,
GRAPHICPROJECT values of the TYPE pa-
rameter.
Target directory. Relevance of this parameter.

For GRAPHICPAGE, GRAPHICPROJECT:
Directory where the graphical files are stored.
If this directory does not exist yet, it is cre-
ated. Below this directory, a new directory
DESTINATIONPATH with the name of the project is created into
which the individual image files are saved
For DXFPAGE, DXFPROJECT, DWGPAGE,
DWGPROJECT: Directory to which the data
is exported (optional). The project directory is
the default value.
22 / 50
Output format. Supported export formats are:

• BMP: available color depth: 1, 4, 8, 16,
24 and 32
• TIF: available color depth: 1, 4, 8, 24
and 32
• GIF: color depth is irrelevant
FORMAT • PNG: available color depth: 1, 4, 8, 16,
24 and 32
• JPG: available color depth: 1, 4, 8, 16,
24 and 32.
This parameter is optional. Default value is

TIF. This parameter is only effective with the
GRAPHICPAGE, GRAPHICPROJECT values
of the TYPE parameter.
Color depth of the image. The possible values
are 1,8,16,24,32. This parameter is optional
COLORDEPTH
and 24 is the default value. This parameter is
only effective with the GRAPHICPAGE and
rameter.
Image width in pixels. The height is automati-

cally computed from the page dimensions.
This parameter is optional and 80 is the de-
IMAGEWIDTH fault value. This parameter is only effective
with the GRAPHICPAGE and
rameter.
23 / 50
Type of compression for output in Tiff format.

This parameter has no effect on other output
formats. The color depth is always 1 for
CCITT3, CCITT4, and RLE compression, that
IMAGECOMPRESSION
is, a binary image is created. This parameter
is optional and possible values are LZW,
RLE, CCITT3, CCITT4, NONE. Default value
is NONE. This parameter is only effective with
the GRAPHICPAGE and GRAPHICPROJECT
values of the TYPE parameter.
The output is in black and white. Note: This

does not affect the image format or size, i. e.,
the files are not reduced. Default:
BLACKWHITE 1(black/white) This parameter is also optional
and only effective with the GRAPHICPAGE
and GRAPHICPROJECT values of the TYPE
parameter.

USEPAGEFILTER
checkbox in GUI. This parameter is only ef-
fective with the GRAPHICPAGE value of the
TYPE parameter
Default value: 1
Scheme for user settings (optional). If this pa-

rameter does not exist or is empty (""), the
most recently used page filter scheme is ta-
SCHEME ken. This parameter is only effective with the
DXFPAGE, DXFPROJECT, DWGPAGE,
DWGPROJECT values of the TYPE parame-
ter.
24 / 50
Scheme for DXF/DWG export (optional). If

this parameter does not exist or is empty (""),
the most recently used DXF/DWG export
EXPORTSCHEME scheme is taken. This parameter is only effec-
tive with the DXFPAGE, DXFPROJECT,
DWGPAGE, DWGPROJECT values of the
TYPE parameter.
If set to 1, a zoom window is to be used when

jumping from navigation pages to compo-
USEZOOMLEVEL nents in the PDF file. The components are
then displayed centered within the zoom win-
dow.
If bUseZoom is set to true, you set in dZoom-

Level the desired zoom level in "mm". The va-
lue entered reflects the height of the screen
section that is to be displayed magnified after
ZOOMLEVEL
the jump. A smaller value (e.g. 20 mm) thus
leads to a greatly magnified display of the re-
spective component on the screen. You can
enter values between 1 and 3500.
If bUseZoom is false, dZoomLevel has no in-
fluence on the result.
If set to 1, only a simple link is created in the

USESIMPLELINK PDF. If set to 0 then "three-way" jumps are
available for all components in the PDF.
FASTWEBVIEW
If set to 1, fast web display will be enabled in
the PDF.
READONLYEXPORT If set to 1, the PDF file will be write protected.
25 / 50
Example:
Export a project in PXF format
export /TYPE:PXFPROJECT
/EXPORTFILE:C:\temp\myPxfDEMO_D
Export a project in graphical format

export /TYPE:GRAPHICPROJECT
/PROJECTNAME:C:\Projects\EPLAN\DEMO2_d.elk
/DESTINATIONPATH:C:\temp /FORMAT:BMP /COLORDEPTH:24
/IMAGEWIDTH:1024 /BLACKWHITE:1
Export a page in graphical format

export /TYPE:GRAPHICPAGE
/PAGENAME:=AP1+ST1/2 /DESTINATIONPATH:C:\temp /FORMAT:BMP
/COLORDEPTH:24 /IMAGEWIDTH:1024 /BLACKWHITE:1
Export several pages in graphical format

export /TYPE:GRAPHICPAGE
/DESTINATIONPATH:C:\temp /FORMAT:BMP /COLORDEPTH:24
/IMAGEWIDTH:1024 /BLACKWHITE:1 /USEPAGEFILTER:1
Export a project in DXF/DWG format

export /TYPE:DXFPROJECT
/DESTINATIONPATH:C:\temp
Export a page in DXF/DWG format

export /TYPE:DXFPAGE
/PAGENAME:=AP1+ST1/2 /DESTINATIONPATH:C:\temp
26 / 50
Export several pages in DXF/DWG format
export /TYPE:DXFPAGE
/DESTINATIONPATH:C:\temp /EXPORTSCHEME:dxf_scheme
/USEPAGEFILTER:1
Automatic Action: generate


TYPE CONNECTIONS: Connection generation
CABLES: Cable generation

PROJECTNAME
script or button bar). If called from the windows
command line, PROJECTNAME must be set or
the ProjectAction must be used first, otherwise
an System.ArgumentException exception is
thrown.
Name of the scheme; for cable generation (op-

CREATIONSCHEME
tional).
Default value: Most recently used scheme.
This only applies to cable generation.
Name of the scheme; for cable numbering (op-

NUMBERINGSCHEME
tional).
Default value: Recent scheme.
27 / 50
Name of the scheme; for automatic cable se-

AUTOSELECTSCHEME
lection (optional).
Default value: Recent scheme.
Specifies whether connections are to be re-

REGENERATECONNS
generated first (optional, 0 = No, 1 = Yes).
Default value = 1
Specifies whether existing cable names are to

KEEPOLDNAMES
be preserved (optional, 0 = No, 1 = Yes).
Default value = 1
Start value for DT counter (optional).

STARTVALUE Default value: 1
Increment; value by which the DT counter is

STEPVALUE increased (optional). Default value: 1
Only applies to cable generation.
Specifies whether the cable selection should

be made only for automatically generated ca-
ONLYAUTOCABLES bles (optional, 0 = No, 1 = Yes).
Default value: 1
Only applies to cable generation.
28 / 50
Example:
Connection generation
generate /TYPE:CONNECTIONS
/PROJECTNAME:C:\Projects\EPLANDEMO2_D.elk
Cable generation
generate /TYPE:CABLES /KEEPOLDNAMES:0 /STARTVALUE:5
/STEPVALUE:2 /ONLYAUTOCABLES:0
Automatic Action: import

Type of task to be performed by the

action:
PXFPROJECT: Import PXF project
DXFDWGFILES: Insert DXF / DWG
drawings in macros.
DXFPAGE: Insert DXF drawing into a
page
DWGPAGE: Insert DWG drawing into
TYPE a page
EPLAN5MACROS: Import EPLAN 5
macros
EPLAN5PROJECT: Import EPLAN 5
project
EPLAN21MACROS: Import EPLAN 21
macros
EPLAN21PROJECT: Import EPLAN
21 project
29 / 50
Project name with full path.

Is required for the following values of
the TYPE parameter:
EPLAN5MACROS and
EPLAN5PROJECT.
Is not required for the following values
of the TYPE parameter:
EPLAN21MACROS and
EPLAN21PROJECT.
PROJECTNAME
Is optional if the TYPE parameter has
the following values: PXFPROJECT,
DXFDWGFILES, DXFPAGE und
DWGPAGE. If not entered, the se-
lected project is used when the action
is called from GUI (like from a script or
button bar). If called from the windows
command line, PROJECTNAME must
be set or the ProjectAction must be
used first, otherwise an System.Argu-
mentException exception is thrown.
Path and name. This parameter is not

effective with the following values of
the TYPE parameter:
EPLAN5MACROS and
EPLAN5PROJECT.
Meaning of this parameter to the val-
IMPORTFILE ues of the TYPE parameter:
EPLAN21MACROS: Path and name of
the EPLAN21 macro (*.mac) to be im-
ported, or all EPLAN21 macros from
an EPLAN21 archive (*.ez).
EPLAN21PROJECT: Path and name
of the EPLAN21 project to be im-
ported.
30 / 50
PXFPROJECT: Path and name of the
file to be imported.
DXFPAGE,DWGPAGE: Path and na-
me of the file to be imported.
Directory where the DXF/DWG files

SOURCEPATH
are located. Only applies to the
DXFDWGFILES value of the TYPE
parameter
Destination directory where the im-

ported projects and macros are stored.
DESTINATIONPATH
Only applies to the
EPLAN5MACROS,EPLAN5PROJECT,
and DXFDWGFILES values of the
TYPE parameter
Name of the DXF/DWG import scheme

(only name, without full path). (op-
tional) Defaultwert= Most recently
used scheme. If this parameter does
IMPORTSCHEME not exist or is empty (""), the most re-
cently used scheme is taken. Only ap-
plies to the TYPE parameter values:
DXFPAGE, DWGPAGE,
DXFDWGFILES
Name of page into which the CAD

PAGENAME
drawing is to be inserted. Only applies
to the DXFPAGE and DWGPAGE val-
ues of the TYPE parameter
31 / 50
Scaling in X direction. Default value=1.

XSCALE
Only applies to the DXFPAGE and
DWGPAGE values of the TYPE pa-
rameter. (optional)
Scaling in Y direction. Default value=1.

YSCALE
rameter. (optional)
Move to X direction. Default value=0.

XOFFSET
rameter. (optional)
Move to Y direction. Default value=0.

YOFFSET
rameter. (optional)
Full path of new macro project with file

MACROPROJECT
extension *.elk. Only applies to the
EPLAN5MACROS value of the TYPE
parameter.
Boolean parameter. 1: Only create

macro project. 0: automatic export of
ONLYMACROPROJECT
all macros from created project to
macro directory. Default: 0. Only ap-
plies to the EPLAN5MACROS value of
the TYPE parameter. (optional)
32 / 50
Character set of EPLAN5 project. Only

applies to the EPLAN5MACROS and
CODEPAGE EPLAN5PROJECT values of the
TYPE parameter (optional). Default
value = 437.
EPLAN 5 master data drive (e.g. C:).

DRIVE
Only applies to the EPLAN5MACROS
and EPLAN5PROJECT values of the
TYPE parameter.
Full path of an EPLAN 5 macro (with

file extension) to be imported, or full
path of an EPLAN 5 macro directory
SOURCEMACROPATH from which all macros are to be im-
ported. Only applies to the
EPLAN5MACROS value of the TYPE
parameter.
Synchronization of imported parts data

BALANCEARTICLES
with database. Only applies to the
EPLAN5PROJECT value of the TYPE
parameter. Default: 0. (optional)
Indicates whether automatic cables

GENERATEAUTOMATICCABLES
are generated. Only applies to the
EPLAN5PROJECT value of the TYPE
parameter. Default: 0. (optional)
Destination path with file name. Only

DESTINATIONFILE
applies to the EPLAN21MACROS and
EPLAN21PROJECT values of the
TYPE parameter.
33 / 50
Indicates whether a project check is

started after the import (0 or 1). Only
VERIFY applies to the EPLAN21PROJECT va-
lue of the TYPE parameter. Default = 0
(optional).
Example:
Import PXF project:
import /TYPE:PXFPROJECT /IMPORTFILE:C:\Projects\DEMO_D.epj
/PROJECTNAME:C:\Projects\EPLAN\Imported_DEMO_D.elk
Import DXF / DWG drawings in macros

import /TYPE:DXFDWGFILES
/PROJECTNAME:C:\Projects\EPLAN\DEMO2_D_V550.elk
/SOURCEPATH:C:\Projects\DXF_DWG /DESTINATIONPATH:D:\Macros
Insert DXF / DWG drawing into a page:

import /TYPE:DWGPAGE
/PROJECTNAME:C:\Projects\EPLAN\DEMO2_D_V550.elk
/PAGENAME:=AP+ST1/4
/IMPORTFILE:C:\Projects\EPLAN\DXF_DWG\pline_1.dwg
/XSCALE:0.5 /YSCALE:0.5 /XOFFSET:100.0 /YOFFSET:100.0
Import EPLAN 5 macros:

Import one EPLAN 5 macro import /TYPE:EPLAN5MACROS
/PROJECTNAME:C:\EPLAN4\P\EPLAN\DEMO2_D.P
/MACROPROJECT:C:\Projects\EPLAN\EPLAN0001.elk
/ONLYMACROPROJECT:0 /CODEPAGE:437 /DRIVE:C:
/SOURCEMACROPATH:C:\EPLAN4\M\EPLAN\AB100.MZF
/DESTINATIONPATH:C:\Projects\EPLAN\Macros Import several
EPLAN 5 macros import /TYPE:EPLAN5MACROS
/MACROPROJECT:C:\Projects\EPLAN\EPLAN0001.elk
/ONLYMACROPROJECT:0 /CODEPAGE:437 /DRIVE:C:
34 / 50
/SOURCEMACROPATH:C:\EPLAN4\M\EPLAN
/DESTINATIONPATH:C:\Projects\EPLAN\Macros
Import EPLAN 5 project:

import /TYPE:EPLAN5PROJECT
/DESTINATIONPATH:"C:\temp\my imported projects"
/BALANCEARTICLES:0 /CODEPAGE:437 /DRIVE:C:
/GENERATEAUTOMATICCABLES:0
Import EPLAN 21 macros:

import /TYPE:EPLAN21MACROS
/IMPORTFILE:C:\EPLAN21\MACROS\AB_2.mac
/DESTINATIONFILE:C:\EPLAN\MACROSMyMacros
Import EPLAN 21 project:

import /TYPE:EPLAN21PROJECT
/IMPORTFILE:C:\Projects\EPLAN\E21EasyProjects\demo_v31.prj
/DESTINATIONFILE:C:\temp\myProjects
Automatic Action: label


Configuration scheme (optional).

CONFIGSCHEME Default value: Most recently used configuration
scheme.
35 / 50
Filter scheme (optional).

FILTERSCHEME
Default value: Most recently used filter scheme. If
this parameter is not available, no filtering can be
performed.
Sorting scheme.
SORTSCHEME
Default value: Most recently used sorting scheme If
this parameter is not available, no sorting can be
performed.
LANGUAGE Language (e.g., en_US).
Target file where the labeling results are saved.

DESTINATIONFILE
The following formats are supported: txt, xls, xml.
Format must be set according to the extension that
is in CONFIGSCHEME
RECREPEAT
Optional: Number of repetitions per label (>=1).
Default value: 1
Optional: Number of repetitions of total output

TASKREPEAT (>=1).
Default value: 1
Optional: Decide whether the output file should be

SHOWOUTPUT shown.
Default value: false
36 / 50
Example:
label /PROJECTNAME:C:\Projects\EPLAN\DEMO2_D.elk
/CONFIGSCHEME:config_scheme /FILTERSCHEME:filter_scheme
/SORTSCHEME:sort_scheme /LANGUAGE:en_US
/DESTINATIONFILE:c:temp\labeling.txt /RECREPEAT:3
/TASKREPEAT:2
Use the most recent configuration scheme: The CONFIGSCHEME

parameter is not entered. It is empty.
/FILTERSCHEME:filter_scheme /SORTSCHEME:sort_scheme
/LANGUAGE:en_US /DESTINATIONFILE:c:temp\labeling.txt
/RECREPEAT:3 /TASKREPEAT:2
Carry out labeling without filtering and sorting: The

FILTERSCHEME and SORTSCHEME parameters are not passed in
this case.
/CONFIGSCHEME:config_scheme /LANGUAGE:en_US
/DESTINATIONFILE:c:temp\labeling.txt /RECREPEAT:3
/TASKREPEAT:2
Automatic Action: MfImportToolbarAction

File the xml file inclusive path for import
Replace Existing toolbars with the same name are replaced.
Example:
MfImportToolbarAction /File:"?" /Replace:Yes
37 / 50
Automatic Action: OpenWorkspaceAction
Workspacename
name of the workspace which should be opened (a
string)
set or reset the silent mode (a bool term); in silent

Silent mode all dialogs will be suppressed (e.g. error dia-
logs)
Example:
OpenWorkspaceAction /Workspacename:"?"
Automatic Action: partslist


IMPORT: Import parts lists
TYPE
EXPORT: Export parts lists
IMPORTTOSYSTEM:Import to parts management
EXPORTFROMSYSTEM:Export to parts manage-
ment

38 / 50
The directory and the file name of the file to be im-

IMPORTFILE ported must be specified here. This only applies to
IMPORT.
The directory and the file name of the file to be ex-

EXPORTFILE
ported must be specified here. The file extension is
automatically added by the system. This only applies
to EXPORT
Optional: File format ("XPalXmlExporter", "XPalCS-

VConverter", or user-defined format). For System
Parts ( IXPamImportE21, IXPamImportE5, IXPamIm-
FORMAT
portText, IXPamImportCSV, IXPamImportEcad, XPa-
mImportXml and IXPamImportText, IXPamIm-
portCSV, XPamExportXml)
Default value= XPalXmlExporter, XPamImportXml,
XPamExportXml
SQLFILTERPART
Optional: Sql filter for advanced users.
Default value= 1=1
Optional: The directory and the file name of the con-

CFGFILE figuration file.
Default value= NULL, the currently used config file.
Example:
Export:
partslist /TYPE:EXPORT
/FORMAT:XPalCSVConverter /EXPORTFILE:d:\temp\PartsList.csv
39 / 50
Import:
partslist /TYPE:IMPORT
/FORMAT:XPalCSVConverter /IMPORTFILE:d:\temp\PartsList.csv
Automatic Action: print


TYPE PROJECT: Print project.
PAGES: Print pages.

PROJECTNAME
ception is thrown.
PRINTERNAME
Name of printer (optional).
Default value: Printer set on your computer.
PAGENAME Page to be printed (optional).
PRINTCOLLATE
Sorted order (optional, 0 = No, 1 = Yes).
Default value: 1
PRINTREVERSE
Reverse order (optional, 0 = No, 1 = Yes).
Default value: 0
40 / 50
NUMBER
Number of copies.
Default: 1
DESTINATIONFILE
Path and name of the output file.
Default value: Printer set or specified

USEPAGEFILTER
checkbox in GUI.
Default value:1
PRINTCHANGEDPAGES Print only changed pages
Example:
Print page
print /TYPE:PAGES
/PAGENAME:=AP+ST1/6 /PRINTERNAME:my_printer /NUMBER:2
Print page to file

print /TYPE:PAGES
/PRINTCOLLATE :0 /PRINTREVERSE:1
/DESTINATIONFILE:U:tempprint /USEPAGEFILTER:1
Print project
print /TYPE:PROJECT
/PRINTCOLLATE :0 /PRINTREVERSE:1
/DESTINATIONFILE:U:\tempprint
41 / 50
Automatic Action: ProjectAction
Project used project
Action used action, action parameter following.
NOCLOSE
if "1" used project will not be closed afterwards (Optional).
On default project will be closed afterwards.
Automatic Action: projectmanagement


TYPE READPROJECTINFO : Load project information from
an XML file into the project.

PROJECTNAME must be set or the Project Action
FILENAME Full path / name of the XML file to be imported.
42 / 50
Example:
projectmanagement /TYPE:READPROJECTINFO
/PROJECTNAME:"C:\Projects\EPLAN projcets\DEMO2_D.elk"
/FILENAME:C:\Files\ProjectInfo.xml
Automatic Action: ProjectOpen

Project used project
Example:
ProjectOpen /Project:C:EPLANProjectsDEMO.elk ProjectOpen
/Project:"C:EPLANmy own ProjectsDEMO.elk"
Automatic Action: reports

TYPE
PROJECT: update all project reports.
Project name with full path (optional). If not entered,

the selected project is used, in case the action is cal-
PROJECTNAME led from GUI (like from a script or button bar). If called
from the windows command line, PROJECTNAME
must be set or the ProjectAction must be used first.
43 / 50
Example:
reports /TYPE:PROJECT
/PROJECTNAME:C\Projects\EPLAN\DEMO2_D.elk
Automatic Action: Restore

ARCHIVENAME
Archive name. Name of the archive to be re-
stored.
Target directory. Path where the projects or data

DESTINATIONPATH are to be restored.
Only applies to TYPE = MASTERDATA
Specifies whether the previously packed project is

to be unpacked (optional, Yes = 1, No = 0).
UNPACKPROJECT
Set this flag to 0 Only if previously packed projects
are to be unpacked,
Default value=0
Only applies to TYPE = PROJECT
Example:
Restore project:
restore /TYPE:PROJECT /ARCHIVENAME:U:\temp\my_prj.zw1
/PROJECTNAME:U:\temp\w3_proj.elk /UNPACKPROJECT:0
Restore master data (plot frames, ...) to a DestinationPath

restore /TYPE:MASTERDATA
/ARCHIVENAME:U:\temp\SSHmy_MasterData.zw2
/DESTINATIONPATH:U:\temp
44 / 50
Automatic Action: SaveWorkspaceAction
Workspacename
name of the workspace which should be saved (a
string)
set or reset the silent mode (a bool term); in silent

Silent mode all dialogs will be suppressed (e.g. error dia-
logs)
Example:
SaveWorkspaceAction /Workspacename:"?"
Automatic Action: search

Describes the search area:

DEVICETAG: Search for devices
ALLPROPERTIES: Search through all prop-
TYPE
erties
TEXTS: Text search
PAGEDATA: Search through page data
PROJECTDATA: Search through project da-
ta
45 / 50

when the action is called from GUI (like from
PROJECTNAME
a script or button bar). If called from the win-
be set or the ProjectAction must be used
first, otherwise an System.ArgumentExcep-
tion exception is thrown.
SEARCHITEM Text you are searching for.
CASESENSITIVE
Match case (optional, 1 = Yes, 0 = No).
Default value: Last setting.
Find whole texts only (optional, 1 = Yes, 0 =

WHOLETEXT No).
Search on logic pages (optional, 1 = Yes, 0 =

LOGICPAGES No).
Search on graphical pages (optional, 1 =

GRAPHICPAGES Yes, 0 = No).
Search on report pages (optional, 1 = Yes, 0

EVALUATIONPAGES = No).
Search in unplaced functions (optional, 1 =

NOTPLACEDFUNCTIONS Yes, 0 = No).
46 / 50
Number of the current search database (op-

tional).
SEARCHDB 0: List of results 1
1: List of results 2
Default value: 0
Example:
search /TYPE:TEXTS
/SEARCHITEM:Hallo /CASESENSITIVE:1 /WHOLETEXT:0
/LOGICPAGES:1 /SEARCHDB:0
search /TYPE:PAGEDATA
/SEARCHITEM:Drive /CASESENSITIVE:0 /WHOLETEXT:0
/LOGICPAGES:1 /EVALUATIONPAGES:1 /NOTPLACEDFUNCTIONS:1
/SEARCHDB:1
Automatic Action: selectionset


TYPE PROJECT: Return selected project
PAGES: Return selected pages
47 / 50
Example:
Return currently selected project:
selectionset /TYPE:PROJECT
Results in calling context: Parameter name = 'PROJECT'

Value = 'C:\Projects\EPLAN\DEMO2_D.elk'
Return currently selected pages:

selectionset /TYPE:PAGES
Results in calling context: Parameter name = 'PAGES'

Value = '=AP+ST1/1;=AP+ST1/2;=AP+ST1/5'
Automatic Action: translate

TRANSLATEPROJECT: Translate project

TYPE
REMOVELANGUAGE: Remove language entry
EXPORTMISSINGTRANSLATIONS: Export missing-
word list

Name of file containing exported missing word list. On-

EXPORTFILE ly applies to the parameter: TYPE =
EXPORTMISSINGTRANSLATIONS
48 / 50
Name of converter (optional). This name is used as the

output format for the missing-word list.
CONVERTER Default value: XTrLanguageDbXml-2TabConverterImpl
(TAB-separated Unicode file). Only applies to the pa-
rameter: TYPE = EXPORTMISSINGTRANSLATIONS
Translation language, e.g., fr_FR

LANGUAGE
Only applies to the parameter:
REMOVELANGUAGE
EXPORTMISSINGTRANSLATIONS
Example:
Translate project
translate /TYPE:TRANSLATEPROJECT
Remove translation from project:

translate /PROJECTNAME:C:\Projects\EPLAN\DEMO2_D.elk
/TYPE:REMOVELANGUAGE /LANGUAGE:en_US
Export missing-word list

translate /TYPE:EXPORTMISSINGTRANSLATIONS
/PROJECTNAME:C:\Projects\EPLAN\DEMO2_D.elk /LANGUAGE:en_US
/EXPORTFILE:d:\temp\missingTransFile.txt
/CONVERTER:XE5LanguageDbXmlConverterImpl
49 / 50
Automatic Action: XSDPreviewAction
PROJECTNAME
name of the project; if the path is missing, the default
value is used (see $(MD_PROJECTS))
PAGENAME name of page as string
complete path to a window or page macro (with exten-

MACRONAME sion); if the path is missing, the default value is used
(see $(MD_MACROS))
SHOW
1: the preview of the page/macro will be opened; 0: the
preview will be closed
Example:
preview of a page:
XSDPreviewAction /PROJECTNAME:DEMO2_D /PAGENAME:=AP+ST1/1
XSDPreviewAction /PROJECTNAME:C:ProjectsEPLANDEMO2_D
/PAGENAME:=AP+ST1/2
preview of a page macro:

XSDPreviewAction /PROJECTNAME:DEMO2_D /MACRONAME:st1.emp
XSDPreviewAction /PROJECTNAME:$(MD_PROJECTS)DEMO2_D
/MACRONAME:$(MD_MACROS)st1.emp
50 / 50

Eplan Curs

Hochgeladen von

Dokumentinformationen

Originaltitel

Copyright

Verfügbare Formate

Dieses Dokument teilen

Dokument teilen oder einbetten

Freigabeoptionen

Stufen Sie dieses Dokument als nützlich ein?

Sind diese Inhalte unangemessen?

Copyright:

Verfügbare Formate

Eplan Curs

Hochgeladen von

Copyright:

Verfügbare Formate

Application Example

EPLAN Command Line Parameters

The actual call of EPLAN is performed by specifying the executable file

Command, action, and parameter are separated by spaces on the com-

General command line parameters

W3u.EXE /GenParameter Action /Parameter1:Value1

• /TYPE:PAGES (= type of print command, here: print pages)

Due to the inclusion of the general command line parameters

If an error occurs during the execution of a command line, it is logged in

The following automatic actions are available in EPLAN:

Action name Description

backup Backs a project or master data up.

check Checks pages or the entire project.

compress Compresses a project.

devicelist Imports, exports, or deletes a device list.

edit Opens a page or a project.

EplApiModuleAction Loads and registers an API module.

ExecuteScript Runs a specified script.

export Exports pages or projects in different formats.

generate Generates connections or cables.

import Imports projects, macros, or drawings.

label Generates the labeling for a project.

MfImportToolbarAction Imports a toolbar from a file.

OpenWorkspaceAction Opens an existing workspace.

partslist Imports or exports a parts list.

print Prints a page or the whole project.

ProjectOpen Opens a specified project.

reports Generates project reports.

/NoLoadWorkspace No workspace is loaded or recreated.

/Auto Quits EPLAN after the command line is executed.

Automatic Action: backup

Type of task to be performed:

Project name with full path (optional).

DESTINATIONPATH Target directory

Remark on backup (optional).

If the project to be backed up is to be packed (zip-

An enum constant that may assume the following

Specifies whether the database is to be com-

Specifies whether external documents are to be

Specifies whether image files are to be included in

Type of master data to be backed up:

Name of the file to be backed up.

backup /TYPE:PROJECT /COMMENT:Hello

Back up master data:

Back up all plot frames (*.fn1):

Back up all files (*.*) in specified source directory:

Automatic Action: check

Type of task to be performed by the action.

Project name with full path (optional).

Name of scheme used for the project check

Determines if only filtered pages should be

PAGENAME Name of the page to be checked (optional).

Automatic Action: compress

Project name with full path (optional).

Configuration scheme for project compression (op-

Filter scheme for project compression (optional).

Use the most recent configuration scheme: The 'CONFIGSCHEME'

Automatic Action: devicelist

Type of task to be performed by the action:

Project name with full path (optional).

Optional: File format ("XDLXmlExporter", "XDLTxtIm-

Automatic Action: edit

Project name with full path (optional).

Back up all files (.) in specified source directory: