Backend CLI Tool

Verfügbar ab Version: 9.7 #SR1
Label_For_Administrators.svg

Das Backend CLI Tool ist ein Kommandozeilen-Tool, das mit dem empower® Backend verbunden ist.

Es kann von empower® Administratoren verwendet werden.

Das Backend CLI Tool wird für folgende Aufgaben verwendet:

  • Bulk-Import von Dateien wie Präsentationen oder Bildern

  • Download eines Nutzungsberichts

Das Tool wird mithilfe eines separaten .msi-Installers installiert, der von empower bereitgestellt wird.

Um das Tool zu installieren, müssen die folgenden Bedingungen erfüllt sein:

  • .NET 8 Desktop Runtime (64-Bit) ist auf dem Gerät des Benutzers installiert.

  • Die Konfigurationsdatei appsettings.json befindet sich während der Installation neben dem .msi-Installer des Tools.

  • Das Gerät muss nach der Installation neu gestartet werden.

Nach der Installation wird das Tool unter folgendem Pfad abgelegt:

%LocalAppData%\programs\empower\backendCli

Wichtig

Das Backend CLI Tool kann nur auf Windows-Geräten über die Kommandozeile ausgeführt werden.

Die Ausführung über PowerShell wird nicht unterstützt.

Importierte Dateien sind jedoch auch für empower® für macOS verfügbar und die Nutzungsdaten aus macOS-Installationen werden auch in den Nutzungsbericht eingeschlossen.

Anmerkung

Sie können auch Zeitpläne erstellen, um die Befehle automatisch und regelmäßig auszuführen.

Für weitere Informationen zur Planung von Befehlen siehe Befehle planen.

Im Tool anmelden

Nutzen Sie zu Anmeldung in dem Backend CLI Tool den folgenden Befehl:

backendCli.exe l

Der Befehl öffnet ein Login-Fenster.

Melden Sie sich bei Ihrem Benutzerkonto an. Je nach Konfiguration ist das entweder Ihr empower® Benutzer oder Ihr Windows-Benutzer.

Wenn Ihr Windows-Benutzer verwendet wird, müssen Sie sich möglicherweise nicht manuell anmelden. Ihre Benutzer-ID wird automatisch verwendet.

Im Kommandozeilen-Tool können Sie sehen, ob Ihre Authentifizierung erfolgreich war.

Nachdem Sie sich erfolgreich angemeldet haben, können Sie Befehle unbeaufsichtigt im stillen Modus ausführen.

Um zu verhindern, dass Sie während automatisierter Aufgaben aufgefordert werden, sich anzumelden, verwenden Sie immer den oben genannten Befehl, bevor Sie eine Aufgabe planen.

Anmerkung

Wenn Sie zum Anmelden Ihren empower® Benutzer verwenden, müssen Sie der Anwendung die Berechtigung User.Read für Microsoft Graph erteilen.

Für weitere Informationen zu dieser Berechtigung siehe Microsoft Graph-Berechtigungsreferenz.

Ein Dialogfenster öffnet sich.

Akzeptieren Sie hier die Erteilung der Berechtigungen.

Je nach geltenden Richtlinien kann es vorkommen, dass nur Administratoren die benötigten Berechtigungen erteilen können. Ist dies für Ihr Unternehmen der Fall, werden Sie über das Dialogfenster darüber informiert, dass Sie einen Administrator kontaktieren müssen.

Nutzungsbericht exportieren

Das Tool kann dazu verwendet werden, einen Bericht über die Nutzung verschiedener Bibliotheksinhalte zu exportieren.

Der Bericht enthält die in der Bibliothek angezeigten Informationen darüber, wie oft ein Bibliothekselement im Unternehmen verwendet wurde.

Um den Bericht als .csv-Datei zu exportieren, verwenden Sie den folgenden Befehl:

backendCli.exe r -o "[ZIEL-PFAD]"

