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.

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

Iridient Developer 3.5.1 - Powerful imag...
Iridient Developer (was RAW Developer) is a powerful image-conversion application designed specifically for OS X. Iridient Developer gives advanced photographers total control over every aspect of... Read more
CleanMyMac X 4.7.1 - Delete files that w...
CleanMyMac makes space for the things you love. Sporting a range of ingenious new features, CleanMyMac lets you safely and intelligently scan and clean your entire system, delete large, unused files... Read more
Yojimbo 4.6 - Data organizer.
Yojimbo empowers Mac users to manage, effortlessly and securely, the onslaught of information encountered every day at work and at home, even across multiple computers. Yojimbo stores different data... Read more
VMware Fusion 12.1.0 - Run Windows apps...
VMware Fusion and Fusion Pro - virtualization software for running Windows, Linux, and other systems on a Mac without rebooting. The latest version includes full support for Windows 10, macOS Mojave... Read more
DiskCatalogMaker 8.2.7 - Catalog your di...
DiskCatalogMaker is a simple disk management tool which catalogs disks. Simple, light-weight, and fast Finder-like intuitive look and feel Super-fast search algorithm Can compress catalog data for... Read more
Bartender 3.1.25 - Organize your menu-ba...
Bartender lets you organize your menu-bar apps by hiding them, rearranging them, or moving them to Bartender's Bar. You can display the full menu bar, set options to have menu-bar items show in the... Read more
TotalFinder 1.13.7 - Adds tabs, hotkeys,...
TotalFinder is a universally acclaimed navigational companion for your Mac. Enhance your Mac's Finder with features so smart and convenient, you won't believe you ever lived without them. Features... Read more
SyncTwoFolders 2.3.6b2 - Syncs two user-...
SyncTwoFolders simply synchronizes two folders. It supports synchronization across mounted network drives and it is a possibility to run a simulation showing in a log what will be done. Please visit... Read more
PDFpenPro 12.2.1 - Advanced PDF toolkit...
PDFpenPro allows users to edit PDF's easily. Add text, images and signatures. Fill out PDF forms. Merge or split PDF documents. Reorder and delete pages. Create fillable forms and tables of content... Read more
PDFpen 12.2.1 - Edit and annotate PDFs w...
PDFpen allows users to easily edit PDF's. Add text, images and signatures. Fill out PDF forms. Merge or split PDF documents. Reorder and delete pages. Even correct text and edit graphics! Features... Read more

Latest Forum Discussions

See All

