ELO Java Client Scripting Documentation
Übersicht der Events und Schnittstellen des ELO Java Clients.
Funktionsauflistung mit Button-Positionen
Die Werte der Parameter werden nach Parameternamen sortiert an das Skript übergeben.
Die verfügbaren Funktionen sind unter
Ribbon-Erweiterungen
Ribbon-Erweiterungen müssen im EventScriptEvents.SimpleScriptEvent.ExpandRibbon mit Hilfe des RibbonAdapter vorgenommen werden.
Die bisherige Event-Methodik wird unter RibbonHookup beschrieben.Funktionsauflistung mit Button-Positionen
JavaScript Events
elo[FunctionName]Start: Start-Events von Ribbon-Funktionen. Bei einem negativen Rückgabewert wird die Funktion abgebrochen.
elo[FunctionName]End: Ende-Events von Ribbon-Funktionen.
Eine Auflistung der Funktionen und ihren Positionen im Ribbon befindet sich in der Funktionsauflistung und in der Java Client Scripting Dokumentation.
Alle darüber hinaus verfügbaren Events sind unter ScriptEvents und ScriptEvents.SimpleScriptEvent aufgelistet.
JavaScript Globalen
| Globale Variable | Klasse | |
|---|---|---|
| workspace | WorkspaceAdapter |
|
| dialogs | DialogsAdapter |
|
| components | ComponentsAdapter |
|
| utils | UtilsAdapter |
|
| indexDialog | IndexDialogAdapter |
|
| archive | ArchiveAdapter |
|
| archiveViews | ArchiveViews |
|
| preview | PreviewAdapter |
|
| intray | IntrayAdapter |
|
| checkout | CheckoutAdapter |
|
| tasksViews | TasksViews |
|
| clipboard | ClipboardAdapter |
|
| searchViews | SearchViews |
|
| myelo | MyEloAdapter |
|
| ribbon | RibbonAdapter |
|
| log | Log |
|
IXServicePortIF |
Nicht mehr verfügbar und durch ixc zu ersetzen, wobei die ClientInfo aus den Parametern entfernt werden muss. |
|
| ix2 | IXConnection |
|
| ixc | IXConnIXServicePortIF_2 |
|
| clientInfo | ClientInfo |
|
| ixConst | IXServicePortC |
|
| ixConnect | IXConnection |
|
| CONST | IXServicePortC |
|
HTTP-Schnittstelle
Standardmäßig ist die HTTP Schnittstelle mit Port 0 aktiviert. In diesem Fall teilt das Betriebssystem automatisch einen freien Port zu. Der Client hinterlegt diesen Port in den Client Einstellungen, unter Windows ist dies in der Registry unterHKEY_CURRENT_USER\SOFTWARE\JavaSoft\Prefs\Elo Digital Office\eloenterprise der Eintrag socketserverport.
Skriptaufruf
Scripte werden mithttp://localhost:PORT/script/SCRIPTFUNCTION?param1=X¶m2=Y¶m3=Z aufgerufen.SCRIPTFUNTKION muss eine mit "http"-Beginnende JavaScript-Funktion sein.Die Werte der Parameter werden nach Parameternamen sortiert an das Skript übergeben.
Skriptergebnis
Das Ergebniss des Skriptaufrufs wird als Fehlercode und JavaScript-Rückgabewert durch einen Pipe getrennt übergeben, z.B.OK|null.
Mögliche Fehlercodes sind OK, SKIP, SCRIPT_FUNCTION_NOT_FOUND, SCRIPT_ERROR, OTHER_ERROR.
COM-Schnittstelle
Die COM-Schnittstelle wird mit dem Objekt "elo.enterprise" angesprochen.Die verfügbaren Funktionen sind unter
EloComServer aufgelistet.
Vorzugsweise sollten jedoch nur die Funktionen EloComServer.runScriptFunction(BStr, BStr) und EloComServer.runScriptFunctionEx(BStr, BStr) verwendet werden und möglichst viel Logik in JavaScripte verlagert werden.