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

iMazing 2.17.16 - Complete iOS device ma...
iMazing is the world’s favourite iOS device manager for Mac and PC. Millions of users every year leverage its powerful capabilities to make the most of their personal or business iPhone and iPad.... Read more
VueScan 9.8.22 - Scanner software with a...
VueScan is a scanning program that works with most high-quality flatbed and film scanners to produce scans that have excellent color fidelity and color balance. VueScan is easy to use, and has... Read more
MacPilot 15.0.2 - $15.96 (53% off)
MacPilot gives you the power of UNIX and the simplicity of Macintosh, which means a phenomenal amount of untapped power in your hands! Use MacPilot to unlock over 1,200 features, and access them all... Read more
Visual Studio Code 1.85.0 - Cross-platfo...
Visual Studio Code provides developers with a new choice of developer tool that combines the simplicity and streamlined experience of a code editor with the best of what developers need for their... Read more
Spotify 1.2.26.1187 - Stream music, crea...
Spotify is a streaming music service that gives you on-demand access to millions of songs. Whether you like driving rock, silky R&B, or grandiose classical music, Spotify's massive catalogue puts... Read more
Transmission 4.0.5 - Popular BitTorrent...
Transmission is a fast, easy, and free multi-platform BitTorrent client. Transmission sets initial preferences so things "just work", while advanced features like watch directories, bad peer blocking... Read more
Fantastical 3.8.9 - Create calendar even...
Fantastical is the Mac calendar you'll actually enjoy using. Creating an event with Fantastical is quick, easy, and fun: Open Fantastical with a single click or keystroke Type in your event details... Read more
Notion 3.0.0 - A unified workspace for m...
Notion is the unified workspace for modern teams. Features: Integration with Slack Documents Wikis Tasks Release notes were unavailable when this listing was updated. Download Now]]> Read more
GarageBand 10.4.10 - Complete recording...
GarageBand is the easiest way to create a great-sounding song on your Mac. Add realistic, impeccably produced and performed drum grooves to your song with Drummer. Easily shape the sound of any... Read more
Pacifist 4.1.0 - Install individual file...
Pacifist opens up .pkg installer packages, .dmg disk images, .zip, .tar. tar.gz, .tar.bz2, .pax, and .xar archives and more, and lets you extract or install individual files out of them. This is... Read more

Latest Forum Discussions

See All

Best iPhone Game Updates: ‘Bloons TD 6’,...
Hello everyone, and welcome to the week! It’s time once again for our look back at the noteworthy updates of the last seven days. We’re getting well into the month now, which means we’ll be seeing more holiday-themed updates this time. Only a couple... | Read more »
‘DOOM’ 30th Anniversary Stream Featuring...
id Software’s DOOM ($4.99) celebrated its 30th anniversary over the weekend. While I didn’t play it literally when it launched, I adored the shareware version I played hundreds of times until I finally got the full game. | Read more »
‘Shadowverse: Worlds Beyond’ Is a New Fr...
At its Shadowverse Next 2024 event, Cygames announced Shadowverse: Worlds Beyond for iOS, Android, and PC. This new game will have many new features including a lobby system that allows you to play Mahjong, go fishing, and more. If you ever wanted... | Read more »
Fontaine frolics in a festival with the...
Fontaine has finally overcome a fairly turbulent time and it's time to get back to the important things in Genshin Impact. Version 4.3, Roses and Muskets, will kick off December 20th and bring Travelers to one of the nation's most important events... | Read more »
TouchArcade Game of the Week: ‘Sonic Dre...
I can still remember the time I played my first 3D Sonic game. It was at Hollywood Video (that’s a video rental store for you young ones out there) and my buddy was the manager, and he invited me and my friend to hang out in the store after they... | Read more »
SwitchArcade Round-Up: Strictly Limited...
Hello gentle readers, and welcome to the SwitchArcade Round-Up for December 8th, 2023. In today’s article, we start off with a couple of news items. Nothing from The Game Awards, that’s a bit beyond the scope of what I usually do here. But I do have... | Read more »
Football Manager 2024 Interview – We Tal...
Last month, SEGA and Sports Interactive released Football Manager 2024 on Apple Arcade (Touch), Netflix (Mobile), consoles, PC, and even Game Pass. If you missed my detailed review covering many versions of the game, read it here. | Read more »
‘Shiren the Wanderer: The Mystery Dungeo...
Recently, my son and I were invited to attend a special hands-on preview event at Spike Chunsoft’s headquarters in Tokyo to play the upcoming Shiren the Wanderer: The Mystery Dungeon of Serpentcoil Island for Nintendo Switch, which is scheduled for... | Read more »
Apple Arcade Weekly Round-Up: Updates fo...
We just had a huge content drop on Apple Arcade earlier this week with Sonic Dream Team, Disney Dreamlight Valley, Puzzles and Dragons, and more hitting the service. Today (and as of a few days ago), many notable games on the service have gotten... | Read more »
‘Genshin Impact’ Version 4.3 Update “Ros...
Following two trailers during The Game Awards 2023, HoYoverse has more news today with the next major Genshin Impact (Free) update detailed for all platforms. | Read more »

