Was ist scriptrunner.cfg?

Im folgende Beispiel wird der Report Prozesshandbuch für ein Prozessmodell der Demo-Datenbank United Motor Group mit Script Runner ausgeführt.

Dazu wurden die fett ausgezeichneten Einträge in der Datei ARIS-Client-Installationsverzeichnis/tools/scriptrunner/scriptrunner.cfg.template angepasst und im Client-Installationsverzeichnis als scriptrunner.cfg gespeichert.

Hinweise zur Parametereingabe werden eingeblendet, wenn Sie auf einen Link klicken.

Nachdem Sie die Beispieldatei scriptrunner.cfg angepasst und im selben Verzeichnis wie die Datei scriptrunner.bat und scriptrunner.sh gespeichert haben, starten Sie scriptrunner abhängig von Ihrem Betriebssystem. Öffnen Sie die Eingabeaufforderung im ARIS-Client-Installationsverzeichnis/tools/scriptrunner und geben für Microsoft® Windows®-Betriebssysteme Folgendes ein:

scriptrunner.bat scriptrunner.cfg

oder für Linux®-Betriebssysteme:

scriptrunner.sh scriptrunner.cfg

Nach Abschluss der Aktion finden Sie die Ausgabedatei im definierten Verzeichnis D:/Evaluations/Reports/example.pdf.

Beispieldatei 'scriptrunner.cfg'

#client home directory (to be changed if needed)

client.home=.

Client-Installationsverzeichnis.

Die vorgegebene Einstellung (.) darf nur beibehalten werden, wenn Sie die Datei scriptrunner.bat aus dem ARIS-Client-Installationsverzeichnis/tools/scriptrunner starten werden.

# server to connect to.

scriptrunner.servername=aris3.eur.ad.abc

Name des ARIS-Servers, auf dem das Skript ausgeführt wird und auf dem die auszuwertenden Modellierungsdaten gespeichert sind.

Geben Sie den voll qualifizierten Namen oder die IP-Adresse ein.

# port the server is listening

scriptrunner.serverport=80

Portnummer für die Verbindung zum ARIS-Server.

Standardmäßig ist bei der Installation der Port 80 gewählt. Falls ihr Systemadministrator eine andere Portnummer zugewiesen hat, müssen Sie diese hier eintragen.

# to use ssl set to true

scriptrunner.serverssl=false

Aktiviert die SSL-Verschlüsselung (SSL: Secure Socket Layer), damit die Daten zwischen ARIS-Server und ARIS-Client verschlüsselt übertragen werden.

Standardmäßig ist diese Option deaktiviert. Um SSL zu verwenden, tragen Sie den Wert true ein.

# tenant to use

scriptrunner.tenant=default

Gültiger Mandant, der dem Benutzer abhängig von dessen Lizenz eine bestimmte Funktionalität und bestimmte Daten zur Verfügung stellt.

In diesem Beispiel heißt der Mandant default.

# Username for login. Use the login of the user who executes the report here.

scriptrunner.username=system

Benutzername und Kennwort des Benutzers, mit dem die Anmeldung erfolgen soll.

In diesem Beispiel erfolgt die Anmeldung als Systembenutzer system.

Geben Sie hier den gewünschten Benutzernamen ein. Dieser Benutzer benötigt ausreichende Lizenz-, Funktions- und Zugriffsrechte.

# Password for login. Use the password of the user who executes the report here. Can/should be encrypted.

scriptrunner.userpassword={crypted}d12173f23e5f6e5d3cf163169b1068a4

Kennwort des Benutzers, mit dem die Anmeldung erfolgen soll.

In diesem Beispiel erfolgt die Anmeldung mit dem Systembenutzer system und dem Kennwort manager (hier: {crypted}d12173f23e5f6e5d3cf163169b1068a4).

Geben Sie hier das Kennwort des Benutzers an, mit dem der Report ausgeführt werden soll. Kennwörter sollten Sie aus Sicherheitsgründen mit Hilfe des ARIS Server Administrator-Befehls encrypt verschlüsseln.

