Installation Guide - CWR Mobile CRM 4.1

{S:Draft}

{S:AppliesTo|4.1|4.0}

{toc}

== Mobile CRM Server Installation==
=== Installation Overview ===
The Mobile CRM Server installation consists of 3 major components: 
* Mobile CRM Web Services website.
* Mobile CRM Configurator.
* Mobile CRM Updates website.

Installing the system consists of the following steps: 
* Installing program files via the setup wizard.
*Configuring the Mobile CRM Server.

Prerequisites:
See [CWR41Prerequisites|CWR Mobile CRM 4.1 Prerequisites].

== Installing a new installation==
Run setup.exe from the software delivery folder and follow the setup wizard.

'''Note:''' Please make sure that the correct you use the 64-bits setup files on a 64-bits server. Installing the 32-bits application on a 64-bits server will result in issues.

=== Setup wizard ===
This chapter describes which steps the setup wizard will take to install Mobile CRM Server.

[image|Setup wizard|{UP}ING41_001.jpg]

Click “Next” to start installation.

[image|Setup wizard|{UP}ING41_002.jpg]

Read the license agreement and check “I agree” if you accept. Click “Next” to continue setup

[image|Setup wizard|{UP}ING41_003.jpg]

Select the location where Mobile CRM Server is going to be installed and click “Next”.

[image|Setup wizard|{UP}ING41_005.jpg]

Please wait while the program files are copied to the selected location. After this process finishes, click “Next”.

[image|Setup wizard|{UP}ING41_006.jpg]

Installation of the Mobile CRM Server is complete. Click “Close” to exit the setup wizard.

=== Configure the Mobile CRM Server ===
====Deployment Options ====
With CWR Mobile CRM 4.1 there are several deployment and authentication options:  
{| border="0" style="text-align:center;"
!  !! AD !! IFD
|-
! Same Server
| OK || --
|-
! Different Servers
| manual steps required || OK
|}

To start the initial configuration, start the Mobile CRM Server Configurator via “Start -> Programs -> CWR Mobility -> Mobile CRM Server Configurator”.

====Mobile Web Services ====
On the first tab you can configure the Mobile Web Services. The mobile devices will communicate with these web services to synchronize data with CRM.

[image|Mobile Web Services|{UP}ING41_007.jpg]

CRM Service URL: When you install CWR Mobile CRM on another server than the CRM server, you are presented with a dialog asking for the URL to the CRM server when you start the Configurator. This URL is stored in the registry so the next time you start the tool, it will take this value from the registry.

[image|CRM Server URL|{UP}ING41_008.jpg]

When you install CWR Mobile CRM on the CRM server then this value will be taken from the registry key: “HKLM\Software\Microsoft\MSCRM\ServerUrl”.

Authentication Type: When selecting IFD as the authentication type on the first tab, you will see three new textboxes appear: username, password and domain:

[image|Authentication Type|{UP}ING41_009.jpg]

Here you will need to enter the IFD credentials you want to use for configuring the system. Note that these credentials are only used in this tool and not for communicating with the mobile devices or when using the Mobile Configurator inside CRM. These credentials are also not stored, you need to enter them every time you run this tool in IFD mode.

TCP Port: Enter the port on which the communication should occur (default 5556). This server should be available to the mobile devices over this port. So this port should be enabled on your firewall or router.

SSL Port: You can optionally enter an SSL port. SSL needs to be configured manually and cannot be done via this tool.

Client Updates Website: The client updates website will be installed as a virtual directory under the Mobile Web Services website. A mobile device can connect to this website to install the software.

====Mobile Configurator ====
On the second tab you configure the Mobile Configurator. This is a web interface that usually runs within the CRM Settings area where you can configure your CWR Mobile CRM system.

[image|Mobile Configurator|{UP}ING41_010.jpg]

Website: The Mobile Configurator will be installed as a virtual directory under a website. When you install CWR Mobile CRM on the CRM server, this field will automatically be filled with the CRM website as defined in the registry key: “HKLM\Software\Microsoft\website” and will be read-only.

When you install CWR Mobile CRM on another server, then you can select a website from the list of available websites.

External URL: When you install CWR Mobile CRM on the CRM server, this field is not used. When you install it on another server, you need to enter the External URL. This URL is used to update the CRM sitemap to point to the correct URL to access the CWR Mobile CRM configuration.

