@Analyst Multi-DB Administrator Guide

Size: px

Start display at page:

Download "@Analyst Multi-DB Administrator Guide"

Everett Singleton
5 years ago
Views:

1 @ptitude Analyst Multi-DB Support Administrator Guide ROLE Project Manager Team Member TEAM MEMBERS NAME Yezen Younan Jack Gulla DOCUMENT HISTORY REV DATE COMMENTS 0.1 6/27/2013 Document created /1/2013 Document sent for initial review /2/2013 More mods 0.4 7/17/2013 Document sent to Erik Bouthillier /26/2013 Added more details after Brice Tests.

2 Page 2 of 22 TABLE OF CONTENTS 1 INTRODUCTION PURPOSE SCOPE GENERAL CONCEPT ONE TIME CONFIGURATION SKFMASTERSETTINGS.XML APPLICATION.CONFIG FILES PER DATABASE CONFIGURATION PREPARING THE SOURCE DATABASE Using Existing Detached Database Using Existing Attached Database Using the Supplied Empty Database Creating a new Database FIXING DATABASE FILE REFERENCES CREATING DATABASE USERS PREPARING THE TARGET DATABASE CLIENT APPLICATION DATABASE ACCESS SETTING DATABASE CONNECTIONS SETTING APPLICATION DATABASE ACCESS Client Application Database Access Windows Services Database Access GENERAL NOTES...22

3 Page 3 of 22 1 Introduction 1.1 Purpose This document provides guidelines for RDC administrators to setup and configure the multi-db feature Analyst. 1.2 Scope This document is intended for RDC administrators and not general users of the software. The guideline and the feature support is only for SQL Server databases and not Oracle.

4 Page 4 of 22 2 General Concept Provide multiple database support Analyst within the same database instance, in Microsoft SQL Server. Oracle is not supported by this feature. These are some of the setup highlights: 1. Databases can be named differently than the default skfuser name. 2. Database selection is established by command line options for the client applications. 3. Unique Database users are created by batch files. 4. There are minimal general application configuration changes. 5. Existing default database operation is not broken. 6. Multi-DB support only takes effect when CMSW7490 license key is used.

5 Page 5 of 22 3 One Time Configuration The following configuration changes needs to be completed once, per RDC Application Server. 3.1 skfmastersettings.xml A configuration change is required to one of the tags in the skfmastersettings.xml file. The change can be done using an XML editor or using the skfanconfigtool application. This file is typically located in c:programdata\skf\@ptitude Analyst folder. If you use the skfanconfigtool application, then open the General Configuration settings page. Find and change the DbConnectFormat tag value as follows: From: <DbConnectFormat>Provider=sqloledb;server=%s;initial catalog=skfuser</dbconnectformat> To: <DbConnectFormat>Provider=sqloledb;server=%s;initial catalog=%s</dbconnectformat> 3.2 Application.Config Files Some of the application and service.exe files may not have an application configuration (.Config) file associated with them. A.Config file needs to be created for those don t have one already. All the.exe files in reference here are located in the Analyst folder. The following.exe file need to have.config files: skfimxservice.exe skfmicrologservice.exe skfmonitor.exe skftransact.exe skfwmxservice.exe skfwmxconversionutility.exe

6 Page 6 of 22 If one of these.exe files does not have a.config file associated with it, then copy the skfanalyst.exe.config file and rename the copy to match the.exe file. For example, if skfimxservice.exe does not have a matching.config file, then rename the copy to skfimxservice.exe.config.

