Scriptor: Parameter

Einführung:

Ein Parameter ist eine Variable, die in Scripten mit der <%..%>-Syntax in JavaScript-Ausdrücken verwendet werden kann. Jeder Parameter kann in verschiedenen Konfigurationen verschiedene Werte annehmen.

Es gibt folgende Arten von Parametern:

  • “normale Parameter”.
    Diese müssen vom User definiert werden, ihre Werte ergeben sich nur aus den User-Einträgen für die verschiedenen Konfigurationen.
  • “interne Info-Parameter”:
    Diese sind SCRIPTOR automatisch bekannt, ihre Werte werden von SCRIPTOR automatisch bestimmt. Dazu gehört zum Beispiel die aktuelle Uhrzeit oder der gerade laufende Job
  • “interne Setup-Parameter”.
    Dies sind ebenfalls interne Parameter, denen der User aber in jeder Konfiguration einen Wert zugeweisen kann. Über diese Parameter werden SCRIPTOR Einstellungen mitgeteilt, ohne die er nicht funktionieren kann. (Zum Beispiel die Lage von temporären Verzeichnissen, oder der zu benutzende Texteditor für die Anzeige von Logfiles).
    Wenn der User die Defaultwerte überschreiben will, MUSS er sie selber nochmals definieren.
  • “Undefinierte, Script-lokale Parameter”
    Dies sind im Prinzip normale Parameter, die aber nicht global in SCRIPTORs-Tabellen, sondern direkt in einem Script mit der “<%define()%>”-Anweisung selbst definiert wurden.
    Da diese Parameter keinen Wert haben, wird dieser vor der Script-Ausführung vom User abgefragt.
     

Normale Parameter:

Diese werden definiert, in dem man sie in der Tabelle auf der Seite “Edit Parameter” eingeträgt:

Feld

Bedeutung

PARAMETER

Name des Parameters. Die Angabe eines Namens reicht schon, um einen Parameter zu definieren.

ReadOnly

Angabe, ob der Parameter durch JScript-Anweisungen geändert werden darf. Bei “Wahr” führt eine Anweisung wie
“<% parm = val; %>”
zu einem Fehler. Bei “Falsch” wird der Wert in der Datenbank verändert.

INFO

Beschreibung. Erscheint zum Beispiel bei der Parameterabfrage Maske als Hilfe

BEISPIEL

Beispielwert. Erscheint zum Beispiel bei der Parameterabfrage Maske als Hilfe

Parameter, deren Namen mit “DIR_” beginnen, werden als Namen von Verzeichnissen interpretiert. Auf Wunsch kann SCRIPTOR solche Verzeichnisse automatisch anlegen.

