Importing Projects from Flix 5 to Flix 6

This page explains how to import projects from Flix 5 to Flix 6 using the Flix Migration Tool.

Requirements

The Migration Tool requires Python 3.7. Installing the dependencies using pip is recommended. You can follow the instructions found here: https://pip.pypa.io/en/stable/installing/

You can use the provided requirements.txt file for pip to install all the dependencies automatically, by running the following command:

python3 -m pip install -r requirements.txt

Flix Server Version Compatibility

With every release of Flix comes a version of the Migration Tool, which may be incompatible with earlier Flix versions.

The table below lists which release of Flix each Migration Tool version is compatible with.

Flix Server Version Migration Tool Version
6.1.0 36
6.1.1 37
6.1.2 40
6.2.0 44

Usage

The migrate5to6.py file is the script that allows you to list or migrate your Flix 5 projects into Flix 6.

Required Arguments

--server SERVER - Flix 6 server url. For example 'http://flix001.mystudio.com:8080'

--user USER - Flix 6 client username. For example 'admin'.

--password PASSWORD - Flix 6 client password. For example 'admin'.

--flix-projects FLIX_PROJECTS - Path to your Flix 5 projects directory. For example '/mnt/flix/flixProjects'.

--list - List what the Migration Tool found from your Flix 5 project(s), without importing into Flix 6.

--migrate - Import what the Migration Tool found from your Flix 5 project(s) into Flix 6.

Optional Arguments

--help

--shows [SHOWS [SHOWS ...]] - Shows to list/migrate. By default, the Migration Tool will go through all the shows it finds in your Flix 5 projects directory.

--episodes [EPISODES [EPISODES ...]] - Episodes to list/migrate. By default, the Migration Tool will go through all the episodes in the current show.

--sequences [SEQUENCES [SEQUENCES ...]] - Sequences to list/migrate. By default, the Migration Tool will go through all the sequences in the current show or episode.

--revisions n - Only list/migrate the n most recent sequence revisions.

--all-revisions - Use this flag to list/migrate all the sequence revisions from the current sequence. By default, the Migration Tool will only import the most recent one.

--port PORT - Download helper port.

Examples

python3 migrate5to6.py --server http://flix001.myStudio.com:8080 --user admin --password admin --flix-projects /mnt/flix/flixProjects --shows my_show --list

This command lists all the information from the show 'my_show'.

python3 migrate5to6.py --server http://flix001.myStudio.com:8080 --user admin --password admin --flix-projects /mnt/flix/flixProjects --shows my_show --sequences my_sequence --migrate

This command will migrate the last sequence revision from the sequence my_sequence from the show my_show.

python3 migrate5to6.py --server http://flix001.myStudio.com:8080 --user admin --password admin --flix-projects /mnt/flix/flixProjects --all-revisions --migrate

This command will migrate everything from your Flix 5 projects directory.

Reconform from Avid using Flix 5 assets

--flix5_compatible_imports - For cases where Flix 5 sequences sent to Avid have not been sent back to Flix prior to a Flix 5 to Flix 6 migration. After having run a migration, it is possible for Flix 6 to recognize Flix 5 assets coming from Avid and relink them to the ones now available in Flix 6. To enable this behavior, you will need to set the 'flix5_compatible_imports' option to 'true' in your server's config.yml file.

Note:  When enabled, this may cause slowdowns while importing AAFs from Avid. We recommend disabling it once you have successfully migrated, reconformed all of your sequences in Flix 6 and there are no more Flix 5 assets left in your Avid project.