File Renamer - Lightroom Plugin

Supports batch renaming of files using search & replace, exif-based renaming, ...

Advanced users can customize renaming schemes.

Featuring:

• Multiple renaming configurations are supported via plugin-manager presets.
• Includes presets:
  • Search and Replace (does not require exiftool)
  • Exif-based File Renaming (uses exiftool, which comes built-in for all platforms).
  • Date-Time + Original Filename (see system requirements below).
• Advanced settings may be edited to modify renaming behavior.
• Puts files with name changes into a collection, to facilitate publish service synchronization...
• Test mode so you can test without altering catalog or photo files.

System Requirements

• Lightroom 5, 4, or 3.
• Windows or Mac
• Until recently (sometime in 2014), original filename support required SQLiteroom - enable Original Filenames for startup (and disable all others that are of no interest).. @now (2015), it just needs to be able to write/read-back a file renaming template which returns original filename - the "preset" (lrtemplate file) comes with the plugin, but Lr will need to be restarted after it gets copied to usable location. Note: it can still use SQLiteroom initialized data if available.

Note: using FileRenamer for "field loading" is hereby deprecated - it is now recommended to use Metato instead for metadata transformation and transfer, and FileRenamer just for renaming files.

 

*** Read the FAQ before using.
*** Read the FAQ before using.
*** Read the FAQ before using.

Quick Links (intra-page)

Background Information
Screenshots
How to Use
File Renamer FAQ (Frequently Asked Questions)
Revision History
Download

See the readme file after downloading for usage and other notes.

 

---

File Renamer - Screenshots

 

*Library* (NOT File) Menu -> Plugin Extras

Common functions are accessed via the library menu - you'll not find them in the file menu..

 

Default rename prompt:

This can be customized for special renaming needs by editing 'Advanced Settings'.

 

Background/Introduction

I wanted to rename my files in a way that native Lightroom did not support, and I'm sharing my solution with you...

 

Definitions (for the purposes of File Renamer)

Photo	Photo or video...
File	Photo or video file.

 

How to Use File Renamer

- Install (see readme file in downloaded zip file)
- Configure in plugin manager
- Library Menu

*** Read the FAQ before using.
*** Read the FAQ before using.
*** Read the FAQ before using.

 

Plugin Manager Configuration

See elare plugin framework for common settings.

Additional Settings and Controls

None

*** Read the FAQ before using.
*** Read the FAQ before using.
*** Read the FAQ before using.

 

Library Menu

Access via Lightroom's menu bar: Library Menu -> Plugin Extras

Rename Files - Start	Start here (but first, backup your catalog). - Prepares for batch rename using Lightroom proper - 'rc File Renamer' preset. - Moves headline field to temporary storage, then places new filename in headline field. 'rc File Renamer' preset will rename files according to headline field.
To be clear, and yet another reminder: there is another step in here which you must take - renaming files in Lightroom proper. That step can not be omitted !!! Please read the faq before using this plugin - thanks.
Rename Files - Finish	Invoke after batch rename using Lightroom proper, 'rc File Renamer' preset. - Moves headline field from temporary storage back to proper place.

 

*** Read the FAQ before using.
*** Read the FAQ before using.
*** Read the FAQ before using.

 

---

 

File Renamer FAQ (Frequently Asked Questions)

(no particular order)

---

These FAQs come partly from users, and partly from my imagination. Please let me know if there are errors or omissions in this FAQ - thanks.

NOTE: The following Q&A's assume that the plugin is working as I expect... If, after your best effort, still "no go", please let me know.

---

Question: Why should I use File Renamer?

Answer: If Lightroom's native file renaming does what you need, then File Renamer is not for you. If you need 'Search & Replace' file renaming, then File Renamer will work for you, right out of the box. If you need something different, then you'll need to customize via lua configuration file.

---

*** READ THIS ***

Question: How does it work? (and why does it work this way)

Answer: Plugins can't actually rename files, but they can initialize an IPTC field with a filename that can be used by you (in Lightroom) for renaming. 'rc File Renamer' uses the headline field, but it really doesn't matter which field is used, since headlines will be restored after the headline field is borrowed for renaming, provided you follow instructions, which are:

1. Visit plugin manager and choose preset (drop-down menu in preset manager section). Also, assure test mode is set as desired (bottom section) - usually I run test mode first, then when new filenames have been confirmed, switch to real mode. To be clear: if the preset does not do what you want as is, you'll need to edit advanced settings and make it right. Also, if you are having problems, consider enabling verbose logging (top section plugin manager) and even advanced debug - until problems resolved.
2. Select files to rename.
3. Invoke 'Rename Files - Start'.
4. Rename all selected files in Lightroom proper using 'rc File Renamer' preset - this step must not omitted!
5. Invoke 'Rename Files - Finish'.

---

Question: What is the "Renamed" collection for, in 'rc File Renamer' collection set?

Answer: Photos whose names will change are put in the "rename" collection.

I exclude photos that are in that collection from smart publish collections which need for the photo to be republished using the new name.

Thus whenever photos get renamed (and thus put into the renamed collection), they are marked for deletion on the publish service (since they are no longer included in the smart publish collection).

Thus I can publish / delete them.

Then after removing from the renamed collection, they are marked "to be published", at which point they can be republished with the new name.

Or it can be used for other things instead if you want...

---

Question: Can I use file-renamer to change filename extension?

Answer: No. - because of how it works, changes are confined to base of filenames.

---

Question: What is Lua, and what is a regular expression?

Answer: www.lua.org - good docs here...

---

Question: Other resources to aid in customization?

Answer:

• SDK: http://www.adobe.com/devnet/photoshoplightroom/sdk/eula_lr4.html
• Elare plugin framework: https://www.assembla.com/spaces/lrdevplugin/

