Dieser Artikel beschreibt die Verwendung des Administrator-Clients per Befehlszeilentool. Seit Version 2.1.1000 kann der Administrator-Client auch über eine grafische Oberfläche direkt aus dem Browser heraus gesteuert werden, siehe Administrator-Client UI.


Das R-S kann über einen nicht grafischen Administrator-Client(Konsole) von der Kommandozeile des Betriebssystems in Grundfunktionen administriert werden. Solche Grundfunktionen sind u.a.:

  • R-S Nutzer anlegen
  • für R-S Nutzer das Passwort ändern
  • Arbeitsbereiche anlegen
  • Arbeitsbereichen R-S Nutzer zuordnen
  • Produktions-Pakete aus dem R-S abrufen
  • Verwaltung von Binäry-Paketen
  • eine Liste der aktiven Nutzer abrufen
  • Abruf von Version-Informationen des R-S Clients und Servers
  • Verwaltung von Lock-Objekten
  • Prüf-Routinen zum Testen der Lock-Algorithmen
  • Abruf von Import-Paketen von Transaktions-Formularen
  • Systemaufgaben wie Reorganisation des Datei-Repository


Voraussetzung für den Start des Administrator-Client(Konsole) ist:

  • die Verfügbarkeit eines JAVA JRE ab der Version 1.6 auf dem Server wo der Administrator-Client(Konsole) ausgeführt wird
  • eine installierte Version des Administrator-Client(Konsole)
  • eine korrekt definierte Konfigurationsdatei 'rs.client.properties' des Administrator-Client(Konsole)


Konfigurationsdatei für den Administrator-Client(Konsole)

Die Konfiguration befindet sich in der Datei 'rs.client.properties', welche im gleichen Verzeichnis abgelegt sein muss, aus welchem der Administrator-Client(Konsole) gestartet wird. Diese Konfigurationsdatei entspricht im Aufbau einer Java-Properties-Datei. Folgende Einträge sind in dieser Konfigurationsdatei enthalten: 

Eintrag

Wert

Beschreibung

rs.server.protocol

http|https

Beschreibt das Protokoll, mit welchem auf das R-S zugegriffen werden soll

rs.server.host

xxx.xxx.xxx.xxx
localhost

Die IP-Adresse oder der Host-Name des Servers auf welchem das R-S arbeitet

rs.server.port

8080

Ist der TCP/IP-Port unter welchem das R-S mit entfernten Applikationen kommuniziert.

rs.server.user

admin

Ist der Nutzer-Name des System-Admininistrators des R-S (standardmäßig 'admin')

rs.server.password

admin

Ist das Passwort des System-Admininistrators des R-S (standardmäßig 'admin')

rs.client.workdir

runtime

Temporäres Verzeichnis 'unterhalb' des Arbeitsverzeichnisses des Administrator-Client(Konsole)


Start des Administrator-Client(Konsole)

Die Kommandozeile des Administrator-Client(Konsole) lautet wie folgt:

PATH_JRE\jre\bin\java -Djava.ext.dirs=lib;PATH_JRE/jre/lib/ext -cp config;rs-client.jar de.profiforms.rs.client.admin.AdminClientStarter KOMMANDO


Wobei PATH_JRE der Pfad zur JAVA JRE ist und mit KOMMANDO die auszuführenden Befehle des Administrator-Client(Konsole) gemeint sind.


Wir bei Ihnen nach Eingabe der Kommandozeile folgender Warnhinweis ausgegeben:

(Warnung) "log4j:WARN no appenders could be found for logger (org.springframework.core.io.support.PathMatchingResourcePatternResolver). log4j:WARN Please initialize the log4j system properly.

verwenden Sie statt obiger Kommandozeile:

(Haken) PATH_JRE\jre\bin\java -Dlog4j.configuration=file:AC_PATH/log4j.xml -Djava.ext.dirs=lib;PATH_JRE/jre/lib/ext -cp config;rs-client.jar de.profiforms.rs.client.admin.AdminClientStarter KOMMANDO

wobei AC_PATH der Pfad zur Administrator-Konsole ist.

Damit Umlaute oder Sonderzeichen bei der Eingabe über die Kommandozeile berücksichtigt werden, kann direkt hinter ..\bin\java die verwendete Codepage angegeben werden. Unter dem Telnet/SSH-Client PUTTY für UNIX ist die Codepage z.B. wie folgt zu setzen:  -Dsun.jnu.encoding=iso-8859-1 -Dfile.encoding=iso-8859-1

Im PUTTY kann die Codepage auch über die Konfiguration WINDOW/Translation eingestellt werden.


Kommandos des Administrator-Client(Konsole)

