DifficultyMoeilijkheidsgraad: novicebeginner

Parameters in

sjablonen

In the previous article het vorige 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.

heb je geleerd hoe je parameters kunt vinden, maken en gebruiken. Parameters worden vaak gebruikt bij het genereren van inhoud uit documentsjablonen of bij het verzenden van e-mails vanuit Workplace. Een sjabloon dat is ingesteld om zeer dynamisch te zijn, kan worden gebruikt om meerdere verschillende scenario's aan te pakken. In dit artikel leer je de basisfunctionaliteiten om een sjabloon te maken met behulp van parameters vanuit Workplace.

Regels voor het maken van sjablonen (HTML en docx)

De basisprincipes bij het maken van een sjabloon gelden voor alle modules in Workplace. Het voorbeeld dat we in dit artikel volgen, helpt je om je eigen sjabloon op te zetten. Voordat je een sjabloon maakt, is het echter belangrijk om de basisregels te kennen:

• Werkplaatsjablonen die worden gebruikt om documenten en e-mails te genereren, hebben het formaat ".docx" of ".html".

  • Het maken van HTML-sjablonen wordt niet besproken in dit artikel. Er gelden echter dezelfde regels als bij het maken van .docx-sjablonen

• Bij het exporteren van de resultaten kan een sjabloon worden opgemaakt naar docx, pdf of html.

• Een parameter wordt gebruikt door hem tussen {curly_brackets} te plaatsen.

  • beginnen met een hoofdletter: De parameter geeft de label van het veld.

    • Voorbeeld: {SystemUserContact} geeft "Contact" terug

  • beginnen met een kleine letter: De Parameter geeft de waarde van het veld.

    • Voorbeeld: {systemUserContact} geeft als resultaat "CON-20001".

• Zorg ervoor dat de parameter een exacte kopie is. Spaties of verkeerd gebruik van hoofdletters binnen de haakjes zullen een storing veroorzaken.

• Het is mogelijk om je parameter te specificeren met vet, cursief, onderstreping, kleur enz. Pas hiervoor gewoon de gewenste opmaak toe op de parameter. Bijvoorbeeld:

  • {referentie} zal resulteren in REQ-230001

  • {referentie} zal resulteren in REQ-230001

• Als vertaalstrings worden opgegeven voor parameters, zullen de labels en waarden van een parameter de opgegeven taal van de ontvanger weergeven (ervan uitgaande dat de juiste instellingen zijn toegepast en vertaalstrings beschikbaar zijn).

• Als een parameter afkomstig is van een lijst, is het mogelijk om "Automatisch uitbreiden" in te schakelen. Door "1" toe te voegen aan de parameter, zal deze automatisch uitbreiden op basis van de waarden in de lijst. Opmerking: Dit werkt alleen voor parameters in een tabel!

• Het gebruik van if-statements is toegestaan.

Goed om te weten bij het testen van sjablonen

• Wanneer je een sjabloon aan een pagina koppelt (navigeer naar instantiepagina > open paginadefinitie > tabblad PDF > Nieuw), kan deze worden getest door de knop 'PDF exporteren' of 'Word exporteren' te kiezen wanneer je een reservering opent. Dit proces wordt in meer detail beschreven in het onderstaande voorbeeld.

• Als er meer dan één sjabloon is gekoppeld aan een paginadefinitie, moet de gebruiker selecteren welke sjabloon moet worden gebruikt wanneer hij op 'Exporteer PDF' of 'Exporteer Word' drukt.

• Sjablonen worden geërfd van de bovenliggende pagina. Zodra echter een sjabloon aan een kindpagina wordt gekoppeld, kunnen de sjablonen van de ouderpagina's niet meer op deze kindpagina worden gebruikt.

• Als je een e-mailsjabloon implementeert, zorg er dan altijd voor dat je deze ook test door het workflowproces te doorlopen. Dus maak en verwerk een reservering/reservering/werkorder/ etc. voordat u de sjabloon in productie neemt.

Voorbeeld: een sjabloon maken voor reserveringen

In dit voorbeeld laten we je stap voor stap zien hoe je een sjabloon maakt voor de reserveringsmodule in Workplace.

Stap 1: Bij het maken van een sjabloon voor reserveringen is de eerste stap om te controleren welke parameters beschikbaar zijn op de pagina. Om de beschikbare parameters voor reserveringen:

1. Navigeer naar de Reserveringen via je navigatiemenu;

2. Klik op Reserveringen;

