DifficultySchwierigkeitsgrad: noviceAnfänger

Parameter in Vorlagen

Im vorherigen Artikel /wiki/spaces/KB/pages/105971749, you have learned how to find, create and refer to parameters. Parameters are frequently used when generating content from document templates or when sending out emails from Workplace. A template that is set up to be highly dynamic, can be used to tackle multiple different scenarios. In this article, you will learn the basic functionalities to create a template using parameters from Workplace.

Rules for creating (HTML and docx) templates

The basic principles when creating a template applies to all modules in Workplace. The example that we follow in this article will help you to set up your own template. However, before creating a template it is important to know the basic rules:

• Workplace templates used to generate documents and email have the format “.docx” or “.html”.

  • The creation of HTML templates is not discussed in this article. However, the same rules apply as when creating .docx templates

• When exporting the results, a template can be formatted to docx, pdf, or html.

• A parameter is used by placing it between {curly_brackets}.

  • start with Capital letter: The Parameter will return the label of the field.

    • Example: {SystemUserContact} returns “Contact”

  • start with small letter: The Parameter will return the value of the field.

    • Example: {systemUserContact} returns “CON-20001”

• Make sure there that the parameter is an exact copy. Any spaces or wrong use of capital letters inside the brackets will cause a malfunction.

• It is possible to specify your parameter using bold, italic, underlining, color etc. To do so simply apply the desired layout to the parameter. For example:

  • {reference} will result in REQ-230001

  • {reference} will result in REQ-230001

• If translation strings are specified for parameters, the labels and values of a parameter will reflect the specified language of the receiver (assuming the correct settings are applied and translation strings are available).

• If a parameter originates from a list, it is possible to switch on “Auto-expansion”. By adding “1” to the parameter, it will auto-expand based on the values in the list. Note: This only works for parameters situated inside a tabel!

• The use of if-statements is allowed.

Good to know when testing templates

• When you link a template to a page (navigate to instance page > open page definition > PDF tab > New) it can be tested by choosing the ‘Export PDF” or “Export Word” button when you open a reservation. This process is described in more detail in the example below.

• If more than one template is linked to a page definition, the user needs to select what template should be used when pressing 'Export PDF” or “Export Word”.

• Templates are inherited from parent page. However, as soon as one template is linked to a child page, the templates from parent pages can no longer be used on this child page.

• When implementing an email template always make sure to also test it by going through the workflow proces. So actually create and process a reservation/ reservation/ work order/ etc. before putting the template in Production.

Example: create a template for reservations

In this example, we will show you step-by-step, how to create a template for the reservation module in Workplace.

Step 1: When creating a template for reservations, the first step is to check which parameters are available on the page. To check the available parameters for reservations:

1. Navigate to the Reservations via your navigation menu;

2. Click on Reservations;

3. Open a reservation;

   1. Alternatively, create a new reservation;

4. Navigate to parameters (behind the gear symbol).

5. You will now see all the available parameters for reservations that can be referred to in a template.

haben Sie gelernt, wie man Parameter findet, erstellt und auf sie verweist. Parameter werden häufig bei der Generierung von Inhalten aus Dokumentvorlagen oder beim Versand von E-Mails aus Workplace verwendet. Eine Vorlage, die so eingerichtet ist, dass sie sehr dynamisch ist, kann für viele verschiedene Szenarien verwendet werden. In diesem Artikel lernen Sie die grundlegenden Funktionen kennen, um eine Vorlage mit Parametern aus dem Workplace zu erstellen.

Regeln für die Erstellung von Vorlagen (HTML und docx)

Die Grundprinzipien bei der Erstellung einer Vorlage gelten für alle Module im Workplace. Das Beispiel, dem wir in diesem Artikel folgen, wird Ihnen helfen, Ihre eigene Vorlage zu erstellen. Bevor Sie jedoch eine Vorlage erstellen, ist es wichtig, die Grundregeln zu kennen:

• Workplace-Vorlagen, die zur Erstellung von Dokumenten und E-Mails verwendet werden, haben das Format ".docx" oder ".html".

  • Die Erstellung von HTML-Vorlagen wird in diesem Artikel nicht behandelt. Es gelten jedoch die gleichen Regeln wie bei der Erstellung von .docx-Vorlagen

