synerion direct installation guide · synerion direct installation guide contents 1 overview 4 2...

Synerion Direct Installation Guide

Version: 1.3

Date: 13 December 2012

Synerion technical documentation and the product(s) described herein are protected by one or more copyrights, patents, foreign patents trademarks or pending applications. No part of this publication may be reproduced or transmitted into any human or computer language in any form or by any means, stored in a retrieval system, transmitted, redistributed, translated or disclosed to third parties, or decompiled in any way including, but not limited to, photocopy, photograph, electronic, mechanical, magnetic or manual without the expressed written permission of Synerion, or its licensors, if any.

All copies, so authorized, contain a full copy of this copyright notice.

Synerion products are licensed products. The product licenses convey the right to use only those specific products, components, modules, features and/or functions specified in the license agreement or contract. This publication may mention or reference products, components, modules, features and/or functions that are not part of a particular license agreement. The customer is not entitled to the receipt of, or use of, any other products, components, modules, features and/or functions that may be referenced in any documentation provided to customer unless additional license fees are paid and an appropriate license agreement is duly executed. Synerion obligations with respect to its products and services are governed solely by the agreements under which they are provided.

This publication is furnished for informational use only and should not be construed as a commitment by Synerion. The information could include technical inaccuracies or typographical errors. Every effort has been made to make this publication as complete and accurate as possible, but it is provided “as is” without warranty of any kind, what so ever, either expressed or implied, including, but not limited to, the implied warranties of merchantability, fitness for a particular purpose, or non- infringement. Synerion may make improvements and/or changes in the program(s), product(s), and/or applications described in this publication at any time without notice. Due to continuous development of Synerion. Products, information published in this document may become obsolete.

Third-party products, services, or company names referenced in this document may be trademarked or copyrighted by their respective owners, and are for identification purposes only.

All Synerion products are licensed. This document and related products are protected amongst others by copyright and distributed under licenses restricting their use, reproduction, distribution, or decompilation. It is illegal to use any Synerion product, or Synerion product components, modules, features and/or functions that have not been properly licensed through Synerion. This document may reference products, components, modules, features and/or functionality that are not part of your license agreement. Their inclusion or mention in this documentation does not constitute entitlement for receipt or use.

Synerion Direct Installation Guide

Contents

1 Overview 4

2 General Prerequisites 5

3 Databases Setup and Installation 6

4 Installing the Synerion Direct Web Server 8

5 Installing the Synerion Direct Middleware Service 13

5.1 Pre-Requisites 14

5.2 Installing the Lighthouse Middleware Service 16

5.3 Setting the Database Connection 17

5.4 Starting the Lighthouse Middleware Service 19

5.5 Upgrading the Lighthouse Middleware Service 20

5.6 Ensuring MSDTC is Properly Configured 21

6 Appendix: Installing the MSMQ component for Windows 24

6.1 Installing MSMQ on Windows Server 2003 25

6.2 Installing MSMQ on Windows Server 2008 27

7 Appendix: Message Queues Required for Synerion Direct 28

Overview 4

1 Overview This guide describes installation and setup of Synerion Direct for the January 2013 release, version 1.3.

The authors of this guide have made every attempt at comprehensive documentation. However, any additional questions and comments beyond the scope of this guide are to be sent to the Synerion R &D, Installation/Setup, or Implementation departments.

General Prerequisites 5

2 General Prerequisites • Download and install MS Web Deploy 2.10 and above. Refer here.

• Upgrade your version of TKSQL to the latest major version + service pack.

If this is a first-time installation of TKSQL, ensure that lavlbsql.dll exists in your Windows system folder LAVLBSQL.dll – must be placed in the system's System32 or SysWow64 directory otherwise log in will not work (internal error in UserLogin component which will manifest in a "Wrong username or password message")

• Ensure that you have reviewed and prepared the demands described in the System Requirements.

