Versions Compared

Version Old Version 1 New Version Current
Changes made by

Lango: Language and translation manager

Lango: Language and translation manager

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

DifficultyMoeilijkheidsgraad: novicebeginner

Content

Inhoud

Table of Contents
minLevel1
maxLevel1

Learning Objectives

After reading this article you will be able to:

  • Identify parameters.

  • Know where parameters come from.

  • Create new parameters.

What are

Leerdoelen

Na het lezen van dit artikel zul je in staat zijn om:

  • Parameters identificeren.

  • Weet waar parameters vandaan komen.

  • Nieuwe parameters maken.

Wat zijn parameters in Workplace?

A Een parameter in Workplace is a variable used to represent the value displayed within the corresponding field. When the value of a field is updated, the parameter is automatically updated as well. Parameters are for example used as dynamic input for: templates, formulas, and for the email body when sending workflow emails.Example of parameter are {reference} and {firstname}. In an email template this parameter could be used to address the requestor of a reservation personally. For exampleeen variabele die wordt gebruikt om de waarde weer te geven die in het bijbehorende veld wordt weergegeven. Wanneer de waarde van een veld wordt bijgewerkt, wordt de parameter automatisch ook bijgewerkt. Parameters worden bijvoorbeeld gebruikt als dynamische invoer voor: sjablonen, formules en voor de e-mailbody bij het verzenden van workflow e-mails.

Voorbeelden van parameters zijn {referentie} en {voornaam}. In een e-mailsjabloon kan deze parameter worden gebruikt om de aanvrager van een reservering persoonlijk aan te spreken. Bijvoorbeeld:

Code Block
Dear {firstname},

Reservation {reference} is confirmed by the serviceDesk. 
The reservation can now be found on your personal login page.

Warm regards,
{nameofhost}

What parameters are available on a page?

