Redeploying Microsoft CRM 3.0

Redeploying Microsoft CRM 3.0 2005

Information in this document, including URL and other Internet Web site references, is subject to change without notice. Unless otherwise noted, the example companies, organizations, products, domain names, e-mail addresses, logos, people, places, and events depicted herein are fictitious, and no association with any real company, organization, product, domain name, e-mail address, logo, person, place, or event is intended or should be inferred. Complying with all applicable copyright laws is the responsibility of the user. Without limiting the rights under copyright, no part of this document may be reproduced, stored in or introduced into a retrieval system, or transmitted in any form or by any means (electronic, mechanical, photocopying, recording, or otherwise), or for any purpose, without the express written permission of Microsoft Corporation. Microsoft may have patents, patent applications, trademarks, copyrights, or other intellectual property rights covering subject matter in this document. Except as expressly provided in any written license agreement from Microsoft, the furnishing of this document does not give you any license to these patents, trademarks, copyrights, or other intellectual property. 2005 Microsoft Corporation. All rights reserved. Microsoft, Great Plains, MS-DOS, Windows, Windows NT, Windows Server, Active Directory, and Outlook are either registered trademarks or trademarks of Microsoft Corporation or Great Plains Software or their affiliates in the United States and/or other countries. Great Plains Software, Inc. is a subsidiary of Microsoft Corporation. The names of actual companies and products mentioned herein may be the trademarks of their respective owners.

Contents Contents Introduction...1 Usage Scenarios...3 System Requirements...4 Wizard Installation...4 Redeployment Process...4 Redeploying Other Microsoft CRM Components...9 Known Issues...10 Sample Mapping File...11 i

Introduction Deploying or redeploying Microsoft CRM 3.0 to a second system is a multi-step process that involves: Several manual procedures The use of standard backup and restore procedures and utilities A wizard designed specifically for this process The wizard is the Microsoft CRM Redeployment Wizard. Using this wizard and the processes described in this document, a system administrator or software developer can copy and use their Microsoft CRM data in another Microsoft CRM implementation separate from the original system. The following are some examples of redeployments that you can make using these tools, processes, and procedures. On a separate Microsoft CRM implementation with its own Active Directory forest and domain that is not connected to the original Active Directory forest and domain. 1

On a separate Microsoft CRM implementation with its own Active Directory domain (but in the same forest) that is not directly connected to the original Active Directory domain. 2

On a separate Microsoft CRM implementation but still part of the original Active Directory forest; however, the redeployed implementation must have its own Active Directory OU, structure, users and user roles, and groups. The Microsoft CRM 3.0 Implementation Guide is the source information document for implementing Microsoft CRM. The Microsoft CRM 3.0 Implementation Guide will be referred to several times in this document. Note Although the redeployment wizard for Microsoft CRM 3.0 is available only in English, it can be used to redeploy other language versions of Microsoft CRM. For example, it can redeploy an original Spanish Microsoft CRM implementation to a new Spanish implementation. It cannot be used to change languages originally used in an implementation; that is, it cannot be used to redeploy an original Spanish implementation to a new Italian implementation. Usage Scenarios There are probably as many different scenarios as there are organizations using Microsoft CRM where the need exists to have a separate Microsoft CRM system running with actual organizational data. Using the Microsoft CRM redeployment wizard, the associate processes and procedures, you can copy and then modify the Microsoft CRM databases for use in scenarios such as: Using existing Microsoft CRM data in a test or pilot system. Performing pre-production testing of Microsoft CRM application and platform components using existing Microsoft CRM data. Developing and testing in-house customizations, reports, or additional Microsoft CRM solutions before deploying them to the production system. Investigating and reproducing Microsoft CRM system issues in a safe environment. 3

