MX-Contact Instruction Sheet Setting up SQL Replication SQL 2005

Transcription

1 1 Introduction The purpose of this Instruction Sheet is to describe how to set up SQL Replication from a SQL Server 2005 Database to a SQL Server 2005 Express 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 with SQL Server 2005 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_SQLExpr_Install_ exe for a SQL Server 2005 host database). Each of these installation packages has a corresponding Installation Guide that should be followed step by step. During installation of SQL Express, an additional option must be selected, namely Replication. This is selected under Database Services on the Feature Selection dialogue. Note that this is not installed by default: ExchangeWise (Pty) Ltd Page 1

2 4.2 Configuring the Offline SQL Database for Remote Connections The next step is to check that the SQL Express databases 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 a SQL Server 2005 Express Database proceed as follows: 1. Open the SQL Server Express Configuration Manager by clicking Start->All Programs->Microsoft SQL Server 2005->Configuration Tools->SQL Server Configuration Manager: 2. Check that both the SQL Server Browser and SQL Server services are running: ExchangeWise (Pty) Ltd Page 2

3 3. Check that both the Named Pipes and TCP/IP Protocols are Enabled: 4. 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: 5. Add the SQL Server program (sqlservr.exe) by clicking on Add Program: ExchangeWise (Pty) Ltd Page 3

4 6. Click on Browse and navigate to the Program Files\Microsoft SQL Server\MSSQL.1\MSSQL\Binn folder and selecting sqlservr.exe: 7. Add UDP Port 1434 by click on Add Port: ExchangeWise (Pty) Ltd Page 4

5 8. Click on OK. You should now have 2 additional exceptions listed: Your SQL Server should now be able to be accessed by the remote clients that will connect to this server. 5 Preparing the Host 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. ExchangeWise (Pty) Ltd Page 5

6 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). 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 Note: 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. ExchangeWise (Pty) Ltd Page 6

7 5.3 Configuring the Server for Publishing To configure the server for publishing, do the following: 1. From within Microsoft SQL Server Management Studio right click Replication and select Configure Distribution: 2. Click Next. 3. Check the option to make the server its own distributor. Click Next. ExchangeWise (Pty) Ltd Page 7

8 4. Check the option to configure the SQL Server Agent to start automatically. Click Next. 5. Select a folder on the SQL Server that has 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 8

9 6. Enter a distribution database name. Click Next. 7. Check the checkbox in the Publishers list. Click Next. ExchangeWise (Pty) Ltd Page 9

10 8. Select the checkbox to Configure distribution. Click Next. 9. Click Finish. ExchangeWise (Pty) Ltd Page 10

11 10. Make sure the configuration completes successfully. 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. From within Microsoft SQL Server Management Studio right click the SQL Server and select Register: ExchangeWise (Pty) Ltd Page 11

12 2. Click New Group. 3. Call the new group MX-Contact Offline Users and click Save. 4. Right click on the new group and select New Server Registration ExchangeWise (Pty) Ltd Page 12

13 5. The New Server Registration window will appear. 6. Select the Server Name dropdown and select the Browse option. 7. Select the server to be associated with this registration and click OK: ExchangeWise (Pty) Ltd Page 13

14 8. In the New Server Registration window click Save. 5.5 Updating your MX-Contact Database If your database was installed using an Installation Package version or earlier, you will need to update your database to 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. 3. Run the following scripts from SQL Query Analyser: Triggers_CREATE_Not_For_Replication.sql ExchangeWise (Pty) Ltd Page 14

15 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 Setting the Publication Permissions Creating the Subscriptions Synchronizing and Propagating Data 6.1 Creating the Publication The next step is to create a Publication for your MX-Contact database. Do the following: 1. Right click on the Local Publications folder below Replication and select New Publication: 2. The New Publication Wizard will appear. Click Next. ExchangeWise (Pty) Ltd Page 15

16 3. Select the host database that you are synchronizing to the remote client machine. Click Next. 4. Select Merge publication. Click Next. ExchangeWise (Pty) Ltd Page 16

17 5. Select the various SQL Server versions running on the remote client machines. Click Next. 6. Select all tables, stored procedures, views and functions that need to be replicated. Click Next. ExchangeWise (Pty) Ltd Page 17

18 7. Click Next. 8. Click Next if you do not need to filter the data in your publication. ExchangeWise (Pty) Ltd Page 18

19 9. Select the checkbox to Create a snapshot immediately and if you want future snapshots to be created periodically select the checkbox to Schedule the Snapshot Agent to run at the following times. Click Next. 10. Click Security Settings. ExchangeWise (Pty) Ltd Page 19

20 11. Enter the SQL Agent account information. Click OK. 12. Click Next. ExchangeWise (Pty) Ltd Page 20

21 13. Click the checkbox Create the publication. Click Next. 14. Enter a name for the publication. Click Next. ExchangeWise (Pty) Ltd Page 21

22 15. Make sure that the publication completes successfully. 16. When the publication has completed successfully click Close. ExchangeWise (Pty) Ltd Page 22

23 6.2 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 and click Add. 3. Click on the MX-Contact Users login and click OK. ExchangeWise (Pty) Ltd Page 23

24 4. Check that the group is added to the Publication Access List and click OK. 6.3 Creating the Subscriptions The next step is to create a Subscription for each remote user database. For this you need the machine/server name of each user. Do the following: 5. Right click the Publication Merge_All and select New Subscription: ExchangeWise (Pty) Ltd Page 24

25 6. The New Subscription Wizard will appear. Click Next: 7. Select the Merge_All publication. Click Next: 8. Select the option to Run all agents at the Distributor. Click Next. ExchangeWise (Pty) Ltd Page 25

26 9. Click Add SQL Server Subscriber. 10. Click the Server name dropdown and select Browse for more. 11. Select the Network Servers tab. Expand the Database Engine list and select the machine you want to add as a subscriber. Click OK. ExchangeWise (Pty) Ltd Page 26

27 12. Click Connect. 13. Select the Subscription Database from the dropdown and click Next. 14. Click the ellipses ExchangeWise (Pty) Ltd Page 27

28 15. Enter the SQLAgent account information and click OK. 16. Click Next. ExchangeWise (Pty) Ltd Page 28

29 17. Select the option Run continuously from the Agent Schedule dropdown. Click Next. 18. Click Next. 19. Click Next. ExchangeWise (Pty) Ltd Page 29

30 20. Click Next. 21. Click Finish. 22. Monitor the creation of the subscription from the Replication Monitor and click Close when the Status is Complete. ExchangeWise (Pty) Ltd Page 30

31 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: 1. Open Enterprise Manager, select your MX-Contact database and open SQL Query Analyser. ExchangeWise (Pty) Ltd Page 31

32 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 02_vwContacts_ILS_Company Contact_Group_Ownership.sql ExchangeWise (Pty) Ltd Page 32

33 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 33

34 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: 6. From within Enterprise Manager select Management->SQL Server Agent->Jobs and refresh the Jobs list. 7. Open the REPL-Merge Job corresponding to the first offline computer name (in this case CHDELDT3_1). ExchangeWise (Pty) Ltd Page 34

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

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

37 14. 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. 15. 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 37

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

39 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 39