Starten Sie den Administrator-Client(Konsole) ohne ein Kommando, so erhalten Sie eine Liste der möglichen Kommandos als Hilfe angeboten. Hier eine Auflistung der Kommandos mit Kurzbeschreibung:

Kommando

Parameter

Kommando-Beschreibung

Parameter-Beschreibung

-createUser

<user-email/ID>
<password>
<firstname>
<lastname>

Erzeugt eines R-S Nutzer ohne Berechtigung auf Arbeitsbereiche.

<user-email/ID>
Ist der Nutzername des R-S Nutzers im R-S
<password>
Ist das Passwort des R-S Nutzers
<firstname>
Ist der Vorname des R-S Nutzers
<lastname>
Ist der Familienname des R-S Nutzers

-changePassword

<user-email/ID>
<oldpassword>
<newpassword>

Ändert das Passwort für einen bestehenden R-S Nutzer.

<user-email/ID>
Ist der Nutzername des R-S Nutzers im R-S
<oldpassword>
Ist das bisherige Passwort des R-S Nutzers
<newpassword>
Ist das neue Passwort des R-S Nutzers

-resetPassword

<user-email/ID>
<newpassword>

Setzt das Passwort für einen bestehenden R-S Nutzer zurück.

<user-email/ID>
Ist der Nutzername des R-S Nutzers im R-S
<newpassword>
Ist das neue Passwort des R-S Nutzers.

-createWorkspace

<name>

Erzeugt einen Arbeitsbereich mit dem angegebenen Namen im R-S.

<name>
Names des Arbeitsbereiches

-assignWorkspace

<workspace-name>
<user-email/ID>

Weist einen existierenden R-S Nutzer einem Arbeitsbereich zu.

<workspace-name>
Name des Arbeitsbereiches, welchem der R-S Nutzer zugeordnet werden soll
<user-email/ID>
Ist der Nutzername des R-S Nutzers im R-S

-assignWorkspaceAdmin

<workspace-name>
<user-email/ID>

Weist einem existierenden Arbeitsbereich einen R-S Nutzer mit administrativen Rechten zu.

<workspace-name>
Name des Arbeitsbereiches, welchem der R-S Nutzer als Administrator zugeordnet werden soll
<user-email/ID>
Ist der Nutzername des R-S Nutzers im R-S

-unassignWorkspace

<workspace-name>
<user-email/ID>

Entfernt einen R-S Nutzer aus dem angegebenen Arbeitsbereich.

<workspace-name>
Name des Arbeitsbereiches, aus welchem der R-S Nutzer entfernt werden soll
<user-email>
Ist der Nutzername des R-S Nutzers im R-S

-renameWorkspace

<old-workspace-name>
<new-workspace-name>

Benennt einen angegebenen Arbeitsbereich um.

<old-workspace-name>
Name des Arbeitsbereiches welcher umbenannt werden soll
<new-workspace-name>
der neue Name des Arbeitsbereiches

-fetchTXData

<destination-dir>
<tx form revision id>

Führt ein Download für ein Transaktions-Formular mit der angegebenen ID in das angegebene Verzeichnis durch.

<destination-dir>
Verzeichnis in welches das Transaktions-Formular abgelegt werden soll
<tx form revision id>
ID des Transaktions-Formulars im R-S

-fetchProductionBundleID

<destination-dir>
<bundle-id>

Führt ein Download für ein Produktions-Paket mit der angegebenen ID in das angegebene Verzeichnis durch.

<destination-dir>
Verzeichnis in welches das Produktions-Paket abgelegt werden soll
<bundle-id>
ID des Produktions-Paketes im R-S

-fetchProductionBundleDW

<destination-dir>
<contract>

Führt ein Download für ein Produktions-Paket mit der angegebenen Verfahrensnummer aus dem docxworld-System in das angegebene Verzeichnis durch.

<destination-dir>
Verzeichnis in welches das Produktions-Paket abgelegt werden soll
<contract>
Verfahrensnummer von docxworld

-fetchProductionBundleLink

<destination-dir>
<name>

Führt ein Download für ein Produktions-Paket mit dem angegebenen Namen aus dem OMS-/docxeed-System in das angegebene Verzeichnis durch.

<destination-dir>
Verzeichnis in welches das Produktions-Paket abgelegt werden soll
<contract>
Name des Produktions-Paketes aus der OMS-/docxeed-Umgebung

-listUsers


Zeigt alle im System vorhandenen R-S Nutzer an.


-listActiveUsers


Zeigt alle im System aktuell angemeldeten R-S Nutzer an.


-listWorkspaces


Zeigt alle im System vorhandenen Arbeitsbereiche an.


-listWorkspaceUsers

<workspace-name>

Zeigt alle einem Arbeitsbereich zugeordneten R-S Nutzer an.

