e-notebook sql 13.0 desktop migration and upgrade...

E-Notebook SQL13.0 Desktop Migration

and Upgrade Guide

Last Modified: October 09, 2012

E-Notebook SQL13.0 Desktop Migration and Upgrade Guide

2 of 31

© Copyright 1998-2012 CambridgeSoft Corporation. All rights reserved.

TABLE OF CONTENTS

1 Introduction ....................................................................................................................................... 3

2 Software Requirements .................................................................................................................... 3

2.1 Single User ........................................................................................................................................ 3

2.2 Remote (Shared Database Installation) ............................................................................................ 3

3 Prerequisites ..................................................................................................................................... 3

4 Database Migration and Configuration ............................................................................................. 7

4.1 Create and share E-Notebook data folders (optional) ...................................................................... 7

4.2 Migrate/Upgrade E-Notebook Database ......................................................................................... 14

4.3 Configuring E-Notebook Client to Connect to the Database .......................................................... 25

4.4 Configuring Adobe PDF Printer on E-Notebook Client (Optional) .................................................. 26

4.5 Validating the Configuration of the Database and Client ................................................................ 27

5 Remote Client Configuration (Optional) .......................................................................................... 28

5.1 Configuring Notebook Client-Server Connections .......................................................................... 28

5.2 Verification of the Remote Client Configuration .............................................................................. 30

6 Support ............................................................................................................................................ 31


3 of 31


1 Introduction

This document describes the steps required to upgrade an existing CambridgeSoft E-Notebook SQL Desktop 11

or 12.0 to version 13.0 on a desktop computer. The process includes database upgrade (and migration if

necessary) and v.13.0 client installation and configuration. There are two scenarios for the upgrade:

Migration plus Upgrade: The existing E-Notebook 11 or 12.0 Desktop database is on a different

computer than where the E-Notebook 13.0 will be deployed

Upgrade only: The E-Notebook 13.0 Desktop will be deployed on the same computer that currently hosts

the E-Notebook 11 or 12.0 database

2 Software Requirements

2.1 Single User

Operating system version: Windows XP SP3 and Windows Vista Business SP1/SP2 (32 bit), and Windows

7 professional (32 & 64 bit)

Operating system architecture: 32 bit (Windows XP SP3 and Windows Vista Business SP1/SP2) 32 bit &

64 bit (Windows 7 professional)

Microsoft Office: Office 2003 SP3, Office 2007 SP1 & SP2, and MSOffice 2010 (32-bit)

CambridgeSoft Applications: SKU with ChemDraw ActiveX Enterprise Constant control

SQL Server version: SQL Server 2008 R2 Express edition.

Microsoft .Net Framework: .Net Framework 2.0 & 4.0 2.2 Remote (Shared Database Installation)

All the Software requirements for the remote (shared data base installation) remain the same as mentioned in

point 2.1

3 Prerequisites

1. E-Notebook Client 2. ChemDraw_ActiveX_Enterprise_Constant_13.0

Both are installed by the ChemBioOffice installation wizard...


4 of 31


The Installation wizard opens. Click Next

1. The License Agreement window opens. Click the radio button next to “I accept the terms in the

license agreement” to accept the license agreement. Click Next.


5 of 31


2. Click the radio button to select the type of user for the installation. Click Next.

3. Click Next to install the ChemDraw ActiveX Enterprise Constant 13.0 to the folder.


6 of 31


4. Click Install to begin the installation process.

5. Click Finish to complete the installation process.


7 of 31


4 Database Migration and Configuration

The following sections provide instruction for database migration and configuration.

4.1 Create and share E-Notebook data folders (optional)

By default the Database Setup Wizard places all of the database and configuration files in (subfolders of):

[AppData]\CambridgeSoft\E-Notebook\13.0\.

On Windows XP this is:

C:\Documents and Settings\All Users\Application Data\CambridgeSoft\E-Notebook\13.0\