• Ensure .NET 4 is installed on the computer where the services will be installed.

• Install the .NET Framework update. Refer here.

http://www.iis.net/downloads/microsoft/web-deploy�

http://www.microsoft.com/en-us/download/details.aspx?id=3556�

Databases Setup and Installation 6

3 Databases Setup and Installation This procedure updates TKSQL and iBrowse (all new and missing objects) and creates a new database for Notifications, Metrics, etc.

To setup and install the databases:

1. Copy the Synerion Direct installation package to a folder on your server.

2. Open the Database folder.

3. Using a text editor, open SynerionLH.DB.Install.exe.config.

4. Do as follows:

a. Enter your settings in server name and database name

b. If you use SQL Authentication (NOTE: If you use Windows Authentication, leave as is), enter the user name and password of an account that can create and update databases.

c. Save your work and then close.

5. Double-click the SynerionLH.DB.Install.exe file.

The .exe file's details are written to a log file. It is recommended to view this file to verify the success of entering settings. Do as follows:

a. To view the Click Start > Run > &Temp%.

Databases Setup and Installation 7

b. In the Status column, all rows must be marked as Exist or OK. If there are any errors (they will be marked in red) contact Synerion.

Installing the Synerion Direct Web Server 8

4 Installing the Synerion Direct Web Server To install the web server:

NOTE: To perform this step you should have MS Web Deploy installed. Click here.

1. Open the IIS Manager: %windir%\system32\inetsrv\InetMgr.exe.

2. Right click the web site which will host the Synerion Direct web application, select: Deploy > Import Application.

3. Browse to the location of Web Package folder in your installation package and select the Zip file located in this directory.

4. Click Next.

The following view shows the details of the deployment. Usually there is no need to change any of the settings however if required you can modify the advanced details of the deployment.

5. In the next screen you can select the name of the deployed application. If no special network configurations are made this will be a part of the URL which users will navigate to as clients. If the app is deployed to the Default Web Server on a web server hosted in the following url: www.synerion.com , then the resulting url that clients will need to browse to, will be: https://www.synerion.com/Lighthouse (assuming the https port bound to the site is 443):

http://www.iis.net/downloads/microsoft/web-deploy�

http://www.synerion.com/�

https://www.synerion.com/Lighthouse�


6. Click Next.The Installation Progress and Summary you should see the following summary screen with details of the deployment:

7. Click Finish. The Lighthouse directory is created.


If Default Web Site works on port 80, Lighthouse will be port 443. You can change this port if necessary.

8. Under Default Web Site, click Lighthouse, and then click SSL Settings.

9. Ensure that Require SSL is selected (leave the remainder as is).

10. In the Application Pool, in Advanced Settings, under Process Model, in Identity, ensure that the user sufficient permissions to databases (DBO).

11. Enable 32-bit application must be set to True.

12. In the Lighthouse folder, edit the following documents:

• In Web, in DataPath, enter a path to the TKSQL partition.


• Under Lighthouse > bin > configuration, in hibernate.cfg, direct Lighthouse to the current database. In Data Source, enter the server/database.

• Under Lighthouse > TKSQL binaries, perform registration on the following files:

▪ IcREpSql.dll


▪ TkSqlVbAdapter.dll

13. Install the required message queues. See Appendix: Synerion Direct Required Message Queues.

Installing the Synerion Direct Middleware Service 13

5 Installing the Synerion Direct Middleware Service

Middleware is the service that is responsible for business processes such as Alerts, Metrics, and email.

This section contains the following procedures:

• Pre-Requisites

• Installing the Lighthouse Middleware Service

• Setting the Database Connection

• Starting the Lighthouse Middleware Service

• Upgrading the Lighthouse Middleware Service

• Ensuring MSDTC is Properly Configured


5.1 Pre-Requisites The following is the Lighthouse server and Middleware prerequisites.

MSMQ:

1. From Start > Run, enter compmgmt.msc and click OK.