Der zugrundeliegende Befehl besteht aus folgenden Bestandteilen:

  • r – Zeigt an, dass ein Bericht erstellt werden soll.

  • --output-folder [PFAD] (-o) – Definiert den Zielpfad, unter dem der Bericht gespeichert werden soll.

    Hier können Sie einen individuellen Pfad in Ihrem Dateisystem angeben, z. B. C:\Users\[BENUTZERNAME]\Documents\empower Usage Report.

Optional können Sie den Befehl im stillen Modus ausführen, um ihn zeitlich zu planen.

Fügen Sie dazu -q (--quiet) am Ende des Befehls hinzu:

backendCli.exe r -o "[ZIEL-PFAD]" -q

Anmerkung

Um den stillen Modus zu verwenden, müssen Sie sich entweder einmal im normalen Modus anmelden oder sich vorher mithilfe des Login-Befehls authentifizieren.

Dateistruktur und Inhalt

Der .csv-Bericht enthält pro Bibliotheksinhalt die folgenden Informationen (Abbildung 1, „Nutzungsbericht“):

  • Name

  • Pfad

  • Typ

  • Autor

  • Editor

  • Letztes Änderungsdatum

  • Nutzungsanzahl

Abbildung 1. Nutzungsbericht

Nutzungsbericht

Bulk-Upload von Dateien

Um mehrere Dateien wie z. B. Bilder oder Präsentationen in empower® auf einmal hochzuladen, verwenden Sie den folgenden Befehl:

backendCli.exe u -s "[QUELL-PFAD]" -t "[ZIEL-PFAD]"

Der zugrundeliegende Befehl besteht aus den folgenden Bestandteilen:

  • u – Zeigt an, dass ein Bulk-Upload von Dateien durchgeführt werden soll.

  • --source [QUELL-PFAD] (-s) – Definiert den Pfad, unter dem der zu importierende Inhalt gespeichert ist.

  • --target [ZIEL-PFAD] (-t) – Definiert den Ordner, in den die Inhalte importiert werden sollen.

    Der Ordner kann entweder in Form eines Pfades oder in Form seiner GUID aus empower® definiert werden. Die GUID ist in der empower® Datenbank zu finden.

    Für weitere Informationen siehe Gültige Zielordner und Dateitypen.

Optional können Sie den Befehl im stillen Modus ausführen, um ihn zeitlich zu planen.

Fügen Sie dazu -q (--quiet) am Ende des Befehls hinzu:

backendCli.exe u -s "[QUELL-PFAD]" -t "[ZIEL-PFAD]" -q

Wichtig

Der Quell-Pfad darf nicht mit einem \ Zeichen enden.

Der Ziel-Pfad darf nicht mit einem > Zeichen enden.

Beispiel

Quell-Pfad

RIchtig: -s "C:\Users\[BENUTZERNAME]\Desktop\Bilder"

Falsch: -s "C:\Users\[BENUTZERNAME]\Desktop\Bilder\"

Ziel-Pfad

Richtig: -t "%CorporateDesignTemplates%>%Slides%"

Falsch: -t "%CorporateDesignTemplates%>%Slides%>"

Gültige Zielordner und Dateitypen

Die Dateipfade zu den Ordnern auf dem Gerät und in der empower® Bibliothek können auf zwei verschiedene Wege angegeben werden

Für Pfade, die zu Dateien auf dem Gerät führen, geben Sie den Pfad in einer Standard-Pfad-Struktur an, die mithilfe von Rückstrichen (\) getrennt wird.

Wenn Sie den Ordner in der empower® Bibliothek mithilfe eines Pfades statt mithilfe der GUID definieren, verwenden Sie das folgende Format:

%UserLibrary%>%MyContent%>[ORDNER-NAME]

Die folgende Tabelle bietet eine Übersicht über alle gültigen Ordnerpfade und die jeweiligen unterstützten Dateitypen, die mit dem Befehl -t verwendet werden können:

Ordnerpfad

Bereich in der Bibliothek

Unterstützte Dateitypen