3. Open een reservering;

   1. U kunt ook een nieuwe reservering maken;

4. Navigeer naar parameters (achter het tandwielsymbool).

5. U ziet nu alle beschikbare parameters voor reserveringen waarnaar kan worden verwezen in een sjabloon.

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

SearchStap 2: Maak een sjabloon met een programma dat uw bestand kan opslaan als ".docx" of ".html". In dit voorbeeld maken we een sjabloon in .docx met Microsoft Word.

Het onderstaande voorbeeld maakt gebruik van een mix van gecodeerde tekst, parameters, vertaalstrings, if-statements en verschillende stijlelementen (vet, cursief, onderstrepen, kleur) om de meest gebruikte opties voor een Workplace sjabloon te laten zien.

• Punt 1: Hard gecodeerde tekst en een parameter voor de contactpersoon die de brief zal ontvangen.

• Punt 2: De parameter is een vertaalstring. Vertalingstekenreeksen laten het gebruik toe van alinea's, spaties, nummering, enz.

  • Een groot voordeel van het gebruik van vertaalstekenreeksen is dat zodra de sjabloon is ingesteld. De tekst kan worden beheerd door de vertaalstring te bewerken. Dit is vaak gemakkelijker dan een bestaande sjabloon te downloaden, te bewerken en de nieuwe versie te uploaden.

• Punt 3: Diverse stijlelementen opgenomen voor de parameters.

• Punt 4: Een if-statement is een voorwaardelijk statement dat verschillende waarden aanneemt, afhankelijk van de specificaties.

  • Een if-statement opent altijd met een accolade. Alles binnen het statement wordt omsloten door normale haakjes. Het if-statement wordt afgesloten met een accolade.

  • Hard gecodeerde tekst moet tussen dubbele aanhalingstekens staan. Opmerking: de dubbele aanhalingstekens moeten recht zijn, niet hoekig.

  • Als de dubbele aanhalingstekens naast elkaar staan zonder inhoud, zoals: "". We zeggen in feite dat er niets moet worden weergegeven.

  • Komma's scheiden de waarden in de if-statement.

  • Er moeten twee gelijkheidstekens staan als je verwijst naar "gelijk".

    • De if-statement in het onderstaande voorbeeld wordt als volgt gelezen: Als de parameter item1 is gelijk aan leeg, dan de tekst weergeven Er zijn geen reserveerbare items geselecteerd, anders de parameter weergeven item1.

• Punt 5: een parameter die eindigt op het getal "1", wordt automatisch uitgevouwen. Dit is handig wanneer de lengte van de items in een lijst varieert. Om de auto-expansiefunctie te activeren, moet de parameter in tabelformaat zijn. Als je MS Word gebruikt, kun je de randen van de tabel verbergen met de optie 'Geen rand'.

  Image Added

• Punt 6: Logo's en andere afbeeldingen kunnen ook worden toegevoegd aan de sjabloon. Om de grootte en positie te regelen worden deze vaak in verborgen tabellen geplaatst. Afbeeldingen kunnen ook worden toegevoegd aan de kop- en voetnoot van het document. Deze functionaliteit wordt niet getoond in het onderstaande voorbeeld, maar spreekt voor zich.

Voorbeeld van invoer (sjabloon) en uitvoer (sjabloon geëxporteerd naar PDF)

Stap 3: Test de sjabloon door deze te koppelen aan de paginadefinitie (de reserveringspagina in dit voorbeeld)

1. Navigeer naar de Reserveringen via je navigatiemenu;

2. Klik op reserveringen;

3. Open een reservatie die is ingevuld en die alle informatie bevat die nodig is voor de parameters die je hebt gedefinieerd.

4. Navigeer naar de achterkant van de pagina met behulp van de paginadefinitie;

5. Klik op het tabblad PDF;

6. Klik op "nieuw";

Image Added

7. Druk op de "drie puntjes" en upload de sjabloon met slepen en neerzetten;

Image Added

8. U kunt het veld 'PDF-parameter' leeg laten. Dan wordt de PDF-parameterpagina gebruikt die is gekoppeld op het tabblad 'Algemeen' van de paginadefinitie.

9. Opmerking: schrijf het documentnummer op. Dat hebben we later nodig als je dit document koppelt als sjabloon voor de workflow e-mail.

10. Navigeer terug naar de instantiepagina;

11. Test de sjabloon door hem te exporteren als PDF. Als er meer dan één sjabloon aan de pagina is gekoppeld, moet je de juiste sjabloon selecteren.

Image Added

