Docstoc

Installation and Configuration Guide

Document Sample
Installation and Configuration Guide Powered By Docstoc
					                                                                                                                                                        ©2009




1 Preface
This guide will describe the technical details required to install and configure Spira components. This is not a step-
by-step guide.




2 Contents
1     Preface .......................................................................................................................................................... 1
2     Contents ........................................................................................................................................................ 1
3     Components .................................................................................................................................................. 2
      3.1.1       Spira Express Corporate Message Server (CORP) ....................................................................................2
      3.1.2       Microsoft SQL Server 2005 (SQL) .............................................................................................................2
      3.1.3       Command Client (COM) ...........................................................................................................................2
      3.1.4       Mobile Client (MOB) ................................................................................................................................2
      3.1.5       Spira Client Update Tool (UPD) ................................................................................................................3
4     Spira Express Corporate Message Server Installation Types .......................................................................... 3
    4.1       Standard Installation ............................................................................................................................. 4
      4.1.1       Configuration Variables: ..........................................................................................................................4
      4.1.2       Install .......................................................................................................................................................5
      4.1.3       Configure Spira Express Message Server .................................................................................................7
    4.2       Single Server Installation ....................................................................................................................... 9
    4.3       Command Only ................................................................................................................................... 10
      4.3.1       Configuration Variables .........................................................................................................................10
      4.3.2       Restore Databases .................................................................................................................................10
      4.3.3       Install Spira Command ...........................................................................................................................10
      4.3.4       Configuration Tool .................................................................................................................................11
      4.3.5       Create a New Application Node .............................................................................................................11
5     Install Spira Command................................................................................................................................. 14
6     Install Spira Mobile...................................................................................................................................... 14
7     Install Spira Client Update Tool ................................................................................................................... 15
8     SQL Server Configurations ........................................................................................................................... 17
      8.1.1       Server Settings .......................................................................................................................................17
      8.1.2       Spira Database User Configuration ........................................................................................................18

Revised: December 3, 2011                                                                                                                                         Page 1 of 19
                                                    Spira® is a registered trademark of Spira Data Corp
                                                                                                    ©2009




3 Components
3.1.1     Spira Express Corporate Message Server (CORP)
          ISO                                  Spira_Corporate_48xx.iso
          Installer                            Setup Spira Corporate.exe
This is the application server that relays and processes incoming messages from Mobile Clients to the databases
for use by in office Command Clients. Spira Corporate Installer includes 2 components:
     1.   Spira Express Corporate Message Application (Windows services):
               a. Spira Message Processor
               b. Spira Message Queuing
     2.   Corporate Databases
               a. Spira (Application Database)
               b. SpiraMessaging (Messaging Database)
The Applications will be installed on the machine the installer is executed from. Databases may be installed locally
(CORP is installed on a SQL Server) or remotely (dedicated SQL server).

3.1.2     Microsoft SQL Server 2005 (SQL)
There is no installer for the databases. Empty Databases are included with the “Spira Corporate” Installer suite. A
SQL Authentication user with admin rights to create databases will be required during Spira Corporate installation
to create:
         Spira : Application database containing master data
         SpiraMessaging : Messaging Database containing incoming and outgoing messages for mobile units.
Customers running a “Command Only” configuration may be provision database Backup files to restore on a SQL
server.
The customer is responsible for installation and configuration of SQL server which may include additional
configuration of MS SQL Server Reporting Services and/or IIS for Spira SSRS Reports.

3.1.3     Command Client (COM)
          ISO                                  Spira_Command_48xx.iso
          Installer                            Setup Spira Command.exe
This in office client application accesses the SQL Server databases, Spira and SpiraMessaging.

3.1.4     Mobile Client (MOB)
          ISO                                  Spira_Mobile_48xx.iso
          Installer                            Setup Spira Mobile.exe


Revised: December 3, 2011                                                                                   Page 2 of 19
                                    Spira® is a registered trademark of Spira Data Corp
                                                                                                                          ©2009




Mobile field client application is for remote out of office use. The Mobile application stores data locally on its SQL
Express 2005 databases: SpiraLocal + SpiraMessaging.
Spira.Express.Client (tray icon) synchronizes with the Spira Express Corporate Message Processing server.

