Spira Corporate Web Services

snortfearΔιακομιστές

4 Δεκ 2013 (πριν από 3 χρόνια και 4 μήνες)

90 εμφανίσεις



Spira

Corporate Web Services Installation Guide
©
2012


Revised:
December 4, 2013


Page
1

of
8


Spira®

is a registered trademark of Spira® Data Corp.




Spira
Corporate Web
Service
s

Installation

& Upgrade

Guide

Version 4.9.
0.
80






Spira

Corporate Web Services Installation Guide
©
2012


Revised:
December 4, 2013


Page
2

of
8


Spira®

is a registered trademark of Spira® Data Corp.

1

Contents

1

Contents

................................
................................
................................
................................
................

2

2

Preface

................................
................................
................................
................................
..................

3

3

Components

................................
................................
................................
................................
..........

3

3.1.1

Spira Corporate Web Services
................................
................................
................................
...

3

4

Installation

................................
................................
................................
................................
............

3

4.1.1

General
Information

................................
................................
................................
.................

3

4.1.2

Configuration Variables
................................
................................
................................
.........

4

4.1.3

Installation and Upgrade Files

................................
................................
...............................

4

4.1.4

New Installation

................................
................................
................................
........................

4

4.1.5

IIS Web Services

................................
................................
................................
....................

4

4.1.6

Corporate Database Patches
................................
................................
................................
.

5

4.1.7

Upgrading an Existing Installation

................................
................................
.............................

6

4.1.8

IIS Web Services

................................
................................
................................
....................

6

4.1.9

Corporate Database Patches
................................
................................
................................
.

7

5

Troubleshooting

................................
................................
................................
................................
....

7






Spira

Corporate Web Services Installation Guide
©
2012


Revised:
December 4, 2013


Page
3

of
8


Spira®

is a registered trademark of Spira® Data Corp.

2

Preface

This guide will describe the technical details required to install and configure Spira
Corporate W
eb
S
ervices.

3

Components

3.1.1

Spira
Corporate
Web Services

The installer packages and database upgrade scripts are available on the latest Spira FT release notes
found at
http://support.spiradata.com/
.

4

Installation

4.1.1

General Information