• Beim Exportieren der Ergebnisse kann eine Vorlage als docx, pdf oder html formatiert werden.

• Ein Parameter wird verwendet, indem er zwischen {curly_brackets} gesetzt wird.

  • mit einem Großbuchstaben beginnen: Der Parameter gibt den Etikett des Feldes.

    • Beispiel: {SystemUserContact} gibt "Kontakt" zurück

  • mit einem Kleinbuchstaben beginnen: Der Parameter gibt den Wert des Feldes.

    • Beispiel: {systemUserContact} gibt "CON-20001" zurück

• Achten Sie dabei darauf, dass der Parameter eine exakte Kopie ist. Leerzeichen oder die falsche Verwendung von Großbuchstaben innerhalb der Klammern führen zu einer Fehlfunktion.

• Es ist möglich, den Parameter mit fett, kursiv, Unterstreichung, Farbe usw. Wenden Sie dazu einfach das gewünschte Layout auf den Parameter an. Zum Beispiel:

  • {Referenz} führt zu REQ-230001

  • {Referenz} führt zu REQ-230001

• Wenn Übersetzungszeichenfolgen für Parameter angegeben werden, geben die Bezeichnungen und Werte eines Parameters die angegebene Sprache des Empfängers wieder (vorausgesetzt, die richtigen Einstellungen werden angewendet und Übersetzungszeichenfolgen sind verfügbar).

• Wenn ein Parameter aus einer Liste stammt, ist es möglich, die "automatische Erweiterung" einzuschalten. Wenn Sie dem Parameter eine "1" hinzufügen, wird er automatisch auf der Grundlage der Werte in der Liste erweitert. Hinweis: Dies funktioniert nur für Parameter, die sich innerhalb einer Tabelle befinden!

• Die Verwendung von if-Anweisungen ist zulässig.

Gut zu wissen beim Testen von Vorlagen

• Wenn Sie eine Vorlage mit einer Seite verknüpfen (navigieren Sie zur Instanzseite > Seitendefinition öffnen > Registerkarte PDF > Neu), kann sie getestet werden, indem Sie beim Öffnen einer Reservierung die Schaltfläche "PDF exportieren" oder "Word exportieren" wählen. Dieser Vorgang wird in dem folgenden Beispiel näher beschrieben.

• Wenn mehr als eine Vorlage mit einer Seitendefinition verknüpft ist, muss der Benutzer auswählen, welche Vorlage verwendet werden soll, wenn er "PDF exportieren" oder "Word exportieren" drückt.

• Vorlagen werden von der übergeordneten Seite vererbt. Sobald jedoch eine Vorlage mit einer untergeordneten Seite verknüpft ist, können die Vorlagen der übergeordneten Seiten nicht mehr auf dieser untergeordneten Seite verwendet werden.

• Wenn Sie eine E-Mail-Vorlage implementieren, stellen Sie sicher, dass Sie sie auch testen, indem Sie den Workflow-Prozess durchlaufen. Erstellen und verarbeiten Sie also tatsächlich eine Reservierung, einen Arbeitsauftrag usw., bevor Sie die Vorlage in Produktion geben.

Beispiel: Erstellen einer Vorlage für Reservierungen

In diesem Beispiel zeigen wir Ihnen Schritt für Schritt, wie Sie eine Vorlage für das Reservierungsmodul im Workplace erstellen.

Schritt 1: Wenn Sie eine Vorlage für Reservierungen erstellen, müssen Sie zunächst prüfen, welche Parameter auf der Seite verfügbar sind. Zur Überprüfung der verfügbaren Parameter für Reservierungen:

1. Navigieren Sie zum Reservierungen über Ihr Navigationsmenü;

2. Klicken Sie auf Reservierungen;

3. Öffnen Sie eine Reservierung;

   1. Alternativ können Sie auch eine neue Reservierung anlegen;

4. Navigieren Sie zu Parameter (hinter dem Zahnradsymbol).

5. Sie sehen nun alle verfügbaren Parameter für Reservierungen, auf die in einer Vorlage Bezug genommen werden kann.

Step 2: Create a template using a program that can save your file as “.docx” or “.html”. In this example we’re creating a template in .docx using Microsoft Word.

