KB333: How to: Add new metadata tags to Moxie 7.03 to 7.05

SUMMARY

Moxie installs with an extensive set of metadata to apply to content and players. This metadata can then be used in rules and events to contextualize your content and filter your log data.

Occasionally, you may want to add new custom metadata tags to Moxie to suit your own system requirements.

SOLUTION

In order to add new metadata tags to Moxie, you must edit the AdditionalFields.XML file Moxie references to build its list of metadata tags. Any changes to the AdditionalFields.XML file are preserved on upgrade, so your custom metadata tags will not be lost.

As a best practice, we recommend you create and edit your XML in a text file, then copy and paste the text into the AdditionalFields.XML file, rather than editing it directly.

To prepare your XML tags:

  1. Open a new document in Windows Notepad or another text editor.
  2. Copy and paste the following code block into the new document:

    <group name="YOUR_GROUP_NAME">
    </group>

    We recommend grouping all of your custom tags in order to make it easier to track new tag sets.
  3. Replace YOUR_GROUP_NAME with the group name you want to appear in Moxie when working with metadata tags. Ensure the quotation marks are present and they are straight quotes "..."
  4. Type your tags, one per line, between the group tags. The structure for tags in Moxie is:
    <field name="MyField" type="Type" format="Format"/>
    Where:
    • field name, is the label that appears in the Moxie interface when working with metadata tags. It can be any contiguous text string.
    • type, is the type of metadata. Moxie works with a limited set of types; valid types are shown in the chart below.
    • format, is the syntactical structure of the data that Moxie works with when processing the values associated with this tag. Refer to the chart below for valid format syntax.

    The following table contains the valid values for type and format:
    Type
    Format
    Date yyyy-mm-dd
    Integer 0
    Time hh:mm
    Boolean True or False
    Double 0.0
    Text Any string enclosed in straight, double quotation marks
    Choice A comma-delimited list of text strings

    Notes:
    • Only Text and Choice permit user defined values whereas Date, Integer, Time, Boolean and Double only permit the exact value in the Format column of the chart above.
    • The field name cannot contain any special characters (e.g. ,.!@#-/, etc.) or spaces
    • Ensure all of the values used in the field name, type and format use straight quotes, "...".
    The following list provides an example of all valid types with sample values:
    • <field name="DateField" type="Date" format="yyyy-mm-dd"/>
    • <field name="IntegerField" type="Integer" format="0"/>
    • <field name="TimeField" type="Time" format="hh:mm"/>
    • <field name="BooleanField" type="Boolean" format="True,False"/>
    • <field name="DoubleField" type="Double" format="0.0/>
    • <field name="TextField" type="Text" format=""/>
    • <field name="ChoiceField_color" type="Choice" format="red, green, blue"/>
  5. Select and Copy all of your new XML to the system clipboard.
  6. Save your document as a TXT file.

Add your new metadata tags to Moxie XML files:

  1. Shut down all of the Moxie Studios that are running on your network.
  2. Stop the Moxie Services:
    1. On the Moxie Data Server computer, click Control Panel  >  Administrative Tools  >  Services
    2. Find and select Omnivex Moxie Agent.
    3. Stop the service.
    4. Confirm stopping any dependent Moxie services.
      Note: When the Moxie services are stopped, running Players continue to run, but any live data stops updating until the Moxie services are restarted.
  3. Using Windows Explorer, browse to Moxie\Data Server\Preload, in the install directory.
  4. Create a back-up copy of AdditionalFields.XML.
  5. Copy AdditionalFields.XML to your desktop and open it using a text editor.
  6. Insert a return between the last </group> tag and the </fields> tag.
  7. Paste the XML content from your clipboard into the new, empty line.
  8. Save and close the file.
  9. Replace the AdditionalFields.XML file in the install directory with your new file.
  10. Restart the Moxie services.
  11. Restart Studio. Your new XML tags appear in the Studio interface when you work with metadata.