GlobalForms v6.1 Installation Guide

Transcription

1 GlobalForms v6.1 Installation Guide 2015 Square 9 Softworks All rights Reserved The copyright for all material provided herein is held by Square 9 Softworks. None of the material may be copied, reproduced, distributed, republished, downloaded, displayed, posted or transmitted in any form or by any means, including, but not limited to, electronic, mechanical, photocopying, recording, or otherwise, without the express written permission of Square 9 Softworks. i P a g e

2 Table of Contents PURPOSE... 1 PREREQUISITES... 1 INSTALLING JAVA ON THE GLOBALFORMS SERVER... 2 DOWNLOADING THE MEDIA... 4 UNZIPPING GLOBALFORMS... 4 SQL CONFIGURATION... 4 CONFIGURING THE FORM SUBMISSION DATABASE... 8 CONFIGURE THE GLOBALFORMS DATABASES... 8 CHANGING DATABASE SETTINGS FROM DEFAULTS INSTALLING GLOBALFORMS SERVER INSTALLING THE SERVICE CONFIGURING GLOBALFORMS APPLYING YOUR PRODUCTION LICENSE KEY LOGGING IN FOR THE FIRST TIME CHANGING THE DEFAULT ADMIN PASSWORD CREATING A NEW TENANT ADDITIONAL CONFIGURATION INFORMATION CHANGING THE DEFAULT TOMCAT LOG IN NOTES ii P a g e

3 Purpose This guide outlines the installation process for installing GlobalForms version 6.1.x on Windows based machines. Prerequisites Prior to installing Square 9 GlobalForms, the following technical requirements must be in place: GlobalForms Server Requirements o Java 7 (JDK 7) 2 or higher o Microsoft SQL Server Express 2008 or 2012 GlobalForms Designer Supported Browsers o Firefox Latest Stable Version (all platforms) o Chrome Latest Stable Version (all platforms) o Internet Explorer 9 (Windows) 1 Browser must have JavaScript, CSS and cookies enabled Form Filling Supported Browsers - Desktop o Firefox Latest Stable version (all platforms) o Chrome Latest Stable Version (Windows/Mac) o Internet Explorer 9 or higher (Windows) 1 o Safari (Mac) Browser must have JavaScript, CSS and cookies enabled Form Filling Supported Browsers - Mobile o Safari (ios 7.0) Editor Recommendation o While it is not necessary to install a file editor, it is strongly recommended. Notepad++ is a free editor that makes working with xml files very easy. Notes 1. GlobalForms Forms and Flows will not display correctly in Internet Explorer browsers when Compatibility View is enabled. 2. The Java Runtime Environment 7 (JRE) update level must be at 21 or above. (JRE 7u21+). 1 P a g e

4 Installing Java on the GlobalForms Server The Java JDK runtime can be downloaded from the following link: Select the Windows version appropriate for your operating system configuration (x86 for 32-bit systems and x64 for 64-bit systems) and follow the instructions to properly complete the installation. Once installed you may begin the installation of GlobalForms server. Set the JAVA_HOME System Variable In order for GlobalForms to properly interact with the Java JDK on a 64-bit system, a system variable needs to be set. 1. Right click on My Computer, click on properties and go got advanced system settings (Figure 1.1). (Fig. 1.1) 2. Under the Advanced tab, go to environmental variables (Figure 1.2). (Fig. 1.2) 2 P a g e

5 3. Click on New under the system variables (Figure 1.3). (Fig. 1.3) 4. For the variable name, use JAVA_HOME for the variable value, find the path to the jdk. Do NOT use the one under the x86 program files directory. Since there are often updates to java, your installation path may vary from the one below (Figure 1.4). (Fig. 1.4) 5. Now you will test the new variable. Open a command prompt and type ECHO %JAVA_HOME% if you see the system variable value that you set earlier, Java is properly configured (Figure 1.5). (Fig. 1.5) 3 P a g e

