Die Dokumentation ab Version 39.5.17 von PLANTA project finden Sie in der neuen PLANTA Online-Hilfe.
TWiki> Current Web>CustomizingDokumentation>CustomizingFunktionen>MakroBefehle

Makrobefehle

Achtung
  • In diesem Topic sind die Makro-Befehle und -Funktionen aus PPMS (Releases 3.8 und <3.8) aufgelistet.
  • Es werden nicht alle dieser Funktionen in PLANTA project unterstützt.
  • In PLANTA project wird empfohlen, anstelle von Makrozeilen ein Python-Makro zu customizen.

PPMS-Makrobefehle, die mit Python abgebildet werden können

Ab S 39.5.12

Befehl Beschreibung Wert
MOD Aufruf eines Moduls/eines Makros open_module(id)
MSG ON Ausgabe einer Dialogmeldung ui_message_id()
MSG OFF Blendet Dialogmeldungen aus  
DATA Fügt einen Wert ins aktive Datenfeld ein DataField class und seine Methoden: set_raw_value(value) und set_text_value(value)
DATAV Expandiert den Wert einer Variablen und schreibt ihn in das aktive Datenfeld Für das Auslesen der Variable: uvar_get()
Für das Schreiben DataField class und seine Methoden: set_raw_value(value) und set_text_value(value)
ECHO ON/OFF Aktiviert/Deaktiviert Ausgabe der Makrobefehle am Client NEU echo_enabled(), NEU echo_disabled()
LOOP/END LOOP Startet/Beendet eine Schleife Konstruktionen der Python-Sprache, wie if oder for
MENU Ruft einen Menüpunkt auf menu() Methode der Klasse Module
REPLY Gibt auf eine geöffnete Meldungs-Box eine Antwort durch die Angabe der Nummer des Buttons  
SETV Ersetzt eine Variable mit dem angegebenen Wert uvar_set()
SETVXY Ersetzt eine Variable mit dem Wert aus dem angegebenen Datenfeld uvar_set() und Methoden der Klasse Data field
SETT Fügt die definierte Zeichenkette in den Modultitel ein set_title_suffix() Methode der Klasse Module
TRACE ON1 Startet Nachverfolgung. Zeigt jeden Makrobefehl in der Dialogmeldung an. Der Makrobefehl kann ausgeführt oder nicht ausgeführt werden oder die ganze Makro-Ausführung kann zu einem bestimmten Zeitpunkt abgebrochen werden.  
TRACE OFF Ende Nachverfolgung  
WAIT Wartet die angegebene Anzahl von Sekunden mit der Ausführung jedes Makrobefehls

sleep(n)

Konstruktion der Python-Sprache

Bis S 39.5.12

Befehl Beschreibung Wert
MOD Aufruf eines Moduls/eines Makros open_module(MODULE_ID)
MSG ON Ausgabe einer Dialogmeldung ui_message_id()
MSG OFF Blendet Dialogmeldungen aus  
DATA Fügt einen Wert ins aktive Datenfeld ein DataField class und seine Methoden: set_raw_value(value) und set_text_value(value)
DATAV Expandiert den Wert einer Variablen und schreibt ihn in das aktive Datenfeld Für das Auslesen der Variable: uvar_get()
Für das Schreiben DataField class und seine Methoden: set_raw_value(value) und set_text_value(value)
ECHO ON/OFF Aktiviert/Deaktiviert Ausgabe der Makrobefehle am Client echo_on(), echo_off()
LOOP/END LOOP Startet/Beendet eine Schleife Konstruktionen der Python-Sprache, wie if oder for
MENU Ruft einen Menüpunkt auf menu() Methode der Klasse Module
Ein Customizingbeispiel für MENU154 finden Sie hier
REPLY Gibt auf eine geöffnete Meldungs-Box eine Antwort durch die Angabe der Nummer des Buttons  
SETV Ersetzt eine Variable mit dem angegebenen Wert uvar_set()
SETVXY Ersetzt eine Variable mit dem Wert aus dem angegebenen Datenfeld uvar_set() und Methoden der Klasse Data field
SETT Fügt die definierte Zeichenkette in den Modultitel ein set_title_suffix() Methode der Klasse Module
TRACE ON1 Startet Nachverfolgung. Zeigt jeden Makrobefehl in der Dialogmeldung an. Der Makrobefehl kann ausgeführt oder nicht ausgeführt werden oder die ganze Makro-Ausführung kann zu einem bestimmten Zeitpunkt abgebrochen werden.  
TRACE OFF Ende Nachverfolgung  
WAIT Wartet die angegebene Anzahl von Sekunden mit der Ausführung jedes Makrobefehls

=sleep(n)=

Konstruktion der Python-Sprache

Makrobefehle (<3.8)

