Zum Inhalt

Skripte

Die imperia-Admin-Skripte#

Die imperia-Admin-Skripte sind als Werkzeuge für Systemadministratoren gedacht. Sie können damit häufig auszuführende Aufgaben vereinfachen. Zur Ausführung rufen Sie das betreffende Skript von der Kommandozeile aus auf. Sie liegen im Verzeichnis site/bin Ihrer imperia-Installation. Ein Zugriff über die imperia-Benutzeroberfläche ist nicht möglich.

Wichtig

  • Legen Sie vor der Verwendung der Admin Skripte ein Backup an bzw. stellen Sie sicher, dass ein aktuelles Backup existiert.
  • Außerdem sollte imperia im Wartungsmodus laufen, siehe auch Wartungsmodus mit Superuser-Zugriff.

Die Skripte liegen alle im Verzeichnis site/bin. Eine Erklärung zu ihrer Anwendung und zu den jeweils verfügbaren Optionen erhalten Sie mit dem Aufrufparameter -h bzw. --help . Zum Beispiel:

admin_accesscat.pl --help

Alte oder veraltete Skripte werden umbenannt in script_name.pl.000, wenn die neuste install.pl ausgeführt wird. Im Zweifel kann einfach das site/bin-Verzeichnis gelöscht werden und die aktuellste install.pl ausgeführt werden.

admin_accesscat.pl#

Mit diesem Skript können Sie die Zugriffsrechte für eine Rubrik anzeigen lassen und ändern.

admin_accesselement.pl#

Das vorgesehen Format ist beispielsweise:

    site\bin\admin_accesselement.pl template:Movies id:1:r name:Editor:rw

Wobei der erste Parameter des Typs <type>:<name/id> +/- RIDENT ist.

admin_accessmeta.pl#

Legen Sie die Zugriffsrechte für eine Meta-Datei fest oder lesen Sie die gegenwärtigen Zugriffsberechtigungen.

admin_accesstemplate.pl#

Mit diesem Skript ändern Sie die Zugriffsrechte für ein Template oder lesen die aktuelle Konfiguration aus.

admin_accessworkflow.pl#

Mit diesem Skript ändern oder lesen Sie die Zugriffsrechte für einen Workflow(-Metafile).

admin_acl_update.pl#

Mit diesem Skript löschen Sie alte, nicht mehr gültige Gruppen aus den ACLs.

admin_addcat.pl#

Mit diesem Skript legen Sie eine neue Rubrik oder Unterrubrik an.

Die Eigenschaften der neuen Rubrik definieren Sie mit Hilfe der Aufrufparameter. Dabei sind alle Angaben optional. Einzige Ausnahme ist der Rubrikname, den Sie angeben müssen.

Bei Unterrubriken müssen Sie zusätzlich den eindeutigen Namen oder die ID der übergeordneten Rubrik angeben.

Bitte beachten

Nach der Verwendung von admin_addcat.pl sollten Sie die Rubrikenrechte mit dem Skript admin_accesscat.pl einrichten.

admin_adddoc.pl#

Mit diesem Skript erstellen Sie ein neues Dokument, dessen Attribute Sie über die Aufrufparameter festlegen. Per Default wird anschließend der Workflow für das neue Dokument angestoßen. Dies können Sie jedoch auch durch einen Parameter unterbinden.

admin_addgroup.pl#

Mit diesem Skript legen Sie eine neue Gruppe an. Den Namen der neuen Gruppe und einen Kommentar können Sie beim Aufruf des Skriptes übergeben.

Nutzen Sie das Skript admin_grpuser.pl (siehe admin_grpuser.pl), um Benutzern Zugriff auf diese Gruppe zu gewähren.

Für die Festlegung der Berechtigungen der neuen Gruppe stehen Ihnen diese Admin-Skripte zur Verfügung:

admin_adduser.pl#

Nutzen Sie dieses Skript, um einen neuen Benutzer anzulegen. Die Attribute des neuen Benutzers können Sie beim Aufruf des Skriptes übergeben.

Zugriffsrechte erteilen Sie dem neuen Benutzer, indem Sie mit dem Skript admin_grpuser.pl seine Gruppenzugehörigkeiten festlegen.

Sie können anderen Benutzern mit dem Skript admin_edituser.pl Zugriff auf den neuen Benutzer gewähren.

admin_asset_actions.pl#

Nutzen Sie dieses Skript um Asset-Aktionen für eine Rubrik oder ein spezifisches Asset festzulegen oder anzuzeigen. Spezifizieren Sie das Objekt um es via NodeID zu verarbeiten.

admin_cat_del.pl#

Nutzen Sie dieses Skript um eine Rubrik komplett aus dem Rubrikenbaum zu löschen. Die Rubrik wird von NodeID oder einem einzigartigen Namen identifiziert.

