Project Archive
Archive frame.io projects to iconik.
Overview
This guide explains how to use the project archive integration between frame.io and iconik services to copy entire projects from frame.io to iconik. The process involves several critical steps that need to be followed in a specific order to successfully archive projects to iconik.
The archive transfers carries over the following frame.io taxonomy mapped to the equivalent in iconik.
- Folders
- Assets
- Annotations
- Comments
- Presentations
See Section A.1 System Mapping for further info on the taxonomy mapping between both systems.
frame.io User Experience
frame.io Login
Log in to your frame.io account at app.frame.io where your project is located.
Project Selection & Archive
Navgate to the project under the respective Team that you want to archive and click the vertical elipsis menu as per Image 2 - Native Archive Option Context Menu. Select Archive project to use the archive feature provided by frame.io to move the project's files to cold storage as highlighted in Image 3 - Native Archive Option
 |
|---|
| Image 1 - Native Archive Option Context Menu |
 |
| Image 2 - Native Archive Option |
Renaming the Project
After archiving the project on frame.io, rename the project to include the word "Archived" at the end. For example, if your project is named "Summer Campaign", change it to "Summer Campaign - Archived"
The naming convention must be precise. Adding "Archived" to the project name is crucial to trigger the project.updated webhook that initiates the archive task.
 |
|---|
| Image 3 - Project Rename 01 |
 |
| Image 4 - Project Rename 02 |
Triggering the Webhook; Renaming the project correctly after archiving it will automatically trigger the webhook responsible for starting the archive task.
Only one archive task can be processed at a time. If you attempt to trigger another task while one is ongoing, it will be skipped, and you will receive an email advising you to try again later.
iconik User Experience
iconik Login
Log in to your iconik account at app.iconik.io.
Project Collection
In iconik, go to the collection named “Archive from Frame.io Media”.
Inside this collection, find another collection with the same name as the Frame.io team that owns the project.
For example, if your frame.io team is named "Marketing Team", look for a collection named "Marketing Team".
Within this collection, find the collection corresponding to your archived project.This will contain all assets, versions, comments, annotations, presentations and metadata from the project in frame.io
 |
|---|
| Image 5 - iconik Archive Collection |
Manifest File
In iconik, go to the collection named "Archive from Frame.io Manifests". Inside this collection, find another collection with the same name as the frame.io team that owns the project. This collection contains the CSV manifest files. The manifest file's name consists of the task completion date and project name (e.g., “2023-10-01_Summer_Campaign.csv”).
 |
|---|
| Image 6 - iconik Manifest Collection |
This file includes records of all copied assets and indicates whether they have been successfully archived.
 |
|---|
| Image 7 - Manifest File |
The Project Archive integration has a file size limitation of 50 GB. As such it is you the user who has a responsibility to ensure all files from frame have been transferred before deleting any data in frame.io.
Notifications & Monitoring
Email Confirmation
Archive Started
You will receive an email informing you that the archive task has started. This email confirms that the integration is working correctly and the task is in progress.
 |
|---|
| Image 8 - Email Notification Archive Started |
REMINDER: Only one archive task can be processed at a time. If you attempt to trigger another task while one is ongoing, it will be skipped, and you will receive an email advising you to try again later.
Archive Completed
Once the archive task is complete, you will receive an email informing you that the project has been successfully archived.
 |
|---|
| Image 9 - Email Notification Archive completed |
Monitoring
The integration leverages the native iconik Jobs functionality to showcase progress of the current Active Job being processed.
As a separate data transfer service handles the fileset payload, the progress may appear to be stuck at 20% for some time before continuing to increment towards 100%. An email notification will be received should any issue occur with the archive progress.
Appendices
The following sections contain additional information tha the user may find helpful.
A.1 System Mapping
It is crucial to understand how the mapping between both systems work. This is highlighted in Image 1 - System Mapping.
 |
|---|
| Image 10 - System Mapping |
When working in frame.io you must use the native Archive functionality to separate Archived projects from Active projects.
A.2 Troubleshooting & Tips
- Ensure proper order: Always archive the project on Frame.io first, and then rename it to include Archived. The webhook will not trigger if these steps are not followed accurately.
- Check email notifications: Monitor your email for notifications to keep track of the archive task's status.
- Retry skipped tasks: If you receive an email indicating a task has been skipped due to an ongoing task, wait for the current task to complete before trying again.
By following this guide, you should be able to efficiently archive your projects from frame.io to Iconik, thereby optimizing your storage usage and costs.