PigCHAMP Knowledge Software. Enterprise Edition Installation Guide

Transcription

1 PigCHAMP Knowledge Software Enterprise Edition Installation Guide

2 PIGCHAMP, LLC Enterprise Edition Installation Guide JUNE 2016 EDITION PigCHAMP Knowledge Software 1531 Airport Rd Suite 101 Ames, IA Phone (515) Fax (515)

3 Table of Contents Enterprise Server Installation... 1 Enterprise Client Installation... 5 Post Installation... 5 Specifying the Server... 6 Obtaining the IP Address of the Database Server... 6 Obtain a License: In order to register the software you will need to get a license from PigCHAMP Import a License: Once notification is received that the license is ready, import the license Troubleshooting... 9 Error logging on to server... 9 Determining if database/browser is started... 9 Client will not connect to the server Determining if windows firewall is enabled Modifying the Windows Firewall Disabling the Windows Firewall Opening the Firewall for Enterprise Clients Windows XP and Vista Opening the Firewall for Enterprise Clients Windows 7 and Windows Opening the Firewall for Enterprise Server Windows 2008 Server Unable to connect to service Firewall is blocking the service port PigCHAMP Licensing Service is not started Restart the service using the Services management console... 13

4 Chapter 1 Enterprise Server Installation Warning The computer that hosts the database server needs to have a static IP address. P igchamp Enterprise consists of several portions of software: SQL database, PigCHAMP Licensing Management Service (PCLMS), and the PigCHAMP application are required, though they do not need to be co-located. There are also some software modules that are optional: pdf995 driver, Scheduling Service and the PigCHAMP Backup and Restore Utility. PigCHAMP software uses Microsoft SQL Server as its database. You have the option during installation to either use an existing installation of SQL Server (2005 or newer) or have the setup install it for you. If you choose to let the setup install SQL Server it will install SQL Server 2008 R2 Express Edition with an instance called PigCHAMPData and database named PigCHAMP. You can also choose to manually install a different version of SQL prior to running the PigCHAMP database server installation software. You must have the PigCHAMP Setup file and either the SQL Installation file or existing SQL software available before beginning the installation. Note: On Windows 10 computers, SQL 2012 or SQL 2014 should be installed manually for best results. Downloadable files for installation: PigCHAMP Setup File (works for client, database server and PCLMS installation): SQL Setup File: You will be required to choose the language and version of program you need to download: SQLEXPR_x86 for 32-bit operating systems or SQLEXPR_x64 for 64-bit operating systems. SQL 2008 R2 SP2 Express: SQL 2012 SP2 Express: 1

5 SQL 2014 Express: Instructions to manually install SQL Express can be found here: 3F During the installation process, you will be presented with several screens. You can choose the back button to change your settings at any time during setup. At the end of the process, you will be presented with a list of the configurations you have chosen before performing the installation. The first two screens start the installation and ask you to accept the End User Licensing Agreement (EULA). You must accept the EULA to proceed with the installation. The Select Components screen will allow you to set up the database server. Choose Database Server installation from the dropdown menu. Here, you get to choose which software modules to install. Following is a brief overview of the items you see on this screen and what they are: 1. Static Client PigCHAMP application software. Application software can be installed on the same computer as the database but is not required. The local temporary reporting database is an option for the client computers connected to PigCHAMP and should not be selected for the database server installation. 2. Roaming Client PigCHAMP application software for non-connected clients. Should not be installed on database server. 3. pdf995 driver to create Adobe pdf documents a third-party software product that allows saving and ing of reports directly from the PigCHAMP program as pdf documents. 4. Scheduling Service - currently used for Canarm interface. Recommend to uncheck unless using Canarm interface. 5. Backup and Restore Utility Graphical interface that allows backup of PigCHAMP database for protection of data. This needs to be installed if there is no other SQL backup plan already in place. 6. SQL Server Command Line Utilities basic package of SQL command executables including bcp.exe to allow movement of data in and out of the PigCHAMP program 2

