Allgemeine Sektionen der Schnittstellendatei¶

Schnittstellendatei¶

Wenn ein Ereignis eintritt, zu dem es eine Skriptschnittstelle gibt, wird eine Schnittstellendatei erstellt. Die Schnittstellendatei ist eine Initialisierungsdatei, die Skriptapplikationen sowie Informationen über die Komponente, ihren Status und über den Benutzer, der das Ereignis ausgelöst hat, zur Verfügung stellt. Sie liegt im Dateiformat INI vor und ist in UTF-16 codiert.

Nachfolgend sind die allgemeinen Sektionen und Schlüssel der Schnittstellendatei aufgelistet. Die Sektionen und Schlüssel, die nur in Schnittstellendateien einzelner Ereignisse vorhanden sind, finden Sie bei den Beschreibungen der Ereignisse.

[Common]¶

Schlüssel	I/O	Beschreibung
RootDirAdmin	I	Vollständiger Pfad des Verzeichnisses mit den Verwaltungsdateien 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 Computers, auf dem die Skriptapplikation ausgeführt wird Format: [Domain].ComputerName 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 Skriptapplikationen temporäre Daten speichern. Jede Skriptapplikation muss temporäre Daten eigenständig löschen. Alle Skriptapplikationen teilen sich ein Verzeichnis für temporäre Daten. Deshalb müssen Unterverzeichnisse und Dateien eindeutig zugeordnet werden können, um sicherzustellen, dass Skriptapplikationen nur die eigenen temporären Daten löschen.
PathLog	I	Vollständiger Pfad des Verzeichnisses, in dem die protokollierten Informationen gespeichert werden. Einige Skriptapplikationen stellen diese Informationen dem gesamten System zur Verfügung. Jede Skriptapplikation muss diese Daten eigenständig löschen.
TimeOutInMin	I	Zeit bis zum Time-out in Minuten. Warnung: Wird der hier eingestellte Wert überschritten, wird die Skriptapplikation sofort und ohne Benachrichtigung geschlossen.
Licence	I	Informationen über die in der Lizenz enthaltenen Funktionen
PathExeVdog	I	Vollständiger Pfad der Anwendung, welche die Skriptapplikation aufgerufen hat (z. B.`C:\Programme\vdog\VDogClient.exe` oder der Pfad zur Serverapplikation)
SilentMode	I	Zeigt, ob die Skriptapplikation Eingaben durch den Benutzer verlangen darf (z. B. durch Meldungen) Y: Es dürfen keine Eingaben verlangt werden. N: Eingaben dürfen verlangt werden. Das bedeutet nicht, dass die Skriptapplikation tatsächlich Eingaben verlangt. Der Standardwert ist Y für serverseitige und N für clientseitige Skriptapplikationen.

[Component]¶

Einige Skriptapplikationen 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	Component ID
ComponentTypeId	I	ID des Komponententyps
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 Skriptapplikationen 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.
Domäne	I	Domäne, in welcher der Benutzer angemeldet 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 Skriptapplikationen unterstützen diese Sektion nicht. Bei einigen Skriptapplikationen ist diese Sektion anders benannt.

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)
Kommentar	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	Domäne, in welcher der Benutzer angemeldet ist.
ComputerName	I	Name des Computers, 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	ID der Komponente. 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	Domäne, in welcher der Benutzer angemeldet ist.
ComputerName	I	Name des Computers, 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 In Bearbeitung gekennzeichnet hat, als String mit 32 Zeichen. Wird kein Wert oder ein Nullwert 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	Domäne, in welcher der Benutzer angemeldet ist.
ComputerName	I	Name des Computers, 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	Computername und ggf. die dazugehörige Domäne 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 Skriptapplikation mit einem Fehler beendet wurde und eine Fehlermeldung ausgegeben wurde. Meldungen blockieren Programme, bis sie zur Kenntnis genommen wurden. Daher sollten diese bei serverseitigen Skriptapplikationen nicht verwendet werden. Wird der Wert`<na>`angegeben, wird keine Fehlermeldung geschrieben.
Warnings	O	Zeigt, ob die Skriptapplikation mit einer Warnung beendet wurde.