%CompanyLibrary%

Unternehmensbibliothek

Alle unterstützten Dateitypen in dieser Tabelle.

%CorporateDesignTemplates%>%CorporatePresentations%

Corporate Presentations

.pptx, .pptm

%CorporateDesignTemplates%>%DocumentTemplates%

Dokumentvorlagen

.docx, .docm

%CorporateDesignTemplates%>%Icons%

Icons

.jpg, .jpeg, .png, .gif, .svg, .tif, .tiff

Außerdem wird .tiff nur unterstützt, wenn der Parameter -l auf false gesetzt ist.

%CorporateDesignTemplates%>%Images%

ODER

%CorporateDesignTemplates%>%Pictures%

Bilder

.jpg, .jpeg, .png, .gif, .svg, .tif, .tiff

Außerdem wird .tiff nur unterstützt, wenn der Parameter -l auf false gesetzt ist.

%CorporateDesignTemplates%>%MasterTemplates%

Master Templates

.pptx, .pptm

%CorporateDesignTemplates%>%Slides%

Slides

.pptx, .pptm

%UserLibrary%>%MyContent%

ODER

%UserLibrary%

Meine Inhalte

Alle unterstützten Dateitypen in dieser Tabelle.

Wichtig

Die Ordnernamen der zu importierenden Daten dürfen keine Punkte enthalten.

Erweiterte Befehle

Wenn Sie zum Bulk-Upload mehr Details mitgeben möchten, können Sie die folgenden Parameter zu Ihrem Befehl hinzufügen:

Befehl

Kurzform

Beschreibung

Standard

--includeSubfolders

-i

Definiert, ob Unterordner mit eingeschlossen werden.

Dieser Parameter kann auf true oder false gesetzt werden.

true

--ignoreUnsupportedFiles

-g

Definiert, ob nicht unterstützte Dateien übersprungen werden.

Dieser Parameter kann auf true oder false gesetzt werden.

Wenn dieser Parameter deaktiviert ist und es nicht unterstützte Dateien gibt, wird der Import abgebrochen und ein Hinweis erscheint.

false

--additionalInformationFile [PFAD]

-f

Definiert den Pfad zu einer zusätzlichen .csv-Datei mit Metadaten, die mit den Dateien hochgeladen werden sollen.

Für weitere Informationen siehe Metadaten zum Import hinzufügen.

-

--archiveSourceFolder [PFAD]

-r

Definiert den Pfad, unter dem der Import-Ordner nach erfolgreichem Upload archiviert werden soll.

Der Ordner wird dann zum Archivordner verschoben und nach dem Zeitstempel benannt.

false

--updateNotification [MODUS]

-n

Definiert das Update-Benachrichtigungsverhalten.

Dieser Parameter kann auf force, update oder disable gesetzt werden.

Dieser Parameter hat keinen Einfluss auf Word-Dateien.

Update-Benachrichtigungen werden nur für einzelne Folien, auf Benutzergeräten gespeicherte Präsentationen, Bilder in Word und Bilder in PowerPoint, die über den Parameter -l hochgeladen wurden, unterstützt.

update

--setTranslationsOutdated

-x

Definiert, ob Übersetzungen bei der Überschreibung von Dateien innerhalb des Übersetzungsverbundes als veraltet markiert werden sollen.

Dieser Parameter kann auf true oder false gesetzt werden.

Dieser Parameter ist abhängig vom Parameter -n.

false

--overwriteExistingFiles

-o

Definiert, ob bestehende Dateien in der empower® Library überschrieben werden sollen. Damit die Aktualisierung funktioniert, müssen die importierte und die existierende Datei denselben Namen haben.

Dieser Parameter kann auf true oder false gesetzt werden.

Wenn dieser Parameter deaktiviert ist, werden bestehende Dateien übersprungen.

true

--useIncrementalUpload

-m

Definiert, ob nur Dateien, die seit dem letzten Import geändert wurden, aktualisiert werden sollen.

