MX-Contact Instruction Sheet Setting up SQL Replication SQL 2000

Transcription

1 1 Introduction The purpose of this Instruction Sheet is to describe how to set up SQL Replication from Microsoft SQL Server 2000 to an MSDE database so that MX-Contact Enterprise Edition can be used offline, or disconnected from the main SQL Server database. This document should assist you in answering the following typical questions that are asked: How can I use MX-Contact Enterprise Edition in offline mode? 2 Other Documents Required This document references other documents and scripts, which should be contained in the zip file with the same name as this document: Item_Level_Security_Replication.zip 3 Installing the Admin Client Computer Install a computer that will function as the Administrator workstation for the main SQL Server database. Follow the instructions in the Installation Guide, making sure you set the necessary permissions. This computer will be needed to make certain changes on the central SQL Server database, so as to limit to data (where appropriate) that will be replicated down to the remote client computers. 4 Installation of the Remote Clients 4.1 Installing the Remote Clients Install MX-Contact on the remote client computers using the relevant offline package (MXContact_MSDE_Install_ exe for a SQL Server 2000 host database). This installation package has a corresponding Installation Guide that should be followed step by step. 4.2 Configuring the Offline SQL Database for Remote Connections The next step is to check that the SQL Server MSDE database can be accessed by a remote client (which in this case is actually the central SQL Server host computer), so that the host server can push data down to the offline computer. For an MSDE Database proceed as follows: 1. If you are running Windows XP Service Pack 2 or have a Firewall configured you will need to make the following changes to your Firewall. Open Windows Firewall from Control Panel and click on the Exceptions tab: ExchangeWise (Pty) Ltd Page 1

2 2. Add UDP Port 1434 by clicking on Add Port: 3. Click on OK. 4. Click Add Program. Click Browse and navigate to the \Program Files\Microsoft SQL Server\MSSQL\Binn and select the sqlservr.exe file. Click Open and then click OK. You should now have 2 additional exceptions listed: ExchangeWise (Pty) Ltd Page 2

3 Your SQL Server should now be able to be accessed by the remote clients that will connect to this server. 5 Preparing the Host Two methods are described in this Instruction Sheet for setting up offline use, namely i) a stepby-step manual process setting up replication of the complete database to each offline client so that one can understand exactly what is involved in setting up replication, and ii) a scripted process that creates a Publication and Subscriptions via SQL script files that replicate a restricted sub-set of the database for each user based on the Item Level Security rules. In both cases, there is some initial setup required on the host SQL Server, namely: Checking the SQL Server Registration. Setting up the SQL Server Agent. Configuring the Server for Publishing. Creating an Offline Group. Updating your MX-Contact Database. 5.1 Checking the SQL Server Registration Before you configure the server for publishing you need to check that you have registered the SQL Server under its actual server name, rather than as (local). ExchangeWise (Pty) Ltd Page 3

4 If you have registered the server as (local), delete the registration and re-add the SQL Server to the SQL Server Group using its actual server name (as shown for CHEXSVR2 in the example above). 5.2 Setting up the SQL Server Agent Before you configure the server for publishing you need to check the Properties of the SQL Server agent (under Management->SQL Server Agent): If you have installed the SQL Server Agent to run under a local System Account rather than under a Domain User account, the service can access only the local computer. If the Snapshot Agent that runs under SQL Server Agent is configured to use Windows Authentication Mode when it logs in to SQL Server, the Snapshot Agent fails. You must therefore configure the SQL Server Agent to run under a Domain User account that also has rights to access the various computers in the domain that will be set up for replication. It is suggested that you create a User Account called sqlagent for this purpose. 5.3 Configuring the Server for Publishing To configure the server for publishing, do the following: ExchangeWise (Pty) Ltd Page 4

5 1. From within Enterprise Manager select Tools->Replication->Configure Publishing, Subscribers and Distribution: 2. Click Next. 3. Check the option to make the server its own distributor. Click Next. 4. You may receive a message telling you that you need to specify a SQL ServerAgent account. Click OK. ExchangeWise (Pty) Ltd Page 5

6 5. Check the option to configure the SQL Server Agent to start automatically. Click Next. 6. Select a folder on the SQL Server that that been shared as a Replication folder where the snapshots of each publication will be created. Note that the remote computers must have access rights to this shared folder. Click Next. ExchangeWise (Pty) Ltd Page 6

7 7. Click Next. 8. Click Finish. 5.4 Creating a SQL Server Group The next step is to create a SQL Server Group for the Offline Users. Do the following: 1. Create a new SQL Server Group called MX-Contact Offline Users: 2. Ensure that each remote computer is connected to the network. 3. Register each remote server in Enterprise Manager in the new group by right clicking on the group and selecting New SQL Server Registration: ExchangeWise (Pty) Ltd Page 7

8 4. The Register SQL Server Wizard will appear: 5. Click Next. ExchangeWise (Pty) Ltd Page 8