6 7. Licensing Service (PCLMS) Software service module that keeps track of numbers of pigs licensed and allows connection of client computers to database. PCLMS must be installed and running on the network in a location always available to clients. PCLMS uses hardware and software signatures to validate the installation of PigCHAMP. Therefore, it should not be installed on a virtual machine since moving the virtual machine will invalidate the license. PCLMS does not have to be installed on the same computer with the database or PigCHAMP application. 8. Database Microsoft SQL database where the PigCHAMP data will be stored. Can be any version of Microsoft SQL (version 2005 SP4 or higher) including Express. The default installation for Database Server will install static client software, pdf995 driver, Scheduling Service, SQL Command Line Utilities, PigCHAMP Backup and Restore utility, PCLMS, and the database. If you change any of these settings, the dropdown box will change to Custom installation. You are allowed to choose the Start Menu folder for PigCHAMP. It will default to PigCHAMP. The Database Server Options screen will allow you to choose how you want to install the database. If you choose to use an existing instance or installed SQL manually, fill out the data for the bottom option. You can choose to install the database files on a different computer than the computer running the PigCHAMP application or they can reside on the same computer. On the server\instance line, the server name will be the name or IP address of the computer where the database files reside. If you are installing the database on the local computer, you can use localhost for the computer name. In order to use a default unnamed instance, the server\instance line will just contain the server (localhost, IP or computer name of the database server). If you installed SQL manually using the PigCHAMP instructions, the instance will be PigCHAMPData and the database will be PigCHAMP. If you do not have an existing SQL program already installed, you will choose the top option default database. If this is a new installation, Microsoft SQL 2008 R2 Express will be installed with an instance of PIGCHAMPDATA and database PigCHAMP. 3

7 The installation will put the SQL files in the default location under the SQL server directory. If you want to be able to designate a different location for the SQL files, check the box that says Advanced Options. If you are installing a new database, you will be allowed to choose the location of the database files on the Select where to create the database files screen: If you leave these fields blank, it will install to the default locations in the SQL program files directory. Note: The Advanced Options checkbox also gives access to the option to store Unicode text fields. If the Store Unicode Text box is checked, it means that data will be stored in the database in NVARCHAR format. This will increase the size of the database since NVARCHAR data takes up more space than VARCHAR data (the default setting). This setting is only needed if using non-latin based graphical characters such as Russian, Chinese, Japanese, etc. that need to be displayed in the data text fields (farm name, etc.). If SQL has not been previously installed, the PigCHAMP Setup program will check the version of operating system (32-bit or 64-bit) and ask for the location of SQLEXPR that it needs to install. Use the Browse button to locate the SQL file that you downloaded. If all necessary components were not installed on the database server (PCLMS, static client, SQL database); you must run the installation program again on various computers on the network, choosing the components to be installed at each location. After all three necessary components are installed on the network, you must license the PigCHAMP application. Reference license options at the end of Chapter 2. 4

8 Chapter 2 Enterprise Client Installation E nterprise client may be installed on multiple computers. Each computer will connect to a single enterprise server database to access shared farm data stored on the database server. No data is stored locally on the client computer. On the Select Components screen, choose Static Client installation. During installation, a local instance of SQL Server Native Client will be installed along with PigCHAMP software. A local copy of pdf995 must be installed with Static Client software if reports will be saved in pdf format or ed from the client computer. The Local temporary reporting database checkbox allows for a local copy of SQL to be installed on the client computer. This can dramatically speed up report processing on the client computer. If this box is checked, the installation program will need to install or use a local copy of SQL on the client computer. See Chapter 1 for download links for SQL software installation files. The local temporary database does not permanently store PigCHAMP data and does not need to be backed up. Post Installation Once the installation is complete there are a few steps you will need to do in order to connect to the database server. 5

9 Specifying the Server When you first start a client program you will need to specify login credentials and the server\instance that you will log into. The server can be specified as either a hostname or IP Address, as shown below. For a default unnamed instance, use only the server name (no instance). If you already know the IP address or hostname of your server type it in the box and click Connect. If you are unsure how to obtain this information read the next section. If you do not have a username and password contact your server administrator. The defaults for first-time use are: Username: SYSADMIN (must be in all capital letters) Password: SYSADMIN (must be in all capital letters) Obtaining the IP Address of the Database Server If you are not sure how to obtain the IP address of the database server continue reading. The below instructions must be done on the server, not on a client. Click Start > Run and type cmd in the box next to Open, and then click Ok. In the window that came up type ipconfig and press enter. You should see output similar to the screenshot below. Write down the number and period sequence next to IP Address. In the example below that would be Now go to the client computer and enter in IP address\instance Name into the textbox, then press OK (ex: \PigCHAMPData). The first time you log into the database, the PigCHAMP software will attempt to locate the PCLMS service. The software assumes PCLMS is running on the same server as the database. If it does not find PCLMS running on the database server, 6