7 Page 7 of 22 4 Per Database Configuration To attach Analyst databases into the same SQL Server database instance, the database name needs to be unique. There are different ways to prepare the source database, and then attaching and configuring it. A database source can be an Analyst database, the supplied skfuserempty database, or a newly created database. NOTE 1: The following utilizes and assumes you are familiar with the SQL Server Management Studio application. NOTE 2: The database scripting files referenced in this section are all located in the Analyst\DBAssist\SQL Server folder. 4.1 Preparing the Source Database Using Existing Detached Database Apply these steps on Analyst database that is not attached to any database instance: 1. Using Management Studio, detach existing skfuser database, if any. 2. Using Management Studio, attach the source database. 3. Follow the steps in section Using Existing Attached Database Using Existing Attached Database Apply these steps on Analyst database that is already attached to the database instance: 1. From within Management Studio, open and execute the script Remove_Database_Users.sql. This will remove all the associated database login and users (skfhmix, and skfuserx). The users skfuser1 and skfuserts1 will not be removed. 2. From within Management Studio, rename the database name from skfuser to the target name (example: skfuserconocophillips). 3. Detach the database.

8 Page 8 of Rename the database files (.mdf/.ldf) to match the new database name (example: skfuserconocophillips.mdf, skfuserconocophillips.ldf). 5. Follow the steps in section 4.2 Fixing Database File References. 6. Follow the steps in section 4.3 Creating Database Users Using the Supplied Empty Database Apply these steps on the supplied Analyst database, to use as a source database. This database has Analyst DB schema, and also includes Decision Support schema. The database is empty and there is no content in the tables: 1. Rename the database files (.mdf/.ldf) to match the new database name (Example: skfuserconocophillips.mdf, skfuserconocophillips.ldf). 2. Follow the steps in section 4.2 Fixing Database File References. 3. Follow the steps in section 4.3 Creating Database Users Creating a new Database Apply these steps when there are no existing source databases to utilize: NOTE 1: It is recommended to start with the supplied empty database instead of creating a new database, since the new database will not have Decision Support schema, and therefore it will be structurally different from most of the databases in use today. 1. Execute the batch file CreateDatabase.bat and provide the database info parameters on the command line. CreateDatabase.bat <instancename> <dbname> <sapwd> Where: <instancename> is the database server/instance combination name (Example: localhost). <dbname> is the target database name (Example: skfuserconocophillips). <sapwd> is the database instance s SA password (Example: skf).

9 Page 9 of The database files will be located in the SQL Server installation s Data folder (Example: C:\Program Files\Microsoft SQL Server\MSSQL10_50.MSSQLSERVER\MSSQL\DATA). 3. The database files will be named <dbname>.mdf, and <dbname>.ldf (Example: skfuserconocophillips.mdf, skfuserconocophillips.ldf). 4. Optionally, if you organize your database files somewhere other than the default SQL Server Data folder, then you will need to detach the newly created database, move the database files to the target folder, then reattach the database. 4.2 Follow the steps in section 4.3

10 Page 10 of 22 Fixing Database File References After renaming the database name, detaching the database, and then renaming the database files, when the newly renamed database is attached again, the internal database file references will be wrong. NOTE 1: The database file references must be corrected, or there may be unpredictable behaviors. Apply these steps to correct the database file references: 1. From within Management Studio, attach the target database. After the database.mdf file is selected and the Add action is executed, the referenced database files are displayed in the list. Notice that the files are identified as not found.

11 Page 11 of Click on the file browse button identified by the red arrow, and select the corresponding database file. Do this for the.mdf file and for the.ldf file. Click OK when done. NOTE 1: Make sure to match the file names with the database name. There may be a case where the files do exist with the old name, and therefore will not be identified as Not Found. 5. Creating Database Users.

12 Page 12 of From within Management Studio, open a query window and execute the following SQL statement: CREATE ROLE skfuser 7. Execute the batch file Buckeye.bat and provide the database info parameters on the command line. This will create Analyst database schema. Buckeye.bat <instancename> <dbname> <username> <userpwd> Where: <instancename> is the database server/instance combination name (Example: localhost). <dbname> is the target database name (Example: skfuserconocophillips). <username> is the user/login name (Example: skfuserconocophillips). <userpwd> is the user/login password (Example: cm).

