Reportskripte schreiben

Schreiben Sie ein Reportskript. Autorisierte Benutzer können auf diesem Mandanten alle Skripte ausführen.

Falls Sie einARIS-Standardskript anpassen möchten, nehmen Sie die Änderungen grundsätzlich an Kopien vor. Standardskripte und JS-Dateien werden bei jeder Programmaktualisierung überschrieben. Änderungen an Originaldateien gehen dabei verloren.

Voraussetzung

Vorgehen

  1. Klicken Sie in ARIS Architect auf ARIS > Administration anzeigen Administration.

  2. Klicken Sie in der Leistenanzeige auf Navigation Navigation, wenn die Leiste Navigation noch nicht aktiviert ist.

  3. Klicken Sie im Explorer-Baum doppelt auf den Ordner Auswertungen Auswertungen.

  4. Klicken Sie doppelt auf den Ordner Reporte. Die Reportkategorien werden angezeigt.

  5. Klicken Sie mit der rechten Maustaste auf die Kategorie, der Sie das Reportskript zuordnen möchten, oder legen Sie eine neue Kategorie an.

  6. Klicken Sie auf Neu > Report Report. Der Skript-Assistent wird geöffnet.

  7. Geben Sie die Einträge in den gewünschten Sprachen ein. Sie sollten die Einträge unbedingt in allen Sprachen pflegen, für die eine String-Tabelle im Skript gepflegt ist. Besonders wichtig sind Name und Beschreibung. Sie können Sicherheitseinstellungen festlegen, um unberechtigte Skriptänderungen zu verhindern oder die Ausführung einzuschränken.

  8. Deaktivieren Sie ggf. das Kontrollkästchen Für Anwender verfügbar, wenn Sie z. B. einen Report angelegt, das Skript aber noch nicht vollständig programmiert haben. Im Skript-Assistenten können die Skripte weiterhin bearbeitet werden. Klicken Sie auf Weiter.

  9. Bestimmen Sie, für welche Datenbankelemente das Skript gestartet werden kann, und klicken Sie auf Weiter.

  10. Wählen Sie ggf. einen Auswertungsfilter. Es werden nur die Methodeninhalte berücksichtigt, die sowohl im Methodenfilter, mit dem Sie sich bei der Datenbank angemeldet haben, als auch im gewählten Auswertungsfilter aktiviert sind.

  11. Aktivieren Sie das Kontrollkästchen Ausgabedatei erzeugen, die Option Quelltext eingeben (Code-Ansicht) und aktivieren Sie im Feld Unterstützte Ausgabeformate die Dateiformate, die Benutzer beim Ausführen des Reports für die Ausgabe wählen können.

  12. Nehmen Sie ggf. weitere Einstellungen vor und klicken Sie auf Fertigstellen. Der Skripteditor wird geöffnet.

  13. Schreiben Sie das Skript im Skripteditor. Zum Bearbeiten verwenden Sie bitte die Befehle der Funktionsleisten Start und Debug.

    Verwenden Sie bitte ausschließlich Methoden aus dem Objektmodell für Reporte und Semantikchecks. Sie können den Skript-Code jederzeit anpassen und z. B. eigene Hilfeseiten anbieten. Falls Sie ein Skript nicht von Grund auf schreiben möchten, passen Sie doch einfach die Kopie eines bestehenden Skriptes Ihren Wünschen entsprechend an. Informationen zu ARIS Script-Befehlen erhalten Sie, wenn Sie den Mauszeiger im Skript-Code auf einen Befehl führen und die Taste F1 drücken.

    Im Lieferumfang von ARIS befinden sich viele Standardskripte. Generell empfehlen wir, alle Änderungen von Skripten extern zu dokumentieren, um diese mit Hilfe der Dokumentation während des Aktualisierungsprozesses korrekt zu berücksichtigen.

    Reporte/Makros/Reportvorlagen und -dateien

    Nehmen Sie keine Änderungen an den von uns ausgelieferten Standardskripten vor. Passen Sie immer Kopien von Report-, Makro- und JS-Dateien oder sonstigen Dateien an. Es gibt Ausnahmen, z. B. die Datei atsall<Sprachkürzel>.js.

    Beim Aktualisieren von ARIS werden alle ARIS-Standardskripte und -dateien überschrieben und kundenspezifische Änderungen an diesen Dateien verworfen. Kopierte und selbst geschriebene Skripte und Dateien werden nicht überschrieben.

    Wenn Sie von uns ausgelieferte Dateien geändert, aber nicht kopiert haben, müssen diese vor der Aktualisierung (updatesystemdb) exportiert und nach der Aktualisierung wieder importiert werden. Dadurch erhalten Sie Ihre angepassten Standardskripte aus der entsprechenden Vorversion. In diesem Fall bekommen Sie aber keine Korrekturen oder Aktualisierungen der von uns ausgelieferten Dateien.

    Semantikchecks

    Wir empfehlen Ihnen, für Semantikchecks eigene Regelarten und eigene Profile zu erstellen, in denen die ARIS-Standard-Regelarten und -Regeln referenziert werden.

    Für konfigurierbare Regelarten ist dies nicht möglich (Beziehungsattribut-, Modellattribut-, Objektattribut-, Existenz- und Zuordnungsregeln). Haben Sie diesen Regelarten Regeln hinzugefügt, müssen Sie die Regelarten vor der Aktualisierung exportieren und nach der Aktualisierung importieren.

  14. Klicken Sie in der Menüleiste auf Debug > Syntax prüfen. Falls im Skript syntaktische Fehler gefunden wurden, können Sie diese mit Hilfe der ausgegebenen Liste schnell beheben.

  15. Prüfen Sie das Skript vor der Freigabe. Aktivieren Sie die Funktionsleiste Debug und klicken Sie auf die Schaltfläche Ausführen Ausführen (F9).

