Dalet Flex Core: Plugins: Resource Plugins

Capacity

Folder

A Folder plugin represents a folder for the storage of assets. A folder resource references one or more storage resources that is actually used for managing the storage of the underlying files. (A folder can span multiple storage resources). A folder is closer in concept to an object storage "bucket" as it does not support nesting.

 

Folder Properties

Field	Value	Explanation
Icon		Plugin icon
Sub-type	Folder	Sub-type of this plugin
Classification	Capacity	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		What Dalet Flex objects can be referenced from within the scripting context
Undo action		The action required to undo this action
Redo action		The action required to redo this action
Compatibility	5.x	What versions of Dalet Flex this plugin works for
Lifecycle	Stable	Maturity of this plugin (Experimental, Unstable or Stable)

 

Folder Configuration

Field	Field Type	Mandatory	Multiplicity	Description
Storage resources	complex		1..*	Storage resources used by the folder resource
Storage resource	resource (Storage)			Name of storage resource

 

Hot Folder Resource

A Hot Folder is a special type of folder resource, designed for the processing and ingesting of files.
This is a very versatile plugin that supports a range of features.

 

Variables

You can view a list of variables that are injected by Hot Folders here.

 

File Name Limitations in Hot Folders

The following characters are allowed in filenames in hot folders: !, @, $, #, &, _ (underscore), - (hyphen), ^, *`*, ', ~, ;, [], (), {}

The following special characters are not allowed in filenames in hot folders: %, Æ, Ø, Å, æ, ø, å, 电脑
(Any Chinese or Japanese characters), Umlauts (e.g. å ä ö ü ß Ä Ö Ü), < >, :, ", /, \, |, ?, *

 

Housekeeping Period

The Housekeeping Period option determines how often to clean up (delete) partial media file uploads, old MD5 checksum files and old manifest files from Dalet Flex.

 

Inactivity Timeout

This option specifies how much time should pass since the file was last modified before starting to process the file.

If a file is transferred without a manifest or MD5 checksum, it is impossible to know whether the transfer is completed. In this case, Dalet Flex assumes that the transfer completed since the last modified date, and begin ingest.

If an MD5 checksum fails, Dalet Flex fires an event. So it is easy to monitor for failed MD5 checksums.
In fact, a range of Events related to transfer processing can be monitored.

 

Storage Resources

Storage resources are used in this context to point to storage mounts that the Hot Folder uses to process incoming files.

 

Match Pattern

Match pattern is a regular expression used to match file names for processing.

 

Ignore Pattern

Ignore pattern is a regular expression used to specify the files to ignore.

 

MD5 Checksums

MD5 checksum algorithms are used by Dalet Flex to check the integrity of files once ingested. Dalet Flex uses these algorithms to verify the integrity of the media file once delivered.

 

Workflow

Workflow specifies a workflow definition to run once the file has been processed.

A workflow should contain an Ingest node to ensure the file gets converted to an asset for further processing.

 

Owner

Owner specifies the owner (user) of the imported files.

 

Workspace

Workspace is the name of the Workspace to associated the newly ingested asset with.

 

Sidecar

Sidecar specifies a sidecar file (this is injected into the workflow as a variable).

 

Hot Folder Resource Properties

Field	Value	Explanation
Icon		Plugin icon
Sub-type	inbox	Sub-type of this plugin
Classification	Capacity	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		What Dalet Flex objects can be referenced from within the scripting context
Undo action		The action required to undo this action
Redo action		The action required to redo this action
Compatibility	5.x	What versions of Dalet Flex this plugin works for
Lifecycle	Stable	Maturity of this plugin (Experimental, Unstable or Stable)

 

Hot Folder Resource Configuration

Field	Field Type	Mandatory	Multiplicity	Description
Housekeeping Period	long			Housekeeping Period
Inactivity Timeout	long			Seconds of inactivity before considering transfer complete
Storage resources	complex			Storage resources used by inbox
Storage resource	resource (Storage)		1..*	Name of storage resource
Remove Timestamp	boolean			Should timestamps be expected on filenames and removed after delivery?
Use Manifest	boolean			Whether or not a manifest file is expected
Use MD5	boolean			Whether or not an MD5 checksum file for the main file is expected. Irrelevant if using manifests.
Workflow	Workflow definition			Name of the workflow definition to launch after upload
Validation	Validation Profile (All)			Validation definition to be applied within Dalet Flex Client
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 for image or media assets.
Metadata definition	Metadata definition			The metadata definition to set. This must belong to the specified variant.

 

Hot Folder

The Hot Folder plugin can scan subdirectories recursively. This Hot Folder plugin does not need to be backed by a storage resource. Hot folder resource configuration itself supports configuring multiple VFS locations, which must be scanned for any changes.

 

Points to be Considered Before Using the Hot Folder Plugin

