Seite „Dokumentation“

Auf dieser Seite und deren Unterseiten geben Sie die für Sie wichtigen Information für das ObjektTätigkeiten und Abläufe, welche die Automation Engine steuert, werden mit Hilfe von sogenannten Objekten abgebildet (siehe auch Aufgabe). ein. Es können sowohl strukturierte als auch unstrukturierte Informationen eingegeben werden.

Wenn Sie den Tab Dokumentation öffnen, wird standardmäßig auch die Hauptseite, auf der Sie unstrukturierte Dokumentation eingeben, geöffnet. Zudem können auch zusätzliche Unterseiten für die Eingabe von strukturierter Dokumentation verfügbar sein. Die Anzahl und Art der für die Dokumentation des Objektes verfügbaren Unterseiten hängen von der Systemkonfiguration ab, da dies vom Systemadministrator im MandantAbgeschlossene Umgebung für die Erstellung und Durchführung von Objekten innerhalb eines Automation Engine-Systems. Der Name von Mandanten besteht aus einer vierstelligen Zahl, die bei der Anmeldung von Benutzern an das Automation Engine-System anzugeben ist. Benutzer und deren Berechtigungen werden ebenfalls in einem Mandant definiert.Auch ein eigener Objekttyp in der Automation Engine. 0 in der VariableSpeichert oder ermittelt Werte dynamisch zur Laufzeit. Auch ein eigener Objekttyp in der Automation Engine. UC_OBJECT_DOCU definiert wird. Unstrukturierte Seiten werden in Form von einfachen mit Kommata getrennten Werten definiert, während strukturierte Seiten durch mit Kommata getrennten Werten mit „@“ als Präfix definiert werden.

Unstrukturierte Dokumentation

Grundsätzlich erstellen Sie unstrukturierte Dokumentation, um im Objekt Wartungs- und Notfallinformationen als Freitexte einzugeben, um Anleitungen innerhalb der Automation EngineDiese Komponente steuert ein Automation Engine-System. Besteht aus verschiedenen Serverprozessen. bereitzustellen etc.

Strukturierte Dokumentation

Mittels der strukturierten Dokumentation können Sie umfangreiche Informationen zu einem Objekt in übersichtliche Teile aufgliedern. Auf den Seiten der strukturierten Dokumentation haben Sie die Möglichkeit, mit der Scriptsprache Automation Engine und unter Verwendung eines Script-Objekt (SCRI), Werte auszulesen. Die auf dieser Seite beinhalteten Parameter können dann von anderen ausführbaren Objekten abgefragt werden.

Sie können neben Attributen und Text auch Links zu Dateien, Ordnern, Dokumenten und zum Intranet oder Internet eingeben. Je nach den installierten Programmen und der KonfigurationEine Reihe von Komponenten, aus denen ein System besteht. Dazu gehören Informationen über die Verbindung der Komponenten einschließlich der angewendeten Einstellungen. des PCs werden die verlinkten Dateien und Dokumente in den zugehörigen Programmen und die URLs im Standardbrowser geöffnet.

Regeln und Konventionen

Bei der Benennung von Elementen und Attributen müssen die Namenskonventionen von XML beachtet werden. Das heißt, dass Sie alphanumerische Zeichen und die Zeichen „-“, „.“, „_“ verwenden können.

Folgende Regeln sind zusätzlich zu beachten:

Sie können eine strukturierte Dokumentation mit speziellen Script-Sprachmitteln (XML_*) auslesen

ClosedStrukturierte Dokumentation erstellen

Sie erstellen eine strukturierte Dokumentation, indem Sie für die Struktur Elemente und Unterelemente verwenden und Attribute mit Werten zu diesen Elementen hinzufügen.

  1. Öffnen Sie die Unterseite, in die Sie die strukturierten Informationen eingeben möchten. Die Anzahl der für diesen Zweck verfügbaren Unterseiten und der Name dieser Unterseiten hängen von Ihren Systemkonfigurationen ab.

    Die Funktionen, die für die Erstellung von Strukturen mit Elementen und Subelementen notwendig sind, werden in der Symbolleiste Dokumentation bereitgestellt.

  2. Erstellen Sie so viele Elemente und Subelemente, wie Sie benötigen:
    1. Klicken Sie in der Symbolleiste auf die Schaltfläche Neues Element und geben Sie den Elementnamen in dem sich öffnenden Dialog ein. Beachten Sie die zuvor beschriebenen Namensregeln und -konventionen. Erstellen Sie so viele Elemente, wie Sie benötigen:
    2. Sie haben zwei Möglichkeiten für die Erstellung von Subelementen:
      • Wählen Sie das Hauptelement aus, klicken Sie in der Symbolleiste auf die Schaltfläche Neues Subelement und geben Sie den Namen des Subelements im sich öffnenden Dialog ein. Es wird unter dem Hauptelement hinzugefügt.
      • Wählen Sie ein bestehendes Element aus, greifen Sie es im Auswahlbereich (im folgenden Screenshot rot markiert) auf und platzieren Sie es mittels Drag&Drop unter dem Hauptelement.

    3. Um die Reihenfolge der Elemente in der Baumstruktur zu verändern, ziehen Sie die Elemente mittels Drag&Drop auf die gewünschte Position.
    4. Klicken Sie auf die Schaltfläche Element löschen, um ein bestehendes Element zu löschen.
    5. Klicken Sie auf die Schaltfläche Element bearbeiten, um es umzubenennen.
    6. Klicken Sie auf die SchaltflächeElement duplizieren, um ein Element an genau derselben Stelle noch einmal zu erstellen.
  3. Fügen Sie den Elementen Attribute hinzu:
    1. Wählen Sie ein Element aus und klicken Sie auf die Schaltfläche Neues Attribut.
    2. Im Dialog Neues Attribut können Sie den Namen des Attributs eingeben und seinen Typ definieren:
      • Wählen Sie Text aus und geben Sie im nachstehenden Eingabefeld einen Wert ein.
      • Wählen Sie Aufzählung aus, um eine Dropdown-Liste mit den Werten zu erstellen, die Sie in die Tabelle eingeben:

        Um eine Zeile hinzufügen / bearbeiten zu können, muss diese zuerst mit Klick auf die Checkbox aktiviert werden. Danach stehen Ihnen folgende Optionen zur Verfügung:

        Option

        Beschreibung

        Fügt eine neue Zeile am Ende der Tabelle hinzu.

        Löscht die Zeile.

        Entfernt den Eintrag von der Liste und kopiert ihn in die Zwischenablage. Klicken Sie Einfügen, um ihn am Ende der Tabelle einzufügen.

        Dupliziert den Eintrag. Klicken Sie Einfügen, um ihn am Ende der Tabelle einzufügen.
        Aktiviert alle Zeilen in der Tabelle.

    3. Klicken Sie auf Hinzufügen, um das neue Attribut in die Liste der Attribute hinzuzufügen oder auf Hinzufügen und neues erstellen, um weitere Attribute zu definieren.
  4. Änderungen speichern.