Share Monitor 4 User Manual Copyright © 2012 Apple Inc. All rights reserved. Note: Because Apple frequently releases new versions and updates to its system software, applications, and Your rights to the software are governed by the Internet sites, images shown in this manual may be slightly accompanying software license agreement. The owner or different from what you see on your screen. authorized user of a valid copy of Compressor, Final Cut Pro, or Motion software may reproduce this Apple publication for the purpose of learning to use such 1 Infinite Loop software. No part of this publication may be reproduced Cupertino, CA 95014 or transmitted for commercial purposes, such as selling 408-996-1010 copies of this publication or for providing paid for support www.apple.com services. Apple, the Apple logo, Final Cut, and Final Cut Pro are The Apple logo is a trademark of Apple Inc., registered in trademarks of Apple Inc., registered in the U.S. and other the U.S. and other countries. Use of the “keyboard” Apple countries. logo (Shift-Option-K) for commercial purposes without the prior written consent of Apple may constitute UNIX is a registered trademark of The Open Group. trademark infringement and unfair competition in violation Other company and product names mentioned herein of federal and state laws. are trademarks of their respective companies. Mention of Every effort has been made to ensure that the information third-party products is for informational purposes only in this manual is accurate. Apple is not responsible for and constitutes neither an endorsement nor a printing or clerical errors. recommendation. Apple assumes no responsibility with regard to the performance or use of these products. Contents
Preface 5 Welcome to Share Monitor 5 About Share Monitor 5 About the Share Monitor Documentation 6 Additional Resources
Chapter 1 7 Using Share Monitor 8 About the Share Monitor Main Window 11 About the Info Window 11 Viewing or Changing the Status of a Submitted Batch 13 Share Monitor and Distributed Processing 14 Share Monitor Preferences
3
Welcome to Share Monitor Preface
Share Monitor is an easy-to-use application for viewing or adjusting the status of batches and jobs processed by Compressor, Apple Qmaster, Final Cut Pro, and Motion.
This preface covers the following: • About Share Monitor (p. 5) • About the Share Monitor Documentation (p. 5) • Additional Resources (p. 6)
About Share Monitor You use Share Monitor to monitor the transcoding progress of batches and jobs. You can pause, resume, cancel, and get the status for any submitted batch or any individual job, target, or target segment. You can also use Share Monitor to view detailed history for recently completed batches and jobs.
Important: Share Monitor 4 is designed to work closely with Final Cut Pro X and later and Motion 5 and later. All mentions of Final Cut Pro and Motion in this document refer to these versions.
About the Share Monitor Documentation The Share Monitor User Manual (this document) describes the Share Monitor application only. For information about Compressor and how to create a complete network for Apple Qmaster processing, see the Compressor User Manual, available in Compressor Help. • Share Monitor User Manual: This brief document describes how to use Share Monitor to monitor the transcoding progress of batches and jobs. • Compressor User Manual: This is a comprehensive document that describes the Compressor interface, commands, and menus and gives step-by-step instructions for using Compressor and accomplishing specific tasks. It also explains how to set up and maintain a distributed processing network for use with Compressor or digital visual effects software packages. It is written for users of all levels of experience.
5 • Final Cut Pro Help: This document describes how to share your projects and use Share Monitor to view the progress. • Motion Help: This document describes how to share your projects and use Share Monitor to view the progress.
Additional Resources There are a variety of Apple websites that you can visit to find additional information.
Compressor Website For general information and updates, as well as the latest news on Compressor, go to: • http://www.apple.com/finalcutpro/compressor
Apple Service and Support Websites For software updates and answers to the most frequently asked questions for all Apple products, go to the general Apple Support webpage. You’ll also have access to product specifications, reference documentation, and Apple and third-party product technical articles. • http://www.apple.com/support
For software updates, documentation, discussion forums, and answers to the most frequently asked questions for Compressor, go to: • http://www.apple.com/support/compressor
6 Preface Welcome to Share Monitor Using Share Monitor 1
Just as Printer Setup Utility allows you to view print jobs submitted to a printer, Share Monitor lets you view the status of batches submitted for processing. For example, Share Monitor displays each batch’s name, details of where it originated, the percentage of completion, and the estimated time before completion. Batches not yet running appear as pending. Each batch, job, target, and target segment includes status information and a progress bar, as well as buttons you can use to pause, resume, cancel, and get the status of a transcode that is currently in progress.
Note: The most popular use of Share Monitor is viewing the progress of the Compressor transcoding batches and Final Cut Pro or Motion sharing operations. By default, Share Monitor does not automatically open when you submit a Compressor batch. To have Share Monitor open automatically, in Compressor preferences, select “Automatically launch Share Monitor.” See the Compressor User Manual for more information. Share Monitor appears in the Dock when you start a share operation from either Final Cut Pro or Motion.
This chapter covers the following: • About the Share Monitor Main Window (p. 8) • About the Info Window (p. 11) • Viewing or Changing the Status of a Submitted Batch (p. 11) • Share Monitor and Distributed Processing (p. 13) • Share Monitor Preferences (p. 14)
7 About the Share Monitor Main Window Most of the Share Monitor controls are available in the Share Monitor main window.
Toolbar buttons User buttons Status buttons
Batch display
Cluster list
The Share Monitor main window includes the following sections:
General Interface For details about the toolbar buttons and the batch display, see the next sections. • Batch display: Provides a hierarchical display of batch, job, target, and segment information for current and completed batches. Also includes controls to pause, resume, cancel, and get status for any individual batch, job, target, or segment. • Toolbar: Use the toolbar to adjust the display of items you are monitoring. See Toolbar Buttons for details. • Cluster list: Displays a list of computers available for processing batches, including “This Computer” (the one using Share Monitor) and all enabled Apple Qmaster processing clusters on your network. Select any cluster in the list to monitor its activity. • User buttons: Click the Me button to display batches you submitted. Click All to display all batches for the selected cluster. (For information about permissions and password protection, see the “Apple Qmaster and Distributed Processing” chapter in the Compressor User Manual. • Status buttons: Click the Active button to display batches that the selected cluster is currently processing. Click Completed to display batches that the selected cluster has already completed. Click All to display all batches for the selected cluster.
8 Chapter 1 Using Share Monitor Toolbar Buttons Share Monitor contains a toolbar with the following buttons that let you adjust the display of batch status information.
Note: If the toolbar isn’t visible when you open Share Monitor, click the button in the upper-right corner of the Batch window to open it.
• Refresh: Click Refresh to update the status of a selected cluster immediately, rather than wait for the next update event. • Expand All: Reveals all job, target, and segment information for every batch. • Collapse All: Displays batch-level information only. • Sort Order: Switches the batch list between descending and ascending order.
Batch Display Batches, jobs, targets, and segments are displayed in hierarchical (nested) views. Each view in the batch view hierarchy contains a disclosure triangle. Click the disclosure triangles to reveal the next level of the hierarchy. For example, click the disclosure triangle in a batch view to reveal the jobs contained within the batch, and click the disclosure triangle in a job view to reveal the targets contained within the job.
Chapter 1 Using Share Monitor 9 Note: Completed tasks appear in the same view area.
Batch view
Job view
Target view
Segment views
• Batch view: Displays the batch name, the number of jobs and targets contained within the batch, the date and time on which the batch was submitted, the name of the user who submitted the batch, and the status. • Job view: Displays the name, the number of targets and segments contained within the job, the input file type (displayed as an icon), and the status. • Target view: Displays the type (displayed as an icon), the name, the number of segments that the target has been broken down into, and the status. • Segment view: When a batch is being processed using a cluster, this displays a description (a time-based or frame-based description of the portion of the target being processed), the machine name (service node that the segment is being processed on), the status, and the machine type (displayed as an icon). Segment information is available only while a batch is being processed.
10 Chapter 1 Using Share Monitor About the Info Window To get detailed information about any submitted batch, job, target, or segment, click its Show Info button to open a window showing information for that item.
The window displays the full text of status messages on any batch, job, target, or segment, such as Name, Submission Time, Owner, Time Elapsed, Time Remaining, Percent Complete, and Status. Click the Show Log button to display text information on any batch, job, target, or segment in a Console window. This information is useful for troubleshooting distributed processing issues, and it can be saved to a file and processed with XML tools and UNIX scripts.
The following table lists the service labels used in logs and email notifications.
Processing Notification Local Compressor service servicecontroller:com.apple.stomp.transcoder Distributed Compressor service servicecontroller:com.apple.stomp.transcoderx Distributed Apple Qmaster servicecontroller:com.apple.qmaster.executor service
Viewing or Changing the Status of a Submitted Batch You open Share Monitor to see the status of a submitted batch and all the jobs contained within it.
To open Share Monitor from Compressor Do one of the following: µ Click Share Monitor in the Batch window. µ Select the “Automatically launch Share Monitor” preference to have Share Monitor open each time you submit a batch.
To open Share Monitor from Apple Qmaster µ Click Share Monitor in the toolbar.
Chapter 1 Using Share Monitor 11 Share Monitor also opens automatically each time you submit a batch.
To open Share Monitor from Apple Qadministrator µ Choose Cluster > Show Share Monitor. To open Share Monitor from Final Cut Pro Do one of the following: µ Double-click Share Monitor in the Dock. Share Monitor appears in the Dock when you submit a Share menu option, such as sharing a project to Apple Devices. µ Open the Background Tasks window (choose Window > Background Tasks or press Command-9) and click the Open button next to the Sharing item.
To open Share Monitor from Motion Do one of the following: µ Choose Share > Show Share Monitor. µ Double-click Share Monitor in the Dock. Share Monitor appears in the Dock when you submit a Share menu option, such as sharing a project to Apple Devices.
To use Share Monitor to view the status of your batch 1 Open Share Monitor. 2 Do any of the following to view the batch processing details and take any necessary action. • To reveal information about the component parts of a batch, job, or target: Click the disclosure triangle next to the item name. • To pause a job, batch, or target: Click the corresponding Pause/Resume button. • To restart the processing for an item: Click the corresponding Pause/Resume button. • To cancel a job, batch, or target: Click its Cancel button.
Click the disclosure triangle next to an item to reveal more information.
Pause/Resume Show Info Cancel
When the progress bar reaches 100 percent, your media file has been successfully transcoded and saved in the designated destination folder. Completed batch and job items are marked “Successful” and remain in the batch display. Unsuccessful batch and job items are marked “Failed” and remain in the batch display.
12 Chapter 1 Using Share Monitor 3 Click the Show Info button for any item in the batch display to view information about that item. 4 Open the destination folder to view the newly transcoded output media file.
Share Monitor and Distributed Processing If you have set up an Apple Qmaster distributed processing system to process Compressor, Apple Qmaster, Final Cut Pro, and Motion jobs, Share Monitor will offer some additional features. For example, both administrators and client users can use Share Monitor to monitor the processing of submitted jobs. Administrators can stop or cancel any batch, as long as they have the administrator password for the cluster that is processing the batch, and users can stop or cancel their own batches.
Share Monitor and Passwords There are different kinds of passwords that may affect how you use Share Monitor. For more information, see the “Apple Qmaster and Distributed Processing” chapter in the Compressor User Manual.
Administrator Password If you create this password, administrators will need to know it in order to modify the selected cluster and to view the selected cluster’s batches in Share Monitor. To create an administrator password, click the Security tab in Apple Qadministrator.
User Password If you create this password, users will need to know it in order to submit batches to the selected cluster and to view those batches in Share Monitor. To create a user password, click the Security tab in Apple Qadministrator.
Service Node Password If you are setting up a QuickCluster, other users will be required to enter this password before being allowed to submit remote requests to the computer.
If you are setting up a cluster to use with Apple Qadministrator, an administrator will be required to enter this password before being allowed to add the computer to a cluster. To create a service node password, select the “Require password” checkbox in the Apple Qmaster Sharing window of Compressor.
Viewing or Changing Batch Status for Distributed Processing Depending on how you open Share Monitor, the application may have slightly different views, with different levels of control.
Chapter 1 Using Share Monitor 13 To view or change batch status 1 Open Share Monitor in one of the following ways. • Administrators who want to see or modify the status of batches: Choose Cluster > Show Share Monitor when Apple Qadministrator is open. • Users who want to see the status of batches and modify the status of their own batches: Use the Share Monitor window that opens when you open it from Compressor, Apple Qmaster, Final Cut Pro, or Motion. For more information, see Viewing or Changing the Status of a Submitted Batch. 2 Choose the cluster whose activity you want to view from the Cluster list. 3 View the batch processing details and take any necessary action. Note: Client users cannot modify other users’ batches. When they select a batch or job submitted by another user, the Cancel and Pause/Resume buttons are not available.
For more details, see Setting Share Monitor Preferences and Viewing or Changing the Status of a Submitted Batch.
Share Monitor Preferences You can use the Share Monitor Preferences window to configure several aspects of Share Monitor. Most of the information displayed in Share Monitor can be shown or hidden using settings in Share Monitor preferences.
About the Share Monitor Preferences Window The Share Monitor Preferences window includes the following view options and network options:
14 Chapter 1 Using Share Monitor View Options • Show Jobs: Select this checkbox to show job views (and target and segment views) in the Share Monitor batch display. • Show Targets: Select this checkbox to show target views (and segment views) in the Share Monitor batch display. • Show Segments: Select this checkbox to show segment views in the Share Monitor batch display. • Update status every # seconds field: Enter the number of seconds between updates from processing computers to control how often Share Monitor information is updated. The Status Interval setting in Apple Qadministrator cluster preferences takes precedence over the update frequency setting in Share Monitor preferences. Share Monitor can provide new status information only as often as it receives it from the cluster controller, as set in the Status Interval field of the Apple Qadministrator Cluster Preferences window. For more information, see “Setting Preferences” in the Apple Qadministrator User Manual.
Network Options • Monitor non-Bonjour hosts table: This table displays information about remote host computers. • Add/Remove button: Use the button to add or remove information about remote host computers.
Remote Computer Address Dialog This dialog is displayed when you click the Add/Remove button in the main Preferences window. Use this dialog to enter IP addresses or ranges for manually selected computers. • Host/Host IP address range buttons: These buttons control whether this dialog is in IP address mode (in which you enter a specific address) or IP address range mode (in which you enter a range of addresses). • Host: Use this mode to enter a host name and IP address for a specific remote computer. • Host IP address range: Use this mode to enter a name and set of range numbers (Range From, Range To) for a range of remote IP addresses.
Setting Share Monitor Preferences Use the Share Monitor Preferences window to configure several aspects of Share Monitor.
To set Share Monitor preferences µ Choose Share Monitor > Preferences, or press Command-Comma (,). The Share Monitor Preferences window opens.
Any changes you make to the Share Monitor preference settings take effect only when you click OK. If you make changes but decide not to use them, click Cancel.
Chapter 1 Using Share Monitor 15