• The current implementation of the Hot Folder service does not currently support all features of the previous Hot Folder Resource, such as Md5 support, Side car xml support, and Housekeeping.
• A segmented asset must be copied as a package (even though there is a single file) inside the hot folder.
• Only the master manifest file is tracked in Core. A segmented asset in Core points to the master `m3u8` file only. However, the copy and move actions are modified to consider the segmented asset as a package, so that whenever a copy or move action is run against a segmented asset, it copies or moves the master manifest with all the other reference files.
• The Hot Folder plugin does not read the `m3u8` file, so cannot decide which is a master manifest and which are sub, or child manifest files. Pattern matching must be configured on the hot folder to help the hot folder to identify the master manifest.
• Segmented assets created as part of hot folder scanning are marked as live files. Once the file is no longer live, it currently needs to be set to `live = false` explicitly by hitting the asset REST endpoint. In future, this will be taken care of automatically by the Hot Folder plugin.
• Resource items are created in Core for every file scanned or processed (after applying match and ignore patterns). However, if there is more than one file with the same name (in different sub-directories) then there will be more than one resource item with the same name in Core. A tool-tip is displayed when you hover on the item name, showing a path to the specific file item location.

 

Hot Folder Properties

Field	Value	Explanation
Icon		Plugin icon
Sub-type	Folder	Sub-type of this plugin
Classification	Capacity	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		What Dalet Flex objects can be referenced from within the scripting context
Undo action		The action required to undo this action
Redo action		The action required to redo this action
Compatibility	6.x	What versions of Dalet Flex this plugin works for
Lifecycle	Stable	Maturity of this plugin (Experimental, Unstable or Stable)

 

Hot Folder Configuration