Befehl Beschreibung Wert
CONT Eine Meldung fragt während des Makros, ob dieses fortgeführt werden soll. Der Benutzer hat die Möglichkeit, an dieser Stelle das Makro zu unterbrechen. (z.B. Bei automatischem Löschen nach Übertrag von Daten.)  
DATA
  • Füllt ein Wert in ein Datenfeld.
  • Erfordert, dass bereits ein Eingabefeld aktiv ist z.B. durch den vorherigen Befehl GOTO.
 <Eingegebener Wert>
DATAV Expandiert den Wert einer Variablen und schreibt ihn in ein Datenfeld. <@ Variable>
DEBUG
  • Startet/Beendet eine Server-Logdatei
  • Startet/Beendet das Sammeln von statistischen Daten
  • DEBUG kann abhängig vom Wert die Aufzeichnung von Laufzeitdaten pro Ereignis aktivieren und deaktivieren bzw. die Aufzeichnung der Server-Logdatei steuern.
 0 = Beendet die Logdatei

1 = Startet die Logdatei

2 = Server-Logdatei mit zusätzlichen Informationen wird aktiviert.

PERF ON = Startet das Sammeln von statistischen Daten

PERF OFF = Beendet das Sammeln von statistischen Daten.
DUMPSCREEN Druckt das gesamte Hauptfenster der Software in die angegebene Datei. Voraussetzungen für DUMPSCREEN:
  • Die Pfadangeben können relativ oder absolut sein.
  • Word6 muss über PATH (autoexec.bat) erreichbar sein.
  • Im Startverzeichnis vom pmsgui (d.h., dort wo die Datei pmsgui.ini steht) muss ein leeres Word6-Dokument mit dem Namen pscreen.doc enthalten sein.
 Pfad und Dateibezeichnung, wo die Screenshots abgelegt werden sollen.
ECHO OFF Ab diesem Befehl werden alle weiteren Makrobefehle ohne Ausgaben am Client ausgeführt.
  • Betätigen von ESC führt nicht zum Abbruch, unabhängig von der Dauer der Operationen innerhalb des Makros.
  • Es werden keine Statusmeldungen ausgegeben.
  • ECHO OFF gilt auch für sämtliche Unter-Makros, die in einem Makro aufgerufen werden.
  • Während des Makrolaufs ist der Programm-Client für Benutzereingaben gesperrt. Der Makro-Cursor wird angezeigt.
 Hinweise:
  • Innerhalb eines Makros darf das ECHO auch mehrmals aus- und eingeschaltet werden, um z.B. zwischendurch Dialoge an den Anwender auszugeben oder Anwenderentscheidungen abzuholen.
  • Mit den Befehlen MSG ON und MSG OFF kann eine spezielle Tätigkeitsanzeige-Box gecustomized werden, die unmittelbar vor dem ECHO OFF ausgegeben wird. Die Handhabung ist mit der Funktion MSG ON und MSG OFF beschrieben. Diese Box hat keinerlei Button, sie wird durch den Makrobefehl MSG OFF oder das Enden des Makros wieder entfernt.
ECHO ON
  • Der Befehl hebt die Unterdrückung der Ausgaben am Client wieder auf. Alle danach laufenden Makrobefehle sind wieder für den Benutzer sichtbar.
  
END LOOP
  • Beendet eine Schleife, die mit LOOP angefangen wurde.
  
GOTO
  • Es kann nur zu vorhandenen Eingabefeldern gesprungen werden.
 <Fenster> <Feld-Nummer> Beispiel: Es soll im Fenster 2 in das dritte Inputfeld gesprungen werden. Eingabe Wert: 2 3 (zwei, blank, drei)
INBX
  • Ermöglicht das Eingeben eines Wertes in das Abfragefeld einer Dialogbox.
  • Anwendung: Operation bei Kopieren;
  • Beispiel: Division durch: <Wert>
 <Wert>
LOOP
  • Starten einer Schleife
  • Es werden alle Makrobefehle ab dem LOOP-Befehl wiederholt bis das END-LOOP-Kriterium erfüllt ist.
 
MENU
  • Es kann jeder Menüpunkt ausgeführt werden, d.h., auch Menüpunkte die in einem Modul deaktiviert sind.
 <Menüpunkt-Identnummer>
MOD MODULE
  • Es können nur Module aufgerufen werden, die im für den jeweiligen Benutzer gültigen Benutzer-Menü enthalten sind. Auf diese Weise wird die Zugriffsberechtigung berücksichtigt.
  • MODULE kann auch den Wert einer globalen Variable ausführen.
    • Damit ist es möglich, Module aufzurufen, die zuvor mit SETVXY aus einer Liste ausgelesen wurden.
 <Modul-Identnummer>
MSG ON
  • Ausgabe von Dialogmeldungen in einem Makro.
  • Dialoge und Benutzerentscheidungen sind somit in Software-Makros customizebar.
 <Dialogmeldung-Identnummer>
MSG OFF
  • Dieser Befehl wirkt nur auf Dialogmeldungen der Art Tätigkeitsanzeige-Box (Button-Art = 5). Die betreffende Box wird durch den Befehl MSG OFF geschlossen.
  • Für normale Dialogmeldungen wird MSG OFF nicht verwendet. Diese Meldungsboxen werden durch den Anwender mit Klicken auf Ok, Ja, Nein und Zurück beantwortet.
  
