Customized Metadata XML (just:in v3.0)

just:in allows you to create a custom Sidecar XML file for each Capture. Those sidecar files contain Metadata which can be completely user defined. The sidecar files can then be used for further workflow processing.



Overview

Here is a rough outline on how it works:

  1. You select a (previously defined) Metadata Set in the Inspector.
  2. You enter your Metadata and do the Recording.
  3. just:in writes the Recording and a corresponding Sidecar XML file to a user defined location.

This figure shows how the included example would be displayed in the Inspector. The naming, the number and the type of Metadata Fields is completely user definable.

Getting Started with the Example XML

just:in comes with example XML files which can be adapted to your needs. These XMLs are stored in the folder /Library/Application Support/ToolsOnAir/Just In.

  • StartUpXML: contains the XML files which will be listed under Metadata in the Inspector of the just:in user interface.
  • ExportXML: contains the XML files which will be used by just:in Engine to create the output Sidecar XML files. 

StartUpXML Folder: XML Metadata Sets

  • The folder StartUpXML contains the XML files which will be listed under Metadata in the Inspector of the just:in user interface.
  • This folder contains a file named example.xml which can be adapted to your needs.

This figure shows how the example.xml would be displayed in the user interface of just:in.

Metadata Types

There are three Metadata Types:

  • Selection: drop-down box, containing several, user definable <item> elements.
  • Text: text field.
  • Checkbox: checkbox, can either be off ("0") or on ("1").

Reset Value in UI after each Recording

If the metadata field should be reseted to the default value after each recording then following element can be used in the StartUpXML:

<control resetAfterRecord="1">


Adding a XML Metadata Set

  1. Go to the folder /Library/Application Support/ToolsOnAir/Just In/StartUpXML.
  2. Duplicate the file example.xml and rename it to a name of your choice.
  3. Open the previously duplicated XML in a plain text editor.
  4. Edit the XML accordingly to your needs.
  5. Save the XML file.
  6. Create a XML Export Template for the Metadata Set, as explained below.

ExportXML Folder: XML Sidecar Templates

  • The folder ExportXML contains the XML files which will be used by just:in Engine to create the output Sidecar XML files. 
  • This folder contains a file named example.xml which can be adapted to your needs.

This figure shows how the StartUpXML and the ExportXML templates correlate to each other.

  • Each <control> node of the StartUpXML contains a <name> node which must to be represented in the ExportXML template.
  • Each <name> node contains a placeholder for the actual data which is entered in the Metadata fields in the Inspector if just:in. just:in Engine will output the Sidecar XML file with the corresponding data.

Adding a XML Export Template

  1. Go to the folder /Library/Application Support/ToolsOnAir/Just In/ExportXML.
  2. Duplicate the file example.xml and rename it to a name of your choice.
  3. Open the previously duplicated XML in a plain text editor.
  4. Add all nodes to the Export XML which you did create in the XML Metadata Set before.
  5. Save the XML file.
  6. Launch just:in Engine and just:in.
  7. Select the Metadata Set in the Inspector and do your Recordings.

Preparing the Destination Preset of the XML Sidecar File

Before you can use customized XML Sidecar files you need to prepare your Destination Preset(s) accordingly.

  1. Open just:in Engine.
  2. Go to the Preferences.
  3. Switch to the Presets tab.
  4. Under the Destination Presets, add a new XML Container.
  5. Select a Path and a Type.
  6. Save the Preset.

XML Sidecar File Write Process

You can decide whether the XML Sidecar files will be written at the Start or the End of a Recording. Select the one which suffices your needs.