Response Pane and Window

The Response pane contains the settings for creating a wide variety of preconfigured actions. These responses are what the watchers, subscriptions, and schedules use when they detect that an action needs to be performed. Responses are configured separately from watchers, subscriptions, and schedules because the same response may be required in several situations.

The Response pane lists the existing responses.

Figure. Administration window, showing the Response pane and the Create and Duplicate buttons.

The Response pane includes the following columns:

The Response window appears when you click the Create button.

Figure. The Response window.

The settings that appear in the window, along with the items that appear in the area on the left, depend on the action you choose from the Response Action pop-up menu.

Note: If you edit an existing response by double-clicking it in the Response pane, you cannot change its Response Action setting.

Response Actions

What you choose from the Response Action pop-up menu defines the response’s basic purpose. Some response actions have additional settings that can be configured in a second pane that gets added to the column on the left.

Response action
Triggered by
Description
Check the disk space of the database volume
Schedule
Defines the minimum disk space before a warning is issued that the database is about to run out of room.
Clean Jobs
Schedule
Defines periods at which jobs are archived and deleted. For more information, see About Clearing Jobs and Logs from the Final Cut Server Database.
Clean Logs
Schedule
Defines periods at which logs are archived and deleted. For more information, see About Clearing Jobs and Logs from the Final Cut Server Database.
Copy
Poll watcher or asset subscription
Copies media to any connected Final Cut Server device with or without transcoding. Optionally, creates a new asset in Final Cut Server and allows you to set that asset’s metadata.
Delete
Poll watcher or asset subscription
Deletes the item. You can choose to have this response run even if other responses in the list fail.
Email
Poll watcher or asset, production, or job subscription
Sends an email. You configure the email settings (to, sender, subject, and message).
Log
Asset, production, or job subscription
No additional options. Adds an entry to the log.
Measure database size
Schedule
No additional options. You can use this to find the disk space used by the catalog’s database (the results are shown in the Log pane). This action measures only the database—it does not include the actual assets the catalog refers to.
Monitor Scan
Poll watcher
Scans for specific metadata settings.
Move to Archive
Asset subscription
No additional options. Moves the media to the selected archive device.
Purge Subscriptions
Schedule
Deletes subscriptions that have not been active for a specified number of days.
Read XML
Poll watcher
No additional options. Reads XML data from an external system. It is used in conjunction with the Write XML response action.
Restore from Archive
Asset subscription
No additional options. Restores items from an archive device.
Run an external script or command
Poll watcher or asset, production, or job subscription
Executes a script or other external command. You can also define special parameters to apply to the script or command.
Scan
Schedule
Scans a specified Final Cut Server device. The purpose of a scan is to synchronize the contents of the Final Cut Server catalog with the media that exists on a device. This is necessary if you intend to change the media on the device directly without using Final Cut Server. You can choose the device and a folder in that device to scan, as well as specify metadata settings. You can also specify other scan details, such as whether to purge (remove) items from the catalog if they are removed from the device, or specify a frame rate if you are scanning image sequences.
Scan Productions
Schedule
Scans a specified Final Cut Server device for productions. Similar to the Scan response action, but with added production metadata settings that create a new production with the assets.
Search Expired
Schedule
Searches for expired items. It creates events based on a timestamp field (such as Last Accessed) and a value defining the number of past days to look for. This can be used to identify items to archive.
Set Asset Metadata
Asset subscription
Enters data in specified metadata fields. You choose the asset metadata set with the fields to change.
Set Production Metadata
Production subscription
Enters data in specified metadata fields. You choose the production metadata set with the fields to change.
Write XML
Asset or production subscription
Creates an XML file based on the asset’s metadata. This allows someone using an external system to modify the metadata; for example, to add review comments or annotations, which can be read back in and applied to the asset using the Read XML response action.

About Scan Responses

Scan responses are one of the most commonly used custom responses.

To access the scan response settings
  1. Click the Create button in the Administration window’s Responses pane to create a new response.

  2. Choose Scan from the Response Action pop-up menu.

  3. Click Scan to view the scan settings.

The Scan pane of the Response window contains settings that define what is being scanned, the metadata that is applied to the items found by the scan, and the actual scan mode and settings.

Figure. Response window, showing the Response Action pop-up menu and the Scan settings.
Scan Source Section
Metadata Set Section
Scan Metadata Section
  • Recursion Limit: This defines the number of folder levels the scan will include. A value of 0 means unlimited subfolders are scanned. A value of 1 means that only the folder specified by the Scan Source pop-up menu is scanned.
  • Background Analyze: Creates the proxy items for the assets as a background task. Normally, assets are analyzed as a foreground task, one at a time. Analyzing in the background allows multiple tasks to run concurrently, which may be useful but also may result in resource issues with your computer. In general, it is recommended that you do not select this option unless you are comfortable with monitoring your computer’s resources.
  • Always Update: This sets the scan to continuously attempt to make proxy files for assets that do not currently have proxy files. This should not be selected unless you had a known issue with a device and want to generate proxy files from its assets.
  • Purge Unfiltered Assets: This sets the scan to purge assets from the catalog that don’t match the Wildcard Include Filter and Wildcard Exclude Filter settings.
  • Wildcard Include Filter: You can use this to define the types of files that the scan processes. The default filter is the asterisk (*), which is the wildcard indication. A single asterisk indicates that all files are processed. If you want the scan to process only JPEG and QuickTime movie files, you can replace the asterisk with two items: *.jpg and *.mov (which indicate that all files with .jpg and .mov file extensions are processed).
  • Wildcard Exclude Filter: You can use this to define types of files that the scan should not process. For example, if the folder that the scan is processing includes PDF documents that you do not want to have processed and added as assets, you can enter *.pdf (which indicates that all files with a .pdf extension are not processed).