The example below uses a mix between hard coded text, parameters, translation strings, if-statements, and various style elements (bold, italic, underline, colour) to showcase the most used options for a Workplace template.

• Point 1: Hard coded text and a parameter addressing the contact that will receive the letter.

• Point 2: The parameter is a translation string. Translation strings allow the use of paragraphs, spaces, numeration, etc.

  • A big advantage of using translation string is that once the template has been setup. The text can be managed by editing the translation string. This is often easier than downloading an existing template, editing it, and uploading the new version.

• Point 3: Various style elements incorporated for the parameters.

• Point 4: An if-statement is a conditional statement that takes on different values depending on its specifications.

  • An if-statement always open with a curly bracket. Everything inside the statement is enclosed by normal brackets. The if-stament is closed by a curly bracket.

  • Hard coded text must be enclosed by double quotes. Note: the double quotes must be straight, not angular.

  • If the double quotes are next to each other without any content, as such: ““. We are effectively telling it to show nothing.

  • Commas are separating the values in the if-statement.

  • There must be two equal signs when referring to “equal”.

    • The if-statement in the example below is read as follows: If the parameter item1 is equal to empty, then show the text No reservable items have been selected, else show the parameter item1.

• Point 5: a parameter that ends with the number “1”, is auto-expanded. This is useful when the length of the items in a list varies. To activate the auto-expansion function, the parameter must be in a table format. When you’re using MS Word you can hide the borders of the tabled by using the ‘No border’ option.

  Image Removed

• Point 6: Logos and other pictures can also be added to the template. To control the size and position these are often places in hidden tables. Pictures can also be added to the header and footnote of the document. This functionality is not shown in the example below, but self explanatory.

Example of input (template) and output (template exported to PDF)

Step 3: Testing the template by linking it to the page definition (the reservation page in this example)

1. Navigate to the Reservations via your navigation menu;

2. Click on reservations;

3. Open a reservations that is filled in and contains all the information needed for the parameters you defined.

4. Navigate to the back-end of the page using the page definition;

5. Click on the PDF tab;

6. Click on “new”;

Image Removed

7. Press the “three dots” and upload the template using drag- and drop;

Image Removed

8. You can leave the field ‘PDF parameter’ empty. It will then use the PDF-parameter page that is linked on the ‘General’ tab of the page definition.

9. Note: write down the document number. We need it for later when you’re linking this document as a template for the workflow email.

10. Navigate back to the instance page;

11. Test the template by exporting it as a PDF. If more than one template is linked to the page you have to select the correct template.

Image Removed

Example: link the email template to a workflow connector

Step 4: Linking the template to a workflow connector.

An email can be set up to be sent via the reservations workflow. For most workflow objects standard email templates are applied (See section “Editing the default email templates” below). However, it is also possible to link our own template that we have created in the example above. In this example, we will link our own email template to a workflow connector for reservations.

The template that we have created in the steps above, can be linked to the email by following these steps:

1. Navigate to the Reservations via your navigation menu.

2. Click on Reservations.

3. Open a reservation, or create a new reservation.

4. Click on the workflow tab.

5. Click on the workflow definition button.

   Image Removed

6. Click on the magnifying glass to enter the workflow graphics.

   Image Removed

7. Click on the connector that the email should be sent via.

   1. Emails can only be linked to connectors going from a task to a status (square to a circle);

   2. Emails can also be linked to a status combined with a trigger (e.g. send an email when the status of a workflow has been ‘awaiting approval’ for 3 work days)
      

8. Image Removed

   Click on the Email button.

9. Click on the plus sign to generate a new email.

10. Choose a ‘From’ or 'From group' contact by:

    1. Click on the ‘…' behind the 'From’ field.

    2. Select if your looking for a person or organization.

    3. Type a keyword.

    4. OK.

    5. Selecting a contact.

    6. OK.

11. To determine who received the email set the field “To”:

    1. Click on the '…'.

    2. Click the ‘To systemgroup’ button. It is also possible to send an email to a specific contact or organization. The front desk could for example be put in the Cc for reservation all emails.

    3. Type a keyword.

    4. OK.

    5. select one or more groups by clicking the checkbox.

    6. OK.

    7. Press OK a second time to return to the email definition.