[image|External URL|{UP}ING41_011.jpg]

====Configuration Database====
CWR Mobile CRM supports multi-tenancy like Microsoft Dynamics CRM does. Information about the different organizations is stored in a Configuration Database. On the third tab you install the configuration database.

[image|Configuration Database|{UP}ING41_012.jpg]

SQL Server: You can select from a list of available SQL servers where you want to install the configuration database. If, for any reason, a SQL server doesn't appear in the list and you know it is in fact available, then you can enter the name of the SQL server yourself.

The other fields are pre-filled and read-only.

====Organization Database====
On the fourth tab you can setup an organization. A database will be created for the organization that you configure.

[image|Organization Database|{UP}ING41_013.jpg]

SQL Server: You can select from a list of available SQL servers where you want to install the configuration database. If, for any reason, a SQL server doesn't appear in the list and you know it is in fact available, then you can enter the name of the SQL server yourself.

Organization: You can select an organization from the list of available organization on your CRM server. The list of organizations is retrieved using the CRM Discovery Service so you need to be connecting to CRM as a CRM Administrator (either as a logged on user for AD or with the IFD credentials set on the first tab).

License File: You need to provide the license file that was sent to you.

'''NOTE''': It’s not possible to upgrade to version 4.1 using a version 4.0 license file. Please make sure you have the correct license. More information about the upgrade procedure, see chapter “License files and compatibility”.

Modify Sitemap: Here you can indicate whether you want to modify the CRM sitemap and make the Mobile Configurator available in the CRM Settings area, or not. If you choose to do so, it will use the External URL value that you entered on the Configurator tab to point to the Mobile Configurator.

After the initial setup, you can run this tool again. If everything is installed correctly the other tabs should be disabled. However, the Organization Database tab is still enabled and you can configure another organization.

When you click “Next” and then “Finish” on the Summary tab, the system configuration will start.

All actions, and possible errors that occur, will be logged in a log file called <date>_Configurator.log in the “C:\program files\CWR Mobility\Mobile CRM Server\Logs” folder.

== Upgrading from version 1.2 ==
For upgrading a 1.2 installation, follow these steps: 
* Uninstall 1.2 and remove everything except the database, i.e.
** Uninstall CWR Mobile CRM using “Control Panel -> Add or Remove Programs”.
** Delete the “CWR Mobile CRM” website from IIS.
** Delete the “CWRMobileConfig” virtual directory from IIS.
** Make a backup of your 1.2 database.
* Install CWR Mobile CRM 4.1 using the sections mentioned in the previous chapter.

When you come to the fourth tab Organization database, select “Upgrade existing 1.2 database”.

[image|Upgrading from version 1.2 database|{UP}ING41_014.jpg]

In the field “Existing Database” you then need to enter the name of your existing 1.2 database. This database will then be renamed to the new 4.1 convention “<organization>_CWRMOBILECRM” and the contents will be converted to the new 4.1 format.

After upgrading the databases, the licenses of all organizations must be upgraded to version 4.1. This action can be performed in the Mobile CRM Server Administrator. 

== Upgrading from version 4.0 ==
For upgrading a 4.0 installation, follow these steps: 
* Make a backup of all CWR profiles.
* Uninstall 4.0 and remove everything except the database, i.e.
** Uninstall CWR Mobile CRM using “Control Panel -> Add or Remove Programs”.
** Delete the “CWR Mobile CRM” website from IIS.
** Delete the “CWRMobileConfig” virtual directory from IIS.
** Make a backup of your 4.0 databases.
* Install CWR Mobile CRM 4.1 using the information in chapter “Installing a new installation”.

After installing the CWR Mobile CRM 4.1 application, open the Configurator. The Configurator will detect the 4.0 configuration and content databases. The Configurator will display a message stating that the configuration database must be upgraded first.

[image|Upgrading from version 4.0 database|{UP}ING41_015.jpg]

After the configuration database is upgraded, all other content databases will also be automatically updated to version 4.1.

After upgrading the databases, the licenses of all organizations must be upgraded to version 4.1. This action can be performed in the Mobile CRM Server Administrator. 

Note: It’s not possible to upgrade a specific content database; all content databases will be upgraded at the same time.

===License files and compatibility===
'''Because of changes in the license files, version 4.0 license files cannot be used with version 4.1 installations!!''' 