The Computer Management screen is displayed.

2. Select Computer Management > Services and Applications > Message Queuing > Private Queues.

(If it does not exist, follow the instructions in MSMQ and then return here)

3. Create a new Private Queue by right clicking Private Queue, and selecting New.


The New Private Queue dialog box is displayed.

4. If you have not yet created the following queues referenced in Appendix: Message Queues Required for Synerion Direct, do it now. NOTE: The Transactional checkbox must be seelcted for each new queue.


5.2 Installing the Lighthouse Middleware Service The Lighthouse Middleware service is a Windows service responsible for hosting Lighthouse external processes such as:

• Notifications

• Metrics pre calculation

Installing the LH Middleware service (and starting it after installation) is required ONLY if you want these services to run. If not installed or started Synerion Direct can still function properly however none of these external services will function properly.

To install the Middleware service:

NOTE: This installation needs to be done only once.

1. Copy the Middleware to the desired path on your local drive.

2. Locate the Synerion.Lighthouse.Middleware.exe to where it you copied it.

3. Install the service for the first time using the installutil.exe tool located in your .NET 4 installation folder, for example:

C:\Windows\Microsoft.NET\Framework\v4.0.30319\InstallUtil.exe Synerion.Lighthouse.Middleware.exe

NOTE: Ensure you execute the command from the directory the Middleware .exe file is located in; otherwise you need to specify it in your command line as well.

4. Enter a user that has access to running Windows services and has authorizations to the TKSQL and Notification databases that will be used. A dialog box will appear and request a "log on as" user and password for running the service.

5. This user needs to have access to the Middleware private queues created in Pre-Requisites.


5.3 Setting the Database Connection Hibernate configuration files for both databases are located in your bin\Configuration folder.

NOTE: Do not forget to configure the proper connection strings in both hibernate configurations! (each one will point to the corresponding database)

1. In Lighthouse/in/configuration, open the following files through a text editor, and enter your server and database in the indicated location.

• TK Database (hibernate.cfg.xml)

• Notifications Database (notifications.hibernate.cfg.xml)

For an example of nhibernate configuration using sql authentication.

<?xml version="1.0" encoding="utf-8" ?>

<hibernate-configuration xmlns="urn:nhibernate-configuration-2.2">

<session-factory> <property name="dialect">NHibernate.Dialect.MsSql2005Dialect</property>

<propertyname="connection.driver_class">NHibernate.Driver.SqlClientDriver</property>

<propertyname="connection.provider">NHibernate.Connection.DriverConnectionProvider</property>

<property name="connection.connection_string">


Data Source=Server Name;Initial Catalog=Database Name;User ID=Sql User name;Password=Sql password

</property>


5.4 Starting the Lighthouse Middleware Service 1. From Start > Run, enter services.msc and click OK.

The Services screen is displayed.

2. Locate the service Synerion Middleware Service.


5.5 Upgrading the Lighthouse Middleware Service To upgrade the service:

1. From Start > Run, enter services.msc and click OK.

The Services screen is displayed.

2. Locate the service Synerion Middleware Service.

3. Right-click the service, and select Stop.

4. Copy the new files overwriting the old ones.

REMINDER: Do not forget to configure your hibernate files located in the Configuration folder.

5. Right-click the service, and select Start.


5.6 Ensuring MSDTC is Properly Configured This section is relevant in situations where the Middleware service is installed on one machine and that at least one of the databases is installed on a SQL server on a separate machine. In such a scenario (which should be a common production scenario) MSDTC must be configured according to these steps for each of the host machines.

The NServiceBus hosted by the Middleware windows service creates a transaction in which it opens sessions to two separate databases:

• TKSQL

• Notifications

If the Middleware service is installed on one server and the databases are located on another machine (1 or 2) then a distributed transaction is required.

Therefore, for such scenarios MSDTC (Microsoft Distributed Transaction Manager) needs to be properly set up on both machines.