12. Cc and Bcc in the same manner (optional).

13. Fill in the subject of the email. This can contain a translation string.

14. Change the setting for ‘Expand recipients’ if needed.

15. Upload the template using the drag and drop function. Alternatively, if the template already exists in the environment (because you already tested it):

    1. Click on the Add button in the document include.

    2. Click on Advanced search.

    3. Empty all the filters and search for the document number (generated earlier in step 3).

    4. Select the document and click OK.

Settings on the email definition

Hovering over the settings will show a help text. The most common settings are explained in the table below.

Setting

Explenation

From (group)

Define the from contact of the email

To, Cc, Bcc

Who should receive the email

Subject

Subject of the email. Can contain translation string or parameters

Send

Only change this setting when you want to use the the ‘Depend on object’ option. In which case the email is only send when the setting “Send email = yes”‘ for the problem type that is linked to the object (problemType.sendWorkflowMessageCode).

Expand recipients 

Yes: all recipients receive a separate email. Tis settings needs to be set to ‘yes’ if the email should be translated to the languages of the receiver.

No: One email is send with all the recipients in the To/ Cc/ Bcc.

Text

If you want to create a very simple email, the body of the email can be created here. This is than used instead of the template.

Archive message

By default the email is not saved with the object. Set to ‘yes’ if the send emails should be saved to the ‘Messages’ tab (for example on a reservation). It could be that the message tab is not configured yet. This setting does not affect the email log report.

Confirm 

Asks for confirmation before sending the email. Also gives the option to edit the email before sending.

Only system users 

When enabled, email is only send to contacts that are linked to a Workplace system user.

Editing the default email templates

When implementing a module using the SBRs, the default email templates are applied to that Workplace environment. When the default mail templates need to be modified and the email do not exist in the client environment, the steps below can be followed.

Click on Generate standard emails button on the bottom of the page.

Image Removed

The email can now be accesses by pressing the envelop icon on the top right OR by navigating to the graphical workflow view > opening the corresponding workflow connector > press the ‘Email’ button.

Summary

SearchSchritt 2: Erstellen Sie eine Vorlage mit einem Programm, das Ihre Datei als ".docx" oder ".html" speichern kann. In diesem Beispiel erstellen wir eine Vorlage im .docx-Format mit Microsoft Word.

Das folgende Beispiel verwendet eine Mischung aus hart kodiertem Text, Parametern, Übersetzungsstrings, if-Anweisungen und verschiedenen Stilelementen (fett, kursiv, unterstrichen, farbig), um die am häufigsten verwendeten Optionen für eine Workplace-Vorlage zu zeigen.

• Punkt 1: Hart kodierter Text und ein Parameter, der den Kontakt angibt, der den Brief erhalten soll.

• Punkt 2: Der Parameter ist eine Übersetzungszeichenfolge. Übersetzungszeichenfolgen ermöglichen die Verwendung von Absätzen, Leerzeichen, Nummerierungen usw.

  • Ein großer Vorteil der Verwendung von Übersetzungsstrings ist, dass die Vorlage einmal eingerichtet wurde. Der Text kann durch Bearbeitung der Übersetzungszeichenfolge verwaltet werden. Das ist oft einfacher, als eine bestehende Vorlage herunterzuladen, sie zu bearbeiten und die neue Version hochzuladen.

• Punkt 3: Verschiedene Stilelemente für die Parameter.

• Punkt 4: Eine if-Anweisung ist eine bedingte Anweisung, die je nach ihren Spezifikationen unterschiedliche Werte annimmt.

  • Eine if-Anweisung beginnt immer mit einer geschweiften Klammer. Alles innerhalb der Anweisung wird von normalen Klammern umschlossen. Die if-Anweisung wird durch eine geschweifte Klammer abgeschlossen.

  • Hart kodierter Text muss in doppelte Anführungszeichen gesetzt werden. Hinweis: Die doppelten Anführungszeichen müssen gerade sein, nicht schräg.

  • Wenn die doppelten Anführungszeichen ohne Inhalt nebeneinander stehen, wie z.B.: "". Wir sagen dem Programm damit, dass es nichts anzeigen soll.

  • Die Werte in der if-Anweisung werden durch Kommas voneinander getrennt.

  • Bei "gleich" müssen zwei Gleichheitszeichen stehen.

    • Die if-Anweisung im folgenden Beispiel lautet wie folgt: Wenn der Parameter Artikel1 ist gleich leer, dann den Text anzeigen Es wurden keine reservierbaren Artikel ausgewählt, sonst den Parameter anzeigen Artikel1.