Price Scanner via MacPrices.net

13-inch M2 MacBook Airs are on Holiday sale f...
Best Buy has Apple 13″ MacBook Airs with M2 CPUs in stock and back on Holiday sale for $150-$200 off MSRP in Space Gray, Silver, Starlight, and Midnight colors. Their prices are among the lowest... Read more
15-inch M2 MacBook Airs are back on Holiday s...
Apple retailers have 15-inch M2 MacBook Air back on Holiday sale for $250 off MSRP. Here is where to find the cheapest 15″ Air today: (1): Apple 15-inch MacBook Airs with M2 CPUs are in stock and on... Read more
Update: Apple Watch Series 9 models now $70 o...
Walmart has Apple Watch Series 9 models on Holiday sale for $70 off MSRP on their online store this weekend (that’s $20 cheaper than their earlier price). Sale prices available for online orders only... Read more
Apple’s AirTags 4-Pack is on Holiday sale for...
Apple retailers have 4-pack AirTags on sale this weekend for $19 off MSRP as part of their Holiday sales. These make a great stocking stuffer: (1): Amazon has Apple AirTags 4 Pack on sale for $79.99... Read more
Sunday Sale: $100 off every Apple iPad mini 6
Amazon is offering Apple’s 8.3″ iPad minis for $100 off MSRP, including free shipping, as part of their Holiday sale this weekend. Prices start at $399. Amazon’s prices are the lowest currently... Read more
16-inch M3 Pro MacBook Pros (18GB/512GB) are...
Looking for the best price on a 16″ M3 Pro MacBook Pro this Holiday shopping season? B&H and Amazon are currently offering a $250 discount on the 16″ M3 Pro MacBook Pro (18GB RAM/512GB SSD),... Read more
Apple Watch SE models on Holiday sale for $50...
Walmart has Apple Watch SE GPS-only models on Holiday sale on their online store for $50 off MSRP this weekend. Sale prices for online orders only, in-store prices may vary. Order online, and choose... Read more
Apple Watch Series 9 models on Holiday sale t...
Walmart has Apple Watch Series 9 models on Holiday sale for $50 off MSRP on their online store this weekend. Sale prices available for online orders only, in-store prices may vary. Order online, and... Read more
Apple has the 13-inch M2 MacBook Air in stock...
Apple has Certified Refurbished 13″ M2 MacBook Airs available starting at only $929 and ranging up to $210 off MSRP. These are the cheapest M2-powered MacBooks for sale at Apple. Apple’s one-year... Read more
Apple’s 10th-generation iPads on Holiday sale...
Amazon has Apple’s 10th-generation WiFi iPads on sale for $100 off MSRP, starting at only $349, as part of their Holiday sales this weekend. With the discount, Amazon’s prices are the lowest we’ve... Read more

Jobs Board

Principal Offering Sales - Modern Workplace...
…Job Description **Who you are** + **Drives Modern Workplace sale, focusing on Apple Managed Services across the enterprise globally.** + **Owns the Apple Read more
Material Handler 1 - *Apple* (1st shift) -...
Material Handler 1 - Apple (1st shift)Apply now " Apply now + Start apply with LinkedIn + Apply Now Start + Please wait Date:Dec 8, 2023 Location: Irwindale, CA, US, Read more
Macintosh/ *Apple* Systems Administrator, TS...
…to a team-based environment. + Perform systems administration support tasks for Apple MacOS and iOS operating systems. + TDY travel (approximately 25%) for Read more
Principal Offering Sales - Modern Workplace...
…Job Description **Who you are** + **Drives Modern Workplace sale, focusing on Apple Managed Services across the enterprise globally.** + **Owns the Apple Read more
*Apple* Systems Administrator - JAMF - Activ...
…**Public Trust/Other Required:** None **Job Family:** Systems Administration **Skills:** Apple Platforms,Computer Servers,Jamf Pro **Experience:** 3 + years of Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.