Search for answers or browse our knowledge base

Click here for Partner information on Installing and Upgrading

Login here for full access

How to set up Sidecar (xml) Ingest

Updated on December 8th, 2022

Table of Contents

X
Assumptions MediaStore Example 1 - Add or Update - Basic Example 2 - Add or Update - Multiple Assets Example 3 - Add Media and Subclips/bookmarks Example 4 - Add Subclips/bookmarks to existing media Example 5 - Update Existing Subclips/bookmarks

Assumptions

Xchange manager should be set up with watchfolders. We do not need a separate XChange MediaStore for sidecar, unless it is a different device or volume to the other files ingested.

We also need to know ahead of time the format the sidecar is and also the asset type the metadata needs to be associated with. We will then create the xsd and xsl files to validate and transform the sidecar into Curator format. This xsd and xsl will be referenced in the Metadata Import MediaStore.

MediaStore

XCHANGEMANAGER-INGEST-SIDECARS

FILEINGEST-METADATAIMPORT

As shown above.

Example 1 - Add or Update - Basic

Curator will be searched for the media asset using the primary key asset.name. If no matching asset(s) are found, then the media asset will be created.  If a single asset is found by asset.name then the records would be updated with the extended metadata

<?xml version="1.0" encoding="UTF-8"?>
<assets> 
<asset>
<asset.name>IPV_INGEST_ONE</asset.name>
<asset.asset_type>media</asset.asset_type>
 <HomeTeam>IPV</HomeTeam>
 <AwayTeam>Curator</AwayTeam>  
</asset>
</assets>

Example 2 - Add or Update - Multiple Assets

Curator will search for the each media asset using the primary key InternalId. If no matching asset(s) are found, then the media asset will be created. If a single asset is found by InternalId then the records would be updated with the extended metadata and static metadata.

<?xml version="1.0" encoding="UTF-8"?>
<assets>
 <asset>
<InternalId>00000001></InternalId>
<asset.name>IPV_MEDIA_0001</asset.asset_id> <asset.asset_type>media</asset.asset_type>
 <HomeTeam>Curator</HomeTeam>
<AwayTeam>IPV </AwayTeam>
</asset>
<asset>
 <InternalId>00000002></InternalId>
<asset.name>IPV_MEDIA_0002</asset.asset_id> <asset.asset_type>media</asset.asset_type>
 <HomeTeam>Process Engine</HomeTeam>
 <AwayTeam>XChange Manager</AwayTeam>
</asset>
</assets>

Example 3 - Add Media and Subclips/bookmarks

Curator will search for the media asset using the primary key asset.name. If no matching asset(s) are found, then the media asset will be created and if one asset is found it will update the media. The assets in the asset.children element will be created on the parent media asset.

<?xml version="1.0" encoding="UTF-8"?> 
<assets> 
<asset> 
<asset.name>IPV_MEDIA_0001</asset.name>   <asset.start_frame_timecode>01:00:00:00</asset.start_frame_timecode>   <asset.frame_rate>25.00</asset.frame_rate>
<asset.children>
   <asset>    
<asset.name>IPV_MEDIA_0001_00h00m00s00f_01h02m21s28f</asset.name>    <asset.asset_type>subclip</asset.asset_type>    <asset.start_frame_timecode>01:00:00;00</asset.start_frame_timecode>    <asset.end_frame_timecode>01:02:21;28</asset.end_frame_timecode> 
</asset> 
<asset> 
<asset.name>IPV_MEDIA_0001_01h02m00s00f_01h05m21s28f</asset.name>    <asset.asset_type>subclip</asset.asset_type>    <asset.start_frame_timecode>01:02:00;00</asset.start_frame_timecode>    <asset.end_frame_timecode>01:05:21;28</asset.end_frame_timecode>
   </asset>
  </asset.children> 
</asset> 
</assets>

Example 4 - Add Subclips/bookmarks to existing media

Curator will search for the media asset using the primary key asset.name and add subclips to existing media.

<?xml version="1.0" ?> 
<assets> 
<asset> 
<asset.name>HD-P042718</asset.name>
<asset.subclip_name>HD-P042718_01h00m00s00f_01h55m00s00f</asset.subclip_name>  <asset.asset_type>subclip</asset.asset_type>
<asset.mode>update</asset.mode>
<asset.start_frame>469</asset.start_frame>   <asset.end_frame>99369</asset.end_frame>
<Content>SEGMENT</Content>  
<asset.description>ISRAEL TOUR 2018</asset.description>
<User>MCOperator</User>
</asset> 
<asset> 
<asset.name>HD-P042718</asset.name> 
<asset.subclip_name>HD-P042718_00h59m44s11f_01h55m19s09f</asset.subclip_name>  <asset.asset_type>subclip</asset.asset_type>
<asset.mode>update</asset.mode>
<asset.start_frame>0</asset.start_frame>
<asset.end_frame>99948</asset.end_frame>
<Content>THUMBNAIL</Content>
<User>daletservice</User>
</asset>
<asset>
<asset.name>HD-P042718</asset.name>
<asset.bookmark_name>HD-P042718_00h59m44s11f</asset.bookmark_name>  <asset.asset_type>bookmark</asset.asset_type>
<asset.mode>update</asset.mode>
<asset.start_frame>0</asset.start_frame>
<asset.end_frame>0</asset.end_frame>
<Content>POSTER-FRAME</Content>
<User>daletservice</User>
</asset>
</assets>

Example 5 - Update Existing Subclips/bookmarks

Curator will search for existing subclips/bookmarks using the primary key asset.name and update it.


<?xml version="1.0" ?> 
<assets>
<asset>
<asset.name>HD-P042718_01h00m00s00f_01h55m00s00f</asset.name>   <asset.asset_type>subclip</asset.asset_type>   <asset.searchtype>subclip</asset.searchtype>
<asset.mode>update</asset.mode> 
<asset.start_frame>469</asset.start_frame>   <asset.end_frame>99369</asset.end_frame>
<Content>SEGMENT1</TBN_Content>
<asset.description>ISRAEL TOUR 2018</asset.description>
<User>MCOperator</User>
</asset>
<asset>
<asset.name>HD-P042718_00h59m44s11f_01h55m19s09f</asset.name>  <asset.asset_type>subclip</asset.asset_type>  <asset.searchtype>subclip</asset.searchtype>
<asset.mode>update</asset.mode>
<asset.start_frame>0</asset.start_frame>
<asset.end_frame>99948</asset.end_frame>
<Content>THUMBNAIL1</TBN_Content>
<User>daletservice</User>
</asset>
<asset>
<asset.name>HD-P042718_00h59m44s11f</asset.name>  <asset.asset_type>bookmark</asset.asset_type>  <asset.searchtype>bookmark</asset.searchtype>
<asset.mode>update</asset.mode>
<asset.start_frame>0</asset.start_frame>
<asset.end_frame>0</asset.end_frame> 
<Content>POSTER-FRAME1</TBN_Content>
<User>daletservice</User>
</asset>
</assets>

Was this article helpful?

Related Questions