External Reference ID & JIT Variable Subsitution
Introduction
Often, when working with website URLs, the web server or web service endpoints require the resource requester to identify itself so it can serve custom and relevant content. In NexSigns, it provides users the ability to perform Just In Time (JIT) Variable Substitution, so you can define an External Reference ID against the screen and use it as part of the Website URL.
In this article, we will delve into the advanced use case of the External Reference ID and JIT variable substitution technique, as well as how to set it up.
Concept
The External Reference ID is a user-defined field that should uniquely identify the location for each screen license. It is essential to note that the External Reference ID does not need to be unique across all your screens, as multiple screens within the same location may use the same External Reference ID. NexSigns will not require the External Reference ID to be universally unique. This results in providing flexibility for various use case scenarios.
Once the External Reference ID is defined, you can now call it as part of your URL string and set it as a variable placeholder. The NexSigns JIT process will then replace this variable placeholder before the website is retrieved against the final URL.
Different Types of External Reference ID
Here are some ideas on how you will define your External Reference ID.
External Reference ID may be referring to:
Store/branch number (i.e. 2730)
Department or isle number within a location (i.e. 17)
Custom screen reference number
A hybrid Store/branch number and department number (i.e., 2730-17)
and more…
Define External Reference ID
To change or add an External Reference ID
Locate your desired license, expand to see Screen Details
Click on Settings under the Action panel
Enter your desired number into the External Reference ID (i.e. 2730)
Click Save
to complete the setup.
How to use the External Reference ID in URL
You can now call this External Reference ID by inserting {ExternalReferenceID} as part of your URL. For example,
https://my-domain.com/dashboard/{ExternalReferenceID}Limitation
Currently, only the website URL within the Multimedia Channel supports JIT Variable Substitution.
JIT Variable Substitution Behavior
The screen External Reference ID will be used even if it is under Display Mirroring against other licenses.
The screen External Reference ID will be used when the multimedia playlist is using Playlist Inhertence feature (connection token).
Conclusion
That’s all you need to do to start using External Reference ID with JIT Variable Substitution.
If you have any questions, please don't hesitate to reach outKuusoft Support Team.