10 the software will ask you where to find PCLMS. You can specify where to find PCLMS at that time. If you are experiencing any issues at this point please refer to the troubleshooting section for possible solutions, or contact PigCHAMP Technical Support for assistance. Obtain a License: In order to register the software you will need to get a license from PigCHAMP. Open the PigCHAMP program by either double-clicking on the PigCHAMP icon on your desktop, or by navigating to Start > All Programs > PigCHAMP > PigCHAMP ( Programs may be in place of All Programs ). After logging into the program, the following dialogue screen will appear: Click the OK button. The following screen will appear. (If the program is already licensed and this does not appear, go to Help > About to open the Registration page.) Click on the Customer Information tab and fill out the information on that page. (Sections with an asterisk (*) are required.) Click on Registration/Licensing Information tab. If this computer is connected to the internet, click on the Send or Receive button. This will send an automatic license request to PigCHAMP. The user will receive an notification to the specified on the Customer Information tab when the license has been processed. If the computer does not have internet access, click on the Export Information button and save the registration file to a familiar location. Copy the file to an external storage device and take it to a source with internet access. Send an to reg@pigchamp.com with the registration file attached in order to obtain a valid license for the program. NOTE: All programs are different. If you do not know how to attach items to your DO NOT CALL PigCHAMP tech support. Contact your provider s support line for assistance. 7

11 If no internet option is available, you can fax the registration to PigCHAMP. You will need to click on the Export Information button and save the registration file to a familiar location. Go to that location and open the careregistration.xml and print. The printed registration can be faxed to Special Note: Licenses will only be processed during regular business hours. Monday through Friday 8 a.m. to 5 p.m. CST, excluding US holidays. Import a License: Once notification is received that the license is ready, import the license. If not already open, launch PigCHAMP program, either from the desktop shortcut icon, or by navigating to Start > All Programs > PigCHAMP > PigCHAMP ( Programs may be in place of All Programs ). If the internet option for licensing was used, click on the Send or Receive button again. The license will be automatically imported. If the computer does not have internet access, go to the source with internet access and access the account initially used to send the registration file. Save the file attached to the notification from PigCHAMP to an external storage device. Take the external storage device back to the computer with the PigCHAMP program and insert it into the computer. Click on the Import License button and navigate to the registration file received from PigCHAMP, and then click Open. The license file will be imported. If you faxed PigCHAMP your registration, you will receive your registration back via fax. Once your registration is received, if not already open, launch the PigCHAMP program from either the desktop shortcut, or by navigating to Start > All Programs > PigCHAMP > PigCHAMP ( Programs may be in place of All Programs ). You will need to key in your License Key and Placement Credit Key. These keys are case sensitive so please enter all letters and numbers exactly as they appear on the faxed sheet. Once entered click the Save button. A dialog box will appear stating that the application has been successfully registered. If there is an error indicating the license is not valid check the letters and numbers to make sure they are correct, it is case sensitive so make sure you have capital and lower case letters just as they appear in the fax you received. Contact PigCHAMP for assistance if the invalid key error persists. Now your server is registered and ready for use. NOTE: Moving PCLMS will cause your license to become invalid. Therefore, if PigCHAMP software is installed on a virtual machine, it is wise to install PCLMS on a real machine. 8

