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
 
(29 intermediate revisions by 5 users not shown)
Line 1: Line 1:
=Introduction=
=Introduction=
When 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.
RangerMSP 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_the_Software_Installation_from_One_Server_to_Another|transferring your Installation from one server to another]]), you may also need to update the RangerMSP 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 four steps:
* Update the paths in your database to the new location
* Update the Global Default Document Folder settings.
* Update the Global Default Documents Folders
* Update the Knowledge Base Articles Folder
 
==Step 1 - Backup Your Database==
'''IMPORTANT''': Please backup the RangerMSP folder and sub-folders. [[Backup_and_Restore_FAQ|Click here]] for more details on backing up your system.
 
 
==Step 2 - Update the path for existing docs==
In order to change the path in the database for existing documents, you should use a utility.
This utility finds documents that contain the old location and replaces it with 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.
*If you are using '''version 25 or above''' - [http://{{SERVERNAME}}/downloads/CRMChangeDocsPath.exe Click here to download] a utility that will help you modify the path.


Here’s the steps:
*If you are using '''version 18 to 24''' - [http://{{SERVERNAME}}/downloads/crm-change-all-docs-path-v18.exe Click here to download] a utility that will help you modify the path.


IMPORTANT: Please backup the Commit folder and sub-folders and only then:
*If you are using '''version 16 to 17''' - [http://{{SERVERNAME}}/downloads/crm-change-all-docs-path-v16.exe Click here to download] a utility that will help you modify the path.


==Step 1 - Update the path for existing docs:==
* If you are using '''version 8 to 15''' - [http://{{SERVERNAME}}/downloads/crm-change-all-docs-path-v8-to-v15.exe Click here to download] a utility that will help you modify the path.


* 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.
* If you are using '''version 5.3 to 7.0''' - [http://{{SERVERNAME}}/downloads/crm-change-all-docs-path-53.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
* If you are using '''version 5.0, 5.1 or 5.2''' - [http://{{SERVERNAME}}/downloads/crm-change-all-docs-path-50.exe Click here to download] a utility that will help you modify the path.


* Save it in folder:
* If you are using a version prior to 5.0, please contact us again for a different link to the program.
'''<server>\Commit\Utils'''


* Run the downloaded program
* Save the utility in folder:
'''<server>\RangerMSP\Utils'''


* Set the original/old path
To run the utility:
# Run the downloaded program.
# Set the original/old path.
# Set the new path of the new server.<br>'''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 backslash ( '''\''' )
# Click Replace
# Done.
# Run RangerMSP and make sure the path was updated successfully.


* Set the new path of the new server
<br>


'''NOTE''': The path should point to the root folder where the documents are stored
==Step 3 – Update the Global Default Documents Folders==
e.g. '''<server>/x/y/z/docs/'''
The Default Documents Folder determines the folder that will for new Accounts that will be created from now on.


* Make SURE you end each path you set with a slash ( '''/''' )
To update this location to the new one, go to '''Tools menu > Options > Documents tab > Default Documents Folder''' and update the folder location.


* Click Replace
==Step 4 - Update the Knowledge Base Articles Folder==
If you keep documents for your Knowledge Base Articles, perform also the following steps:


* Done.
# Set the default folder for Knowledge Base Articles from:<br> '''Tools > Options > Knowledge Base tab > Default Folder for Articles' Document Files'''. This will make sure new Knowledge Base articles will be created in the correct location from now on.


* Run Commit and make sure the path was updated successfully.
To update existing documents:
# Backup your database again, before proceeding to the next step.
# Then, use the same utility again to update the KB Articles path:
## Run the downloaded program
## Set the original/old path for the KB Articles
## Set the new path in the new server<br>'''NOTE''': The path should point to the root folder where the KB documents are stored <br> e.g. '''\\<server>\x\y\z\Docs\Knowledge Base\'''
## Make SURE you end each path you set with a backslash ( '''\''' )
## Click Replace
## Done.
# Run RangerMSP and make sure the path for KB Article documents was updated successfully.


==Step 2 - Update the Account Defaults==
=See Also=
'''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.
[[Transferring_the_Software_Installation_from_One_Server_to_Another|Transferring your Installation from one server to another]]


==Step 3 – Update the Global defaults for new accounts==
[[Category:KB|Docs]]
* Set the default folder to be used for new accounts by going to:  
'''Tools menu > Options > Documents tab > Default Documents Folder'''

Latest revision as of 10:10, 22 May 2023

Introduction

RangerMSP 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 Installation from one server to another), you may also need to update the RangerMSP 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 four steps:

  • Update the paths in your database to the new location
  • Update the Global Default Document Folder settings.
  • Update the Global Default Documents Folders
  • Update the Knowledge Base Articles Folder

Step 1 - Backup Your Database

IMPORTANT: Please backup the RangerMSP 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 path in the database for existing documents, you should use a utility. This utility finds documents that contain the old location and replaces it with the new location.


  • If you are using version 5.0, 5.1 or 5.2 - Click here to download a utility that will help you modify the path.
  • If you are using a version prior to 5.0, please contact us again for a different link to the program.
  • Save the utility in folder:
<server>\RangerMSP\Utils

To run the utility:

  1. Run the downloaded program.
  2. Set the original/old path.
  3. 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\
  4. Make SURE you end each path you set with a backslash ( \ )
  5. Click Replace
  6. Done.
  7. Run RangerMSP and make sure the path was updated successfully.


Step 3 – Update the Global Default Documents Folders

The Default Documents Folder determines the folder that will for new Accounts that will be created from now on.

To update this location to the new one, go to Tools menu > Options > Documents tab > Default Documents Folder and update the folder location.

Step 4 - Update the Knowledge Base Articles Folder

If you keep documents for your 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. This will make sure new Knowledge Base articles will be created in the correct location from now on.

To update existing documents:

  1. Backup your database again, before proceeding to the next step.
  2. 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 backslash ( \ )
    5. Click Replace
    6. Done.
  3. Run RangerMSP and make sure the path for KB Article documents was updated successfully.

See Also

Transferring your Installation from one server to another