6 Downloading the Media GlobalForms installation media is distributed electronically. You will receive an with a download link to GlobalForms6.zip, along with associated documentation. If you need to obtain this media, contact your Square 9 Authorized Reseller or Square-9.com. Download and save the media to a local path on the GlobalForms server. Unzipping GlobalForms 1. Once downloaded, unzip the contents of GlobalForms6.zip to X:\GlobalForms6 where X represents the drive on the GlobalForms server where GlobalForms will be installed to (Figure 1.12). Note: This is not a temporary directory, GlobalForms will reside and run from the directory that these files are unzipped to. SQL Configuration GlobalForms requires the following to be configured. (Fig. 1.12) SQL Server Browser Service Started Named Pipes & TCP/IP enabled SQL Server and Windows authentication on mix mode Remote connection enabled A SQL user that GlobalForms can use for authentication SQL Server Configuration Manager 1. Go into the SQL Server Configuration Manager and click on SQL Server 20XX Services (Figure 1.6). (Fig. 1.6) 2. If the SQL Server Browser is not running, right click on it and go to properties. 4 P a g e

7 3. Switch to the Service tab and find the Start Mode option. It is likely set to disabled. Click on the dropdown and choose Automatic (Figure 1.7). (Fig. 1.7) 4. Click OK and go back to the SQL Server Configuration Manager. This time on the left select Protocols for. For your particular instance. If installing on the same server as SmartSearch, this will likely be the GETSMART instance (Figure 1.8). (Fig. 1.8) 5. Make sure that Named Pipes and TCP/IP are both enabled. 5 P a g e

8 SQL Server Management Studio 1. First, make sure that mixed authentication is on. SmartSearch uses windows authentication and GlobalForms uses SQL. Go into the SQL Server Management Studio and right click on the instance that GlobalForms will be installed on, in this case GETSMART (Figure 1.9). (Fig. 1.9) 2. On the left hand side click on Security and make sure the radio button for SQL Server and Windows Authenticated mode is clicked (Figure 1.10). (Fig. 1.10) 6 P a g e

9 3. Then, back on the left hand side, switch to the Connections page and make sure Allow remote connections to this server is checked (Figure 1.11). (Fig. 1.11) 7 P a g e

10 Configuring the Form Submission Database Your GlobalForms server requires a SQL database for storing users and form submissions. GlobalForms has been certified with the following SQL databases: Microsoft SQL Server 2008 Microsoft SQL Server 2008 R2 Microsoft SQL Server 2012 Follow these steps to create the necessary databases for GlobalForms. GlobalForms comes preconfigured to connect to a database in the default GETSMART instance along with the GlobalForms user created in the following steps. Instructions on how to modify this follow. The database configuration file frevvo.xml is located in <GlobalForms installdir>/tomcat/conf/catalina/localhost directory. Configure the GlobalForms Databases 1. In the Microsoft SQL Management Studio Object Explorer, look for the Databases section. Right click on it and select New Database. (Figure 1.12) (Figure 1.12) 2. Enter in a name of GlobalForms6 for the database, then select OK. (Figure 1.13) (Figure 1.13) 8 P a g e

11 Manually Adding the SQL User Now a user needs to be created to connect GlobalForms to the database. 1. Now we will add a SQL user for GlobalForms to use. Back in the main studio window, expand the SQL instance, Security, and then Logins. Right click and go to New Login (Figure 1.14). (Fig. 1.14) 2. Enter a username, choose SQL Server authentication and enter a password, and then uncheck Enforce password policy so that the subsequent checkboxes are also unchecked and greyed out (Figure 1.15). By default, GlobalForms is configured to use the username: globalforms with the password: gf@cce$$61 (Fig. 1.15) 9 P a g e

12 3. Switch to the Server Roles page and give the user sysadmin access (Figure 1.16). (Fig. 1.16) 4. Set the owner of the database by going to Security > Logins > right click your GlobalForms user and select Properties. Click User Mapping > check the GlobalForms database and check db_owner. Click OK (Figure 1.17). (Fig. 1.17) 10 P a g e

