KB: Changing Documents Folder Path

Introduction

CommitCRM documents are saved in the database including the full path to the file location. When the path to the Documents folder changes (for example when transferring your CommitCRM Installation from one server to another), you may also need to update the CommitCRM Documents Folder as well.

Since the document path is saved in the database, there is a need to actually update the path in the document records.

How to change the database paths

Updating the documents path to a new location consist of three steps:

• Updating the paths in your database to the new location
• Updating the Accounts default document folder to the new location
• Updating the Global Default Document Folder settings.

Step 1 - Backup Your Database

IMPORTANT: Please backup the Commit folder and sub-folders. Click here for more details on backing up your system.

Step 2 - Update the path for existing docs

In order to change the documents path in the database, you should use a utility designed for updating the path in the database according to the old location.

• Make sure you are using CommitCRM version 5.0 or higher (you can check this from the Help > About window). If you are using a version prior to 5.0, please contact us again for a different link to the program.

• If you are using CommitCRM version 5.3 or higher - Click here to download a utility that will help you modify the path.

• If you are using CommitCRM version 5.0, 5.1 or 5.2 - Click here to download a utility that will help you modify the path.

• Save it in folder:

<server>\Commit\Utils

• Run the downloaded program

• Set the original/old path

• Set the new path of the new server

NOTE: The path should point to the root folder where the documents are stored

e.g. <server>/x/y/z/docs/

• Make SURE you end each path you set with a slash ( / )

• Click Replace

• Done.

• Run CommitCRM and make sure the path was updated successfully.

Step 3 - Update the Account Default Folders

Note: The default folder location for your accounts is not modified by the document path updater program. You should update the relevant default folders for your Accounts (via the Account's Details tab > Docs Dir). This is relevant only for accounts who have the default directory defined.

Step 4 – Update the Global Default Documents Folders

• Set the default folder to be used for new accounts by going to:

Tools menu > Options > Documents tab > Default Documents Folder

Step 5 - Update the Knowledge Base Articles Folder

If you keep documents for Knowledge Base Articles, perform also the following steps:

1. Set the default folder for Knowledge Base Articles from:
   Tools > Options > Knowledge Base tab > Default Folder for Articles' Document Files
2. Backup your database again, before proceeding to the next step.
3. Then, use the same utility again to update the KB Articles path:
   1. Run the downloaded program
   2. Set the original/old path for the KB Articles
   3. Set the new path in the new server
      NOTE: The path should point to the root folder where the KB documents are stored
      e.g. <server>/x/y/z/Docs/Knowledge Base/
   4. Make SURE you end each path you set with a slash ( / )
   5. Click Replace
   6. Done.
4. Run CommitCRM and make sure the path for KB Article documents was updated successfully.

See Also

Transferring your CommitCRM Installation from one server to another