• Punkt 5: Ein Parameter, der mit der Zahl "1" endet, wird automatisch erweitert. Dies ist nützlich, wenn die Länge der Elemente in einer Liste variiert. Um die Funktion der automatischen Erweiterung zu aktivieren, muss der Parameter in einem Tabellenformat vorliegen. Wenn Sie MS Word verwenden, können Sie die Ränder der Tabelle ausblenden, indem Sie die Option "Kein Rand" verwenden.

  Image Added

• Punkt 6: Logos und andere Bilder können ebenfalls in die Vorlage eingefügt werden. Um die Größe und Position zu kontrollieren, werden diese oft in versteckten Tabellen platziert. Bilder können auch in die Kopf- und Fußzeilen des Dokuments eingefügt werden. Diese Funktion wird im folgenden Beispiel nicht gezeigt, ist aber selbsterklärend.

Beispiel für Eingabe (Vorlage) und Ausgabe (in PDF exportierte Vorlage)

Schritt 3: Testen der Vorlage durch Verknüpfung mit der Seitendefinition (in diesem Beispiel die Reservierungsseite)

1. Navigieren Sie zum Reservierungen über Ihr Navigationsmenü;

2. Klicken Sie auf Reservierungen;

3. Öffnen Sie eine Reservierung, die ausgefüllt ist und alle Informationen enthält, die für die von Ihnen festgelegten Parameter erforderlich sind.

4. Navigieren Sie über die Seitendefinition zum Backend der Seite;

5. Klicken Sie auf die Registerkarte PDF;

6. Klicken Sie auf "Neu";

Image Added

7. Drücken Sie die "drei Punkte" und laden Sie die Vorlage per Drag-and-Drop hoch;

Image Added

8. Sie können das Feld "PDF-Parameter" leer lassen. Dann wird die Seite mit den PDF-Parametern verwendet, die auf der Registerkarte "Allgemein" der Seitendefinition verlinkt ist.

9. Hinweis: Notieren Sie sich die Dokumentennummer. Wir brauchen sie später, wenn Sie dieses Dokument als Vorlage für die Workflow-E-Mail verknüpfen.

10. Navigieren Sie zurück zur Instanzseite;

11. Testen Sie die Vorlage, indem Sie sie als PDF exportieren. Wenn mehr als eine Vorlage mit der Seite verknüpft ist, müssen Sie die richtige Vorlage auswählen.

Image Added

Beispiel: Verknüpfung der E-Mail-Vorlage mit einem Workflow-Konnektor

Schritt 4: Verknüpfung des Musters mit einem Workflow-Konnektor.

Eine E-Mail kann so eingerichtet werden, dass sie über den Buchungsworkflow versendet wird. Für die meisten Workflow-Objekte werden Standard-E-Mail-Vorlagen verwendet (siehe Abschnitt "Bearbeiten der Standard-E-Mail-Vorlagen" unten). Es ist jedoch auch möglich, unsere eigene Vorlage zu verknüpfen, die wir im obigen Beispiel erstellt haben. In diesem Beispiel werden wir unsere eigene E-Mail-Vorlage mit einem Workflow-Konnektor für Reservierungen verknüpfen.

Die Vorlage, die wir in den obigen Schritten erstellt haben, kann mit der E-Mail verknüpft werden, indem Sie diese Schritte ausführen:

1. Navigieren Sie zum Reservierungen über Ihr Navigationsmenü.

2. Klicken Sie auf Reservierungen.

3. Öffnen Sie eine Reservierung, oder erstellen Sie eine neue Reservierung.

4. Klicken Sie auf das Workflow-Registerkarte.

5. Klicken Sie auf die Schaltfläche Workflow-Definition.

   Image Added

6. Klicken Sie auf die Lupe, um die Workflow-Grafik aufzurufen.

   Image Added