Migrating your Microsoft CRM implementation from one Active Directory Domain to another. System Requirements The Microsoft CRM redeployment tools do not require additional hardware or software beyond the requirements of Microsoft CRM. See Hardware and Software Requirements in the Microsoft CRM3.0 Implementation Guide for the hardware and software requirements of Microsoft CRM and its various components. Also see Installing Microsoft CRM Server on Microsoft Windows Small Business Server 2003, of the Microsoft CRM 3.0 Implementation Guide for information about deploying Microsoft CRM on this system. Wizard Installation The Microsoft CRM Redeployment Wizard is available on the Microsoft CRM Server CD. The Wizard is located in the \RedeploymentTool folder. Install the Microsoft CRM Redeployment Wizard This wizard will be used during Step 5 of the redeployment process. Install it on the computer that will eventually become the computer running Microsoft CRM Server in your new system. 1. Log on to the computer as a user with Local Administrator privileges on the computer that will contain the Microsoft CRM server for your new system. 2. Insert the Microsoft CRM Server CD in your CD-ROM drive. Open Windows Explorer and navigate to your CD- ROM drive. 3. Navigate to the RedeploymentTool folder, double-click RedeployImport.msi and follow the installation instructions. 4 Note If the procedure above fails to install the Redeployment Wizard, you can run the installation again from a command prompt window and generate a log file, which will help in troubleshooting the failed installation. The command is: msiexec /l*v logfile.log /I redeployimport.msi Redeployment Process This section discusses the details of the redeployment process. Step 1: Back Up the Databases Make a copy of or back up the Microsoft CRM databases. Perform the following tasks before copying the databases: All instances of Microsoft CRM Laptop Client for Outlook must complete synchronization to the production system. Data changes and updates from the Microsoft CRM Laptop clients that have not been synchronized after you work offline will not be part of the database copy that is made as part of this process. If Microsoft CRM Integration for Great Plains is installed, data updates must be completed. Data changes and updates not completed will not be part of the database copy that is made as part of this process. Stop the Microsoft CRM Workflow Service. Stop the Microsoft CRM Workflow Service 1. On the Microsoft CRM server, on the Start menu, point to Programs, point to Administrative Tools, and click Services.

2. Right-click Microsoft CRM Workflow Service and click Stop. Back up the Microsoft CRM databases From the computer running SQL Server, make a copy (backup) of the Microsoft CRM databases listed below. You can use your regular backup and restore procedures to make this copy, but include only the database files listed below. If you followed the Microsoft Business Solutions CRM Implementation Guide in setting up your Microsoft CRM system, the database files are located in the folder: <systemdrive>:\program Files\Microsoft SQL Server\MSSQL\Data The files are named: Organization_name_MSCRM Organization_name_METABASE Important The names of these database files are case sensitive. It is critical that the _MSCRM part of the Organization_name_MSCRM database file names be uppercase. Step 2: (Optional) Back Up Customizations, Workflow, and Custom Reports Important: Customizations, workflow, and customized reports are not redeployed using the Redeployment Tool. If you want your redeployed Microsoft CRM system to have the customizations, workflow rules, or custom reports from your source Microsoft CRM system, you must back them up manually and restore them to your redeployed system manually. Exporting Customizations, Including Entity, Template and Configuration Customizations From the Microsoft CRM Customizations area, use Export Customizations to export your customizations from your source system. You will use the output.xml file that you create in Step 7. The procedure for exporting customizations is in Microsoft CRM online help. To backup workflow and callouts, you will also need to copy the workflow.config file, callout.config.xml file all the files in the <systemdrive>:program Files\Microsoft CRM\Server\bin\assembly folder and deploy this to your new server. This must be done before workflow rules are imported using the Import Workflow Wizard. Exporting Workflow Rules Use the Export Workflow Wizard to make a backup of any workflow rules you want to redeploy. You will use the output.xml file you create in Step 7. Start the Export Workflow Wizard On the Microsoft CRM Server, on the Start menu, point to All Programs, point to Microsoft CRM, and then click Export Workflow Wizard. Reports If you have any custom reports on your source system, run the DownloadReports.exe command-line tool. You will use the resulting publish.config file and Reports folder in Step 7. The procedure for downloading reports can be found in Chapter 25: Reporting in the Microsoft CRM 3.0 Implementation Guide. 5

