Introduction
FlexXTEND Adobe Panel is a microservice application designed to provide HTML pages into Adobe Premiere Pro. It allows end user to import/Export assets from the Dalet Flex environment.
This is a step-by-step guide for installing and configuring Dalet FlexXTEND.
Versions
- Adobe Premiere Pro 15.4.1 and above
- Adobe Media Encoder (below called AME) is optional and must match the Premiere version.
Prerequisites
In order to run FlexXTEND Adobe Panel, you will need the following:
- Supported Adobe Premiere Pro CC and Adobe Media Encoder (local or remote)
- A preset created in Adobe Media Encoder
- The FlexXTEND Adobe Panel ZXP file
AME Rendering (Adobe Media Encoder) Prerequisites:
Adobe Media Encoder is installed alongside Adobe Premiere and is the local render engine, or installed independently as a remote encoding machine.
- AME version 2021 and above
- Premiere Pro version and AME version must match (e.g. if the AME version is 2022 then Premiere Pro version must be 2022)
- The configured "ameNodeServicePort" must be accessible to the client (Premiere Pro) machine
- A public certificate must be used from end to end. The solution does not support private PKI.
FlexXTEND Extension Installation
On all the Adobe Premiere machines, install the provided Xtend Panel ZXP extension for Adobe.
Only on a Remote Rendering AME machine, install the provided AME panel ZXP extension for Adobe.
Request the ZXPs from your Dalet representative.
For the Internal Versions and Location of ZXP files, see FlexXTEND ZXP Versions and Locations
ZXPs are installed using the Adobe Unified Pluging Installer AUPI: https://helpx.adobe.com/creative-cloud/help/working-from-the-command-line.html
The AUPI is automatically available via the Creative Cloud app.
Install using command line:
Windows:
C:\<AUPI directory>\UnifiedPluginInstallerAgent.exe /install c:\myfodler\flex-xtendadobepanel-extension-1.2.10.zxp
macOS:
./UnifiedPluginInstallerAgent --install /myfolder/mysubfolder/flex-xtendadobepanel-extension-1.2.10.zxp
EPR files (optional)
An *.EPR file contains system presets for Adobe Media Encoder. Some hi-res formats require the one-time generation of an *.EPR file to ensure correct encoding of that format.
EPR files are created in Adobe Media Encoder, using the Preset Browser. Created presets can be exported to external EPR files for future import. For more information on the Preset Browser operations, see Adobe Documentation.
The location of the Flex related EPR files is configured in the Sequence - Render and Export section below. Copy any newly created and exported EPR files to this location.
Flex Side Configuration
Setting up the panel in Adobe Premiere Pro includes the following fields which can be configured in the associated Dalet Flex account:
- Metadata Definition ID
- Premiere Project Workflow Definition ID
- Raw Asset Workflow Definition ID
- Rendered Asset Workflow Definition ID
- Import Action ID
- Variants
- Workspace ID (Optional)
Login and Panel Setup
Once you have successfully installed the FlexXTEND Adobe Panel you can follow the steps below to set up the panel.
To open the panel, launch Adobe Premiere Pro and create a new project or load an existing one.
Go to Window > Extensions > FlexXTEND.
The FlexXTEND panel will pop up.
Panel Configuration
The panel will prompt you to select or create a new environment.
Click the Plus (+) icon to create a new environment or select an existing environment from the dropdown list.
When creating a new environment, fill in the following fields:
Environment name: give your environment a name.
Panel Service URL: this is the URL for the server-side component of the panel. The FlexXTEND panel communicates with this service in the backend. This service needs to be installed inside the Flex environment.
Click Load.
FlexXTEND Settings
On first connection to an environment, fill in and configure the following fields in the FlexXTEND Settings. These can be changed at any time by clicking on the Settings icon in the User Profile. See FlexXTEND User Guide for more information.
General
Enter the general settings, as detailed below.
| Parameter | Description |
| Environment name: | The environment name as entered above. |
| FlexXTEND Service URL: | The panel service URL as entered above; this is the URL to the Flex environment the panel works with (it uses this to make API calls to Flex). |
| Preview Auto-Play: | Start playing automatically when preview is triggered (double click on an asset). |
| Proxy Mode: | If existing, import either the hi-res asset or the proxy format. |
| Media Files - Shared Storage Path: | This is where the Flex Panel will look for assets (media/image/text) to import into Premiere. The panel assumes that Flex and Premiere have access to these shared storage locations. |
| Media Files – Local Storage Path: | This is where the Flex Panel will look for media assets on your local computer to import into Premiere. The panel assumes that Flex and Premiere have access to this shared storage location. |
| Workspace ID: OPTIONAL | This is the ID of the Flex workspace you are working in. If this field is left blank, all workflows will be triggered on the default workspace in Flex. If you enter a specific Workspace ID, then all workflows will be triggered in that workspace in Flex. |
Sequence – Render and Export
Enter the rendering and export settings, for rendering a new sequence and importing to Flex.
| Parameter | Description |
| Export Selection - Entire sequence: | The default setting and will export the entire sequence. |
| Export Selection - Sequence In/Out: | This will export the section of your sequence marked with In/Out. |
| Export Selection - Work Area: | This will export section of the sequence in your Premiere Pro Work Area. |
| Export Preset (EPR) Path: | The Adobe Media Encoder preset which Premiere uses to render a sequence. This preset needs to be created in Adobe Media Encoder once before using it. |
| Export Storage Path: | The location to which your rendered sequences will be exported on your local computer. |
| Variant Name: | The name of the asset type variant which will be associated to this media. Usually preconfigured in the Flex system. |
| Metadata Definition ID: | This tells the Flex Panel which metadata definition to show in the Export screen of the Panel. The metadata entered will be sent into the Rendered Asset workflow. |
| Workflow Definition ID: | The workflow that the Flex Panel launches you render your sequence, creating a new asset (using Adobe Media Encoder). This workflow runs when you select Export > Export in the FlexXTEND panel. If no workflow ID is entered here, then no workflow will be triggered, and your project will be saved locally. |
| Enable Remote Media Encoding: | When enabled, render jobs are sent to a remote AME, assigning the actual render to a dedicated AME server. |
| Remote Media Encoding - Label: | Add a label to the remote AME instance. |
| Remote Media Encoding - URL: | Http://<AME_SERVER>:\<PORT> by default, the port is 8007. See AME configuration below. |
| Upload rendered sequence to S3: | You can select whether to upload your rendered sequence to S3. Checking the box will prompt you to fill in your S3 Bucket credentials. |
json
[
{
"AllowedHeaders":[
"*"
],
"AllowedMethods":[
"HEAD",
"GET",
"PUT",
"POST",
"DELETE"
],
"AllowedOrigins":[
"*"
],
"ExposeHeaders":[
"ETag"
]
}
]
Media Check-In
This section handles the upload of local media used in a project, to the Flex system. The media will then be available via Flex for continued editing or future projects.
| Parameter | Description |
| Variant Name: | The name of the asset type variant which will be associated to this media. Usually preconfigured in the Flex system. |
| Metadata Definition ID: | The metadata definition ID for this asset, as configured in Flex. |
| Import Action ID: | Enter the import action ID, for local media upload, as configured in the Flex Core. Note that this must be the dedicated action for Xtend local media import. See Import Actions Mandatory Configuration below |
| Workflow Definition ID: | The workflow that the Flex Panel launches after importing the local media. |
| Save Project File to: | Choose between an S3 bucket or a shared UNC or local drive location. Enter the required details. |
Project Check-In
This section handles the import of an Adobe Project to the Flex system. The Adobe project file (*.PRPROJ) will then become an asset in the Flex system for future use and further editing. Note that any local media used in a project must be uploaded to Flex so it will be available on different workstations.
| Parameter | Description |
| Variant Name: | The variant name for this type of media asset, which will be associated to this asset in Flex. |
| Metadata Definition ID: | The metadata definition ID for this asset, as configured in Flex. |
| Import Action ID: | Enter the import action ID for the *. PRPROJ file, as configured in the Flex Core. Note that this must be the dedicated action for Xtend Adobe Project import. See Import Actions Mandatory Configuration below |
| Workflow Definition ID: | The workflow that the Flex Panel launches after importing the project file (*. PRPROJ). |
| Save Project File to: | Choose between an S3 bucket or a shared UNC or local drive location. Enter the required details. |
| Create Flex Edits: | Export the sequences with the project (as Flex Edit assets). |
| Variant Name: | The variant name for this type of Edit asset, which will be associated to this Project asset in Flex. |
| Import Action ID: | If Flex Edits creation is enabled, enter the import action ID for the sequence import, as configured in the Flex Core. Note that this must be the dedicated action for Xtend sequence import. |
| Export Sequence To: | Choose between an S3 bucket or a shared UNC or local drive location. Enter the required details. |
Import Actions Mandatory Configuration
To enable the import of media and adobe projects to proper, the proper Import Actions must be created on the Flex admin side.
Media Check-In Import Action
For local media check in, configure the import action in Flex Core, under Settings > Actions.
Note the Import Action ID under Details, as it is needed for the FlexXTEND panel configuration.
Under Configuration, set the exact expressions as described in the table below.
| Field | Value |
| Source Resource | <code>#{job.variables.variableHashMap['resource'].id}</code> |
| Item Name | <code>#{job.variables.variableHashMap['resourceItemName']}</code> |
| Variant | <code>#{job.variables.variableHashMap['variant']} (*If variant is configured in panel*) </code> |
Adobe Project Import Action
For local media check in, configure the import action in Flex Core, under Settings > Actions.
Note the Import Action ID under Details, as it is needed for the FlexXTEND panel configuration.
Under Configuration, set the exact expressions as described in the table below.
| Field | Value |
| Source Resource | <code>#{job.variables.variableHashMap['resource'].id}</code> |
| File Name | <code>#{job.variables.variableHashMap['resourceItemName']}</code> |
| Import Referenced Sources | No |
| Reconciliate Referenced Sources | No |
| Create Placeholders | No |
Flex Edits Import Action
In order to import the Adobe Sequences with the Project, as Flex Edit assets, configure the import action in Flex Core, under Settings > Actions.
Note the Import Action ID under Details, as it is needed for the FlexXTEND panel configuration.
Under Configuration, it is highly recommended (though not strictly mandatory) to set the exact expressions as described below.
| Field | Value |
| Source Resource | <code>#{job.variables.variableHashMap['resource'].id}</code> |
| File Name | <code>#{job.variables.variableHashMap['resourceItemName']}</code> |
| Title | #{job.variables.variableHashMap['resourceItemName']} |
| Parent Project | #{job.variables.variableHashMap['parentProject'].id} |
| Import Referenced Sources | Yes |
| Reconciliate Referenced Sources | Yes |
| Create Placeholders | Yes |
AME Remote Rendering
Remote encoding, or remote rendering, allows Adobe Premiere users to send the render jobs to a central rendering server, and not launching a local Adobe Media Encoder instance and render locally.
When configured, rendering jobs by FlexXTEND users are directed to the central AME server for rendering.
The AME will output the rendered asset into the "exportPath" location configured in the AME JSON, and then it will optionally also upload to the S3 location specified in the Premiere user's configuration. The premiere user does not have to specify an S3 bucket for upload.
Versions and Notes
- The Adobe Media Encoder must match the Premiere version.
- Remote AME is currently supported for Windows only.
Installation and Configuration
Install the Xtend to AME extension in the same way it is installed on Premiere machines above. See Adobe Documentation for more information.
Once installed, the Xtend to AME configuration is done in a JSON file. There is no graphic user interface for configuration, as there is for the FlexXTEND extension.
After the installation, the JSON file is located under C:\Users\\\<USER>\Documents\AdobeFiles\
Edit the file and add the following parameters:
- Flex environment URL, followed by /flexxtendamepanel
- AME port, this port is needed in the Xtend Premiere configuration, by default: 8007
- Shared storage path, accessible by the Flex system
- Export path, the path for exported files and optionally upload to the S3 location specified in the Premiere user's configuration
- Download path, the path for downloaded files
Example:
{
"amePanelUrl": "https://documentation.flex.dalet.com/flexxtendamepanel/",
"ameNodeServicePort": 8007,
"sharedStoragePaths": ["\\AME_Storage\amepanel\AMELocal"],
"exportPath": "\\AME_Storage\amepanel\AME Export",
"downloadPath": "\\AME_Storage\amepanel\AMEDownload"
}
Comments
0 comments
Please sign in to leave a comment.