BeforeUpload
Skriptapplikationen, die von dieser Schnittstelle aufgerufen werden, werden ausgeführt, bevor ein Upload durchgeführt wird. Der Upload wird erst durchgeführt, wenn die Skriptapplikation beendet wurde (abgeschlossen, abgebrochen oder time-out). Dadurch können Uploads vorbereitet werden.
Beispiel: Anlegen von Backups für Geräte, die eine eigene Backup-Funktion haben, aber noch nicht von octoplant unterstützt werden.
Befehlszeile für diese Skriptapplikation
Ohne Agents:
| ScriptBeforeUpload.exe /ConfigFileW:[absoluter Pfad der Schnittstellendatei] /rd:[Pfad des Serverarchivs] /at:s |
Bei Verwendung von Agents:
| ScriptBeforeUpload.exe /ConfigFileW:[absoluter Pfad der Schnittstellendatei] /rd:[Pfad des Agent-Archivs] /at:s |
Beschreibung der Schnittstellendatei
Die Sektion [Component] ist im Abschnitt Allgemeine Sektionen der Schnittstellendatei beschrieben.
Die Sektionen [User] und [Version] sind nicht enthalten.
[Common]
Die Schlüssel RootDirAdmin und DirPrjData werden nicht angegeben. Die weiteren Schlüssel sind im Abschnitt Allgemeine Sektionen der Schnittstellendatei beschrieben.
[Specific]
| INI-Schlüssel | I/O | Erklärung |
|---|---|---|
| UploadClass | I | Name der Uploadklasse |
| DirBackup | I |
Vollständiger Pfad des Verzeichnisses, in dem das entpackte Backup gespeichert wird oder wurde |
| PathArchive | I |
Vollständiger Pfad der Archivdatei (ZIP) der letzten eingecheckten Version Dieser Schlüssel kann leer sein oder fehlen (selbst wenn eine Version eingecheckt ist). |
| PathPreBackup | I |
Vollständiger Pfad der Archivdatei (ZIP) des vorherigen Backups Dieser Schlüssel kann leer sein oder fehlen (selbst wenn es ein archiviertes Backup gibt). |
| Type | I |
Modul, das den Upload angestoßen hat. Folgende Werte sind möglich: 1: Scheduler (manuell/automatisch) 2: Upload&Compare-Funktion Der Standardwert ist 1 |
| JobName | I |
Name des Jobs in der Jobkonfiguration Leerzeichen im Namen sind erlaubt |
| JobID | I | ID des Jobs (als Zeichenfolge mit 32 Zeichen) |
[UploadParameters]
Die Schlüssel dieser Sektion werden immer in Base64 gespeichert. Die Daten sind folgendermaßen codiert: {ParamId}={Value}\0…{ParamId}={Value}\0\0.
Gibt es für einen Schlüssel keine Parameter, wird der Schlüssel nicht angegeben.
| INI-Schlüssel | I/O | Erklärung |
|---|---|---|
| Class | I |
Parameter der Uploadklasse (Quelle octoplant Server - VD$A\Configuration\Upload\Classes.ini) |
| Job | I | Parameter des Uploadjobs |
| Agent | I |
Parameter des Rechners auf dem die Agents installiert sind. (Quelle Agent - VD$A\Configuration\Upload\AgentStation.ini) Dieser Schlüssel kann leer sein oder fehlen. |
[Result]
Die Schlüssel der Sektion sind im Abschnitt Allgemeine Sektionen der Schnittstellendatei beschrieben.
| INI-Schlüssel | I/O | Erklärung |
|---|---|---|
| Done | O |
Zeigt, ob die Skriptapplikation bereits ein Backup angelegt hat Mögliche Werte sind Y und N Der Standardwert ist N |
| Verwandte Themen |
|---|
| Allgemeine Sektionen der Schnittstellendatei |