REPLY
  • Gibt auf eine geöffnete Meldungs-Box eine Antwort. Die Nummer zählt von links nach rechts.
  • Während des Makro-Ablaufs bleiben solche Boxen unsichtbar.
 <Button-Nummer> WERTE: 1=JA oder OK 2=NEIN 3=HILFE
SETV Ersetzt den Wert der Variable gegen den hier angegebenen Eingabe: <Wert>
  • Sonderfall bei Listenvariablen @L:
    • Ersetzt den Inhalt der Variable durch die durch Komma getrennten Werte:
      • SETV <@L-Variable> = a,b,c
  • SETV mit dem Wert @19=xxxx stellt die Benutzersprache für alle anschließend ausgeführten Module bis zur Benutzerneuanmeldung oder einen weiteren gleichartigen Befehl um.
    • Dadurch werden nur die anschließend aufgerufenen Daten und Module in der neuen Sprache angezeigt.
    • Bei I-Texten in Modulen wirkt der Befehl erst nach Modulaufruf vollständig.
 <Variable> = <Wert>
SETVXY
  • Liest den Wert eines DF in eine Variable.
  • Die Variable erhält den Wert des Y-ten Eingabefeldes in Datenbereich X.
  • SETVXY wirkt im Gegensatz zu GOTO auch auf Ident- und Outputfelder.
  • SETVXY kann nur aus dem ersten Datensatz eines Datenbereichs auslesen
  • Die Positionsnummer des DFs ist unabhängig vom DF-Typ.
 @xxxx X Y Beispiel: Es soll im 3.Dber in das 5. Feld gesprungen werden. Eingabe Wert: 3 5 (drei, blank, fünf)
SETT
  • Die durch SETT erzeugte Zeichenkette kann verwendet werden in
    • Modultitel
    • Druck und Druckvorschau
    • Defaultdateiname bei Verwendung eines pdf-Druckers
  • Falls das Zeichen @ in der erzeugten Zeichenkette angezeigt werden soll, muss das Zeichen doppelt verwendet werden. Beispiel: user@@domain.de
  • Die durch SETT erzeugte Zeichenkette wird in der globalen Variablen @G54 gespeichert. Der Modultitel wird in @G26 gespeichert.
  • SETT funktioniert dann nicht, wenn Optionsmodule mit geöffnet werden
  • Es ist möglich, mit SETT den Modultitel um den Inhalt einer globalen Variable zu erweitern
 <Text> <@Gxxx> <Text> <@Gyyy>...
STATISTIC Startet/Beendet eine Kurzstatistik. STATISTIC legt für alle zwischen STATISTIC ON und STATISTIC OFF aufgetretenen Ereignisse einen Summen-Datensatz an. Dieser ist am Ereignis STATISTIC erkennbar. ON = Startet Statistik OFF = Beendet Statistik
SUSPEND Unterbricht die Makro-Ausführung solange bis der Benutzer den Menüpunkt Makro weiter wählt. Wird während eines unterbrochenen Makros ein anderes Makro manuell aufgerufen, kann das unterbrochene Makro nicht mehr fortgesetzt werden.  
TRACE ON1
  • Startet Nachverfolgung
  • Hilfsreich bei der Fehleranalyse in Makromodulen
  • Vor dem Aufruf jeder Makrozeile erscheint eine Meldung
  
TRACE ON2 Startet eine Dialogmeldung Abhängig von der Benutzereingabe in der Dialogmeldung verzweigt das Makro.
  • JA = ausführen der folgende Zeile.
  • NEIN = Sprung zu TRACE OFF
  • Zurück = Makro vollständig abbrechen Hinweis:
  • Diese Funktion wird nicht mehr verwendet, Dialogmeldungen werden mit dem Befehl MSG ON aufgerufen.
  
TRACE OFF Ende Nachverfolgung  
WAIT Wartet die angegebene Anzahl von Sekunden mit der Ausführung jedes Makro-Befehls. Der Befehl kann durch einen weiteren WAIT- Befehl deaktiviert werden (z.B. WAIT 0). Kann für selbstablaufende Vorführungen verwendet werden. <sec>
#
  • Durch # können Makrozeilen auskommentiert werden, d.h., sie werden vom Makro nicht mehr angesprochen.
  • Ermöglicht es, beliebige Kommentare in ein Makro einzufügen. Die Makroausführung wird mit dem folgenden Befehl fortgesetzt.
 <Kommentar>

Hinweis

  • In der Listbox des Datenfeldes Wert werden die Menüpunkte bzw. die MENU-Werte und Ihre Bedeutung aufgelistet.

         PLANTA project







 
  • Suche in Topic-Namen

  • Suche in Topic-Inhalten
This site is powered by the TWiki collaboration platform Powered by Perl