Moeilijkheidsgraad: beginner

Parameters in sjablonen

In het vorige artikel https://spacewell.atlassian.net/wiki/spaces/KB/pages/105971749heb 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.

Stap 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'.

  Open

  

   

• 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)

 

Open

.docx-sjabloon

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";

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

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.

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.

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

    

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. 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.

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