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 | Beschreibung | Werte |
|---|---|---|
| Account | Benutzer, der den Exportvorgang startet | |
| Domain | Domain, in welcher der Benutzer angelegt wird. Dieser Schlüssel muss nur angegeben werden, wenn der Benutzer Teil einer Domain ist und diese beim Aufruf nicht angegeben wurde. | |
| Password | Passwort des Benutzers. Dieser Schlüssel wird nur beachtet, wenn der ausführende Benutzer auch in der Parameterdatei angegeben wird. | |
| PasswordMode | Gibt an, wie das Passwort interpretiert wird | 0: Das Passwort wird als unverschlüsselt interpretiert (Standardwert). 2: Das Passwort muss über die Kommandozeile eingegeben werden. |
| Token | Zugriffstoken des Benutzers. Das Zugriffstoken kann im AdminClient erzeugt werden und wird zur Ausführung des ExportModule benötigt. Wenn ein Token angegeben wird, brauchen die anderen Anmeldeinformationen nicht übergeben zu werden. |
Sektion [Common]¶
ReportType*¶
Zu erstellender Report. Es ist nur ein Attribut möglich.
| Wert | Beschreibung |
|---|---|
| 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 ihre Konfiguration (Name, ID, usw.) |
| Componentlog | Exportiert die Inhalte des Komponentenlogs |
| Eventlog | Exportiert die Inhalte des Moduls Ereignisanzeige |
| Adminlog | Exportiert eine Liste der Änderungen am AdminClient |
| 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 | Erzeugt eine Datei mit Nutzungsinformationen |
ExportType¶
Gibt an, welcher Exportvorgang in welchem Format erstellt werden soll. Nicht jeder Exportvorgang kann in jedem Format erstellt werden. Der Standardwert wird verwendet, wenn ExportType nicht in der Datei angegeben ist.
| Wert | Format | Standardformat |
|---|---|---|
| ComponentTree | XML oder JSON | XML |
| JobList | CSV oder JSON | CSV |
| JobResults | CSV oder JSON | CSV |
| UnequalJobResults | CSV oder JSON | CSV |
| UserManagement | XML oder JSON | XML |
| ComponentTypes | XML oder JSON | XML |
| ComponentLog | CSV oder JSON | CSV |
| Eventlog | CSV oder JSON | CSV |
| Adminlog | CSV oder JSON | CSV |
| StandardLibraryManagement | CSV oder JSON | CSV |
| ComponentsWithStdLibAssignments | CSV oder JSON | CSV |
| AssetState | CSV oder JSON | CSV |
ExportFile*¶
Absoluter Pfad (mit Dateiname) der Datei, in der die Exportergebnisse gespeichert werden sollen. Wenn die Datei bereits existiert, wird sie überschrieben. Wird dieser Schlüssel nicht angegeben, wird das Trennzeichen verwendet, das im AdminClient im Modul Globale Einstellungen konfiguriert wurde.
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:
- Zeichenfolge TAB
- Anführungszeichen + Tabulator Taste + Anführungszeichen ("⇥")
- Ein Leerzeichen geben Sie ebenfalls mit Anführungszeichen ein. (" ")
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.
| Wert | Beschreibung |
|---|---|
| Y | Die JSON-Datei enthält keine umschließenden Elemente. Beispiel: [ { Job1 ... }, { Job2 ... } ] |
| N | Alle Elemente in der JSON-Datei werden ausgegeben. Beispiel: { "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 |
Info
Die mit *(Sternchen) gekennzeichneten Attribute sind Pflichtattribute. Sie müssen vergeben werden.