Creative Automation Tool

5.0.0 (2015-06-29)


License

For Tremor Video internal use only. Tremor Video 2011


Authors

Leandro Silva


System Requirements


Quick Links


Description

Developed for the Creative Department, and used in the New York, Los Angeles, and Singapore office, this application provides a cross operating-system tool to assist in making creative demos and live units. It supports over 20 unit types, removes all current pain points, and helps to decrease the need for make-goods. This application will copy files to the needed directories/servers, update Salesforce with pertinent data, write to a central data warehouse for demo creation, and purge Akamai, all while enforcing a unified naming convention and checking for a multitude of errors. Additionally, it unifies the creative workflow.

This automated process has saved countless hours of production time (conservatively estimated at over 600 hours per month). As of April 2015, it has helped to create over 14,000 unique demos.

Old Process

The old process was riddled with unnecessary manual labor and inconsistent processes between team members. It involved a higher learning curve and the need to pass files back and forth between multiple people. The steps were as follows:

Upon completion of creative unit:

*Through management

New Process

Upon completion of creative unit:

*Through management


Documentation

Modes

3rd Party Systems

Supported Unit Types

Application Flow (Demo Mode)

Every step is automated unless noted.

Instream

*As a separate process, and every sixth minute, the purge queue is check for content. If there are files to be purged, a purge request is sent to Akamai via their REST API. This process runs every sixth minute to align with the Systems Departments script to copy files from our local servers to net storage every fifth minute.

Mobile

This process requires you to have the applications 'MCS Bookmarklet' link in your browser.

Application Flow (Move Mode)

Same error checking and directory copying as above, but data is not pushed to any databases. Use in cases where a CU is incomplete and needs to be sent to another designer.

Expected Directory Structure

../Advertiser/Ad Sale Id/Creative Unit Id/

Instream:

`- CU
    |
    |- bin
    |   |
    |   |- vids
    |   |   |
    |   |   `- video.flv
    |   |
    |   `- creative.swf
    |
    |- src
    |   |
    |   |- ad
    |   |   |
    |   |   `-AdClass.as
    |   |
    |   `- creative.fla
    |
    `- elements
        |
        `- asset.psd

Mobile:

`- CU
    |
    |- bin
    |   |
    |   `- creative.zip
    |
    `- src
        |
        |- manifext.xml
        |
        `- vidurl.txt

Preroll:

`- CU
    |
    |- companion (optional)
    |   |
    |   `- image.jpg
    |
    `- video.flv

On Windows, the cmd key is mapped to the ctrl key.

Config File

The available configurations are:

Errors

Id: e001

Message: Currently, only Mac and Windows Operating Systems are applicable. Sorry.

Note: Mac and Win OS only.

-

Id: e002

Message: There is a conflict between your data and the Salesforce data. Make sure your CU# is a correct match to your AS#.

Note: Occurs if the users folder structure is incorrect.

-

Id: e003

Message: AS# from SalesForce does not match AS# from dropped file. AS# from SalesForce: [# pulled from SalesForce query] AS# from folder: [# pulled from drag/dropped file].

Note: Occurs if the users folder structure is incorrect.

-

Id: e004

Message: There was a problem adding your data to the database. Please try again.

Note: Database error.

-

Id: e005

Message: There was a problem copying your files to the [errored location].

Please reach out to I.T. and try again. If this unit needs to be pushed ASAP, manually move your assets and use the 'File Copying Override' menu option.

Note: An OS permissions error or file lock is most likely the cause.

-

Id: e006

Message: Make sure your folder structure is setup correctly. Expecting a 'bin' folder. If this is a preroll, make sure your folder name includes "preroll" (no 'bin' folder needed for prerolls).

Note: If not a preroll, checks for 'bin' folder before attempting to move files to the CDN.

-

Id: e007

Message: You're trying to purge too many files at once. This app accepts no more than 90 URLs at a time.

Note: See CCU API documentation (Content_Control_Interfaces.pdf).

-

Id: e008

Message: Akamai purge-file creation failed. Please try again.

Note: Occurs if the app fails to properly create a purge file.

-

Id: e009

Message: Make sure the following is in your XML:

<supportedProfiles>extendedDesktop</supportedProfiles>

If on a Windows machine, make sure you have the Java JRE (v6+) installed.

Note: To run the Java process, you need to have the above node in your apps descriptor xml.

-

Id: e010

Message: There was an error sending your purge request to Akamai. See CCU-API documentation "Result Code" definitions.

Note: See CCU API documentation (Content_Control_Interfaces.pdf).

-

Id: e011

Message: There was an error logging your data. Everything else has succeeded.

Note: You should re-run your last CU so that the log is properly updated.

-

Id: e012

Message: A internet connection is needed to proceed.

Note: Internet is needed for database communication.

-

Id: e013

Message: There was an error getting your Akamai login credentials.