Scan Responses Created by Device Setup Assistant

One or two scan responses are created when you configure the scan settings for a device with Device Setup Assistant in Final Cut Server System Preferences:

  • Device Scan [Full Scan]: This is created when you configure a full scan in Device Setup Assistant. This response uses the Purge setting from the Scan Mode pop-up menu with a Recursion Limit setting of 0 (unlimited subfolder access).
  • Device Scan [Add Only]: This is created when you configure an add only scan in Device Setup Assistant. This response uses the Add Only setting from the Scan Mode pop-up menu with a Recursion Limit setting of 0.

About Scan Productions

The scan productions response allows you to automate more of your workflow process for adding assets and productions to the Final Cut Server catalog.

Most of the settings for a scan production response are the same as for a scan response. The difference is a section that allows you to specify production settings.

To access the scan production response settings
  1. Click the Create button in the Administration window’s Responses pane to create a new response.

  2. Choose Scan Productions from the Response Action pop-up menu.

  3. Click Production Scan to view the Scan Productions settings.

The Production Scan pane of the Response window contains settings that define what is being scanned, the metadata that is applied to the items found by the scan, production metadata settings, and the actual scan mode and settings.

Figure. Response window, showing the Response Action pop-up menu and the Production Scan settings.
Scan Source Section
Metadata Set Section
Production Metadata Section
Scan Metadata Section
  • Production Depth: This defines the depth of the subfolders that are made into productions. A value of 0 means to use the first level of subfolders, while a value of 1 means to use the second level of subfolders.
  • Reset Production Metadata: Click this checkbox to replace an existing production’s metadata with the new metadata generated from this scan production response.
  • Recursion Limit: This defines the number of folder levels the scan will include when looking for assets. A value of 0 means unlimited subfolders are scanned. A value of 1 means that only the folder specified by the Scan Source pop-up menu is scanned.
  • Background Analyze: Creates the proxy items for the assets as a background task. Normally, assets are analyzed as a foreground task, one at a time. Analyzing in the background allows multiple tasks to run concurrently, which may be useful but also may result in resource issues with your computer. In general, it is recommended that you do not select this option unless you are comfortable with monitoring your computer’s resources.
  • Always Update: This sets the scan to continuously attempt to make proxy files for assets that do not currently have proxy files. This should not be selected unless you had a known issue with a device and want to generate proxy files from its assets.
  • Purge Unfiltered Assets: This sets the scan to purge assets from the catalog that don’t match the Wildcard Include Filter and Wildcard Exclude Filter settings.
  • Wildcard Include Filter: You can use this to define the types of files that the scan processes. The default filter is the asterisk (*), which is the wildcard indication. A single asterisk indicates that all files are processed. If you want the scan to process only JPEG and QuickTime movie files, you can replace the asterisk with two items: *.jpg and *.mov (which indicate that all files with .jpg and .mov file extensions are processed).
  • Wildcard Exclude Filter: You can use this to define types of files that the scan should not process. For example, if the folder that the scan is processing includes PDF documents that you do not want to have processed and added as assets, you can enter *.pdf (which indicates that all files with a .pdf extension are not processed).

About Copy Responses

Copy responses are one of the most commonly used custom responses.

Important: If the destination device already contains a file with the same name as the one being copied, copy responses by default will not overwrite that file, and instead, will add a numbered extension to the new file’s name. You can optionally use the Overwrite setting to overwrite an existing file with the same name. An exception to this is copying to ContentBase devices, where each file is placed in a unique folder.

To access the copy response settings
  1. Click the Create button in the Administration window’s Responses pane to create a new response.

  2. Choose Copy from the Response Action pop-up menu.

  3. Click Copy to view the Copy settings.

The Copy pane of the Response window contains the destination, transcode, and destination metadata settings.

Figure. Response window, showing the Response Action pop-up menu and the Copy settings.
Destination Settings
Transcode Setting
Destination Metadata Settings
  • Copy Metadata: Select the “Run in parallel” checkbox to allow this response to run at the same time as other copy responses in a watcher or subscription. When this is not selected, the response runs serially, based on its order in the watcher or subscription. Select the Overwrite checkbox to overwrite an existing destination file if it has the same filename as the file being copied.

    Note: Delete responses always run serially and after the copy responses.

  • Create Asset: Select this checkbox to have the copied asset added to the Final Cut Server catalog. Selecting this checkbox activates the Metadata Set and Production selection settings.
  • Production: Enter a name to create a new production that the asset aliases are added to. Alternatively, click Choose to search for an existing production to add the asset aliases to.
  • Overwrite: Select this checkbox to have the copied asset replace an existing file if it has the same filename.

