eMAM Sidecar Ingest - XML Specifications
eMAM Version 5.1
Notice
The content in this document represents the current view of Empress Media Asset Management, LLC as of the date of publication. As Empress responds continually to the changing market conditions, this document should not be interpreted as a commitment on the part of Empress. Empress cannot guarantee the accuracy of any information presented after the date of publication. Empress is a US registered trademark of EMAM Inc., and is used by permission. eMAM logos are US registered trademarks of Empress Media Asset Management, LLC. Information in this document is subject to change without notice.

Contents

» Introduction. 5

» Metadata Sidecar Ingest 5

» Steps for Ingest Automation with sidecar XML. 5

» Validate your XML. 6

» Pre-requisites 6

» Sample XML. 7

» XML Structure. 8

1.     Identify the XML. 8

2.     Root Tag. 8

3.     eMAM asset 9

3.1    File name: 10

3.2    File path: 10

3.3    Asset id: 10

3.4    Ingest actions: 10

3.5    File Action. 11

4.     Tags: 11

4.1    Basic Metadata. 11

4.2    Custom Metadata. 12

4.3    Markers 13

4.4    Subclips 13

4.5    Projects 14

4.6    Categories 14

4.7    Associate File. 15

» Ingest action and Attribute Combinations 16

» Sample XML file: 17

a    create-new-asset: 19

b    create-new-version. 21

c    associate-metadata. 23

d    create-asset-placeholder 25

» Known issues 25

» Glossary 25

» Get Help 25


Introduction

This is a reference document for Ingest of XML file that you must create to use the eMAM sidecar ingest option.  This document gives detailed specifications and code samples of the required elements and the attributes that you must include in your ingest XML file. This enables you to ingest multiple videos and associated metadata by dropping the XML file into the configured ingest watch folder. eMAM will validate the XML file against the predefined rules defined in the XML Schema Definition (XSD) and if it fails, it will be shown as validation error in eMAM ingest dashboard.

Metadata Sidecar Ingest

Side car files are files that come along with source files and hold the metadata of the source file. eMAM has defined an Xml schema (a description of the structure of xml)  for creating the side car xml file. Xml files which follow this schema can be parsed by eMAM Ingest Manager to extract the metadata given in that xml and perform actions based on that. The metadata xml can be ingested alone or with source files. eMAM Ingest manager parses the xml, collects the information from xml and updates the database. This automates the process of metadata association with the asset in eMAM.  

 

Steps for Ingest Automation with sidecar XML

To use the Ingest automation with sidecar xml feature, follow below steps:

1.    Prepare your list of assets

2.    Create a XML file for assets that needs to be ingested to eMAM

3.    Drop the XML file to the configured ingest folder

4.    Wait for processing to complete

5.    If there is any validation error associated with the XML file, error message will be displayed in the eMAM dashboard.

6.    User can fix the error in XML file and resubmit the job from the dashboard. 

Validate your XML

You can validate your XML file against the XSD and to ensure that it is free of invalid or illegal characters which need to be removed. If left unfixed, these characters could cause failures during the ingest process. Here is the list of illegal characters and its representation in XML:

A comma (,) cannot be included in a tag. The reason behind this is that tags are stored internally as comma separated lists, and unexpected commas cause issues.

 

Pre-requisites

Few pre-requisites for ingest automation with Metadata Sidecar XML are:

If a user needs to upload both source files and the metadata XML to ingest folders, an ingest profile should be created by the Super Admin with XcodeType as  ‘SidecarXMLIngest’.

There should be at least one Unit Admin user created in eMAM and associated with the Sidecar XML Ingest profile.

A Unit Admin user key. Userkey can be obtained from the eMAM Admin interface or from the eMAM Director interfac e > Admin Tools page > Manage Users > edit user>Manage Userkey tab.

Sample XML

Below is a sample of basic XML file. All the tag names and attributes used in the xml file are case sensitive and should be used as it is.

 <?xml version="1.0" encoding="UTF-8"?>