3.1.5     Spira Client Update Tool (UPD)
          ISO                                   Spira_Update_48xx.iso
          Installer                             Spira.Update.Client.Install
Spira client update tool is for updating Mobile field client applications.



4 Spira Express Corporate Message Server Installation Types
There are 3 typical installation configurations:
COMPONENTS            CORP     SQL        COM          MOB         NOTES
Standard              y        y          y            y           Standard Installation
Installation                                                        Configuration: Standard Installation
                                                                    CORP + SQL + COM + MOB

                                                                             HEAD OFFICE

                                                                                SpiraCorporate




                                                                                    CORP                                     Port 9669




                                                                                                                                             MOB




                                                                                    SQL                               `

                                                                                                                COM




Single Server                  y          y            Y           Spira Corporate Services are installed on the
                                                                   Database Server
                                                                    Configuration: Single Server Installation
                                                                    CORP on SQL + COM + MOB

                                                                             HEAD OFFICE

                                                                                SpiraCorporate




                                                                                                                             Port 9669
                                                                                     CORP
                                                                                     + SQL

                                                                                                                                             MOB




                                                                                                                      `

                                                                                                                COM




Command Only                   y          y                        Database + Command Client application only




Revised: December 3, 2011                                                                                                                Page 3 of 19
                                     Spira® is a registered trademark of Spira Data Corp
                                                                                                                              ©2009




                                                                       Configuration: Command Only
                                                                       SQL + COM




                                                                                     SQL                                  `

                                                                                                                   COM




4.1 Standard Installation
 Configuration: Standard Installation
 Application + Database Server

           HEAD OFFICE

               SpiraCorporate




                  CORP                                                                                        Port 9669




                                                                                                                                      MOB




                  SQL                                                                   `

                                                                         COM




4.1.1     Configuration Variables:
These variables will be used for your installation. Reference values have been used in this guide for you to follow.
Substitute VALUE with your actual Test or Production values as these will differ than these reference values. Ie.
Your SQL server IP may not be 10.0.0.40.

4.1.1.1     CORP
          VARIBABLE                     VALUE                                                        DESCRIPTION
          Machine Name                  CORP.spiradata.local
          IP                            10.0.0.50



Revised: December 3, 2011                                                                                                             Page 4 of 19
                                        Spira® is a registered trademark of Spira Data Corp
                                                                                                           ©2009




          External HOSTNAME/IP      spiradata.net                                   Externally accessible Hostname/ip of
                                    or 66.216.119.46                                that resolves to your firewall which
                                                                                    directs traffic to CORP.spiradata.local
                                                                                    aka 10.0.0.50. For mobile units to
                                                                                    communicate to CORP.
          PORT                      9669                                            ie. 9669
          Customer #                SPIRA001                                        Customer Licensing Number provided
                                                                                    by Spira



4.1.1.2     SQL
          VARIBABLE                 VALUE                                           DESCRIPTION
          Machine Name              SQL.spiradata.local
          SQL Instance              SQL.spiradata.local\SQL2005
          IP                        10.0.0.40
          SQL Administrator User    sa                                              User that is able to create databases
                                                                                    and tables.
          SQL Admin password        Password99
          SpiraUser Name            SpiraUser                                       Has read/write access to Spira +
                                                                                    SpiraMessaging Databses only
          SpiraUser password        password



4.1.2     Install
On your CORP server,
     1.   Insert Spira_Corporate_48xx.iso CD into your server
          or execute “Setup Spira Corporate.exe”
     2.   Follow on screen instructions…
               a. Welcome
                        i. Click Next
               b. License Agreement
                        i. Select I accept the terms in the license agreement. Click Next
               c. Customer Information
                        i. Fill out your Name and Organization. Click Next
               d. Setup Type
                        i. Pick Complete. Click Next.




