Handbuch

Kommandozeilenwerkzeuge

mesindexclient

Einführung

Mit dem mesindexclient Kommandozeilenwerkzeug können sowohl Metadaten in bestehenden Indices aus lokalen Daten erweitert und vervollständigt werden, als auch Metadaten aus bestehenden Indices in lokale Dateien exportiert werden.

Verwendung

Die folgende Hilfe kann im inspire container durch „mesindexclient --help“ aufgerufen werden.

usage: mesindexclient [-h] --host HOST

                      [--auth-server-baseurl AUTH_SERVER_BASEURL]

                      [--client-id CLIENT_ID] [--client-secret CLIENT_SECRET]

                      [--realm REALM] [--username USERNAME]

                      [--password PASSWORD] [-v]

                      {update-metadata,fetch-metadata} ...

Mindbreeze Index Client.

positional arguments:

  {update-metadata,fetch-metadata}

                        Command

optional arguments:

  -h, --help            show this help message and exit

  --host HOST           target host name

  --auth-server-baseurl AUTH_SERVER_BASEURL

                        auth server baseurl (in keycloak before

                        /auth/realms..)

  --client-id CLIENT_ID

  --client-secret CLIENT_SECRET

                        client secret

  --realm REALM         authentication realm

  --username USERNAME   user name

  --password PASSWORD   password

  -v, --verbose         verbose

mesindexclient update-metadata –help

mesindexclient fetch-metadata --help

Detailierte Erklärung der Argumente

--hostInspire Server URL

--auth-server-baseurl Authentifizierungs Server URL

--client-id ID des Clients

--client-secret Client Secret falls für die Client-Authentifizierung notwendig

--realm Keycloak Realm

--verbose Ausgabe der einzelnen Schritte

--usernameBenutzername eines Benutzers mit der Rolle “InSpire Index Writer”

--passwordPasswort des Benutzers

mesindexclient update-metadata –help

  --set Zum setzen einzelner Metadaten im Format „--set title titleToBeSet“

  --index-port Der Index-port des Index Services. Zu finden unter Configuration -> Indices -> [Index Name] -> Index Port (HTTP)

  --category Dokument Category

  --category-instanceDokument Categoryinstance

  --keys-file Pfad zum CSV Dokument mit den zu verändernden Dokumenten Keys

  --key Dokument Keys

mesindexclient fetch-metadata –help

  --in-csv-file Pfad zur CSV Datei, mit den Suchbegriffen

  --out-csv-filePfad zur CSV Datei, in der die Metadaten der gefundenen Dokumente gespeichert werden sollen

  --key-column-name Spaltenname in der Datei in-csv-file der Spalte die die Keys beinhaltet

  --fqcategory-column-nameSpaltenname in der Datei in-csv-file der Spalte die die fqcategories beinhaltet

  --add Spaltenname in der Datei out-csv-file der Spalte mit den zu speichernden Metadaten

  --map Map für die Zuweisung von fqcategory zu Index-Port

Beispiele

mesindexclient \

--host inspire.mycompany.com \

--username admin \

--client-id mindbreeze-inspire \

--client-secret xxxxxxxxxxxx \

fetch-metadata \

--in-csv-file=/data/top_100.csv \

--key-column-name action_key \

--fqcategory-column-name \

action_fq_category \

--out-csv-file=/tmp/top_100_2.csv \

--add title \

--add url \

--map "Web:.*" 23444

in-csv /data/top_100.csv

out-csv /tmp/top_100_2.csv