Herzlich Willkommen zu unserer neuen Blogreihe „COSIMA Scripting„! Mit Hilfe von Scripting können COSIMA-Anwender*innen mit ein wenig Programmiererfahrung selbst neue und sehr spezifische Funktionalitäten erstellen. Welche spannenden Möglichkeiten das bietet, zeigen wir anhand verschiedener Kundenbeispiele.
Große Datenmengen in DOCUFY COSIMA importieren
Wir beginnen unsere Scripting-Reihe mit einem typischen Use Case, den unsere Kund*innen häufig anfragen: bestimmte Daten liegen außerhalb von DOCUFY COSIMA, werden aber als Teil der Dokumentation im Redaktionssystem benötigt. Da die Daten beliebig strukturiert sein können, ist hier keine Standardlösung möglich, die das Problem für alle adressiert.
Mit Scripting gibt es eine Möglichkeit, Inhalte relativ einfach und schnell nach COSIMA zu überführen. das folgende Beispiel zeigt dies am Beispiel eines Excel-Dokuments.
Einer unserer Kunden muss im Rahmen seines Dokumentationsprozesses eine Vielzahl an weiterführenden Verweisen in die Dokumentation aufnehmen. Dazu liegen dem Kunden mehrere Excel-Dokumente mit folgendem beispielhaften Aufbau vor:
Die Lösung: COSIMA Scripting
Natürlich wäre es möglich, alle Inhalte per Copy & Paste nach DOCUFY COSIMA zu überführen. Bei großen Datenmengen ist das ein langwieriger und vor allem fehleranfälliger Prozess. Die Beispieldatei unseres Kunden enthält alleine über 3.000 Einträge. Das ist manuell einfach nicht mehr durchführbar.
Eine Vereinfachung bietet das neue smarte Copy-Paste-Feature (verfügbar ab COSIMA go! 8.5), das zumindest bereits eine valide Struktur mit Elementen erzeugt. Aber auch hier ist manuelle Nacharbeit nötig, die bei großen Datenmengen sehr aufwendig werden kann.
Wir haben daher für das Unternehmen ein Script erstellt, das die Informationen aus dem Excel-Dokument ausliest und direkt in die gewünschte Struktur importiert. Dabei wird in DOCUFY COSIMA eine Liste erzeugt, die Indexeinträge (Spalte „Keyword“) und URL-Links (Spalte „Link“) enthält. Ein neuer Kontextmenüeintrag im XMAX-Editor ermöglicht die Ausführung dieser Aktion:
Für unseren Kunden ist das hier beschriebene COSIMA Script eine enorme Hilfe, da sowohl der Excel-Import häufig stattfindet als auch der manuelle Prozess sehr zeitaufwendig ist.
Philipp Schulze, Leiter Projektentwicklung, DOCUFY GmbH
Ein Update-Mechanismus ist dabei nicht vorgesehen, was für unseren Kunden für diesen Use Case auch nicht nötig ist.
Ob sich die Automatisierung von Prozessschritten lohnt, hängt immer vom Einzelfall ab. Wichtige Entscheidungskriterien sind dabei u.a. die Häufigkeit, in der die Aktion ausgeführt werden muss (täglich, wöchentlich, monatlich etc.) und der zeitliche Aufwand, der hinter einer manuellen Ausführung steht (5 Minuten, 1 Stunde, 1 Arbeitstag etc.). Speziell der zeitliche Aufwand hängt natürlich auch am Umfang der Daten, wie das gezeigte Beispiel mit den über 3.000 Einträgen gut veranschaulicht.
Ihr Feedback ist sehr willkommen
Von Excel zu XML: Diese neue Artikelreihe beschäftigt sich mit den mächtigen Funktionen von COSIMA Scripting und stellt verschiedene Anwendungsfälle in einzelnen Artikeln vor. Die (künftigen) einzelnen Artikel sollen dazu inspirieren, eigene Optimierungen zu erkennen und zu realisieren. Wir freuen uns sehr, Rückmeldung von Ihren Beispielen oder Vorschläge für zukünftige Artikel dieser Reihe zu erhalten. Unsere Kunden erhalten die in den Artikeln vorgestellte COSIMA Scripte mit einer kurzen Anleitung auf Nachfrage selbstverständlich kostenfrei. Dazu reicht es, eine kurze Mail an support@docufy.de mit dem Stichwort „COSIMA Scripting 01: Von Excel zu XML“ zu schreiben. Voraussetzung für die Nutzung des Scripts ist ein COSIMA in der Version 8.0 oder neuer.
Für weitere Unterstützung oder eine Initial-Umsetzung bieten wir regelmäßig stattfindende Gruppen-Schulungen, aber auch individuelle Workshops an. Zusätzlich bieten wir Ihnen Scripting-Support als Dienstleistung, falls Sie bei selbst erstellten Scripten Unterstützung in Form eines direkten Austauschs mit unseren Entwicklern brauchen.
Über Feedback und Vorschläge für weitere Anwendungsfälle freuen wir uns sehr. Diese können Sie entweder direkt hier in den Kommentaren oder per Mail an philipp.schulze@docufy.de mitteilen.