Step 3: Install Servers and Configure Users Install all server applications for your new implementation, including: Active Directory domain controllers Microsoft SQL Server Microsoft Exchange Server (optional) Important Do not install Microsoft CRM Server at this time. Microsoft CRM Server will be installed later in the process. Use the installation procedures in the Microsoft CRM3.0 Implementation Guide. Depending on your configuration, the procedures are in the following chapters: Chapter 12, "Installing on Windows 2000 Server" Chapter 13, "Installing on Windows Server 2003" Chapter 14, "Installing on Microsoft Windows Small Business Server 2003" Create a new Active Directory parent OU and user accounts for the new system. User logon names created on the new system do not have to be identical to those on the original system. If your new Microsoft CRM implementation is in the same Active Directory forest as your original Microsoft CRM implementation, you can use the existing users for the new implementation if you are logged on as the original installation user. Otherwise you must map to new users. If an Exchange server is going to be part of your new system, you must also create an Exchange mailbox for each user. To have the user created with an Exchange 2000 or Exchange Server 2003 mailbox, you must run Active Directory Users and Computers on an Exchange server or any other server that has Exchange System Manager installed. Step 4: Restore the Microsoft CRM Databases Restore the copy of the Microsoft CRM databases to the computer running SQL Server in the new system. If you follow the Microsoft CRM 3.0 Implementation Guide in setting up your new Microsoft CRM system, the database files should be restored to the folder: <systemdrive>:\program Files\Microsoft SQL Server\MSSQL\Data We recommend that you retain the original names of your Microsoft CRM database files and do not rename them as part of this redeployment process. Step 5: Complete the Microsoft CRM Redeployment Wizard Before you can perform this step, you must have the Microsoft CRM Redeployment Wizard installed on the computer that will be running Microsoft CRM Server in the new system. For more information, see the procedures in the previous Wizard Installation section. To use the Microsoft CRM Redeployment Wizard, you must be logged on as a member of the Local Administrators group. Use the Microsoft CRM Redeployment Wizard to define and map the users from the original Microsoft CRM implementation to the new implementation. The Microsoft CRM Redeployment Wizard will create the Active Directory groups on the new system. Use the Microsoft CRM Redeployment Wizard 6

1. On the Start menu, point to Programs, point to Microsoft CRM, and then click Microsoft CRM Redeployment Wizard. 2. On the Welcome to the Microsoft CRM Redeployment Wizard opening page, click Next. 3. On the Database Information page, type the name of the Microsoft SQL Server and then select the name of your restored Microsoft CRM database (see Step 4 above). 4. On the Organization Information page, type an Organization Name. This name can be the same as your original Microsoft CRM system. However, if you prefer to use a different Organization Name, enter it here and the Microsoft CRM Redeployment Wizard will transform the data to use the name. 5. On the Active Directory Information page, Browse Active Directory to choose an Organizational Unit where the Microsoft CRM security groups will be created. 6. On the User Mapping page, choose the method to be used to map Microsoft CRM users from your original system to your redeployed system. The options are: Keep Existing User Mappings. Your redeployed Microsoft CRM system will have the exact same users as your original system. Manually Map Users. Selecting this option and clicking Next will display the Edit User Mapping page. On this page you can manually map users from your original Microsoft CRM system to your redeployed system. Generate New Mapping File. This option will generate a new mapping file that can be edited and then used to do the actual user mappings. Auto-map Users. This option will cause the Microsoft CRM Redeployment Wizard automatically map users from your original Microsoft CRM system to the redeployed system based on one of the following parameters. Active Directory Account Name Microsoft CRM Full Name to Active Directory Full Name Prefix and a start value An existing mapping file, for which you can browse for. 7. On the Edit User Mapping page, you can manually map users from your original Microsoft CRM system to the redeployed system. Click Next. 8. The Confirm Database Transformation page appears listing the details of what will be transformed. Click Start for the wizard to start the transformation. 9. The Performing Database Transformation page appears showing the transformation progress. When the process is complete, click Next. 10. Click Finish to complete the wizard. Note The records transformed by the Microsoft CRM Redeployment Wizard in the new implementation will not have data in the Primary E-mail Address field. You need to complete this field in the Microsoft CRM application after it has been installed in Step 6. (All other user record data is preserved.) Run the Microsoft CRM Redeployment Wizard from the Command Line. The Microsoft CRM Redeployment Wizard can be run from the command line. Running the Microsoft CRM Redeployment Wizard from the command line is recommended only if you intend to install Microsoft CRM Server (in Step 6 below) from the command line. Both the Microsoft CRM Redeployment Wizard and installing Microsoft CRM Server use the same configuration file to supply the data and parameters required. Running the Microsoft CRM Redeployment Wizard from the 7

