Berichte

Der iCL Designer stellt eine Standard-Berichtsvorlage zur Verfügung, die automatisch alle Daten Ihrer Inspektionen enthält - unabhängig davon, wie Sie Ihre Arbeitsmappe erstellen oder ändern.

Oft müssen Sie das Aussehen oder das Branding eines Berichts ändern. Oder Sie möchten sogar ändern, welche Daten in Ihren Berichten angezeigt werden und wie sie angezeigt werden.

Um Ihnen diese Flexibilität zu bieten, ist iCL mit [dox42] (https://www.dox42.com) integriert. dox42 bietet Add-Ins für Microsoft Word, Excel und PowerPoint und ermöglicht Ihnen die Erstellung und Bearbeitung Ihrer Berichtsvorlagen mit diesen Tools.

Dieser Abschnitt führt Sie in dox42 ein und erklärt, wie Sie mit Daten aus Ihren Arbeitsmappen arbeiten können, um einen benutzerdefinierten Bericht zu erstellen.

Erste Schritte mit Berichten

1. Einrichten von dox42

Gehen Sie zu www.dox42.com und wählen Sie oben rechts Download.

Laden Sie dann die dox42 Add-Ins herunter, indem Sie zunächst die Nutzungsbedingungen akzeptieren.

Nachdem der Download abgeschlossen ist, entpacken Sie den Inhalt der zip-Datei. Sie wird folgende Ordner enthalten:

Wie Sie sehen, gibt es Add-Ins für Word, Excel und PowerPoint. Wir benötigen vorerst nur das Word-Add-In. Öffnen Sie also den Ordner dox42WordAddInVx.x.x.x und führen Sie die setup.exe aus:

Klicken Sie sich einfach durch den Installationsassistenten, denn es sind keine wichtigen Einstellungen zu machen.

Um zu überprüfen, ob Sie das Word Add-In erfolgreich installiert haben, starten Sie Microsoft Word. Sie sollten nun die Registerkarte dox42 sehen:

Tipp

Falls die Schaltflächen in der Ribbon Bar ausgegraut sind, ist Ihre Installation noch nicht lizenziert. Um eine erste kostenlose Lizenz zu erhalten, holen Sie sich eine kostenlose Testlizenz aus dem dox42 free program Wählen Sie einfach Request a Free Key, geben Sie Ihre E-Mail, Ihren Namen und Ihre Firma ein, und Sie erhalten Ihren Lizenzschlüssel innerhalb weniger Minuten.

Danach klicken Sie auf Activate in der Ribbon Bar und geben Ihren Lizenzschlüssel ein.

Sie sollten nun ein funktionierendes dox42 Add-In haben

Tipp

Um iCL-Berichtsvorlagen mit dox42 bearbeiten zu können, müssen Sie auch den iCL Designer installiert haben. Ansonsten wird beim Öffnen einer Berichtsvorlage der folgende Fehler angezeigt:

In diesem Fall installieren Sie den iCL Designer und führen ihn einmal aus. Beim Starten wird die iCL DataSource in dox42 automatisch konfiguriert. ✨

2. Erzeugen Sie Ihren ersten Bericht

Jetzt, wo dox42 in Betrieb ist, können Sie Ihren ersten Bericht erstellen. Öffnen Sie dazu eine beliebige Arbeitsmappe im iCL Designer.

Gehen Sie zu den workbook settings und klicken Sie auf das Kopiersymbol der Reports

Dann fügen Sie CTRL+V in einen beliebigen Ordner ein und Sie werden die folgenden zwei Dateien sehen:

Die Datei default.docx ist die Berichtsvorlage und definiert das Aussehen des Berichts. Für das Einfügen von Daten verweist sie auf Datenquellen. Diese werden in der Datei default.dm konfiguriert, die data map genannt wird. Sie enthält alle Konfigurationsdetails der Datenquellen, die in dem Bericht verwendet werden.

Öffnen Sie die Datei default.docx durch Doppelklick. Microsoft Word sollte sich öffnen und die Berichtsvorlage anzeigen.

Um den Bericht zu erstellen, klicken Sie auf die Schaltfläche play im Ribbon-Menü

In einem Dialog werden Sie nach einem Dateipfad zu einer *.iclr-Datei gefragt. Dies ist ein Archiv, das alle Daten einer einzelnen Prüfung enthält.

Normalerweise gehen Sie zum iCL Portal und laden die iclr-Datei von einer bestimmten Inspektion herunter, wie unten gezeigt:

Alternativ können Sie auch 💾 diese ICLR-Beispieldatei herunterladen

Als nächstes werden Sie nach einem Parameter namens language gefragt. Wenn Ihre Arbeitsmappe in mehrere Sprachen übersetzt ist, können Sie hier festlegen, in welcher dieser Sprachen die Datenquellen die Daten darstellen sollen. Ist dies nicht der Fall, lassen Sie den Parameter einfach leer und die Standardsprache wird verwendet.

🎉 Herzlichen Glückwunsch! Sie sollten nun Ihren ersten generierten Bericht sehen

Die von iCL bereitgestellten Datenquellen

Um Daten aus dem iCL-System für dox42 verfügbar zu machen, stellt iCL zwei Datenquellen zur Verfügung

1. Die iCL-Datenquelle

Dies ist die Hauptdatenquelle, mit der Sie verschiedene Informationen aus dem iCL-System abrufen können, z. B.

• die Inspektionsinformationen (Inspektionsnummer, Titel, wann und ob die Inspektion abgeschlossen wurde, usw.)
• die Daten aller Checklisten
• die Bilder, die während einer Inspektion aufgenommen oder importiert wurden
• verwandte Inhaltselemente, die während einer Inspektion verwendet/erstellt wurden

Es bietet die folgenden Konfigurationsoptionen:

Name	Beschreibung
Type	Definiert den Typ der Daten, die aus der iclr-Datei extrahiert werden sollen
Name	Der Name dieser Datenquelle. Sie benötigen diesen, wenn Sie die Berichtsvorlage bearbeiten, um die Datenquellen voneinander zu unterscheiden.
Inhaltstyp	Dieses Feld ist nur aktiviert, wenn der Typ der Datenquelle Inhaltselemente ist. In diesem Fall müssen Sie die json-Definition des Inhaltstyps angeben, von dem Sie die Daten abrufen möchten. **Beachten Sie, dass der Inhaltstyp auch in der Arbeitsmappe konfiguriert sein muss und dass nur Inhaltselemente, die bei der Prüfung verwendet wurden, verfügbar sein werden.
Datei	Hiermit kann ein fester Pfad zu einer iclr-Datei angegeben werden. Wir empfehlen jedoch die Verwendung des Parameterfeldes.
Parameterfeld	Dieses Feld enthält den Namen eines dox42-Parameters, der den Pfad zur iclr-Datei enthält. Hinweis: Dies sollte immer filePathField sein, außer in sehr fortgeschrittenen Anwendungsfällen. Also lassen Sie es einfach so wie es ist.

Tipp

Sie können sich die Daten jeder konfigurierten Datenquelle ansehen, indem Sie auf die Schaltfläche Test klicken. Es wird Ihnen ein Datengitter mit allen Daten angezeigt, die von der aktuell ausgewählten iclr-Datei bereitgestellt werden.

2. Die iCL-Plan-Datenquelle

Die Plan Data Source ermöglicht es, Pläne dynamisch zu rendern. Dadurch können Sie nicht immer die gleichen Elemente darstellen, die sich auf einem Plan befinden, sondern diese auch filtern. Zum Beispiel könnten Sie nur Mängel darstellen, die noch nicht behoben wurden.

Es bietet die folgenden Konfigurationsoptionen:

Name	Beschreibung
Name	Der Name dieser Datenquelle. Sie benötigen diesen, wenn Sie die Berichtsvorlage bearbeiten, um die Datenquellen voneinander zu unterscheiden.
Datei	Hiermit können Sie einen festen Pfad zu einer iclr-Datei angeben. Wir empfehlen jedoch die Verwendung des Parameterfeldes.
Parameterfeld	Dieses Feld enthält den Namen eines dox42-Parameters, der den Pfad zur iclr-Datei enthält. Hinweis: Dies sollte immer filePathField sein, außer in sehr fortgeschrittenen Anwendungsfällen. Also lassen Sie es einfach so wie es ist.
Filter	Standardmäßig werden alle verfügbaren Elemente, die sich auf einem Plan befinden, wiedergegeben. Es kann jedoch sein, dass Sie nur offene (d.h. nicht gelöste) Defekte anzeigen lassen möchten. In diesem Fall geben Sie hier einen Filterausdruck an.
Testvariablen (Filter)	Wenn Sie einen Variablennamen in einem Filter angeben, können Sie in diesem Feld einen Wert für diese Variablen zum Testen angeben. Diese Werte werden dann verwendet, wenn Sie auf Test (Elemente anzeigen) klicken, werden aber ansonsten ignoriert. Wenn Sie beispielsweise auf die Datenquelle <%somedatasource.StatusColumn%> verweisen, können Sie einen Testwert von 33 wie folgt angeben Sie können ziemlich fortgeschrittene Filterausdrücke angeben
Sortierung	Ermöglicht die Angabe der Reihenfolge, in der die Elemente auf einem Plan gerendert werden. Dies kann notwendig sein, wenn sich einige Elemente überschneiden. Sie können ziemlich fortgeschrittene Sortierausdrücke angeben.
Testvariablen (Sortierung)	Gleich wie die Testvariablen für Filter: Wenn Sie einen Variablennamen in einem Filter angeben, können Sie in diesem Feld einen Wert für diese Variablen zum Testen angeben. Diese Werte werden dann verwendet, wenn Sie auf Test (Elemente anzeigen) klicken, werden aber ansonsten ignoriert.
Fokussierte Elemente	Standardmäßig werden alle verfügbaren Elemente, die sich auf einem Plan befinden, angezeigt. Falls Sie ein oder mehrere spezifische Elemente darstellen möchten, geben Sie hier deren Identität an. Die Standard-Berichtsvorlage verwendet diese Einstellung, um ein vergrößertes Bild jedes einzelnen Fehlers, der mit Hilfe einer Checkliste gefunden wurde, darzustellen. Dazu verwendet sie den Ausdruck =checklistdata.answerraw
Bildmodus	Ermöglicht es, das Bild entweder im Hoch- oder im Querformat darzustellen.
Deckkraft für nicht fokussierte Elemente	Wenn fokussierte Elemente gerendert werden, werden Elemente, die nicht fokussiert sind, trotzdem gerendert. Sie können eine Deckkraft für sie angeben, damit sie leichter zu unterscheiden sind.
Seitenverhältnis	Sie können das Seitenverhältnis des resultierenden Bildes angeben, z. B. "4:3" oder "16:9".
Maximaler Zoomfaktor	Wenn ein fokussiertes Element gerendert wird, zoomt der Renderer auf dieses Element. Geben Sie hier den maximalen Zoomfaktor an. Falls Sie keine Vergrößerung beim Fokussieren eines Eintrags wünschen, geben Sie einfach "1" ein.
Mindestabstand	Der Mindestabstand, den das fokussierte Element vom Rand des Bildes haben soll.
Gewünschte Breite/Höhe	Da Pläne als Vektorgrafiken bereitgestellt werden können, kann ihre Größe potenziell unendlich sein. Bitte geben Sie hier eine geeignete Bildgröße an, um das beste Verhältnis zwischen Dokumentgröße und Bildqualität zu erzielen.
Bildqualität	Auch wenn Pläne als Vektorgrafiken vorliegen können, ist das resultierende Bild immer ein PNG mit einer Standardqualität von "76". Sie können diese Einstellung überschreiben, um die Dateigröße zu verringern oder die Bildqualität zu verbessern.
Plan-Hintergrundfarbe	Oft wird in Plänen keine Hintergrundfarbe angegeben. Dann können Sie hier eine festlegen. In den meisten Fällen werden Sie #FFFFFF wählen.

Fokussierte Elemente

Fokussierte Elemente erlauben nicht nur die Angabe von Elementen durch die Angabe von IDs, die mit , verkettet sind wie z.B. 82f58ab8-e41a-4f8a-b85e-9f7772b3f278,Item02, unterstützt aber auch die _JSON-Daten, die einen Planort definieren, wie z.B.:

{
    "location":"POINT(342.8304 230.9064)",
    "planId":"c3dbd71d-3fee-4d21-9a59-527a072c4111",
    "itemId":"82f58ab8-e41a-4f8a-b85e-9f7772b3f278",
    "color": "#0000FF",
    "displayText": "M02"
}

Test (Elemente anzeigen)

Wenn Sie testen möchten, ob Ihr Filterausdruck wie erwartet funktioniert, verwenden Sie die Schaltfläche Test (show items). Falls vorhanden, werden die angegebenen Testvariablen berücksichtigt und der Filter wird auf die Liste der angezeigten Elemente angewendet. Hier definieren wir zum Beispiel einen Filter, der auf eine andere Datenquelle verweist. Zum Testen fälschen wir den Wert dieser Datenquelle auf "0" und klicken auf Test (show items). Das resultierende Datengitter zeigt, dass alle Defekte mit dem Status "0" wie beabsichtigt gefiltert worden sind

Die Parameter der Berichtsvorlage

Die dox42 Datamap der Standardberichtsvorlage bietet zwei Parameter, die zur zentralen Konfiguration aller iCL-Datenquellen verwendet werden können. Das iCL Portal stellt automatisch die richtigen Werte für diese Parameter bereit, wenn ein Bericht im System erstellt wird.

1. Parameter filePathField

Dieser Parameter verweist auf die *.iclr-Datei, die alle relevanten Daten einer Inspektion enthält. Alle iCL-Datenquellen beziehen ihre Daten aus dieser Datei. Sie können den Dateipfad auf verschiedene Weise angeben:

1. Geben Sie den Pfad zu einer einzelnen Datei an. (der typischste Fall) Zum Beispiel: c:\downloads\myinspection.iclr

2. Geben Sie eine durch Semikolon ; getrennte Liste von Dateien an. Die Datenquellen fassen dann alle Daten dieser Dateien zusammen. Zum Beispiel: c:\downloads\myinspection.iclr;c:\downloads\my_other_inspection.iclr

   Wenn einer der Pfade zwar existiert, aber auf ein Verzeichnis verweist, werden alle "*.iclr"-Dateien dieses Verzeichnisses angezeigt. Zum Beispiel: c:\downloads\myinspection.iclr;c:\pfad_zu_einem_ordner_der_iclr_dateien_enthält

nicht rekursiv

Wenn ein Ordnerpfad angegeben wird, werden nur *.iclr-Dateien berücksichtigt, die sich direkt in diesem Ordner befinden. Es wird keine rekursive Ordnerdurchsuchung durchgeführt.

3. Geben Sie einen Link zum Herunterladen einer *.iclr-Datei an. Dies kann ein http- oder https-Link sein wie: http://path-to-some.fileserver.net?file=myinspection.iclr

   Auch URL-kodierte Links werden unterstützt. Zum Beispiel: http%3A%2F%2Fpath-to-some.fileserver.net%3Ffile%3Dmyinspection.iclr

2. Parameter language

Dieser Parameter gibt die Ausgabesprache an, die von den iCL-Datenquellen verwendet werden soll, falls es sich um eine mehrsprachige Arbeitsmappe handelt. Wenn Ihre Arbeitsmappe nur eine einzige Sprache enthält (die Standardeinstellung), können Sie diesen Parameter einfach leer lassen.

Ansonsten haben Sie folgende Möglichkeiten

1. (null oder leer)... es wird die Standardsprache verwendet.
2. user ...die Sprache, die der Benutzer für die Durchführung der Inspektion in der Anwendung gewählt hat
3. de...Sprache explizit angeben z.B. 'en','de',...
   Hinweis

   es kann nur eine einzige Sprache angegeben werden

4. <%reportlang%>... verwenden einer Variable. Damit können Sie ein Checklistenfeld angeben, das Ihnen die Sprache für den Bericht liefert.

Hinweis

Falls die Sprache unbekannt/ungültig ist, wird die Standardsprache verwendet

Die Standard-Berichtsvorlage

Da wir nun wissen, wie die Daten des iCL-Systems dox42 zur Verfügung gestellt werden, können wir erklären, wie die Standard-Berichtsvorlage aufgebaut ist.

Checklisten

Der erste Abschnitt ist der komplexeste.

1. Es durchläuft die Datenquelle "checklists", um alle Checklisten zu erhalten.
2. Dann werden für jede Checkliste alle Feldwerte dieser Checkliste mit Hilfe der Datenquelle "checklistdata" ermittelt.
3. Wenn wir uns am Anfang eines Kapitels befinden, wird der Titel des Kapitels eingefügt
4. und wenn wir uns am Anfang einer Überschrift befinden, wird diese hier eingefügt

Dann gibt es für jeden Feldtyp eine bedingte Zeile:

5. für Bilder, Unterschriften und Skizzen
6. für Planstellen (Elemente, die sich auf einem Plan befinden)
7. für Kontrollkästchen
8. für Feststellungen
9. und alle übrigen Felder (Text, mehrzeiliger Text, Zahl, Datum, Zeit, Dropdown, Optionsfeld, usw.)

Bilder

In diesem Abschnitt werden alle Bilder angezeigt, die während einer Inspektion aufgenommen wurden.

Gefahr

Es werden nur Bilder in der Bilderliste berücksichtigt. Bilder von Checklisten werden nicht berücksichtigt.

1. falls Bilder aufgenommen wurden

je nachdem, wie sie konfiguriert wurden

2. sie werden entweder nebeneinander gerendert
3. oder jedes Bild in einer separaten Zeile

Pläne

1. Falls in den aktuellen Inspektionsergebnissen (iclr-Datei) Pläne vorhanden sind
2. werden sie in diesem Abschnitt wiedergegeben

Dynamische Berichtsempfänger

Im Bereich der Berichtskonfiguration in den Arbeitsmappenoptionen können Sie Feldwerte aus den Checklisten als E-Mail-Empfänger oder in das Titelfeld des Berichtsnamens eintragen.

Sie geben einen Platzhalter an, indem Sie einen Feldnamen in <% und %> einschließen. Der Name des Feldes, dessen Antwort eingefügt werden soll, wird in der Mitte eingegeben.

Im folgenden Beispiel existiert das Feld mit dem Titel 'Email' und dem Namen 'email_name' - daher müsste der Platzhalter <%email_name%> lauten.

Namen sind innerhalb einer Checkliste eindeutig. Wenn ein Feldname in mehreren Checklisten gleichzeitig vorkommt, werden die Antwortwerte aller vorhandenen Felder aus allen Checklisten ebenfalls verwendet und mit Kommas verkettet.

Filter für die Berichterstellung

Eine weitere wichtige Eigenschaft im Konfigurationsbereich ist "Create if". Mit ihr können Sie festlegen, ob ein Bericht erstellt werden soll oder nicht. Sie wird über ein blockweises Skript definiert, das bei Abschluss der Prüfung ausgewertet wird. Wenn es nicht definiert ist, wird der Bericht immer erstellt.

best practice

Wir empfehlen dringend, ein verstecktes Feld in der Checkliste zu erstellen (z. B. ein Ja/Nein-Feld), in dem Sie angeben, ob der Bericht erstellt werden soll oder nicht, und dann den Wert dieses Feldes ohne weitere Logik im Skript zur Berichterstellung zu verwenden. Auf diese Weise können Sie das Skript in iCL Filler leicht testen, indem Sie versteckte Felder anzeigen lassen.