Special functions
You can use special functions, for example, to add details of who printed the report.
To understand the functions, consider the following example:
Person linked to the account:
• First name - John
• Last name - Williams
• Initial(s) - J.
Logged in user's account:
• User name - JW@Planon
• Description - John Williams
The special functions work as follows:
loggedInPerson()
The loggedInPerson() function returns the value of the name of the linked person as a string. The string is returned in the format -"Firstname"space"Last name".
You can also append parameters related to the person details - such as First name, Last name or Surname - to the function.
| The loggedInPerson() works only if there is a person linked to the logged in account, otherwise, it will not return any value. |
Example | Result |
---|
loggedInPerson() | John Williams |
LoggedInPerson("LastName") | Williams |
loggedInUser()
The loggedInUser() function returns the value of the user name and the description field of the account as a string.
You can also append parameters related to the user account details or person details - such as Account name - to the function.
Example | Result |
---|
loggedInUser() | JW@Planon, John Williams |
loggedInUser("Accountname") | JW@Planon |
retrieveExternalURL()
The retrieveExternalURL() function returns the value of the Externally accessible URL field ( > ) and includes it in your report.
In the Expression box, you can - for example - extend the URL by adding the + operator and typing the URL part of the web definition whose link you want to include in your report:
retrieveExternalURL() + "/case/BP/PUB003"
Result
https://<YourEnvironment>.cloud/case/BP/PUB003
By using this function, the URL remains working dynamically, even when you work across DTAP environments.
generateDeepLinkItemURL(,,)
This expression can be used to generate
deep link items (encrypted URLs). In
Planon ProCenter , encrypted URLs / deep link items can only be generated in
Report generator. The expression builder functionality can be used to create these URLs with an encrypted part that is based on
system code. This means that the URL is specifically created for a particular record in Planon. See
Generating deep link items for more information about generation deep link items.
Once generated, you can use deep link item in emails, mail merge reporting etc. to redirect users to a relevant record in Planon.
This is the basic syntax:
generateDeepLinkItemURL(,,)
In the Expression box, you can - for example - extend the deep link item URL further, for example to allow navigation to a specific Personnel record.:
"<A HREF="+generateDeepLinkItemURL("Personnel",Person.'Syscode', "NavDef001")+">[hyperlink name]</A>"