Parameterdatei

Die Parameterdatei ist eine INI-Datei, in der Einstellungen für den Export vorgenommen werden können. So kann beispielsweise eingestellt werden, welche Daten exportiert oder in welcher Datei diese abgelegt werden sollen.

Sie erstellen die Paramaterdatei selbst in einem beliebigen Texteditor. Der Name und die Dateierweiterung der Parameterdatei sind frei wählbar, zum Beispiel Parameter.config.ini.

Die Einstellungen, die für alle Exporte vorgenommen werden können, sind in den nachfolgenden Tabellen aufgelistet. Die Einstellungen, die nur für einzelne Exporte gelten, finden Sie bei der Beschreibung des jeweiligen Exports.

 

Sektion [User]

Schlüssel Werte
Account Benutzer, der den Exportvorgang startet
Domain

Domäne, in welcher der Benutzer angelegt ist

Dieser Schlüssel muss nur angegeben werden, falls der Benutzer Teil einer Domäne ist und diese nicht beim Aufruf angegeben wurde.
Password

Passwort des Benutzers

Dieser Schlüssel wird nur beachtet, wenn der ausführende Benutzer auch in der Parameterdatei angegeben wird.
PasswordMode

Legt fest, wie das Passwort interpretiert wird. Folgende Werte sind möglich:

  • 0: Das Passwort wird als unverschlüsselt interpretiert (Standardwert).
  • 2: Das Passwort muss über die Befehlszeile eingegeben werden.
Token

Zugriffstoken des Benutzers

Das Zugriffstoken kann im AdminClient erzeugt werden und wird zur Ausführung des ExportModules benötigt.

Wenn ein Token angegeben wird, brauchen die anderen Anmeldeinformationen nicht übergeben zu werden.

 

Sektion [Common]

Schlüssel Werte
ReportType*

Bericht, der erstellt werden soll. Folgende Werte sind möglich:

  • ComponentTree

    • Exportiert den Projektbaum

  • JobList

    • Exportiert eine Übersicht der Jobs

  • JobResults

    • Exportiert die Jobergebnisse aller Jobs

  • UnequalJobResults

    • Exportiert nur die Jobergebnisse der Jobs, bei denen Unterschiede festgestellt wurden oder Fehler aufgetreten sind

  • UserManagement

    • Exportiert die Benutzer und Benutzergruppen

  • ComponentTypes

    • Exportiert die Komponententypen und ihrer Konfiguration (Name, ID, usw.)

  • Componentlog

    • Exportiert die Inhalte des Komponentenlogs

  • Eventlog

    • Exportiert die Inhalte des Moduls Ereignisanzeige

  • Adminlog

    • Exportiert eine Liste der Änderungen an den Modulen des AdminClients

  • StandardLibraryManagement

    • Exportiert eine Übersicht darüber, wo welche Standardbausteine verwendet werden

  • ComponentsWithStdLibAssignments

    • Exportiert eine Übersicht über die Komponenten, die mit Standardbibliotheken verknüpft sind.

  • AssetState

    • exportiert eine Übersicht der Jobs des Anlagenstatus

  • UsageInformation

    • Erstellt eine Benutzungsinformationsdatei.

Nur ein Attribut ist möglich.

ExportType

Gibt an, welcher Export in welchem Format erstellt werden soll.

Nicht jeder Export kann in jedem Format erstellt werden. Sie haben folgende Möglichkeiten:

  • ComponentTree: XML oder JSON
  • JobList: CSV oder JSON
  • JobResults: CSV oder JSON
  • UnequalJobResults: CSV oder JSON
  • UserManagement: XML oder JSON
  • ComponentTypes: XML oder JSON
  • Componentlog: CSV oder JSON
  • Eventlog: CSV oder JSON
  • Adminlog: CSV oder JSON
  • StandardLibraryManagement: CSV oder JSON
  • ComponentsWithStdLibAssignments: CSV oder JSON
  • AssetState: CSV oder JSON

*Das jeweils unterstrichene Format wird als Standardwert verwendet, wenn ExportType in der Parameterdatei nicht angegeben ist.
ExportFile* Absoluter Pfad (mit Dateiname) der Datei, in der die Exportergebnisse abgelegt werden sollen. Ist die Datei bereits vorhanden, wird sie überschrieben.
CsvSeparator

Trennzeichen zwischen den Spalten in einer CSV-Datei, die als Exportergebnis ausgegeben wird, z. B. Semikolon, Komma, Tabulator oder ein Leerzeichen

Um einen Tabulator als Trennzeichen zu verwenden, gibt es folgende Alternativen:

  • String TAB

  • Anführungszeichen + Tabulator Taste + Anführungszeichen ("⇥")

Ein Leerzeichen geben Sie ebenfalls mit Anführungszeichen ein. (" ")

Wenn dieser Schlüssel nicht angegeben ist, wird das Trennzeichen verwendet, das im AdminClient im Modul Globale Einstellungen konfiguriert wurde.
FlatExport

Dieser Schlüssel kann nur für den ExportType JSON verwendet werden.

Gibt an, ob die JSON-Datei nur Daten ohne umschließende Elemente enthält.

Folgende Werte sind möglich:

  • Y: Die JSON-Datei enthält keine umschließenden Elemente.
    Beispiel:

    • [
    {
    Job1 ...
    },
    {
    Job2 ...
    }
    ]

  • N: Es werden alle Elemente in der JSON-Datei ausgegeben.

    • {
    "Jobs": [
    {
    Job1 ...
    },
    {
    Job2 ...
    }
    ]
    }

 

Sektion [Result]

Schlüssel Werte
ErrorText An dieser Stelle werden Fehler aufgelistet, die beim Export aufgetreten sind.
LastExecution Zeitstempel des zuletzt ausgeführten Exports

 

Die mit *(Sternchen) gekennzeichneten Attribute sind Pflichtattribute. Sie müssen vergeben werden.

 

Verwandte Themen
AdminClient -> INI-Dateien
AdminClient -> Server