CPR BROKER. Installation and setup

Transcription

1 CPR BROKER Installation and setup Copyright 2011

2 TABLE OF CONTENTS 1 Introduction Installation overview System requirements General Requirements Specific requirements for PersonMaster Specific requirements for DPR Updates Before installing CPR broker Software Installing PersonMaster Before installing Installation Installing CPR broker / Event Broker Before installation Installation Configuring the CPR broker Applications Data Providers Person master data providers CPR data providers Installing DPR updates Before installing Installation Operation and maintenance Setting up logging Uninstalling CPR broker Software...29

3 Introduction 1 INTRODUCTION This document will describe how to create a working setup. The software package consists of three components: PersonMaster / Event Broker DPR Updates Depending on your existing setup and the data providers you want to use you may not have to install all of these components. This guide will assume that any CPR data providers that are to be used by the are already installed. 1.1 Installation overview The general procedure for installing will be as follows: 1. Prepare the setup environment 2. Install PersonMaster (optional) 3. Install and Event Broker 4. Configure CPR broker 5. Install and configure DPR Updates (optional) Step two can be skipped if you already have a working installation of PersonMaster. Step 6 can be skipped if you are not using DPR as a data provider or if you do not want data in the CPR Broker to be automatically updated when changes occur in DPR. 3

4 System requirements 2 SYSTEM REQUIREMENTS 2.1 General Requirements The following are the general requirements for installing the : Windows 2008 with IIS installed. Windows Vista/7 with IIS installed will work for demonstration purposes but not for production due to the 10 concurrent connections limit these operating system impose. Operating systems that comes with IIS7 will need to install IIS6 compatibility software in order for the installation to work. In Windows 2008 this can be done by installing the IIS 6 Management Compatibility Role for the Web Server (IIS) Role. In Windows 7 the windows component IIS Metabase and IIS6 Configuration Compatibility will have to be installed. SQL Server 2005 or SQL Server 2008 with administrator access. The SQL server must be configured to use both SQL Server and Windows Authentication mode..net framework version 3.5 SP1 Any computer capable of running the above software will also be capable of running CPR Broker. 2.2 Specific requirements for PersonMaster In addition to the general requirements PersonMaster will require the following:.net framework version Specific requirements for DPR Updates In addition to the general requirements installation of DPR Update will require the following: A DPR setup that has been configured to work with the. Administrator access to the DPR database, allowing the creation of staging tables and triggers. 4

5 Before installing CPR broker Software 3 BEFORE INSTALLING CPR BROKER SOFTWARE First make sure that the computer on which you want to install fulfills the System Requirements. You need to have administrative access to SQL Server and the machine you are installing on. If you are installing on Windows 2008 you must first install the.net Feature via Server Manager. Then you should install the Web Server (IIS) Role together with the IIS 6 Management Compatibility Role Service. and Event Broker can be installed as a root sites or as a so called virtual directories inside an existing root site. If you want to install / Event Broker as a root sites (which is what is recommended) you must prepare a DNS-records to point to the web server before beginning the installation. The installation program does not create the DNS-records for you. PersonMaster must be installed as a root site. Therefore you will have to create a DNS record for the PersonMaster website unless you already have an existing PersonMaster setup. If you want the web site to use Windows Authentication to connect to the SQL Server (this is not recommended, though) you also need to configure a special user domain account, which is used by s notification service. When done with the installation this account should be given access to the database created by the installation program. 5

6 Installing PersonMaster 4 INSTALLING PERSONMASTER You can skip this step if you already have a working install of PersonMaster. 4.1 Before installing Before installing PersonMaster you will have to create a DNS record pointing to the website where PersonMaster will be installed. The installation program will not create this record for you. You will also have to make sure that you have administrator access to the SQL Server that is to be used for the installation. 4.2 Installation On the computer with IIS installed, unpack PersonMasterInstaller.msi from the installation package and run it. If the computer uses User Account Control (Windows Vista/2008/7) you will have to right-click PersonMasterInstaller.msi and select Run as administrator. When the installer launches, click next to begin the installation. On the first page you will have to accept the license agreement and click next to continue the installation. 6

7 Installation Choose where you want to install the PersonMaster. 7

8 Installation Input the name of the website where PersonMaster should be installed. This will be the domain name used to access the website, so it should correspond to the prepared DNS entry. Click Next. 8