12 Chapter 3 Troubleshooting I f you are having any issues with the installation this section will do its best to help you resolve them. In the event that your issues are still not resolved after reading this chapter please contact PigCHAMP Technical Support and we will be happy to assist you. Error logging on to server If you followed the server installation instructions but receive the Invalid Connection String Attribute error when trying to log on to PigCHAMP from the server, it means that the PigCHAMP software cannot access the database for some reason. Determining if database/browser is started To determine if the database instance is started: Click Start > All Programs > Microsoft SQL Server > Configuration Tools > SQL Server Configuration Manager. Click on SQL Server Services on the left hand pane. The right pane will show you what services are running. The instance used for PigCHAMP must be running as well as SQL Browser. The default named instance for PigCHAMP is PigCHAMPData, though this may be designated during installation if using a previously installed instance of SQL Server. o If PigCHAMPDATA (or correct instance) is not running, start it by right-clicking on the instance name and choosing Start. If the instance will not start, you may have to change the logon account by right-clicking on the instance name, choosing Properties > Log On tab and changing the logon account to Built-in Account: Local System. o If SQL Browser is not running, right-click on it and select Start. If it states that you cannot start it since it is disabled, you must enable it by right-clicking on SQL Browser, choose Properties > Service tab. Change the Start Mode dropdown to Automatic. 9

13 Client will not connect to the server If you followed the client installation instructions but continue to get a dialog indicating it cannot connect to the server there may be a firewall enabled on the server and/or client that is causing the issue. The error Invalid Connection String Attribute means the PigCHAMP application cannot connect to the SQL database. Determining if windows firewall is enabled First we need to determine if there is a firewall enabled on the server. The following instructions will help you determine if the Windows Firewall is enabled, and how to fix it. There are many other possible firewall applications that you may have, so if you find that the windows firewall is disabled but you are still not able to connect please contact PigCHAMP. The below instructions must be done on the server, not on a client. Click Start > Control Panel, then double click on Network Connections (you may have to go to Settings before Control Panel ). In the window that opens you should see something similar to the picture below. Notice the yellow padlock in the upper right corner of the icon, as well as the word Firewalled. If you do not see either the text or the padlock on the connections in your connections window then your windows firewall is not enabled. If you do see them then continue reading. Modifying the Windows Firewall If you found that the windows firewall is enabled you have two options to allow the PigCHAMP clients to connect to your server. You can disable the firewall, which will disable the protection it provides for your computer as well, or you can tell the firewall to let the PigCHAMP clients go past it. Disabling the Windows Firewall 1. Right-click on the connection your computer uses in the connections window that was opened in the previous section, (This is most likely labeled Local Area Connection ) in the menu that pops up click on Properties. 2. A dialog box should have appeared with General, Authentication and Advanced tabs. Click on the Advanced tab. 3. In the Windows Firewall section of this tab click on the Settings button. 4. You should now see a Windows Firewall dialog box, and the General tab should be selected. Click on the button next to the red shield with a white x in it. The button should get filled in Green, indicating it is selected. 5. Click Ok, then Ok again. The connections in the connections window should now be missing the word Firewalled and the yellow padlock icon. Your firewall is now disabled. 10

14 Opening the Firewall for Enterprise Clients Windows XP and Vista 1. Our first step will be determining what port number your SQL Server installation assigned the PigCHAMP database. a. Click Start > All Programs > Microsoft SQL Server> Configuration Tools > SQL Server Configuration Manager (you may have Program Files in place of All Programs ). b. On the left side of the window that pops up click on the plus symbol next to SQL Server Network Configuration, then click on Protocols for PIGCHAMPDATA. c. Now double click on TCP/IP on the right side of the window. d. In the dialog that pops up click on the IP Addresses tab. e. In the IPAll section, write down the number in the TCP Dynamic Ports box. 2. Now that we have the port used by SQL Server we can open it up in the firewall. a. Follow steps one through three of the Disabling the Windows Firewall section. You should end with the Windows Firewall dialog. b. Click on the Exceptions tab. c. Click on the Add Port button. i. In the Name box enter SQL Server Browser. ii. In the Port Number box enter iii. Click on the button next to UDP and then click OK. d. Click on the Add Port button again. i. In the Name box enter SQL Server PIGCHAMPDATA. ii. In the Port Number box enter the port number that you wrote down from step one. iii. Verify that the TCP button is checked and then click OK. e. Click on the Add Port button again. i. In the Name box enter PigCHAMP Licensing Service. ii. In the Port Number box enter iii. Verify that the TCP button is checked and then click OK. Your firewall should now allow the clients to pass through it in order to connect to your PigCHAMP database. Go to a client machine and attempt to connect to the server. If you are still having issues please contact PigCHAMP for assistance. Opening the Firewall for Enterprise Clients Windows 7 and Windows Go to Control Panel a. If Control Panel is being viewed by Category: i. Click System and Security. ii. Under Windows Firewall click Allow a program through Windows Firewall. b. If Control Panel is being viewed by icons: i. Click Windows Firewall. ii. On the upper left hand side click Allow a program or feature through Windows Firewall. 11