<eMAM user-key="zlEKbVGXb0UWyOavK6yQwneL7cPxV6zy6V1/+ZTxuuA=">

       <asset file-name="Ads1.mov" ingest-action="create-new-version" file-action="copy-file" file-path="\\102.10.0.148\shareddelvry\Videos" asset-id="30494">

                            <basic-metadata>

                     <title>Ads1</title>

                     <description>first ad-based video test description</description>

                     <author>John Garyson</author>

              </basic-metadata>

              <custom-metadata>

                     <field standard-id="CUST_FLD_APPROVED_TXT_595">Approved</field>

                     <field standard-id="CUST_FLD_APPROVED_ON_TXT_595">02/12/2016</field>

              </custom-metadata>

              <markers>

                     <marker name="my_marker1" time-code="00:05:44:10" duration="00:00:00:00">The first filter for the video starts from here</marker>

                     <marker name="my_marker2" time-code="00:09:44:14" duration="00:00:00:00">The second filter for the video starts from here</marker>

              </markers>

              <subclips>

                     <subclip name="sb_clp1" start-time="05:59:51:13" end-time="07:00:36:00" />

                     <subclip name ="sb_clp2" start-time="08:25:10:13" end-time="14:00:36:00" />

              </subclips>

              <projects>

                     <project name="Project5/New"/>

              </projects>

              <categories>

                     <category name="Main/Approved_Items"/>

                     <category name="Videos/Ads"/>

              </categories>

       </asset>

<asset asset-id="30494" ingest-action="associate-metadata" file-name="NewVideo1.mp4" version-id="35662">

<associate file-type="original" file-action="copy" file-exist-action="replace" file-name="A013C009_160219_R0S7.mov" file-path="D:\Project A\Bin" />

            <associate file-type="platform" file-action="copy" platform-id="1" file-name="A013C009_160219_R0S7.mp4" file-path="D:\Project B\Clip" />

        </asset>

</eMAM>

XML Structure

Users need to follow below mentioned XML structure specified by eMAM.

1.  Identify the XML

Required- This first tag identifies the XML document type and always looks exactly like the following:

<?xml version="1.0" encoding="UTF-8"?>  

2.  Root Tag

eMAM: For user authentication, provide the user key from user management section in eMAM Admin interface. This user should be associated with at least one ingest profile with ‘SidecarXMLIngest’ option enabled in order to use the sidecar XML ingest option. Otherwise, an error will show up in the dashboard “user xyz is not associated with the ingest profile”

Required- This automatic ingest-specific (eMAM user key) tag marks the beginning of the upload.

<eMAM user-key="zlEKbVGXb0UWyOavK6yQwneL7cPxV6zy6V1/+ZTxuuA="> 


 

XML Element

 

Required

 

Element Value

 

Attributes

 

Required

 

Attribute Value

 

Description

 

    <eMAM>

 Yes

 Nil

 user-key

 yes

 non-empty key

User key can be obtained from eMAM Admin ->user management. Contact eMAM Unit Administrator to get the user key.

3.  eMAM asset

For all the assets which needs to be uploaded, please specify following attributes for each asset in the Xml file.

<asset file-name="Ads1.mov" ingest-action="create-new-version" file-action="copy-file" file-path="\\102.10.0.148\shareddelvry\Videos" asset-id="30494">

 

Asset attributes: <asset> tag uses following attributes:

 

 

XML Element

 

Required

 

Element value

 

Attributes

 

Required

 

Attribute Value

 

Description

 

 

 

<asset>

 

 

 

 

 

 

 

 

 

Yes

 

 

 

 

 

 

 

 

 

Nil

 

File name

 

Yes

 

non-empty key

 

Provide name of the file

Nil

*ingest-  action

yes

create-new-asset/ associate-metadata/ create-new-version/ create-asset-placeholder

 Provide the details of what action ingest manager needs to take

 

Nil

 

*file-action

 *Yes (Not required with associate-metadata and create-asset-placeholder)

copy-file/move/index

Provide the details of what action needs to be taken on the file

 

Nil

 

file-path

 *Yes (Not required with associate-metadata and create-asset-placeholder)

non-empty string

Provide network shared path of the asset.

 

Nil

 

asset-id

 

*Yes (Not required with create-new-asset and create-asset-placeholder)

 

integer

Provide id of the asset from File version widget

 

 

3.1   File name: Name of the source file.

3.2   File path: Source location of the asset. (File path can also be an Http URL.

e.g.: file-path="http://10.0.20.15/Highres". Http URL as file path can be used with Create new asset, create new version and associate files)

3.3   Asset id: Id of an asset from eMAM. Asset Id can be obtained from the version widget, API, asset state report or from the SQL report

3.4   Ingest actions: Various actions that can be performed during Ingest are mentioned below:

 

*Ingest action

 

Mandatory

 

Description

 

