Bulk Team Creator Management
The purpose of this document is to describe how the Creatable platform ingests creators, stores, and regions from data feeds on a periodic basis. These data feeds can be configured to create, update, and/or remove creators, stores, and regions automatically.
Data file ingestion options and scheduling
In order to bulk ingest video content, we must have access to a data feed file so that it can be ingested. The following methods are available for this process:
- Place the file on the Creatable provided FTP/SFTP server.
- Make the file available to Creatable via HTTP/HTTPS.
The Creatable Platform will ingest the file from either location. Note that if using option 2, only Basic HTTP Authorization is available, sending custom headers or tokens for authorization purposes is not available.
First you must configure a feed import mapping for each file. From the dropdown in the dashboard in the upper right, select "Feed Mapping". Then click "New Mapping".
Enter a name, select "Employee Import", “Stores Import”, or “Regions Import” as the mapping type as appropriate.
Configuration and scheduling of these imports can be done via the Schedule Manager in the management dashboard. From the “Add Schedule” button, select Employee Import, Stores Import, or Regions Import as appropriate and complete the form.
- Title your feed import.
- Enter the Feed URL (can be direct HTTP/HTTPS or via the Creatable FTP/SFTP)
- Select a field mapping (corresponding mapping must already exist).
- Select a schedule for import (every X days). Defaults to every 1 day.
- Activate the feed import.
- If your file contains a header row, enable "Skip first row".
- Finally, click “Save” and your video feed schedule is done!
Data file format
The following describes the requirements for the data file format and specific requirements for the data file itself.
The format of the file must be TSV -- “Tab” separated values. This reduces the potential for errors/issues when generating or reading the file.
File Data Column Reference:
Creator Feed:
Field |
Type |
Data Type |
Example |
Minimum Characters |
Maximum Characters |
Allowed Values |
Is Case Sensitive |
Required |
Primary Key |
Action |
enum |
string |
CREATE |
-- |
-- |
CREATE,UPDATE,REMOVE |
yes |
Yes |
No |
First name |
string |
string |
Johnny |
1 |
100 |
no |
Yes |
No |
|
Last name |
string |
string |
Johnny |
1 |
100 |
no |
Yes |
No |
|
Email address |
string |
string |
user@domain.com |
1 |
100 |
no |
Yes |
Yes |
|
Status |
enum |
string |
APPROVED |
-- |
-- |
NEW,REVIEW,APPROVED,TEMPORARILY SUSPENDED, SUSPENDED, REJECTED |
yes |
Yes |
No |
Password |
string |
string |
1q2W#e4R |
8 |
30 |
Minimum 8 characters, Uppercase & lowercase letters, at least 1 special character |
yes |
Yes |
No |
Stores Feed:
Field |
Type |
Data Type |
Example |
Minimum Characters |
Maximum Characters |
Allowed Values |
Is Case Sensitive |
Required |
Primary Key |
Store # |
string |
string |
1234 |
1 |
100 |
No |
Yes |
Yes |
|
Store Name |
string |
string |
Winslow |
1 |
100 |
No |
Yes |
No |
|
Region |
string |
string |
Smith |
1 |
100 |
Region name as found in the Team > Settings > Regions list in the Creatable dashboard, exact string match |
No |
Yes |
No |
City |
string |
string |
San Diego |
1 |
100 |
No |
Yes |
No |
|
State/Province |
string |
string |
California |
1 |
100 |
No |
Yes |
No |
|
Country |
string |
string |
USA |
1 |
100 |
No |
Yes |
No |
|
Action |
enum |
string |
CREATE |
-- |
-- |
CREATE,UPDATE,REMOVE |
yes |
Yes |
No |
Regions Feed:
Field |
Type |
Data Type |
Example |
Minimum Characters |
Maximum Characters |
Allowed Values |
Is Case Sensitive |
Required |
Primary Key |
Name |
string |
string |
Smith |
1 |
100 |
No |
Yes |
Yes |
|
Action |
enum |
string |
CREATE |
-- |
-- |
CREATE,UPDATE,REMOVE |
yes |
Yes |
No |
Custom fields
Sending custom fields as part of the Creator feed import process can be done and must be initially configured by Creatable. This allows you to provide additional metadata with your video asset beyond the columns specified above.
Processing an import feed
When our system processes your video import feed, it will iterate through each line in the file and either CREATE, UPDATE, or REMOVE the Creator, Store, or Region as appropriate. This effectively allows you to manage your digital sales team automatically without having to manually update information within the dashboard. NOTE: to deactivate an employee, you must perform an update action changing their status to “Suspended”.
The feed import process can be coordinated with Creatable to ensure an early pickup and ingestion of the data file on a daily, weekly or monthly basis.
If for any reason, the import process fails, this will be logged in the Job Manager within your Creatable account.