Field	Field Type	Mandatory	Multiplicity	Description
Inactivity Timeout (in seconds)	long			Seconds of inactivity before considering transfer complete (#,##0.###)
File Location	complex		1..*	Location of a file system to be monitored
Protocol	single option			Protocol to access the location
Host Name	string			Hostname to access the location (mandatory except for FILE, S3 and AZBS protocols)
Account Name	string			Account name to access the azure blob storage (only applicable for AZBS protocol)
Port	integer			Port to access the location (mandatory except for File, S3 and AZBS protocols) (#)
Path	string			Path to access 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	string			Only applicable to SFTP certificate authentication
Workflow Definition	single option			Workflow to be launched once the file is copied
Workflow Priority	single option			Priority to be set to the job launched by the workflow
Workflow and Asset Owner	single option			Owner of workflows and any imported assets
Workspace	string			Workflow and asset workspace
Match Pattern (regular expression)	string			Regular expression to match on file names
Ignore Pattern (regular expression)	string			Regular expression used to ignore files

 

Inbox

An inbox resource is a special type of folder resource, designed for the delivery of incoming files. This is a very versatile plugin that supports a range of features, including delivery from the FlexMOVE and standard FTP clients. The inbox V2 resource currently supports HTTP upload only. Later versions will incorporate functionality from the older inbox resource, which will be deprecated, and will support all types of remote transfer.

 

Manifest Files

When a file is transferred from the FlexMOVE, a manifest file is first sent to the inbox. This file comprises:

• Folder name: The remote Folder being delivered to.
• Md5 Checksum Data: Information for verifying that the file has been successfully transferred and its integrity is intact.
• File Size Info: A file size value for verifying that the entire file has been delivered.
• User: user details to identify the Dalet Flex user that transferred the file.
• Workspace: The chosen workspace that the user would like the ingested asset associated with.
• File name: The original file name (with timestamp prepended if this is enabled).
• Content Metadata: Metadata values to associated with the ingested asset (assuming a metadata schema has been enabled).

Using a manifest file makes ingest more robust and also allows for the combination of files and "sidecar" metadata. When using the Transfer Agent, Manifest files are created and transferred automatically behind the scenes. Manifest files can also be created by other systems and transferred first, if you wish to use an FTP client.

If you intend to deliver to a specific workspace, or require Metadata entry on upload, you must enable manifests in your inbox.

 

Timestamps

If a user transfers a file with the same name as a file that is already in the inbox, then the transfer fails. This can be avoided by enabling the removal of timestamps.

If the Timestamp option is enabled, the Transfer Agent adds a timestamp at the start of the file. The timestamp is then removed prior to ingest into Dalet Flex. If this option is enabled and you are using an FTP client, you must add a timestamp yourself. The format is: ``13-09-11-14-57-43_FILEname`` where `FILEname` is the original name of your file.

 

MD5 Checksums

MD5 checksum algorithms are used by Dalet Flex to check the integrity of files once ingested. If you use a manifest file, Dalet Flex expects to find the checksum inside it. If you are not using a manifest, then the md5 checksum file must be sent first. Dalet Flex uses this file to verify the integrity of the media file once delivered.

If you use manifests, you can ignore the MD5 checksum option, as the MD5 checksum is always included in the manifest and therefore always used.

 

Housekeeping Period

The Housekeeping Period option is used to determine how often to clean up (delete) partial media file uploads, old MD5 checksum files and old manifest files from Dalet Flex.

 

Inactivity Timeout

This option is used to specify how much time should pass since the file was last modified before starting to process the file. If there is a manifest file, then Dalet Flex can check the file size to be sure that it completed transfer. If there is an MD5 file, Dalet Flex can check the integrity of the file. If the file transfer is complete and the file integrity is correct, the ingest process begins.

If a file is transferred without a manifest or MD5 checksum, it is impossible to know whether the transfer is completed. In this case, Dalet Flex assumes that the transfer has completed since the last modified date, and begins ingest.

If an MD5 checksum fails, Dalet Flex fires an event. So it is easy to monitor for failed MD5 checksums. In fact, a range of events related to transfer processing can be monitored.

 

Storage Resources

Storage resources are used in this context to point to storage mounts on the Dalet Flex Transfer servers. Normally, more than one of these entries exist, as Dalet Flex Transfer servers are typically deployed in clusters. The inbox polls these locations for new files to process and ingest.

 

Workflow

This option is used to specify a workflow defintion to run once the file has been processed.

A workflow should contain an Ingest node to ensure the file gets converted to an asset for further processing.

 

Validation

This option is used to specify an optional validation profile to use to validate the file before the Transfer Agent commences upload. This option is only relevant if you intend to use the Transfer Agent for transferring files.

 

Variant

This option is used to convert the ingest file into a specific asset . You can also specify what metadata schema to associate with the variant.

 

Inbox Properties

Field	Value	Explanation
Icon		plugin icon
Sub-type	inbox	Sub-type of this plugin
Classification	Capacity	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		What Dalet Flex objects can be referenced from within the scripting context
Undo action		The action required to undo this action
Redo action		The action required to redo this action
Compatibility	5.x	What versions of Dalet Flex this plugin works for
Lifecycle	Stable	Maturity of this plugin (Experimental, Unstable or Stable)

 

Inbox Configuration

Field	Field Type	Mandatory	Multiplicity	Description
Housekeeping Period	long			Housekeeping Period
Inactivity Timeout	long			Seconds of inactivity before considering transfer complete
Storage resources	complex			Storage resources used by inbox
Storage resource	resource (Storage)		1..*	Name of storage resource
Remove Timestamp	boolean			Should timestamps be expected on filenames and removed after delivery?
Use Manifest	boolean			Whether or not a manifest file is expected
Use MD5	boolean			Whether or not an MD5 checksum file for the main file is expected. Irrelevant if using manifests.
Workflow	Workflow definition			Name of the workflow definition to launch after upload
Validation	Validation Profile (All)			Validation definition to be applied within Dalet Flex Client
Variant	complex		0..1	Specify the variant and optionally the Metadata defintion 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 for image or media assets.
Metadata definition	Metadata definition			The metadata definition to set. This must belong to the specified variant.

 

DIVArchive Resource

This resource provides access to an archive resource. Configuration options are governed by the specific vendor solution being used, so in this case, the configuration options are related to DIVArchive.

 

DIVArchive Resource Properties

Field	Value	Explanation
Icon		plugin icon
Sub-type	External	Sub-type of this plugin
Classification	Process	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		What Dalet Flex objects can be referenced from within the scripting context
Undo action		The action required to undo this action
Redo action		The action required to redo this action
Compatibility	5.x	What versions of Dalet Flex this plugin works for
Lifecycle	Stable	Maturity of this plugin (Experimental, Unstable or Stable)

 

DIVArchive Resource Configuration

Field	Field Type	Mandatory	Multiplicity	Description
Integration Service	complex			This is a complex that houses the configuration fields related to the Integration Service.
Hostname	string			Hostname for accessing the location. For example: hostname1234
Port	string			Port for accessing the location (#). This is an integer. For example: 1234.
Username	string			Username for authentication. This is a string that can be a combination of letters and numbers.
Password	string			Password for authentication. This is a string.
Site name	string			The site name configured in DIVArchive. This is a string. For example: my-site-name.
Folder Mapping	complex		0..*	Base VFS locations for the location of files
Flex Base VFS Location				Details for a base VFS location
Protocol	single option			Protocol for accessing the location. You must select an option from the drop down. The options that can be selected are as follows: AZBS, File, FTP, FTPS, HTTP, HTTPS, S3, SFTP, SMB,WEBDAV.
Hostname	string			Hostname for accessing the location (mandatory except for file, s3)
Port	string			Port for accessing the location (mandatory except for file, s3) (#). You must specify an integer. For example: 1234.
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). Example: /exampleflex/exampleflex-Core/storage/media
Username	string			Username for authentication (not required for file protocol)
Password	string			Password for authentication (not required for file, s3)
Key	string			Key for authentication (only applicable to s3)
Secret string	string			Secret for authentication (only applicable to s3)
Token	string			Token for authentication (only applicable to s3)
Bucket	string			Only applicable to S3 protocol. This is the path to the Amazon S3 bucket.
Private Key File	file			Only applicable for SFTP certificate authentication. Click the Choose file button and upload the private key file.
DIVA Archive Base VFS Location	complex			Details for a diva archive base vfs Location. You must specify the path to the location of the DIVArchive Base location.
Protocol	single option			Protocol for accessing the location. You must select an option from the drop down. The options that can be selected are as follows: AZBS, File, FTP, FTPS, HTTP, HTTPS, S3, SFTP, SMB,WEBDAV.
Hostname	string			Hostname for accessing the location (mandatory except for file, s3)
Port	string			Port for accessing the location (mandatory except for file, s3) (#)
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). You must specify the absolute path to the location. For example: c:\storage
Username	string			username for authentication (not required for file protocol)
Password	string			Password for authentication (not required for file, s3)
Key	string			Key for authentication (only applicable to s3)
Secret	string			Secret for authentication (only applicable to s3)
Token	string			Token for authentication.
Bucket	string			Only applicable to S3 protocol. You must specify the path to the Amazon S3 Bucket.
Private Key File	file			Only applicable for SFTP certificate authentication. Click the Choose file button and upload the private key file.

 

Shared Folder

Shared Folder resource is a special type of folder resource, designed for the sharing files residing in Dalet Flex. This is a very versatile plugin that supports a range of features, including transfer from the FlexMOVE and standard FTP clients.

Files uploaded to a shared folder can be downloaded using the FlexMOVE and using FTP clients. Shared files are never ingested into Dalet Flex.

 

MD5 Checksums

MD5 checksum algorithms are used by Dalet Flex to check the integrity of files once ingested.

 

Housekeeping Period

The Housekeeping Period option is used to determine how often to clean up (delete) partial media file uploads, old MD5 checksum files and old manifest files from Dalet Flex.

 

Inactivity Timeout

This option is used to specify how much time should pass since the file was last modified before starting to process the file. if there is a manifest file, then Dalet Flex can check the file size to be sure that it completed transfer. If there is an MD5 file, Dalet Flex can check the file's integrity. If the file transfer is complete and the file integrity is correct, the ingest process will begin.

If a file is transferred without a manifest or MD5 checksum, it is impossible to know whether the transfer is completed. So in this case, Dalet Flex will assume the the transfer is complete by the time since the last modified date, and begin ingest.

If an MD5 checksum fails, Dalet Flex will fire an Event. So it's easy to monitor for failed MD5 checksums. In fact there are a range of Events related to transfer processing that can be monitored.

 

Storage resources

Storage resources are used in this context to point to storage mounts on the Dalet Flex Transfer servers.
You will normally see more than one of these entries as Dalet Flex Transfer servers are typically deployed in clusters. The inbox will poll these locations for new files to process and ingest.

If you just configure storage resources they should be on the Dalet Flex Transfer Servers. The file will be uploaded to Transfer Servers and will also be downloadable from FlexMOVE.

 

Incoming Storage Resources

If you configure incoming resources, these should be on the transfer servers and the storage resources should be on the internal network. Then you need to setup an Event Handler to move the files from "Incoming resource" to "Storage resource" - the idea being that you could virus scan etc. the incoming files before putting them in a Shared location. In this case, only those that get shifted to "storage resource" would be visible to download in FlexMOVE.

 

Shared Folder Properties

Field	Value	Explanation
Icon		Plugin icon
Sub-type	Shared Folder	Sub-type of this plugin
Classification	Capacity	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		What Dalet Flex objects can be referenced from within the scripting context
Undo action		The action required to undo this action
Redo action		The action required to redo this action
Compatibility	5.x	What versions of Dalet Flex this plugin works for
Lifecycle	Stable	Maturity of this plugin (Experimental, Unstable or Stable)

 

Shared Folder Configuration

Field	Field Type	Mandatory	Multiplicity	Description
Housekeeping Period	long			Housekeeping Period
Inactivity Timeout	long			Seconds of inactivity before considering transfer complete
Storage resources	complex			Storage resources used by Shared Folder
Storage resource	resource (Storage)		1..*	Name of storage resource
Incoming Storage resources	complex			Incoming storage resources used by Shared Folder
Incoming Storage resource	resource (Storage)		0..*	Name of Incoming storage resource
Use MD5	boolean			Whether or not an MD5 checksum file for the main file is expected

 

Storage

CDN Storage

This plugin is a specialisation of the VFS storage resource. It provides a means of managing a CDN service as a storage resource in Dalet Flex. This can be extremely useful if, within a workflow, you wish to copy an asset from local storage directly to a CDN location for external access. It can also be useful if you wish to make an asset globally stream-able or downloadable outside of the Dalet Flex Console and yet still manageable as a Dalet Flex storage resource.

Dalet Flex can be configured to play back proxies from CDN storage resources within the Player framework.

The CDN storage resource requires two separate VFS mappings:

• Read VFS Location: How the file on the CDN can be read by Dalet Flex file-based jobs. This may differ from the write protocol. For example the read protocol could be HTTPS.
• Write VFS Location: How the file on the CDN can be written by Dalet Flex file-based jobs. This may differ from the read protocol. For example the write protocol could be FTPS.

 

CDN Storage Properties

Field	Value	Explanation
Icon		Plugin icon
Sub-type	Storage	Sub-type of this plugin
Classification	Internal	Classification of this plugin
Deployment		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		What Dalet Flex objects can be referenced from within the scripting context
Undo action		The action required to undo this action
Redo action		The action required to redo this action
Compatibility	5.x	What versions of Dalet Flex this plugin works for
Lifecycle	Stable	Maturity of this plugin (Experimental, Unstable or Stable)

 

CDN Storage Configuration

Field	Field Type	Mandatory	Multiplicity	Description
Read VFS Location	complex		0..1	Details for a Virtual File System location
Protocol	single-option			Protocol for accessing the location
Hostname	string			Hostname for accessing the location (mandatory except for file, s3)
Port	integer			Port for accessing the location (mandatory except for file, s3) (#)
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			Physical storage location
Password	password			Password for authentication (not required for file, s3)
Key	string			Key for authentication (only applicable to s3)
Secret	string			Secret for authentication (only applicable to s3)
Token	string			Token for authentication
Bucket	string			Only applicable to S3 protocol
Private Key File	file			Only applicable for SFTP certificate authentication
Write VFS Location	complex		0..1	Details for a Virtual File System location
Protocol	single-option			Protocol for accessing the location
Hostname	string			Hostname for accessing the location (mandatory except for file, s3)
Port	integer			Port for accessing the location (mandatory except for file, s3) (#)
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			Physical storage location
Password	password			Password for authentication (not required for file, s3)
Key	string			Key for authentication (only applicable to s3)
Secret	string			Secret for authentication (only applicable to s3)
Token	string			Token for authentication
Bucket	string			Only applicable to S3 protocol
Private Key File	file			Only applicable for SFTP certificate authentication
File Details Check	complex		0..1	Perform regular checks of file existence, size and last modification time.
Checking Interval	file			Minimum interval between file details checking. (#)

 

VFS Storage

This plugin acts as a wholesale replacement for the older storage plugin, which is supported but will be deprecated in future releases. The purpose of the VFS resource is to:

• Provide access to different types of concrete file systems, managed by Dalet Flex, in a uniform way.
• Support file-based processes between different file systems at the job level while hiding the underlying complexity.
• Offer a larger degree of configuration and security options.
• Make managing and integrating diverse storage devices more simple and less erroneous.

The virtual file system (VFS) is an abstraction layer on top of a more concrete file system. Within Dalet Flex, the concrete file system can be made up of:

• object storage devices
• File storage devices
• Cloud storage devices

 

VFS Protocols

The following Protocols exist for the VFS storage resource:

• SMB
• SFTP
• FTPS
• FTP
• WEBDAV
• HTTP
• HTTPS
• FILE
• S3

 

VFS Storage Properties

Field	Value	Explanation
Icon		Plugin icon
Sub-type	Storage	Sub-type of this plugin
Classification	Capacity	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		What Dalet Flex objects can be referenced from within the scripting context
Undo action		The action required to undo this action
Redo action		The action required to redo this action
Compatibility	5.x	What versions of Dalet Flex this plugin works for
Lifecycle	Stable	Maturity of this plugin (Experimental, Unstable or Stable)

 

VFS Storage Configuration

Field	Field Type	Mandatory	Multiplicity	Description
VFS Location	complex		0..1	Details for a Virtual File System location
Protocol	single-option			Protocol for accessing the location
Hostname	string			Hostname for accessing the location (mandatory except for file, s3)
Port	integer			Port for accessing the location (mandatory except for file, s3) (#)
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			Physical storage location
Password	password			Password for authentication (not required for file, s3)
Key	string			Key for authentication (only applicable to s3)
Secret	string			Secret for authentication (only applicable to s3)
Token	string			Token for authentication
Bucket	string			Only applicable to S3 protocol
Private Key File	file			Only applicable for SFTP certificate authentication
File Details Check	complex			Perform regular checks of file existence, size and last modification time.
Checking Interval	file		0..1	Minimum interval between file details checking. (#)

 

Process

Extract

The extract resource is used for extracting technical metadata and keyframes from media files. It is used by extract plugins.

Extract jobs will not run unless an extract resource is available.

 

Extract Properties

Field	Value	Explanation
Icon		Plugin icon
Sub-type	Extract	Sub-type of this plugin
Classification	Process	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		What Dalet Flex objects can be referenced from within the scripting context
Undo action		The action required to undo this action
Redo action		The action required to redo this action
Compatibility	5.x	What versions of Dalet Flex this plugin works for
Lifecycle	Stable	Maturity of this plugin (Experimental, Unstable or Stable)

 

Inject

The inject resource is used for injecting metadata into media files. It is used by inject plugins.

Inject jobs will not run unless an inject resource is available.

 

Inject Properties

Field	Value	Explanation
Icon		plugin icon
Sub-type	Inject	Sub-type of this plugin
Classification	Process	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		What Dalet Flex objects can be referenced from within the scripting context
Undo action		The action required to undo this action
Redo action		The action required to redo this action
Compatibility	5.x	What versions of Dalet Flex this plugin works for
Lifecycle	Stable	Maturity of this plugin (Experimental, Unstable or Stable)

 

VFS QC Resource

This resource provides access to networked QC resources. Configuration options are governed by the specific vendor solution being used. The QC Engine specifies which vendor solution should be used.

This resource relies on the QC Resource Adapter. Please consult this Adapter for information on which QC vendor solutions are supported.

 

VFS QC Resource Properties

Field	Value	Explanation
Icon		Plugin icon
Sub-type	QC	Sub-type of this plugin
Classification	Process	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		What Dalet Flex objects can be referenced from within the scripting context
Undo action		The action required to undo this action
Redo action		The action required to redo this action
Compatibility	5.x	What versions of Dalet Flex this plugin works for
Lifecycle	Stable	Maturity of this plugin (Experimental, Unstable or Stable)

 

VFS QC Resource Configuration

Field	Field Type	Mandatory	Multiplicity	Description
QC Properties	complex		0..1	Specify QC to use
QC Engine	single option			Specify QC to use
AmberFinICR Properties	complex		0..1
QC WSDL location	string			QC WSDL location
FlipFactory Properties	complex		0..1
QC Hosts names	integer			Comma delimited flip factory hosts in array
QC Host user	string			Username valid on all qc nodes in hosts array
QC Host Password	string			Password valid on all qc nodes in hosts array
QC Content Store	string			A temporary transcoding store existing on all array hosts
QC Management Host	integer			Host that manages flipfactories (in array)
QC Management Port	integer			QC manager listening port
QC Management user	string			Valid Qc Manager user
QC Management Password	string			Qc Manager user Password
QC Host Submit Strategy Classname	string			Classname for submit strategy for hosts in array
Baton Properties	complex		0..1
QC Hosts names	integer			Comma delimited flip factory hosts in array
QC Host user	string			username valid on all qc nodes in hosts array
QC Host Password	string			Password valid on all qc nodes in hosts array
Vidchecker Properties	complex		0..1
Vidchecker QC WSDL location	string			Vidchecker QC WSDL location
Media Folder Mapping	complex		0..1	Base paths for the location of media files
Dalet Flex Media Base VFS Location	complex		0..1	Details for a base VFS Location
Protocol	single option			Protocol for accessing the location
Hostname	string			Hostname for accessing the location (mandatory except for file, s3)
Port	string			Port for accessing the location (mandatory except for file, s3) (#)
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)
Key	string			Key for authentication (only applicable to s3)
Secret	string			Secret for authentication (only applicable to s3)
Token	string			Token for authentication
Bucket	string			Only applicable to S3 protocol
Private Key File	choose file			Only applicable for SFTP certificate authentication
QC Media Base VFS Location	complex		0..1	Details for a transcoder base vfs Location
Protocol	single option			Protocol for accessing the location
Hostname	string			Hostname for accessing the location (mandatory except for file, s3)
Port	string			Port for accessing the location (mandatory except for file, s3) (#)
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)
Key	string			Key for authentication (only applicable to s3)
Secret	string			Secret for authentication (only applicable to s3)
Token	string			Token for authentication
Bucket	string			Only applicable to S3 protocol
Private Key File	choose file			Only applicable for SFTP certificate authentication

 

Azure Transcode Resource

This resource gives you access cloud based encoding features of the Standard Media Encoder within Azure Media Services, as another transcoding resource for Dalet Flex users.

 

Azure Transcode Resource Properties

Icon		Plugin icon
Sub-type	Transcode	Sub-type of this plugin
Classification	Process	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		What Dalet Flex objects can be referenced from within the scripting context
Undo action		The action required to undo this action
Redo action		The action required to redo this action
Compatibility	6	What versions of Dalet Flex this plugin works for
Lifecycle	Stable	Maturity of this plugin (Experimental, Unstable or Stable)

 

Azure Transcode Resource Configuration

Field	Field Type	Mandatory	Multiplicity	Description
Transcoder Properties	complex			The properties for the Azure transcode
Transcode Engine	string			The transcode engine to use for this resource
Azure Tenant Domain	string			The Azure AD tenant domain where the Azure AD application resides
Azure Media Service Rest Endpoint	string			The REST API endpoint of the Azure Media Services account
Azure AD Client ID	string			The client ID of the Azure AD application
Azure AD Client Key	string			The client key of the Azure AD application

 

VFS Transcode

This resource provides access to networked Transcode resources. Configuration options are governed by the specific vendor solution being used. The Transcode Engine specifies which vendor solution should be used.

This resource relies on the Transcode resource Adapter. Please consult this Adapter for information on which Transcode vendor solutions are supported.

 

VFS Transcode Properties

Field	Value	Explanation
Icon		Plugin icon
Sub-type	Transcode	Sub-type of this plugin
Classification	Process	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		What Dalet Flex objects can be referenced from within the scripting context
Undo action		The action required to undo this action
Redo action		The action required to redo this action
Compatibility	5.x	What versions of Dalet Flex this plugin works for
Lifecycle	Stable	Maturity of this plugin (Experimental, Unstable or Stable)

 

VFS Transcode Configuration

Field	Field Type	Mandatory	Multiplicity	Description
Transcoder Properties	complex		1
Transcode Engine	single option			The transcode engine to use for this resource
Transcoder Hosts names	integer			Comma delimited hosts in array
Transcoder Host user	string			Username valid on all transcoder nodes in hosts array
Transcoder Host Password	string			Password valid on all transcoder nodes in hosts array
Transcoder Content Store	string			A temporary transcoding store existing on all array hosts
Transcoder Management Host	integer			Host that manages transcoders (in array)
Transcoder Management Port	integer			Transcoder manager listening port
Transcoder Management user	string			Valid Transcode Manager user
Transcoder Management Password	password			Transcode Manager user Password
Transcoder Host Submit Strategy Class name	string			Class name for submit strategy for hosts in array
Transcoder Platform	single option			To determine how the path should be translated
Folder Mapping	complex			Base VFS locations for the location of files
Dalet Flex Base VFS Location			1..*	Details for a base VFS Location
Protocol	single option			Protocol for accessing the location
Hostname	string			Hostname for accessing the location (mandatory except for file, s3)
Port	string			Port for accessing the location (mandatory except for file, s3) (#)
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)
Key	string			Key for authentication (only applicable to s3)
Secret	string			Secret for authentication (only applicable to s3)
Token	string			Token for authentication
Bucket	string			Only applicable to S3 protocol
Private Key File	choose file			Only applicable for SFTP certificate authentication
Transcoder Base VFS Location	complex			Details for a transcoder base VFS Location
Protocol	single option			Protocol for accessing the location
Hostname	string			Hostname for accessing the location (mandatory except for file, s3)
Port	string			Port for accessing the location (mandatory except for file, s3) (#)
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)
Key	string			Key for authentication (only applicable to s3)
Secret	string			Secret for authentication (only applicable to s3)
Token	string			Token for authentication
Bucket	string			Only applicable to S3 protocol
Private Key File	choose file			Only applicable for SFTP certificate authentication

 

I/O

Dalet Flex FTP Transfer

This plugin is used for managing a Dalet Flex Transfer Server resource. This resource can be configured to listen on multiple ports (FTP Services) as well as to support plain FTP or UDP-accelerated FTP. Some of the more important configuration options are discussed below.

 

Callback End Point

This field is used to instruct the Dalet Flex Transfer Server what URL to use when communicating with Dalet Flex's Manager nodes.

 

FTP Service

This option allows for the configuration or one or more FTP Services. Each service listens for connections on its own port range.

 

Accelerated

This option allows for choosing between plain TCP or accelerated UDP. Accelerated UDP allows the Transfer Agent to transfer files more rapidly than with plain FTP.

A service set up with acceleration enabled will not work for normal FTP software.

 

Secure Transfer

These options allow for specification of SSL details to secure transfer.

Stopping this resource type will disconnect all remote connections.

 

Dalet Flex FTP Transfer Properties

Field	Value	Explanation
Icon		Plugin icon
Sub-type	Transfer	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		What Dalet Flex objects can be referenced from within the scripting context
Undo action		The action required to undo this action
Redo action		The action required to redo this action
Compatibility	5.x	What versions of Dalet Flex this plugin works for
Lifecycle	Stable	Maturity of this plugin (Experimental, Unstable or Stable)

 

Dalet Flex FTP Transfer Configuration

Field	Field Type	Mandatory	Multiplicity	Description
Callback End Point	string			End point URL of the master for the Transfer Service to perform callbacks
FTP Service	complex		1..*	Details of FTP Transfer service
Service End Point	string			End point of Transfer Service node web service
FTP Server	complex		1..*	Details of FTP Transfer service
Public Host	string			External hostname of IP for external client connection
Public Port	string			External port for external client connection
Incoming Port	string			Port for connecting
External Passive Host	string			Advertised passive host name for client/proxy connection
Passive Port Range	string			Ports for passive connections (can be comma separated and/or a range indicated with a - character)
Accelerated	boolean			Normal or accelerated transfers
Secure Transfer	complex		0..1	Security details to enable secure (SSL) transfers
Keystore File	file			Secure transfer (SSL) keystore file (file should end in .jks)
Keystore Password	password			Password for secure transfer (SSL) keystore file
Key Alias	string			Alias of keystore entry to be used for secure transfer (SSL)

 

HTTP Transfer

This plugin is used for managing an HTTP-based Dalet Flex Transfer Server resource. This resource can be configured to listen on multiple ports (HTTP Service) and HTTP-based file transfer.

This resource supports large file transfer and advanced features such as pause and resume. It also support file chunking within the Dalet Flex Transfer Server.

It is recommended that you use secure transfer with HTTPS.

 

HTTP Transfer Properties

Field	Value	Explanation
Icon		Plugin icon
Sub-type	Transfer	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		What Dalet Flex objects can be referenced from within the scripting context
Undo action		The action required to undo this action
Redo action		The action required to redo this action
Compatibility	5.x	What versions of Dalet Flex this plugin works for
Lifecycle	Stable	Maturity of this plugin (Experimental, Unstable or Stable)

 

HTTP Transfer Configuration

Field	Field Type	Mandatory	Multiplicity	Description
Public End Point	string			Public end point to access the HTTP Transfer Service user interface. Use %Account expression placeholder for templating e.g. `http://%Account.hostname.com/a/%Account` or `http://%Account.hostname.com`
Management End Point	string			Management end point URL of the HTTP Transfer Service management API
Callback Endpoint	string			End point URL for the HTTP Transfer Service to access the callback API

 

Aspera Transfer

Aspera Transfer Properties

Field	Value	Explanation
Icon		Plugin icon
Sub-type	Transfer	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		What Dalet Flex objects can be referenced from within the scripting context
Undo action		The action required to undo this action
Redo action		The action required to redo this action
Compatibility	5.x	What versions of Dalet Flex this plugin works for
Lifecycle	Stable	Maturity of this plugin (Experimental, Unstable or Stable)

 

Aspera Transfer Configuration

Field	Field Type	Mandatory	Multiplicity	Description
Aspera Console IP/Host name	string			Aspera Console IP/Host name (with protocol)
Basic Authentication	complex		0..1
Username	string			Username to use for Basic Authentication.
Password	password			Password to use for Basic Authentication.

 

Outbound Transfer Resource

Outbound Transfer Service is a Flex External resource Framework Service responsible for handling transfers between Dalet Flex and a target External VFS location. This resource is used in conjunction with the External Copy action, which supports the copying of a file from a source VFS location (Dalet Flex) to a target VFS location (External Systems).

 

Outbound Transfer Resource Properties

Field	Value	Explanation
Icon		Plugin icon
Sub-type	Workflow	Sub-type of this plugin
Classification		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		What Dalet Flex objects can be referenced from within the scripting context
Undo action		The action required to undo this action
Redo action		The action required to redo this action
Compatibility	5.3.0	What versions of Dalet Flex this plugin works for
Lifecycle	Stable	Maturity of this plugin (Experimental, Unstable or Stable)

 

Outbound Transfer Resource Configuration

Field	Field Type	Mandatory	Multiplicity	Description
Integration Service	complex		0..1	Outbound Transfer Integration service details
Hostname	string			Hostname for accessing the location
Port	string			Port for accessing the location (#)
username	string			Username for authentication
Password	string			Password for authentication
Site name	string			Username for authentication
Response Timeout	string			Response timeout
userinfo	string			User Information
Folder Mapping	complex		0..*	Base vfs locations for the location of files
Mio Base VFS Location	complex			Details for a base vfs Location
Protocol	single option			Protocol for accessing the location
Hostname	string			Hostname for accessing the location (mandatory except for file, s3)
Port	string			Port for accessing the location (mandatory except for file, s3) (#)
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)
Key	string			Key for authentication (only applicable to s3)
Secret	string			Secret for authentication (only applicable to s3)
Token	string			Token for authentication
Bucket	string			Only applicable to S3 protocol
Private Key File	file			Only applicable for SFTP certificate authentication
Target Base VFS Location	complex			Details for a outbound transfer base vfs Location
Protocol	single option			Protocol for accessing the location
Hostname	string			Hostname for accessing the location (mandatory except for file, s3)
Port	string			Port for accessing the location (mandatory except for file, s3) (#)
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)
Key	string			Key for authentication (only applicable to s3)
Secret	string			Secret for authentication (only applicable to s3)
Token	string			Token for authentication
Bucket	string			Only applicable to S3 protocol
Private Key File	string			Only applicable for SFTP certificate authentication

 

Workflow

Vantage Resource Workflow

This version of the Vantage resource Workflow supports Vantage 7.0.

 

Vantage Resource Workflow Properties

Field	Value	Explanation
Icon		Plugin icon
Sub-type	Workflow	Sub-type of this plugin
Classification		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		What Dalet Flex objects can be referenced from within the scripting context
Undo action		The action required to undo this action
Redo action		The action required to redo this action
Compatibility	5.x	What versions of Dalet Flex this plugin works for
Lifecycle	Stable	Maturity of this plugin (Experimental, Unstable or Stable)

 

Vantage Resource Workflow Configuration

Field	Field Type	Mandatory	Multiplicity	Description
Host name/IP	string			The Host name or the IP Address of the Vantage SDK Server
Host Port	integer			The port number of the Vantage SDK Server. Port: 8676
Folder Mapping	complex		1..*	Base vfs locations for the location of files
Dalet Flex Base VFS Location	complex			VFS Location of folder visible to Dalet Flex
Protocol	single option			Protocol for accessing the location
Hostname	string			Hostname for accessing the location (mandatory except for file, s3)
Port	string			Port for accessing the location (mandatory except for file, s3) (#)
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)
Key	string			Key for authentication (only applicable to s3)
Secret	string			Secret for authentication (only applicable to s3)
Token	string			Token for authentication
Bucket	string			Only applicable to S3 protocol
Private Key File	choose file
Vantage Base VFS Location	complex			VFS Location of folder visible to Vantage
Protocol	single option			Protocol for accessing the location
Hostname	string			Hostname for accessing the location (mandatory except for file, s3)
Port	string			Port for accessing the location (mandatory except for file, s3) (#)
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)
Key	string			Key for authentication (only applicable to s3)
Secret	string			Secret for authentication (only applicable to s3)
Token	string			Token for authentication
Bucket	string			Only applicable to S3 protocol
Private Key File	choose file			Only applicable for SFTP certificate authentication

 

AmberFin (JEF)

 

Baton QC (JEF)

 

Aspera Transfer

 

Flex File Processor (FFP)

 

Media Cortex