13 Changing Database Settings from Defaults NOTE: If you are using the GETSMART SQL instance (you are if you installed SmartSearch using the Sales Demo option and used the defaults) AND you used globalforms for the username and for the password of the SQL user, you can skip this section. Back in the frevvo.xml file you need to make some changes if you are not using the default settings. Configuration of the connection URL is key to successfully connecting the GlobalForms server to your database. Consult your DBA to assist with connection issues. 1. Edit the file X:\GlobalForms6\tomcat\conf\Catalina\localhost\frevvo.xml. Scroll down to the SQLSERVER resource section. You will need to make the changes for the GlobalForms6 (Figure 1.18). NOTE: It is strongly recommended that you open this file using Notepad++. <!-- SQLSERVER Resource --> <Resource auth="container" maxactive="200" maxidle="20" maxwait="10000" validationquery="select 1" testonborrow="true" testonidle="true" timebetweenevictionrunsmillis="10000" removeabandoned="true" logabandoned="true" name="jdbc/frevvods" driverclassname="com.microsoft.sqlserver.jdbc.sqlserverdriver" username="globalforms" type="javax.sql.datasource" url="jdbc:sqlserver://localhost\getsmart;databasename=globalfo rms6;"/> 2. The SQL username and password need to be set in the definition. The server name or IP address, along with the instance name also need to go in the URL. If the SQL server is installed on the same server as GlobalForms, you can just use localhost (Figure 1.18). (Fig. 1.18) 11 P a g e

14 If installing on a SQL Server other than the default GetSmart instance, for both data sources frevvods and userds: 1. Verify that the URL parameter is pointing to the correct server. If GlobalForms and the database server are collocated localhost may be fine. The URL parameters depend on the database type and installation choices made when your DBA installed your database software. Consult your DBA for the correct connection values. 2. As of SQL 2000, Microsoft SQL allows installation of multiple SQL named instances. If your SQL server was installed this way you must use the instance parameter. For example if your database instance was named GetSmart (Figure 1.19): url="jdbc:sqlserver://localhost\getsmart;databasename=globalforms6;user =globalforms;password=globalforms;"/> (Fig. 1.19) 3. Verify that the users and passwords required to connect to each database are correct. 4. Make sure that the users configured in the data sources have permissions to read and write to the respective databases. NOTE: Upon any changes to the Frevvo.XML file, you will need to restart the ssglobalforms6 service in your services control panel. Installing GlobalForms Server Installing the Service 1. If you have a 32-bit system, go to the x:\globalforms6\tomcat\bin\x86 folder and copy all three files into the x:\globalforms6\tomcat\bin\ folder. When prompted, overwrite the files. 12 P a g e

15 2. To install the GlobalForms web service, launch a command prompt with administrative access. To do so, navigate to Start Program Files Accessories and right click on Command Prompt. Choose run as administrator and confirm any prompts if applicable. Change the directory to X:\GlobalForms6 and execute the service installation by typing Install-Service.bat. You will receive a message indicating ssglobalforms6 was installed successfully upon completion (Figure 1.20). (Fig. 1.20) 3. To start the service, open Control Panel, select Administrative Tools and open Services. You may also type services.msc into the search/run bar of Windows. Locate ssglobalforms6 in the list of services, right click and choose Properties (Figure 1.21). (Fig. 1.21) 13 P a g e

16 4. Set the Startup type to be Automatic if you d like GlobalForms to automatically start upon reboot of the server. Click Start to start the service (Figure 1.22). 5. Restart the Server (Fig. 1.22) 14 P a g e

17 Configuring GlobalForms Applying your Production License Key Upon first access, GlobalForms will prompt you to update your license key. To access the GlobalForms application you will need to navigate to in your web browser. When GlobalForms media is shipped via , a license key will be included that is unique per customer. Copy and paste the license key into the text box and click Submit to activate GlobalForms (Figure 1.23). If you are unsure what your GlobalForms license key is, contact fulfillment@square-9.com or your Square 9 Authorized Reseller. Logging in for the First Time (Fig. 1.23) 1. To log in and begin using GlobalForms (Figure 1.24), navigate to from a supported web browser, where servername is the name of the server that you ve installed GlobalForms to. 2. GlobalForms can be also accessed over the internet if made available, for example: 15 P a g e

18 3. The default GlobalForms Administrator username is and the password is admin. Changing the Default Admin Password (Fig. 1.24) 1. Once logged in, the first thing we recommend is changing the default admin password. 2. Select Manage Tenants from the Manage server list options (Figure 1.25). (Fig. 1.25) 3. A list of Tenants will be displayed. Click on the next to the (Default tenant) (Figure 1.26). (Fig. 1.26) 4. The Manage tenant menu will be displayed. Select Manage users (Figure 1.27). (Fig. 1.27) 16 P a g e