create-new-asset

 

File action, file name and file path

 

It creates a new asset. File-action (copy-file, index or move), file name and file path details are mandatory.

 

associate-metadata

 

File name and eMAM-asset-id

 

Associates metadata to an existing asset. File name and eMAM asset id details are mandatory.

 

create-new-version

 

File name, Asset file path & eMAM asset id

 

Adds new version to the existing asset. File name, asset file path and eMAM asset id details are mandatory.

 create-asset-placeholder

     File name

Creates a virtual asset in the eMAM system but with limited operations. It can be associated with metadata, assigned to Projects/Categories without any physical media. File name detail is mandatory.


3.5   File Action: Various actions that can be performed for an asset during ingest.

 

 

*File action

 

Description

copy-file

This will copy the asset to eMAM managed storage and index the source storage location

 

index

 

 

Index option will index the source file storage location in eMAM. Certain functionalities like download will not be supported from eMAM interface with this option.

 

Move

 

Move file option will move the file from the source storage location to eMAM managed storage after processing.

4.  Tags:

Various tags that can be associated with assets are:

 

4.1   Basic Metadata:

 

Basic metadata details of an asset can be updated by providing title, description and author details.

            

              <basic-metadata>

                     <title>Ads1</title>

                     <description>first ad-based video test description</description>

                     <author>John Garyson</author>

              </basic-metadata>

 

 

     Attribute

Description

Title

Title of the asset

description

Description of the asset

author

Name of the person who created the asset



4.2   Custom Metadata

After you have created the custom metadata fields and assigned them to Metadata groups and Metadata Sets in the eMAM Director Admin Tools page, you can use the metadata standard id (associated with the metadata fields) and standard set id (associated with the metadata sets) in the XML to set the custom metadata values for an asset. Both these values can be obtained from the Manage Metadata section in the eMAM Director Admin Tools page. The field values should be validated before submitting the XML. 

Metadata field Standard-id for custom metadata fields are mandatory attributes for each field tag however Metadata Set-standard-id is optional.

Note: If Set-standard-id is not provided, you will not be able to see the associated metadata in the Director Interface, unless it is already associated.

Custom metadata details of an asset can be updated with a value that matches the field-type (integer, string, list-item, float, date-time or time-code) provided the unique standard-id for that field exists in the eMAM system otherwise ingest will fail. Therefore, please ensure that the metadata standard id and set standard id exists in the eMAM system before you start with the ingest. If the standard id or set standard id do not exist in eMAM, eMAM ingest manager will ignore those metadata fields. During ingest of a new version of an asset, existing metadata values will be over written with the values from the XML.

             <custom-metadata set-standard-id="CUST_SET_7576">

                     <field standard-id="CUST_FLD_APPROVED_TXT_595">Approved</field>

                     <field standard-id="CUST_FLD_APPROVED_ON_TXT_595">02/12/2016</field>

              </custom-metadata>

 

 

XML Element / Attribute

 

Required

 

Attributes

 

Required

 

Attribute Value

 

<field>

 

Optional

 

*standard-id

 

Yes


non-empty string

 

<custom metadata>

 

Optional

 

*set-standard-id

 

Optional


non-empty string

 

Note:
*standard-id:
Unique id for each metadata field which can be obtained from eMAM Admin interface>Tools>Administrator tools>Metadata Fields OR, eMAM Director Interface>Admin Tools>Manage Metadata>Metadata Fields>Standard Id.

*set standard-id:
Unique id for each metadata set which can be obtained from eMAM Admin interface>Tools>Administrator tools> Metadata Set OR, eMAM Director interface>Admin Tools>Manage Metadata>Metadata Set>Standard Id

*Element value:
Metadata value should be entered between the field opening and closing XML tags.


 

4.3   Markers

Markers of a video asset can be updated using the XML with name, time-code, duration and description details.

            

              <markers>

                     <marker name="my_marker1" time-code="00:05:44:10" duration="00:00:00:00">The first filter for the video starts from here</marker>

                     <marker name="my_marker2" time-code="00:09:44:14" duration="00:00:00:00">The second filter for the video starts from here</marker>

              </markers>

 

 

XML Element

 

Required

 

Attributes

 

Required

 

Attribute Value

 <marker> Optional

 

name

 

Yes

 

non-empty string

 

duration

 

Yes

 

time-code string

 

time-code

 

Yes

 

time-code string

 

Note: Marker description should be placed between the tags <marker> value </marker>

