EPLAN Actions: Overview

The Actions listed below are available to you in EPLAN for different fields of application. An "X" in a column identifies the field of application recommended by us for the respective action. The actions identified with "X*" in the Ribbon column are available to you in the dialog Customize for customizing the ribbon as pre-defined commands.

Further information on the actions is available in the EPLAN API help of the Platform. A list of all official EPLAN actions is available in the section Actions.

Action name	Command line	Scripts	Ribbon	Description
backup	X	X	–	Backs a project or master data up.
changelayer	X	X	–	Changes the graphical properties of layers.
check	X	X	–	Checks pages or the entire project.
CleanWorkspaceAction	X	–	–	Deletes an existing workspace.
compress	X	X	–	Compresses a project.
devicelist	X	X	–	Imports, exports, or deletes a device list.
edit	X	X	–	Opens a page or a project.
EplApiModuleAction	X	–	–	Loads and registers an API module.
EsCorrectConnections	X	–	X	Combines identical connection definition points.
ExecuteScript	X	–	X	Runs a script.
export	X	X	–	Exports pages or projects in different formats.
export3D	X	X	–	Exports layout spaces into the STEP format.
exportNCData	X	X	–	Exports NC data for different machine formats.
exportProductionWiring	X	X	–	Exports wire fabrication data into different formats.
ExportSegmentsTemplate	X	X	–	Exports segment templates into a file.
exportToGraphics	X	X	–	Exports pages or projects in graphic format (TIF, GIF, PNG, JPG).
gedRedraw	–	–	X	Builds the image of the graphical editor anew.
generate	X	X	–	Generates connections or cables.
generatemacros	X	X	–	Generates macros from a project.
GraphicalLayerTable	X	X	–	Imports / exports layers.
import	X	X	–	Imports projects, macros, or drawings.
ImportPrePlanningData	X	X	–	Imports pre-planning data.
ImportSegmentsTemplate	X	X	–	Imports segment templates from a file into a project.
InsertModelViewAction	X	X	–	Inserts model views into a project.
label Ribbon: Export manufacturing data / output labeling	X	X	X*	Generates the export of the manufacturing data / the labeling for a project.
masterdata	X	X	–	Updates the master data of the current project.
MfExportRibbonBarAction	X	X	–	Exports a ribbon.
MfImportRibbonBarAction	X	X	–	Imports a ribbon.
MfToggleMainMenuAction	–	–	X	Shows or hides the menu bar with the "old" menus from Version 2.9.
OpenWorkspaceAction	–	–	X	Opens an existing workspace.
partslist	X	X	–	Imports or exports a bill of materials.
partsmanagementapi	X	X	–	Exports or imports parts and other objects of the parts management such as accessory lists, accessory placements, drilling patterns, connection point patterns and addresses.
plcservice	X	X	–	Imports or exports PLC data by means of the specified configuration program.
preparemacros	X	X	–	Prepares macros of a macro project for automatic generation.
print	X	X	–	Prints a page or the whole project.
ProjectAction	X	X	–	Runs an action for a project and closes the project after this.
projectmanagement Ribbon: Manage project	X	X	X*	Runs an action for the project management or for projects. It is possible, among other things, to reorganize a project. This allows projects with database errors to be repaired in many cases and then opened again.
ProjectOpen	X	X	–	Opens a project.
RegisterCustomPropertyEditorAction	–	X	–	Registers/unregisters a user-defined editing dialog for a property number or for the identifying name of a user-defined property.
RegisterScript	X	–	–	Registers a script.
Renumber	X	X	–	Carries out renumbering.
reports	X	X	–	Generates project reports.
restore	X	X	–	Restores a project or master data from backup.
SaveWorkspaceAction	–	–	X	Saves the current user interface settings as workspace.
search	X	X	X	Searches for objects (devices, properties, texts, etc.) in a project.
selectionset	–	X	–	Retrieves values (name, file path, file name extension) from selected pages or a selected project.
SetProjectLanguage	X	X	–	Determines display languages for editable and read-only projects.
subprojects	X	X	–	Files off or stores a subproject.
SwitchProjectType	X	X	–	Switches the "Type of project" property.
synchronize	X	X	–	Synchronizes project data.
Topology	X	X	–	Routes topology connections or creates topology functions.
translate	X	X	–	Translates a project, deletes the translation from the project, or exports a missing word list.
UnregisterScript	X	–	–	Unregisters a script.
UpdateSegmentsFilling	X	X	–	Calculates the value of the property "Topology: Fill capacity" (ID 20332) of the manual routing paths project-wide and enters it at the respective routing paths, i.e. supplies a feedback about the space reserves in manual routing paths.
XAfActionSetting Ribbon: Define setting	X	X	X*	Sets a user, station, or company setting to a certain value.
XAfActionSettingProject Ribbon: Set project setting	X	X	X*	Sets a project setting to a certain value.
XAMlExportProductionData2RASCenterAction	X	X	X	Exports manufacturing data for the machining of enclosures in the AutomationML format for the selected project. The generated AML file is intended for import into the Rittal - RiPanel Processing Center production planning and control program.
XCMRemoveUnnecessaryNDPsAction	X	X	–	Removes superfluous net definition points from the current project. If necessary, connection definition points are placed on the connections of the net so that no properties are lost.
XCMUserToolAction Ribbon: Run external program	–	–	X*	Allows the integration of external programs.
XCMUniteNetDefinitionPointsAction	X	X	–	Unites net definition points that are placed in the same net of the current project. If more than one net definition point is placed in the same net, these net definition points (i.e. their connections) are combined into a single net definition point. After the execution of this action a maximum of one net definition point exists per net that contains all the net-based connections of the net.
XDLInsertDeviceAction Ribbon: Insert device	X	X	X*	Inserts a device.
XEGActionInsertSymRef Ribbon: Insert symbol, Insert symbol with function definition	–	–	X*	Inserts a symbol.
XEsGetPagePropertyAction	–	X	–	Determines the value for a page property of the currently selected page.
XEsGetProjectPropertyAction	–	X	–	Determines the value for a project property of the currently selected project.
XEsGetPropertyAction	–	X	–	Determines the value for a property of the currently selected object in the graphical editor.
XEsSetPagePropertyAction Ribbon: Set page property	–	–	X*	Sets a page property for the currently selected page to a specific value.
XEsSetProjectPropertyAction Ribbon: Set project property	–	–	X*	Sets a project property for the currently selected project to a specific value.
XEsSetPropertyAction Ribbon: Set component property	–	–	X*	Sets a property for the currently selected objects to a specific value.
XEsUserPropertiesExportAction	X	X	–	Exports user-defined properties into a file.
XEsUserPropertiesImportAction	X	X	–	Imports user-defined properties from a file.
XGedClosePage	–	–	X	Closes all selected pages. This action has no parameters.
XGedStartInteractionAction Ribbon: Set format of graphical elements,, Insert macro,, Set component format, Set text format, Set graphical format of connections (connection definition point, potential definition point)	–	X	X*	Starts an interaction in the graphical editor. Possible interactions are (e.g.) insertion of a macro or definition of the format settings for components, text, or similar elements.
XGedUpdateMacroAction	X	X	–	Updates macros.
XMActionDCCommonExport	X	X	–	Starts the export for the external editing.
XMActionDCImport	X	X	–	Imports a data configuration file of external editing into an existing EPLAN project.
XMDeleteReprTypeAction	X	X	–	Removes from selected macros a representation type and saves these macros in a directory.
XMExportConnectionsAction Ribbon: Export connections	X	X	X*	Exports the connection properties of a project for external editing.
XMExportDCArticleDataAction	X	X	–	Starts the export of parts data for external editing.
XMExportFunctionAction Ribbon: Export functions	X	X	X*	Exports the function properties of a project for external editing.
XMExportPagesAction Ribbon: Export pages	X	X	X*	Exports the page properties of a project for external editing.
XMImportDCArticleDataAction	X	X	–	Imports a file with parts data after external editing into an existing EPLAN parts database.
XPamArticlesSyncAction Ribbon: Synchronize parts databases	X	–	X*	Synchronizes the parts data of a new parts database (Version 2022) with an old, updated parts database (Version 2.9 or older).
XPamsDeviceSelectionAction	X	X	–	Carries our a device selection or updates device data.
XPamSelectPart	X	X	–	Starts the part selection.
XPlaUpdateDetailAction	X	X	–	Updates the detailed planning in the pre-planning navigator.
XPrjActionUpgradeProjects	X	X	–	Updates one or more projects to the current database scheme.
XPrjConvertBaseProjectsAction	X	X	–	Converts project templates from older EPLAN versions (Version 2.9 and older) into basic projects.
XSDPreviewAction	X	X	–	Opens or closes a page or macro preview window.
XSettingsExport	X	X	–	Exports user, workstation and company settings.
XSettingsImport Ribbon: Import settings	X	X	X*	Imports user, workstation and company settings.
XSettingsRegisterAction	X	–	–	Allows registering of add-ons.
XSettingsUnregisterAction	X	–	–	Allows unregistering of add-ons.

Warning:

Please note that the examples given for the individual actions in the help topics are separated by line breaks to make them easier to read. If you want to use the examples in the form illustrated, you MUST delete these line breaks. Please also make sure that, during input, action and parameter as well as the individual parameters are separated from each other by a blank space.