EPLAN-Scripts

EPLAN 2.5: Scripting Neuerungen

EPLAN ist in Version 2.5 nun offiziell released.

Mit den News zur neuen Version (leider nur im Supportbereich von EPLAN erhältlich), teilt EPLAN den Anwendern schön mit, was sich alles geändert hat.

Leider wird hier das Scripting vernachlässigt. Es sind nämlich neue (offizielle Action) dazugekommen, welche in den News nicht erwähnt werden.

Bis zum Schluss habe ich gehofft dass die API-Hilfe auch online verfügbar ist, aber das ist leider nicht der Fall.

Anbei alle neuen Actions in EPLAN 2.5:

Action

Beschreibung

CreateTopologyFunctions

Erzeugt Topologie-Funktionen.

ExportSegmentsTemplate

Exportiert Segmentvorlagen in eine Datei.

ImportPrePlanningData

Importiert Vorplanungsdaten.

ImportSegmentsTemplate

Importiert Segmentvorlagen aus einer Datei in ein Projekt.

InsertModelViewAction

Fügt Modell-Ansichten in ein Projekt ein.

RouteTopology

Verlegt Verbindungen (Topologie).

SpExportSubProject

Lagert ein Projekt aus, welches im Bearbeitungsmodus “Exklusiv” geöffnet worden sein muss.

SpImportSubProject

Importiert ein Projekt, welches exklusiv geöffnet worden sein muss.

UpdateSegmentsFilling

Berechnet den Wert der Eigenschaft “Füllgrad” (ID 20332) und weist ihn allen Segmenten des Projekts zu.

XCMRemoveUnnecessaryNDPsAction

Entfernt überflüssige Netzdefinitionspunkte aus dem aktuellen Projekt. Falls erforderlich werden Verbindungsdefinitionspunkte auf die Verbindungen des Netzes platziert, so dass keine Eigenschaften verloren gehen.

XCMUniteNetDefinitionPointsAction

Vereinigt Netzdefinitionspunkte, die im gleichen Netz des aktuellen Projekts platziert sind. Ist mehr als ein Netzdefinitionspunkt im gleichen Netz platziert, werden diese Netzdefinitionspunkte (d.h. ihre Verbindungen) in einen einzelnen Netzdefinitionspunkt zusammengeführt. Nach der Ausführung dieser Aktion existiert also maximal ein Netzdefinitionspunkt pro Netz, der alle netzbasierten Verbindungen des Netzes enthält.

XMActionDCCommonExport

Startet den Export für die externe Bearbeitung.

Von |2018-12-10T13:36:26+01:002015-08-18|EPLAN, EPLAN-Scripts|

GetCurrentLoadedScripts

Ach schön, endlich ist es möglich zu erfahren, welche Scripte geladen sind…
Bin Aufgrund der Codes von GetCurrentScriptPath auf diese Lösung gekommen… Auch hier vielen Dank an den tollen EPLAN API Support!

/* Usage
    private static string GetCurrentLoadedScripts()
    {
        string value = null;
        ActionCallingContext actionCallingContext = new ActionCallingContext();
        new CommandLineInterpreter().Execute("GetCurrentLoadedScripts", actionCallingContext);
        actionCallingContext.GetParameter("value", ref value);
        return value;
    }
*/

using System.Text;
using Eplan.EplApi.Base;
using Eplan.EplApi.Scripting;

namespace EplanScriptingProjectBySuplanus.GetCurrentLoadedScripts
{
    public class GetCurrentLoadedScripts
    {
        [DeclareAction("GetCurrentLoadedScripts")]
        public void Action(out string value)
        {
            Settings settings = new Settings();
            var settingsUrlScripts = "STATION.EplanEplApiScriptGui.Scripts";
            int countOfScripts = settings.GetCountOfValues(settingsUrlScripts);
            StringBuilder stringBuilder = new StringBuilder();
            for (int i = 0; i < countOfScripts; i++)
            {
                string scriptPath = settings.GetStringSetting(settingsUrlScripts, i);
                stringBuilder.Append(scriptPath);

                // not last one
                if (i != countOfScripts - 1)
                {
                    stringBuilder.Append("|");
                }
            }

            // returns list: "\\path\script1.cs|\\path\script2.vb"
            value = stringBuilder.ToString();
        }
    }
}

