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

Dropbox 193.4.5594 - Cloud backup and sy...
Dropbox is a file hosting service that provides cloud storage, file synchronization, personal cloud, and client software. It is a modern workspace that allows you to get to all of your files, manage... Read more
Google Chrome 122.0.6261.57 - Modern and...
Google Chrome is a Web browser by Google, created to be a modern platform for Web pages and applications. It utilizes very fast loading of Web pages and has a V8 engine, which is a custom built... Read more
Skype 8.113.0.210 - Voice-over-internet...
Skype is a telecommunications app that provides HD video calls, instant messaging, calling to any phone number or landline, and Skype for Business for productive cooperation on the projects. This... Read more
Tor Browser 13.0.10 - Anonymize Web brow...
Using Tor Browser you can protect yourself against tracking, surveillance, and censorship. Tor was originally designed, implemented, and deployed as a third-generation onion-routing project of the U.... Read more
Deeper 3.0.4 - Enable hidden features in...
Deeper is a personalization utility for macOS which allows you to enable and disable the hidden functions of the Finder, Dock, QuickTime, Safari, iTunes, login window, Spotlight, and many of Apple's... Read more
OnyX 4.5.5 - Maintenance and optimizatio...
OnyX is a multifunction utility that you can use to verify the startup disk and the structure of its system files, to run miscellaneous maintenance and cleaning tasks, to configure parameters in the... Read more
Hopper Disassembler 5.14.1 - Binary disa...
Hopper Disassembler is a binary disassembler, decompiler, and debugger for 32- and 64-bit executables. It will let you disassemble any binary you want, and provide you all the information about its... Read more

Latest Forum Discussions

See All

Zenless Zone Zero opens entries for its...
miHoYo, aka HoYoverse, has become such a big name in mobile gaming that it's hard to believe that arguably their flagship title, Genshin Impact, is only three and a half years old. Now, they continue the road to the next title in their world, with... | Read more »
Live, Playdate, Live! – The TouchArcade...
In this week’s episode of The TouchArcade Show we kick things off by talking about all the games I splurged on during the recent Playdate Catalog one-year anniversary sale, including the new Lucas Pope jam Mars After Midnight. We haven’t played any... | Read more »
TouchArcade Game of the Week: ‘Vroomies’
So here’s a thing: Vroomies from developer Alex Taber aka Unordered Games is the Game of the Week! Except… Vroomies came out an entire month ago. It wasn’t on my radar until this week, which is why I included it in our weekly new games round-up, but... | Read more »
SwitchArcade Round-Up: ‘MLB The Show 24’...
Hello gentle readers, and welcome to the SwitchArcade Round-Up for March 15th, 2024. We’re closing out the week with a bunch of new games, with Sony’s baseball franchise MLB The Show up to bat yet again. There are several other interesting games to... | Read more »
Steam Deck Weekly: WWE 2K24 and Summerho...
Welcome to this week’s edition of the Steam Deck Weekly. The busy season has begun with games we’ve been looking forward to playing including Dragon’s Dogma 2, Horizon Forbidden West Complete Edition, and also console exclusives like Rise of the... | Read more »
Steam Spring Sale 2024 – The 10 Best Ste...
The Steam Spring Sale 2024 began last night, and while it isn’t as big of a deal as say the Steam Winter Sale, you may as well take advantage of it to save money on some games you were planning to buy. I obviously recommend checking out your own... | Read more »
New ‘SaGa Emerald Beyond’ Gameplay Showc...
Last month, Square Enix posted a Let’s Play video featuring SaGa Localization Director Neil Broadley who showcased the worlds, companions, and more from the upcoming and highly-anticipated RPG SaGa Emerald Beyond. | Read more »
Choose Your Side in the Latest ‘Marvel S...
Last month, Marvel Snap (Free) held its very first “imbalance" event in honor of Valentine’s Day. For a limited time, certain well-known couples were given special boosts when conditions were right. It must have gone over well, because we’ve got a... | Read more »
Warframe welcomes the arrival of a new s...
As a Warframe player one of the best things about it launching on iOS, despite it being arguably the best way to play the game if you have a controller, is that I can now be paid to talk about it. To whit, we are gearing up to receive the first... | Read more »
Apple Arcade Weekly Round-Up: Updates an...
Following the new releases earlier in the month and April 2024’s games being revealed by Apple, this week has seen some notable game updates and events go live for Apple Arcade. What The Golf? has an April Fool’s Day celebration event going live “... | Read more »