CORP
`
COM
SQL
Port
9669
MOB
HEAD OFFICE
Configuration
:
Standard Installation
Application
+
Database Server
+
Web Server
SpiraCorporate
IIS
IPhone
Port
8080



Spira

Corporate Web Services Installation Guide
©
2012


Revised:
December 4, 2013


Page
4

of
8


Spira®

is a registered trademark of Spira® Data Corp.

4.1.2

Configuration Variables

Spira Corporate Web Services serve as a gateway between your Spira Corporate installation and your
Spira FT devices. Please refer to the Spira Corporate configuration settings as you will need them to
properly point Spira Corporate
Web Services to your Spira Corporate Services installation.

1.

SQL Server name/address

2.

Spira Corporate Database name (not Spira Messaging)

3.

A port opened up to the internet for the Spira Corporate Web Services to listen on. I.e. 8080

4.1.3

Installation and Upgrade F
iles

Important:

Please refer to the Spira Knowledge Base to obtain the
latest

installation, upgrade or patch
scripts required to install Spira Corporate Web Services (
http://support.spiradata.com/
). Search for
Spira
FT and follow the links.

4.1.4

New Installation

4.1.5

IIS Web Services

1.

Install .Net Framework 4.0 Full

2.

Enable Dynamic Content Compression on your web server:

a.

Windows 2008 Server: Open Server Manager and go to Roles and enable this role if it is
not already
enabled.

3.

Extract and run the IIS
-
Compression.bat script on the same server as IIS to enable content
compression on your IIS server.

4.

Create an a
uthenticated service account that will be used for the web application pool.

This
account needs administrative permissions and it is recom
mended that only a few users have

access
to it
.


a.

Associate the service account with
the

authenticated user.

5.

Copy
the

services into your web services folder

a.

Windows 2003 Server: C:
\
wwwroot
\

b.

Win
dows 2008 Server: C:
\
inetpub
\


6.

Find and open

Web.xml in the
SpiraServices

services folder

a.

Under <appSettings> change the value of the DlsLookUpFilePAth to
the correct file
directory:

i.

Windows 2003 Server =
C:
\
wwwroot
\
Spira
Services
\
bin
\
Locations
\
ATS_March20
05.bin

ii.

Windows 2008 Server =
C:
\
inetpub
\
Spira
Services
\
bin
\
Locations
\
ATS_March2005.bin

7.

Find and open WebConnecti
onStrings.xml in the Spira
Services services folder

a.

Change the SpiraNHDBConnection connectionString to the Corporate database

b.

Change the SpiraMess
agingDBConnection connectionString to the Messaging database.



Spira

Corporate Web Services Installation Guide
©
2012


Revised:
December 4, 2013


Page
5

of
8


Spira®

is a registered trademark of Spira® Data Corp.

8.

Open IIS, and create a new Application Pool called Spira

a.

The Application Pool needs to use .Net Framework v4.0

b.

Managed pipeline mode needs to be set to Integrated

9.

For Windows Server 2003 add the authenticated user that is associated with services account to
the Application Pool.

10.

Internet Information Services and add a new Web Site

a.

The default port is 8080

b.

The Content Directory Physical path n
eeds to point at the Sp
ira
Services root folder,
C:
\
inetpub
\
SpiraS
ervices
\
bin
\
Locations
\
ATS_March2005.bin

i.

If you are using Windows Server 2003 remember to select Execute Permissions
in the Security tab

c.

For Windows 2003 Server ensure that the Web Site is using .Net Framework 4.0

11.

A
dd the authenticated user that is associated with the newly created services account to the
Web Site.

a.

For Windows Server 2003 right click Spira Web and selecting properties and go to the
Security tab to add the user.

b.

For Windows Server 2008 right click S
pira Web and select “Edit Permissions” to view the
Security tab.

12.

View the properties of Spira Web site created and point it to the Spira Application Pool

a.

For Windows Server 2003 right click on Spira Web and select Properties

b.

For Windows Server 2008 select

Advanced Settings

13.

Windows Server 2003
:

a.

E
nsure that the Web Service extensions have been
enabled within

IIS to ensure the
services are able to start.

b.

Ensure that .NET extension is also enabled for Web Services for services to work
correctly

c.

Web Services do

not require ISAPI or CGI to be running

14.

Once Spira Web has been set up, open up internet explorer and
test Spira

Web by connecting to
the assigned URL
.

4.1.6

Corporate Database Patches

1.

Spira Corporate Web Services require a set of scripts run against your Spira Corporate database
to function.
Please ensure your Spira Corporate database is configured for Spira 4.9 R1 before
running any scripts to support Spira FT.

2.

Download the latest Spir
a 4.9 R1 Corporate Services Update Package from the Spira
Knowledgebase.

3.

Extract the
Spira4.9R1
-
SpiraFTBaselineStoredProcs
SQL script and run it on your database.

4.

Extract the Spira4.9R1
-
spira_GenerateControlNumbers
SQL script and run it on your database.



Spira

Corporate Web Services Installation Guide
©
2012


Revised:
December 4, 2013


Page
6

of
8


Spira®

is a registered trademark of Spira® Data Corp.

5.

E
xtract and run any of the version specific stored procedures following any specific instructions
on the Spira Knowledge base.

4.1.7

Upgrading
an
Existing Installation

4.1.8

IIS Web Services

1.

Enable Dynamic Content Compression on your web server:

a.

Windows 2008 Server: Op
en Server Manager and go to Roles and enable this role if it is
not already enabled.

2.

Extract and run the IIS
-
Compression.bat script on the same server as IIS to enable content
compression on your IIS server.

3.

Stop the Spira Corporate Web Services site and
make a backup of the web services folder.

4.

Extract the contents of the Spira Corporate Web Services zip package to a temporary location.

5.

Copy the
contents from step
4

into your current web service folder, ensure that you overwrite
the Spira folder or the fo
lder containing Spira services:

a.

Windows 2003 Server:
C:
\
wwwroot
\
SpiraServices

b.

Windows 2008 Server: C:
\
inetpub
\
SpiraServices

15.

Find and open Web.xml in the SpiraServices services folder

a.

Under <appSettings> change the value of the DlsLookUpFilePAth to the cor
rect file
directory:

i.

Windows 2003 Server =
C:
\
wwwroot
\
SpiraServices
\
bin
\
Locations
\
ATS_March2005.bin

ii.

Windows 2008 Server =
C:
\
inetpub
\
SpiraServices
\
bin
\
Locations
\
ATS_March2005.bin

16.

Find and open WebConnectionStrings.xml in the SpiraServices services folder

a.

Change the SpiraNHDBConnection connectionString to the Corporate database

b.

Change the SpiraMessagingDBConnection connectionString to the Messaging database.

17.

Restart the IIS service

a.

Open IIS and right click on the Spira application pool and hit Restart.

b.

Fi
nd and right click on the Web site using Spira services and hit Refresh.

To confirm
that you are using the correct S
pira services navigate to the bin directory in the
services folder:

a.

Windows 2003 Server = C:
\
wwwroot
\
SpiraServices
\
bin
\

b.

Windows 2008 Server

= C:
\
inetpub
\
SpiraServices
\
bin
\

Find and right click Spira.Services.Base.dll and go to the properties. The Details tab will indicate
what version of
S
pira services you are running.



Spira

Corporate Web Services Installation Guide
©
2012


Revised:
December 4, 2013


Page
7

of
8


Spira®

is a registered trademark of Spira® Data Corp.

4.1.9

Corporate Database Patches

1.

Spira Corporate Web Services require a set of s
cripts run against your Spira Corporate database
to function. Please ensure your Spira Corporate database is configured for Spira 4.9 R1 before
running any scripts to support Spira FT.

2.

Download the latest Spira 4.9 R1 Corporate Services Update Package from

the Spira
Knowledgebase.

3.

Extract and run any of the version specific stored procedures following any specific instructions
on the Spira Knowledge base.

5

Troubleshooting

After attempting to register a new device you receive the following error message: “Dev
ice Registration

Failed

[404].”



Open up the file directory where the services are located and make sure that all of the .svc files
and .dll files exist within the directory.

o

Ensure that you are using the correct service file versions



Restart Spira servic
es application pool and Spira services



Make sure that the port assigned to Spira services is not being used by other applications



Make sure that you can reach Spira services from outside of the server. You can test by using the
following url:
http://[serverhostname]:[port]/Mobiledataservice.svc/ping

o

If
you receive a 404 error than the port needs to be opened to allow external
connections



Make sure that the following IIS Rol
e services are installed:

o

ASP.NET

o

.Net Extensibility

o

IIS 6 Metabase Compatibility



Make sure that the Windows server is using all of the .Net 3.5 Features

o

If
this is not configured on the server and both IIS and .Net 4 has been installed it is
recommended t
hat you run the aspnet_iisreg.exe.
Careful
running this on a production
environment as it will restart all of the websites

After attempting to register a new device you receive the following error message: “Device Registration
Failed

[500]”



The authentica
ted user that is used to run Spira Services
needs

administrative

access



Make sure that the authenticated user is able to access all of the services and binaries



If you receive a 500 Internal server error without any details please run the following URL on the
server where you installed the Spira services:
http://localhost:[port]/Mobiledataservice.s
vc/ping



Spira

Corporate Web Services Installation Guide
©
2012


Revised:
December 4, 2013


Page
8

of
8


Spira®

is a registered trademark of Spira® Data Corp.

o

You will see the full details of the error. Likely “
WCF
-

Error 500.21 Handler "svc
-
Integrated" has a bad module "ManagedPipelineHandler" in its module list"


o

If the above is true, please run the following from an elevated command prompt on the
ser
ver running Spira services:

Run:
C:
\
Windows
\
Microsoft.NET
\
Framework
\
v4.0.30319
\
aspnet_regiis.exe

i

o

Restart your Spira services site and the above and your Spira services should work now.