Bitte beachten

Referenzierte Rubriken werden nicht gelöscht.

admin_cleandesktop.pl#

Dieses Skript findet und löscht alle MAM-Dokumente auf dem Schreibtisch, die nicht mit binären Daten in Zusammenhang stehen. Dokumente dieser Art sind das Ergebnis eines abgebrochenen Uploads.

Bitte beachten

Falls das Skript auf gesperrte Dokumente stößt, werden diese übersprungen. Eine Fehlernachricht, die die NodeID des übersprungenen Dokuments enthält, wird angezeigt.

admin_delete_entry.pl#

Nutzen Sie dieses Skript um Archiveinträge oder Dokumente auf dem Schreibtisch zu löschen.

Bitte beachten

Die Optionen um etwas aus dem Archiv und dem Schreibtisch zu löschen sind exklusiv und können nicht simultan ausgeführt werden.

admin_delrole.pl#

Mit diesem Skript löschen Sie eine Gruppe aus dem System. Als Parameter können Sie die ID oder den eindeutigen Namen der Gruppe angeben.

admin_delfile.pl#

Mit diesem Skript löschen Sie Dokumente aus dem System, jedoch bleiben die Archivversionen erhalten; um diese ebenfalls vollständig zu entfernen, müssen Sie den Archive::Killer verwenden (deleteArchivedMetaInfo löscht nicht das komplette Dokument).

admin_duplicates.pl#

Nutzen Sie dieses Skript, um Duplikate von Rubriken-IDs im File65 Speicher anzuzeigen und zu fixen.

admin_expire.pl#

Mit diesem Skript können Sie Dokumente, die ein Verfallsdatum eingetragen haben, wahlweise anzeigen oder in die Datei site/articles/expiry.new schreiben lassen.

admin_fake_publish.pl#

Nutzen Sie dieses Skript, um alle Dokumente auf einem System auf veröffentlicht/nicht veröffentlicht zu setzen ohne tatsächlich Dateien zu transferieren.

admin_getcat.pl#

Mit diesem Skript können Sie die Eigenschaften einer Rubrik ausgeben. Es stehen verschiedene Ausgabeformate zur Verfügung, die Sie mit Aufrufparametern auswählen können. Die Rubrik legen Sie durch Angabe der NodeID (beginnend mit einem Slash) oder des eindeutigen Rubriknamens fest.

admin_getdoc.pl#

Sie können sich mit diesem Skript die Meta-Information zu einem Dokument ausgeben lassen. Dabei stehen Ihnen verschiedene Ausgabeformate zur Verfügung, die Sie mit Aufrufparametern auswählen können. Das Dokument bestimmen Sie durch die Angabe der NodeID beim Aufruf des Skripts.

Wenn Sie die Informationen einer archivierten Version des Dokumentes anzeigen lassen möchten, geben Sie zusätzlich die arch_id der betreffenden Version an. Andernfalls werden die Informationen der neuesten Version ausgegeben.

admin_getrole.pl#

Mit diesem Skript können Sie die Eigenschaften einer Gruppe anzeigen lassen. Die Gruppe bestimmen Sie durch die Angabe der GruppenID oder des eindeutigen Gruppennamens. Es stehen Ihnen verschiedene Ausgabeformate zur Verfügung, die Sie mit Aufrufparametern auswählen können.

admin_grpuser.pl#

Mit diesem Skript können Sie sich anzeigen lassen, welche Gruppen Ihres Systems ein Benutzer annehmen darf oder einem Benutzer Zugriff auf weitere Gruppen gewähren.

Mögliche Optionen:

--repair zeigt an, welche Gruppen fehlen.

admin_listcat.pl#

Nutzen Sie dieses Skript, um sich eine Liste aller Rubriken unterhalb einer Startrubrik anzeigen zu lassen.

admin_listflex.pl#

Rufen Sie dieses Skript auf, um sich eine Liste aller Flexmodule inklusive ihrer Validcodes, Invalidcodes und Autoren anzeigen zu lassen.

admin_listmeta.pl#

Für eine Liste aller Meta-Dateien Ihres Systems rufen Sie dieses Skript auf.

admin_listrole.pl#

Mit diesem Skript können Sie sich eine Liste aller Gruppen ausgeben lassen.

admin_listtemplate.pl#

Mit diesem Skript können Sie eine Liste aller Templates erzeugen und ausgeben lassen.

admin_listunreferenced.pl#

Rufen Sie dieses Skript auf um eine Liste aller unreferenzierten Assets einer gewünschten Rubrik anzuzeigen.

admin_listuser.pl#

Nutzen Sie dieses Skript, um sich eine Liste aller Benutzer anzeigen zu lassen.

admin_listworkflow.pl#

Mit diesem Skript können Sie eine Liste aller Workflows anzeigen lassen.