9 6. Select the servers corresponding to the remote offline servers by clicking Add, and then click Next: 7. Check the option for Windows Authentication and click Next: ExchangeWise (Pty) Ltd Page 9

10 8. Select Add the SQL Server(s) to an existing SQL Server Group. Click Next: 9. Click Finish. 5.5 Updating your MX-Contact Database In order to use the MX-Contact database offline, you will need to apply certain updates to your database. Do the following: 1. Open Enterprise Manager, select your MX-Contact database and open SQL Query Analyser. 2. Some additional scripts relating to replication are included in a separate zip file called Item_Level_Security_Replication.zip in the MXContact_Instruction_Sheet..zip file. Extract this file to a sub-folder off My Documents. 3. Open SQL Query Analyser and run the following scripts: Triggers_CREATE_Not_For_Replication.sql 6 Setting Up Replication Full Database Replication The first method for setting up offline use described below is a step-by-step manual process setting up replication of the complete database to each offline client so that one can understand exactly what is involved in setting up replication. You will go through the following steps: Creating the Publication Generating and applying initial snapshot Setting the Publication Permissions Synchronizing and propagating data ExchangeWise (Pty) Ltd Page 10

11 6.1 Creating the Publication The next step is to create a Publication for your MX-Contact database. Do the following: 1. From within Enterprise Manager, right click on the Publications folder below Replication and select New Publication: 2. Click Next. 3. Select the host database that you are synchronizing to the remote client machine. Click Next. ExchangeWise (Pty) Ltd Page 11

12 4. Select Merge publication. Click Next. 5. Select the various SQL Server versions running on the remote client machines. Click Next. 6. Select Show and Publish All for Tables only. Click Next. ExchangeWise (Pty) Ltd Page 12

13 7. Click Next. 8. Enter the Publication name Merge_All and click Next. 9. Select No, create the publication as specified. Click Next. ExchangeWise (Pty) Ltd Page 13

14 10. Click Finish. 11. Click Close. 12. Monitor the Snapshot Agent under the Replication Monitor->Agents to establish when the Snapshot has been created. ExchangeWise (Pty) Ltd Page 14

15 13. Ensure that it completes successfully. 6.2 Generating and Applying the Initial Snapshot The next step is to create a Subscription for each remote user/msde database. For this you need the machine/server name of each user. Do the following: 1. Highlight the Publication Merge_All, right click and select Push New Subscription: 2. Click Next: ExchangeWise (Pty) Ltd Page 15

16 3. Select the remote client machines for which you want to create a subscription. These will appear under the MX-Contact Offline Users Group. Click Next: 4. Enter the name of the Subscriber Database. This will usually be MXContact. Click Next. (NOTE: By this stage you should ve already installed MX-Contact on the remote client machine and created the local MX-Contact database as per the instructions in the MXContact_Installation_Guide_SOHO_Edition_MSDE.doc document.) ExchangeWise (Pty) Ltd Page 16

17 5. Check the option Continuously.. if you want the replication to occur automatically whenever the Subscriber connects to the network. If you check the option Using the following schedule.., you will have to run the MXSubscribe.exe utility whenever you want to force a replication from the central SQL Server to the remote (offline) server: 6. Select the option Yes, initialize the schema and data. Click Next: ExchangeWise (Pty) Ltd Page 17

18 7. Select the option Use the Publisher as a proxy for the Subscriber when resolving conflicts. Click Next: 8. Make sure that the SQLServerAgent is running. Click Next. ExchangeWise (Pty) Ltd Page 18

19 9. Click Finish: 10. Click Close. 11. Use the Merge Agent to monitor the progress of the subscription being pushed down to the client computers. 12. Ensure that it completes successfully. 6.3 Setting the Publication Permissions Once you have created the Publication, you need to give access to this publication to the Remote Users. Do the following: 1. Right click on the Merge_All Publication, and select Properties. 2. Click the Publication Access List Tab: ExchangeWise (Pty) Ltd Page 19

20 3. Click on Add: 4. Select the MX-Contact Users group and click OK. ExchangeWise (Pty) Ltd Page 20

21 5. Check that the group is added to the Access List and click OK. 6.4 Synchronizing and Propagating Data Once the Jobs are started on the SQL Server, the remote computers will be updated automatically whenever a connection is established to the network. 7 Setting Up Replication Item Level Restrictions The second method for setting up offline use described below is a scripted process that creates a Publication and Subscriptions via SQL script files that replicate a restricted sub-set of the database for each user based on the Item Level Security rules. The following is a quick-start method for setting up replication for those administrators who want to set up replication to offline users quickly without following the more step-by-step manual method. You should only follow this if you already have experience with SQL replication. This process involves the following: Updating your MX-Contact database Creating the Publications and Subscriptions Modifying the Job Properties Generating and applying initial snapshot (running the Snapshot Agent) Synchronizing and propagating data (running the Merge Agent) 7.1 Updating your MX-Contact Database In order to replicate a limited set of data to each offline client, you will need to apply certain updates to your database. Do the following: ExchangeWise (Pty) Ltd Page 21