About Email Responses

Email responses are commonly used with metadata watchers that look for an asset’s status to change to a specific state, such as Ready for Review.

To access the email response settings
  1. Click the Create button in the Administration window’s Responses pane to create a new response.

  2. Choose Email from the Response Action pop-up menu.

  3. Click Email to view the Email settings.

The Email pane of the Response window contains the settings for configuring the email. See the Final Cut Server Setup Guide for information about email response details, including codes you can enter to add automated data to the email, shown above as the text in brackets ([ ]).

Figure. Response window, showing the Response Action pop-up menu and the Email settings.

The Email pane contains the following settings:

  • To: Enter the email addresses that should receive the email. Use a comma (with no space after it) to separate addresses; for example, rev1@apple.com,rev2@apple.com.
  • Sender: Enter the email address to send the email from. This is the “reply to” address that the email recipient can send an email to if necessary. If left empty, the sender address defaults to “finalcutserver@servername.”
  • Subject: Enter the email subject. You can enter codes to automatically add specific information to the email’s subject.
  • Message: Enter the email’s main text. You can enter codes to automatically add specific information to the email.

About Read XML and Write XML Responses

The Read XML and Write XML responses can be used together to exchange XML metadata between Final Cut Server and other applications. For example, you could create a Read XML Response that reads annotations metadata from an XML file that was exported from a Final Cut Pro project and displays that annotations metadata in the matching Final Cut Pro project asset in Final Cut Server.

The Read XML and Write XML settings are similar, therefore, only the Write XML settings are explained in this manual.

To access the Write XML response settings
  1. Click the Create button in the Administration window’s Responses pane to create a new response.

  2. Choose Write XML from the Response Action pop-up menu.

  3. Click Write XML to view the Write XML settings.

    Figure. Response window, showing the Response Action pop-up menu and the Write XML settings.

The Write XML pane contains the following settings:

  • Use ID for Filename: Select this checkbox to change an asset’s filename to a unique Final Cut Server asset or production ID number. This change will only apply to assets modified using a Read XML or Write XML response.
  • Production: Enter a name to create a new production that the asset aliases are added to. Alternatively, click Choose to search for an existing production to add the asset aliases to.

About Running External Scripts and Commands Responses

External scripts and commands responses are useful when you need to have a response that performs actions beyond those that Final Cut Server provides. For example, you could create a script that adds a new folder to a device whenever a new production is created. You could even specify parameters that would name the folder the same as the title of the production.

You can use this response to run more than just scripts—you can use it to run just about any executable file.

To access the “run an external script or command” response settings
  1. Click the Create button in the Administration window’s Responses pane to create a new response.

  2. Choose “Run an external script or command” from the Response Action pop-up menu.

  3. Click Run Script to view the Run Script settings.

The Run Script pane of the Response window contains the settings for configuring the script to run.

Figure. Response window, showing the Response Action pop-up menu and the Run Script settings.

The Run Script pane contains the following settings:

  • Command Path: Enter the path and name of the script or other executable file this response runs.
  • Command Parameters: Enter special parameters that can be used to customize the script that runs. For example, you can specify codes, such as [Title], that the script can use; this is similar to how they are used with email responses.

    Important: If you are running a script interpreter such as osacript and you want to pass the script itself as an argument, put the path to the script interpreter in the command path and put the script’s path in the command arguments. Otherwise if the script itself is executable, it can be run directly via the command path.

About Check the Disk Space of the Database Volume Responses

Check the disk space of the database volume responses are useful to make sure that you are warned if your Final Cut Server catalog database is in danger of running out of disk space.

Important: This only applies to the catalog’s database file and does not apply to the assets stored on the various devices.

The typical use of this response would be to create a daily schedule that uses this response to check the amount of free disk space available for the database. The response writes a value to the log showing the amount of free disk space. If that value is lower than the warning level you entered in the response, a warning is issued, with the idea being that you could have a subscription that emails you when this warning occurs.

To access the “Check the disk space of the database volume” response settings
  1. Click the Create button in the Administration window’s Responses pane to create a new response.

  2. Choose “Check the disk space of the database volume” from the Response Action pop-up menu.

  3. Click Check Database Disk Space to view the Check Database Disk Space settings.

Figure. Response window, showing the Response Action pop-up menu and the Check Database Disk Space settings.

The Check Database Disk Space pane of the Response window contains the following setting:

  • Disk space warning level: Enter a value (in bytes) that defines the minimum threshold for disk space availability for the Final Cut Server catalog’s database. If you do not enter a value, a default setting of 500 MB is used (shown as a value of 0). For example, to set the minimum threshold to 50 MB, enter the value 50000000.