4.4 Subclips

Sub clips information of a video asset can be updated with subclip name, subclip type (Std or Tx), start-time and end-time details.  

       <subclips>

             <subclip type="std" name="sb_clp1" start-time="05:59:51:13" end-time="07:00:36:00" />

 

              <subclip type ="tx" name ="sb_clp2" start-time="08:25:10:13" end-time="14:00:36:00" />

       </subclips>


 

 

XML Element

 

Required

 

Attributes

 

Required

 

Attribute Value

 

 <subclips>

 

      Optional

name

Yes

non-empty string

 

end-time

 

Yes

 

time-code string

 

time-code

 

Yes

 

time-code string

 

type

 

Yes

 

Std or Tx

 

4.5 Projects

Assets can be associated with one or more Projects. Bins inside the project can be defined inside the XML with forward slash (/) after the project name. Ingested assets will be automatically assigned to the specified project or bin. Project structure will be created automatically if it does not exist in eMAM system.

                          

                          <projects>

                     <project name="Project5/New"/>

              </projects>

 

 

XML Element

 

Required

 

Attributes

 

Required

 

Attribute Value

 <project>

 Optional

 name

 Yes

 non-empty string

 

4.6 Categories

Assets can be associated with one or more Categories. Sub Categories can be defined inside the XML with a forward-slash (/) after the category name. Ingested assets will be automatically assigned to the specified categories. Category structure will be created automatically if it does not exist in the eMAM system.

             

              <categories>

                     <category name="Main/Approved_Items"/>

                     <category name="Videos/Ads"/>

              </categories>

 

 

XML Element

 

Required

 

Attributes

 

Required

 

Attribute Value

 <category>

 Optional

 name

 Yes

 non-empty string

 

4.7 Associate File

Assets can be associated with the Original, Proxy and Mezzanine files. You can also attach key frames as thumbnails for videos. Note: It can be attached from http url too.

<asset asset-id="30494" ingest-action="associate-metadata" file-name="NewVideo1.mp4" version-id="35662">

            <associate file-type="original" file-action="copy" file-exist-action="replace" file-name="A013C009_160219_R0S7.mov" file-path="D:\Project A\Bin" />

            <associate file-type="platform" file-action="copy" platform-id="1" file-name="A013C009_160219_R0S7.mp4" file-path="D:\Project B\Clip" />

            <associate file-type="thumbnail" file-action="move" file-name="hd_wallpapers_forbackground_2015.jpg" file-path="G:\Test Assets\Images" />

 

XML Element Required Attribute Description

 

 

 

 

 

 

 

<associate>

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Optional

 

 

 

 

 

 

 

 

 

 

file name

Asset name "NewVideo1.mp4"

file-name="NewVideo1.mp4"

Ingest action

associate-metadata

Metadata’s will be associated for an already existing asset "NewVideo1.mp4" with id 30494 in eMAM system.

ingest-action="associate-metadata"

 

Asset id

 

Asset Id can be obtained from File version widget in eMAM Director interface. asset-id="30494"

Note: If asset id is equal to 0, it will automatically create a new placeholder for an asset and then original/proxy files and metadata can be associated to that asset.

<asset asset-id="0ingest-action="associate-metadata" >

 

 

Version id

 

Version id is optional. If version id is provided, file gets associated with this version of the asset. If version id is not there, file gets associated with the face version of the asset.

It is advisable to use Version id only if we have valid version id of assets. Avoid using version id if you do not have the values as values like 0 or -1 can lead to validation issues.

version-id="35662">

file action

 

Copy: Copy the asset to eMAM Managed Storage.

file-action="copy"

 

Move: Move the file from the source storage location to eMAM managed storage after processing.

file-action="move"

Index: Index and associate original files from source. Source files (local path/UNC path/Network) should be accessible by the Ingest manager.

Note: While associating files, index option is only available for original file association.

 file-type="original" file-action="index"

 

 

file type

 

Original: Associate file to original file

 

file-name="A013C009_160219_R0S7.mov"

file-type="original"

 

Platform: Associate file to a platform file which includes all the proxies, including eMAM preview proxy and other mezzanine files.

If platform id is 1, it will associate to eMAM preview proxy else it will associate to corresponding mezzanine.

(For file type- Platform, platform id is must)

 

file-name="A013C009_160219_R0S7.mp4"

file-type="platform"

 