Voorbeeld: de e-mailsjabloon koppelen aan een workflowconnector

Stap 4: De sjabloon koppelen aan een workflowconnector.

Er kan een e-mail worden ingesteld om te worden verzonden via de reserveringsworkflow. Voor de meeste workflowobjecten worden standaard e-mailsjablonen toegepast (zie paragraaf "De standaard e-mailsjablonen bewerken" hieronder). Het is echter ook mogelijk om onze eigen sjabloon te koppelen die we in het bovenstaande voorbeeld hebben gemaakt. In dit voorbeeld koppelen we onze eigen e-mailsjabloon aan een workflowconnector voor reserveringen.

De sjabloon die we in de bovenstaande stappen hebben gemaakt, kunnen we aan de e-mail koppelen door deze stappen te volgen:

1. Navigeer naar de Reserveringen via je navigatiemenu.

2. Klik op Reserveringen.

3. Open een reservering of maak een nieuwe reservering.

4. Klik op de tabblad workflow.

5. Klik op de knop workflowdefinitie.

   Image Added

6. Klik op het vergrootglas om de workflowgrafiek te openen.

   Image Added

7. Klik op de connector waarmee de e-mail moet worden verzonden.

   1. E-mails kunnen alleen worden gekoppeld aan connectors die van een taak naar een status gaan (vierkant naar cirkel);

   2. E-mails kunnen ook worden gekoppeld aan een status in combinatie met een trigger (stuur bijvoorbeeld een e-mail als de status van een workflow al 3 werkdagen 'in afwachting van goedkeuring' is).
      

8. Image Added

   Klik op de E-mail knop.

9. Klik op de plus teken om een nieuwe e-mail te genereren.

10. Kies een 'Van' of 'Van groep' contactpersoon door:

    1. Klik op de '...' achter het veld 'Van'.

    2. Selecteer of je op zoek bent naar een persoon of organisatie.

    3. Typ een trefwoord.

    4. OK.

    5. Een contactpersoon selecteren.

    6. OK.

11. Om te bepalen wie de e-mail heeft ontvangen, stel je het veld "Aan" in:

    1. Klik op de knop '...'.

    2. Klik op de knop 'Naar systeemgroep'. Het is ook mogelijk om een e-mail naar een specifieke contactpersoon of organisatie te sturen. De receptie kan bijvoorbeeld in de Cc worden gezet voor het reserveren van alle e-mails.

    3. Typ een trefwoord.

    4. OK.

    5. Selecteer een of meer groepen door op het selectievakje te klikken.

    6. OK.

    7. Druk een tweede keer op OK om terug te keren naar de e-maildefinitie.

12. Cc en Bcc op dezelfde manier (optioneel).

13. Vul het onderwerp van de e-mail in. Dit kan een vertaalstring bevatten.

14. Wijzig indien nodig de instelling voor 'Ontvangers uitbreiden'.

15. Upload de sjabloon met de sleepfunctie. Als alternatief, als de sjabloon al bestaat in de omgeving (omdat je hem al hebt getest):

    1. Klik op de Voeg toe knop in het document zijn.

    2. Klik op Geavanceerd zoeken.

    3. Leeg alle filters en zoek naar het documentnummer (eerder gegenereerd in stap 3).

    4. Selecteer het document en klik op OK.

Instellingen voor de e-maildefinitie

Als je met de muis over de instellingen beweegt, verschijnt er een helptekst. De meest voorkomende instellingen worden in de onderstaande tabel uitgelegd.

De standaard e-mailsjablonen bewerken

Bij het implementeren van een module met behulp van de SBR's worden de standaard e-mailsjablonen toegepast op die Werkplek-omgeving. Wanneer de standaard e-mailsjablonen moeten worden aangepast en de e-mail niet bestaat in de clientomgeving, kunnen de onderstaande stappen worden gevolgd.

1. Navigeer naar de Reserveringen via je navigatiemenu.

2. Klik op Reserveringen.

3. Open een reservering of maak een nieuwe reservering.

4. Klik op de tabblad workflow.

5. Klik op het pictogram van de workflowcase (rechtsboven)

6. Klik op de knop workflowdefinitie.

7. Klik op Standaard e-mails genereren onderaan de pagina.

   Image Added

8. De e-mail kan nu worden geopend door op het enveloppictogram rechtsboven te drukken OF door naar de grafische workflowweergave te gaan > de bijbehorende workflowconnector te openen > op de knop 'E-mail' te drukken.

Samenvatting

Zoek op