# Database name to login.

scriptrunner.dbname=United Motor Group

Name der Datenbank für die oder für deren Elemente der Report gestartet werden soll.

In diesem Beispiel United Motor Group. Falls Sie keinen Zugriff auf diese Datenbank haben, kann sie von Ihrem Systemadministrator zur Verfügung gestellt werden. Die Demo-Datenbank befindet sich im ARIS-Installationspaket.

# GUID of methodfilter for login. No entry (default) is "entire method".

scriptrunner.methodfilterguid=dd838074-ac29-11d4-85b8-00005a4053ff

GUID des Methodenfilters. In diesem Beispiel dd838074-ac29-11d4-85b8-00005a4053ff. Wenn Sie an dieser Stelle keine GUID eintragen, wird automatisch der Filter Gesamtmethode verwendet.

Die GUID eines Filters erhalten Sie auf der Registerkarte Administration, wenn Sie mit der rechten Maustaste auf den gewünschten Filter klicken und Bearbeiten wählen.

# Locale for database login. ISO 639 code for language.

scriptrunner.dblocale=de

ISO 639-1-Code für die Datenbankpflegesprache, die für den Report verwendet werden soll.

In diesem Beispiel ist de für Deutsch gewählt.

Optional können Sie mit dem Eintrag scriptrunner.dblocale.country= das Land angeben, in dem die Sprache gesprochen wird.

# Locale for database login. ISO-3166 code for country (optional).

#scriptrunner.dblocale.country=DE

ISO-3166-Code für das Land, in dem die Sprache gesprochen wird (optional).

In diesem Beispiel ist DE für Deutschland gewählt.

# oem identifier (do not change)

#scriptrunner.oemprofile=oem01

Interne Bezeichnung.

Bitte ändern Sie den Eintrag auf keinen Fall, um Fehlfunktionen auszuschließen.

# Locale for script stringtable and error messages. ISO 639 code for language.

scriptrunner.guilocale=de

ISO 639-1-Code für die Oberflächensprache, in der Fehlermeldungen und Texte des Reports angezeigt werden. Sie bestimmt die Registerkarte der Sprache für die String-Tabelle im Skripteditor.

In diesem Beispiel ist de für Deutsch gewählt.

# Locale for script stringtable and error messages. ISO -3166 code for language. (optional)

scriptrunner.guilocale.country=DE

ISO-3166-Code für das Land, in dem die Sprache gesprochen wird (optional).

In diesem Beispiel ist DE für Deutschland gewählt.

# Script component - id. Default is 'Report' (value = 1). Optional 'static publisher' (value = 10).

# scriptrunner.component=1

# GUID of script to execute.

scriptrunner.scriptid=f1253ea0-1c0f-11dd-3a64-0015582c76ab

GUID des auszuführenden Reportskriptes.

In diesem Beispiel für das Beispielskript Prozesshandbuch (f1253ea0-1c0f-11dd-3a64-0015582c76ab).

Die GUID eines Skriptes erhalten Sie auf der Registerkarte 'Administration', wenn Sie mit der rechten Maustaste auf das Skript klicken und Eigenschaften wählen.

Bitte verwenden Sie nur Reporte, für die das Kontrollkästchen Öffnet Dialoge auf der Eigenschaftsseite Allgemein deaktiviert ist.

# Outputformat ID, defaults to -1 (no output)

# 0 = RTF

# 2 = Text

# 3 = HTML

# 4 = MS Word

# 5 = MS Excel

# 7 = other

# 8 = XML

# 9 = PDF

# -1 = No output

scriptrunner.outputformat=9

Definiert das Format der Ausgabedatei.

In diesem Beispiel wird das Ausgabeformat PDF (9) verwendet.

# path and name of outputfile. Only relevant if outputformat != -1

scriptrunner.outputfile=D:/Evaluations/Reports/example.pdf

Pfad und Name der Ausgabedatei.