==Verifying your installation ==
There are a couple of areas where you can verify the correctness of your installation:

Configuration: In CRM 4.0 select the Settings Area. This should show the "CWR Mobile CRM" menu option. Select the option. This should bring you to the Mobile CRM Configurator screen.

The Web Services: Go to “http://servername:5556/mobileservice.asmx”. This should show you a list of the methods of the Mobile Service. The first part, http://servername:5556, is also the URL that you need to enter when initializing the mobile client. So make sure that you can access this URL from your mobile device.

The Updates: Go to “http://servername:5556/cwrupdates/”. This should show you the website where you can download the latest client software.

==Extra steps required for IFD and Online installations==
Due to the way authentication is handled in Internet Facing Deployments (IFD) and CRM Online installations, a number of steps must be performed to ensure correct workings of the CWR Mobile Server and Client.

'''Step 1''': To correctly log errors that originate from the Mobile Client, modify the security roles in the following manner:
* Users must have CREATE and APPEND user level rights on the '''CWR_mobilecrmlog''' entity.
* Users must have APPENDTO user level access rights on the '''systemuser''' entity.

'''Step 2''': To correctly use teams for sharing, modify the security roles in the following manner:
* Organization level READ rights on all '''teams''' for all Mobile Users.

'''Step 3''': To successfully retrieve metadata to the mobile client, modify the security roles in the following manner:
* READ rights to '''Entity''', '''Attribute''' and '''Relationship''' for all Mobile Users.

'''Step 4''': To successfully retrieve entity access rights, modify the security roles in the following manner:
* Parent: Child Business Units level READ rights on entity '''businessunit''' for all Mobile Users.

==Mobile CRM Client Installation ==
===Installation Overview ===
The Mobile CRM Client installation consists out of 3 steps: 
* Installation of Client software.
* Initializing the client environment.
* Synchronizing the initial data.

===Install Client Software (from Desktop)===
* Insert your PDA in the Docking Cradle.
* Go to “http://servername:5556/cwrupdates/”, where server name is the name of the CRM server and 5556 is the port that you have selected during the configuration of the Web Services.
* Download and run the “Full Desktop Install”.
* Click on “Deploy” to install the mobile client on your PDA or Smartphone.

[image|Installing Client Software on the workstation|{UP}ING41_016.jpg]

Note: If you get the message that the installer was unable to start installation on your PDA, open “File Explorer” on your PDA and start the file “/Temp/CWRPDAInstaller.exe”.

* The Installer will install the .Net Compact Framework, SQL Server Mobile and the 
CWR Mobile CRM Client.
* Follow the instructions on your PDA.

===Install Client Software (from PDA) ===
* Make sure your PDA is connected to a network.
* In “Pocket Internet Explorer”, on your PDA, go to “http://servername:5556/cwrupdates/”, where server name is the name of the CRM server and 5556 is the port that you have selected during the configuration of the Web Services.
* Download and run the “Full PDA Install”.
* The Installer will install the .Net Compact Framework, SQL Server Mobile and the CWR Mobile CRM Client.

[image|Installing Client Software on the PDA|{UP}ING41_017.jpg]

===Initialization of the Mobile Client ===
Note: Before initializing your mobile client you need to setup your profiles and mobile users on the server. Failing to do so before initializing the mobile client will result in the error “This user is not a Mobile User”. Please read the [CWR41ImplementationGuide|Implementation Guide] and chapter "Import profiles" for more information.

When the Mobile Client is installed, the installation has to be initialized. This means that all basic configuration information is sent to the Mobile Client. When the initialization has been performed, the user can use the Mobile Client.
Upon first starting the Mobile Client, the system will display a message stating that the local database has not been created.

[image|No database available|{UP}ING41_018.jpg]

Click on the “OK” in the top-right corner to start the initialization process. The Mobile CRM Setup is started and will guide the user through the initialization process.

[image|No database available|{UP}ING41_019.jpg]

Click “Next” in the bottom menu to continue the setup.
The following screen will ask the user for the remote URL where the CWR Server can be found. The screenshot is not representative of your organization, so make sure you have the correct URL available.

[image|Remote Server URL|{UP}ING41_020.jpg]

Click “Next” in the bottom menu to continue the setup.
The user will be asked to insert his or her credentials. These settings will be used every time the user synchronizes with the office.
Again, this screenshot is not representative of your organization, so make sure you have the correct information available.

