On premise upgrade guide (to 3.3) XperiDo for Microsoft Dynamics CRM

Transcription

1 On premise upgrade guide (to 3.3) XperiDo for Microsoft Dynamics CRM Last updated:

2 Table of contents Table of contents Beginning Prerequisites and required files Support options About this guide Website backup Website backup Install XperiDo XperiDo Installation Install client applications Setup XperiDo libraries Update project Update database Update 3.2 project objects On premise upgrade guide (to 3.3) XperiDo for Microsoft Dynamics CRM 2

3 The following guide describes the process of upgrading XperiDo from 3.2 to 3.3. On premise upgrade guide (to 3.3) XperiDo for Microsoft Dynamics CRM 3

4 1 Beginning 1.1 Prerequisites and required files XperiDo 3.3 requires the following prerequisites in order to work: Java JDK 1.7+.NET Framework IIS (with URL rewrite and Application Request Routing) Please ensure that these are installed before upgrading XperiDo. The following files are required during the upgrade process: Invenso.XBi.Administrator.Install.msi, which is the installer for the XBintegrator Administrator Console. Invenso.XBi.XBids.Install.msi, which is the installer for the XBintegrator Development Studio. xperidocrm-install-x64.jar, which is the XperiDo installer. XDCrmServices.xar and XDCrmCustomerBase.xar, which are XperiDo libraries. Invenso.XperiDo.Setup or Invenso.XperiDo.Machine.Setup, which are the installers for the Word add-in. XperiDo_3_3_x_managed_online.zip, XperiDo_3_3_x_managed_onpremise.zip, or XperiDo_3_3_x_managed_onpremise_sandbox.zip, which are the XperiDo solutions voor CRM. Which one you need depends on your CRM type. Please note that upgrading XperiDo yourself is a process that can take several hours, and it should be done with care. 1.2 Support options Should you, at some point, require assistance, you can contact Invenso's helpdesk by sending a mail to support@invenso.com. The online application, where you can manage your tickets, can be found at You can register in the helpdesk application to create an account. After completing the account information, activating and approving the account, the helpdesk application is ready to use. 1.3 About this guide This guide was adapted from the previous upgrade guide, which means that the screenshots feature the previous version numbers. The windows/graphics haven't changed, except for the numbers - so don't panic when you see a different number on your screen. On premise upgrade guide (to 3.3) XperiDo for Microsoft Dynamics CRM 4

5 2 Website backup 2.1 Website backup We strongly advise you to make a backup of the current website, in case it gets overwritten. Changes made to the web.config file will be lost if this happens. To find the location of your website, go into IIS Manager, select XperiDo Configuration and then you can select Explore in the Actions pane. This opens an explorer window with the current website in it: On premise upgrade guide (to 3.3) XperiDo for Microsoft Dynamics CRM 5

6 Copy the complete folder and paste it in a secure location. On premise upgrade guide (to 3.3) XperiDo for Microsoft Dynamics CRM 6

7 3 Install XperiDo XperiDo Installation Open a command window (as an administrator), navigate to the folder where the xperidocrm-install-x64.jar file is, type java -jar xperidocrm-install-x64.jar and hit Enter. The XperiDo installer will now start. On premise upgrade guide (to 3.3) XperiDo for Microsoft Dynamics CRM 7

8 Accept the terms of the license agreement and click Next. Choose the location where you want to back up the previous installation, then click Backup and uninstall. On premise upgrade guide (to 3.3) XperiDo for Microsoft Dynamics CRM 8

9 An uninstaller will pop up. Click Uninstall. On premise upgrade guide (to 3.3) XperiDo for Microsoft Dynamics CRM 9

10 Wait until the uninstaller is finished, then click Quit. Once the uninstaller is done and the green bar (in the installer) is full, click Next. The next screen lists the status of some of the prerequisites. If one or more prerequisites are not installed, please install them and click Refresh before continuing. On premise upgrade guide (to 3.3) XperiDo for Microsoft Dynamics CRM 10

11 Next, select the installation path where you would like to install XperiDo. You will need to give confirmation if the directory is to be created. On premise upgrade guide (to 3.3) XperiDo for Microsoft Dynamics CRM 11

12 In the next screen, the installer detects the current installation of the Java JDK. Click Next to confirm. Next, choose the folder where you want to store the logging and set the logging level. The higher the level, the more information is logged and the more space the logging will use up. On premise upgrade guide (to 3.3) XperiDo for Microsoft Dynamics CRM 12

13 Then, choose the port for the XperiDo webserver. This is only required for XperiDo Nucleus. In the next screen, you need to enter the current password for the admin user for the XBintegrator service. On premise upgrade guide (to 3.3) XperiDo for Microsoft Dynamics CRM 13

14 Then, the installation will begin. Wait for the bars to fill up and click Next. Again, wait for the bar to fill up and click Next. On premise upgrade guide (to 3.3) XperiDo for Microsoft Dynamics CRM 14

15 On premise upgrade guide (to 3.3) XperiDo for Microsoft Dynamics CRM 15

16 The next screen lists the status of some of the prerequisites. If one or more prerequisites are not installed, please install them and click Refresh before continuing. The next screen asks where you want to store the XperiDo website and what you want to call it. But you can select Use an existing site: XperiDo Configuration. On premise upgrade guide (to 3.3) XperiDo for Microsoft Dynamics CRM 16