Note: Database may be down or Akamai login name/password was possibly changed. Update the name/password located in air-to-mysql.php.

-

Id: e014

Message: Make sure your advertiser folder is correctly named. Please rename your advertiser folder to match the folder on the creative drive and try again.

Note: The advertiser folder should already be on the creative drive. If the users advertiser folder does not match the name of the folder on the server, he/she must correctly rename the folder. If the folder does not exist, please ask Creative Management to create a folder on creative drive.

-

Id: e015

Message: Your 'bin' folder should only have two files (the creative and live assets file). All additional files should go inside their respective folders.

Note: Bin folders should only have one swf (or zip for mobile) file.

-

Id: e016

Message: Your preroll folder should not have a 'bin' folder. It should only have a video file (and companion folder if needed).

Note: Specific to prerolls.

-

Id: e017

Message: This Creative Unit is locked. Please have your Creative Manager change its Salesforce status.

Note: Checks the configData.lockStatus array for Salesforce statuses that lock this app. Also checks via a query to the 'Creative Unit History' table in the Salesforce database. The query is mainly used to check instances where the CU is locked even though the status is one that allows us to edit it (e.g. the CUs status is okay for updates, but there is a lock-icon in the CU in SalesForce).

-

Id: e018

Message: There was an error attempting to list files in your directory.

Note: Plan prerolls are the only CUs that have no bin folder.

-

Id: e019

Message: No spaces or ampersands are allowed in file/directory names.

Note: No spaces or ampersands are allowed in any part of the file or directory name(s).

-

Id: e020

Message: Please have your manager update Salesforce with a CTA message before re-running.

Note: Preroll CTA messages should be set by Creative Managers.

-

Id: e021

Message: There is in an error in your config file.

Note: Most likely caused by malformed XML.

-

Id: e022

Message: The config files app id is not correct.

Note: The config app id should match the Creative Automation Tool's app id.

-

Id: e023

Message: You're missing files in the expected locations.

Note: An Alert windows pops up showing the expected locations.

-

Id: e024

Message: The app is currently locked due to maintenance. Contact Leandro for more info.

Note: Toggled via lockswitch.xml.

-

Id: e025

Message: There was a problem accessing Salesforce.

-Make sure your CU is correct.

-This error may be caused by an unacceptable character entered in the comments field.

Note: SalesForce connection error. If error occurs when trying to write to SalesForce, make sure the key you are trying to update is flagged for update. In PHP (CATSFConn.class.php), "$this->keySelect"s third arguement should be "true" if you want that field to be updatable.

-

Id: e026

Message: There is a conflict between your data and the Salesforce data.

