E-Notebook SQL 12.0 Desktop Database Migration and Upgrade Guide
1. Introduction... 3 2. Database System... 3 2.1. Software requirements... 3 2.2. Analysis of E-Notebook 10.0 and 11.0 database... 4 2.3. Database Migration and Configuration... 6 2.3.1. Create and share E-Notebook data folders (optional)... 6 2.3.2. Migrate/Upgrade E-Notebook Database... 10 2.4. Configure E-Notebook Client to connect to the database... 17 2.5. Configure Adobe PDF printer on E-Notebook client... 19 2.6. Confirm proper configuration of the database and client... 19 3. Remote Client Configuration... 20 3.1. Software requirements... 20 3.2. E-Notebook client-server connection configuration... 21 3.3. Configure Adobe PDF printer on E-Notebook client... 24 3.4. Confirm proper configuration of the remote connection... 24 Page 2 of 24
1. Introduction This document describes the steps required to upgrade an existing CambridgeSoft E- Notebook SQL Desktop 10.0 or 11.0 database to version 12.0 on a desktop or workstation computer. There are two scenarios for the upgrade: The existing E-Notebook 10.0 or 11.0 Desktop database is on a different computer than where the E-Notebook 12.0 database will be deployed (migration plus upgrade) The E-Notebook 12.0 Desktop database will be deployed on the same computer that currently hosts the E-Notebook 10.0, 11.0 or 11.5 database (upgrade) 2. Database System 2.1. Software requirements Operating system version: Windows XP Pro SP2/SP3 or Windows Vista Business SP1/SP2 Operating system architecture: 32 bit Microsoft Office: Office XP SP3, Office 2003 SP3, Office 2007 SP1 CambridgeSoft Applications: SKU with ChemDraw ActiveX control and E- Notebook client SQL Server version: SQL Server 2005 Express Edition with Advanced Services SP3 (as installed by the CambridgeSoft version 12 Installation Wizard).Net Framework:.Net Framework 2.0 SP2 Page 3 of 24
2.2. Analysis of E-Notebook 10.0 and 11.0 database Due to bugs in older client versions it is possible that some database corruption has taken place in the E-Notebook 10.0 and 11.0 Desktop databases. This will interfere with a proper migration to 12.0 and so it is recommended to run the Migration Analysis tool first against your E-Notebook 10.0 or 11.0 database. Browse to the Migration Analysis folder in your E-Notebook installation folder (default is C:\Program Files\CambridgeSoft\ChemOffice2010\E-Notebook 12.0\Utilities\Migration Analysis ). MigrationFrom11.exe. Provide the name of the E-Notebook 10.0 or 11.0 database (the default is ENDesktop10 and ENDesktop11 respectively), the server name where the 10.0/11.0 database is installed and the SQL server instance name that runs the 10.0/11.0 database (default is CAMBRIDGESOFT and CSSQL05 respectively). The connection string is generated based on the entries from the first dialog. Now a userid and password needs to be entered that has administrative access to the SQL server (the sa account is recommended. The default password for sa is CambridgeSoft_SA when installed through the CambridgeSoft Installation Wizard). Select a folder where the results can be saved and press Analyze Page 4 of 24
During the analysis several message will appear in the dialog with ready being the last. In the output folder where the analysis files were created, open the file MigrationProgIDs.htm and look if there are any gaps or duplicates ; other errors like invalid object name can be ignored. If you do find gaps or duplicates a SQL script needs to be constructed to fix them. There is a sample script CorrectFieldListenerPositions.sql in the Migration Analysis folder that can be used as a guide. Please contact CambridgeSoft support if you run into problems constructing the SQL query. During the analysis there are several.xml files created that contain configuration information and that need to be used for updating your database to version 12. Browse into the analysis output folder and copy the newly generated.xml files into the C:\Program Files\CambridgeSoft\ChemOffice2010\E-Notebook 12.0\Utilities\Configuration folder (overwriting any identically named existing files) Page 5 of 24
2.3. Database Migration and Configuration 2.3.1. Create and share E-Notebook data folders (optional) By default the Database Setup Wizard will place all the database and configuration files in (subfolders of): [AppData]\CambridgeSoft\E-Notebook\12.0\ On Windows XP this will be: C:\Documents and Settings\All Users\Application Data\CambridgeSoft\E-Notebook\12.0\ On Windows Vista this will be: C:\ProgramData\CambridgeSoft\E-Notebook\12.0\ Note that the [AppData] folder is by default hidden on the Windows OS. Users might prefer to have the E-Notebook database and configuration files in a special data location if you plan on sharing your database since some of the folders need to be shared over the network in that case. The example below will use a data hard drive. You can create the data and configuration folders in advance before running the Database Setup Wizard but if you have not so, the Wizard will automatically create any specified folders that do not exist. Create three folders: Database will contain the actual SQL database and is not shared. Structure Index Files will contain the index files that are used for structure searching. This folder needs to be shared over the network with read/write permissions if you are going to allow other E-Notebook users to connect to your database. Configuration File will contain the information to allow the E- Notebook client to connect to the database. This folder needs be shared over the network with read permissions if you are going to allow other E- Notebook users to connect to your database. Page 6 of 24
Right click the Structure Index Files folder and from the context menu select Sharing and Security on Windows XP. On Windows Vista (with the share wizard turned off) select Share and click Advanced Sharing. Check Share this folder and type a network Share name. Windows XP Windows Vista Click the Permissions button. Click Add and select all the users and/or user groups that will be using E- Notebook. <OK> Select the users or user group and in the Permissions section check change and read. <OK> Page 7 of 24
Select the Security tab of the properties dialog. In Windows 2008 click Edit Click Add Again select all the users and/or user groups that will be using E-Notebook. <OK> Highlight the users or user group and in the Permissions section check Modify. <OK> Page 8 of 24
Right click the Configuration File folder and from the context menu select Sharing and Security on Windows XP. On Windows Vista select Share and click Advanced Sharing. Check Share this folder and type a network Share name. Windows XP Windows Vista Click the Permissions button. Click Add and select all the users and/or user groups that will be using E- Notebook. <OK> Only the read permission is required for the Configuration file folder. <OK> Page 9 of 24
2.3.2. Migrate/Upgrade E-Notebook Database The E-Notebook migration Wizard can be used to: Upgrade the E-Notebook 10.0 or 11.0 database to 12.0 on the same computer Migrate the E-Notebook 10.0 or 11.0 database from a different computer and upgrade to 12.0 From the Windows start menu run the E-Notebook 12.0 application The E-Notebook application will check if there is already a connection setup to an existing database. If none is found a dialog will be displayed asking you if you would like to create a new database or setup a connection to an existing database. Press Yes to continue Page 10 of 24
Select the Create/Migrate E-Notebook database radio button and press next. On Windows Vista allow elevated admin permissions. After clicking Next on the welcome screen, select Migrate an existing database <Next> Page 11 of 24
In the server name field select the (remote) computer including the SQL Server instance name that hosts your E-Notebook 10.0 or 11.0 database from the dropdown list. If the computer is not listed you need to type it in manually. The instance name used when E-Notebook Desktop 10.0 and 11.0 were installed with the CambridgeSoft Installation Wizard is CAMBRIDGESOFT and CSSQL05 respectively. Enter the information of an account that has administrative access to the remote SQL server. (If the user who is logged into the SQL server system is an administrator on both systems, Windows integrated security can be used. Otherwise a SQL user (usually sa ) that has administrative permissions has to be supplied. (The default password for sa is CambridgeSoft_SA when installed through the CambridgeSoft Installation Wizard). Press Connect If the connection to the (remote) SQL server is successful, a drop-down will appear with all the databases that are available on that computer. Select the E-Notebook SQL 10.0 or 11.0 database (default names for E-Notebook SQL 10.0 and 11.0 databases are ENDesktop10 and ENDesktop11 respectively). <next> Page 12 of 24
The entries for the server name where you want to create the E-Notebook 12.0 database and information to login to the SQL server Express can be left at default. The local value will automatically be converted to the name of your computer. Enter a name for your E-Notebook database or leave it at the suggested default. <Next> If you are migrating a version 10.0 E-Notebook database you will be given the option to convert the existing Windows user accounts to SQL user accounts. In particular if you are not on a domain and are migrating the database to a different computer, this is highly recommended. From the Existing User Name drop-down list, choose the windows user that you would like to convert. Enter the new SQL user name that you would like to use Press Save Page 13 of 24
This dialog is only seen when migrating from a 10.0 database A confirmation dialog will show confirming a new SQL login account was created. The above three steps need to be repeated for each existing user that you would like to convert. If you are migrating the E-Notebook database from a remote system, it will be backed up and then restored onto the new server. The backup file (.bak) needs to be transferred from one system to the other via a shared network folder that both systems have access to (full control). Select a location for the backup file of the old database. In the screenshot below a shared folder on the system that will host the 12.0 database was chosen but it can be any shared network resource. This dialog is only seen when migrating a remote database Page 14 of 24
Browse to the database, Structure Index Files and Configuration File folders if you have created them earlier. If you plan to share your database with other E- Notebook clients, you will have to use the UNC or network path of the shared folder for the Structure Index Files (which will look something like \\computer\e-notebook Structure Index files ). This path will be used in the SqlConfig.xml configuration file (that is saved in the Configuration File folder). Each client connects to SqlConfig.xml on login to determine the SQL Server Express with the connection settings and the path to the Structure Index Files that it needs to use. Leave the two check boxes checked. A summary dialog is displayed with the database that will be created in SQL Server. If you would like to use the same users in the E-Notebook 12.0 database as in 11.0, select the Migrate ENotebook users and logins checkbox so that the appropriate entries are made in SQL server. Press Create to start the process. Depending on the SQL server system configuration the upgrade process will take some time to finish. Page 15 of 24
After successfully creating the database, a confirmation dialog will be displayed. The MstFiles folder that the dialog talks about is the structure index folder. It should now contain the following 6 files: ENotebook.msf ENotebook.msh ENotebook.msk ENotebook.mss ENotebook.mst ENotebook.msx Page 16 of 24
2.4. Configure E-Notebook Client to connect to the database After successfully migrating the database, the wizard will show a dialog asking if you want to configure the E-Notebook client on the system to connect to the newly created database. Press Yes. If you chose all the defaults during the database creation, you can also use the defaults in the Client Configuration tool. Enter a service name or leave it at the suggested default. This name can be anything and will show on the E-Notebook login dialog. Keep the authentication set to SQL Server so that you will get a login screen that asks for a username and password. Keep the server connection radio button set to Server Configuration File and browse to the location where you created the Sqlconfig.xml file. Page 17 of 24
Press OK to save the ENClientConfig.xml file. A dialog confirming the completion of the configuration will be shown. <OK> In the login dialog that now appears enter ELNAdmin/ELNAdmin for the username and password and press Connect. The E-Notebook client will now start and connect to the database. Page 18 of 24
2.5. Configure Adobe PDF printer on E-Notebook client If you wish to make use of the export to PDF functionality in E-Notebook, it is required that Adobe Acrobat Pro is installed. The PDF printer on these clients needs to have the option 'Rely on System Fonts only: do not use document fonts' unchecked. 2.6. Confirm proper configuration of the database and client It is recommended to confirm the proper setup of the database and client by logging into E-Notebook and performing some basic tasks. Launch E-Notebook from the start menu and login using the pre-defined SQL administrative user account with login/password ELNAdmin/ELNAdmin. Create a new Chemistry Notebook with a reaction page Draw a reaction and save it to the database Do a structure search for one of the reagents you just submitted Export the notebook page to MS Word and/or PDF Create a new non-admin E-Notebook user (SQL authentication) and login as this user. During these tasks no errors should show otherwise there is a problem with one of the settings. If you are unable to trouble shoot the problem, please contact CambridgeSoft support. Page 19 of 24
3. Remote Client Configuration 3.1. Software requirements Operating system version: Windows XP Pro SP2/SP3 or Windows Vista Business SP1/SP2 Operating system architecture: 32 bit Microsoft Office: Office XP SP3, Office 2003 SP3, Office 2007 SP1 CambridgeSoft Applications: SKU with ChemDraw ActiveX control and E- Notebook client SQL Server version: SQL Server 2005 native client (installed by the CambridgeSoft version 12 Installation Wizard).Net Framework:.Net Framework 2.0 SP2 Page 20 of 24
3.2. E-Notebook client-server connection configuration Each E-Notebook client needs to be configured with the proper entries to be able to connect to the E-Notebook Database. These settings are maintained in the ENClientConfig.xml file in: From the Windows start menu run the E-Notebook 12.0 application The E-Notebook application will check if there is already a connection setup to an existing database. If none is found a dialog will be displayed asking you if you would like to create a new database or setup a connection to an existing database. Press Yes to continue Page 21 of 24
Select the Configure Client to connect to an existing database radio button and press next. Enter a service name or leave it at the suggested default. This name can be anything and will show on the E-Notebook login dialog. Keep the authentication set to SQL Server so that you will get a login screen that asks for a username and password. Keep the server connection radio button set to Server Configuration File Browse to, or enter, the shared folder (in UNC format) that contains the E- Notebook Configuration file ( SqlConfig.xml ) on the computer that has the E- Notebook database. Page 22 of 24
Press OK to save the ENClientConfig.xml file. A dialog confirming the completion of the configuration will be shown. <OK> In the login dialog that now appears enter the username and password that is setup for the remote user (or use the default admin account ELNAdmin/ELNAdmin ) and press Connect. The E-Notebook client will now start and connect to the database. Page 23 of 24
3.3. Configure Adobe PDF printer on E-Notebook client On all clients that wish to make use of the export to PDF functionality, it is required that Adobe Acrobat Pro is installed. The PDF printer on these clients needs to have the option 'Rely on System Fonts only: do not use document fonts' unchecked. 3.4. Confirm proper configuration of the remote connection It is recommended to confirm the proper setup of the client by logging into E-Notebook and performing some basic tasks. Launch E-Notebook from the start menu and login using a user account that was setup by the E-Notebook administrator. Create a new Chemistry Notebook with a reaction page Draw a reaction and save it to the database Do a structure search for one of the reagents you just submitted Export the notebook page to MS Word and/or PDF Create a new non-admin E-Notebook user (Windows, LDAP or SQL authentication) and login as this user. During these tasks no errors should show otherwise there is a problem with one of the settings. If you are unable to trouble shoot the problem, please contact CambridgeSoft support. Page 24 of 24