Download auf GitHub

Von |2018-08-17T12:30:02+02:002015-08-05|EPLAN, EPLAN-Scripts|

GetProjectLanguages

Hatte das Script schon länger hier, aber irgendwie vergessen zu posten.

Aufgrund dieses Beitrages wurde ich daran erinnert :)

Die Funktion um Projekt-Sprachen zu erhalten war im MultiLanguageTool von EPLAN enthalten (freie API). Diese wurde aber nicht mehr entwickelt und ein Teil kam als offizielle Action… leider nicht die Projektsprachen.

/* Usage
    private static string GetProjectLanguages()
    {
        string value = null;
        ActionCallingContext actionCallingContext = new ActionCallingContext();
        new CommandLineInterpreter().Execute("GetProjectLanguages", actionCallingContext);
        actionCallingContext.GetParameter("value", ref value);
        return value;
    }
*/

using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Text;
using System.Xml;
using Eplan.EplApi.ApplicationFramework;
using Eplan.EplApi.Base;
using Eplan.EplApi.Scripting;

namespace EplanScriptingProjectBySuplanus.GetProjectLanguages
{
    public class GetProjectLanguages
    {
        private readonly string TempPath = Path.Combine(
            PathMap.SubstitutePath("$(TMP)"), "GetProjectLanguages.xml");

        [DeclareAction("GetProjectLanguages")]
        public void Action(out string value)
        {
            ActionCallingContext actionCallingContext = new ActionCallingContext();
            actionCallingContext.AddParameter("prj", FullProjectPath());
            actionCallingContext.AddParameter("node", "TRANSLATEGUI");
            actionCallingContext.AddParameter("XMLFile", TempPath);
            new CommandLineInterpreter().Execute("XSettingsExport", actionCallingContext);

            if (File.Exists(TempPath))
            {
                string languagesString = GetValueSettingsXml(TempPath,
                    "/Settings/CAT/MOD/Setting[@name='TRANSLATE_LANGUAGES']/Val");

                if (languagesString != null)
                {
                    List<string> languages = languagesString.Split(';').ToList();
                    languages = languages.Where(obj => !obj.Equals("")).ToList();

                    StringBuilder stringBuilder = new StringBuilder();
                    for (int i = 0; i < languages.Count; i++)
                    {
                        var language = languages[i];
                        stringBuilder.Append(language);

                        // not last one
                        if (i != languages.Count - 1)
                        {
                            stringBuilder.Append("|");
                        }
                    }

                    // returns list: "de_DE|en_EN"
                    value = stringBuilder.ToString();
                    return;
                }
            }

            value = null;
            return;
        }

        // Returns the EPLAN Project Path
        private static string FullProjectPath()
        {
            ActionCallingContext acc = new ActionCallingContext();
            acc.AddParameter("TYPE", "PROJECT");

            string projectPath = string.Empty;
            new CommandLineInterpreter().Execute("selectionset", acc);
            acc.GetParameter("PROJECT", ref projectPath);

            return projectPath;
        }

        // Read EPLAN XML-ProjectInfo and returns the value
        private static string GetValueSettingsXml(string filename, string url)
        {
            XmlDocument xmlDocument = new XmlDocument();
            xmlDocument.Load(filename);

            XmlNodeList rankListSchemaName = xmlDocument.SelectNodes(url);
            if (rankListSchemaName != null && rankListSchemaName.Count > 0)
            {
                // Get Text from MultiLanguage or not :)
                string value = rankListSchemaName[0].InnerText;
                return value;
            }
            else
            {
                return null;
            }
        }
    }
}

Download auf GitHub

Von |2018-08-17T12:29:57+02:002015-08-03|EPLAN, EPLAN-Scripts|

GetSelectedProject

Ach, ich weiß ja auch immer nicht.

Mir wurde mal gesagt man soll mit SelectionSet das aktuelle Projekt abfragen… denn mit den Pfadvariablen gibt es Probleme.

