Automated 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:

1. Place the file on the Creatable provided FTP/SFTP server.
2. Make the file available to Creatable via HTTPS.

We will ingest the file from either location. Note: if using option 2, only Basic HTTP Authorization is available, sending custom headers or tokens for authorization purposes is not available.

Configuring a feed file mapping

First you must configure a feed import mapping for each type of file (Employee, Store, Region). 

1. From the main menu, navigate to the “Account” section.
2. Click on the tab “Job configuration”.
3. Click “Add configuration”.
4. Name your configuration, for example “Employee sync”.
5. Select the mapping type “Employee sync”.

The default configuration provided shows how system field names are mapped to columns in the TSV file. You can adjust this configuration by changing the key/value pairs, it is imperative that the key corresponds with a field in the system.

Save your configuration and this portion of the setup for an Employee sync job is complete.

Custom fields

For mapping custom fields, you can edit your Job configuration and provide additional custom key/value pairs. Each key/value pair must correspond to a key that is represented in the “Custom attributes” section of your account (Account > Custom attributes) to get the specific field names.

Note: This functionality only applies to the Employee sync type job.

Creating a scheduled job

Creating a scheduled job is easy, just follow these steps.

1. Navigate to “Account > Job scheduler” in your account.
2. Click “Add schedule”.
3. From the “Schedule type” dropdown, select “Employee sync”. If you are creating a job for Store or Region sync, the process is the same.
4. Name your job, for example “Employee sync”.
5. Choose how often you wish the job to run, we recommend a daily job for most sync operations.
6. Enter the URL location for where the job file is located. If this is via the Creatable SFTP, your account manager will configure this for you.
7. Select the field mapping we created earlier in the Job configuration “Employee sync”.
8. If your file contains a header row, you can enable the “Skip first row” option.
9. Finally, you can choose to enable the job and it will run on the scheduled frequency. We recommend for testing purposes that you leave this disabled until you are ready to run the job on a scheduled basis. You can run the job at any time otherwise by clicking the “Run now” button from the main job list.

Data file formats

The formats of these data files allow you to manage the data in the system for each of the respective job types. Each file follows a similar format with the most important column being the “Action” column. This tells the system what kind of action to perform on the row and also dictates what data is required to perform the operation.

Employee sync

Below you will find a data definition format and sample. This definition provides the basis for the fields that can have operations performed against them with this type of job.

How to: Deactivate an employee

A popular operation is to simply deactivate an employee. To achieve this you would use an UPDATE operation and change the “status” of the employee to “SUSPENDED”. This will not allow the employee to log in to the dashboard for the brand they are working with, effectively removing their access.

See sample data file format (link TBD)

Store sync

See sample data file format (link TBD)

Region sync

See sample data file format (link TBD)

Job status & troubleshooting

Each time a job is run, you can find a record of that execution in the Job history section (Account > Job history). Every execution has a status - Complete, Queued, Failed. More details on job status can be provided by contacting your account manager, please provide the Job ID and additional information can be provided.