TweetFollow Us on Twitter

Becoming More Efficient through Folder Watching

Volume Number: 20 (2004)
Issue Number: 7
Column Tag: Programming

AppleScript Essentials

by Benjamin S. Waldie

Becoming More Efficient through Folder Watching

For the past several months, we have explored various aspects of AppleScripting in Mac OS X. We have discussed some basic Finder scripting, adding repeat loops and if/then statements to our scripts, and more. This month, we will explore a topic of frequent interest to those who want to automate various aspects of their workflow - folder watching.

Folder Watching

Folder watching is a common automation technique that can be used to make virtually any workflow more efficient. By configuring AppleScripts to monitor folders for new items to arrive, users are able to set up watched folders to automatically process incoming items.

Folder watching can be extremely useful in a variety of situations. For example, let's say that a user in your office copies files into a drop box on your computer at various times throughout the day. Whenever these files arrive, they need to be processed. Since you have other work to do too, you may not be able to monitor the drop box for new files on a regular basis. To assist with the process, you could create an AppleScript that monitors this drop box for you, and then notifies you whenever a new item is detected. Once notified, you could manually process the detected files. Or, you could write additional AppleScript code to process the files for you, completely removing all aspects of manual processing.

In some cases, you need to configure a large number of watched folders for multiple workflows. A common technique for dealing with this type of situation is to set up an AppleScript server. In other words, any dedicated Mac whose primary purpose is to watch these folders for new items, and then process the detected items. By integrating a dedicated folder watching machine into a workflow, users are able to hand off their files for processing, freeing them to work on other less time consuming and repetitive tasks.

In this article, we will discuss some basic ways to create a folder watching script. Then, you can expand these techniques in order to create more complex automated systems.

Idle Folder Watching

One method for writing a script that will watch a folder is to create an AppleScript that has been saved as a stay open application and makes use of AppleScript's idle handler. A stay open application is a script that, when launched, will remain open until manually quit by the user, or told to quit by the script itself, or by another script.

on idle
   -- Add code here to watch the folder
end idle

Handlers are an important, yet fairly complex topic. I will explain handlers in detail in a future article. In the meantime, this tech-note provides a very brief overview of a handler.

A handler is a group of AppleScript statements that may be executed with a single command. There are two types of handlers in AppleScript - subroutine handlers and command handlers. Subroutine handlers are groups of statements, which are defined by the developer, and called throughout a script, or from another script. A command handler is a group of statements that is triggered by an event, such as when a script is run, opened, quit, or idle. The idle handler is considered to be a command handler.

An idle handler will always begin with an on idle line and end with an end idle line. Any AppleScript code in-between these two lines will trigger whenever the script becomes idle. In a stay open script, by default, the idle handler will trigger every 30 seconds. However, you may optionally customize this delay period by adding a line to the end of the idle handler that returns a number of seconds to delay before becoming idle again. In the code below, the script would wait 1 second between executions of the idle handler.

on idle
   -- Add code here to watch the folder
   return 1 -- The number of seconds the script should delay before being idle again
end idle

Once you have a shell for your idle handler, it is time to begin adding some folder watching code. The following example represents a very basic folder watching script. In this example, the script will monitor a user specified folder for items. Whenever items are detected in the folder, they will be moved immediately to the desktop, and the user will be notified that items were detected and moved. The idle handler in this example will trigger once every second. Of course, this example could be expanded to have much greater functionality. For example, you could write code to process only new images that are placed in the folder. The script could be written to open those images in Photoshop, perform various image manipulations, and then save the images into an output folder.

global theWatchedFolder
set theWatchedFolder to choose folder
on idle
   tell application "Finder"
      set theDetectedItems to every item of theWatchedFolder
      repeat with aDetectedItem in theDetectedItems
         move aDetectedItem to the desktop
      end repeat
   end tell
   if theDetectedItems <> {} then
      activate
      display dialog "New items were detected and moved to your desktop."
   end if
   return 1
end idle

In the example above, the first line of code indicates that the variable theWatchedFolder will be a global variable. In other words, once assigned, this variable will be available to all areas of the script, at all times. The second line of code prompts the user to choose a folder, and assigns a reference to the chosen folder to the global variable theWatchedFolder. Because these first two lines of code do not fall within the idle handler, they will only be executed when the script is initially launched.

The code within the idle handler executes after the initial code has finished running. Once executed, it determines whether any items exist in the chosen folder. If items are detected in the folder, the script moves them to the desktop, and then notifies the user that items were detected and moved.

By moving items out of the watched folder, the script ensures that the same items are not detected and reprocessed during the next idle period. If necessary, the script could instead be expanded to keep track of the items in the folder, and only process when new items are added. However, this would require quite a bit more development. Therefore, it is common practice to move files from a watched folder into an output folder once processing is complete.

