Kommandozeilen-Tools für ARIS Dokumentablage

ARIS Dokumentablage bietet eine Reihe von Kommandozeilen-Tools, die zum Durchführen von Administrationstätigkeiten verwendet werden können.

Bitte verwenden Sie y-admintool.bat für Windows-Betriebssysteme und y-admintool.sh für Unix-Betriebssysteme. Bei Unix-Betriebssystemen können Befehlszeilen-Tools (sh-Dateien) nur vom Benutzer aris10 gestartet werden. Beispiel: su -c y-admintool.sh aris10.

Allgemeine Verwendung

Optionen

Beschreibung

-?, -h, --help

Hilfe anzeigen, Standardwert: false

-s, --server

URL von ARIS Dokumentablage

-t, --tenant

ID des Mandanten. Der Standardwert ist default.

-umc, --umcserver

URL von User Management

Befehle

Beschreibung

Parameter

adjustTimestamps

Ändert den Zeitstempel, der beim Anlegen oder Aktualisieren von Dokumenten oder Ordnern festgelegt wird.

Der Zeitstempel wird bei einem Mandanten für alle Dokumente und Ordner geändert.

Verwendung: adjustTimestamps [options]

--password (-p) <KENNWORT>. Das Standardkennwort lautet manager.

--user (-u). Der Standardbenutzername lautet system.

* -offset

Versatz in Minuten, der hinzugefügt (+) oder abgezogen (-) werden soll, z. B.:

"-210". Der Standardwert ist "0".

anonymize

Anonymisiert die Benutzerinformationen bei Dokumenten und Ordnern

Verwendung: anonymize [options]

 

Dies ist DSGVO-konform. Die Datenschutz-Grundverordnung (DSGVO) schützt personenbezogene Daten des Einzelnen innerhalb der Europäischen Union. Sie reguliert zudem die Ausfuhr personenbezogener Daten an Standorte außerhalb der EU. Die DSGVO ist eine Verordnung des Europäischen Parlaments, des Rates der Europäischen Union und der Europäischen Kommission.

--password (-p) <KENNWORT>

Kennwort des Bearbeiters. Das Standardkennwort lautet manager.

Standardmäßig sind in ARIS Dokumentablage keine Zugriffsberechtigungen festgelegt. Alle Benutzer haben Zugriff auf sämtliche Ordner – einschließlich des Wurzelordners – und Dokumente. Sie können den Zugriff auf einzelne Ordner von ARIS Dokumentablage einschränken, damit nicht alle Benutzer von ARIS Dokumentablage auf alle Ordner und deren Inhalte zugreifen können.

Beachten Sie bitte:

Wenn Sie nur einen Benutzer aus der Benutzerliste oder aus Benutzergruppen löschen, die Zugriff auf den Ordner haben, und dann die Ordnerdaten anonymisieren, werden alle Aktionen im Zusammenhang mit den Ordnerdaten anonymisiert. Die Anonymisierung wirkt sich also nicht nur auf die Daten des gelöschten Benutzers aus.

Bevor Sie einen Benutzer löschen, rufen Sie die Benutzer-ID der jeweiligen Benutzers aus den Benutzerdetails in der Benutzerverwaltung ab.

* -n, --name

Name des Benutzers oder der Benutzergruppe

* -type, --type

Typ des Benutzers oder der Benutzergruppe

-u, --user

Benutzername

Kennwort des Bearbeiters. Das Standardkennwort lautet system.

Der Benutzername wird durch die Zeichenfolge anonymous ersetzt.

bulkimport

Importiert alle Dateien und Ordner aus einem bestimmten Verzeichnis nach ARIS Dokumentablage. Die Ordnerstruktur der Quelle wird beibehalten.

Verwendung: bulkimport [options]

Alternativ können Sie große Datensätze mit Hilfe eines Reports nach ARIS Dokumentablage importieren. Wenden Sie sich dazu an Ihre lokale Software AG-Vertriebsorganisation.

 

-a, --attributes

Erstellt Metadaten für jedes hochgeladene Dokument, z. B.: "description:initial upload for migration step|labels:big data,external,draft|source:sharepoint".

Dieses Beispiel zeigt, wie das Attribut Beschreibung definiert werden kann und dass benutzerdefinierte Attribute angelegt werden, sollten erforderliche Attribute standardmäßig nicht verfügbar sein (Titel, Beschreibung, Tags, Verantwortlicher). Das Zeichen | dient der Trennung der Werte. Es darf jedoch nicht innerhalb eines Wertes verwendet werden.

--password (-p) <KENNWORT>

Kennwort des Bearbeiters. Das Standardkennwort lautet manager.

--repository (-r) <Repository-Name>.

Das Standard-Repository ist das Portal-Repository, das in ARIS Dokumentablage oder in der Repository-Ansicht von ARIS Connect verwendet wird. Der Standardwert ist portal.

Das Ziel-Repository müssen Sie nur angeben, wenn Sie das Standard-Repository nicht verwenden.

Ein anderes Repository könnte z. B. das ARIS Risk & Compliance Manager-Repository sein.

-sw, --stopwatch

Aktiviert die Benchmark-Messung für den Reihenimport von Dokumenten und Ordnern.

Der Standardwert ist false.

--user (-u) <BENUTZERNAME>

Benutzername des Bearbeiters. Der Standardbenutzername lautet system.

-deltaimportfile

Delta-Import: Sind beim Importieren Fehler aufgetreten, wird eine Datei importerrors.log im aktuellen Arbeitsverzeichnis angelegt, z. B. ../tools/bin/importerrors.log. Um die in der Protokolldatei aufgelisteten Dokumente zu importieren, geben Sie Folgendes an:

 

 

-deltaimportfile "./importerrors.log".