<workspace-name>
Name des Arbeitsbereiches, für welchen die R-S Nutzer angezeigt werden soll

-listUserWorkspaces<user-email>Zeigt alle einem R-S Nutzer zugeordneten Arbeitsbereiche an.

<user-email>

Der Nutzername des R-S Nutzers,
für den die Arbeitsbereiche angezeigt werden sollen.


-scheduleGC


Startet den Reorganisations-Lauf für das Datei-Repository des R-S.


-scheduleStorageInfoUpdate


Startet die Abfrage für Informationen über den Status des Datei-Repositories und gibt diese auf Konsole aus.


-scheduleUserLocksCollector

—


-scheduleDBBackup

—


-createBinaryBundle<binary-file>Generiert ein Binär-Paket im R-S, welches zur Abarbeitung von Produktions-Paketen vorhanden sein muss.

<binary-file>
Dateiname des BinaryBundles.

-fetchBinaryBundle

<destination-dir>
<bundleid>

Ruft ein Binär-Paket aus dem R-S ab und legt es im angegebenen Verzeichnis ab.

<destination-dir>
Verzeichnis in welches das BinaryBundle abgelegt werden soll
<bundle-id>
ID des BinaryBundles im R-S

-deleteBinaryBundle<bundle-id>Entfernt ein Binär-Paket aus dem R-S.

<bundle-id>

Die ID des BinaryBundles, das aus dem R-S entfernt werden soll.

-listBinaryBundles
Zeigt alle im System vorhandenen Binär-Pakete an
-listAllLocks

Zeigt alle im System vorhandenen Locks an.


-removeLock<lock-id>Löscht einen im System vorhandenen Lock.

<lock-id>

Die ID des Locks, das aus dem System entfernt werden soll.

-removeAllLocks

Löscht alle im System vorhandenen Locks.

Wichtiger Hinweis : Damit können aktuelle Änderungen von Nutzern des R-S verloren gehen. Besser ist der Befehl '-removeLock' zu wählen, um ausgewählte Locks zu löschen.


-testSchemaRevisionConcurrentModifications

<schema-revision-id>
<threads-number>
<iteration-numbers>

Führt eine Prüfroutine zum Test von konkurrierenden Zugriffen auf das angegebene Schema-Version-Objekt durch.

<schema-revision-id>
ID der Schema-Version welche getestet werden solll
<threads-number>
Anzahl der gleichzeitig simulierten Nutzer
<iteration-numbers>
Anzahl der Zugriffs-Versuche pro simulierten Nutzer

-testTXFormRevisionConcurrentModifications

<txform-revision-id>
<threads-number><iteration-numbers>

Führt eine Prüfroutine zum Test von konkurrierenden Zugriffen auf das angegebene Transaktions-Formular-Version-Objekt durch.

<txform-revision-id>
ID der Transaktions-Formular-Version welche getestet werden solll
<threads-number>
Anzahl der gleichzeitig simulierten Nutzer

<iteration-numbers>
Anzahl der Zugriffs-Versuche pro simulierten Nutzer

-clientVersion
Zeigt die Version des aktuell installierten R-S Clients an.
-serverVersion
Zeigt die Version des aktuell installierten R-S Servers an.
-serverInfo
Zeigt Informationen über den R-S Server an.
-listFonts<workspace-name>Zeigt alle einem Arbeitsbereich zugeordneten Schriftarten an. Diese Schriftarten werden für die Verwendung in Bibliotheken benötigt.

<workspace-name>
Name des Arbeitsbereiches, für welchen die Workspace-Schriftarten angezeigt werden sollen

-createFont

<name>
<description><workspace-name>
<regular(y/n)>
<bold(y/n)>
<italic(y/n)>
<bolditalic(y/n)>


Registriert eine Schriftart für den Arbeitsbereich, welche durch Ressourcen von Bibliotheken genutzt werden kann.
Hinweis: In Schema-Versionen werden diese Fonts nicht zur Auswahl angeboten.

 <name>
Name der Schriftart
<description>
Eine Kurzbeschreibung für die Schriftart.<workspace-name>
Name des Arbeitsbereiches, in welchen die Workspace-Schriftarten registriert werden soll
<regular(y/n)>
Bestimmt, ob für die Schriftart das Attribut 'normal' angeboten werden soll
<bold(y/n)>
Bestimmt, ob für die Schriftart das Attribut 'fett' angeboten werden soll
<italic(y/n)>
Bestimmt, ob für die Schriftart das Attribut 'kursiv' angeboten werden soll
<bolditalic(y/n)>
Bestimmt, ob für die Schriftart das Attribut 'fett und kursiv' angeboten werden soll

  • Keine Stichwörter