In diesem Beispiel wird der Eintrag D:/Evaluations/Reports/example.pdf verwendet. Falls der eingegebene Pfad nicht existiert, wird er ohne Nachfrage angelegt. Stellen Sie sicher, dass Sie für den Zielpfad zugriffsberechtigt sind.

# GUID of evaluation filter (optional)

scriptrunner.evaluationfilterguid=

GUID des Auswertungsfilters, mit dem Sie Elemente von der Auswertung ausschließen können. In diesem Beispiel wird kein Auswertungsfilter definiert.

Die GUID eines Filters erhalten Sie auf der Registerkarte 'Administration', wenn Sie mit der rechten Maustaste auf den gewünschten Filter klicken und Bearbeiten wählen.

# IDs of objects to start the script on. Separated by ';'

# DB : the script is to be run on a database context (database is specified by srciptrunner.dbname property)

# F:[GUID]: for scripts running on "configuration filter" context a configuration filter is specified by "F:" directly followed by the filter GUID

# G:[OID] : for scripts running on group objects: their OIDs, each preceded by "G:"

# M:[GUID]or[OID] : for scripts running on models: their OID or their GUID, each preceded by "M:"

# O:[GUID]or[OID] : for scripts running on object definitions: their OID or their GUID, each preceded by "O:"

# examples:

# scriptrunner.scriptinput=DB

# scriptrunner.scriptinput=F:f98555a9-6158-11d4-8582-00005a4053ff

# scriptrunner.scriptinput=G:

# scriptrunner.scriptinput=M:abababab-cdcd-efef-a1a2-b1b33fce23e5;M:ef2579bd-cdcd-efef-a1a2-b1b33fce23e5

# scriptrunner.scriptinput=O:abababab-cdcd-efef-a1a2-b1b33fce23e5;O:ef2579bd-cdcd-efef-a1a2-b1b33fce23e5

scriptrunner.scriptinput=M:bf2a9d60-7cb8-11dc-2729-000bcd0cce4e

Definiert das Datenbankelement für das der Report gestartet werden soll.

Syntax: <Elementtyp>:<GUID>

Zum Auswerten mehrerer gleicher Datenbankelemente trennen Sie die Einträge jeweils durch ein Semikolon (;) ab. Beispiele finden Sie als Kommentare in der Datei.

In diesem Beispiel wird das Prozessmodell der Datenbank ausgewertet, M:c45e1bd1-eff6-11e0-1cef-0025b3bf9d9d. M: steht für Modell gefolgt vom GUID des Modells.

Den GUID erhalten Sie auf der Eigenschaftsseite Information des Modells.

# User-defined properties. Can be accessed in script using Context.getProperty("propertyname")

scriptrunner.userproperty.count=0

Einstellung zum Aufruf von Texten, die Sie in den Zeilen scriptrunner.userproperty<Nummer>.key= und scriptrunner.userproperty<Nummer>.value= definieren können.

Ändern Sie den Eintrag 0 nur , wenn Sie in selbstgeschriebenen Reportskripten den Aufruf Context.getProperty("<Wert des Schlüssels>") verwenden.

Wenn Sie z. B. die folgenden Texte und Schlüssel gepflegt haben:

scriptrunner.userproperty.count=2

scriptrunner.userproperty1.key=send_mail

scriptrunner.userproperty1.value=true

scriptrunner.userproperty2.key=Extratext

scriptrunner.userproperty2.value=Gestartet mit scriptrunner.bat

können Sie diese Texte im Skript wie folgt abfragen:

var text = Context.getProperty("Extratext") //liefert "Gestartet mit dem scriptrunner.bat"

if("true"==Context.getProperty("send_mail")

sendMail();

# as many user-defined properties as specified in scriptrunner.userproperty.count.

# syntax:

#scriptrunner.userproperty1.key=

#scriptrunner.userproperty1.value=

#scriptrunner.userproperty2.key=

#scriptrunner.userproperty2.value=

#...