Bei mir war es aber nun in zwei Scripten der Fall dass die Abfrage nicht funktionierte.
Somit habe ich mich dazu entschlossen die Pfadvariable zu verwenden und das Problem ist seitdem nicht mehr aufgetreten.

Anbei beide Varianten…

Wie ist denn eure Meinung zu diesem Thema?

 

SelectionSet (meiner Meinung nach schlechte Wahl)

string projectname = string.Empty;
ActionCallingContext actionCallingContext = new ActionCallingContext();
CommandLineInterpreter commandLineInterpreter = new CommandLineInterpreter();
actionCallingContext.AddParameter("TYPE", "PROJECT");
commandLineInterpreter.Execute("selectionset", actionCallingContext);
actionCallingContext.GetParameter("PROJECT", ref projectname); // selected project
if (string.IsNullOrEmpty(projectname))
{
    // No project selected
}

 

Pfadvariable (meiner Meinung nach bessere Wahl)

var projectname = PathMap.SubstitutePath("$(PROJECTNAME)");
if (string.IsNullOrEmpty(projectname))
{
    // No project selected
}

 

Von |2017-11-09T11:22:20+01:002015-07-30|EPLAN, EPLAN-Scripts|

EPLAN Scripting & API Dokumentation erstellen

Wie schon öfters angemerkt, gibt es eine API-Dokumentation von EPLAN, welche leider nur mit dem Erwerb der API-Entwickler einsehbar ist.

Besonders schade daran ist, dass Scripting dort sehr gut beschrieben wird.

Da die Dokumentation von EPLAN selbst auch automatisch generiert wird, hat sich Daniel Papp die Mühe gemacht und das Ganze mal mit Sandcastle getestet.

Mit seiner Anleitung kann man sich eine eigene Scripting & API Dokumentation erstellen:

http://broadcast.oreilly.com/2010/09/build-html-documentation-for-y.html
Nicht erschrecken! Wir brauchen nur Step 1, Step 4 und den Anfang von 5.
Anstelle der in der Anleitung erzeugten Guy.dll + Guy.xml, binden wir die folgenden Dateien aus dem “..\EPLAN\Platform\[version]\Bin” Ordner ein:

  • Eplan.EplApi.AFu.dll
  • Eplan.EplApi.AFu.xml
  • Eplan.EplApi.Baseu.dll
  • Eplan.EplApi.Baseu.xml
  • Eplan.EplApi.DataModelu.dll
  • Eplan.EplApi.DataModelu.xml
  • Eplan.EplApi.EServicesu.dll
  • Eplan.EplApi.EServicesu.xml
  • Eplan.EplApi.Guiu.dll
  • Eplan.EplApi.Guiu.xml
  • Eplan.EplApi.HEServicesu.dll
  • Eplan.EplApi.HEServicesu.xml
  • Eplan.EplApi.MasterData.dll
  • Eplan.EplApi.Ppeu.dll
  • Eplan.EplApi.Ppeu.xml
  • Eplan.EplApi.Systemu.dll
  • Eplan.EplApi.Systemu.xml

In den Project Properties (Taste F4) kann man noch ein paar Einstellungen wie den Ausgabepfad, Format, Titel, Name etc. vornehmen.
Die Durchlaufzeit des Build-Prozesses kann je nach Rechnerleistung relativ hoch sein (Intel Core2, 2,4GHz ca. 50min).
Es werden auch Tausende Warnungen wegen fehlender Referenzen ausgegeben. Diesen bin ich nicht weiter nachgegangen. Das Ergebnis ist dennoch brauchbar.
Der User, und Migration Guide aus der Originaldoku fehlen. Der Rest scheint sehr ähnlich zu sein.
Man könnte so auch eigene Doku anfügen, oder sich nur die für das Scripting relevanten Bibliotheken (*.AFu.*; *.Baseu.*; *.Guiu.*) erzeugen.

Von |2017-11-09T11:22:20+01:002015-04-29|EPLAN, EPLAN-Scripts|
Nach oben