15 2. Click on Allow another program 3. Click Browse, browse to Computer > Local Disk C: > Program Files (x86) > Microsoft SQL Server > 90 > Shared. Click on sqlbrowser.exe and click Open. 4. Click Add. a. Note: Newer versions of SQL may have moved this file to a different folder search to find sqlbrowser.exe if needed 5. Click on Allow another program 6. Click Browse, browse to Computer > Local Disk C: > Program Files (x86) > Microsoft SQL Server > MSSQL.1 > MSSQL > Binn. Click on sqlservr.exe and click Open. 7. Click Add. a. Note: Newer versions of SQL may have moved this file to a different folder search to find sqlservr.exe if needed 8. Click on Allow another program 9. Click Browse, browse to Computer > Local Disk C: > Program Files (x86) > PigCHAMP. Click on PCLMS.exe and click Open. 10. Click Add. The Allowed programs and features: should now have PCLMS, SQL Browser Service EXE, and SQL Server Windows NT options listed and checked. Opening the Firewall for Enterprise Server Windows 2008 Server Windows 2008 Server introduced a whole new security scheme that restricts access to SQL on the server. See the Microsoft Knowledgebase article for information and a script to allow SQL to access a database on the server: In addition to the SQL ports, you must also allow PCLMS to penetrate the server firewall. PCLMS uses port 6000 by default, though that can be changed via dialog box when the PigCHAMP program first starts. Unable to connect to service PCLMS, which stands for PigCHAMP Licensing Management Service, must be installed and running on the network so clients and database server can both access it. When the client first starts, it will look for PCLMS on the database server. If PCLMS was not installed on the database server, a pop up will appear asking where to locate PCLMS. Type in the IP address and port where PCLMS was installed. The port will 12

16 be 6000 unless manually changed in the installation process. If you followed the client installation instructions but still cannot connect to PCLMS, there are a few possible causes. Firewall is blocking the service port Determine if the Windows Firewall is enabled, and open it up if needed. 1. Follow the instructions in the Determining if windows firewall is enabled section in the Client will not connect to server section of this chapter. 2. If the Windows Firewall is enabled then follow step 2 of the Opening the Firewall for Enterprise Clients section. If you have not already opened your firewall for SQL Server make sure you also follow step c and d. 3. If you have different firewall software then please consult the manual on how to open up ports. PigCHAMP Licensing Service is not started On installation the PCLMS service should automatically start itself, and it will be setup to start automatically if you reboot your computer. If for some reason it has trouble starting you can either try rebooting the server so it starts automatically, or you can follow the steps below to manually start the service. Restart the service using the Services management console 1. Verify the windows user you are logged in as has Administrator rights. 2. Click Start > Control Panel, or Start > Settings > Control Panel. a. If you have an option titled Performance and Maintenance click on that. Otherwise skip to step b. b. Double-click on Administrative Tools. c. Double-click on Services. 3. On the left side of the Services window that opened up is your list of available services for your computer. Scroll down until you see PCLMS and left-click on it to highlight it. 4. Now right-click on it to view the context menu for the service. a. If Start is bold then click on it to start the service. b. If Start is grayed out then click on Restart to restart the service. c. If the service will not start, change the logon service by right-clicking PCLMS, choosing Properties > Log On tab. Fill in radio button in front of Local Service Account. Click on Apply and then OK. Start the PCLMS service as described above. 5. If PCLMS fails to start often when the computer boots up, change the recovery options for PCLMS. a. Right-click on PCLMS, choose Properties > Recovery tab. b. Set options for first, second and subsequent failures as desired. Setting First Failure to Restart the Service after 1 minute will often prevent further issues with PCLMS 13

17 not starting correctly on boot up. c. Click on Apply and then OK to exit. d. For Windows 10 if PCLMS often does not start when the computer is restarted, set the Start-up type to Automatic (Delayed Start) 14