19 5. An alphabetical list of users will be displayed. Click on the Edit User button next to the admin user (Figure 1. 28). 6. The profile update form will be displayed. (Fig. 1.28) NOTE: In addition to changing the admin password, you may configure personal information for the admin user such as first and last name, address, form filling task notification preference and max form attachment size. This is important if the admin user will be involved in form filling workflows. 7. Once complete, click Submit to save your changes (Figure 1.29). (Fig. 1.29) 17 P a g e

20 Creating a New Tenant Before you can create forms, you need to create a tenant on your GlobalForms server. Tenants merely allow you administrative and data control so you can create and manage users, roles, workflows, and submissions for your forms. 1. Select Manage Tenants from the Manage server list options (Figure 1.30). (Fig. 1.30) 2. A list of Tenants will be displayed. From the list of tenants, click on the next to Tenants (Figure 1.31). (Fig. 1.31) 18 P a g e

21 3. Select your Security Management Class. For Frevvo Default Security Manager The numbers in the section below relate to the red numbers in Figure Tenant ID This is what users will enter at the end of their username after symbol. (i.e. jsmith@s9s) 2. Tenant Name This is a good place to enter the full name of the Tenant 3. Tenant Description Enter a description for the Tenant 4. Admin User Id A username for the administrative user. admin is a good choice 5. Password a. Create a password b. Confirm the password 6. Enter the address for the administrative user (Fig. 1.32) For LDAP/Active Directory Security Manager The numbers in the section below relate to the red numbers in Figure Connection URL That path to the LDAP Server 2. Connection User A Domain user that only needs read rights to AD 3. Connection Password The password for the above user 4. Ignore Case Check the box to make the system ignore the case in usernames Users Base This is the path to the object in your domain where your users exist Groups Base This is the path to the object in your domain where your groups exist Copy as seen below. Do NOT alter! 17. Custom Enter LDAP additional attributes here separated by commas with no spaces 18. Tenant Id This is what users will enter at the end of their username after symbol. (i.e. jsmith@s9s) 19. Tenant Name This is a good place to enter the full name of the Tenant 20. Tenant Description Enter a description for the Tenant 21. Admin User Id This must be a domain user and this will be used to administer the Tenant. Notes 1. With this box unchecked, JSmith@s9s is different than jsmith@s9s. Checking this box means user s will not need to remember how their login is cased and Square 9 advises that this is enabled. 2. If you want to pull in all your users and/or groups, you can enter only your domain here. For instance, the domain square-9.com would be represented by entering DC=square-9,DC=com 19 P a g e

22 (Fig. 1.33) 22. Click Submit. 20 P a g e

23 Additional Configuration Information Changing the default tomcat Log In If it is critical that you change the default tomcat login information, simply go to <GlobalForms-home>\tomcat\conf and edit tomcat-users.xml. The default is the following (Figure 1.34): <?xml version='1.0' encoding='utf-8'?> <tomcat-users> <role rolename="tomcat"/> <role rolename="manager"/> <user username="admin" password="admin" roles="manager,tomcat"/> </tomcat-users> (Fig. 1.34) Change the username and password to something secure of your choosing. Increasing the GlobalForms Memory GlobalForms is installed with a pre-configured setting for memory usage. These defaults are adequate at the beginning but may need to be increased as the number of Forms, Flows, and submissions increases. Besides experiencing performance issues, there are two errors that you will find in the Tomcat logfiles located in X:\GlobalForms6\tomcat\logs. OutOfMemoryError: Java heap space SEVERE: Servlet.service() for servlet jsp threw exception java.lang.outofmemoryerror: Java heap space (Fig. 1.35) To solve this edit setenv.[bat,sh] to increase the minimum and maximum heap size via the parameters: -Xmx and - Xms. For example: -Xmx512m to -Xmx1g. Ensure that the machine where GlobalForms is installed has enough memory available. If you change -Xmx to 1g your machine will need more than 1g RAM. 21 P a g e

24 OutOfMemoryError: PermGen space MemoryError: PermGen space java.lang.outofmemoryerror: PermGen space (Fig. 1.35) Java has a fixed space allocated for classes and other statics that is usually enough in normal cases, but could be quickly filled up if there is on the fly code generation or significant business logic in your forms. To solve this edit setenv.[bat,sh] increase the maximum perm size via the paramenter: -XX:MaxPermSize For example: -XX:MaxPermSize=128M 22 P a g e

25 Notes 23 P a g e