Die Artikelreihe „COSIMA Scripting“  beschäftigt sich mit den mächtigen Funktionen von COSIMA Scripting und stellt verschiedene Anwendungsfälle vor. Die Artikel sollen dazu inspirieren, eigene Optimierungen zu erkennen und zu realisieren.

Einer der häufigsten Use Cases für Anpassungen, die wir für unsere Kunden umsetzen, ist die Integration von COSIMA mit anderen Software-Lösungen. Das Ziel ist dabei immer klar: die doppelte Datenhaltung vermeiden (keine Redundanz) sowie manuelles Copy&Paste vermeiden, um Zeit einzusparen und potentielle Fehlerquellen zu minimieren.

Viele unserer Kunden wissen, dass wir bei DOCUFY mit dem Ticketsystem Jira von Atlassian arbeiten, um Anforderungen und Fehlermeldungen nachvollziehbar zu tracken. Dies gilt auch für Informationen aus den Tickets, die wir als COSIMA Release Notes zusammen mit einem neuen Produktrelease veröffentlichen. Früher hatten wir dafür manuell die relevanten Informationen aus Jira per Copy&Paste nach COSIMA übertragen. Das Ergebnis war dennoch unbefriedigend:

  1. Pro Release war eine Person mehrere Stunden für das Zusammensuchen der Tickets, das manuelle Übertragen und das anschließende Strukturieren in COSIMA beschäftigt
  2. Trotzdem gab es regelmäßig Fehler, da beispielsweise Inhalte nicht vollständig übernommen wurden
  3. Und falls kurzfristig ein Release erforderlich ist, musste das Release Notes Dokument immer erst nachgeliefert werden

Dank den Möglichkeiten von COSIMA Scripting haben wir diesen Prozess nahezu komplett automatisiert:

  1. COSIMA meldet sich mit einem User an unserer Jira-Instanz an,
  2. COSIMA führt eine definierte Suchabfrage nach relevanten Tickets aus,
  3. Jira liefert Informationen aus den Tickets (beispielsweise den Tickettyp wie Bug oder Change Request, die Ticket-Überschrift und ein spezielles „Release Notes“ Feld am Ticket),
  4. COSIMA konvertiert diese Inhalte in Block-Module von COSIMA go! (mit passender DTD-Struktur).
  5. Die neuen Blöcke werden noch Metadaten und Gültikeiten versehen, so dass diese per Publikationskonfigurator sehr einfach als ein Release Notes Dokument strukturiert werden können.
  6. Zum Schluss leistet noch der DOCUFY Layouter seine Arbeit, um daraus ein optisch ansprechendes PDF-Dokument zu erzeugen (natürlich ist auch die Bereitstellung via TopicPilot/CDP problemlos möglich).

Prozess Integration von Inhalten jira-Tickets in COSIMA Release Notes

 

Das zugehörige COSIMA Script ist durchaus umfangreicher, da wir inzwischen viele Sonderkonstellationen und Randbedingungen mit berücksichtigen, um einen möglichst 100% automatischen Ablauf zu gewährleisten. Diese Sonderkonstellationen wurden nach und nach ergänzt, so dass das COSIMA Script mit den Anforderungen mitwachsen kann. Als Beispiel stellen wir Ihnen eine erste Version unseres Scripts bereit, die ein Dialogfeld zur Angabe von Zugangsdaten und einer Jira-Suchabfrage bietet und jedes gefundene Ticket als Block-Modul mit vordefinierten Inhalten aus dem Ticket ablegt. Die Ablage erfolgt in dem Ordner, von dem aus das COSIMA Script gestartet wurde. So haben Sie eine schnelle Startmöglichkeit und können das Script ebenfalls um Ihre individuellen Bedürfnisse erweitern.

Der oben erwähnte Abfragedialog wurde ebenfalls rein mit COSIMA Scripting erstellt und ist Teil des bereitgestellten Scripts. In unserem Beispiel sieht er so aus:

Interessieren Sie weitere externe Systemanbindungen? Oder haben Sie ggf. selbst bereits eine eigene Systemanbindung realisiert und wollen diese mit uns teilen? Dann melden Sie sich gerne bei uns und teilen uns Ihre Use Cases mit.

Interesse geweckt?

Wir freuen uns sehr, Rückmeldung von Ihren Beispielen oder Vorschläge für zukünftige Artikel dieser Reihe zu erhalten. Unsere Kunden bekommen die in den Artikeln vorgestellte COSIMA Scripte mit einer kurzen Anleitung auf Nachfrage selbstverständlich kostenfrei. Dafür einfach eine kurze Mail an support@docufy.de mit dem Titel „Inhalte aus externen Systemen generieren“ schreiben.

Für weitere Unterstützung oder eine Initial-Umsetzung melden Sie sich gerne zu einem unserer Trainings oder zu einem individuellen Workshop an. Zusätzlich bieten wir Ihnen auch Scripting-Support als Dienstleistung an, falls Sie bei selbst erstellten Scripten Unterstützung in Form eines direkten Austauschs mit unseren Entwicklern brauchen, oder Sie sprechen einen unserer Partner an, der Ihnen ebenfalls Unterstützung im Bereich COSIMA Scripting bieten kann.