ACTIVANT DISTRIBUTION SUITE Installation Guide (SQL Server) Self-Hosted
This manual contains reference information about software products from Activant Solutions Inc. The software described in this manual and the manual itself are furnished under the terms and conditions of a license agreement. The software consists of software options that are separately licensed. It is against the law to copy the software on any medium, or to enable any software options, except as specifically permitted under the license agreement. In addition, no part of this manual may be copied or transmitted in any form or by any means without the prior written permission of Activant Solutions Inc. From time to time, Activant makes changes to its software products. Therefore, information in this manual is subject to change, and the illustrations and screens that appear in the manual may differ somewhat from the version of the software provided to you. Created by: WDN Technical Communication 2011, Activant Solutions Inc. All rights reserved. Activant and the Activant logo are registered trademarks and Activant Prophet 21 is a trademark of Activant Solutions Inc. All other company or product names are the trademarks or registered trademarks of their respective companies. Activant Solutions Inc. 7683 Southfront Road Livermore, CA 94551 Version 1.0.0.0 Publication Date: 4/27/2011-2 -
Revision History Build Description of Update Page (11/1/10) Beta release n/a (4/1/11) Split self-hosted instructions to two manuals, one for PostgreSQL Servers and one for SQL Server. n/a (4/27/11) Updated system requirements to include Java on the ADS Server. 8-3 -
Table of Contents Overview 5 Self-Hosted 7 Self-Hosted Requirements 8 Setting Up Your ADS Server and Database: SQL Server 9 Install SQL Server 9 Create the ADS Database 9 Create Two New Logins 11 Configuring the ADS Framework (Self-Hosted) 15-4 -
Overview Overview Before you can integrate any Activant Distribution Suite (ADS) products with your Prophet 21 system, you must install the ADS framework. The ADS framework varies depending on how you plan to host your ADS applications: you can either have Activant host them, or you can host them yourself. If you need to setup ADS in a test environment, you must install it on a test server. Contact Activant to set up another subscriber for testing (e.g., @distributortest.com, where production is @distributor.com). Then configure your test ADS environment to point to your test database. Setting up the ADS test environment is identical to the production environment, except the subscriber and server / database names change. There are two methods of implementing ADS: Activant-hosted - All of the ADS applications run off of Activant's ADS server. You must install the framework locally, but you do not need to have a local database. Self-hosted - All of the ADS applications run on hardware at your physical location. You must install the framework and connect it to a local ADS database. - 5 -
Overview Activant-Hosted - 6 -
Overview Self-Hosted Self-Hosted The ADS framework consists of JBoss, JDK, and the ADS database. This framework supports communication between your production database, your ADS database, and the central ADS servers. This manual describes the process of installing and configuring the ADS framework for your production system. There are three parts to the installation. Setting up your server and database Installing the ADS components Configuring your ADS framework The following sections explain the process in detail with step-by-step instructions. - 7 -
Self-Hosted Requirements Self-Hosted Requirements If you have chosen to host your own ADS applications, use the following requirements. A server with Windows Server, Java, and a database management system (choose either database management system listed below); Activant recommends against using your Prophet 21 production database server. SQL Server 2000 or better (SQL 2005 or better recommended); the server should use the TCP / IP protocol for connections (you can view and change protocols using the SQL Server Configuration Manager) OR PostgreSQL Postgres Plus Standard Server version 8 or better. Prophet 21 version 12.4 or higher (each ADS product may require a specific build; check the documentation for any specific product)..net Framework version 2.0 or higher on the server. - 8 -
Setting Up Your ADS Server and Database: SQL Server Setting Up Your ADS Server and Database: SQL Server You must complete the following things to set up your server and database before you install the ADS framework. Install SQL Server Create the ADS database Create two new logins for the ADS framework (one to access the ADS database, and one to access the Prophet 21 database) These instructions use SQL Server 2008. For more information on how to create databases or logins for other versions of SQL Server, refer to SQL Server Books Online. Install SQL Server These instructions do not cover installation of SQL Server. However, ADS requires that you use the TCP / IP protocol for connections (set this up in SQL Server Configuration Manager). Create the ADS Database 1. Log into the server you want to use for your ADS database. This server may be your production database server or some other server you want to use for ADS. 2. Open SQL Server Management Studio (Start > All Programs > Microsoft SQL Server 2008 > SQL Server Management Studio). 3. Log into your server. 4. Expand the instance on which you want to install ADS (you may have only one instance, depending on how you set up SQL Server). - 9 -
Setting Up Your ADS Server and Database: SQL Server 5. Right-click the Databases node and select New Database. 6. Name your database. Activant recommends using ADS as the name. - 10 -
Setting Up Your ADS Server and Database: SQL Server 7. You can accept the rest of the defaults and click OK. Your database is created. Now that you have a database for ADS, continue to the next section to create SQL Server logins for ADS. Create Two New Logins The ADS framework must have access to both its own database (which you just created), and also to your Prophet 21 production database. The following instructions help you to create the two logins ADS needs. 1. Open SQL Server Management Studio (Start > All Programs > Microsoft SQL Server 2008 > SQL Server Management Studio). 2. Expand the server instance that contains your ADS database. 3. Right-click the Security node and select New > Login. - 11 -
Setting Up Your ADS Server and Database: SQL Server 4. On the General page, give the login a name. Activant recommends adsuser as the login name. 5. Select SQL Server authentication. 6. Enter a secure password for the login. Make sure you track this login and password as you normally track secure logins to the database, as you need to specify this later. 7. Disable the Enforce Password Expiration check box. 8. Select ADS as the default database. Your screen should look like the following: 9. Select the Server Roles page. 10. Enable the sysadmin check box to give this login system administration privileges for the SQL Server. - 12 -
Setting Up Your ADS Server and Database: SQL Server 11. Select the User Mapping page. 12. Enable the Map check box to map adsuser to the ADS database. - 13 -
Setting Up Your ADS Server and Database: SQL Server 13. Repeat Steps 3-15, except the login name should be adsp21user, and the database should be your Prophet 21 production database. You have now created the two SQL Server logins the ADS framework needs. Continue to the next section to begin installing the ADS framework components. - 14 -
Configuring the ADS Framework (Self-Hosted) Configuring the ADS Framework (Self-Hosted) Before you can use any features or products from ADS, you must configure the ADS framework so that it has access to both the ADS and Prophet 21 databases. 1. If it is not already open, open the ADS Configuration tool (by default, Start > All Programs > Activant Distribution Suite 1.0.0.0 > ADS Configuration). 2. Select Self Hosted. 3. Click Next to enter the ADS domain. 4. Enter the ADS domain assigned to you by Activant. This domain is typically yourcomanyname.com. - 15 -
Configuring the ADS Framework (Self-Hosted) 5. Click Next to select your database server type. 6. Select PostgreSQL Database. 6. Select Microsoft SQL Server Database. - 16 -
Configuring the ADS Framework (Self-Hosted) 7. Click Next to configure ADS database access. 8. Enter the server name, port, database name, user name, and password. The port defaults to the default port for the server. If you changed the port for your server from the default, you must change the default port here; otherwise, you can leave the default. 9. Click Test Connection to ensure that ADS can connect to your database using the connection and authorization properties you entered. If the test succeeds, the following message displays. - 17 -
Configuring the ADS Framework (Self-Hosted) If the connection fails, the system displays an error message pop up that describes why the connection failed. Note that sometimes it takes a little while for the error message to display as the program waits for connection timeouts. 10. Click Next to configure Prophet 21 database access. 11. Enter the server name, port, database name, user name, and password for your Prophet 21 database. - 18 -
Configuring the ADS Framework (Self-Hosted) The port defaults to the default server port. If you have changed your server port, you must change the port. 12. Click Test Connection to ensure that ADS can connect to your database using the connection and authorization properties you entered. If the test succeeds, the following message displays. If the connection fails, an error message pop up displays that describes why the connection failed. Note that sometimes it takes a little while for the error message to display as the program waits for connection timeouts. - 19 -
Configuring the ADS Framework (Self-Hosted) 13. Click Next to select ADS authentication type (the authentication that users will use when logging into ADS). 14. Select either Windows Authentication or Database Authentication. You should select whichever option matches how your users normally log into Prophet 21. If you select Windows Authentication, then you must specify the name of your LDAPserver in the Windows Authentication Server field. 15. Click Next to review a summary of your selections. - 20 -
Configuring the ADS Framework (Self-Hosted) 16. Click Finish to save the configuration. Your ADS configuration settings are now saved. If you have not already done so, you can close the Activant Distribution Suite Setup program. - 21 -