As previously mentioned, idle handlers are used in scripts that have been saved as stay open applications. Therefore, in order to test the code above, you will need to save the script as a stay open application. To save a script as a stay open application, save the script as an application and select the Stay Open checkbox in Script Editor's save dialog, as shown in Figure 1.


Figure 1. Stay Open Application Save Option

You are now ready to test your script. Launch it from the Finder and select a folder. Next, try moving or copying items into the selected folder, and they should be moved to the desktop.

Folder Actions

Another method of creating a folder watching script is to make use of Mac OS X's built-in Folder Actions support. Folder Actions offer a more robust way to configure watched folders, with less coding needed.

What is a Folder Action?

A Folder Action is a specially written AppleScript, which may be attached to a folder. Folder Actions may be configured to trigger when specific types of action are taken on the folder they are attached to. Folder Actions may be written to trigger whenever:

  • A folder is opened

  • A folder's opened window is moved

  • A folder's opened window is closed

  • Items are added or removed from a folder

Information about Folder Actions, including sample code for configuring each type of Folder Action can be found on Apple Computer's web site at <http://www.apple.com/applescript/folderactions>.

Creating a Folder Action

To create a Folder Action, much like the idle handler, you add a specific handler into your script, indicating the type of action that will trigger the script. Different types of Folder Action handlers exist, and the one that you will need to use will depend on the type of action that you want to trigger your AppleScript code. A list of available Folder Action handlers can be found in the Folder Actions suite in the Standard Additions scripting addition that is installed with Mac OS X.


Figure 2. Folder Actions in the Standard Additions Scripting Addition

As you can see in Figure 2, there are several different types of Folder Action handlers that you may include in your script. Since this article specifically talks about folder watching, we will only discuss the adding folder items to Folder Action handler, which is used to process items added to a folder. However, I encourage you to try out the other types of Folder Action handlers as well.

To create a Folder Action that will process items that are moved or copied into an attached folder, add the adding folder items to Folder Action handler into your script.

on adding folder items to theWatchedFolder after receiving theDetectedItems

-- Add processing code here

end adding folder items to

In the example above, the first line of the handler contains two labeled parameters, theWatchedFolder and theDetectedItems. These parameters will pass dynamically assigned values to the script whenever the script is triggered. The parameter theWatchedFolder will contain an AppleScript alias reference to the folder that the script is attached to. The parameter theDetectedItems will contain a list of AppleScript alias references to the items that were added to the attached folder.

The on adding folder items to handler will only trigger when new items are added to the attached folder, providing to the script a list of only the newly added items. Therefore, unlike the script we created using the idle handler, we could choose to process the newly detected items, without moving them out of the watched folder.

Since, when the script is triggered, it will already have a list of newly added items, there is no need to write code to determine which items were detected. Instead, we only need to add code to process the detected items. The following example code, just like our idle handler, will move newly added items to the desktop, and then notify the user.

on adding folder items to theWatchedFolder after receiving theDetectedItems
   tell application "Finder"
      move theDetectedItems to the desktop
   end tell
   activate
   display dialog "New items were detected and moved to your desktop."
end adding folder items to

Once you have written your Folder Action script, you need to save it as a compiled script.


Figure 3. Saving a Folder Action Script

Place the saved Folder Action script into the Library > Scripts > Folder Action Scripts folder on your computer. Next, you need to actually attach the script to the folder you want to watch.

Configuring a Folder Action

To attach a Folder Action script to a folder, launch the Folder Actions Setup application, which is located in the Applications > AppleScript folder in Mac OS X 10.3 and higher. Once launched, verify that the Enable Folder Actions checkbox is selected. You must enable Folder Actions in order for them to function.


Figure 4. Enabling Folder Actions

Click the + button under the Folders with Actions field, and you will be prompted to select a folder. Make your selection, and click the Open button in the folder selection dialog window. You will then be prompted to select a Folder Action script to attach to the specified folder. Select the desired Folder Action script, and click the Attach button.


Figure 5. Selecting a Folder Action Script

As the Folder Actions Setup application interface will indicate, your Folder Action script is now attached to the folder that you specified.


Figure 6. A Configured Folder Action

Now that configuration is complete, quit the Folder Actions Setup application, and test your Folder Action script by copying or moving items into the attached folder. If everything has been properly configured, then your Folder Action script should process the items placed in the attached folder.

Please note that it is also possible to configure Folder Actions through the contextual menu in the Finder. To display the contextual menu, control click on the desired folder in the Finder.


Figure 7. Folder Action Contextual Menus

In Closing