Key frames: Associate key frames as thumbnails (only for video files). It can be attached from http URL too. File type should be thumbnail.

 

file-type="thumbnail"

file-name="hd_wallpapers_forbackground_2015.jpg"

file-path="G:\Test Assets\Images"  

Platform-id

If platform id is 1, it will associate to eMAM preview proxy else it will associate to corresponding mezzanine formats. (For file type- Platform, platform id is must).

 

platform-id="1"
file-exist-action

While associating original files, file-exist-action attribute can be used to perform specific actions (based on the below described values chosen) on the associated new file:

  • create-new-asset: If the original file already exists for the given asset Id, this new file will be ingested as a new asset.
    file-exist-action="create-new-asset" 
  • create-new-version: The new file will be ingested and associated as a new version for the given asset Id.
    file-exist-action="create-new-version" 
  • replace: The new file will replace the already existing original file and metadata of the given asset id with the new file and its metadata. 
    file-exist-action="replace" 
  • none: Here no action will be taken and will skip the given asset id if the original file already exists for the same.
    file-exist-action="none" 
file name

Asset name "NewVideo1.mp4"
file-name="NewVideo1.mp4"

file path

Path of the asset.

file-path="D:\Project A\Bin"

Ingest action and Attribute Combinations

Various ingest actions and its combinations with different attributes are mentioned in the below figure:

Sample XML file:

Assets ingested using XML file with various ingest actions: Using one Xml file, you can automatically ingest any no. of assets to eMAM. Details of each asset can be included like basic metadata, custom metadata, associate files, markers, subclips, projects, categories that needs to be associated with the asset. eMAM Ingest manager will process each asset based in the “ingest action” and “file action” specified in the XML

 

Below is a sample XML file used for automated ingest of 4 assets with different ingest actions.

 

<?xml version="1.0" encoding="UTF-8"?>

<eMAM user-key="zlEKbVGXb0UWyOavK6yQwneL7cPxV6zy6V1/+ZTxuuA=">

       <asset file-name="Heartbeat.avi" ingest-action="create-new-asset" file-action="copy-file" file-path="\\10.0.8.40\emamfolders\xmlingest">

              <basic-metadata>

                     <title>Heartbeat</title>

                     <description>Euphoria is the ninth studio album by Spanish singer-songwriter Enrique Iglesias. The album is a joint-release by Universal Republic and Universal Music Latino and was released on 5 July 2010 internationally and in the US on 6 July 2010</description>

                     <author>John Garyson</author>

              </basic-metadata>

              <markers>

                     <marker name="marker1" time-code="00:00:01:10" duration="00:00:00:00">The best part of the album</marker>

              </markers>

              <subclips>

                     <subclip type="std" name="subclip1" start-time="00:00:01:43" end-time="00:00:03:43"/>

                     < subclip type = " tx " name = " subclip2 " start-time = " 00:00:03:53 " end-time="00:00:06:43"/>

              </subclips>

              <projects>

                     <project name="NewProjects/Albums"/>

                     <project name="LatestCollections/Videos"/>

              </projects>

              <categories>

                     <category name="Albums/Enrique/Euphoria"/>

              </categories>

       </asset>

       <asset asset-id="30544" file-path="\\10.0.8.40\emamfolders\xmlingest" file-action="move" ingest-action="create-new-version" file-name="Ayer1.avi">

              <basic-metadata>

                     <title>Ayer</title>

                     <description>'Ayer' by Enrique Iglesias.</description>

                     <author>Johan</author>

              </basic-metadata>

              <custom-metadata>

                     <field standard-id="CUST_FLD_TXT_DATETIME_598">02/23/2015</field>

                     <field standard-id="CUST_FLD_TST_INT_596">15</field>

                     <field standard-id="CUST_FLD_TXT_TIMECODE_599">00:02:05:29</field>

              </custom-metadata>

              <markers>

                     <marker name="marker1" time-code="00:00:01:10" duration="00:00:00:00">The first part of the album from here</marker>

                     <marker name="marker1" time-code="00:00:01:10" duration="00:00:00:00">The second part of the album from here</marker>

                     <marker name="marker1" time-code="00:00:01:10" duration="00:00:00:00">The third part of the album from here</marker>

              </markers>

              <projects>

                     <project name="NewProjects/Album1"/>

              </projects>

             

       </asset>

       <asset asset-id="30494" ingest-action="associate-metadata" file-name="NewVideo1.mp4">

              <basic-metadata>

                     <title>NewVideo1.mp4</title>

                     <description>The All new video from the Collection</description>

                     <author>John Garyson</author>

              </basic-metadata>

              <custom-metadata>

                     <field standard-id="CUST_FLD_TST_LIST_595">VideoCategory1</field>

                     <field standard-id="CUST_FLD_TXT_DATETIME_598">02/03/2016</field>

                     <field standard-id="CUST_FLD_TXT_TIMECODE_599">00:00:25:50</field>

                     <field standard-id="CUST_FLD_TXT_FLOAT_597">29.97</field>

              </custom-metadata>

              <categories>

                     <category name="Albums/Enrique/Ayer"/>

              </categories>

       </asset>

       <asset ingest-action="create-asset-placeholder" file-name="NextAlbum.avi">

              <basic-metadata>

                     <title>NextAlbum</title>

                     <description>Place holder for Next album video </description>

                     <author>Justin</author>

              </basic-metadata>

       </asset>