Dieser Parameter kann auf true oder false gesetzt werden.

true

--useLegacySlidesImageFormat

-l

Definiert, ob das ältere Bildformat für empower® für PowerPoint verwendet werden soll.

Dieser Parameter kann auf true oder false gesetzt werden.

Wenn dieser Parameter aktiviert ist, werden Bilddateien nur in empower® für PowerPoint importiert.

Wenn dieser Parameter deaktiviert ist, werden die Bilddateien in einem globalen Format hochgeladen, das mit empower® für PowerPoint, Word, Excel und Outlook kompatibel ist.

false

Wichtig

Wenn Bilder im globalen Dateiformat hochgeladen werden, das für Bibliotheksinhalte in allen Office-Anwendungen funktioniert, funktionieren Updates für Inhalte in empower® für PowerPoint nicht. Außerdem gibt es für diese Dateien keinen Versionsverlauf.

Die Dateien werden dementsprechend hochgeladen, aber die Benutzer erhalten keine Update-Benachrichtigungen.

Für Bilder in Word, die im globalen Dateiformat hochgeladen wurden, erhalten Benutzer jedoch Update-Benachrichtigungen.

Metadaten zum Import hinzufügen

Wenn Sie Metadaten wie z. B. Tags zu Ihrem Import hinzufügen möchten, können Sie eine separate .csv-Datei erstellen, die diese Informationen enthält.

Während des Imports muss der relative Pfad zu dieser Datei im Befehl angegeben werden.

Platzieren Sie die Datei im Import-Quellordner oder in einem seiner Unterordner.

Geben Sie dann den relativen Pfad basierend auf dem Quellordner an.

Die Datei sollte die folgenden Inhalte in derselben Reihenfolge enthalten:

  • Relativer Dateipfad, inklusive Dateierweiterung

  • Name (ohne Dateierweiterung)

    • Definiert einen neuen Dateinamen, der in der empower® Bibliothek gespeichert wird

    • Wenn der Name nicht angegeben wird, wird der ursprüngliche Dateiname aus dem Import-Ordner verwendet.

  • Tags, die in der empower® Bibliothek angezeigt werden

    • getrennt durch Semikolons

    • In doppelten Anführungszeichen ein ("")

  • Indikator, dass nur einzelne Folien hochgeladen werden soll

    • Verwenden Sie x, um zu definieren, dass nur die erste Folie aus einer Präsentation importiert werden soll.

    • Wenn diese Stelle leer bleibt, wird die gesamte Präsentation importiert

Der folgende Auszug bietet ein Beispiel für die Struktur einer .csv-Datei:

 
Picture File 1.png;New Picture Name;"tag1;tag2;tag3";
Images\Picture File 2.png;;"tag4;tag5;tag6";
Slides\PowerPoint File 1.pptx;New Slide Name;"tag7;tag8";x
Presentations\PowerPoint File 2;;"tag9";

Anmerkung

Wenn eine der Angaben leer bleibt, z. B. wenn Sie keinen neuen Namen für die Datei angeben möchten, lassen Sie dieses Feld leer.

In diesem Fall befinden sich zwei Semikolons direkt nebeneinander (siehe Zeile 2 und 3 in der Beispielstruktur).

Anmerkung

Es müssen nicht alle Dateien aus dem Import-Ordner in der .csv-Datei enthalten sein.

Log-Dateien

Der Import-Vorgang und mögliche Fehler werden in einer Log-Datei sowie im Kommandozeilen-Tool protokolliert.

Die Log-Datei wird unter folgendem Pfad gespeichert:

%LocalAppData%\empower\Logs\backendCli

Im Kommandozeilen-Tool werden die Fehler nur protokolliert, wenn es im normalen Modus verwendet wird. Im stillen Modus werden Fehler nur in der Log-Datei protokolliert.

War dieser Beitrag hilfreich?

/

Kommentare

0 Kommentare

Zu diesem Beitrag können keine Kommentare hinterlassen werden.