On Windows Vista and Windows 7 this is:

C:\ProgramData\CambridgeSoft\E-Notebook\13.0\

Note: The [AppData] folder is hidden by default on the Windows OS. You might prefer to have the E-Notebook

database and configuration files in a special data location if you intend to share your database, since some of the

folders are shared over the network, in some cases. The example shown below uses C: drive.

You can create the data and configuration folders in advance before running the Database Setup Wizard. If you

did not create these folders in advance, the Wizard will automatically create folders that do not exist.


8 of 31


You create three folders:

Database – Contains the actual SQL database and is not shared. Structure Index Files – Contains the index files used for structure searching. This folder must be

shared over the network with read/write permissions if you plan to allow other E-Notebook users to

connect to your database.

Configuration File – Contains the information that allows the E-Notebook client to connect to the

database. This folder must be shared over the network with read permissions if you plan to allow other E-

Notebook users to connect to your database.

1. Right click on the ‘Structure Index Files’ folder. 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’.

2. Click ‘Share this folder’ and enter a network ‘Share name’.


9 of 31


Windows XP Windows Vista

Windows 7

3. Click Permissions. The “Permissions for Structure Index Files” dialog appears.

4. In the Permissions for Structure Index Files” dialog, click ‘Add…’ and select all the users and/or user groups that will be using E-Notebook.


10 of 31


5. The “Select Users or Groups” dialog appears. Click Advanced 6. A new dialog appears. Click Find Now and select the user and /or user groups from the search results

displayed.

7. The user and/ or user group name appears in the “Enter the Object names …..” box. Click OK.

The “Permissions for E-Notebook Configuration File” dialog box opens.

8. In the ‘Group or user names’ field, select the users. or user group.

9. In the ‘Permissions for Users’ field, check ‘Change’ and ‘Read’.

10. Click OK.


11 of 31


11. Select the ‘Security’ tab in the Structure Index Files Properties dialog.

12. Click Add.

13. In the Group or user names field, select all the users, /or user groups, that will be using E-Notebook and

click Add.

14. In the Permissions for User field, highlight the users or user group, and in the ‘Permissions’ section check

‘Modify’.

15. Click OK.


12 of 31


16. Right-click on the ‘Configuration File’ folder and from the context menu select ‘Sharing and Security’ on

Windows XP. On Windows Vista and Windows 7 select ‘Share…’ and click ‘Advanced Sharing’.

17. Check ‘Share this folder’ and enter a network ‘Share name’.


13 of 31


Windows XP Windows Vista

Windows 7


14 of 31


18. Click Permissions.

19. Click Add.

20. Select all the users and/or user groups that will be using E-Notebook.

21. Click OK.

Only the ‘Read’ permission is required for the Configuration file folder.

22. Click OK.

4.2 Migrate/Upgrade E-Notebook Database

The E-Notebook migration Wizard can be used to:

Upgrade the E-Notebook 11 or 12.0 database to 13.0 on the same computer

Migrate the E-Notebook 11 or 12.0 database from a different computer and upgrade to 13.0

1. From the Windows start menu, run the E-Notebook 13.0 application


15 of 31


2. The E-Notebook application checks if there is a connection setup to an existing database. If none is

found, a dialog will display asking if you would like to create a new database, or setup a connection to

an existing database.

3. Click Yes to continue.

4. Click the radio button next to ‘Create/Migrate E-Notebook database’ to select it and click Next.


16 of 31


5. Click Next on the “Welcome to the E-Notebook Setup Wizard” dialog.

6. Click the radio button next to Migrate an existing database to select it and click Next.


17 of 31


7. The Select Source dialog box opens. In the ‘Enter a server name’ field, select the (remote) computer,

including the SQL Server instance name that hosts your E-Notebook 11.0 or 12.0 database from the

drop-down list. If the computer is not listed, you must type it manually. The ‘instance name’ used when E-