Lara Croft returns in Tomb Raider Reload...
Square Enix has unveiled the next entry in the Tomb Raider series, this time headed for mobile platforms sometime in 2021. [Read more] | Read more »
Genshin Impact - Fallen Star Challenge G...
| Read more »
New update for The Battle of Polytopia p...
The Battle of Polytopia released on PC back in August of this year with iOS and Android versions being dated too far behind. But now developer Midjiwan AB has released the Moonrise update to put it on the same level as its PC counterpart, bringing... | Read more »
Transport City: Truck Tycoon is a logist...
Transport City: Truck Tycoon is a brand new simulation game from developer Cupgum that's available now for iOS and Android. As you can probably guess from the name of the game it'll see you working on building a supply chain and logistics setup... | Read more »
Bridge Constructor: The Walking Dead is...
Headup Games' team up with their popular bridge-building franchise and AMC's zombie TV is now available for iOS and Android. Bridge Constructor: The Walking Dead is the latest game in the series and the second to make use of another IP after... | Read more »
Genshin Impact - How to Beat Tartaglia (...
In the 1.1 update to Genshin Impact, the final chapter to the story arc in Liyue reaches its climax with a fight against Tartaglia (AKA Childe), one of the Fatui Harbingers. We won't go into detail as to why this is or the circumstances of the... | Read more »
Genshin Impact - Unreconciled Stars Even...
Genshin Impact's 1.1 update has brought a ton of new content to the game, and one of these things is a brand new event: Unreconciled Stars. This event kicked off yesterday and is running through the end of the month. There are sweet rewards and... | Read more »
The next expansion for Gwent, “Way of th...
CD Projekt Red has announced Way of the Witcher, the next free expansion for its card game, Gwent: The Witcher Card Game. You won’t have long to wait either, as it’s coming to the game on 8th December. [Read more] | Read more »
Distract Yourself With These Great Mobil...
There’s a lot going on right now, and I don’t really feel like trying to write some kind of pithy intro for it. All I’ll say is lots of people have been coming together and helping each other in small ways, and I’m choosing to focus on that as I... | Read more »
FMV thriller The Complex coming to iOS a...
Wales Interactive has announced its interactive FMV sci-fi thriller, The Complex, is coming to iOS and Android on 3rd December. [Read more] | Read more »

Price Scanner via MacPrices.net

Black Friday week 2020 sale: 27″ 5K 6-Core iM...
Amazon has Apple’s 2020 27″ 5K 6-Core iMacs on sale for $150-$250 off MSRP today as part of their Black Friday week 2020 sale. Their price for the 3.3GHz model reflects an extra $150 instant discount... Read more
Black Friday week 2020 sale at B&H: Hot n...
B&H Photo has new 2020 10.9″ Apple iPad Airs in stock and on sale today for up to $50 off MSRP as part of their Black Friday week 2020 sale. Expedited shipping is free to most addresses in the US... Read more
Black Friday week 2020 at Amazon: Take up to...
Amazon has Apple Watch Series 6 models on sale for $50-$110 off Apple’s MSRP as part of their Black Friday week 2020 sales. These are the same Watches sold by Apple in their retail and online stores... Read more
Get a 16″ MacBook Pro for up to $740 off MSRP...
Apple has standard-configuration Certified Refurbished 2019 16″ MacBook Pros available for up to $420 off the cost of new models, starting at $2039. Each model features a new outer case, shipping is... Read more
Best Black Friday week 2020 deals: New 13″ Ma...
Apple resellers have new 13″ MacBook Pros with M1 Apple Silicon CPUs in stock and on sale for this Black Friday week 2020. Save $50-$71 off Apple’s standard MSRP, or save on sales tax in many US... Read more
Xfinity Mobile Black Friday/Cyber Monday 2020...
Xfinity Mobile has announced their Black Friday/Cyber Monday Apple iPhone deals for 2020. These offers are available starting today on their site and last through December 7th, or while supplies last... Read more
Apple announces Black Friday/Cyber Monday 4-D...
Apple has announced their deals for the four day Black Friday/Cyber Monday 2020 event. Receive a free $200 Apple Store gift card with the purchase of select Macs and $50-$100 with various iPads. Get... Read more
Black Friday 2020 Sale: 13″ 2.0GHz Intel MacB...
Amazon has 2020 13″ MacBook Pros with 10th generation Intel CPUs on sale for $250-$200 off Apple’s MSRP as part of their Black Friday week 2020 sale. Shipping is free. Be sure to purchase the MacBook... Read more
Black Friday 2020 Sale: 12.9″ Apple iPad Pros...
Amazon has new 2020 Apple 12.9″ iPad Pros on sale today for up to $150 off MSRP, with prices starting at $899, as part of their Black Friday week 2020 sale. Shipping is free. These are the same iPad... Read more
Black Friday 2020 Sale! Amazon offers new 11″...
Amazon has 2020 11″ iPad Pros on sale for up to $150 off Apple’s MSRP as part of their Black Friday week 2020 sale. These are the same iPad Pros sold by Apple in its retail and online stores. Be sure... Read more

Jobs Board

*Apple* Administrator - Freedom Mortgage (Un...
Apple Administrator + Job ID:8595 + Functional Area:Information Technology + Employment Type:Full Time + Location:Moorestown, NJ + Department:IT Conferencing & AV + Read more
Surgical Technologist - *Apple* Hill Surgic...
Surgical Technlogist Apple Hill Surgical Center Full Time - Day Shift - Possible Saturdays *$3,000 Sign On Bonus* *New Grads considered* Job Description: Under Read more
Geek Squad Advanced Repair *Apple* Professi...
**788646BR** **Job Title:** Geek Squad Advanced Repair Apple Professional **Job Category:** Store Associates **Store Number or Department:** 000498-Bellevue-Store Read more
Senior Software Developer - *Apple* - The W...
**SUMMARY** Hulu's Apple team is seeking a Senior Software Developer who will be an outstanding addition to our team. As a developer at Hulu, you will contribute to Read more
Senior Data Engineer - *Apple* - Theorem, L...
Job Summary Apple is seeking an experienced, detail-minded data engineeringconsultant to join our worldwide business development and strategy team. If you are Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.