</eMAM>

 

 

a.  create-new-asset:

Asset 1.


<?xml version="1.0" encoding="UTF-8"?>

<eMAM user-key="zlEKbVGXb0UWyOavK6yQwneL7cPxV6zy6V1/+ZTxuuA=">

<asset file-name="Heartbeat.avi" ingest-action="create-new-asset" file-action="copy-file" file-path="\\10.0.8.40\emamfolders\xmlingest">

              <basic-metadata>

                     <title>Heartbeat</title>

                     <description>Euphoria is the ninth studio album by Spanish singer-songwriter Enrique Iglesias. The album is a joint-release by Universal Republic and Universal Music Latino and was released on 5 July 2010 internationally and in the US on 6 July 2010</description>

                     <author>John Garyson</author>

              </basic-metadata>

              <markers>

                     <marker name="marker1" time-code="00:00:01:10" duration="00:00:00:00">The best part of the album</marker>

              </markers>

              <subclips>

                     < subclip type = " std " name = " subclip1 " start-time="00:00:01:43" end-time="00:00:03:43"/>

                     < subclip type = " tx " name = " subclip2 " start-time="00:00:03:53" end-time="00:00:06:43"/>

              </subclips>

              <projects>

                     <project name="NewProjects/Albums"/>

                     <project name="LatestCollections/Videos"/>

              </projects>

              <categories>

                     <category name="Albums/Enrique/Euphoria"/>

              </categories>

       </asset>

      </eMAM>

 

 Asset 1 Details

Description

File name

Asset name “Heartbeat.avi

Ingest action

create-new-asset

A new asset with title “Heartbeat” will be created in the eMAM system.

File path

Network shared path of the asset Heartbeat.avi

\\10.0.8.40\emamfolders\xmlingest

File action

copy-file

A copy of “Heartbeat.avi” will be copied from \\10.0.8.40\emamfolders\xmlingest folder to eMAM managed storage. Also, source path will be indexed in eMAM.

 

 

Basic metadata

Basic details like:

<title>Heartbeat</title>

<description>Euphoria is the ninth studio album by Spanish singer-songwriter Enrique Iglesias. The album is a joint-release by Universal Republic and Universal Music Latino and was released on 5 July 2010 internationally and in the US on 6 July 2010</description>

<author>John Garyson</author>

will be associated as basic metadata of the asset “Heartbeat.avi”.

Markers

Markers details like:

“name="marker1" time-code="00:00:01:10" duration="00:00:00:00">The best part of the album</marker”
 will be associated with asset “Heartbeat.avi”.

Subclips

Below subclips details:

name “subclip1”, type “std” , start time " 00:00:01:43 "and end time "00:00:03:43"

name “subclip2” type “tx” , start time " 00:00:03:53 " and end time "00:00:06:43"

will be associated with asset “Heartbeat.avi”..

Projects

Asset “Heartbeat.avi” will be assigned to bin “Albums" under project "NewProjects”  and to bin “Videos” under project “LatestCollections”

name="NewProjects/Albums"

name="LatestCollections/Videos"

Categories

Asset “Heartbeat.avi” will be assigned to sub Category “Albums/Enrique/Euphoria”


 

b.  create-new-version

Asset 2.

<?xml version="1.0" encoding="UTF-8"?>

<eMAM user-key="zlEKbVGXb0UWyOavK6yQwneL7cPxV6zy6V1/+ZTxuuA=">