13 Page 13 of Fixing Database File References After renaming the database name, detaching the database, and then renaming the database files, when the newly renamed database is attached again, the internal database file references will be wrong. NOTE 1: The database file references must be corrected, or there may be unpredictable behaviors. Apply these steps to correct the database file references: 3. From within Management Studio, attach the target database. After the database.mdf file is selected and the Add action is executed, the referenced database files are displayed in the list. Notice that the files are identified as not found.

Page 14 of 22 4. Click on the file browse button identified by the red arrow, and select the corresponding database file. Do this for the.mdf file and for the.ldf file.

14 Page 14 of Click on the file browse button identified by the red arrow, and select the corresponding database file. Do this for the.mdf file and for the.ldf file. Click OK when done. NOTE 1: Make sure to match the file names with the database name. There may be a case where the files do exist with the old name, and therefore will not be identified as Not Found.

15 Page 15 of Creating Database Users With the ability of attaching Analyst databases into the same database instance, it is no longer possible to use a single database user for connection and as the database owner (Example: skfuser1). Therefore each database, within the same instance, must a unique user/login to be the database owner, and the main connection account. NOTE 1: With multiple databases attached and each requiring a unique login account, it will be confusing and hard to remember which login account is paired with which database. It is recommended to use the name of the database as the name for the login account. For example, if the database name is skfuserconocophillips, then create a user named skfuserconocophillips. Apply these steps to create database user accounts: 1. Execute the batch file CreateDatabaseUser.bat and provide the database info parameters on the command line. CreateDatabaseUser.bat <instancename> <dbname> <sapwd> <username> <userpwd> Where: <instancename> is the database server/instance combination name (Example: localhost). <dbname> is the target database name (Example: skfuserconocophillips). <sapwd> is the database instance s SA password (Example: skf). <username> is the user/login name (Example: skfuserconocophillips). <userpwd> is the user/login password (Example: cm). 2. For the client applications, only one user account is required. There is no need to create multiple users to match the number of user licenses purchased, since NT Authentication and IT Security features are not support with the Multi-DB feature. 3. Traditionally the client application used the skfuser1..n for the DB user account, and the Transaction Server service used the skfuserts1 for the DB user account. It is not required to use a different DB user account than the