While the idle handler method of folder watching can be useful at times, Folder Actions offer a very useful way to configure watched folders without a lot of extra coding. I strongly urge you to begin exploring Folder Actions in more detail. As you begin using them, you will wonder how you ever got along without them.

Until next time, keep scripting!


Benjamin Waldie is president of Automated Workflows, LLC, a firm specializing in AppleScript and workflow automation consulting. In addition to his role as a consultant, Benjamin is an evangelist of AppleScript, and can frequently be seen presenting at Macintosh User Groups, Seybold Seminars, and MacWorld. For additional information about Benjamin, please visit http://www.automatedworkflows.com, or email Benjamin at applescriptguru@mac.com.

 
AAPL
$102.08
Apple Inc.
+2.32
MSFT
$44.83
Microsoft Corpora
+0.75
GOOG
$523.95
Google Inc.
+3.11

MacTech Search:
Community Search:

Software Updates via MacUpdate

RapidWeaver 6.0 - Create template-based...
RapidWeaver is a next-generation Web design application to help you easily create professional-looking Web sites in minutes. No knowledge of complex code is required, RapidWeaver will take care of... Read more
NTFS 12.0.39 - Provides full read and wr...
Paragon NTFS breaks down the barriers between Windows and OS X. Paragon NTFS effectively solves the communication problems between the Mac system and NTFS, providing full read and write access to... Read more
RestoreMeNot 2.0.3 - Disable window rest...
RestoreMeNot provides a simple way to disable the window restoration for individual applications so that you can fine-tune this behavior to suit your needs. Please note that RestoreMeNot is designed... Read more
Macgo Blu-ray Player 2.10.9.1750 - Blu-r...
Macgo Mac Blu-ray Player can bring you the most unforgettable Blu-ray experience on your Mac. Overview Macgo Mac Blu-ray Player can satisfy just about every need you could possibly have in a Blu-ray... Read more
Apple iOS 8.1 - The latest version of Ap...
The latest version of iOS can be downloaded through iTunes. Apple iOS 8 comes with big updates to apps you use every day, like Messages and Photos. A whole new way to share content with your family.... Read more
TechTool Pro 7.0.5 - Hard drive and syst...
TechTool Pro is now 7, and this is the most advanced version of the acclaimed Macintosh troubleshooting utility created in its 20-year history. Micromat has redeveloped TechTool Pro 7 to be fully 64... Read more
PDFKey Pro 4.0.2 - Edit and print passwo...
PDFKey Pro can unlock PDF documents protected for printing and copying when you've forgotten your password. It can now also protect your PDF files with a password to prevent unauthorized access and/... Read more
Yasu 2.9.1 - System maintenance app; per...
Yasu was originally created with System Administrators who service large groups of workstations in mind, Yasu (Yet Another System Utility) was made to do a specific group of maintenance tasks... Read more
Hazel 3.3 - Create rules for organizing...
Hazel is your personal housekeeper, organizing and cleaning folders based on rules you define. Hazel can also manage your trash and uninstall your applications. Organize your files using a... Read more
Autopano Giga 3.7 - Stitch multiple imag...
Autopano Giga allows you to stitch 2, 20, or 2,000 images. Version 3.0 integrates impressive new features that will definitely make you adopt Autopano Pro or Autopano Giga: Choose between 9... Read more

Latest Forum Discussions

See All

