Dalet Flex > Configuration > Plugins > Action Plugins > Import

Import

These plugins enable you to import objects into Dalet Flex.

Asset Import Action

This plugin enables the import of assets to Dalet Flex.

Properties

Field	Value	Explanation
Icon		Plugin icon
Sub-type	Import	Sub-type of this plugin
Classification	I/O	Classification of this plugin
Deployment	Internal	Whether the plugin is deployed inside Dalet Flex or within another product
Supports Configuration		Whether this plugin supports configuration
Supports Scripting		Whether configuration supports scripting
Scripting Context	job, asset, event*	What Dalet Flex objects can be referenced from within the scripting context. * Note: the event object is only visible in the context of an action running in an event handler.
Undo Action		The action required to undo this action
Redo Action		The action required to redo this sction
Timeout		Whether or not to select a timeout
Auto retry		Whether or not to select an automatic retry
Compatibility	5.x	What versions of Dalet Flex this plugin works for
Lifecycle	Stable	Maturity of this plugin (Experimental, Unstable or Stable)

Configuration

Field	Field Type	Multiplicity	Description
Source File	complex	0..1	Details of the source file to import. If a source file is not specified, no media file is imported into the asset. This procedure can be used to create placeholder assets.
Source	complex		Details of the source file
Source VFS Location	complex	0..1	The virtual file system location of the medial file to import
Protocol	single option		Protocol for accessing the location
Hostname	string		Hostname for accessing the location (mandatory except for file, s3, google or dropbox protocols)
Port	integer		Port for accessing the location (mandatory except for file, s3, google or dropbox protocols) (#)
Path	string		Path for accessing the location (absolute path starting with / except for ftp, sftp, ftps which are relative to the user’s home directory)
Username	string		Username for authentication (not required for file protocol)
Password	string		Password for authentication (not required for file, s3, google or dropbox protocols)
Key	string		Key for authentication (only applicable to s3, google and dropbox protocols)
Secret	string		Secret for authentication (only applicable to s3, google and dropbox protocols)
Token	string		Token for authentication (only applicable to google and dropbox protocols)
Bucket	string		Only applicable to S3 protocol
Private Key File	file		Only applicable for SFTP certificate authentication
Source Resource Item	complex	0..1	The Resource and Item Name of the source file
Source Resource	single option		The resource containing the source item
Item Name	string		The name of the item in the source resource
Original Filename	string		The value to set as the original filename of the imported media file. If not specified, the current filename is used.
Keep Source File Name	boolean		If true, then the source file name is maintained, otherwise a UUID is generated.
Read Xml Header	boolean		If this field is set to “true”, the system looks for a header in TTML file. If it starts with a tag, it will be imported as a subtitle asset. If it does not start with a tag, it is treated as text asset. This field should only be set to “true” if the TTML file has a .xml extension.
Copy File	complex	0..1	Copy the file to a new location. If not specified, the media file is ingested in place. One of either the target resource or folder can be specified.
Target Resource	single option		The Folder Resource for the imported media file to be copied to
Target VFS Location	complex		The Virtual File System location for the imported media file to be copied to
Protocol	single option		Protocol for accessing the location
Hostname	string		Hostname for accessing the location (mandatory except for file, s3, google or dropbox protocols)
Port	integer		Port for accessing the location (mandatory except for file, s3, google or dropbox protocols)
Path	string		Path for accessing the location (absolute path starting with / except for ftp, sftp, ftps which are relative to the user’s home directory)
Username	string		Username for authentication (not required for file protocol)
Password	string		Password for authentication (not required for file, s3, google or dropbox protocols)
Key	string		Key for authentication (only applicable to s3, google and dropbox protocols)
Secret	string		Secret for authentication (only applicable to s3, google and dropbox protocols)
Token	string		Token for authentication (only applicable to google and dropbox protocols)
Bucket	string		Only applicable to S3 protocol
Private Key File	file		Only applicable for SFTP certificate authentication
Asset Details	complex		Descriptive details for the asset
Title	string		The title of the asset
Description	string		Optional description of the asset
Placeholder Asset Type	single option	0..1	The Placeholder Asset Type to create if no source file is specified
Asset Origin	single option		The origin to set for the asset
Disable Metadata Extraction	boolean		Whether to disable extraction of technical metadata from the asset during import
Variant	complex		Specify the Variant and optionally the Metadata Definition to set for the asset. If not specified, a default is used if it has been configured.
Variant	string		The Variant to set. This must be a valid configured Variant name.
Metadata	complex		Specify a Metadata Definition to set. If not specified, a default is used if it has been configured.
Metadata Definition	single option	0..1	The Metadata Definition to set
Source JSON Variable	string	0..1	The source JSON variable
Source XML	complex	0..1	Set the metadata based on details stored in an XML file or workflow variable. If not specified, a default metadata instance is created.
Source XML Location	complex	0..1
Source XML VFS Location	complex		The Virtual File System location of the source XML file to read.
Protocol	single option		Protocol for accessing the location
Hostname	string		Hostname for accessing the location (mandatory except for file, s3, google or dropbox protocols)
Port	integer		Port for accessing the location (mandatory except for file, s3, google or dropbox protocols)
Path	string		Path for accessing the location (absolute path starting with / except for ftp, sftp, ftps which are relative to the user’s home directory)
Username	string		Username for authentication (not required for file protocol)
Password	string		Password for authentication (not required for file, s3, google or dropbox protocols)
Key	string		Key for authentication (only applicable to s3, google and dropbox protocols)
Secret	string		Secret for authentication (only applicable to s3, google and dropbox protocols)
Token	string		Token for authentication (only applicable to google and dropbox protocols)
Bucket	string		Only applicable to S3 protocol
Private Key File	file		Only applicable for SFTP certificate authentication
Source XML Variable Name	string	0..1	Source XML workflow variable name to use
XSLT	file	0..1	Optional XSLT to apply to source XML. If not defined then XML is expected to be in MioMetadata XML form.
Keyframe	complex	0..*	Keyframe to set on the imported asset, if it is a media file. An image file cannot have keyframes.
Source Keyframe VFS Location	complex		The Virtual File System location of the source keyframe to import.
Protocol	single option field		Protocol for accessing the location
Hostname	string		Hostname for accessing the location (mandatory except for file, s3, google or dropbox protocols)
Port	integer		Port for accessing the location (mandatory except for file, s3, google or dropbox protocols)
Path	string		Path for accessing the location (absolute path starting with / except for ftp, sftp, ftps which are relative to the user’s home directory)
Username	string		Username for authentication (not required for file protocol)
Password	string		Password for authentication (not required for file, s3, google or dropbox protocols)
Key	string		Key for authentication (only applicable to s3, google and dropbox protocols)
Secret	string		Secret for authentication (only applicable to s3, google and dropbox protocols)
Token	string		Token for authentication (only applicable to google and dropbox protocols)
Bucket	string		Only applicable to S3 protocol
Private Key File	file		Only applicable for SFTP certificate authentication
Title	string		Optional title for the keyframe
Keyframe Description	string		Optional description for the keyframe
Timecode	integer	0..1	Optional timecode for the keyframe. If defined, the keyframe is imported as an extracted keyframe, otherwise it is imported as an uploaded keyframe.
Poster frame	boolean		Whether the keyframe should be set as poster. If multiple keyframes are configured as poster, the last to be imported is set as poster for the asset.
Asset Relationships	complex		Specify relationships with existing assets in the system.
Child	complex	0..1	Add a parent-child relationship
Parent Asset	complex		Specify the parent asset
Parent Asset	single option	0..1	Select the parent file asset to use.
Parent Asset ID	string	0..1	Specify the parent file asset ID or use an expression.
Reference Name	string		Optional reference name to set on the parent-child relationship
Member	complex	0..*	Add a group-member relationship.
Parent Group Asset	complex		Specify the parent group.
Group Asset	single option	0..1	Specify the parent group asset to use.
Group Asset ID	string	0..1	Specify the parent group asset ID or use an expression.
Membership Name	string		Optional membership name to set on the group-member relationship

Asset Folder Import Action

Properties

Field	Value	Explanation
Icon		Plugin icon
Sub-type	Import	Sub-type of this plugin
Classification	I/O	Classification of this plugin
Deployment	Internal	Whether the plugin is deployed inside Dalet Flex or within another product
Supports Configuration		Whether this plugin supports configuration
Supports Scripting		Whether configuration supports scripting
Scripting Context	job, asset, event*	What Dalet Flex objects can be referenced from within the scripting context. *Note: the event object is only visible in the context of an action running in an event handler.
Undo Action		The action required to undo this action
Redo Action		The action required to redo this action
Timeout		Whether or not to select a timeout
Auto retry		Whether or not to select an automatic retry
Compatibility	5.x	What versions of Dalet Flex this plugin works for
Lifecycle	Stable	Maturity of this plugin (Experimental, Unstable or Stable)

Configuration

Field	Field Type	Multiplicity	Description
Source Folder	complex	1	Details of the asset to import
Source VFS Location	complex	1	The virtual file system location of the root folder
Protocol	single option		Protocol for accessing the location
Hostname	string		Hostname for accessing the location (mandatory except for file, s3, google or dropbox protocols)
Port	string		Port for accessing the location (mandatory except for file, s3, google or dropbox protocols) (#)
Path	string		Path for accessing the location (absolute path starting with / except for ftp, sftp, ftps which are relative to the User’s home directory)
Username	string		Username for authentication (not required for file protocol)
Password	password		Password for authentication (not required for file, s3, google or dropbox protocols)
Key	string		Key for authentication (only applicable to s3, google and dropbox protocols)
Secret	string		Secret for authentication (only applicable to s3, google and dropbox protocols)
Token	string		Token for authentication (only applicable to google and dropbox protocols)
Bucket	string		Only applicable to S3 protocol
Private Key File	file		Only applicable for SFTP certificate authentication
Source Resource	single option		The source resource for the root folder.
Allowed File Extension	string	1..*	If specified, only files with this extension will be processed.
Update Assets	boolean		If a file last modified date is later than the asset creation date, re-extract the technical metadata.
Asset Group Details	complex	1	If specified, an asset group will be created. All imported assets will be added to this group.
Group Name	string		The asset group will be created with the specified name.
Variant	complex	1	Specify the variant and optionally the metadata definition to set on the asset group. If not specified, a default will be used if it has been configured.
Variant	string		The variant to use for the group. This must be a valid configured variant name.
Metadata Definition	single option		The metadata definition to use.
Variable Name	string		If specified, the asset group will be stored as a variable with this name.

Multi Asset Import

This plugin supports the import of multiple assets.

Properties

Field	Value	Explanation
Icon		Plugin icon
Sub-type	Import	Sub-type of this plugin
Classification	I/O	Classification of this plugin
Deployment	Internal	Whether the plugin is deployed inside Dalet Flex or within another product
Supports Configuration		Whether this plugin supports configuration
Supports Scripting		Whether configuration supports scripting
Scripting Context	job, asset, event*	What Dalet Flex objects can be referenced from within the scripting context. *Note: the event object is only visible in the context of an action running in an event handler.
Undo Action		The action required to undo this action
Redo Action		The action required to redo this action
Timeout		Whether or not to select a timeout
Auto retry		Whether or not to select an automatic retry
Compatibility	5.x	What versions of Dalet Flex this plugin works for
Lifecycle	Stable	Maturity of this plugin (Experimental, Unstable or Stable)

Configuration

Field	Field Type	Multiplicity	Description
Source File	complex	1..*	Details of the source file to import. If not specified no media file will be imported to the asset.
Source File Path	string		Location of the media file to import.
Original Filename	string		The value to set as the original filename of the imported media file. If not specified, this will be the file name.
Copy File	complex	0..1	Copy the file to a new location. If not specified the media file will be ingested in place. One of either the target resource or folder can be specified.
Target Resource	Resource (Folder)		The folder resource for the imported media file to be copied to.
Target Folder Path	string		The target folder path for the imported media file to be copied to.
Asset Details	complex		Descriptive details for the asset.
Title	string		The title of the asset.
Description	string		Optional description for the asset
Placeholder Asset Type	single-option	0..1	The placeholder asset type to create if no source file is specified
Creation Context	single-option		The creation context to set on the asset.
Variant	complex	0..1	Specify the variant and optionally the metadata definition to set on the asset. If not specified, a default will be used if it has been configured.
Variant	string		The variant to set. This must be a valid configured variant name.
Metadata	complex	0..1	Specify a metadata definition to set. If not specified, a default will be used if it has been configured.
Metadata Definition	Metadata Definition	0..1	The metadata definition to set.
Source XML	complex	0..1	Set the metadata based on details stored in an XML file. If not specified a default metadata instance will be created.
Source XML Path	string		Location of the source XML file to read.
XSLT	file	0..1	Optional XSLT to apply to source XML. If not defined then XML is expected to be in Dalet Flex metadata XML form.
Keyframe	complex	0..*	Keyframe to set on the asset. This will be used only if the imported asset is a media file. If an image file it will be ignored.
Source Keyframe Path	string		Location of the source keyframe to import.
Title	string		Optional title for the keyframe.
Keyframe Description	string		Optional description for the keyframe.
Timecode	string	0..1	Optional timecode for the keyframe. If defined the keyframe is imported as an extracted keyframe, otherwise it is imported as an uploaded keyframe.
Poster frame	boolean		Whether the keyframe should be set as poster. If multiple keyframes are configured as poster, the last to be imported will be set as poster for the asset.
Asset Relationships	complex		Relationships to define against existing assets in the system.
Child	complex	0..1	Add a parent-child relationship.
Parent Asset	complex		Specify the parent asset.
Parent Asset	asset	0..1	Select the parent file asset to use.
Parent Asset ID	string	0..1	Specify the parent file asset ID or use an expression.
Reference Name	string		Optional reference name to set on the parent-child relationship.
Member	complex	0..*	Add a group-member relationship.
Parent Group Asset	complex		Specify the parent group.
Group Asset	asset	0..1	Select the parent group asset to use.
Group Asset ID	string	0..1	Specify the parent group asset ID or use an expression.
Membership Name	string		Optional membership name to set on the group-member relationship.
Workflow Variable Name	string	0..1	Specify the workflow variable name to use to store the created asset. If this is not specified, the asset will not be set as a workflow variable.
Store Asset in Context			Stores the created asset in the context

Attachment Import

Supports the import of an attachment file and association with an existing object inside Dalet Flex.

Properties

Field	Value	Explanation
Icon		Plugin icon
Sub-type	Import	Sub-type of this plugin
Classification	I/O	Classification of this plugin
Deployment	Internal	Whether the plugin is deployed inside Dalet Flex or within another product
Supports Configuration		Whether this plugin supports configuration
Supports Scripting		Whether this plugin supports scripting
Undo Action		The action required to undo this action
Redo Action		The action required to redo this action
Timeout		Whether or not to select a timeout
Auto retry		Whether or not to select an automatic retry
Compatibility	5.x	What versions of Dalet Flex this plugin works for
Lifecycle	Stable	Maturity of this plugin (Experimental, Unstable or Stable)

Configuration

Field	Field Type	Multiplicity	Description
Object ID	string	0..1	The ID of the object the file should be attached to. If not specified - the current object will be used.
VFS Location	Complex		Location of the attachment
Protocol	Resource		Protocol for accessing the location
Hostname	String		Hostname for accessing the location (mandatory except for file, s3, google or dropbox protocols)
Port	String		Port for accessing the location (mandatory except for file, s3, google or dropbox protocols) (#)
Path	String		Path for accessing the location (absolute path starting with / except for ftp, sftp, ftps which are relative to the user’s home directory)
Username	String		Username for authentication (not required for file protocol)
Password	String		Password for authentication (not required for file, s3, google or dropbox protocols)
Key	String		Key for authentication (only applicable to s3, google and dropbox protocols)
Secret	String		Secret for authentication (only applicable to s3, google and dropbox protocols)
Token	String		Token for authentication (only applicable to google and dropbox protocols)
Bucket	String		Only applicable to S3 protocol
Private Key File	File		Only applicable for SFTP certificate authentication
Attachment Name	String	0..1	Name for the uploaded attachment.
Attachment Description			Description for the attachment.

Package Import

Supports the import of an attachment file and association with an existing object inside Dalet Flex.

Properties

Field	Value	Explanation
Icon		Plugin icon
Sub-type	Import	Sub-type of this plugin
Classification	I/O	Classification of this plugin
Deployment	Internal	Whether the plugin is deployed inside Dalet Flex or within another product
Supports Configuration		Whether this plugin supports configuration
Supports Scripting		Whether this plugin supports scripting
Scripting Context	job, asset, event*	What Dalet Flex objects can be referenced from within the scripting context. *Note: the event object is only visible in the context of an action running in an event handler.
Undo Action		The action required to undo this action
Redo Action		The action required to redo this action
Timeout		Whether or not to select a timeout
Auto retry		Whether or not to select an automatic retry
Compatibility	5.x	What versions of Dalet Flex this plugin works for
Lifecycle	Stable	Maturity of this plugin (Experimental, Unstable or Stable)

Configuration

Field	Field Type	Mandatory	Multiplicity	Description
Package Profile	Complex			Profile to be used for the package import
Package Profile	Single Option			Select a Mio Package profile to be used
Profile Value Mappings	Complex		0..*	Mappings for the string variable defined in profile
Key	String			Key of the string variable defined in profile
Value	String			Value of the string variable defined in profile
Profile Asset Mappings	Complex		0..*	Mappings for the object variable defined in profile
Key	String			Key of the object variable defined in profile
Value	Single Option	Value of the object variable defined in profile
Target	Complex			The final location of the output file
Folder Resource	Single Option		0..1	The output file will be placed in the specified Folder Resource
Target VFS Location	Complex		0..1	The Virtual File System location for the Package Import
Protocol	Single Option			Protocol for accessing the location
Hostname	String			Hostname for accessing the location (mandatory except for FILE, S3 and AZBS protocols)
Account Name	String			Account name for accessing the azure blob storage (only applicable for AZBS protocol)
Port	String			Port for accessing the location (mandatory except for FILE, S3 and AZBS protocols)
Path	String			Path for accessing the location (absolute path starting with / except for FTP, SFTP, which are relative to the user’s home directory)
Username	String			Username for authentication (not required for FILE protocol)
Password	String			Password for authentication (not required for FILE, S3 and AZBS protocols)
Key	String			Key for authentication (only applicable to S3 and AZBS protocols)
Secret	String			Secret for authentication (only applicable to S3 protocol)
Token	String			Token for authentication
Bucket	String			Only applicable to S3 and AZBS(Container) protocols
Private Key File	File			Only applicable for SFTP certificate authentication

Import IMP

You can import a complete Interoperable Master Package (IMP) into Flex Media Platform. An IMP describes the delivery package exchanged between two businesses. This contains just the video files, audio files, subtitles, closed captions, and metadata that have been acquired / are required by the recipient.

This action lets you import a partial package. You might do this if you want to update a package that is already in Flex. This could be importing a specific version of an existing media file.

Note: You can import a supplemental package and then import a complete package on top of that, or import a complete package and then import a supplemental package on top of that. Inside an IMP folder, you will also find:

Properties

Field	Value	Explanation
Icon		Plugin icon
Sub-type	Import	Sub-type of this plugin
Classification	I/O	Classification of this plugin
Deployment	Internal	Whether the plugin is deployed inside Dalet Flex or within another product
Supports Configuration		Whether this plugin supports configuration
Supports Scripting		Whether configuration supports scripting
Scripting Context	job, asset, event*	What Dalet Flex objects can be referenced from within the scripting context. *Note: the event object is only visible in the context of an action running in an event handler.
Undo Action		The action required to undo this action
Redo Action		The action required to redo this sction
Timeout		Whether or not to select a timeout
Auto retry		Whether or not to select an automatic retry
Compatibility	7.2.0	What versions of Dalet Flex this plugin works for
Lifecycle	Stable	Maturity of this plugin (Experimental, Unstable or Stable)

Configuration