KB: Changing Documents Folder Path: Difference between revisions

From RangerMSP Wiki - PSA software for MSPs and IT services providers
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
=Introduction=
=Introduction=
When [[Transferring_Commit_Installation_from_One_Server_to_Another|transferring your CommitCRM Installation from 1 server to another]], the need to move the '''CommitCRM Accounts Documents Folder''' also comes up many times. The problem here is that if you move the directory, then the database will not know where to look for the documents you have imported into CommitCRM.
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_Commit_Installation_from_One_Server_to_Another|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.


__TOC__
__TOC__
=How to change the database paths=
=How to change the database paths=
We have a find&replace utility designed for updating the Docs path in the files imported in to CommitCRM pointing to the old location.
Updating the documents path to a new location consist of three steps:
 
* Updating the paths in your database to the new location
There is a 3 step process that will update your docs paths in your database to the new location, update your accounts to the new location, and update your default settings.
* Updating the Accounts default document folder to the new location
 
* Updating  the Global Default Document Folder settings.  
Here’s the steps:
'''IMPORTANT''': Please backup the Commit folder and sub-folders. [[Backup_and_Restore_FAQ|Click here]] for more details on backing up your system.


IMPORTANT: Please backup the Commit folder and sub-folders and only then:


==Step 1 - Update the path for existing docs:==
==Step 1 - 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''' (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.
* 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 version 5.0 - [http://www.commitcrm.com/downloads/commit-change-all-docs-path-50.exe Click here to download] a utility that will help you modify the path
* If you are using version 5.0 - [http://www.commitcrm.com/downloads/commit-change-all-docs-path-50.exe Click here to download] a utility that will help you modify the path
Line 38: Line 41:
* Run Commit and make sure the path was updated successfully.
* Run Commit and make sure the path was updated successfully.


==Step 2 - Update the Account Defaults==
==Step 2 - 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.
'''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 3 – Update the Global defaults for new accounts==
==Step 3 – Update the Global Default Documents Folders==
* Set the default folder to be used for new accounts by going to:  
* Set the default folder to be used for new accounts by going to:  
  '''Tools menu > Options > Documents tab > Default Documents Folder'''
  '''Tools menu > Options > Documents tab > Default Documents Folder'''

Revision as of 20:04, 27 October 2009

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.

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


Step 1 - 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.
  • 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 Commit and make sure the path was updated successfully.

Step 2 - 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 3 – 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

See Also

Transferring your CommitCRM Installation from 1 server to another