Das Skript ist angelegt. Wenn Sie es Anwendern zur Verfügung gestellt haben, können es alle Benutzer auf diesem Mandant im Report-Assistenten wählen.

Falls Sie weitere Auswertungsskripte benötigen, können Sie Reportausgaben in der Entwurfsansicht erzeugen. Wenn Sie über Kenntnisse in den Programmiersprachen JavaScript und ARIS Script verfügen, können Sie eigene Reportskripte schreiben oder Kopien bestehender Standardskripte anpassen.

Im Lieferumfang von ARIS befinden sich viele Standardskripte. Generell empfehlen wir, alle Änderungen von Skripten extern zu dokumentieren, um diese mit Hilfe der Dokumentation während des Aktualisierungsprozesses korrekt zu berücksichtigen.

Reporte/Makros/Reportvorlagen und -dateien

Nehmen Sie keine Änderungen an den von uns ausgelieferten Standardskripten vor. Passen Sie immer Kopien von Report-, Makro- und JS-Dateien oder sonstigen Dateien an. Es gibt Ausnahmen, z. B. die Datei atsall<Sprachkürzel>.js.

Beim Aktualisieren von ARIS werden alle ARIS-Standardskripte und -dateien überschrieben und kundenspezifische Änderungen an diesen Dateien verworfen. Kopierte und selbst geschriebene Skripte und Dateien werden nicht überschrieben.

Wenn Sie von uns ausgelieferte Dateien geändert, aber nicht kopiert haben, müssen diese vor der Aktualisierung (updatesystemdb) exportiert und nach der Aktualisierung wieder importiert werden. Dadurch erhalten Sie Ihre angepassten Standardskripte aus der entsprechenden Vorversion. In diesem Fall bekommen Sie aber keine Korrekturen oder Aktualisierungen der von uns ausgelieferten Dateien.

Semantikchecks

Wir empfehlen Ihnen, für Semantikchecks eigene Regelarten und eigene Profile zu erstellen, in denen die ARIS-Standard-Regelarten und -Regeln referenziert werden.

Für konfigurierbare Regelarten ist dies nicht möglich (Beziehungsattribut-, Modellattribut-, Objektattribut-, Existenz- und Zuordnungsregeln). Haben Sie diesen Regelarten Regeln hinzugefügt, müssen Sie die Regelarten vor der Aktualisierung exportieren und nach der Aktualisierung importieren.

Siehe auch

Was ist ein ARIS-Report?

Makro anlegen