22 1. Open Enterprise Manager, select your MX-Contact database and open SQL Query Analyser. 2. Some additional scripts relating to replication are included in a separate zip file called Item_Level_Security_Replication.zip in the MXContact_Instruction_Sheet..zip file. Extract this file to a sub-folder off My Documents. 3. Open SQL Query Analyser and run the following scripts: fn_getuserdatabyhostname.sql fn_getuserdatabyhostname_companies.sql fn_getuserdatabyhostname_contacts.sql fn_getuserdatabyhostname_groups.sql 4. If you are wanting to restrict data based on Company Ownership, then run the following scripts found in the Company_Ownership sub-folder from SQL Query Analyser: 01_vwCompanies_ILS_Company_Ownership.sql 02_vwContacts_ILS_Company_Ownership.sql 03_vwGroups_ILS_Company_Ownership.sql 04_vwstbLinks_ILS.sql 05_vwLinkedItems_ILS_Company_Ownership.sql 06_vwLinkedActivities_ILS_Company_Ownership.sql 07_fn_GetUserData.sql 5. If you are wanting to restrict data based on Company and Contact Ownership, then run the following scripts found in the Company_Contact_Ownership sub-folder from SQL Query Analyser: 01_vwCompanies_ILS_Company_Contact_Ownership.sql 02_vwContacts_ILS_Company_Contact_Ownership.sql 03_vwGroups_ILS_Company_Contact_Ownership.sql 04_vwstbLinks_ILS.sql 05_vwLinkedItems_ILS_Company_Contact_Ownership.sql 06_vwLinkedActivities_ILS_Company_Contact_Ownership.sql 07_fn_GetUserData.sql 6. If you are wanting to restrict data based on Company, Contact and/or Group Ownership, then run the following scripts found in the Company_Contact_Group_Ownership sub-folder from SQL Query Analyser: 01_vwCompanies_ILS_Company_Contact_Group_Ownership.sql ExchangeWise (Pty) Ltd Page 22

23 02_vwContacts_ILS_Company Contact_Group_Ownership.sql 03_vwGroups_ILS_Company Contact_Group_Ownership.sql 04_vwstbLinks_ILS.sql 05_vwLinkedItems_ILS_Company Contact_Group_Ownership.sql 06_vwLinkedActivities_ILS_Company Contact_Group_Ownership.sql 07_fn_GetUserData.sql 7.2 Creating the Publication and Subscriptions The next step is to create the Publication and Subscriptions for your MX-Contact database. Do the following: 1. Open SQL Query Analyser and load the script supplied called Add_Publication_Merge_All.sql. 2. Modify the script to reflect the correct host database name. The default assumed is MXContact: 3. For example if your host database name is MXContact_Host, change the script accordingly to Use [MXContact_Host]. 4. Modify the script to reflect the correct Subscriber client machine names. For example in the script supplied reference is made to the subscriber CHDELDT3_1. Replace this with the name of your remote client computer. If you have more than one, you will need to duplicate the command lines dropping and recreating the subscription for each client computer that will do offline synchronization: ExchangeWise (Pty) Ltd Page 23

24 5. Run the script. This will create the necessary publication and subscription(s). 7.3 Modifying the Job Properties The next step is to modify the properties of the Jobs created to include the name of the each remote computer: 1. From within Enterprise Manager select Management->SQL Server Agent->Jobs and refresh the Jobs list. 2. Open the REPL-Merge Job corresponding to the first offline computer name (in this case CHDELDT3_1). ExchangeWise (Pty) Ltd Page 24

25 3. Click on the Steps tab, highlight step 2 (Run agent) and click Edit: 4. Add the parameter Hostname [Computer Name] in front of Distributor and click OK to close the Edit Job Step window. 5. Click on the Schedules tab and adjust the schedule to synchronize on the frequency required: ExchangeWise (Pty) Ltd Page 25

26 6. Click on OK again to close the Job Properties window. 7.4 Running the Snapshot Agent 7. Select the Publication from the Publication list, right click and select Properties. Click on the Status tab. 8. Click on Run Agent Now to start the agent. ExchangeWise (Pty) Ltd Page 26

27 9. Click on the Snapshot Agent folder and monitor the progress of the agent running until the initial snapshot has been created: 7.5 Running the Merge Agent Once the initial snapshot has been created this needs to be replicated down to each remote client computer. 1. Select the Merge_All publication from the Publications list, highlight the first subscription in the right hand pane, right click and select Start Synchronizing: ExchangeWise (Pty) Ltd Page 27

28 2. Click on the Merge Agents folder and monitor the progress of the agent running until the merge process has completed: 3. Repeat this for the other remote computers. ExchangeWise (Pty) Ltd Page 28

29 7.6 Synchronizing Data Once the Jobs are started on the SQL Server, the remote computers will be updated automatically whenever a connection is established to the network. ExchangeWise (Pty) Ltd Page 29