---

Question: Any other hot tips I should know about?

Answer: Yes:

1. Backup your catalog before renaming files. And, consider exporting a branch of your catalog *with photo copies* to practice on - since you will be renaming actual files, not just catalog info.
2. If you oopsidentally invoke 'Rename Files - Finish' without invoking 'Rename Files - Start' first, it will wipe out all your headlines, but don't panic: just use Lightroom's undo to get them back. But also, see tip #1.
3. Likewise, you can reverse the effects of 'Rename Files - Start' simply by undoing via Lightroom (edit menu). But also, see tip #1.
4. Read the FAQ about the renamed collection above.

 

---

Question: What are the limitations of File Renamer and what are your plans for the future?

Answer:

• The renaming is a 3 step procedure - and only 2 of the 3 steps involve the plugin - the middle step you do all by your lonesome in Lightroom proper (see QA's above).
• lua needs to be used for customization.
• You can't change extension, only file's base name.
• And, backup your catalog (and photo files) before renaming.

---

 

File Renamer Revision History

(reverse chronological order)

 

Version 1.14.2, released 2015-01-21

- Added information to initial prompt to help clarify: results depend on preset selected in plugin manager.

 

Version 1.14.1, released 2014-12-06

- Fixed a bug on Mac (some Yosemite systems for sure, dunno which others) - was computing wrong folder for filename templates, and so wasn't working without user cleverness and action..

 

Version 1.14, released 2014-06-30

- Added 'Date-Time Plus Original Filename' preset.

 

Version 1.13, released 2014-05-19

- Improved Exif Rename 2 preset: added support for photographer ID.

 

Version 1.12, released 2014-05-19

- Improved Exif Rename 2 preset: added support for subsec time, with ability to emulate if not present in exif. Also restructured to make it simpler, and easier to reorder components.

 

Version 1.11, released 2014-05-18

- Added Exif Rename 2 preset - robustened and more usable, but more complicated than the original "Exif Rename" preset.
- Using new techinque for finding the real folder where filename renaming templates should be stored - hopefully this will either be the same or better - let me know if worse.
- Added check for illegal filename characters.
- Includes greatly robustened algorithm for parsing image number from filename, should you decide to use it instead of image number from exif metadata (e.g. because it's missing, or you really want to a sequence number which isn't the original image-number..).

 

Version 1.10.1, released 2014-02-01

- Fixed bug: sometimes requisite filenaming template was not being found (if, for example filenaming templates were being stored with catalog for a while, but aren't anymore).

 

Version 1.10, released 2013-10-17

- Improved handling of "field loader" type presets, and added special custom field loading preset:

"Load File Base Name Into Title"

(deprecated in 2014 in favor of Metato plugin).

 

Version 1.9.1, released 2013-09-24

- Fixed potential for "catch-22" problem when failing to run finish after renaming via template. Symptoms: can't run start 'cause need to finish / can't run finish 'cause haven't run start.......

 

Version 1.9, released 2013-09-07

- Fixed bug in 'Field Loader' preset, and enhanced it to support "raw" metadata too (as source field) like folder-path. It previously supported formatted metadata only, like title or folder name.

 

Version 1.8, released 2013-08-19

- Added exiftool for Mac users (v9.34).
- Refreshed exiftool for Windows users (v9.34).
- Certified for Lr5.

 

Version 1.7.2, released 2013-05-10

- Mac to use manual restart for now (auto-restart after filename preset template copied from plugin to Lr app data (upon first use) was causing problems on Mac platform.

 

Version 1.7.1, released 2013-05-10

- Fixed bug that only occurs on Mac. Symptom/error-message: "attempt to reference 'execute' member but that's nil, or something to that effect.

 

Version 1.7, released 2013-05-07

- Added preset: 'Field Loader', which, by default, simply loads title into caption (not intended to be used for file renaming, but could be). Could also be modified to load any field(s), into any other field(s).

Version 1.6, released 2012-12-03

- Enhanced default preset (search & replace) to preserve UI elements between invocations, and log the search parameters.

 

Version 1.5, released 2012-11-27

- Solved problem when presets are kept with catalog.
- Added option for programmatic restart when requisite filenaming template copied to Lr preset folder, thus necessitating Lightroom be restarted.
- Added warning if plugin is disabled.
- Added general help feature to Lightroom's Help Menu (Plugin Extras).
- Added check for missing files to improve sensibility of error logging.

Version 1.4, released 2012-11-26

- Removed potential for misleading error message about filenaming template not being found.
- Detects virtual copies up-front, to avoid misleading log message.
- Added note for Mac users about how exiftool is required for exif-based file renaming presets (not search & replace).

Version 1.3, released 2012-11-23

- Includes exiftool now v9.06.
- Added ready-to-use (or modify) preset which renames files based on exif capture timestamp and image number.

Version 1.2, released 2012-11-19

- Fixed bug in preset manager: '>', '<', '>|', '<|' buttons were broken.
- Added option for different log file location.

Version 1.1.1, released 2012-11-14

- Was not finding requisite filenaming template, now it is.

 

Version 1.1, released 2012-09-29

- Creates and populates rename collection in test mode.

 

Version 1.0, released 2011-06-12

- Initial release.

---

 

Please (IDENTIFY THE PLUGIN) let me know what you think, and please (IDENTIFY THE PLUGIN) report bugs.

 

Download

acceptance of Download Terms & Conditions will be required

*** Read the FAQ before using.
*** Read the FAQ before using.
*** Read the FAQ before using.

File Renamer 1.14.2 - Latest & greatest: this is the one to download.

*** Read the FAQ before using.
*** Read the FAQ before using.
*** Read the FAQ before using.

File Renamer 1.14.1 - Previous release, in case problem with latest (please let me know).