Revised: December 3, 2011                                                                                          Page 5 of 19
                                    Spira® is a registered trademark of Spira Data Corp
                                                                                                          ©2009




               e.   Database Server




                    Fill out the required information with
                    Field                                                            Input
                    Database Server that you are installing to:                      SQL.spiradata.local\SQL2005
                    Login ID                                                         sa
                    Password                                                         Password99
                    Do not change the values of Database catalogs. These must remain as the defaults:
                           i.    Spira
                          ii.    SpiraMessaging
                    Click Next
               f.   Spira Express
                    Creates the initial Application ID with configurations for this CORP server
                    Fill out the required fields with:
                    Field                                                         Input
                    Host                                                             spiradata.net
                                                                                     or 66.216.119.46
                    Port                                                             9669
                    Local Server\Instance Name                                       SQL.spiradata.local\SQL2005
                    External Server\Instance Name                                    SQL.spiradata.local\SQL2005
                    Credentials to connect to Spira                                  SpiraUser
                    Credentials to connect to SpiraMessaging                         password
                    Click Next
               g.   Ready to Install the Program
                           i. Click Install
               h.   InstallShield Wizard Completed
                           i. Click Finish
                          ii. A sample Spira.tok will be created on the desktop



Revised: December 3, 2011                                                                                         Page 6 of 19
                                      Spira® is a registered trademark of Spira Data Corp
                                                                                                 ©2009




4.1.3     Configure Spira Express Message Server

4.1.3.1     Using a different Database
If you have a specific Database backup you wish to use, ie. myCompany_yyyymmdd.BAK you have 2 options
when restoring the database:
     1. Restore over Spira (overwrite)
              a. easiest and simplest method
     2. Restore as a different database name, ie. MyCompanyWS
              a. specific changes will be required in the configuration tool to reflect the naming difference

4.1.3.2     Configure SpiraUser
Follow the steps outlined in 0




Revised: December 3, 2011                                                                                Page 7 of 19
                                   Spira® is a registered trademark of Spira Data Corp
                                                                                                   ©2009




Spira Database User Configuration.

4.1.3.3     Configuration Tool
     1.   Click Start, point to Programs, point to Spira Data Corp, and then click Spira Configuration Tool.
     2.   In the App Version field, enter the version of this installer, ie. 4.8.12.6
               a. The App Version MUST match the Application Database version (in t_ProductVersion) to facilitate
                    proper updates for Command + Mobile applications.
     3.   Type in the Customer # field provided by Spira: SPIRA001.
     4.   Ensure your Databases are correct:
               a. Click on tab Internal Application. Verify the values are correctly pointing to Spira. Click Test.
                    A popup should show that the connection was successful.
               b. Click on tab External Application. Click Same as Internal.
                          i. IF you are using a different application database than the default installed by Spira
                             Corporate 48xx.iso make sure that Spira the database default Spira Application are
                             changed to MyCompanyWS. Click Test to ensure the database is accessible
               c. Click on tab Internal Messaging. Verify the values are correctly pointing to SpiraMessaging.
                    Click Test. A popup should show that the connection was successful.
               d. Click on Tab External Messaging. Click Same as Internal.
               e. Check Default Configuration
     5.   Click Save
     6.   Verfify that:
               a. Application ID only has one (1) item in the drop down list
               b. Database Configuration list only has one (1) item
     7.   Click Create Token. A popup dialog box shows the one (1) available configuration(s), Spira. Click OK.
          Spira Token File save dialog shows. Name the file. Click Save.
               a. Spira recommends a naming convention of:
                    <version>_<hostname>_<databasename>_<port#>.tok
               b. Ensure that this token, with App Version = 4.8.12.6 is only loaded onto Command or Mobile units
                    of the respective version.
     8.   Your token is now ready for use on new Command and Mobile installations




Revised: December 3, 2011                                                                                  Page 8 of 19
                                     Spira® is a registered trademark of Spira Data Corp
                                                                                                  ©2009




4.1.3.4     Getting your Server Running
Firewall Configuration
     1.   Ensure that your HOST IP and Port correctly forward to your CORP server
On your Corporate Server:
     1.   Click on Start > Run. Type: services.msc
     2.   In the list of windows services, find:
               a. Spira Message Processor
               b. Spira Message Queuing
     3.   Right-Click each service, click Start.
Notes:
         Spira Services are setup to startup automatically on machine startup
         A manual service restart is required on:
               o Configuration Tool changes (ie. New IP, port, database)
               o Database restore
               o Switching from Ticket Type: Single pool to Unique by Type