Fiete – A Day on a Farm Review
Fiete – A Day on a Farm Review By Amy Solomon on October 21st, 2014 Our Rating: :: A MEMORABLE EXPERIENCEUniversal App - Designed for iPhone and iPad Fiete – A day on a farm in an interactive app for young children full of... | Read more »
Tilt to Live: Gauntlet’s Revenge is Almo...
Tilt to Live: Gauntlet’s Revenge is Almost Here Posted by Jessica Fisher on October 21st, 2014 [ permalink ] One Man Left has announced the official release date of Tilt to Live: Gauntlet’s Re | Read more »
Sago Mini Monsters Celebrates Halloween...
Sago Mini Monsters Celebrates Halloween with Fun Costumes and Special Treats. Posted by Jessica Fisher on October 21st, 2014 [ permal | Read more »
Inferno 2 Review
Inferno 2 Review By Andrew Fisher on October 21st, 2014 Our Rating: :: TWIN STICK GOODNESSUniversal App - Designed for iPhone and iPad With tight controls and awesome, stark visuals, Inferno 2 is loads of fun.   | Read more »
Clips Review
Clips Review By Jennifer Allen on October 21st, 2014 Our Rating: :: CONVENIENT PASTINGUniversal App - Designed for iPhone and iPad Making copying and pasting more powerful than usual, Clips is a great way to move stuff around.   | Read more »
MonSense Review
MonSense Review By Jennifer Allen on October 21st, 2014 Our Rating: :: ORGANIZED FINANCESiPhone App - Designed for the iPhone, compatible with the iPad Organize your finances with the quick and easy to use, MonSense.   | Read more »
This Week at 148Apps: October 13-17, 201...
Expert App Reviewers   So little time and so very many apps. What’s a poor iPhone/iPad lover to do? Fortunately, 148Apps is here to give you the rundown on the latest and greatest releases. And we even have a tremendous back catalog of reviews; just... | Read more »
Angry Birds Transformers Review
Angry Birds Transformers Review By Jennifer Allen on October 20th, 2014 Our Rating: :: TRANSFORMED BIRDSUniversal App - Designed for iPhone and iPad Transformed in a way you wouldn’t expect, Angry Birds Transformers is a quite... | Read more »
GAMEVIL Announces the Upcoming Launch of...
GAMEVIL Announces the Upcoming Launch of Mark of the Dragon Posted by Jessica Fisher on October 20th, 2014 [ permalink ] Mark of the Dragon, by GAMEVIL, put | Read more »
Interview With the Angry Birds Transform...
Angry Birds Transformers recently transformed and rolled out worldwide. This run-and-gun title is a hit with young Transformers fans, but the ample references to classic Transformers fandom has also earned it a place in the hearts of long-time... | Read more »

Price Scanner via MacPrices.net

Select MacBook Airs $100 off MSRP, free shipp...
B&H Photo has 2014 a couple of MacBook Airs on sale for $100 off MSRP. Shipping is free, and B&H charges NY sales tax only. They also include free copies of Parallels Desktop and LoJack for... Read more
13-inch 2.5GHz MacBook Pro on sale for $100 o...
B&H Photo has the 13″ 2.5GHz MacBook Pro on sale for $999.99 including free shipping plus NY sales tax only. Their price is $100 off MSRP. Read more
Strong iPhone, Mac And App Store Sales Drive...
Apple on Monday announced financial results for its fiscal 2014 fourth quarter ended September 27, 2014. The Company posted quarterly revenue of $42.1 billion and quarterly net profit of $8.5 billion... Read more
Apple Posts How-To For OS X Recovery
OS X 10.7 Lion and later include OS X Recovery. This feature includes all of the tools you need to reinstall OS X, repair your disk, and even restore from a Time Machine backup. OS X Recovery... Read more
Mac OS X Versions (Builds) Supported By Vario...
Apple Support has posted a handy resource explaining which Mac OS X versions (builds) originally shipped with or are available for your computer via retail discs, downloads, or Software Update. Apple... Read more
Deals on 2011 13-inch MacBook Airs, from $649
Daily Steals has the Mid-2011 13″ 1.7GHz i5 MacBook Air (4GB/128GB) available for $699 with a 90 day warranty. The Mid-2011 13″ 1.7GHz i5 MacBook Air (4GB/128GB SSD) is available for $649 at Other... Read more
2013 15-inch 2.0GHz Retina MacBook Pro availa...
B&H Photo has leftover previous-generation 15″ 2.0GHz Retina MacBook Pros now available for $1599 including free shipping plus NY sales tax only. Their price is $400 off original MSRP. B&H... Read more
Updated iPad Prices
We’ve updated our iPad Air Price Tracker and our iPad mini Price Tracker with the latest information on prices and availability from Apple and other resellers, including the new iPad Air 2 and the... Read more
Apple Pay Available to Millions of Visa Cardh...
Visa Inc. brings secure, convenient payments to iPad Air 2 and iPad mini 3as well as iPhone 6 and 6 Plus. Starting October 20th, eligible Visa cardholders in the U.S. will be able to use Apple Pay,... Read more
Textkraft Pocket – the missing TextEdit for i...
infovole GmbH has announced the release and immediate availability of Textkraft Pocket 1.0, a professional text editor and note taking app for Apple’s iPhone. In March 2014 rumors were all about... Read more

Jobs Board

Senior Event Manager, *Apple* Retail Market...
…This senior level position is responsible for leading and imagining the Apple Retail Team's global event strategy. Delivering an overarching brand story; in-store, Read more
*Apple* Solutions Consultant (ASC) - Apple (...
**Job Summary** The ASC is an Apple employee who serves as an Apple brand ambassador and influencer in a Reseller's store. The ASC's role is to grow Apple Read more
Project Manager / Business Analyst, WW *Appl...
…a senior project manager / business analyst to work within our Worldwide Apple Fulfillment Operations and the Business Process Re-engineering team. This role will work Read more
*Apple* Retail - Multiple Positions (US) - A...
Job Description: Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
Position Opening at *Apple* - Apple (United...
…customers purchase our products, you're the one who helps them get more out of their new Apple technology. Your day in the Apple Store is filled with a range of Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.