Willkommen > Über die Automation Engine Dokumentation > Typographische Konventionen

Typographische Konventionen

Die nachfolgenden Schreibweisen werden verwendet, um ein einheitliches Erscheinungsbild und leichte Lesbarkeit der Automation Engine-Dokumentation zu gewährleisten:

Text

Beispiel Beschreibung
Option Login zu:,
Schaltfläche Hilfe, Registerkarte Inhalt

Namen von Schaltflächen, Feldern, Fenstern, Textfeldern, Symbolen, Steuerelementen, Spalten, Kennzeichnen, Login-Masken etc. werden fett gedruckt im beschreibenden Text hervorgehoben.

Automation Engine-Dokumentation;
nähere Informationen finden Sie im Kapitel Erste Schritte.


Kursivschrift wird verwendet für:

  • Produktnamen, Programmnamen
  • Namen von anderen Dokumenten, Kapitel, Büchertitel
  • Auswahlmöglichkeiten von Steuerelementen (Comboboxen, Radio Buttons, Checklisten, Checkboxen). Die Namen dieser Comboboxen etc. selber werden fett gedruckt hervorgehoben.
UC.MDB, Tabelle USR, UCXJR3?.INI In Beschreibungstexten werden Verzeichnisse, Signaturen, Ordner, Dateinamen, Programme oder Tabellen der AE-Datenbank in Großbuchstaben geschrieben. Das Zeichen "?" wird innerhalb von Dateinamen als Platzhalter verwendet.

IMAGE:TOOLS\BS2_TAR

Im beschreibenden Text werden Ordner, die sich auf der Auslieferungs-CD befinden, in der Form IMAGE:ORDNER und in Großbuchstaben geschrieben. IMAGE: ist ein Platzhalter für die Buchstaben des CD-ROM-Laufwerks, sowie der Ordnername, welcher der AE-Versionsnummer entspricht.

Beispiel: IMAGE:TOOLS\BROWSER entspricht R:\11.0.0\TOOLS\BS2_TAR

<system>AE</system>

Mit dieser Formatierung werden Auszüge aus Dateien gekennzeichnet (z.B. Reports, Konfigurationsdateien, usw.).

AE Script

Spezielle Konventionen gelten auch für die Beschreibung der Script-Sprache von AE. Sie werden immer dann zusätzlich zur allgemeinen Schreibweise verwendet, wenn innerhalb der Automation Engine-Dokumentation Script-Sprache erläutert wird.

Syntax für Beschreibung
Script-Anweisung und Funktionsnamen

Script-Anweisungs- und Funktionsnamen werden als fett formatierter Text dargestellt. Script-Anweisungen beginnen mit einem Doppelpunkt.

Einige Script-Anweisungen und Funktionen können in langer oder kurzer Form geschrieben werden. Wenn dies der Fall ist, werden die Script-Anweisung oder die Funktion mit dem optionalen Text für deren langen Namen in Klammern [ ] dokumentiert. Die Script-Anweisung :PRINT wird beispielsweise als :P[RINT] dokumentiert. Sie kann auf Wunsch als :PRINT oder auch als :P geschrieben werden.

Erforderliche Parameter

Erforderliche Parameter werden in fetter, dunkelroter Kursivschrift dargestellt. Beispiel: Object name.

In einigen Fällen sind einer oder mehr Parameter einer Teilmenge verforderlich. In diesem Fall werden die Parameter in fetter, dunkelroter Kursivschrift und eingeklammert [ ] dargestellt. Als Beispiel: Sie müssen den Aufgabennamen oder die laufende Nummer für die MODIFY_TASK Script-Funktion festlegen.

MODIFY_TASK (RunID, [task name], [running number], REPLACE_TASK, object name, [EXTERNAL, Workflow-Name])

Erforderliche Sonderzeichen

Erforderliche Sonderzeichen wie Klammern oder Gleichheitszeichen werden in fetter, dunkelroter Kursivschrift dargestellt. Im Beispiel unten stellt = den benötigten Qualifier zwischen den erforderlichen Parametern Eigenschaft und Wert dar.