<asset asset-id="30544" file-path="\\10.0.8.40\emamfolders\xmlingest" file-action="move" ingest-action="create-new-version" file-name="Ayer1.avi">

              <basic-metadata>

                     <title>Ayer</title>

                     <description>'Ayer' by Enrique Iglesias.</description>

                     <author>Johan</author>

              </basic-metadata>

              <custom-metadata>

                     <field standard-id="CUST_FLD_TXT_DATETIME_598">02/23/2015</field>

                     <field standard-id="CUST_FLD_TST_INT_596">15</field>

                     <field standard-id="CUST_FLD_TXT_TIMECODE_599">00:02:05:29</field>

              </custom-metadata>

              <markers>

                     <marker name="marker1" time-code="00:00:01:10" duration="00:00:00:00">The first part of the album from here</marker>

                     <marker name="marker1" time-code="00:00:01:10" duration="00:00:00:00">The second part of the album from here</marker>

                     <marker name="marker1" time-code="00:00:01:10" duration="00:00:00:00">The third part of the album from here</marker>

              </markers>

              <projects>

                     <project name="NewProjects/Album1"/>

              </projects>

             

       </asset>

</eMAM>

 

 

Asset 2 Details

Description

File name

Asset name "Ayer1.avi"

Ingest action

create-new-version

A new versionof the existing asset “30544" will be created in the eMAM system.

File action

Move

Asset "Ayer1.avi" will be moved from the source location to eMAM managed storage.

Asset id

30544

Id of the asset from File version widget in eMAM Director interface

“30544”

File path

Network shared path of the asset "Ayer1.avi"

\\10.0.8.40\emamfolders\xmlingest

 

Basic metadata

Basic details like:

<title>Ayer</title>

<description>'Ayer' by Enrique Iglesias.</description>

<author>Johan</author>

 will be associated as basic metadata of the asset "Ayer1.avi".

Custom metadata  

 

Custom metadata details like

standard-id="CUST_FLD_TXT_DATETIME_598">02/23/2015”

standard-id="CUST_FLD_TST_INT_596">15</field”

“field standard-id="CUST_FLD_TXT_TIMECODE_599">00:02:05:29</field”

 

will be associated to Asset "Ayer1.avi"

Markers

Markers details like:

name="marker1" time-code="00:00:01:10" duration="00:00:00:00">The first part of the album from here</marker”

“name="marker1" time-code="00:00:01:10" duration="00:00:00:00">The second part of the album from here”

name="marker1" time-code="00:00:01:10" duration="00:00:00:00">The third part of the album from here”

 

will be associated to Asset "Ayer1.avi"

Projects

Asset "Ayer1.avi" will be assigned to sub Project “Albums1" under project "NewProjects”

name="NewProjects/Albums1"


 

c.  associate-metadata

Asset 3.

<?xml version="1.0" encoding="UTF-8"?>

<eMAM user-key="zlEKbVGXb0UWyOavK6yQwneL7cPxV6zy6V1/+ZTxuuA=">

<asset asset-id="30494" ingest-action="associate-metadata" file-name="NewVideo1.mp4" version-id="35662">

              <associate file-type="original" file-action="copy" file-exist-action="create-new-version" file-name="A013C009_160219_R0S7.mov" file-path="D:\Project A\Bin" />

            <associate file-type="platform" file-action="copy" platform-id="1" file-name="A013C009_160219_R0S7.mp4" file-path="D:\Project B\Clip" />

              <basic-metadata>

                     <title>NewVideo1.mp4</title>

                     <description>The All new video from the Collection</description>

                     <author>John Garyson</author>

              </basic-metadata>

              <custom-metadata>

                     <field standard-id="CUST_FLD_TST_LIST_595">VideoCategory1</field>

                     <field standard-id="CUST_FLD_TXT_DATETIME_598">02/03/2016</field>

                     <field standard-id="CUST_FLD_TXT_TIMECODE_599">00:00:25:50</field>

                     <field standard-id="CUST_FLD_TXT_FLOAT_597">29.97</field>

              </custom-metadata>

              <categories>

                     <category name="Albums/Enrique/Ayer"/>

              </categories>

       </asset>

</eMAM>

 

 

 

 

Asset 3 Details

Description

File name

 

Asset name "NewVideo1.mp4"

file-name="NewVideo1.mp4"

Ingest action

associate-metadata

Metadata’s will be associated for an already existing asset "NewVideo1.mp4" with id 30494 in eMAM system

