Start Session :: Dalet Flex Documentation

Properties

Field	Value	Explanation
Icon		Plugin icon
Sub-type	Start Session	Sub-type of this plugin
Classification	Reviewer	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	asset	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	Stop Video Session	The action required to undo this action
Redo Action		The action required to redo this action
Compatibility	5.5	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
Session name	string		Session name
Initiator	resource		The Dalet Flex user who is initiating the review session.
Make Review Exclusive?	checkbox		Mark the session as Exclusive. An exclusive review is when a specific asset can be sent to one or many recipients for review. When one user takes the review session, only that user can review the asset, unless they are released from the session. This field enables you to specify whether a review session will be exclusive or not. If the checkbox is selected, the review will be exclusive.
Per-Essence Configuration	complex		Specify whether the Review Session will be Essence enabled.
Set as Per-Essence Review?	checkbox		Mark the session as per-Essence Review.
Essence	complex	0..*	Essence to be used for a per-essence review.
Type	single option		Essence type. You can choose Audio or Caption.
Name	string		Essence asset name (caption display name or audio track name)
Read only?	checkbox	Mark this essence as read only
Reviewers	complex		Details of the initiating user.
Reviewer User	resource	1..*	A Dalet Flex user who is a reviewer in the session.
Reviewer Group	resource	1..*	A Dalet Flex group whose members are considered as Reviewers in the session.
Reviewer User List Expression	string	0..1	Reviewer list (semi-colon delimited list of user IDs). Users in this list will be added to any reviewers configured in the options above.
Reviewer Group List Expression	string	0..1	Reviewer list (semi-colon delimited list of group IDs). Members of groups in this list will be added to any Reviewers configured in the options above.
View only reviewers section	complex	0..1	Specify whether reviewers are allowed to download the asset or not. (Warning: If the download allowed is set to true then reviewers would be able to download and keep an unprotected copy of the review video. The downloaded video will not expire.)
View Only Reviewers	complex		Email Details of user
View Only Reviewer Email	string	0..*	These reviwers can only watch video in review portal, these reviewers need not be mio users, the system will send an open authentication token to users who can only view video and nothing else
View Only Reviewer Email Expression	string	0..1	An expression which evaluates to semicolon separated Email’s.
Message Template For External Reviewers	single option		A Message template to use for notifying the users about the review session
Unauthenticated Template URL	string		This mentioned URL will be authenticated and sent to User, Note: You can use place holders such as {assetId} {reviewId} to auto fill assetId and reviewId respectively.
Review Expiry Date	string		Set review expiry date (dd-MM-yyyy HH:mm:ss)
Review Session Fields	complex	1..*	Specify field data for the review session
Instruction	text		Here you can specify any instructions for the review session.
Instructions Config	complex		Specify whether comment should be saved as a Dalet Flex comment on asset
Record Instruction?	boolean	0..1	Record comment
Record Instruction Expression		0..1	An expression which evaluates to boolean that decides whether to record initial comment in Dalet Flex.
Asset Publish Action	resource
Message Template	resource		A message template to use for notifying the users about the review session
Portal URL	string		Portal Base URL to use for the session.
Custom Statuses	complex	1..*	You must set at least one status for the review.
Allow Multiple Custom status?	checkbox		Select this option to allow the reviewer to select more than one custom status simultaneously
Custom Status Name	string		Provide a name for each status.
Color for this Custom Status	Color picker		Select a colour for the status button. The colour selected is stored in HEX format uppercase, e.g. “EAEAEA”.
Metadata definition for Custom Status	single option	0..1	Select a metadata definition that the reviewer should fill, if the reviewer chooses this status.

Properties

Field	Value	Explanation
Icon		Plugin icon
Sub-type	Start Session	Sub-type of this plugin
Classification	Reviewer	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	asset	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	Stop Image Session	The action required to undo this action
Redo Action		The action required to redo this action
Compatibility	5.5	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
Session name	string		Session name
Initiator	resource		The Dalet Flex user who is initiating the review session.
Make Review Exclusive?	checkbox		Mark the session as Exclusive. An exclusive review is when a specific asset can be sent to one or many recipients for review. When one user takes the review session, only that user can review the asset, unless they are released from the session. This field enables you to specify whether a review session will be exclusive or not. If the checkbox is selected, the review will be exclusive.
Reviewers	complex		Details of the initiating user.
Reviewer User	resource	1..*	A Dalet Flex user who is a reviewer in the session.
Reviewer Group	resource	1..*	A Dalet Flex group whose members are considered as Reviewers in the session.
Reviewer User List Expression	string	0..1	Reviewer list (semi-colon delimited list of user IDs). Users in this list will be added to any reviewers configured in the options above.
Reviewer Group List Expression	string	0..1	Reviewer list (semi-colon delimited list of group IDs). Members of groups in this list will be added to any Reviewers configured in the options above.
View only reviewers section	complex	0..1	Specify whether reviewers are allowed to download the asset or not. (Warning: If the download allowed is set to true then reviewers would be able to download and keep an unprotected copy of the review video. The downloaded video will not expire.)
View Only Reviewers	complex		Email Details of user
View Only Reviewer Email	string	0..*	These reviewers can only watch video in review portal, these reviewers need not be mio users, the system will send an open authentication token to users who can only view video and nothing else
View Only Reviewer Email Expression	string	0..1 An expression which evaluates to semicolon separated Email’s.
Message Template For External Reviewers	single option		A Message template to use for notifying the users about the review session
Unauthenticated Template URL	string		This mentioned URL will be authenticated and sent to User. Note: You can use place holders such as {assetId} {reviewId} to auto fill assetId and reviewId respectively.
Review Expiry Date	string		Set review expiry date (dd-MM-yyyy HH:mm:ss)
Review Session Fields	complex	1..*	Specify field data for the review session
Instruction	text		Here you can specify any instructions for the review session.
Instructions Config	complex		Specify whether comment should be saved as a Dalet Flex comment on asset
Record Instruction?	boolean	0..1	Record comment
Record Instruction Expression		0..1	An expression which evaluates to boolean that decides whether to record instruction in Dalet Flex.
Message Template	resource		A message template to use for notifying the users about the review session
Portal URL	string		Portal Base URL to use for the session.
Custom Statuses	complex	1..*	You must set at least one status for the review.
Allow Multiple Custom status?	checkbox		Select this option to allow the reviewer to select more than one custom status simultaneously
Custom Status Name	string		Provide a name for each status.
Color for this Custom Status	Color picker		Select a colour for the status button. The colour selected is stored in HEX format uppercase, e.g. “EAEAEA”.
Metadata definition for Custom Status	single option	0..1	Select a metadata definition that the reviewer should fill, if the reviewer chooses this status.

Start Session

Start Video Review

Start Image Review