7. Klicken Sie auf den Anschluss, über den die E-Mail gesendet werden soll.

   1. E-Mails können nur mit Verbindungen verknüpft werden, die von einer Aufgabe zu einem Status führen (Quadrat zu Kreis);

   2. E-Mails können auch mit einem Status in Verbindung mit einem Auslöser verknüpft werden (z. B. eine E-Mail senden, wenn der Status eines Arbeitsablaufs seit 3 Arbeitstagen "zur Genehmigung anstehend" ist).
      

8. Image Added

   Klicken Sie auf das E-Mail Taste.

9. Klicken Sie auf das plus Zeichen, um eine neue E-Mail zu erstellen.

10. Wählen Sie einen "Von"- oder "Von-Gruppe"-Kontakt aus:

    1. Klicken Sie auf das "..." hinter dem Feld "Von".

    2. Wählen Sie aus, ob Sie nach einer Person oder einer Organisation suchen.

    3. Geben Sie ein Schlüsselwort ein.

    4. GUT.

    5. Auswählen eines Kontakts.

    6. GUT.

11. Um zu bestimmen, wer die E-Mail erhalten hat, setzen Sie das Feld "An":

    1. Klicken Sie auf die Schaltfläche '...'.

    2. Klicken Sie auf die Schaltfläche "An Systemgruppe". Es ist auch möglich, eine E-Mail an einen bestimmten Kontakt oder eine Organisation zu senden. Die Rezeption könnte zum Beispiel in der Cc für die Reservierung alle E-Mails gesetzt werden.

    3. Geben Sie ein Schlüsselwort ein.

    4. GUT.

    5. eine oder mehrere Gruppen durch Anklicken des Kontrollkästchens auswählen.

    6. GUT.

    7. Drücken Sie ein zweites Mal OK, um zur E-Mail-Definition zurückzukehren.

12. Cc und Bcc auf die gleiche Weise (optional).

13. Füllen Sie den Betreff der E-Mail aus. Dieser kann eine Übersetzungszeichenfolge enthalten.

14. Ändern Sie bei Bedarf die Einstellung für "Empfänger erweitern".

15. Laden Sie die Vorlage mit Hilfe der Drag-and-Drop-Funktion hoch. Alternativ, wenn die Vorlage bereits in der Umgebung vorhanden ist (weil Sie sie bereits getestet haben):

    1. Klicken Sie auf das hinzufügen Schaltfläche im Dokument enthalten.

    2. Klicken Sie auf Erweiterte Suche.

    3. Leeren Sie alle Filter und suchen Sie nach der Dokumentnummer (die zuvor in Stufe 3).

    4. Wählen Sie das Dokument aus und klicken Sie auf GUT.

Einstellungen in der E-Mail-Definition

Wenn Sie mit der Maus über die Einstellungen fahren, wird ein Hilfetext angezeigt. Die gebräuchlichsten Einstellungen werden in der nachstehenden Tabelle erläutert.

Bearbeiten der Standard-E-Mail-Vorlagen

Bei der Implementierung eines Moduls unter Verwendung der SBRs werden die Standard-E-Mail-Vorlagen auf diese Workplace-Umgebung angewendet. Wenn die Standard-E-Mail-Vorlagen geändert werden müssen und die E-Mails in der Client-Umgebung nicht vorhanden sind, können die folgenden Schritte ausgeführt werden.

1. Navigieren Sie zum Reservierungen über Ihr Navigationsmenü.

2. Klicken Sie auf Reservierungen.

3. Öffnen Sie eine Reservierung, oder erstellen Sie eine neue Reservierung.

4. Klicken Sie auf das Workflow-Registerkarte.

5. Klicken Sie auf das Symbol für den Workflow-Fall (oben rechts)

6. Klicken Sie auf die Schaltfläche Workflow-Definition.

7. Klicken Sie auf Erzeugen von Standard-E-Mails am unteren Rand der Seite.

   Image Added

8. Die E-Mail kann nun durch Drücken des Briefumschlag-Symbols oben rechts oder durch Navigieren zur grafischen Workflow-Ansicht > Öffnen des entsprechenden Workflow-Connectors > Drücken der Schaltfläche "E-Mail" aufgerufen werden.

Zusammenfassung

Suche