Price Scanner via MacPrices.net

Apple Education is offering $100 discounts on...
If you’re a student, teacher, or staff member at any educational institution, you can use your .edu email address when ordering at Apple Education to take $100 off the price of a new M3 MacBook Air.... Read more
Apple Watch Ultra 2 with Blood Oxygen feature...
Best Buy is offering Apple Watch Ultra 2 models for $50 off MSRP on their online store this week. Sale prices available for online orders only, in-store prices may vary. Order online, and choose... Read more
New promo at Sams Club: Apple HomePods for $2...
Sams Club has Apple HomePods on sale for $259 through March 31, 2024. Their price is $40 off Apple’s MSRP, and both Space Gray and White colors are available. Sale price is for online orders only, in... Read more
Get Apple’s 2nd generation Apple Pencil for $...
Apple’s Pencil (2nd generation) works with the 12″ iPad Pro (3rd, 4th, 5th, and 6th generation), 11″ iPad Pro (1st, 2nd, 3rd, and 4th generation), iPad Air (4th and 5th generation), and iPad mini (... Read more
10th generation Apple iPads on sale for $100...
Best Buy has Apple’s 10th-generation WiFi iPads back on sale for $100 off MSRP on their online store, starting at only $349. With the discount, Best Buy’s prices are the lowest currently available... Read more
iPad Airs on sale again starting at $449 on B...
Best Buy has 10.9″ M1 WiFi iPad Airs on record-low sale prices again for $150 off Apple’s MSRP, starting at $449. Sale prices for online orders only, in-store price may vary. Order online, and choose... Read more
Best Buy is blowing out clearance 13-inch M1...
Best Buy is blowing out clearance Apple 13″ M1 MacBook Airs this weekend for only $649.99, or $350 off Apple’s original MSRP. Sale prices for online orders only, in-store prices may vary. Order... Read more
Low price alert! You can now get a 13-inch M1...
Walmart has, for the first time, begun offering new Apple MacBooks for sale on their online store, albeit clearance previous-generation models. They now have the 13″ M1 MacBook Air (8GB RAM, 256GB... Read more
Best Apple MacBook deal this weekend: Get the...
Apple has 13″ M2 MacBook Airs available for only $849 today in their Certified Refurbished store. These are the cheapest M2-powered MacBooks for sale at Apple. Apple’s one-year warranty is included,... Read more
New 15-inch M3 MacBook Air (Midnight) on sale...
Amazon has the new 15″ M3 MacBook Air (8GB RAM/256GB SSD/Midnight) in stock and on sale today for $1249.99 including free shipping. Their price is $50 off MSRP, and it’s the lowest price currently... Read more

Jobs Board

Early Preschool Teacher - Glenda Drive/ *Appl...
Early Preschool Teacher - Glenda Drive/ Apple ValleyTeacher Share by Email Share on LinkedIn Share on Twitter Read more
Senior Software Engineer - *Apple* Fundamen...
…center of Microsoft's efforts to empower our users to do more. The Apple Fundamentals team focused on defining and improving the end-to-end developer experience in Read more
Relationship Banker *Apple* Valley Main - W...
…Alcohol Policy to learn more. **Company:** WELLS FARGO BANK **Req Number:** R-350696 **Updated:** Mon Mar 11 00:00:00 UTC 2024 **Location:** APPLE VALLEY,California Read more
Medical Assistant - Surgical Oncology- *Apple...
Medical Assistant - Surgical Oncology- Apple Hill WellSpan Medical Group, York, PA | Nursing | Nursing Support | FTE: 1 | Regular | Tracking Code: 200555 Apply Now Read more
Early Preschool Teacher - Glenda Drive/ *Appl...
Early Preschool Teacher - Glenda Drive/ Apple ValleyTeacher Share by Email Share on LinkedIn Share on Twitter Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.