On your Spira Command Client:
     1.   Start > Run
     2.   Startup Spira Command. Configure your system as outlined in the Spira Help Manual. Here is a high level
          of the critical screens:
               a. Setup > Company
               b. Setup > Job Types
               c. Data > Control Sequence
     3.   Click on Data > Offline Store. Click Generate. Click Publish. An offline store is now available on your
          Spira Express Corporate Message server for Mobile units to pick up.
               a. You may verify successfully Baseline.ols publish by going on your CORP server and checking
                    folder to see if the file exists with the current date/time:
                    C:\Documents and Settings\All Users\Application Data\Spira Data
                    Corp\Offlinestore\{Application ID GUID}\


Your CORP system is now ready for a mobile to connect




Revised: December 3, 2011                                                                                 Page 9 of 19
                                    Spira® is a registered trademark of Spira Data Corp
                                                                                                        ©2009




4.2 Single Server Installation
 Configuration: Single Server Installation
 CORP on SQL + COM + MOB

           HEAD OFFICE

              SpiraCorporate




                                                                                            Port 9669
                   CORP
                   + SQL

                                                                                                                MOB




                                                                               `

                                                                       COM




In this configuration, install the Spira Express Corporate Message Server on the SQL Server.




Revised: December 3, 2011                                                                                       Page 10 of 19
                                      Spira® is a registered trademark of Spira Data Corp
                                                                                                   ©2009




4.3 Command Only

 Configuration: Command Only
 SQL + Command




                       SQL                                                                `

                                                                                   Command




4.3.1     Configuration Variables
          Spira.BAK                            Application Database
          SpiraMessaging.BAK                   Messaging Database



4.3.2     Restore Databases
     1.   Obtain your Databases from Spira:
               a. Spira.bak
               b. SpiraMessaging.bak
     2.   Copy the backups to your SQL server
     3.   Startup SQL Management Studio (or tool of choice)
     4.   Log into the SQL Server using a “sa” or sysadmin account
     5.   Restore Spira.bak as “Spira”
     6.   Restore SpiraMessaging.bak as “SpiraMessaging”
Set Up SQL Authentication user (OPTIONAL)
To create a SQL authentication user for Spira + SpiraMessaging databases follow the steps outlined in section 0




Revised: December 3, 2011                                                                                  Page 11 of 19
                                    Spira® is a registered trademark of Spira Data Corp
                                                                                                    ©2009




Spira Database User Configuration.


4.3.3     Install Spira Command
     1.   Follow Command installation instructions at 5 Install Spira Command



4.3.4     Configuration Tool
In a Command Only installation, there is no Central Corporate server. It is recommended that configuration is
always created and maintained at one (the same) computer. Token (configuration files) may be generated for
loading and use on other standalone Command Clients.
A Spira ‘Application Node’ is a GUID that contains settings in the registry under
HKEY_LOCAL_MACHINE\SOFTWARE\Spira Data Corp\
An ‘Application Node’ typically contains 1 Database Connection.
Configuration Tool is used to:
     1.   Create a New Application Node and Token file (first time, command only)
     2.   Maintain/Update Application Nodes and Database Connections

4.3.5     Create a New Application Node
     1.   Execute C:\Program Files\Spira Data Corp\Spira Command\Spira.Configuration.Tool.exe
     2.   Click ‘New’
               a. ‘Browse For Folder’ popup
     3.   Pick ‘Desktop’
               a. A new Node is created
     4.   Application ID is populated with a new GUID
     5.   Friendly ID Name shows ‘00000000-0000-0000-0000-000000000000’
               a. On a Standard Installation with multiple nodes, this helps identify each of your nodes with a
                   friendly name, ie. SpiraProduction or SpiraTest
               b. You may change this to “SpiraWS”
     6.   App Version shows 4.8.16.347
               a. The App Version should always match the Database version in t_ProductVersion.
     7.   Corp Server Host/IP + Port are not required in a Command Only installation
               a. In a standard installation, this would be the hostname/IP of the application server that Mobile
                   field clients will connect to
     8.   Licensing URL is used for application licensing. Obtain this from your Spira representative.
     9.   [New Configuration] denotes that no database configurations currently exist
               a. Click ‘Add’
                          i. In the text box below the Database Configuration Dropdown list, type a name to identify
                             the database pair. Spira recommends a convention to easily identify the location and
                             database:
                             *SERVER or instance+ DatabaseName, ie. ‘SPSQL01 Spira’ or ‘SQL2005 Spira’
               b. Internal Application:
                          i. Server: type in the your: ‘SQLServer\Instance’
                         ii. User Name: type in a SQL authenticated user, “SpiraUser” (or sa)