Note: Salesforce fails to return data (possibly due to an incorrect CU#).

-

Id: e027

Message: There was a problem getting your toolkit version.

Note: The CAT loads the CU SWF to get toolkit version.

-

Id: e028

Message: There was an error connecting to the php->sql file.

Note: Check the PHP database communication file.

-

Id: e029

Message: There was a problem writing your data to Salesforce. Please try again.

Note: May be caused by an incorrect CU#.

-

Id: e030

Message: Your companion banners file size is too large (75kb = max).

Note: Use Adobe's save-for-web feature to decrease file size.

-

Id: e031

Message: There is an error in the Flash file you're working on!

Note: The creative SWF has runtime errors.

-

Id: e032

Message: Make sure all necessary drives are mounted (e.g. the R:\ and CDN drives).

Note: Needs drives mounted for copying files and reading data.

-

Id: e033

Message: You need a default image (jpg or gif) for inBanner CUs.

Note: InBanner CUs need a default image.

-

Id: e034

Message: A demo units advertiser must be "demo." Expected folder structure: /demo/asXXXXX.

Note: Supported demo AS numbers can be found in the config file.

-

Id: e035

Message: Your 'bin' folder should have one 'export' zip file (i.e. mvp_creative_export.zip).

Note: Applies to mobile units that are not MVs.

-

Id: e036 [deprecated]

Message: Your mobile 'src' folder should have a .mov file begining with the as# (i.e. as00000_anytext.mov).

Note: Applies to mobile units that are not MVs.

-

Id: e037 [deprecated]

Message: Your mobile 'src' folder should only have 1 .zip file and 1 .mov file.

Note: Applies to mobile units that are not MVs.

-

Id: e038 [deprecated]

Message: Your mobile 'src' folder should only have 1 .zip file and at least 1 .mov file.

Note: Applies to mobile units that are not MVs.

-

Id: e039 [deprecated]

Message: Your mobile folder should only have a .mov/flv file begining with the correct as# (i.e. as00000_anytext.mov).

Note: Applies to mobile MV units.

-

Id: e040 [deprecated]

Message: The file "[file name]" is too large. It should be no larger than [acceptable size in mb].;

Note: A file throws a warning if larger than the set warning size or throws this error if larger than the max size.

-

Id: e041

Message: Please push files from a directory that is not on the Creative Drive.

Note: You cannot push files from the Creative Drive (since it copies files to that drive).

-

Id: e042

Message: An unknown error occurred.

Note: An uncaught error.

-

Id: e043

Message: One of your companion banners is of an unacceptable file type.

Note: Companion banners must be of a specified image type.

-

Id: e044

Message: A video length must be inputted for every video.

Note: Mobile CUs need video lengths added (in seconds rounded down). If the applciation fails to automatically read a video length, please input it in manually.

-

Id: e045

Message: Mobile SMV, MVP, and MXP units need [mobile video export file name].

Note: The demo URL file exported by the mobile toolkit must be present (config node = <mobileVidName>).

-

Id: e046

Message: The file name "[file name]" must be lowercase.

Note: Since the CDN is case sensitive and does not allow me to change the cases of file/directory names, all directory names must be in lowercase.

-

Id: e047

Message: The file "BuyNow.zip" must be named "[buy now zip name]."

Note: The old name "BuyNow" is no longer accepted.

-

Id: e048 [deprecated]

Message: There was a problem copying your files to the [errored location].

Copy confirmation failed.

Note: There may have been a hiccup in the internet connection.

-

Id: e049

Message: Your 'src' folder must have the video list file [vid url file name].

Note: Mobile reads this txt file to get a list of videos used in the CU.

-

Id: e050

Message: There was a problem versioning your mobile CU.

Note: A mobile CU has its 'bin' folder versioned in the Creative drive. Does not apply to MVs.

-

Id: e051

Message: Your mobile CU directory should not have any video files.

Note: All mobile videos should be in the parent asset-containing directories.

-

Id: e052

Message: Your files are outdated.

Note: Make sure to move your files to their proper locations before using the "File Copying Override" menu option.

-

Id: e053

Message: No file should have the "_v" naming convention. Please remove the "_v" from "[file name]."

Note: The CAT uses "_v" as its versioning convention.

-

Id: e054

Message: There was a problem in the MCS process.

-

Id: e055

Message: Please remove the default video "[file name]."

Note: The default video ("the.flv") is a placeholder and should be removed.

-

Id: e056

Message: The directory "[directory path]" is missing from the Creative Drive.


Changelog

Support for Windows was dropped after v3.6.3 (11/06/13)

5.0.0 (2015-06-29)

4.2.0 (2015-04-22)

4.1.1 (2015-03-09)

4.1 (2014-12-30)

4.0.5 (2014-11-06)

4.0.4 (2014-10-22)

4.0.3 (2014-08-25)

4.0.2 (2014-08-06)

4.0.1 (2014-07-14)

4.0 (2014-07-09)

3.9 (2014-05-30)

3.8 (2014-03-12)

3.7.1 (2014-03-06)

3.7 (2014-03-06)

3.6.7 (2014-02-25)

3.6.6 (2014-02-21)

3.6.5 (2013-12-31)

3.6.4 (2013-12-30)

3.6.3 (2013-11-06)

3.6.2 (2013-10-29)

3.6.1 (2013-10-07)

3.6 (2013-09-11)

3.5 (2013-06-06)

3.4.1 (2013-04-23)

3.4 (2013-04-22)

3.3 (2013-03-18)

3.2.1 (2013-02-26)

3.2 (2013-02-14)

3.1.2 (2012-12-03)

3.1.1 (2012-11-16)

3.1 (2012-11-16)

3.0 (2012-10-05)

2.9 (2012-09-21)

2.8.2 (2012-08-30)

2.8.1 (2012-08-30)

2.8 (2012-08-27)

2.7 (2012-08-16)

2.6.1 (2012-08-07)

2.6 (2012-08-06)

2.5.1 (2012-07-24)

2.5 (2012-07-19)

2.4.1 (2012-06-15)

2.4 (2012-06-15)

2.3 (2012-06-07)

2.2 (2012-05-29)

2.1.1 (2012-04-25)

2.1 (2012-04-19)

2.0 (2012-04-16)

2.0b3 (2012-03-28)

[Beta Release]:

2.0b2 (2012-03-26)

[Beta Release]:

2.0b1 (2012-03-15)

[Beta Release]:

1.9.3 (2012-03-06)

1.9.2 (2012-03-02)

1.9.1 (2012-03-05)

1.9 (2011-11-08)

1.8.2 (2011-10-31)

1.8.1 (2011-10-27)

1.8 (2011-10-26)

1.7.1 (2011-09-28)

1.7 (2011-09-28)

1.6 (2011-08-30)

1.5b (2011-08-08)

[Beta Release]:

1.4b (2011-07-28)

[Beta Release]:

1.3b (2011-07-25)

[Beta Release]:

1.2 (2011-07-19)

[Beta Release]:

1.1 (2011-07-14)

[Beta Release]:

1.0 (2011-06-17)

[Beta Release]:


Known Bugs