To set up MSDTC:

1. Enable MSDTC:

a. From Start > Run, enter dcomcnfg and click OK.

b. Open Component Services > Computer > My Computer > Distributed Transaction Coordinater > Local DTC.

c. Right-click Local DTC and select Properties. The Local DTC Properties dialog box is displayed.

d. Click the Security tab.

e. Ensure the following is selected

▪ Network DTC access

▪ Allow Inbound

▪ Allow outbound


2. Click OK.

3. Set up the MSDTC ports:

a. From Start > Run, enter dcomcnfg and click OK.

b. Open Component Services, right click My Computer and select Properties.

c. Click the Default Protocols tab.

d. Select the TCP/IP entry and click the Properties button.

e. Add a port range (the recommended range is 5000-5020, you should specify ports over 5000 and at least 20 ports).


f. Click OK.

g. Execute this setting on all participating server (the server hosting the Middleware and the server (s) hosting the SQL Databases).

h. Reboot the server for it to take effect.

4. Ensure thatMSDTC ports are open on Windows Firewall:

It is important to ensure that the above defined ports are open on the firewall of all participating machines. This can be done in two ways:

• Create custom inbound and outbound rules for these ports. For increased security you can define these rules apply only for specific IPs this way it will only apply to communication between the SQL server(s) and Web server(s).

• Use the default inbound and outbound MSDTC-related rule templates which exist in the windows firewall settings but are not enabled by default. Do the following:

1) From the Control Panel, open Windows Firewall management (wf.msc).

2) In inbound rules and outbound rules, enable all rules starting with Distributed Transaction Coordinator or MSDTC.

Appendix: Installing the MSMQ component for Windows 24

6 Appendix: Installing the MSMQ component for Windows

In order to install the MSMQ component for Windows, follow the steps under your Operating system:

• Installing MSMQ on Windows Server 2003

• Installing MSMQ on Windows Server 2008


6.1 Installing MSMQ on Windows Server 2003 1. In Control Panel, double-click Add/Remove Programs.

2. On the left tab of the Add/Remove Programs window, click Add/Remove Windows

Components .

The Windows Components Wizard opens.

3. In the Windows Components wizard, select Application Server,

4. Click Details.

5. Check Message Queuing, click OK, and then click Next to complete the installation.

6. In the Control Panel, double-click Administrative Tools, and then double-click Computer

Management .

The Computer Management screen is displayed.

7. Select Computer Management > Services and Applications > Services.

8. Right-click Message Queuing , and click Properties.


NOTE: Be sure to right-click the Message Queuing service in the services list on the right side of the window. Do not confuse it with the Message Queuing folder in the tree view.

9. Click the Recovery tab, set the first, second, and subsequent failures to Restart the service, and then click OK.


6.2 Installing MSMQ on Windows Server 2008

1. In the Control Panel, double-click Programs .

2. Double-click Programs and Features, select the option labeled Turn Windows features

on or off .

The Windows Features dialog box appears.

3. Select the Microsoft Message Queue (MSMQ) Server.

NOTE: It is not necessary to select all the components under it, just the main item.

4. Click OK. This will install all the necessary MSMQ components.

5. When installation completes, if prompted to restart your computer, please do so.

Appendix: Message Queues Required for Synerion Direct 28

7 Appendix: Message Queues Required for Synerion Direct

The following are the message queues required for Synerion Direct.

NOTE: Ensure that the user who is the logon user for the middleware service has full control access to these queues.

Message Queue Synerion Direct

Middleware Service

Both

synerion_lighthouse_events X

synerion_lighthouse_events.errors X

synerion_lighthouse_events X

synerion_lighthouse_middleware_events X

synerion_lighthouse_middleware_events.retries X

synerion_lighthouse_middleware_events.timeouts X

synerion direct installation guide · synerion direct installation guide contents 1 overview 4 2...

Documents