When the data input does not match the desired output, use a properties file to convert one to the other.
Let's say you extract data from your CRM, and the data is something very general and to do with how your CRM is setup. Let's say it's just codes: "P_1", "P_2", and so on. You know that P_1 means something, let's say it means "XBOX", and that's what you want to display. The properties file is there to say that P_1 equals XBOX.
Use properties files with media, audio or text. You can also use several properties files driven by a second parameter. More about this at the bottom of the article.
The Properties File
A properties file is a simple text file that follows these basic rules:
- It's a real text file, not an RTF of DOC file that include information about stylistic choices. Use a text editor rather than a word processor to create one. On a Mac you can use Text Edit, but follow this guide to make sure you are only creating text. On Windows use Notepad.
- The file name needs to have a .properties extension. For example: translateToFR.properties.
- The file consists of rows of data, each one has this structure: input=output. For example: summer=été.
- You can upload the properties file to your user media directory or the scene library's media directory. Read more about these here.
- For media and audio properties files the first line has to be the path to the media files themselves (your JPGs, MP4s, WAVs or MP4s), denoted like so: rootDir=ual://videos/. Read about how to reference the media or scene libraries here.
- You must hold your media on the Idomoo Platform in either the media library or scene library.
Watch the Text Mapping to a Properties File Video
Total running time: 2:31
Watch the Media Mapping to a Properties File Video
Total running time: 2:25
Mapping to Several Properties Files with a Parameter
Sometimes it's useful to map data to several properties file. To direct which properties file to use, a secondary parameter is used. We call this Mapping to a Parameter.
For example, if your data has the seasons of the year in English: Summer, Autumn, Winter and Spring, and you want them displayed in different languages, say French, or Spanish, you use one properties file per language, and create a language parameter to drive when to use which properties file.
How to Setup Map to a Parameter
To setup, please follow these steps:
- First make your properties files. One for each value of the second parameter. In our example the second parameter is the language, so make a properties file for each language. Each properties file has lines of input=output values. In the English one we'll have a summer=summer line. But in the French properties file we'll have a summer=été.
- Upload all the properties files to your asset library--user or scene.
- First make your placeholder dynamic by clicking the lock icon. Using the example above, let's call this parameter "season".
- Click the link icon.
- Choose Map to Parameter from the top of the File Browser panel.
- From the Parameter drop-down click Create New.
- Type a name for your second parameter. Again, for this example, type "language" and click OK.
- Now make a list consisting of the values of the language parameter and the properties files associated with each language. For this example, in the first line I write "en" for English. I then click Browse, navigate to where I uploaded my properties files, and choose the properties file I made for English.
- Repeat the previous step as many times as you need. If you only need to add two more languages, you'll need two more lines.
- You can choose for one of the properties files to be the default one used, in case the second parameter is missing. Do that by clicking the Default radio button.
- Click OK. You've finished to setup Map to Parameter.
Watch the Text Mapping to a Parameter Video
Total running time: 1:09