Scripting in FirstSpirit

Mithilfe von Skripten lassen sich unterschiedliche Arten von Bedienungsabläufe in FirstSpirit automatisieren. Ein Skript dient dabei zur Beschreibung des auszuführenden Ablaufes und kann bei Bedarf Veränderungen an FirstSpirit Datenstrukturen vornehmen. Skripte ermöglichen eine schnelle Umsetzung von Funktionalitäten, die in FirstSpirit noch nicht vorhanden sind. Weitere Einsatzgebiete sind zum Beispiel komplexe Migrationsszenarien und die Anbindung externer Systeme.

FirstSpirit-Skripte stellen eine leichtgewichtige Möglichkeit dar, neue Funktionaliäten in FirstSpirit zu integrieren. Aus Gründen der Stabilität wird jedoch empfohlen, Funktionalitäten, die langfristig benötigt und eingesetzt werden, als FirstSpirit-Modul mit Executable oder Plugin umzusetzen.

Skriptsprache BeanShell

Die unterstützte Skriptsprache in FirstSpirit ist BeanShell. Die BeanShell-Syntax ist stark an JAVA angelegt, bietet aber zahlreiche Vereinfachungen, beispielsweise dynamische statt statische Typisierung globaler Variablen und Funktionen sowie einen (eingeschränkten) reflexiven Zugriff auf das Programm selbst und viele weitere Funktionalitäten:

Weitere Informationen über diese Skriptsprache befinden sich auf der Website www.beanshell.org, die zudem ein ausführliches Manual (EN) zur Verfügung stellt.

Scripting mit BeanShell bietet eine hohe Flexibilität für den Vorlagenentwickler. Das Arbeiten mit Skripten ist jedoch nicht trivial, daher sollte vor dem Einsatz eines Skripts genau geprüft werden, ob nicht bereits eine entsprechende Funktionalität in FirstSpirit vorhanden ist!

Skript-Kontexte

Die Verwendung von Skripten ist in unterschiedlichen Kontexten von FirstSpirit möglich:

• Vorlagen-, Menü- und Kontextmenü-Skripte laufen im SiteArchitect und im ContentCreator und können dem Redakteur unter anderem Eingabefenster zur Verfügung stellen. Daher sind diese Arten von Skripten gut geeignet, um häufig wiederkehrende Bedienungsabläufe innerhalb des Redaktionsprozesses projektspezifisch zu automatisieren. Diese Skripte können anhand von Zusatzinformationen (z. B. eingeloggter Benutzer, Art des aktuell selektierten Objekts) im Kontextmenü ein- oder ausgeblendet werden.
• Serviceskripte (im Hintergrund des FirstSpirit-Servers)
• Pre- oder Postdeployment-Skripte

Skripte erstellen

Neue Skripte können in der Vorlagen-Verwaltung unterhalb des Knotens „Skripte“ erstellt werden, und zwar über das Kontextmenü, Eintrag „Neu“ / „Skript anlegen“.

Zu weiteren Informationen siehe Kapitel Skripte.