17 If everything went well, the installer will display a message saying that the installation was completed successfully. On premise upgrade guide (to 3.3) XperiDo for Microsoft Dynamics CRM 17

19 4 Install client applications In order to be able to configure XBintegrator's settings, you require the XBintegrator client applications. You'll need to install the 6.6 version of these applications as those are designed for use with XperiDo 3.3. Run the 2 installers: Invenso.XBi.Administrator.Install.msi, which is the installer for the XBintegrator Administrator Console. Invenso.XBi.XBids.Install.msi, which is the installer for the XBintegrator Development Studio. On premise upgrade guide (to 3.3) XperiDo for Microsoft Dynamics CRM 19

20 5 Setup XperiDo libraries An XperiDo update comes with updated XperiDo libraries, so we'll install these. Open the XBintegrator Administrator Console and navigate to the repository. In here, delete XDCrmCustomerBase and XDCrmServices. Next, open the XBintegrator Development Studio. Right-click Projects and import the latest XDCrmCustomerBase and XDCrmServices. Do not check the box that says Deploy to active role. On premise upgrade guide (to 3.3) XperiDo for Microsoft Dynamics CRM 20

24 Then, deploy XDCrmServices, followed by XDCrmCustomerBase. The order in which you deploy is important. On premise upgrade guide (to 3.3) XperiDo for Microsoft Dynamics CRM 24

26 6 Update project Next, we need to update the current project. This is usually called XDCrm<customername>. In the XBintegrator Development Studio, open that project. On premise upgrade guide (to 3.3) XperiDo for Microsoft Dynamics CRM 26

27 Open the project and delete the Base folder from it. On premise upgrade guide (to 3.3) XperiDo for Microsoft Dynamics CRM 27

28 Copy the Base folder from XDCrmCustomerBase... On premise upgrade guide (to 3.3) XperiDo for Microsoft Dynamics CRM 28

29 ...and paste that Base folder in the current project. On premise upgrade guide (to 3.3) XperiDo for Microsoft Dynamics CRM 29

30 Then, find the script ReCreateProjectCustomServices (in XDCrmServices) and run it. On premise upgrade guide (to 3.3) XperiDo for Microsoft Dynamics CRM 30

32 Under Data Input, type the name of the current project. On premise upgrade guide (to 3.3) XperiDo for Microsoft Dynamics CRM 32

33 When it's finished (when all the little bullets are green), click Finish. Then, Synchronize the current project: On premise upgrade guide (to 3.3) XperiDo for Microsoft Dynamics CRM 33

34 Then, open the script DocuSignUpdateTransaction. On premise upgrade guide (to 3.3) XperiDo for Microsoft Dynamics CRM 34

36 Change --> to -->. In your case, change XDCrmInvenso to your current project's name. On premise upgrade guide (to 3.3) XperiDo for Microsoft Dynamics CRM 36

38 Commit the script. On premise upgrade guide (to 3.3) XperiDo for Microsoft Dynamics CRM 38

39 Then, deploy the entire project. Next, restart the XBi Admin Server Service. On premise upgrade guide (to 3.3) XperiDo for Microsoft Dynamics CRM 39

40 7 Update database The next thing to do is update the database. Navigate to XDCrmServices > Base > DataBase. Run the script UpdateDataBase_XDCRM Click Next. On premise upgrade guide (to 3.3) XperiDo for Microsoft Dynamics CRM 40

41 Wait for all the little bullets to turn green and click Finish. On premise upgrade guide (to 3.3) XperiDo for Microsoft Dynamics CRM 41

42 8 Update 3.2 project objects XperiDo 3.3 uses the XTA file format to bundle multiple DOCX files into one XperiDo Template Archive. This means that your previous 3.2 templates need to be updated so that they are compatible with XperiDo 3.3. We have provided 2 scripts that help you update your 3.2 project objects to 3.3-compatible objects: /XDCrmServices/Promotion/ConvertDocx_Xta.xb /XDCrmServices/Promotion/FixDocMergeTemplate.xb Perform the following steps to update all of your project's objects: 1) Run the script ConvertDocx_Xta.xb. 2) In the Data Input window, input the following:...where you substitute yourprojectname with your project name, such as XDCrmInvenso. 3) Click Next and wait for all the bullets to turn green. When they have turned green (after clicking Refresh), click Finish. 4) If a template is locked (because it was checked out by someone), it is best that you remove the lock and run the script again. 5) Now run the same script for the database. The change is in the input parameters: On premise upgrade guide (to 3.3) XperiDo for Microsoft Dynamics CRM 42

43 6) Click Next and wait for all the bullets to turn green. When they have turned green (after clicking Refresh), click Finish. 7) Next, run the FixDocMergeTemplate.xb script with the following parameters:...where you substitute yourprojectname with your project name, such as XDCrmInvenso. On premise upgrade guide (to 3.3) XperiDo for Microsoft Dynamics CRM 43

44 8) Click Next and wait for all the bullets to turn green. When they have turned green (after clicking Refresh), click Finish. If everything went well, you should have converted all your 3.2 project objects to 3.3 objects. On premise upgrade guide (to 3.3) XperiDo for Microsoft Dynamics CRM 44