admin_mam_reparent_orphans.pl#

Nutzen Sie dieses Skript, um nach Varianten von imperia-Assets zu suchen, deren Parent überschrieben wurde.

admin_mam_thumbgen.pl#

Nutzen Sie dieses Skript, um ein neues Thumbnail in Standardgröße zu erstellen.

admin_mam.pl#

Nutzen Sie dieses Skript, um den MAM Filter und/oder den MAM Suchindex neu zu bauen.

admin_multilang.pl#

Dies ist ein internes Skript und sollte nicht genutzt werden.

admin_remove_prefs.pl#

Nutzen Sie dieses Skript, um gewünschte Schlüssel aus den persönlichen Einstellungen eines Nutzers zu löschen.

admin_repair_repository.pl#

Nutzen Sie dieses Skript, um jeden fehlerhaften Eintrag aus dem Repository zu löschen.

Bitte beachten

Bitte stellen Sie sicher, dass Sie ein Backup ihrer Daten haben bevor Sie dieses Skript ausführen.

admin_reparse.pl#

Dies ist ein internes Skript und sollte nicht genutzt werden.

admin_rlimit.pl#

Dies ist ein internes Skript und sollte nicht genutzt werden.

admin_sanitisearchive.pl#

Nutzen Sie dieses Skript für die Bereinigung des gesamten Archives oder einzelner Teilbereiche.

Geben Sie beim Aufruf eine NodeID oder einen eindeutigen Rubrikennamen an, um nur einen Teilbereich des Archivs zu bearbeiten. Sollen auch Unterrubriken bereinigt werden, müssen Sie dies beim Aufruf des Skripts vermerken.

Alternativ können Sie das ganze Archiv bereinigen lassen.

Für die Bereinigung stehen Ihnen zwei Optionen zur Auswahl. Sie können wahlweise nur sämtliche unbeendeten Dokument-Versionen löschen, die älter sind als die jeweils letzte beendete, oder auch zusätzlich die Anzahl verbleibender beendeter Versionen einschränken.

admin_searchdoc.pl#

Mit diesem Skript suchen Sie Dokumente nach bestimmten Suchkriterien.

Sie erhalten eine Liste von Dokumenten, auf die Ihre Suchkriterien zutreffen. Neben der NodeID können Sie sich eine frei definierbare Reihe von Meta-Feldinhalten der gefundenen Dokumente anzeigen lassen.

Zur Eingrenzung der Suche können Sie beim Aufruf die NodeID oder den eindeutigen Namen einer Startrubrik übergeben.

admin_setcat.pl#

Mithilfe dieses Skripts können Sie die Eigenschaften bestehender Rubriken ändern.

Die Rubrik bestimmen Sie durch die Angabe einer NodeID oder eines eindeutigen Namens beim Aufruf.

Die Werte, die Sie ändern möchten, übergeben Sie in Form einer durch Leerzeichen getrennten Reihe von Name-Wertpaaren.

admin_setdoc.pl#

Mit diesem Skript können Sie die Meta-Informationen eines Dokumentes verändern. Das Dokument wählen Sie durch die Angabe einer NodeID beim Aufruf aus.

Per Default werden die Informationen der letzten Version des Dokumentes verändert. Optional können Sie auch die der letzten beendeten Version oder die einer per archID bestimmten Version aus dem Archiv verändern.

admin_setrole.pl#

Für die Änderung von Gruppeneigenschaften können Sie dieses Skript nutzen.

Übergeben Sie dem Skript die ID oder den eindeutigen Namen der Gruppe, die Sie ändern möchten, und eine durch Leerzeichen getrennte Reihe von Name-Wertpaaren mit den neuen Eigenschaften.

admin_setuser.pl#

Mit diesem Skript können Sie die Eigenschaften eines Benutzers ändern.

Übergeben Sie dem Skript die ID oder den eindeutigen Namen des Benutzers, den Sie ändern möchten, und eine durch Leerzeichen getrennte Reihe von Name-Wertpaaren mit den neuen Eigenschaften.

admin_unnname2id.pl#

Nutzen Sie dieses Skript, um die Datei /path/to/site/roles/database/name2id neu zu erstellen, die für den Login-Prozess benötigt wird.

clone_repository.pl#

Nutzen Sie dieses Skript, falls der Datenspeicher geändert werden muss. Das Skript kopiert auch die exakten IDs aller Rubriken und Dokumente.

site/bin/admin_anonymize_accesslog.pl#

Mit diesem Perl-Skript können Sie ein datenschutzkonformes Access-Log generieren.

Das Skript geht folgendermaßen vor:

  1. site/logs/access.log zeilenweise einlesen
  2. Bei jedem String "Login: ein_benutzer_name" am Zeilenende, wird der Benutzername durch die md5sum des Benutzernamens ersetzt.
  3. Die Ausgabe wird zurück nach site/logs/anonymized_access.log geschrieben bzw. an einem beliebigen Ort unter Angabe von -o.

