CatDV YouTube Connect User Manual
CatDV YouTube Connect User Manual
This document is considered in draft format for review only as of 1/12/2021
Chapter 1 - User Operations
Chapter 2 - CatDV Metadata
CatDV & YouTube-Connect Metadata Fields
This section lists all the metadata fields in CatDV that are used in this workflow and also gives a description of them.
These metadata fields are created in the CatDV metadata during the system deployment and can be mapped to a details panel in CatDV. We recommend collecting these fields into a dedicated CatDV Details Panel for clarity.
In this example, the user has created a details panel called "NSA-YT_Connect" in which the YouTube and YT-Connect metadata are displayed.
Note: In the "Main Window" of the CatDV, you can set up a column display to view the metadata/status for every clip.
This view provides a quick “dashboard” view of all actions surrounding publishing to YouTube.
The data in the lower fields labeled "YouTube" are typically coming from the YouTube API. (Exceptions are “YouTube Source Path”, YouTube Action, and “YouTube Channel”) All other fields are either updated by user input or by a Worker Node action (e.g., ClipRef, Title, Category, etc.)
Media Path - Built-in CatDV field that lists the selected file's path. This will also be the asset’s original file path, stored in the archive, and used for restore operations
YouTube Source Path - If desired, the YouTube Source Path can be populated with the path to an alternate file to be uploaded, instead of the hi-res asset specified by the clip record in CatDV. In the config file (see below), the YouTube Source Path can take on either a value of default (indicating no alternate file path), or a User Field alias from the [Fields] section be used INSTEAD of the default Media Path to the hi-res.
YouTube Action - CatDV User field watched by the Worker Node in order to start the job enqueue/archive process. After the Worker Node action runs and the job has been submitted to YouTube, this value will be set to blank (a null value)
Listed here are the possible values for the YouTube Action field:
Publish to YouTube
Clip ID / Clip Ref - Built-in CatDV field that lists the selected file's Clip ID (GUID)
YouTube Channel - CatDV User field which denotes which YT Channel to send the selected asset to in the user’s YouTube account
Note: Channels must be set up in advance in YouTube and the CatDV config mapping IDs should be checked to make sure that they match the YouTube channel ID exactly. See Chapter 4 - Deployment>Config File Overview for more information.
Title - CatDV User field which is used to set the Title to be published to the video in YouTube.
Category - CatDV User field which is used to set the Category to be published to the video in YouTube. This should match the current available categories in YouTube.
Listed here are the possible values for the Category field:
Film & Animation
Autos & Vehicles
Howto & Style
People & Blogs
People & Blogs
News & Politics
Pets & Animals
Travel & Events
Science & Technology
Nonprofits & Activism
Keywords - CatDV User field which is used to set the Keywords to be published to the video in YouTube.
Privacy - CatDV User field used to set the privacy to be published to the video in Youtube.
Listed here are the possible values for the Privacy field:
These follow standard YouTube settings conventions. See YouTube admin section for more info.
Description - CatDV User field which is used to set the Description to be published to the video in YouTube.
Note: This might need to be named “YouTube Description” in cases where there is an existing “Description” field in CatDV. As this field will be published publicly, it’s important to note that it’s dedicated to YouTube or other outward facing systems.
YouTube Status - CatDV User field which is set to indicate the status of the video upload process.
Listed here are the possible values for the YouTube Status field:
Processing - This means the asset is currently being sent to YouTube
Failed - This means the asset was unable to be published
Published - This means the asset was successfully published to YouTube
Note: You can confirm this by checking the YouTube URL field for a valid web address
YouTube Publish Date - CatDV User field which is set with the date the asset was published on Youtube.
YouTube URL - CatDV User field which is set to the URL of the video after publishing an asset on Youtube.
Chapter 3 - NSA YT-Connect App Overview
Chapter 4 - Deployment
Config File Overview
This section explains the settings contained in the North Shore YouTube-Connect config file.
You may open it for editing in any text editor.
It is located at:
/etc/northshore/config/youtube-config.cfg - on OS X
%UserProfile%\northshore\config\youtube-config.cfg - on Windows
On the pages below we outline the specific settings and options for each section.
# Uncomment and add ID to upload to channel
default_channel_alias = northshore
# default --> use media source path, otherwise provide a field alias
# from [Fields] section below to use that field instead
# such as 'override_source_path'
# source_path_field = override_source_path
source_path_field = default
northshore = UC-9xxxxxxxxxxxxxxxE
title = com.nsa.yt.title
description = com.nsa.yt.description
category = com.nsa.yt.category
keywords = com.nsa.yt.keywords
privacy = com.nsa.yt.privacy
yt_url = com.nsa.yt.url
yt_publish_date = com.nsa.yt.publish.date
yt_action = com.nsa.yt.action
yt_status = com.nsa.yt.status
override_source_path = com.nsa.yt.source.path
email_enabled = False
email_host = smtp.mailgun.org
email_port = 587
sender_email = <username>
sender_password = <password>
# Comma separated
recipient_emails = email@example.com
log.file = /var/log/northshore/youtube-upload.log
# (debug, error)
log.level = debug
# Pattern: m# = <from_path>;<to_path>
m0 = /Volumes/SourceMedia;C:\Video\SourceMedia
m1 = /Volumes/Foo/Media Back Up/;\\UNC_HOST\Bar\Media Back Up
m2 = /Users/king/Desktop/akomi-import;/home/king/akomi-import
Section - [YouTube]
This section of the config file shows settings related to YouTube account configuration & connection
Section - [CATDV]
This section of the config file shows settings related to CatDV server configuration & connection
Section - [Channel Alias]
This section of the config file defines the alias/es for the YouTube channel/s to publish assets to. They should be entered as a list with line breaks between the alias/ID pairs.
The first part of the key pair, the “alias” (northshore in our example,) is the value that is shown in the CatDV picklist for the “YouTube Channel” field in the CatDV UI. The ID is the YouTube channel ID from your YT account, which is entered during the configuration.
This Alias/Channel Name is user definable and is set during the deployment
Section - [Fields]
This section of the config file defines the CatDV fields for the application. The first value is the NSA app field value. This is only used by the NSA app. The second value of the pair is the CatDV slug name, from the CatDV Server. Note that CatDV Display Names are not used in this application config. This info should be entered as a list with line breaks between the field/slug pairs.
See Chapter 2 - CatDV Metadata for full field list
Section - [NOTIFY]
This section of the config file defines the smtp server settings used by the NSA app to send notification emails.
Section - [SYSTEM]
This section of the config file defines where logs are stored and the log level of the application.
During troubleshooting your NSA support rep may ask you to collect and send these logs to give more info about a particular issue or behavior.
Section - [PathMappings]
If your system contains Mac OS X clients or Worker Nodes you may need to set path equivalences so that the system can translate OS X paths to Windows or Linux paths for the YouTube-connect application.
Pattern: <incoming path root>;<translated path root>
See the examples in the config example above and contact your system administrator for more info if required.