[image|Credentials|{UP}ING41_021.jpg]

Click “Next” in the bottom menu to continue the setup. At this point, the user is validated as a legitimate Mobile User. If the user is not a valid mobile user, an error message is displayed. Contact the administrator of the Mobile Client.
On the following screen, the user is asked to place the database file in a specific location. The default location is the “My Documents” folder on the PDA. The database can be placed at any location, like a memory card.

[image|Database location|{UP}ING41_022.jpg]

Click “Next” in the bottom menu to continue the setup.
When the user clicks on the “Next” button, the wizard is ready to connect to the CWR Server, retrieve all the configuration data and initialize the Mobile Client. Before clicking “Next”, make sure you have a stable connection to the CWR Server. This is essential for a correct initialization.

[image|Start intialization|{UP}ING41_023.jpg]

Click “Next” to start the initialization process.

[image|Intializing|{UP}ING41_024.jpg]

The initialization process can take a while to complete. A message is displayed when the process is complete.

[image|Intialization complete|{UP}ING41_025.jpg]

Click on the “OK” in the top-right corner to finish the initialization process. The CWR Mobile CRM Client will start automatically and the Synchronization Manager will be shown.

===Initial Sync ===
After a successful initialization, CWR Mobile CRM will start automatically in a “Sync” Modus. 
Select “Start Sync” from the bottom menu. After the synchronization is complete, you are ready to use CWR Mobile CRM.

[image|First synchronization|{UP}ING41_026.jpg]

==Import Profiles ==
===Profiles Overview ===
CWR Mobile CRM comes with 2 default profiles out of the box: 
* A default Sales Profile designed for using “Sales” functionality from CRM.
* A default Service Profile designed for using “Service” functionality from CRM.

These profiles can be used as they are, or can be used as a template to start defining your own functionality.

The next section will explain how to load a default profile.

===Import a default profile ===
* Open Dynamics CRM and navigate to “Settings -> CWR Mobile CRM”. 
* Select the “Profiles” option.

[image|Profile overview|{UP}ING41_027.jpg]

* Select “Import”.

[image|Import|{UP}ING41_028.jpg]

* Enter a name for the profile and select the profile file to import.

[image|Import profile|{UP}ING41_029.jpg]

Note: The profiles can be found in the download section of the CWR Mobility website.

* Click on “OK” to import the Profile.

==Setup Users ==
===Users Overview===
In CWR Mobile CRM users are CRM Users that are associated to a Profile. The next chapter will explain how to setup a user in CWR Mobile CRM.

=== Add a user ===
* Open Dynamics CRM and navigate to “Settings -> CWR Mobile CRM”.
* Select “Users”.

[image|Users overview|{UP}ING41_030.jpg]

* Click on “Add”.
* Select the Profile.
* Type the username and select the correct user. Repeat if needed to add more users.

[image|Create users(s)|{UP}ING41_031.jpg]

==Uninstalling CWR software==
If you want to completely remove a server installation, there’re several steps you need to perform. These steps are:
* Uninstall CWR Mobile CRM using “Control Panel -> Add or Remove Programs”.
** If files have been added to the installation folder (default at c:\Program Files\CWR Mobility\Mobile CRM Server) after the initial setup, like log files, then the installation folder will still exist after you uninstall it. You can manually remove this folder.
* Delete the following registry key: “HKLM\Software\CWR Mobility\CWR Mobile CRM”.
* Delete the “CWR Mobile CRM” website from IIS.
* Delete the “CWRMobileConfig” virtual directory from the IIS.
** If you installed it on the CRM server, then this virtual directory will be placed under the Microsoft Dynamics CRM website.
** If you installed it on another server, then you had the option to install it under any website. Look up that website and remove it.
* Delete the “CWRAppPool” Application pool from the IIS.
* Delete the “CWRMOBILECRM_CONFIG” database.
* Delete all “<esc><</esc>organization<esc>></esc>_CWRMOBILECRM” databases.
** An <esc><</esc>organization<esc>></esc>_CWRMOBILECRM database is created for every CRM organization that you've configured.
* Remove the “CWR Mobile CRM” menu entry from the CRM sitemap.
** Export the sitemap.
** Remove the Subarea with id="nav_cwrmobilecrm" from the sitemap xml.
** Import the updated sitemap.

{TrackBack}