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.
Comment: Automatically translated by Lango

DifficultySchwierigkeitsgrad: noviceAnfänger

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 example
Content

Inhalt

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 parameters in Workplace?

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

Lernziele

Nach der Lektüre dieses Artikels werden Sie in der Lage sein:

  • Identifizieren Sie die Parameter.

  • Wissen, woher die Parameter kommen.

  • Erstellen Sie neue Parameter.

Was sind Parameter im Workplace?

Ein Parameter in Workplace ist eine Variable, die den im entsprechenden Feld angezeigten Wert darstellt. Wenn der Wert eines Feldes aktualisiert wird, wird auch der Parameter automatisch aktualisiert. Parameter werden zum Beispiel als dynamische Eingabe für Vorlagen, Formeln und für den E-Mail-Text beim Versenden von Workflow-E-Mails verwendet.

Beispiele für Parameter sind {Referenz} und {Vorname}. In einer E-Mail-Vorlage kann dieser Parameter verwendet werden, um den Antragsteller einer Reservierung persönlich anzusprechen. Zum Beispiel:

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.

    • Image Removed
    Image Removed

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

    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

    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 parameter field;

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

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

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

    Image Removed
    Image Removed

    Image Removed

    Info

    By creating a translation string for the 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.

    Expand
    titleExample of parameters originating from a report
    Image Removed

    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

    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

    Welche Parameter sind auf einer Seite verfügbar?

    Um die Parameter anzuzeigen, die für eine Instanz verfügbar sind, klicken Sie auf die Seite:

    1. Öffnen Sie die Seite (z. B. eine Reservierung);

    2. Navigieren Sie zum Zahnrad-Symbol;

    3. Klicken Sie auf Parameter.

    4. Es wird nun eine Liste aller Parameter angezeigt, die im Kontext dieser Seite verfügbar sind.

    Image Added
    Image Added

    • Die Spalte "Parameter" zeigt die Parameter, die Sie in einer Vorlage verwenden können.

    • In der Spalte "Wert" steht der Wert, der bei der Anwendung der Vorlage erscheint.

    Info

    • ACHTUNG! Jeder Parameter ist auf der Parameterseite verfügbar, die sowohl mit einem Klein- als auch mit einem Großbuchstaben beginnt.

    • Parameter, die mit einem Kleinbuchstaben beginnen, verwenden den Wert der Instanz.

    • Parameter, die mit einem Großbuchstaben angegeben werden, verwenden die Bezeichnung des Feldes.

    Einsicht in die Parameterdefinition

    Parameter werden auf der PDF-Parameterseite erstellt, die mit der Seitendefinition einer Seite verknüpft ist. Wenn in der Seitendefinition keine Parameterseite verknüpft ist, wird die Parameterseite mit einer übergeordneten Seite verknüpft.

    • Die im Feld "PDF-Parameter" verlinkte Seite enthält die Parameter

    • Wenn die PDF-Parameterseite über Includes verfügt, sind die in diesem Include definierten Parameter ebenfalls verfügbar.

    Image Added

    Von welcher Seite stammt ein Parameter?

    Wenn Sie einen neuen Parameter erstellen oder einen bereits vorhandenen Parameter bearbeiten, sollten Sie zunächst nachsehen, wo die vorhandenen Parameter definiert sind. Dieses Werkzeug ist besonders hilfreich, wenn die Parameter von mehreren Seiten stammen.

    1. Öffnen Sie die Seite (z.B. eine Anfrage);

    2. Navigieren Sie zum Zahnrad-Symbol;

    3. Klicken Sie auf Parameter;

    4. Wenn Sie sich auf der Parameterseite befinden. Suchen Sie den Parameter mit "ctrl+F";

    5. "Schauen Sie nach, hinter welcher "parms-group" der Parameter angezeigt wird. Dies ist die Seite, auf der die Parameter definiert sind.
      In diesem Beispiel stammt der Parameter "area" von der Seite "ParametersGOBStandardRequest".

    Image Added
    Info

    • Die parms-Gruppen können von einer übergeordneten Seite geerbt werden.

    • Die Parameter stammen von der verlinkten PDF-Parameterseite.

      • Feld auf der PDF-Parameterseite.

      • Felder auf dem Include, das mit der PDF-Parameterseite verknüpft ist.

      • Felder aus Berichten, die mit der PDF-Parameterseite verknüpft sind.

    Einen Parameter erstellen - einfach

    Gehen Sie folgendermaßen vor, um einen Parameter auf der verknüpften PDF-Parameterseite der Instanz hinzuzufügen:

    1. Navigieren Sie zum Backend der Instanzseite mit Seitendefinition;

    2. Öffnen Sie die verlinkte Seite mit den PDF-Parametern;

    3. Image Added

      Navigieren Sie zur Registerkarte Felder;

    4. Fügen Sie ein neues Feld auf der PDF-Parameterseite hinzu;

    5. Füllen Sie das Objekt und das Feld aus;

    6. Der Parameter auf der Seite entspricht der ursprünglichen "Feldbezeichnung";

    7. Wenn jedoch das Feld "Override label" ausgefüllt ist, wird dies der Name des Parameters sein.

    Image Added

    Image Added

    Erstellen eines Parameters - Fortgeschrittene

    Neben dem Hinzufügen eines regulären Parameters auf der Parameterseite ist es auch möglich,:

    • Ändern Sie den Parameternamen, aber nicht die Feldbezeichnung.

    • Fügen Sie einen Übersetzungsstring als Parameter hinzu. Dies ist besonders hilfreich, wenn Sie eine (E-Mail-)Vorlage erstellen, die auf der Grundlage der Sprache des Endbenutzers übersetzt werden soll.

    • Verwenden Sie einen formelbasierten Parameter. Dies wird verwendet, wenn der Wert eines Parameters auf der Berechnung anderer auf der Seite verfügbarer Felder basiert.

    Info

    Bitte beachten Sie, dass für die Erstellung von Parametern die gleiche Logik gilt wie für das Hinzufügen von Feldern zu einer Instanzseite. Das bedeutet, dass Workplace zur Bestimmung des Wertes eines Parameters nachschlägt, um zu ermitteln, welche Informationen von anderen Objekten angezeigt werden sollen. Das bedeutet auch, dass Sie Felder miteinander verknüpfen können, wenn z.B. die Parameter für einen Kontakt nicht die Informationen liefern, die Sie erwarten würden.

    Ändern Sie den Parameternamen, aber nicht die Feldbezeichnung

    Um eindeutige Parameter zu erstellen, muss der Parametername möglicherweise vom Bezeichnungsnamen abweichen. Zum Beispiel, wenn zwei Kontakte auf einer Seite angezeigt werden.

    1. Navigieren Sie zum Backend der Instanzseite mit Seitendefinition;

    2. Öffnen Sie die verlinkte Seite mit den PDF-Parametern;

    3. Navigieren Sie zur Registerkarte Felder;

    4. Fügen Sie ein neues Feld auf der PDF-Parameterseite hinzu;

    5. Füllen Sie das Objekt und das Feld aus;

    6. Füllen Sie das Feld 'Parameter' aus

    Image Added

    Image Added

    Erzeugen eines Parameters für eine Übersetzungszeichenfolge

    1. Navigieren Sie zum Backend der Instanzseite mit Seitendefinition;

    2. Öffnen Sie die verlinkte Seite mit den PDF-Parametern;

    3. Navigieren Sie zur Registerkarte Felder;

    4. Fügen Sie ein neues Feld auf der PDF-Parameterseite hinzu;

    5. Lassen Sie das Objekt und das Feld leer;

    6. Füllen Sie das Parameterfeld aus;

      1. Dieser Wert wird der Parameter sein, auf den Sie sich in Ihrer Vorlage beziehen können.

    7. Füllen Sie das Feld "Override label" aus oder erstellen Sie einen neuen Übersetzungsstring;

      1. Der Wert in der Überschreibungsbeschriftung ist der Wert, der erzeugt wird, wenn auf den Parameter mit einem Großbuchstaben verwiesen wird.

    Image Added
    Image Added

    Image Added

    Info

    Durch die Erstellung eines Übersetzungsstrings für die Beschriftung ist es möglich, Sätze zu erstellen, die je nach Sprache des Empfängers übersetzt werden können. Dies ist besonders nützlich bei der Erstellung von Vorlagen für E-Mails, Verträge, Arbeitsaufträge usw.

    Verwenden Sie einen formelbasierten Parameter

    1. Navigieren Sie zum Backend der Instanzseite mit Seitendefinition;

    2. Öffnen Sie die verlinkte Seite mit den PDF-Parametern;

    3. Navigieren Sie zur Registerkarte Felder;

    4. Fügen Sie ein neues Feld auf der PDF-Parameterseite hinzu;

    5. Lassen Sie das Objekt und das Feld leer;

    6. Füllen Sie das Formelfeld aus. Verwenden Sie den Hilfetext dieses Feldes, um Ihre Formel zu konfigurieren.

      1. [Wir beabsichtigen, 2023 einen Artikel über die Verwendung von Formeln zu verfassen]

    Hinzufügen von Parametern aus Berichten und Includes

    Parameter können nicht nur als Feld auf einer PDF-Parameterseite hinzugefügt werden, sondern auch aus Berichten und Includes stammen, die mit der verlinkten PDF-Parameterseite verknüpft sind.

    Expand
    titleBeispiel für Parameter, die aus einem Bericht stammen
    Image Added

    So finden Sie die Berichte und Includes, die mit der PDF-Parameterseite verknüpft sind:

    1. Navigieren Sie zum Backend der Instanzseite mit Seitendefinition.

    2. Öffnen Sie die verlinkte Seite mit den PDF-Parametern.

    3. Die Berichte und Includes auf der Instanzseite werden unten auf der Seite PDF-Parameter verfügbar sein.

    Note

    • Stellen Sie sicher, dass der von Ihnen erstellte Parameter eindeutig ist, um unerwartete Ergebnisse zu vermeiden. Es gibt keine automatische Prüfung für doppelte Parameter.

    • Zum Beispiel, wenn es zwei Parameter mit dem Namen {reference} gibt. Der Parameter mit dem höchsten Wert im Feld "Reihenfolge" wird verwendet.

    • Bevor Sie einen neuen Parameter erstellen, können Sie prüfen, ob der Name des Parameters, den Sie verwenden möchten, eindeutig ist. Navigieren Sie zum Zahnradsymbol > Parameter können Sie leicht feststellen, welche Parameter für diese Seite bereits verfügbar sind/verwendet werden.

    Zusammenfassung

    Rw ui textbox macro

    • Parameter werden beim Versand von standardisierten E-Mails, Verträgen, Arbeitsaufträgen usw. verwendet.

    • Der Parameter selbst ist fest, aber der Wert des Parameters ist dynamisch.

    • Parameter können mit Übersetzungsstrings arbeiten.

    Suche

    Live Search