9 Installation In the above dialog input the name of the SQL server PersonMaster should use and the name of the database. In the field Encryption Key input a key that will be used to encrypt CPR numbers so they are not stored in plain text. This key must correspond to the password policy on the server running the PersonMaster application. The default password policy on Windows Server 2008 is as follows: Passwords cannot contain the user s account name or parts of the user s full name that exceed two consecutive characters. Passwords must be at least six characters in length. Passwords must contain characters from three of the following four categories: English uppercase characters (A through Z). English lowercase characters (a through z). Base 10 digits (0 through 9). Non-alphabetic characters (for example,!, $, #, %). Input the domain of your organization into the "Domain" field. This value will be used to make entries added to the PersonMaster database specific to your organization. 9

10 Installation Under "Admin connection" you will have to input authentication information used for administrating the database server and creating the database. The authentication credentials you choose must therefore have access to create and administer databases. Under "Application connection" input the user id and password that will be used by the PersonMaster application to access the database. If the specified login does not exist on the database server it will be created. If it does exist, make sure to provide the correct password. Click next to continue the installation. The installation wizard will now verify your selections and if everything checks out you will be presented with the dialog shown below. Click Install to start the installation of PersonMaster. Once the installation has completed, click the Finish button to exit the installation wizard. 10

11 Installing CPR broker / Event Broker 5 INSTALLING CPR BROKER / EVENT BROKER 5.1 Before installation If you want to install on its own website make sure you have created a DNS record for the website pointing to the server where you are installing. 5.2 Installation Copy InstallCprBrokerWix.msi from the installation package to the server running IIS and run it. If you are installing on a machine with User Account Control (Windows Vista/2008/7) you must instead right-click on InstallCprBrokerWix.msi and select Run as administrator. When the installation wizard has started click next to begin the installation. Accept the license agreement and click next. 11

12 Installation You will now have to configure where is installed. Choose the location you want to install in an click next. 12

13 Installation You will now have to configure the website where the web-services are installed. Select whether you want to install as a new separate website or as a virtual directory under an existing website. If you choose to create a new website you will have to specify the name of that website. Note that this name will also be the domain name used to access the website, so it should correspond to the domain name you prepared before the installation. If you choose to install as a virtual directory you will have to specify which site you want to install it under and what the name of the virtual directory should be. Click next when you have made your selection. 13

14 Installation You will now have to configure the database connections used by the installer and by the CPR Broker application. The Server name is the name or IP-address of the computer on which the SQL Server resides. It could be localhost if the SQL Server resides on the same computer as the web site. Database name is the name of the database. CPRBroker would be a well chosen default name. If the database already exists, you will be given a warning message. If you accept it, the database will be used as it is. Please note that you will have to re configure the data providers because of encryption issues. Refer to the section Data Providers for details on how to do that. Admin login is used for logging into the SQL Server and creating the database with the necessary tables etc. Whether you should use Windows authentication or SQL Server authentication depends very much on your setup. If the SQL Server is on the same computer as the web site you should most likely use Windows authentication. Application login is used by the web site and services to connect with the database. The credentials needed for this purpose do not need to have as many privileges as the Admin login. When you have filled in the information, click Next. 14

15 Installation You will now have to configure the event broker. Click Next to start the configuration of the Event Broker installation. 15

16 Installation Like with the you will have to provide information about where to install the Event Broker web-service. Fill out the above form like you did for the. Note that if you install the Event Broker on a separate website you must have a DNS record for the site pointing to the server you are installing on. 16

17 Installation Next you will have to configure the database for Event Broker. Again the configuration is more or less the same as with the. You must specify a separate database name, but you can use the same login if you wish. When you have filled out the form, click Next. 17

18 Installation You are now ready to start the installation. Click on the Install button to start the installation. When the installation completes click Finish to exit the installation wizard. 18

19 Installation should now have all the information needed to perform the installation. Click the install button to start the installation. Once the installation has completed click Finish to exit the installation wizard. 19

20 Configuring the CPR broker 6 CONFIGURING THE CPR BROKER Open (or where ever you installed ) in a web browser to see whether your installation was successful Above is shown the general interface for the. 20

21 Applications 6.1 Applications Now click Applications: For a client application to be able to use the broker, it needs to use an application token that uniquely identifies the application. This is modeled by the concept of Application in the broker. An application has a unique name and a unique token. The name is a user friendly string that can be seen in with the log entries identifying relevant log entries. The token is a unique key sent with all web service requests to tell the broker which application is making the call. The token is an auto generated Guid(Globally Unique IDentifier) by default, but it can be changed to be any string that uniquely identifies the application. The application needs to be approved before it can be used. Applications can be created through the Applications page and also through web services. Name and token can be changed through the user interface (only), but they still have to be unique. The system comes with three pre-approved applications. The Admin application is a built-in name for an application that is allowed to work with the administrative parts of the. The other two applications are the event broker and the demo application. Please leave these two applications untouched. 21

22 Applications To approve an application, simply click Edit for the application in question and check the Approved check box. Then click Update (only shown after Edit). To create an application, simply give it a Name and whether it should be initially approved (it probably should). Then click Insert. The application is now listed under Applications. 6.2 Data Providers Now click Data Providers: A Data Provider is a connector that provides the broker with information. Cpr Broker itself does not produce data, but rather queries other systems for data. To setup any of these connections you need an account and connection information from the provider. Then choose the appropriate provider type, enter the information and click Insert. You now have a Data Provider. In order for the broker to be usable, it must be told whare to get people's data from. There are two groups of data providers : Person master data providers Used to assign UUID s to Cpr Numbers. It gets UUIDs from the specified person master service. 22

23 Data Providers Address is the address of the service ( You can find this address by going to the address where there will be a link ending in.svc. You can copy the correct address from this link. Clicking on the link will also bring you to a page with a link to the WSDL for the PersonMaster server, which you might need to find the Spn name. Context is any arbitrary string that identifies the broker instance. Spn name is a parameter used by the service that you should get from the administrator, or by checking the WSDL file of the actual service instance CPR data providers These data providers are the ones that retrieve the detailed information of persons. There are currently two data providers that are implemented; DPR and KMD DPR Address and Port are TCP address and port of the DPR forwarding (DPR Viderestilling) service. Keep Subscription tells the instance to whether to set a subscription when requesting data from 23

24 Data Providers DPR forwarding in case data is not already in DPR. It can be either True or False. The rest of the parameters are used to build a SQL Server connection string that points to the DPR database. Note that if you register a DPR data provider you should also set up DPR Updates to ensure data in the is automatically updated. You can see how to do this in the chapter Installing DPR updates. KMD Address is the web service base address ( Username and Password are sent with the requests. 24

25 Installing DPR updates 7 INSTALLING DPR UPDATES This chapter can be skipped if you are not using DPR as a Data Provider or if you do not wish automatic updates from DPR to the. 7.1 Before installing In order to install DPR Updates you must have a working DPR setup configured in your CPR Broker. You must also have administrator access to the database server with the DPR database. You should always backup the DPR database before running the DPR Updates installer. 7.2 Installation Copy DPR Updates Installer.msi to the machine where you want to install DPR Updates and run it. If you are installing on a machine with User Account Control (Windows Vista/2008/7) you must right-click on DPR Updates Installer.msi and select Run as administrator. You will be asked to provide the necessary login information for installing DPR Updates. In the Server name you should put the name of the SQL server running the DPR database. In the Database name you should input the name of the DPR database. 25

26 Installation Under Admin connection you have to provide login information that allows changing the DPR database by adding staging tables and triggers. You can either use windows authentication or SQL Server authentication, just make sure that the user id you provide has the necessary privileges on the SQL server. Under Application connection you must provide the user id and password that will be used by the application to connect to the DPR database. TODO: If the user id does not already exist it will be created. When you have input the above information click Next. You will now be asked to provide the URL to your PART service. Adjust the default URL so it fits the hostname (and path) where you installed. Click Next. 26

27 Installation The installation is now ready. Click the install button to start the installation. When the installation is completed click the Finish button to exit the installer. 27

28 Operation and maintenance 8 OPERATION AND MAINTENANCE 8.1 Setting up logging can log to file, Windows Event Log, to the Database and to . There place to setup logging: In the loggingconfiguration.config file for web service. The default position for this is C:\Program Files\ITST\(Event Broker)\Web\Config Additional location for Event Broker: in the CprBroker.EventBroker.Backend.exe.config file for the Backend service. The default position for this is C:\Program Files\ITST\Event Broker\Web\bin\. The procedure is the same for both files. Locate the < loggingconfiguration> tag in the specific config file. Under the <listeners> tag you will find four <add tags. The "CprDatabase" as well as the "EventLog" should be left untouched in all cases. In "FlatFile" you should look for the filename attribute. This should be set to the full path and name of the where to put the log file. In name=" " there are more settings. The ones most likely to be adjusted are: toaddress, fromaddress, smtpserver and perhaps smtpport. Please note: In the last 3 cases, you need to make sure that the NT AUTHORITY\NETWORK SERVICE account has sufficient access rights to the destination. You have now adjusted the settings for each type of logging, but you have yet to set what types of logging are active. You now look for the <specialsources>/ <allevents> tag. In this you will another <listeners> tag. Per default "CprDatabase" is active, which can be seen from the fact that it is not commented out like e.g. <!--add name="eventlog" /--> is. To enable a specific listener simply remove the <!-- and --> characters from the line. And to disable a listener simply put them back in. 28

29 Uninstalling CPR broker Software 9 UNINSTALLING CPR BROKER SOFTWARE The individual software packages can be removed using the Add/Remove programs feature from the windows control panel. During the uninstall process you will be asked whether you want to remove the corresponding database along with the application. If you choose to remove the database you will have to provide a login to the database server with the necessary privileges. Note that you will have to remove any Sql Server logins created on the database server manually. 29

30 adresse Studiestræde 14, København K info@magenta-aps.dk telefon (+45)