command line will still display the wizard screens. However, the options will be pre-populated based on the information from the configuration file. For more information about this configuration file and installing Microsoft CRM Server using the command line, see Chapter 19, Use the Command Line to Install Microsoft CRM in the Microsoft CRM 3.0 Implementation Guide. Run from the Command Line 1. Open a command prompt windows and navigate to where you installed the Microsoft CRM Redeployment Wizard. By default, the location is: <systemdrive>\program Files\Microsoft CRM Redeployment Wizard 2. Type RedeployWizard.exe /config (config_file_name) Step 6: Install Microsoft CRM Install Microsoft CRM on the computer in the new system and make sure to select the Connect to existing database option during setup. Each Microsoft CRM implementation must have the appropriate license. The user installing Microsoft CRM must be granted the following privileges as a minimum: Be able to create objects within the Active Directory Organizational Unit (OU) that is the target parent OU for installing Microsoft CRM. SQL Administrator privilege IIS Server local Administrator privilege Local Administrator on the computer where Microsoft CRM is to be installed. Use the installation procedures in the Microsoft CRM 3.0 Implementation Guide. Depending on your configuration, the procedures are in the following chapters: "Install Microsoft CRM" "Installing on Microsoft Windows Small Business Server 2003" Step 7: (Optional) Import Customizations, Workflow Rules, and Custom Reports If you have exported your customizations, workflow rules or custom reports from your source Microsoft CRM system, you must restore them to your redeployed system manually. Important: Customizations must be imported prior to importing reports or workflow rules that depend on the customizations. Importing Customizations, Including Entity, Template and Configuration Customizations From the Microsoft CRM Customization area, use Import Customizations to import the customization.xml file you created in Step 2. The procedure for importing customizations is in the Microsoft CRM online help. Workflow and callouts are restored by copying the workflow.config file, the callout.config.xml file all the files in the <systemdrive>:program Files\Microsoft CRM\Server\bin\assembly folder to your new server. (These files were backed up as part of Step 2 above.) This must be done before workflow rules are imported using the Import Workflow Wizard. Importing Workflow Rules Use the Import Workflow Wizard to import the workflow rules.xml file you created in Step 2. Start the Import Workflow Wizard 8

1. On the Microsoft CRM Server, on the Start menu, point to All Programs, point to Microsoft CRM, and then click Import Workflow Wizard. Publishing Reports Use the PublishReports.exe command-line tool to publish the report files you backed up in Step 2. The procedure for publishing reports can be found in Chapter 25: Reporting in the Microsoft CRM 3.0 Implementation Guide. Redeploying Other Microsoft CRM Components This section discusses the requirements and limitations that the other Microsoft CRM components have when you work with more than one Microsoft CRM implementation. Web Browser There is no limitation to accessing different implementations of the Microsoft CRM Web application using only a Web browser (such as Internet Explorer). Microsoft CRM Clients for Outlook The Microsoft CRM Laptop client for Outlook uses the Microsoft SQL Server 2000 Desktop Engine (MSDE 2000) on each client computer to enable the client to operate offline. During installation, the Microsoft CRM Laptop client for Outlook requires the location of the Microsoft CRM server. The Microsoft CRM Laptop client for Outlook maintains a data store on the user's computer for Microsoft CRM data. Microsoft CRM data from the Microsoft CRM server will synchronize with this local store for offline access to data. In addition, there is two-way synchronization between this local store and Microsoft Outlook for contacts, tasks, the calendar, and e-mail items. When the user s computer is connected again to the organization's network, synchronization also takes place between SQL Server 2000 Desktop Engine and the Microsoft CRM server that is posting client-side transactions back to the server. This relationship between SQL Server 2000 Desktop Engine on the client computer and the Microsoft CRM server requires that the following be considered: Before the redeployment starts, all offline Outlook clients should go online to synchronize data before a copy (backup) of the Microsoft CRM databases is made. This will ensure that no data is lost. After redeployment is done, the redeployment tools do not transform local client data stores. If an Outlook client has been working with an original or production Microsoft CRM implementation, the Outlook client must be uninstalled and then re-installed, designating the new Microsoft CRM server during setup. Microsoft CRM-Exchange E-Mail Router E-mail originating from within Microsoft CRM and e-mail whose destination is Microsoft CRM is routed by the Microsoft CRM-Exchange E-Mail Router (the Router). The e-mail configuration of the new or test Microsoft CRM system should be based on your requirements and need for e-mail to be routed into and from the system. If you do not need e-mail for the new Microsoft CRM system, do not install the Router for that system. Otherwise, install the Router for the new Microsoft CRM system. 9