:MODIFY_STATEProperty=Value

Optionale Parameter

Optionale Parameter werden in Klammern [ ] und kursiv geschrieben, zum Beispiel [Datum].

Wenn mehrere optionale Parameter gemeinsam genutzt werden, können Sie innerhalb einer [ ] Klammer aufgeführt werden, zum Beispiel [Kalender, Kalenderbegriff].

Begriff-Parameter

Begriff-Parameter werden in fetter Schrift dargestellt, zum Beispiel VERSION. Wenn es sich um optionale Begriff-Parameter handelt, werden sie auch in [ ] Klammern eingefügt; zum Beispiel [TERMINATE]. Der Text für Begriff-Parameter muss genau so geschrieben werden, wie angegeben.

Einige Begriff-Parameter können in langer oder kurzer Form geschrieben werden. In diesem Fall wird der Begriff-Parameter mit dem optionalen Text für seinen langen Namen in Klammern [ ] dokumentiert. Der Begriff-Parameter STR_SUBSTITUTE_VAR wird beispielsweise als STR_SUB[STITUTE]_VAR dokumentiert. Er kann als STR_SUBSTITUTE_VAR oder auch als STR_SUB_VAR geschrieben werden.

Kommata

Kommata trennen Script-Sprachmittel-Parameter. Script-Sprachmittel werden in der Reihenfolge ihrer Auflistung bewertet. Im Syntax-Beispiel unten trennen Kommata die einzelnen Parameter der CREATE_OBJECT Script-Funktion.

CREATE_OBJECT(Object Type, Object Name, [Folder], [Title])

Wenn Sie für einen optionalen Parameter keinen Wert festlegen möchten, fügen Sie nichts (oder ein Leerzeichen) zwischen den Kommata ein. Wenn Sie beispielsweise keinen Ordner spezifizieren möchten, dann geben Sie zwischen dem dritten und vierten Komma nichts an, wie unten dargestellt.

:SET&RET# = CREATE_OBJECT("CALE","FIRM.CALENDAR2015",,"Firm calendar for 2015")

Wenn Sie Werte für alle erforderlichen Parameter angegeben haben und keine Werte für die verbleibenden, optionalen Parameter einschließen möchten, müssen Sie diese nicht in Kommata einschließen. Wenn Sie beispielsweise ein Objekt erstellen möchten, ohne einen bestimmten Ordner oder Titel anzugeben, können Sie die schließende Klammer nach dem Objekt-Namenparameter setzen, wie unten dargestellt.

:SET &RET# = CREATE_OBJECT("CALE","FIRM.CALENDAR2015")

Leerzeichen Gelegentlich erfordern Scripts das Setzen von Leerzeichen. Wenn sie benötigt werden, sind sie Bestandteil der Syntax. Zusätzlich sind nicht benötigte Leerzeichen gelegentlich aus Gründen der Lesbarkeit in der dokumentierten Syntax enthalten. Sie können auf Wunsch diese und andere optionale Leerzeichen in Ihre Scripts aufnehmen, damit die Lesbarkeit verbessert wird.

Symbole

Folgend Symbole stehen zur Verfügung:

Symbol Beschreibung

Warnung, Hinweis auf mögliche Probleme.

Kritische Warnung (z.B. Systemabsturz, Datenbank-Inkonsistenz)

Bietet nützliche Informationen, Hinweise usw.

Schritte, die nur von Administratoren durchgeführt werden können

Kennzeichnet einen Arbeitsschritt, beispielsweise bei einer Installation.

Inkompatibilität

Weist auf Besonderheiten hin, die sich aufgrund des Berechtigungssystems ergeben (zum Beispiel Privilegien und Berechtigungen).

Tipps zur einfacheren Handhabung oder Verbesserung der Performance.

 


Automic Documentation - Tutorials - Automic Blog - Resources - Training & Services - Automic YouTube Channel - Download Center - Support

Copyright © 2016 Automic Software GmbH