Schnittstellendatei
Wenn ein Ereignis eintritt, das die Skripterstellung auslöst, erzeugt Octoplant eine Schnittstellendatei. Diese Datei initialisiert das Skript oder die Skriptanwendung und übergibt Informationen über:
- Die betroffene Komponente
- Der Ereigniskontext
- Der Benutzer, der das Ereignis ausgelöst hat
- Technische Parameter wie Pfade und IDs
Die Schnittstellendatei:
- Verwendet das Format
ini - Ist in UTF-16 kodiert
- Wird automatisch für jedes skriptrelevante Ereignis erstellt
Aufbau der Schnittstellendatei
Die Schnittstellendatei ist in Abschnitte unterteilt. Einige Abschnitte sind für alle Ereignisse gleich, andere sind ereignisspezifisch.
Typische Abschnitte sind:
[Common][Component][User][Specific][UploadParameter]oder andere jobbezogene Abschnitte (ereignisabhängig)
Jeder Abschnitt enthält Schlüssel mit Eingabe- (I) oder Ausgabewerten (O). Die Ausgabewerte können vom Skript geschrieben werden, um das Verhalten zu beeinflussen.
[Common]
| Schlüssel | I/O | Beschreibung |
|---|---|---|
| RootDirAdmin | I | Vollständiger Pfad des Verzeichnisses mit den Administrationsdateien von Octoplant. Dieser Schlüssel wird für die Ereignisse BeforeUpload und AfterUpload nicht angegeben. |
| DirPrjData | I | Vollständiger Pfad des Verzeichnisses mit den Projektdateien. Dieser Schlüssel wird für die Ereignisse BeforeUpload und AfterUpload nicht angegeben. |
| Language | I | ID der Sprache, die in Octoplant eingestellt ist (z. B. en oder genauer en-gb, en-us, de-de, fr-fr, usw.) |
| ComputerName | I | Name des Rechners, auf dem die Skriptanwendung ausgeführt wird Format: [Domain].Rechnername Bei clientseitigen Ereignissen wird der Name des Clients, bei serverseitigen Ereignissen der Name des Servers angegeben. |
| DirTemp | I | Vollständiger Pfad des Verzeichnisses, in dem Skriptanwendungen temporäre Daten speichern. Jede Skriptanwendung muss temporäre Daten eigenständig löschen. Alle Skriptanwendungen teilen sich ein Verzeichnis für temporäre Daten. Deshalb müssen Unterverzeichnisse und Dateien eindeutig zugeordnet werden können, um sicherzustellen, dass Skriptanwendungen nur die eigenen temporären Daten löschen. |
| PathLog | I | Vollständiger Pfad des Verzeichnisses, in dem die Logging-Informationen gespeichert werden. Einige Skriptanwendungen stellen diese Informationen dem gesamten System zur Verfügung. Jede Skriptanwendung muss diese Daten eigenständig löschen. |
| TimeOutInMin | I | Zeit bis zum Timeout in Minuten. Warnung: Wird der hier eingestellte Wert überschritten, wird die Skriptanwendung sofort und ohne Benachrichtigung geschlossen. |
| Licence | I | Informationen über die in der Lizenz enthaltenen Funktionen |
| PathExeVdog | I | Vollständiger Pfad der Anwendung, welche die Skriptanwendung aufgerufen hat (z. B.C:\Programme\vdog\VDogClient.exe oder der Pfad zur Serveranwendung) |
| SilentMode | I | Zeigt, ob die Skriptanwendung Eingaben durch den Benutzer anfragen darf (z. B. durch Meldungen) Y: Es dürfen keine Eingaben angefragt werden. N: Eingaben dürfen angefragt werden. Das bedeutet nicht, dass die Skriptanwendung tatsächlich Eingaben anfragt. Der Standardwert ist Y für serverseitige und N für clientseitige Skriptanwendungen. |
[Component]
Einige Skriptanwendungen unterstützen diese Sektion nicht.
| Schlüssel | I/O | Beschreibung |
|---|---|---|
| Dir | I | Relativer Pfad des Komponentenverzeichnisses. Der Pfad beginnt mit einem Backslash. Am Ende des Pfades steht kein Backslash. |
| ID | I | Komponenten-ID |
| ComponentTypeId | I | Komponententyp-ID |
| MasterData1 | I | Inhalt des ersten Stammdatenfelds |
| MasterData2 | I | Inhalt des zweiten Stammdatenfelds |
| MasterData3 | I | Inhalt des dritten Stammdatenfelds |
| MasterData4 | I | Inhalt des vierten Stammdatenfelds |
| MasterData5 | I | Inhalt des fünften Stammdatenfelds |
| MasterData6 | I | Inhalt des sechsten Stammdatenfelds |
| MasterData7 | I | Inhalt des siebten Stammdatenfelds |
| MasterData8 | I | Inhalt des achten Stammdatenfelds |
| MasterData9 | I | Inhalt des neunten Stammdatenfelds |
| MasterData10 | I | Inhalt des zehnten Stammdatenfelds |
[User]
Einige Skriptanwendungen unterstützen diese Sektion nicht.
| Schlüssel | I/O | Beschreibung | Werte |
|---|---|---|---|
| ID | I | Benutzer-ID | Ein String mit 32 Zeichen |
| Name | I | Benutzername | |
| FullName | I | Vollständiger Benutzername. Der Schlüssel wird nur angegeben, wenn der Name im Modul Benutzermanagement festgelegt ist. | |
| Domain | I | Domain, in welcher der Benutzer angemeldet ist. | |
| EmailAddress | I | E-Mail-Adresse, wie sie in den Benutzerinformationen gespeichert ist (oder leer, wenn keine E-Mail-Adresse angegeben ist). | |
| LocalLogon | I | Zeigt, ob der Benutzer lokal oder auf dem Server angemeldet ist. | Y: Der Benutzer ist lokal angemeldet. N: Der Benutzer ist auf dem Server angemeldet. |
| Admin | I | Zeigt, ob der Benutzer zur Gruppe Administrators gehört. | Y: Der Benutzer gehört zur Gruppe Administrators. N: Der Benutzer ist nicht Teil der Gruppe Administrators. |
| Groups | I | IDs der Gruppen, denen der Benutzer angehört. | 32-Zeichen-Strings, durch Kommata getrennt |
[Version]
Einige Skriptanwendungen unterstützen diese Sektion nicht. Bei einigen Skriptanwendungen ist diese Sektion anders benannt.
Info
Diese Sektion enthält nur dann benutzerbezogene Details, wenn der Benutzer identifiziert und seine Informationen erfolgreich abgerufen werden können. Wenn dies nicht möglich ist, bleiben die folgenden Schlüssel leer:
- UserName
- UserFullName
- UserDomainName
- UserEmailAddress
| Schlüssel | I/O | Beschreibung |
|---|---|---|
| Hversion | I | Versionsnummer |
| HversionUserDefined | I | Benutzerdefinierte Versionsnummer |
| TimeStampUtc | I | Zeitpunkt der Versionierung im UTC-Zeitformat (YYYYMMDDHHMMSS) |
| TimeStampLocal | I | Zeitpunkt der Versionierung im lokalen Zeitformat (YYYYMMDDHHMMSS) |
| Comment | I | Kommentar zu dieser Version Zeilenumbrüche (LF, CR, CRLF) werden zu <br> konvertiert. |
| ChangeReason | I | Änderungsgrund für diese Version Zeilenumbrüche (LF, CR, CRLF) werden zu <br> konvertiert. |
| UserId | I | ID des Benutzers, der die Version erstellt hat, als String mit 32 Zeichen. |
| UserName | I | Name des Benutzers, der die Version erstellt hat. |
| UserFullName | I | Vollständiger Namen des Benutzers, der die Version erstellt hat. Der Schlüssel wird nur angegeben, wenn der Name im Modul Benutzermanagement festgelegt ist. |
| UserDomainName | I | Domain, in welcher der Benutzer angemeldet ist. |
| UserEmailAddress | I | E-Mail-Adresse, wie sie in den Benutzerinformationen gespeichert ist (oder leer, wenn keine E-Mail-Adresse angegeben ist). |
| ComputerName | I | Name des Rechners, auf dem die Version erstellt wurde. |
| DnameStorage | I | Name des Unterverzeichnisses, in dem das Archiv der Version gespeichert ist, im Format YYYYMMDD.{NNN} |
| State | I | Sperrstatus der Version/des Archivs |
[QuickSave]
Diese Sektion ist nur vorhanden, wenn eine Schnellspeicherung der Komponente wiederhergestellt wurde.
| Schlüssel | I/O | Beschreibung | Werte |
|---|---|---|---|
| Enabled | I | Gibt an, ob Schnellspeicherungen für diese Komponente aktiviert sind. | Y: Schnellspeicherungen sind aktiviert. N: Schnellspeicherungen sind deaktiviert. Wenn für diesen Schlüssel kein Wert angegeben wird, nimmt das System N als Wert an. |
| Dir | I | Relativer Pfad des Komponentenverzeichnisses, beginnend mit einem Backslash. Am Ende des Pfades steht kein Backslash. Dieser Schlüssel wird nur angegeben, wenn der Schlüssel Enabled den Wert Y hat. | |
| ID | I | Komponenten-ID Dieser Schlüssel wird nur angegeben, wenn der Schlüssel Enabled den Wert Y hat. |
[ExclusiveUse]
| Schlüssel | I/O | Beschreibung |
|---|---|---|
| UserID | I | ID des Benutzers, der die Komponente für andere Benutzer gesperrt hat, als String mit 32 Zeichen Wird kein Wert oder ein Nullwert angegeben, ist die Komponente nicht gesperrt. |
| UserName | I | Name des Benutzers, der die Komponente für andere Benutzer gesperrt hat. |
| UserFullName | I | Vollständiger Namen des Benutzers, der die Komponente für andere Benutzer gesperrt hat. Der Schlüssel wird nur angegeben, wenn der Name im Modul Benutzermanagement festgelegt ist. |
| DomainName | I | Domain, in welcher der Benutzer angemeldet ist. |
| EmailAddress | I | E-Mail-Adresse, wie sie in den Benutzerinformationen gespeichert ist (oder leer, wenn keine E-Mail-Adresse angegeben ist). |
| ComputerName | I | Name des Rechners, von dem aus die Komponente für andere Benutzer gesperrt wurde |
| TimeStampUtc | I | Zeitpunkt, zu dem die Komponente in diesen Status versetzt wurde, im UTC-Zeitformat (YYYYMMDDHHMMSS) |
| TimeStampLocal | I | Zeitpunkt, zu dem die Komponente in diesen Status versetzt wurde, im lokalen Zeitformat (YYYYMMDDHHMMSS) |
[UnderDevelopment]
| Schlüssel | I/O | Beschreibung |
|---|---|---|
| UserId | I | ID des Benutzers, der die Komponente als In Bearbeitung gekennzeichnet hat, als String mit 32 Zeichen. Wird kein Wert oder der Wert Null eingegeben, ist die Komponente nicht als In Bearbeitung gekennzeichnet. |
| UserName | I | Name des Benutzers, der die Komponente als In Bearbeitung gekennzeichnet hat |
| UserFullName | I | Vollständiger Namen des Benutzers, der die Komponente als In Bearbeitung gekennzeichnet hat. Der Schlüssel wird nur angegeben, wenn der Name im Modul Benutzermanagement festgelegt ist. |
| DomainName | I | Domain, in welcher der Benutzer angemeldet ist. |
| EmailAddress | I | E-Mail-Adresse, wie sie in den Benutzerinformationen gespeichert ist (oder leer, wenn keine E-Mail-Adresse angegeben ist). |
| ComputerName | I | Name des Rechners, von dem aus die Komponente als In Bearbeitung gekennzeichnet wurde |
| TimeStampUtc | I | Zeitpunkt, zu dem die Komponente in diesen Status versetzt wurde, im UTC-Zeitformat (YYYYMMDDHHMMSS) |
| TimeStampLocal | I | Zeitpunkt, zu dem die Komponente in diesen Status versetzt wurde, im lokalen Zeitformat (YYYYMMDDHHMMSS) |
[ClientInformation]
| Schlüssel | I/O | Beschreibung |
|---|---|---|
| ComputerName | I | Rechnername und ggf. die dazugehörige Domain des Rechners, von dem aus ausgecheckt oder eingecheckt wurde. |
| IpAddress | I | IP-Adresse des Rechners, von dem aus ausgecheckt oder eingecheckt wurde. |
[Result]
| Schlüssel | I/O | Beschreibung |
|---|---|---|
| ErrorText | O | Gibt an, ob die Skriptanwendung mit einem Fehler beendet wurde und eine Fehlermeldung ausgegeben wurde. Meldungen blockieren Programme, bis sie zur Kenntnis genommen wurden. Daher sollten diese bei serverseitigen Skriptanwendungen nicht verwendet werden. Wird der Wert <na>angegeben, wird keine Fehlermeldung geschrieben. |
| Warnungen | O | Zeigt, ob die Skriptanwendung mit einer Warnung beendet wurde. |
Verwandte Themen