site_doctree_search_index.pl#

Nutzen Sie dieses Skript, um den imperia-Suchindex zu reduzieren, indem die Blacklist und Qualifizierungsliste der Meta-Felder genutzt wird.

site_migrate_iwe_to_iwe2.pl#

Nutzen Sie dieses Skript, um die iWE Verarbeitungsanweisungen in iWE2 zu migrieren. Das Skript geht durch alle HTML-basierten Templates, Flex- und Slotmodule, Codeincludes und versucht die Verarbeitungsinformationen zu migrieren.

Bitte beachten

Dieses Skript hat keinen Effekt auf interne Konfigurationsdateien.

site_publish_status.pl#

Nutzen Sie dieses Skript, um jedes imperia-Dokument auf dem Entwicklungssystem zu überprüfen und sie auf den Veröffentlichungsstatus zurückzusetzen, abhängig von den Definitionen auf dem Zielsystem.

site_rebuild_db.pl#

Dieses Skript wird genutzt, um redundante imperia-Daten neu zu bauen. Es ist ebenfalls der finale Schritt in der Migration des Systems.

Bitte beachten

site_rebuild_db.pl auszuführen könnte einige Zeit beanspruchen, daher kann es jederzeit unterbrochen und neu gestartet werden können.

Weitere Informationen können über das Skript mit dem Parameter -h (für Hilfe) aufgerufen werden.

Alle Optionen im Überblick:

  • -m, --minimal : Minimaler, schnellerer Aufbau.
    Das Neuaufbauen der Datenbank (bzw. updaten und anschließend neu aufbauen) geht nun wesentlich schneller mit dem neuen Parameter -m (minmaler Aufbau).
    In diesem Modus werden die Dokumente nicht abgeglichen, sondern lediglich das Benutzermanagement und die Rubrikeninformationen.
    Weitere Aufrufe im minimalen Modus:
    Wenn Sie die Option -m nutzen, sollten Sie danach auch folgende Aufrufe ausführen:

    • perl site/bin/site_rebuild_db.pl -tb --only-targets DEV,- (Baut die MAM/Dokumentenbrowser-Liste neu auf, bspw. nach einem Update von einer älteren i9)
    • perl site/bin/site_rebuild_db.pl -tbd (wenn im Dokumentenbrowser (im Dokumenten-Modus) die "falsche" Copy-Seite als URL angezeigt wird)
      • perl site/bin/site_rebuild_db.pl -tbg (Baut die globalen Metainfos auf/aktualisiert die Variablen, falls z.B. die GLOBAL_METAKEYS geändert wurde)

  • -A: beschleunigt die Abarbeitung.

    Hinweise

    • Gilt nur für die Datenhaltung "Dateisystem".

    • Wechseln Sie hierfür in den Maintenance-Modus.

    • -A, --disable-autocommit: Autocommit deaktivieren. Diese Option muss mit der Option -m kombiniert werden.

    • -Atmb

  • --only-targets: Baut Daten für bestimmte (Ziel)Systeme neu auf, z.B. DEV,live1,live2.

  • -d, --doc-copies-only: Nur Dokumenten-Copies neu aufbauen.

  • -U, --no-um: User-Management bezogene Daten nicht neu aufbauen.

  • -t, --todo: Erstellt die ToDo-Liste.

  • -b, --batch: Führt die ToDo-Liste aus. Diese kann gestoppt und neu gestartet werden.

  • --debug: Erzeugen Sie mehr informative Ausgaben des Replizierungsskripts mit dieser zusätzlichen Option.

    • Durch Setzen der Umgebungsvariablen LDAP_DEBUG auf einen wahren Wert, aktivieren Sie in allen Bereichen von imperia informative Debugausgaben

Mögliche Szenarien für site_rebuild_db

  • Beim Upgraden von Major-Versionen:
    Hier können Sie site_rebuild_db mit den Optionen -m und -U sowie -A nutzen.

  • Beschädigte SQLite-Datei schnell wiederherstellen:

    • Verwenden Sie site_rebuild_db mit den Optionen -m und -A. Danach arbeitet imperia allerdings ohne Funktionen.
    • Wenn Sie mit dem Dokumentenbrowser und MAM arbeiten möchten, verwenden Sie site_rebuild_db mit der Option --only-targets DEV
    • Wenn Sie Ihre imperia-Installation im vollen Umfang nutzen möchten, sollten Sie die Befehle nutzen, die im Output von site_rebuild_db stehen; diese können gleichzeitig verwendet werden.

/cgi-bin/site_info.pl#

Dient dazu die Subversion Ihrer imperia-Version zu erhalten.