In diesem Fall wird der Pfad-Parameter ignoriert und nur die Dateien, die in der Datei importerrors.log angegeben sind, werden importiert.

-logfile

Legt fest, wie der Name der Protokolldatei lauten soll, wenn der Parameter loglevel verwendet wird, z. B. %LOGS%adsimport.log.

Ist nichts angegeben, aber über den Parameter loglevel das Protokollieren aktiviert, wird die Datei adsimport.log im aktuellen Arbeitsverzeichnis gespeichert. Der Standardwert ist adsimport.log.

-loglevel

Legt das Log-Level für den Reihenimport von Dokumenten fest: Mit dem Wert standard werden nur Dokumentnamen und IDs protokolliert. Mit dem Wert hyperlinks werden auch die HTTP-Links von Dokumenten protokolliert. Der Standardwert ist none.

* -path

Verzeichnispfad, der für den Reihenimport von Dokumenten verwendet werden soll, z. B. C:/import/documents/. Vom letzten angegebenen Ordner an wird die Ordnerstruktur im Repository von ARIS Dokumentablage gespiegelt.

Beispiel: Wenn der Quellordner die Struktur C:/import/documents/folder1/folder2 aufweist, wird beim Ausführen des Kommandozeilen-Tools mit der Option -path in ARIS Dokumentablage die Struktur documents/folder1/folder2 erzeugt.

 

 

-overwrite

Wenn diese Option aktiviert ist (-overwrite true), werden bestehende Dokumente und Ordner gelöscht und gemäß der festgelegten Verzeichnisstruktur neu angelegt.

* -path

Der Verzeichnispfad, der für den Reihenimport von Dokumenten verwendet werden soll, z. B. C:/import/documents/. Vom letzten angegebenen Ordner an wird die Ordnerstruktur im Repository von ARIS Dokumentablage gespiegelt. Beispiel: Wenn der Ordner mit den zu importierenden Dokumenten die Struktur C:/import/documents/folder1/folder2 aufweist, wird beim Ausführen des Kommandozeilen-Tools mit der Option -path in ARIS Dokumentablage die Struktur documents/folder1/folder2 erzeugt.

-toplevelfolder

Ist diese Eigenschaft aktiviert, wird der oberste Ordner, der im Parameter -path angegeben wurde, beim Importieren ignoriert. Liegen die zu importierenden Dokumente unterhalb eines Ordners mydocs und wird z. B. der Pfad /mydocs/folder1/folder2 mit dieser Option verwendet, so wird beim Importieren nur die der mydocs-Ebene untergeordnete Ordnerstruktur gespiegelt und direkt unterhalb des Wurzelverzeichnisses in ARIS Dokumentablage angelegt. Ist diese Eigenschaft nicht aktiviert (Standardeinstellung), so wird der oberste Ordner auch im ARIS Dokumentablage-Repository gespiegelt, d. h., die gesamte Struktur /mydocs/folder1/folder2 wird unterhalb des Wurzelverzeichnisses angelegt. Der Standardwert ist false.

deleteAccessPrivileges

Löscht alle Zugriffsbeschränkungen für einen definierten Ordner.

Verwendung: deleteAccessPrivileges [options]

--folderId (* -f)

Die Ordner-ID wird benötigt, um alle Zugriffsrechte zu löschen.

--password (-p) <KENNWORT>. Das Standardkennwort lautet manager.

--user (-u). Der Standardbenutzername lautet system.

--user (-u) <BENUTZERNAME>

Benutzername des Bearbeiters. Der Standardbenutzername lautet system.

-orphandata

Löscht die Zugriffsrechte, die gelöschten Benutzergruppen zugewiesen sind. Der Standardwert ist false.

-passon

Löscht die Zugriffsrechte im Ordner hierarchisch. Der Standardwert ist false.

exportConfig

Exportiert die Konfiguration von ARIS Dokumentablage.

Verwendung: exportConfig [options]

--file (-f)

Konfigurationsdatei. Der Standardwert ist adsConfig.properties.

--password (-p) <KENNWORT>. Das Standardkennwort lautet manager.

--user (-u). Der Standardbenutzername lautet system.

importConfig

Aktualisiert die Konfiguration von ARIS Dokumentablage dieses Mandanten.

Verwendung: importConfig [options]

--file ( -f)

Die zu importierende Konfigurationsdatei. Der Standardwert ist adsConfig.properties.

--password (-p) <KENNWORT>. Das Standardkennwort lautet manager.

--user (-u). Der Standardbenutzername lautet system.

reindex

Reindiziert die ARIS Dokumentablage-Datenbank.

Verwendung: reindix [options]

--password (-p) <KENNWORT>. Das Standardkennwort lautet manager.

--user (-u). Der Standardbenutzername lautet system.

thumbnails

Legt Miniaturansichten für Bilder an.

Verwendung: thumbnails [options]

--password (-p) <KENNWORT>

Kennwort des Bearbeiters. Das Standardkennwort lautet manager.

--repository (-r) <Repository-Name>.

Das Standard-Repository ist das Portal-Repository, das in ARIS Dokumentablage oder in der Repository-Ansicht von ARIS Connect verwendet wird. Der Standardwert ist portal.

Das Ziel-Repository müssen Sie nur angeben, wenn Sie das Standard-Repository nicht verwenden.

Ein anderes Repository könnte z. B. das ARIS Risk & Compliance Manager-Repository sein.

--user (-u) <BENUTZERNAME>

Benutzername des Bearbeiters. Der Standardbenutzername lautet system.

Beispiel

y-admintool.bat -s http://my_aris_host.com:1080 -umc http://my_aris_host.com:1080 -t default bulkimport -u system -p manager -path d:\my_documents