{"id":152,"date":"2011-08-02T10:26:44","date_gmt":"2011-08-02T10:26:44","guid":{"rendered":"http:\/\/vyapin.com\/blogs\/index.php\/2011\/08\/02\/dockit-rename-folders-files-using-metadata-column-values\/"},"modified":"2021-05-28T11:52:23","modified_gmt":"2021-05-28T11:52:23","slug":"dockit-rename-folders-files-using-metadata-column-values","status":"publish","type":"post","link":"https:\/\/www.vyapinsoftware.com\/blog\/dockit-rename-folders-files-using-metadata-column-values","title":{"rendered":"DocKIT: Rename folders\/files based on patterns using renaming rules"},"content":{"rendered":"

In continuation with the previous blog post that deals with the folder and file rename options<\/strong><\/a>, here we discuss how to deal with renaming of folders\/files that contain illegal characters.<\/p>\n

As said earlier, folders and files residing in legacy systems will have having special characters that are invalid (disallowed) in SharePoint. DocKIT facilitates this renaming by providing folder and file naming rules while migrating into SharePoint<\/strong><\/a>.<\/p>\n

Certain users might also need migration of different versions of a file with their version named with certain patterns. DocKIT also supports this file version history creation seamlessly.<\/p>\n

Rename folders & files using naming rules<\/h3>\n

This option is intended \/recommended for renaming folders & files that have characters not accepted in SharePoint as part of their names.<\/p>\n

SharePoint disallows certain invalid characters in the folder and file names. In order to overcome this behavior, you need to replace certain characters that appear in Windows folder & file names and are invalid folder \/ file characters in SharePoint libraries, with valid characters (all characters except ~ # % & { } * | : < > \/ ?) in SharePoint.<\/p>\n

For this, you can use the “Folder & File Renaming Rules” feature in DocKIT. This feature in DocKIT<\/strong><\/a> uses ‘Regular Expressions’ technique that is widely used in software applications where character pattern matching is crucial.<\/p>\n

Consider the following cases:<\/p>\n

Example 1: Order of entries when constructing renaming rules<\/h4>\n

The Folder and File Renaming rule in DocKIT requires the rule entries to be correctly placed for successful and meaningful replacement of invalid characters. The order of the entries (sequence) is important depending on the name of the files and folders. For example, if you want dot and double underscore OR triple dots to be treated as a single entity, then a rule entry with this value has to be given first. After this, you should provide dot and single underscore OR double dots value as entry.<\/p>\n

Example:<\/em><\/strong><\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Invalid File Name<\/strong><\/td>\nValid File Name<\/strong><\/td>\nDescription of the Renaming requirement<\/strong><\/td>\n<\/tr>\n
Sa…ple File 1.doc<\/td>\nSample File 1,doc<\/td>\nReplace 3 dots with ‘m’<\/td>\n<\/tr>\n
Sam..le File2.doc<\/td>\nSample File2.doc<\/td>\nReplace 2 dots with ‘p’<\/td>\n<\/tr>\n
_ample File3.doc<\/td>\nSample File3.doc<\/td>\nReplace_ with ‘S’<\/td>\n<\/tr>\n
.Feb Report.xlsx<\/td>\nFeb Reprt.xlsx<\/td>\nRemove dot if the file name starts<\/strong> with . (dot)<\/td>\n<\/tr>\n
Jan Report.xls<\/td>\nJan Report.xls<\/td>\nRemove dot if the file name ends <\/strong>with . (dot)Replace two consecutive dots with one<\/td>\n<\/tr>\n
<\/td>\n<\/tr>\n
._March Report.pdf<\/td>\nMarch Report.pdf<\/td>\nReplace ._ with empty<\/td>\n<\/tr>\n
.__ April Report.txt<\/td>\nApril Report.txt<\/td>\nReplace .__ ( dot, two underscores) with empty<\/td>\n<\/tr>\n
__ May Report.pptx<\/td>\nMay Report.pptx<\/td>\nReplace __ (two consecutive underscores) with empty<\/td>\n<\/tr>\n
._. June Report.ppt<\/td>\njustify;line-height:normal;mso-yfti-cnfc:128″>June Report.ppt<\/td>\nReplace ._. (dot, underscore,
\ndot) with empty<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Equivalent Naming Rules:<\/em><\/strong><\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n
Find<\/strong><\/td>\nReplace<\/strong><\/td>\nDescription<\/strong><\/td>\n<\/tr>\n
…<\/td>\nm<\/td>\nReplace 3 dots with ‘m’<\/td>\n<\/tr>\n
..<\/td>\np<\/td>\nReplace 2 dots with ‘p’<\/td>\n<\/tr>\n
.*<\/td>\n<\/td>\nRemove dot if the file name starts<\/strong> with . (dot)<\/td>\n<\/tr>\n
*.<\/td>\n<\/td>\nRemove dot if the file name ends<\/strong>
\nwith . (dot)<\/td>\n<\/tr>\n
.__<\/td>\n<\/td>\nReplace .__ ( dot, two underscores) with empty<\/td>\n<\/tr>\n
._.<\/td>\n<\/td>\nReplace ._. (dot, underscore, dot) with empty<\/td>\n<\/tr>\n
._<\/td>\n<\/td>\nReplace ._ with empty<\/td>\n<\/tr>\n
__<\/td>\n<\/td>\nReplace __ (two consecutive underscores) with empty<\/td>\n<\/tr>\n
_<\/td>\nS<\/td>\nReplace _ with ‘S’<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Figure 1: Naming rule as specified in DocKIT application<\/h4>\n

<\/a><\/p>\n

Example 2: Usage of reserved characters<\/h4>\n

The ‘Regular Expressions’ technique used by DocKIT for pattern matching categorizes some of the operators as reserved and has its own meaning for the operators in the pattern syntax. In order to treat the reserved characters as normal characters like ‘A’, ‘1’, you have to use ” (backslash) as an escape sequence character in DocKIT Renaming rule as given below:<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Invalid file name<\/strong><\/td>\nValid file name<\/strong><\/td>\nDescription<\/strong><\/td>\nNaming rule<\/strong><\/td>\n<\/tr>\n
Find<\/td>\nReplace<\/td>\n<\/tr>\n
My File name#.xls<\/td>\nMy File name.xls<\/td>\nReplace # with empty<\/td>\n#<\/td>\n<\/td>\n<\/tr>\n
Programs & Schedules.docx<\/td>\nPrograms and Schedules.docx<\/td>\nReplace & with \u2018and\u2019<\/td>\n&<\/td>\nand<\/td>\n<\/tr>\n
My $ File name.docx<\/td>\nMy File name.docx<\/td>\nReplace $ with empty<\/td>\n$<\/td>\n<\/td>\n<\/tr>\n
policydoc *74565.xls<\/td>\npolicydoc 74565.xls<\/td>\nReplace * with empty<\/td>\n*<\/td>\n<\/td>\n<\/tr>\n
Sample.Doc<\/td>\nSampleDoc<\/td>\nReplace . with empty<\/td>\n.<\/td>\n<\/td>\n<\/tr>\n
Sample?File<\/td>\nSampleTextFile<\/td>\nReplace ? with ‘Text’<\/td>\n?<\/td>\nText<\/td>\n<\/tr>\n
Test^Document<\/td>\nTestdocument<\/td>\nReplace ^ with empty<\/td>\n^<\/td>\n<\/td>\n<\/tr>\n
Sample+File<\/td>\nSampleTextFile<\/td>\nReplace plus with ‘Text’<\/td>\n+<\/td>\nText<\/td>\n<\/tr>\n
Word<Document<\/td>\nWordDocument<\/td>\nReplace < with empty<\/td>\n<<\/td>\n<\/td>\n<\/tr>\n
PDF>Document<\/td>\nPDFDocument<\/td>\nReplace > with empty<\/td>\n><\/td>\n<\/td>\n<\/tr>\n
[Document<\/td>\nDocument<\/td>\nReplace [ with empty<\/td>\n[<\/td>\n<\/td>\n<\/tr>\n
Sample]<\/td>\nSampleFile<\/td>\nReplace ] with ‘File’<\/td>\n]<\/td>\nFile<\/td>\n<\/tr>\n
(File<\/td>\nDocumentFile<\/td>\nReplace ( with ‘Document’<\/td>\n(<\/td>\nDocument<\/td>\n<\/tr>\n
TextFile)<\/td>\nTextFile<\/td>\nReplace ) with empty<\/td>\n)<\/td>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Create file version history by using certain naming patterns<\/span><\/h3>\n

We will discuss a situation where certain files in a folder have their names appended with version numbers. If you would like these version numbers to stack up nicely as version history of the file \/ document, this is what you can do.<\/p>\n

Example 1: Uniform file naming pattern for file version<\/h4>\n\n\n\n\n\n\n\n
Invalid File Name<\/td>\nValid File Name<\/td>\nDescription<\/td>\n\n

Naming Rule<\/p>\n<\/td>\n<\/tr>\n

Find<\/td>\nReplace<\/td>\n<\/tr>\n
My File name_v1.0.docx<\/td>\nMy File name.docx<\/td>\nReplace underscore, v and version number appended with the parent file name with empty so as to create as respective versions of a file
\nFirst version<\/td>\n		*_v??.??<\/td>\n<\/td>\n<\/tr>\n
My File name_v1.1.docx<\/td>\nMy File name.docx<\/td>\nNext minor version<\/td>\n<\/td>\n<\/td>\n<\/tr>\n
My File name_v1.2.docx<\/td>\nMy File name.docx<\/td>\nNext minor version<\/td>\n<\/td>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Example 2: Random file naming pattern for file version:<\/h4>\n\n\n\n\n\n\n\n
Invalid File Name<\/td>\nValid File Name<\/td>\nDescription<\/td>\n\n

Naming Rule<\/p>\n<\/td>\n<\/tr>\n

Find<\/td>\nReplace<\/td>\n<\/tr>\n
My doc_v1.0.doc<\/td>\nMy doc.doc<\/td>\nReplace underscore, v and version number appended with the parent file name with empty so as to create as respective versions of a file
\nFirst version<\/td>\n		*_v*
\n*v??.??<\/td>\n		v<\/td>\n<\/tr>\n
My docv1.1.doc<\/td>\nMy doc.doc<\/td>\nNext minor version<\/td>\n<\/td>\n<\/td>\n<\/tr>\n
My docv1.2.doc<\/td>\nMy doc.doc<\/td>\nNext minor version<\/td>\n<\/td>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Note: Entries under the Find section should be in the same order as listed.<\/p>\n

Figure 2: File Settings in DocKIT Task Wizard<\/h4>\n

To create version history, select \u2018Create new version\u2019 option in \u2018File Settings\u2019 step in DocKIT Task Wizard.<\/p>\n

<\/a><\/p>\n

For more information, please refer the following help sections in the Dockit online help document<\/strong><\/a>. You can launch the help document from Help menu (Help -> Contents menu) in the application.<\/p>\n