Revised: December 3, 2011                                                                                   Page 12 of 19
                                     Spira® is a registered trademark of Spira Data Corp
                                                                                                  ©2009




                     iii. Password: “password”
                     iv. Database: “Spira”
                      v. Click ‘Test’ to ensure that the values were typed correctly and that a connection can be
                          made to the database
                          NOTE: ‘Test’ only tests the connection. It does not ‘test’ user permissions.
             c. Click on tab, ‘External Application’
             d. Click on ‘Make Same as Internal’
                       i. Values are copied across
             e. Click on tab, ‘Internal Messaging’
                       i. Server: type in the your: ‘SQLServer\Instance’
                      ii. User Name: type in a SQL authenticated user, “SpiraUser” (or sa)
                     iii. Password: “password”
                     iv. Database: “SpiraMessaging”
             f. Click on tab, ‘External Messaging’
             g. Click on ‘Make Same as Internal’
     10. You should now have something like:




     11. Click ‘Save’
     12. Click ‘Create Token’
              a. A popup shows the ‘Configurations’ in this node to include.




Revised: December 3, 2011                                                                                 Page 13 of 19
                                   Spira® is a registered trademark of Spira Data Corp
                                                                                                   ©2009




               b.   Ensure ‘SQL2005 Spira’ is checked:




               c.   Click ‘OK’
                           i. A popup dialog appears asking for the name to save the Token file as
               d.   Pick your desktop or network share drive. Recommended naming convention for the tokens is:
                    <version>_<server\instance>_<database>




A command will ask for a token if no current configuration exists (ie. New installation)
This token, 48xx_spiradata.net_Spira.tok can now be loaded on other command installations.


Notes:
     1.   You should always maintain your master configuration from the same location (computer)



Revised: December 3, 2011                                                                                  Page 14 of 19
                                     Spira® is a registered trademark of Spira Data Corp
                                                                                                       ©2009




5 Install Spira Command
     1.   Obtain ISO or installer
     2.   Follow on screen instructions
     3.   Spira is now installed
     4.   You may now:
               a. Create a token using Configuration tool or
               b. load a Token if one is already generated then
               c. Login to Spira Command with the credentials:
                          i. User: setupadmin
                         ii. Password: password
Load Token:
     1.   Double click on the Spira Command desktop shortcut
     2.   A popup will ask for a Token file (outlined in the following section)
Using a ‘Plugin’
     2.   Obtain plugin from Spira Representative, ie. ‘Spira.TimeCard.zip’ or ‘Plugin.zip’
     3.   Copy .ZIP to folder:
          C:\Documents and Settings\All Users\Spira Data Corp\Plugins




     4.   Restart Spira Command


6 Install Spira Mobile
     1.   Obtain ISO or Installer
     2.   Follow on screen instructions
               a. When prompted with Database Server screen, leave all fields as the default values:
                         i. Database Server: (LOCAL)\Spira
                        ii. Connect Using: Server Authentication
                                  1. Login ID: sa
                                  2. Password: Password99
                       iii. Name of database catalog: SpiraLocal
Starting Up for the first time
     1.   Click Start. Point to All Programs \ Spira Data Corp. Click Spira Express. A windows tray application will
          run.
     2.   When Prompted
When Spira.Express.Client
Load the 48xx_spiradata.net_Spira.tok



Revised: December 3, 2011                                                                                      Page 15 of 19
                                     Spira® is a registered trademark of Spira Data Corp
                                                                                                       ©2009




