New Features in the "EPLAN API Extension" Extension Module

A unified, and especially high-performance, programming interface (API, Application Programming Interface) is available for EPLAN platform products. This extension module – the EPLAN API – allows you to develop your own customized solutions in collaboration with EPLAN or other partners. For more information about EPLAN API and EADN, visit the EPLAN web pages under the heading "Solutions > Integration > EPLAN Application Developer Network". The following section provides information on the various new features of EPLAN API. You require the Microsoft .NET Framework 4.5.2 to use the new EPLAN APIversion to develop your own applications.

Notes:

The "EPLAN API Extension" extension module is available as an option as part of our EPLAN Application Developer Network (EADN) as a developer's package for the following program variants:
EPLAN Electric P8 Select, EPLAN Electric P8 Professional,
EPLAN Electric P8 Professional+, EPLAN Electric P8 Ultimate,
EPLAN Fluid, EPLAN Fluid Professional,
EPLAN Fluid Professional+, EPLAN Fluid Professional E,
EPLAN Preplanning P&ID, EPLAN Preplanning Professional,
EPLAN Pro Panel Professional, EPLAN Pro Panel Professional+.
The extension module "EPLAN API Extension" can furthermore be purchased for "normal" licenses (with the exception of EPLAN Electric P8 Compact, EPLAN Fluid Compact).

Note:

We recommend that every API user compiles and tests their application early with the new version of the EPLAN API. If you still use outdated methods in your application, a corresponding compiler warning is shown to you during the compilation.

Drawing a cloud

By using the EPLAN API it is now also possible to draw a rectangle or a polygon in the form of a cloud. To do this you must correspondingly specify the property FillPattern in the class Rectangle or PolyLine.

Removed methods for data transfer

Several methods for data transfer from EPLAN 21 and EPLAN 5 were removed in the EPLAN API.

Synchronizing project master data

Through the new action masterdata you can now update the master data, via script or via the EPLAN API. In the process you use the parameter /TYPE:UPDATEPROJECT to specify that the project master data are updated. In the user interface of the EPLAN platform this corresponds to the Utilities > Master data > Update current project menu items.

New parameters for the action "generatemacros"

The generatemacros action has been expanded by the following optional parameter:

PAGENAMEn : Names of the pages to be considered
INSTALLATIONSPACENAMEn : Names of the layout spaces to be considered
STRUCTUREn : Structure identifier of the layout spaces to be considered
WINDOWMACRODIR : Directory for window macros
PAGEMACRODIR : Directory for page macros
FILTERSCHEME : Filter scheme
OVERWRITE : Overwrite mode.

In this case "n" stands for a number.

Generating piping definition points and piping connection points

In analogy to the menu items Insert > Piping definition point and Insert > Piping connection point in the user interface you can now also transfer and edit piping definition points and piping connection points via EPLAN API. A new Eplan.EplApi.DataModel class is now provided to this purpose in the PipingDefinition namespace.

Integrating when placing in the enclosure hierarchy

In order to also take the setting Integrate into enclosure hierarchy in the EPLAN API during the placement of parts in the 3D mounting layout into consideration, the class Placement3D has been expanded by the additional method FindSourceMate.

Updating parts via the EPLAN Data Portal

By using the EPLAN API it is now also possible to update the parts in the parts management via the EPLAN Data Portal. To this purpose the class MDPartsDataBase now also contains the new method UpdatePartFromDataPortal.

Assigning a bus interface name for function templates and connection point pattern

In order to also be able to assign a bus interface name via EPLAN API for function templates of bus ports in the parts management, the class MDPlcTemplatePosition with the new property BusSystem is now available to you.

Since the bus interface name can also be entered in the connection point patterns of the parts management and in the connection point pattern at specific functions (for example 3D part placements), the classes MDConnectionPointPosition and ConnectionPointPosition have been expanded accordingly with the new propertyPLCBusInterfaceName.

Combining function templates as template group

By means of the new method TemplateGroup from the class MDFunctionTemplatePosition it is now possible to use EPLAN API to combine the function templates of connected functions in the parts management to a template group.

Outputting numerical values as multilingual text

The new GetDisplayString method from the class PropertyValue allows you to output multilingual, meaningful texts from the user interface instead of numerical property values for properties.

Using new path variables

With the PathMap class and in the already existing SubstitutePath method you can now also use all the new path variables of the EPLAN platform (program variables, project variables and environment variables.)

Accessing value sets from macros at planning objects

You can now also use EPLAN API to access the macro stored at a planning object and the placeholder objects with value sets defined in the macro. The class PlanningObject now provides the new property MacroPlaceHolderValueSets to this purpose.

Specifying the connection dimension in function templates

In some of the MDFunctionTemplatePosition classes derived from classes (for example MDTerminalTemplatePosition) the new ConnectionDimension property is now available. With this property it is now also possible to use EPLAN API to determine the connection dimension for a part in the function templates.