ingest-action="associate-metadata"

 Basic metadata

Basic details like:

<title>NewVideo1.mp4</title>

<description>The All new video from the Collection</description>

<author>John Garyson</author>

will be associated as basic metadata for asset "NewVideo1.mp4" with id 30494.

Custom metadata

 

 

Custom metadata details like

standard-id="CUST_FLD_TST_LIST_595">VideoCategory1”

standard-id="CUST_FLD_TXT_DATETIME_598">02/03/2016

standard-id="CUST_FLD_TXT_TIMECODE_599">00:00:25:50

standard-id="CUST_FLD_TXT_FLOAT_597">29.97”

will be associated with asset "NewVideo1.mp4" with id 30494.

Categories

 

"NewVideo1.mp4" will be assigned to sub Category “Albums/Enrique/Ayer

<category name="Albums/Enrique/Ayer"/>

Asset id

Asset Id “30494”: Id of the asset from File version widget in eMAM Director interface.

If asset id = 0, it will automatically create a new placeholder for an asset and then original/proxy files and metadata can be associated to that asset.

Associate files

Associate file option can also be used to associate the Original (copy/move/index), Proxy and Mezzanine files to an existing asset or placeholder. You can also attach key frames as thumbnails for videos.

<associate file-type="original" file-action="copy" file-exist-action="replace" file-name="A013C009_160219_R0S7.mov" file-path="D:\Project A\Bin" />  

 

 

Original: Associate file to original file

file-name="A013C009_160219_R0S7.mov"

file-type="original"

File Type

 

Platform : Associate file to platform file (For file type- platform, platform id is must)

file-name="A013C009_160219_R0S7.mp4"

file-type="platform"

platform-id="1"

 

Platform-id

If platform id is 1, it will associate to eMAM preview proxy else it will associate to corresponding mezzanine formats.

(For file type- Platform, platform id is must).

platform-id="1"

file-exist-action

While associating original files, if file-exist-action

value is create-new-version, it will create a new version of the same asset.

file-exist-action=" create-new-version" 


 

d.  create-asset-placeholder

Asset 4.


<?xml version="1.0" encoding="UTF-8"?>

<eMAM user-key="zlEKbVGXb0UWyOavK6yQwneL7cPxV6zy6V1/+ZTxuuA=">

<asset ingest-action="create-asset-placeholder" file-name="NextAlbum.avi">

              <basic-metadata>

                     <title>Next Album</title>

                     <description>Place holder for Next album video </description>

                     <author>Justin</author>

              </basic-metadata>

       </asset>

</eMAM>

 

 

Asset 4 Details

Description

File name

 

Asset name "NextAlbum.avi"

Ingest action

create-asset-placeholder

A virtual asset with file name "NextAlbum.avi" and title Next Album will be created in the eMAM system

Basic metadata

Basic details like:

<title>Next Album</title>

<description>Next album </description>

<author>Justin</author>

will be associated as basic metadata for asset “NextAlbum.avi".  

 

Known issues

                  

Glossary

XML- Extensible Markup Language is a markup language that defines a set of rules for encoding documents in a format that is both human-readable and machine-readable. XML provides a uniform method for describing and exchanging structured data that is independent of applications or vendors.

XSD- XML Schema Definition: XML Schema describes the structure of an XML document. Schemas are useful for enforcing structure and/or constraining the types of data that can be used validly within other XML documents. XML Schema Definition refers to the fully specified and currently recommended standard for use in authoring XML schemas.

HTML (Hyper Text Markup Language) is the standard markup language for creating web pages and web applications.

Attributes - An XML structural construct. A name-value pair, separated by an equals sign, included inside a tagged element that modifies certain features of the element. All attribute values, including things like size and width, are in fact text strings and not numbers.

Elements - An XML structural construct. An XML element consists of a start tag, an end tag, and the information between the tags, which is often referred to as the contents. Each element has a type, identified by name, sometimes called its "generic identifier" (GI), and may have a set of attribute specifications. Each attribute specification has a name and a value. An instance of an element is declared using tags.

Schema - A formal specification of element names that indicates which elements are allowed in an XML document, and in what combinations. It also defines the structure of the document: which elements are child elements of others, the sequence in which the child elements can appear, and the number of child elements. It defines whether an element is empty or can include text. The schema can also define default values for attributes.

Get Help

For any assistance and more information, please contact eMAM support at support@emamonline.com.