16 Page 16 of 22 one created above, but if you wish to continue with the tradition, then create a second user, as in step 1 above, but append Ts to the user name (Example: skfuserconocophillipsts). Since Transaction Server is a Windows service, there may be an advantage in using a different user account, so the connections can be identified and terminated, if needed, without effecting the client application connections. 4.5 Preparing the Target Database After following the steps in section 4.1, the database is ready become the target database and be utilized by Analyst system. Apply these steps to prepare the target database: 1. Execute the batch file DbUpdate.bat and provide the database info parameters on the command line. This will update the database to the latest database version. DbUpdate.bat <instancename> <dbname> <username> <userpwd> Where: <instancename> is the database server/instance combination name (Example: localhost). <dbname> is the target database name (Example: skfuserconocophillips). <username> is the user/login name (Example: skfuserconocophillips). <userpwd> is the user/login password (Example: cm). 2. The database is now ready to be accessed by the client application. NOTE 1: Existing databases must be updated using the method described in this section. The Database Update feature in the skfanconfigtool application will not update databases with names other than skfuser. NOTE 2: Double clicking on the DbUpdate.bat file will use the default values for the command line parameter (The value of MADBSRVR environment variable for the database instance, skfuser for the database name, skfuser1 for the user, and cm for the password.

17 Page 17 of 22 5 Client Application Database Access 5.1 Setting Database Connections This section describes how to setup and configure the database connections, using the skfanconfigtool application. NOTE 1: Existing database connections will continue to work, and the database name within these existing connections is skfuser. NOTE 2: The steps in this section assume that the database has already been attached and the proper database user has been created. Apply these steps to configure database connection for the target database: 1. Within the skfanconfigtool application select the Database Type page. 2. Select the Manage button, available on the page. 3. This page has been expanded to accept the database name. This field is only available when the SQL Server database type is selected.

Page 18 of 22 4. Click the Add button, to add a new connection. 5. Fill in the required information: Connection Title: Is the title/name given to the database connection.

18 Page 18 of Click the Add button, to add a new connection. 5. Fill in the required information: Connection Title: Is the title/name given to the database connection. This title will be used in the follow on sections. This should have some identification as to which database is connected to, but its recommended to have this string be different that the actual database name, to reduce confusion, when used later. In the example above, an underscore is used between prefix and the DB name. DB Connect Name: This is the database server/instance name combo. DB Name: This is the name of the database that has been attached.

19 Page 19 of Once the Save button is selected, the connection will be tested and saved. More connection can be added. NOTE 3: It is important to note that not all the features in the skfanconfigtool application have been retrofitted to support Multi-DB. Some of the features still operate on the Active Database, and some still operate on a database named skfuser. Therefore some of these operations must be done manually and external to the skfanconfigtool, as has been described in the previous sections. Only the features mentioned in this document have been retrofitted to support multiple databases within one instance. 5.2 Setting Application Database Access This section describes how to setup and configure the specific database connection for the client applications and services Client Application Database Access This section describes how to connect the client desktop applications to the various databases. Analyst software has had the ability to connect to different database through the use of command line options U: and Connect:, but these options connected to different database instances and not multiple databases within the same instance. The software has been changed where the -Connect: option is utilized to specify the database connection title (as described in section 5.1). The -U: option remains unchanged, and still operates on database instance as the input. This is done to reduce the risk of non-rdc like existing installations, and continue the default operation. NOTE 1: For a client application (Example: skfanalyst.exe) without the Connect: option, it will operate and connect to the default database. NOTE 2: It is presumed that for each database, there would be a Transaction Server service configured, therefore the -TS: option would also be required to be used by the client applications, to specify the server and port settings for the Transaction Server.

20 Page 20 of 22 Apply these steps to configure client applications to connect to the target database: 1. Create a shortcut for the client application. 2. Add the command line option to specify the database connection, as follows: connect:<dbconnectname> Where dbconnectname is the database connection title specified when the connection was added within the skfanconfigtool, described in section 5.1, item 4, above. 3. Add the -TS: command line option to specify which Transaction Server to connect to. 4. Add the -Account: command line option to specify which database user to use for the connection. Since each database will have a unique login user account, you will need to specify this option. Otherwise it will default to the account skfuser1, and this account may not be valid for your database.

21 Page 21 of 22 Here is an example: -account:conocophillips,cm -TS:,8091 -connect:skfuser_conocophillips 5. Do these steps for each database Windows Services Database Access This section describes how to connect the Windows service applications to the various databases.

22 Page 22 of Transaction Server Service This section describes how to connect the Transaction Server service to the various databases. The Transaction Server utilizes the -db: command line option, the same way the -connect: option is utilized for the client applications. The -db: option is specified during initialization of a new Transaction Server service. If a service was already created before, then it will need to be first removed (unregistered as a service) and then recreated with the new configuration. For further support on how to unregister an existing Transaction Server service, see the Service Manual Analyst. Apply these steps to configure Transaction Server service to connect to the target database: 1. Open a command window. 2. Change the working folder into the where Analyst files are located. 3. Execute the following command: skftransact.exe /Service:<tsname> -port:<portnum> - u:transactionserver,skf -a:<username>,<userpwd> - db:<dbconnectname> Where: <tsname> Is the Transaction Server service name. <portnum> Is the Transaction Server TCP port number. <username> Is the database user login name. <userpwd> Is the database user password. <dbconnectname> Is the database connection name (DB title). NOTE: Ensure default Transaction service exists. Disable it use only named tansaction services that you create with process above.

23 Page 23 of 22 Example: skftransact.exe /Service:ConocoPhillips -port: u:transactionserver,skf -a:skfuserconocophillips,cm -db: skfuser_conocophillips 4. Follow the steps above to configure a Transaction Server service per database Other Services This section describes how to connect the IMx Service, WMx Service, and Microlog Service to the various databases. The configuration for all these services follows the same set of steps. The steps require the use of the skfanconfigtool application and a text editor. NOTE 1: The database connections for the various databases must first be added, as described in section 5.1 Setting Database Connections, before configuring one of these services. NOTE 2: It is important to note that not all the features in the skfanconfigtool application have been retrofitted to support Multi-DB. Some of the features still operate on the Active Database, and some still operate on a database named skfuser. Therefore the default database skfuser should be kept and attached, and the default Transaction Server (un-named) should be configured to connect to the default database, but does not need to be running. Apply these steps to configure desired service to connect to the target database: 1. Open the skfanconfigtool application. 2. Select settings page for one of the desired services. 3. Add the new service as you have done in the past, or follow the user manual for instructions on how to add the specific service. 4. After the service is added successfully, open the specific service application configuration file with a text editor (Example: Notepad). If an IMx service was added, then open and edit the skfimxservice.exe.config file.

24 Page 24 of Within the.config file, find the section that specifies the configurations for the newly added service. It would look similar to the following: <ImxService_ConocoPhillips> <add key="servicename" value="conocophillips" /> <add key="serviceport" value="9090" /> <add key="dbconnectname" value="skfuser_conocophillips" /> <add key="hostname" value="vmussdgltucmy1y" /> <add key="send " value="0" /> <add key="emaiaddress" value="" />   <add key="writecommslogfile" value="false" /> <add key="commslogfiledetaillevel" value="0" /> </ImxService_ConocoPhillips> 6. Add the following two lines into the same block. These line can be added anywhere within the block. <add key="rpchostname" value="vmussdgltucmy1y" /> <add key="rpcport" value="9090" /> 7. The final configuration should look similar to the following: <ImxService_ConocoPhillips> <add key="servicename" value="conocophillips" /> <add key="serviceport" value="9090" /> <add key="dbconnectname" value="skfuser_conocophillips" /> <add key="hostname" value="vmussdgltucmy1y" /> <add key="rpchostname" value="vmussdgltucmy1y" /> <add key="rpcport" value="9090" /> <add key="send " value="0" /> <add key="emaiaddress" value="" />   <add key="writecommslogfile" value="false" /> <add key="commslogfiledetaillevel" value="0" /> </ImxService_ConocoPhillips> 8. Edit the value for the key RpcHostName. This should match the machine name where the corresponding Transaction Server service is running. 9. Edit the value for the key RpcPort. This should match the TCP port of the corresponding Transaction Server service. 10. Close and save the file. The service should be ready to be started.

25 Page 25 of Start the service, start the corresponding Transaction Server service, and start the Analyst client. Make sure there is an indication of the service on Analyst status bar. 12. Repeat the steps above to add more services. 5.3 General Notes 1. When applying database updates, do not use the Update Database feature in skfanconfigtool. Use the DbUpdate.bat batch file found in the SQL Server database scripts folder. 2. Execute the built-in stored procedure sp_who2 from within SQL Server Management query window, to identify which database user is connecting to which database. This is to diagnose any issues with the connections. While adding new services/connections, it is easier to run one process at a time and then execute this SP to determine proper operation. 3. When databases are detached and then reattached again, do not execute the Rebuild_loginname_username_links.sql script as it has been done before. Just re-run the CreateDatabaseUser.bat again to rebuild the database user and login accounts.

DOCUMENT TRACKING INSTALLATION GUIDE

DOCUMENT TRACKING INSTALLATION GUIDE DOCUMENT TRACKING INSTALLATION GUIDE This document walks through the steps necessary for installing the program. TO INSTALL DTS: You should have administrator rights