Parameter können auch ohne globale Definition verwendet werden, indem direkt im Script die Definition stattfindet. Das geschieht durcheinen primitiven “<%=parmname.%>- Ausdruck, oder durch die Anweisung “<%define(parmname%>”. Die Werte solcher Parameter werden immer vor der Ausführung vom User abgefragt.

Durch Druck auf den Knopf “Show references” scannt SCRIPTOR alle Scripte und Tabellenfelder und erzeugt einen Report, der die Verwendung jedes Parameters in der aktuellen Konfiguration aufzeigt. Dies hilft dabei, überflüssige Parameter zu entdecken.

Vorschlagsliste für Werte

In der unteren Tabelle “Predefined values” kann für jeden Parameter eine Liste von vordefinierten Werten angegeben werden. Diese Liste wird während der Werteingabe auf den anderen SCRIPTOR-Seiten dem Anwender zur Auswahl angeboten. Damit lässt sich in manchen Situationen das Anlegen von Konfigurationen beschleunigen. Ausserdem kann so die Eingabe auf bestimmte feste Werte begrenzt werden, was wichtig ist, wenn per JavaScript Test auf Parameterwerten durchgeführt werden.

Achtung: nach dem Ändern der Vorschlagsliste muss SCRIPTOR neu gestartet werden!

Konventionen für Parameternamen

Es ist sinnvoll, sich bei der Einführung neuer Parameter an folgende Namenskonventionen zu halten:

Der Parameter enthält:.

Schreibweise

ein Laufwerksbuchstaben

Prefix “DRIVE_”

ein Verzeichnis

Prefix “DIR_”. Dieses Prefix wird von SCRIPTOR ausgewertet, das Verzeichnis wird ggf. automatisch erzeugt.

eine Datei

Prefix “FILE_”

einen Registry-schlüssel

Prefox “REG_”

 

Liste der interne Parameter:

Name

Typ

Bedeutung

TMPDIR

Setup

Name des temporären Verzeichnisses, das SCRIPTOR benutzt.
Default: Wert der Umgebungsvariable TMP, oder TEMP, oder TMPDIR oder TEMPDIR.

TEXTEDITOR

Setup

Name des Texteditors/Viewers, den SCRIPTOR zum Editieren von Scripts und zum Anzeigen von Logdateien benutzt. SCRIPTOR übergibt als einzigen Kommandozeilen-Parameter den Dateinamen.
In TEXTEDITOR MUSS der Ausdruck
<%=CURRENT_FILE%> vorkommen, es sollte ein Editor gewählt werden, der auch
<%=CURRENT_LINE%> verarbeiten kann.
Default: “notepad.exe <%=CURRENT_FILE%>”

ERRORVIEWER

Setup

Wie TEXTEDITOR, wird aber benutzt, wenn Logfiles readonly geöffnet werden.

OS_TYPE

Setup

Code über die Plattform, für die SCRIPTOR Scripte erzeugt. Der Wert dieses Parameters beinflußt die Funktion von einigen internen JavaScript-Funktionen.
Default: “WIN”

CURRENT_USERNAME

Info

Der Name des Users, der SCRIPTOR ausführt.

CURRENT_ COMPUTERNAME

Info

Der NetBIOS-Name des Computers, auf dem SCRIPTOR ausgeführt wird.

CURRENT_YEAR

Info

Die jeweils aktuelle Uhrzeit. Kann benutzt werden, um z.B. Dateinamen von Archiven zu bilden.

CURRENT_MONTH

Info

 

CURRENT_DAY

Info

 

CURRENT_WEEKDAY

Info

 

CURRENT_HOUR

Info

 

CURRENT_MINUTE

Info

 

CURRENT_SECOND

Info

 

CURRENT_FILE

Info

Name des Scriptes, das gerade kopiert und ausgeführt wird, oder Name des Files im TEXTEDITOR-Parameter. Wird in der Regel im Tabellenfeld CMDLINE (Script-Ausführungs-Kommando) verwendet..

CURRENT_LINE

Info

Platzhalter für anzuspringende Zeilennummer im TEXTEDITOR-Parameter.

CURRENT_PARAMS

Info

Enthält die Parameter, die an ein Script abhängig vom Platz in einer Task übergeben werden sollen.
Wird durch den Wert im Tabellenfeld CURRENT_PARAMS gesetzt und in der Regel in CMDLINE (Script-Ausführungs-Kommando) verwendet..

CURRENT_LOGFILE

Info

Name der Datei, in der die Ausgabe aller Scripts geloggt wird. Wird durch den Kommandozeilenparameter “/LOGFILE” angegeben, oder vor dem Scriptlauf automatisch bestimmt.

CURRENT_SCRIPTOR

Info

Enthält den vollen Dateipfad des laufenden SCRIPTOR.EXE.
Bsp: “C:\utils\scriptor.exe”

"CURRENT_SCRIPTOR

Info

Enthält das Verzeichnisanteil von CURRENT_SCRIPTOR.
Bsp: “C:\utils\”

CURRENT_DATABASE

Info

Enthält den vollen Pfad der aktiven Datenbank (Microsoft Access MDB-Datei).

CURRENT_CONFIG

Info

Name der aktuellen Konfiguration, für die gerade ein Scriptlauf durchgeführt wird.

CURRENT_RUN

Info

Name des Jobs, der Task oder des Scripts, das gerade ausgeführt wird.

 

[Scriptor] [Parameter] [Konfigurationen] [Jobs und Tasks] [Scripts] [JavaScript] [Command line] [Designing conf hierarchy]