Microsoft CRM Integration for Great Plains You must consider the following items when using Microsoft CRM Integration for Great Plains: The Microsoft CRM integration component can interact only with one Microsoft CRM server deployment at a time. If the integration component is being used on the original Microsoft CRM system and you require the integration on the new or test system, you need to install it on the new system. During the installation of the integration component on a new Microsoft CRM system, make sure you attach it to the original integration computer running Microsoft SQL Server. This will maintain the database integrity of the integration component database. Known Issues Microsoft Windows Operating System Additions and Database Triggers If you want to install any Microsoft Windows operating system enhancements or add-on programs or create or add any custom database triggers (other than system defaults) to your new Microsoft CRM system, you must install them before using the Microsoft CRM Redeployment Wizard. If you have installed the add-on programs or added any custom database triggers, you must remove them, complete the redeployment process on the new Microsoft CRM system, and then re-install them after you have verified that the new Microsoft CRM system is functioning. The Microsoft CRM Redeployment Wizard Does Not Finish If, for any reason, the Microsoft CRM Redeployment Wizard does not complete, you will need to do the following: 1. Delete the Organization_MSCRM and Organization_METABASE databases on the Microsoft SQL Server of your new deployment. These database files should be located in the folder: <systemdrive>:\program Files\Microsoft SQL Server\MSSQL\Data. 2. Start the redeployment process again at Step 4 in this document. Installing Microsoft CRM Server always creates a log files that can be reviewed and used for troubleshooting. By default, the location of the log files is: <systemdrive>:\documents and Settings\User\Application Data\Microsoft\Microsoft CRM\Logs 10

Sample Mapping File This section discusses the structure and contents of the user mapping file. This information is given for those cases where you have many Microsoft CRM users that need to be mapped from the original Microsoft CRM implementation to a new one. In these cases, it may be easier to edit the XML file directly. The file is updated and overwritten by the Microsoft CRM Redeployment Wizard. The Microsoft CRM Redeployment Wizard gives you the option of using a mapping file on the User Mapping page of the wizard. This page will also give you the option to Generate New Mapping File. If you generate a new file, you can edit the file using a text editor, and then start the wizard again. User Mapping XML File Structure The following is an example user mapping file containing two users: <MappingConfiguration> <DomainMapping old="origcrmdom" new="newcrmdom" /> <UserMapping old="origcrmdom\omarse" new="newcrmdom\omarse" /> <UserMapping old="origcrmdom\dkalin" new="newcrmdom\dkalin" /> </MappingConfiguration> Elements in the User Mapping File The user mapping file is contained in the root element <MappingConfiguration>. There are two sub-elements available: <DomainMapping> and <UserMapping>. Use one or the other, but not both together. If both are present, the <UserMapping> elements take precedence. The <DomainMapping old=" " new=" " /> element contains the Active Directory domain for the original and new Microsoft CRM implementations. If you use this element, you do not need to use the individual <UserMapping> elements. If this is the only element you use, then all Microsoft CRM users will be transformed automatically from the old domain to the new domain, keeping the same account names. The <UserMapping old="crmdevdom0\omarse" new="newcrmdom\omarse" /> element contains the alias name of each Microsoft CRM user. For example, if you have ten users in your Microsoft CRM implementation, your user mapping file will have ten <usermapping> elements; one for each user. 11