7 Install Spira Client Update Tool
     1.   Obtain ISO or Installer
     2.   Follow on screen instructions
               a. When prompted with Client FTP Download Site screen, enter in the following values:
                         i. FTP Site: FTP site holding mobile update files
                        ii. FTP User: FTP user name
                       iii. FTP Password: FTP password
               b. When prompted with Application FTP Download Site screen, enter in the following values:
                         i. FTP Site: FTP site holding client update tool files
                        ii. FTP User: FTP user name
                       iii. FTP Password: FTP password
               c. When prompted by Version Information screen, enter in the Command\Mobile version
                         i. To find the version go to C:\Program Files\Spira Data Corp\Spira Mobile
                        ii. Find Spira.Base.dll, right click and go to Properties
                       iii. Choose the Details tab and find the File version




               d.   When prompted with Select Installation Folder, leave all fields as the default values:
                        i. C:\Program Files\Spira Data Corp\ Spira Update Client\
                       ii. Everyone
Starting for the first time
     1.   Double Click on Spira Client Update Tool desktop icon
     2.   Double Click the icon in the taskbar to open Spira Client Update Tool
     3.   Spira Client Update Tool will automatically search for an update.




Revised: December 3, 2011                                                                                      Page 16 of 19
                                      Spira® is a registered trademark of Spira Data Corp
                                                                                                ©2009




     4.   Click Update once download has been completed.




     5.   If a plugin exists this needs to be updated
                a. Open Spira Command.
                b. Under Data go to Offline Store
                c. Change the drop down list from Desktop\Spira Dispatch to Plugins under Documents to be
                    Broadcast




               d.   Add the Plugin file.
               e.   Check the plugin file and click Publish.




Revised: December 3, 2011                                                                               Page 17 of 19
                                      Spira® is a registered trademark of Spira Data Corp
                                                                                                      ©2009




     6.   Spira Mobile is now up to date.



8 SQL Server Configurations
8.1.1     Server Settings
Your SQL server will need to be configured to allow: Local and remote connections using both TCP/IP and named
pipes:
     1.   Click Start, point to Programs, point to
          Microsoft SQL Server 2005, point to
          Configuration Tools, and then click SQL
          Server Surface Area Configuration.
     2.   On the SQL Server 2005 Surface Area
          Configuration page, click Surface Area
          Configuration for Services and Connections.
     3.   On the Surface Area Configuration for
          Services and Connections page, expand
          Database Engine, click Remote Connections,
          click Local and remote connections, click the
          appropriate protocol to enable for your
          environment, and then click Apply.
               a. Spira Suggests, for best performance,
                    using Using both TCP/IP and named pipes.
               b. NOTE: Click OK when you receive the following message:
                    Changes to Connection Settings will not take effect until you restart the Database Engine service.
     4.   Restart your SQL server
Additional Resources:
         How to configure SQL Server 2005 to allow remote connections
          http://support.microsoft.com/kb/914277




Revised: December 3, 2011                                                                                     Page 18 of 19
                                     Spira® is a registered trademark of Spira Data Corp
                                                                                                 ©2009




8.1.2     Spira Database User Configuration
For security reasons, a Spira Specific SQL authenticated user should be used for Applications (CORP + COM) to
connect to databases: Spira + SpiraMessaging. This user can also be used for Crystal Reports read connection
string configured at [Setup] > Company. Using sa/Password99 is not secure:



     1.   Click Microsoft SQL Server Management Studio. Connect to the
          database server with administrator account. Expand Security. Right-Click
          Logins, New Login.
     2.   Create a SQL Server authentication user,
          ie. “SpiraUser” with password, “password”




     3.   Click on User Mapping page.




          Map Spira by clicking the checkbox beside the database Spira. Give Database role membership for Spira:
          [ ]db_datareader and [ ] db_datawriter. Ensure that [ ] public is still checked
          Repeat for SpiraMessaging. Click OK to create the user.
     4.   This user will now have read and write access to the Spira and SpiraMessaging databases.




Revised: December 3, 2011                                                                                Page 19 of 19
                                   Spira® is a registered trademark of Spira Data Corp

				
DOCUMENT INFO
Shared By:
Categories:
Tags:
Stats:
views:2
posted:12/3/2011
language:French
pages:19
liamei12345 liamei12345 http://
About