Notebook Desktop 11.0 and 12.0 were installed with the CambridgeSoft Installation Wizard is ‘CSSQL05’.


18 of 31


8. Enter the information for an account with 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 must be supplied.

(The default password for ‘sa’ is ‘CambridgeSoft_SA’ when installed through the CambridgeSoft

Installation Wizard).

9. Click Connect.


19 of 31


If the connection to the (remote) SQL server is successful, a drop-down will display with all of the databases

available on that computer.

10. In the Enter a server name field, select the E-Notebook SQL 11.0, or 12.0, database from the drop-down

menu. (The default names for E-Notebook SQL 11.0 and 12.0 databases are ‘ENDesktop11’ and

‘CSNotebook12’, respectively).

11. Click Next.

12. The selected database displays with version below. Click Next.


20 of 31


13. The “Target Server” dialog box appears. In the ‘Enter information to log on to the server’ field, click the

radio button next to ‘Use specific user name and password’. The user name default is displayed.

14. Enter the default Password (for ‘sa’ is ‘CambridgeSoft_SA’ when installed through the CambridgeSoft

Installation Wizard).

15. Click Connect.

The ‘Target Server’ dialog box appears, prompting you to enter the name of migrated E- Notebook database.


21 of 31


16. Enter a name for your E-Notebook database, or keep the default. 17. Click Next.

Note: If you are migrating to the E-Notebook database from a remote system, it is backed up and then restored

onto the new server. The backup file (.bak) must be transferred from one system to the other via a shared

network folder that both systems have access to (full control).

To transfer the backup file (.bak) from one system to the other:

1. Select a location for the backup file of the old database. In the Backup File Location image below, a

shared folder on the system that will host the 13.0 database was chosen. The shared location must be

accessible from this machine.

2. Click Next.

Default Screenshot

The image below displays the selected location for the backup in the ‘E-Notebook Database Backup File’ field.


22 of 31


3. Browse to the ‘Database’, ‘Structure Index Files’, and ‘Configuration File’ folders, if you created these

earlier. If you plan to share your database with other E-Notebook clients, you must use the ‘UNC’ or