To view the parameters that are available on an instance the page:

  • Open the page (e.g. a reservation);

    • Navigate to the gear symbol;

    Click on Parameters.A list of all the parameters that are available in the context of this page is now shown

    Welke parameters zijn beschikbaar op een pagina?

    Om de parameters te bekijken die beschikbaar zijn op een instantie de pagina:

    1. Open de pagina (bijvoorbeeld een reservering);

    2. Navigeer naar de versnellingssymbool;

    3. Klik op Parameters.

    4. Er wordt nu een lijst weergegeven met alle parameters die beschikbaar zijn in de context van deze pagina.

    • The column “Parameter” shows the parameter that you can use in a template.

    • The column “value” shows the value that will appear when the template is appliedDe kolom "Parameter" toont de parameter die u kunt gebruiken in een sjabloon.

    • De kolom "waarde" toont de waarde die zal verschijnen wanneer de sjabloon wordt toegepast.

    Info

    • NB! Every parameter is available on the parameter page starting with both a small letter and a capital letter.

    • Parameters starting with a small letter uses the value of the instance.

    • Parameters stating with a Capital letter uses the label of the field.

    Viewing the parameters definition

    Parameters are created on the PDF-parameter page that is linked on the page definition of a page. If no parameter page is linked on the page definition, the parameter page is linked to a parent page.

    • The linked page linked in the ‘PDF parameters’ field contains the parameters

    • If the PDF parameter page has includes, the parameters defined on that include will also be available.

    Image Removed

    From what page does a parameter originate?

    When creating a new parameter, or when editing an already existing one, its advised to first lookup where the existing parameters are defined. This tool is especially helpful when parameters originate from multiple pages.

  • Open the page (e.g. a requests);

    • Navigate to the gear symbol;Click on Parameters;

  • When being on the parameter page. Search for the parameter using “ctrl+F”;

  • “Look up behind what “parms-group” the parameter is shown. This is the page on which the parameters are defined.
    In the example, the ‘area’ parameter originates from the “ParametersGOBStandardRequest” page.

    • Image Removed
    Info

    • The parms-groups can be inherited from a parent page.

    • Parameter come from the linked PDF parameters page.

      • field on the PDF parameter page.

      • fields on the include linked to the PDF parameter page.

      • fields from reports linked to the PDF parameter page.

    Creating a parameter - simple

    To add a parameter on the linked PDF parameters page of the instance, follow these steps:

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

    2. Open the linked PDF parameters page;

    3. Image Removed

      Navigate to the fields tab;

    4. Add a new field to the PDF-parameter page;

    5. Fill out the object and field;

    6. The parameter on the page will be equal to the original ‘Field label’;

    7. However, if the ‘Override label’' field is filled in, that will be the name of the parameter.

    Image Removed

    Image Removed

    Creating a parameter - advanced

    Besides adding a regular parameter to the parameter page, it is also possible to:

    • Change the parameter name, but not the field label.

    • Add a translation string as a parameter. This is especially helpful when generating an (email) template that should be translated based on the language of the end user.

    • Use a formula based parameter. This is used when the value of a parameter is based on the calculation of other fields available on the page.

    Info

    Please take into account that for creating parameters, the same logic for fields applies as when adding fields to an instance page. This means that to determine the value of a parameter, Workplace looks up to determine what information to show of other objects. This also means you can link fields to each other if for example the parameters for a contact does not return the information you would expect.

    Change the parameter name, but not the field label

    To create unique parameters, the parameter name might need to deviate from the label name. For example when two contacts are shown on a page.

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

    2. Open the linked PDF parameters page;

    3. Navigate to the fields tab;

    4. Add a new field to the PDF-parameter page;

    5. Fill out the object and field;

    6. Fill the field ‘Parameter’

    Image Removed

    Image Removed

    Generating a translation string parameter

  • Navigate to the back-end of the instance page using page definition;

  • Open the linked PDF parameters page;

  • Navigate to the fields tab;

  • Add a new field to the PDF-parameter page;

  • Leave the object and field empty;

  • Fill in the parameter field;

    1. This value will be the parameter that you can refer to in your template.

    • Fill in or create a new translation string in the “Override label” field;

    The value in the override label will be the value generated when referring to the parameter using a capital letter

    • Elke parameter is beschikbaar op de parameterpagina die begint met zowel een kleine letter als een hoofdletter.

    • Parameters die beginnen met een kleine letter gebruiken de waarde van de instantie.

    • Parameters met een hoofdletter gebruiken het label van het veld.

    De parameterdefinitie bekijken

    Parameters worden aangemaakt op de PDF-parameterpagina die gelinkt is aan de paginadefinitie van een pagina. Als er geen parameterpagina gekoppeld is aan de paginadefinitie, wordt de parameterpagina gekoppeld aan een bovenliggende pagina.

    • De gekoppelde pagina in het veld 'PDF-parameters' bevat de parameters

    • Als de PDF-parameterpagina inclusief is, zijn de parameters die op die inclusief zijn gedefinieerd ook beschikbaar.

    Image Added

    Van welke pagina komt een parameter?

    Wanneer u een nieuwe parameter maakt of een bestaande parameter bewerkt, is het aan te raden eerst op te zoeken waar de bestaande parameters zijn gedefinieerd. Dit hulpmiddel is vooral handig als parameters afkomstig zijn van meerdere pagina's.

    1. Open de pagina (bijvoorbeeld een verzoek);

    2. Navigeer naar de versnellingssymbool;

    3. Klik op Parameters;

    4. Wanneer u op de parameterpagina bent. Zoek naar de parameter met "ctrl+F";

    5. "Zoek op achter welke "parms-groep" de parameter wordt weergegeven. Dit is de pagina waarop de parameters worden gedefinieerd.
      In het voorbeeld komt de parameter 'area' van de pagina "ParametersGOBStandaardRequest".

    Image Added
    Info

    • De parms-groepen kunnen worden geërfd van een bovenliggende pagina.

    • De parameters komen van de gekoppelde PDF-parameterpagina.

      • veld op de PDF-parameterpagina.

      • velden op de inclusief gekoppeld aan de PDF-parameterpagina.

      • velden van rapporten die gekoppeld zijn aan de PDF-parameterpagina.

    Een parameter maken - eenvoudig

    Volg deze stappen om een parameter toe te voegen op de pagina Gekoppelde PDF-parameters van de instantie:

    1. Navigeer naar de back-end van de instantiepagina met behulp van pagina definitie;

    2. Open de gekoppelde PDF-parameterpagina;

    3. Image Added

      Navigeer naar het tabblad Velden;

    4. Een nieuw veld toevoegen aan de PDF-parameterpagina;

    5. Vul het object en het veld in;

    6. De parameter op de pagina zal gelijk zijn aan het oorspronkelijke 'Veldlabel';

    7. Als echter het veld "Override label'' is ingevuld, wordt dat de naam van de parameter.

    Image Added

    Image Added

    Een parameter maken - geavanceerd

    Naast het toevoegen van een gewone parameter aan de parameterpagina, is het ook mogelijk om:

    • Wijzig de parameternaam, maar niet het veldlabel.

    • Voeg een vertaaltekenreeks toe als parameter. Dit is vooral handig bij het genereren van een (e-mail)sjabloon die vertaald moet worden op basis van de taal van de eindgebruiker.

    • Gebruik een parameter op basis van een formule. Dit wordt gebruikt wanneer de waarde van een parameter gebaseerd is op de berekening van andere velden op de pagina.

    Info

    Houd er rekening mee dat voor het maken van parameters dezelfde logica voor velden geldt als bij het toevoegen van velden aan een instantiepagina. Dit betekent dat om de waarde van een parameter te bepalen, Workplace omhoog kijkt om te bepalen welke informatie van andere objecten moet worden getoond. Dit betekent ook dat je velden aan elkaar kunt koppelen als bijvoorbeeld de parameters voor een contact niet de informatie opleveren die je zou verwachten.

    Wijzig de parameternaam, maar niet het veldlabel

    Om unieke parameters te maken, kan het nodig zijn dat de parameternaam afwijkt van de labelnaam. Bijvoorbeeld als er twee contactpersonen op een pagina worden weergegeven.

    1. Navigeer naar de back-end van de instantiepagina met behulp van pagina definitie;

    2. Open de gekoppelde PDF-parameterpagina;

    3. Navigeer naar het tabblad Velden;

    4. Een nieuw veld toevoegen aan de PDF-parameterpagina;

    5. Vul het object en het veld in;

    6. Vul het veld 'Parameter

    Image Added

    Image Added

    Een vertaalstringparameter genereren

    1. Navigeer naar de back-end van de instantiepagina met behulp van pagina definitie;

    2. Open de gekoppelde PDF-parameterpagina;

    3. Navigeer naar het tabblad Velden;

    4. Een nieuw veld toevoegen aan de PDF-parameterpagina;

    5. Laat het object en het veld leeg;

    6. Vul het parameterveld in;

      1. Deze waarde wordt de parameter waarnaar u kunt verwijzen in uw sjabloon.

    7. Vul een nieuwe vertaalstring in of maak deze in het veld "Overschrijven label";

      1. De waarde in het opheffingslabel is de waarde die wordt gegenereerd wanneer naar de parameter wordt verwezen met een hoofdletter.

    Info

    By creating a translation string for the Door een vertaalstring te maken voor het label, it is possible to create sentences that can be translated based on the language of the receiver. This is especially useful when creating templates for emails, contracts, work orders etc.

    Use a formula based parameter

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

    2. Open the linked PDF parameters page;

    3. Navigate to the fields tab;

    4. Add a new field to the PDF-parameter page;

    5. Leave the object and field empty;

    6. Fill in the formula field. Use the help text of this field to configure your formula.

      1. [We’re aiming to create an article on using formulas in 2023]

    Adding parameters from reports and includes

    Besides being added as a field on a PDF parameters page, parameters can also originate from reports and includes that are linked to the linked PDF parameters page

    is het mogelijk om zinnen te maken die vertaald kunnen worden op basis van de taal van de ontvanger. Dit is vooral handig bij het maken van sjablonen voor e-mails, contracten, werkorders enz.

    Gebruik een parameter op basis van een formule

    1. Navigeer naar de back-end van de instantiepagina met behulp van pagina definitie;

    2. Open de gekoppelde PDF-parameterpagina;

    3. Navigeer naar het tabblad Velden;

    4. Een nieuw veld toevoegen aan de PDF-parameterpagina;

    5. Laat het object en het veld leeg;

    6. Vul het formuleveld in. Gebruik de helptekst van dit veld om uw formule te configureren.

      1. [We streven naar een artikel over het gebruik van formules in 2023].

    Parameters van rapporten en inclusies toevoegen

    Behalve dat ze kunnen worden toegevoegd als een veld op een PDF-parameterpagina, kunnen parameters ook afkomstig zijn van rapporten en inclusies die zijn gekoppeld aan de gekoppelde PDF-parameterpagina.

    Expand
    titleExample of parameters originating from a report

    To find the reports and includes that are linked to the PDF parameters page:

    1. Navigate to the back-end of the instance page using page definition.

    2. Open the linked PDF parameters page.

    3. The reports and includes on the instance page will be available at the bottom of PDF parameters page.

    Note

    • Make sure that the parameter you create is unique, to prevent unexpected results. There is no automated check in place for double parameters.

    • For example, if there are two parameters named {reference}. The parameter with the highest value in the field ‘Order’ is used.

    • Before you create a new parameter you can check if the parameter name you want to use is unique. Navigate to the gear symbol > Parameters to easily see what parameters are already available/ used for that page.

    Summary

    Om de rapporten en bijlagen te vinden die zijn gekoppeld aan de PDF-parameterpagina:

    1. Navigeer naar de back-end van de instantiepagina met behulp van pagina definitie.

    2. Open de gekoppelde PDF-parameterpagina.

    3. De rapporten op de instantiepagina zijn beschikbaar onderaan de PDF-parameterpagina.

    Note

    • Zorg ervoor dat de parameter die je aanmaakt uniek is, om onverwachte resultaten te voorkomen. Er is geen geautomatiseerde controle voor dubbele parameters.

    • Als er bijvoorbeeld twee parameters zijn met de naam {referentie}. De parameter met de hoogste waarde in het veld 'Order' wordt gebruikt.

    • Voordat u een nieuwe parameter maakt, kunt u controleren of de parameternaam die u wilt gebruiken uniek is. Navigeer naar de tandwielsymbool > Parameters om eenvoudig te zien welke parameters al beschikbaar/gebruikt zijn voor die pagina.

    Samenvatting

    Rw ui textbox macro

    • Parameters are used when sending out standardized emails, contracts, workorders etc.

    • The parameter itself is fixed, however the value of the parameter is dynamic.

    • Parameters can work with translation strings.

    Search

    • worden gebruikt bij het verzenden van gestandaardiseerde e-mails, contracten, werkorders enz.

    • De parameter zelf is vast, maar de waarde van de parameter is dynamisch.

    • Parameters kunnen werken met vertaalstrings.

    Zoek op

    Live Search