network path of the shared folder for the ‘Structure Index Files’ (which look similar to: (“\\computer\E-

Notebook Structure Index files”). This path is used in the ‘SqlConfig.xml’ configuration file (that is saved in

the ‘Configuration File’ folder). Each client connects to ‘SqlConfig.xml’ at login to determine the SQL

Server Express with the connection settings and the path to the Structure Index Files that it needs to use.


23 of 31


The ‘Setup’ dialog box appears and the database name and path are displayed, Click Migrate..

4. The Regenerate structure files dialog - displays asking if you want to regenerate the structure files (Mol IDs in the chemical structures table). Click Yes.

5. After successfully regenerating the structure files, a confirmation dialog displays. The ‘MstFiles folder’

mentioned in the Regenerate structure files dialog is the ‘structure index folder’. It should now contain the

following 6 files:

ENotebook.msf

ENotebook.msh

ENotebook.msk

ENotebook.mss

ENotebook.mst


24 of 31


ENotebook.msx

6. Click OK.

7. After successfully creating the database, a confirmation dialog displays. A default E-Notebook

administrator account is created with the following credentials (note the capitalization):

Username: ELNAdmin

Password: ELNAdmin

This is a SQL login account used to perform the initial login and user creation. It can be disabled once at least

one other SQL or Windows E-Notebook Administrator user is created.

A note displays stating you can update the database schema, and can recreate the mst or Structure Files using

the ‘RegenerateStructureFile.exe’ application.

8. Click OK.


25 of 31


4.3 Configuring E-Notebook Client to Connect to the Database

1. After the successful migration of the database, the Configure Client wizard asks if you want to configure the

E-Notebook client on the system to connect to the newly created database. Click Yes.

Note: If you chose default settings during the database creation, you can also use the default settings in the Client Configuration tool.

2. Enter a Service Name,’’ or retain the default. You can enter any name here. This name displays at the E-Notebook login dialog.

3. Retain the default Authentication set to ‘SQL Server’ to get a login screen asking for a username and

password.


26 of 31


4. Retain the default Server Connection radio button set to ‘Server Configuration File’ and browse to the location where you created the Sqlconfig.xml file.

5. Click Save to save the ‘ENClientConfig.xml’ file. A dialog confirming the completion of the configuration will

be shown.

6. The wizard displays: Client configuration complete. Click OK.

4.4 Configuring Adobe PDF Printer on E-Notebook Client (Optional)

If you want to make use of the export to PDF functionality in E-Notebook, you must install Adobe Acrobat Pro.


27 of 31


The PDF printer on these clients must have the option 'Rely on System Fonts only: do not use document fonts'

unchecked.

4.5 Validating the Configuration of the Database and Client

We recommend that you confirm the proper setup of the database and client by logging into E-Notebook and

performing some basic tasks.

1. Launch E-Notebook from the start menu and login using the pre-defined SQL Administrative User Name and

Password ‘ELNAdmin/ELNAdmin’.

2. Create a new ‘Chemistry Notebook’ with a Reaction section.

3. Draw a reaction and save it to the database.

4. Perform a structure search for one of the reagents you just submitted.

5. Export the notebook page to MS Word and/or PDF.

6. Create a new non-admin E-Notebook user (SQL authentication) and login as this new user.


28 of 31


You should not observe errors during these steps. If errors occur, there is a problem with one of your settings. If

you are unable to troubleshoot the problem, please contact CambridgeSoft support.

5 Remote Client Configuration (Optional)

5.1 Configuring Notebook Client-Server Connections

Each E-Notebook client must be configured with the proper entries to connect to the E-Notebook Database and

these settings are maintained in the ENClientConfig.xml file.

1. From the Windows Start menu, navigate to Programs > ChemBioOffice 2012 > E-Notebook >

E-Notebook Client Setup.

The Configure E-Notebook Client dialog box displays. 2. Enter a ‘Service Name’ or retain the default. You can enter any name here. This name displays at the E-

Notebook login dialog. 3. Retain the Authentication set to ‘SQL Server’ to get a login screen asking for a username and password.

4. Retain the ‘Server Connection’ radio button set to ‘Server Configuration File’

5. Browse to, or enter, the shared folder (in UNC format) that contains the E-Notebook Configuration file (‘SqlConfig.xml’) on the computer with the E-Notebook database.


29 of 31


6. Click Save to save the ‘ENClientConfig.xml’ file. A dialog confirming the completion of the configuration

displays.

7. Click OK.

8. The Login dialog appears. Enter the User Name and Password setup for the remote user (or use the default

admin account ‘ELNAdmin/ELNAdmin’).

9. Click Connect.


30 of 31


The E-Notebook client starts and connects to the database.

5.2 Verification of the Remote Client Configuration

We recommend you confirm the proper setup of the client by logging into E-Notebook and performing some basic

tasks.

1. Launch E-Notebook from the start menu and login using a user account setup by the E-Notebook

Administrator.


31 of 31


2. Create a new ‘Chemistry Notebook’ with a Reaction section.

3. Draw a reaction and save it to the database.

4. Perform a structure search for one of the reagents you just submitted.

5. Export the notebook page to MS Word and/or PDF.

6. Create a new non-admin E-Notebook user (Windows, LDAP or SQL authentication) and login as this new

user.

You should not observe errors during these steps. If errors occur, there is a problem with one of your settings. If

you are unable to troubleshoot the problem, please contact support.

6 Support

This software is supported by PerkinElmer Informatics Support PerkinElmer Inc. | For the Better 100 CambridgePark Drive, Cambridge, MA 02140 www.perkinelmer.com/informatics/support