documentation.pierbridge.comdocumentation.pierbridge.com/word/workstation...  · web viewdate....

33
SendSuite® Live Workstation Installation Guide Document Version: 1.4 Last Revised Date: 22 November, 2012 Next Review By Date: 22 May, 2013 Date Versi on Changed by Comments 22 November, 2012 1.4 C. Boyle Added section 3.2 - UrlScan Configuration. Added note to section 5. 10 August, 2012 1.3 C. Boyle Updated section 4.1 regarding user creation. 17 February, 2012 1.2 C. Boyle Updated section 2 to reflect IE9 support. 3 November, 2011 1.1 C. Simpson New format with revised screenshots. Added section 6 – Downloading Templates 30 August, 2011 1.0 C. Boyle First issue. Copyright © 2012 Pierbridge Inc. All Rights Reserved. The technical documentation is being delivered to you as-is and Pierbridge Inc. makes no warranty as to its accuracy or use. Any use of the technical documentation or the information contained therein is at the risk of the user. Documentation may include technical or other inaccuracies or typographical errors. Pierbridge Inc. reserves the right to make changes without prior notice.

Upload: others

Post on 02-Oct-2020

1 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: documentation.pierbridge.comdocumentation.pierbridge.com/Word/Workstation...  · Web viewDate. Version. Changed by. Comments. 22 November, 2012. 1.4. C. Boyle. Added section 3.2

SendSuite® LiveWorkstation Installation GuideDocument Version: 1.4

Last Revised Date: 22 November, 2012

Next Review By Date: 22 May, 2013

Date Version Changed by Comments22 November, 2012 1.4 C. Boyle Added section 3.2 - UrlScan Configuration. Added note

to section 5.

10 August, 2012 1.3 C. Boyle Updated section 4.1 regarding user creation.

17 February, 2012 1.2 C. Boyle Updated section 2 to reflect IE9 support.

3 November, 2011 1.1 C. Simpson New format with revised screenshots.Added section 6 – Downloading Templates

30 August, 2011 1.0 C. Boyle First issue.

Copyright © 2012 Pierbridge Inc. All Rights Reserved.

The technical documentation is being delivered to you as-is and Pierbridge Inc. makes no warranty as to its accuracy or use. Any use of the technical documentation or the information contained therein is at the risk of the user. Documentation may include technical or other inaccuracies or typographical errors. Pierbridge Inc. reserves the right to make changes without prior notice.

Any technical documentation that is made available by Pierbridge Inc. is the copyrighted work of Pierbridge Inc. and is owned by Pierbridge Inc. No part of this publication may be copied without the express written permission of Pierbridge Inc.

Page 2: documentation.pierbridge.comdocumentation.pierbridge.com/Word/Workstation...  · Web viewDate. Version. Changed by. Comments. 22 November, 2012. 1.4. C. Boyle. Added section 3.2

Contents1 Introduction.......................................................................................................3

2 Installation Prerequisites....................................................................................4

3 Preparing the Environment.................................................................................5

3.1 Configuring Workstation Features.................................................................................6

3.2 UrlScan Configuration...................................................................................................8

3.3 SendSuite Live Setup.....................................................................................................9

3.3.1 Installation....................................................................................................................9

4 Installing SendSuite Live...................................................................................12

4.1 Installation..................................................................................................................12

5 Installing Updates.............................................................................................22

6 Downloading Templates...................................................................................24

7 Uninstalling SendSuite Live...............................................................................26

Page 3: documentation.pierbridge.comdocumentation.pierbridge.com/Word/Workstation...  · Web viewDate. Version. Changed by. Comments. 22 November, 2012. 1.4. C. Boyle. Added section 3.2

1 Introduction

This document details how to install SendSuite Live on a Windows 7 workstation. The SendSuite Live workstation application is intended for use with low volume mailing applications and is not a solution for high volume mailroom or production shipping operations.

As such, the workstation version supports three concurrent users. For example, one user can be active on the workstation and two remote users can access the application from elsewhere on the network.

SQL SERVER EXPRESS

Microsoft SQL Server Express is automatically installed on the workstation as part of the installation process – you do not have to install this before you commence the workstation install. Please be aware that the SQL Server Express install may take some time.

USERS

During the installation, you will be prompted for a username and password. Once you enter these details an application context user is created automatically. For workstation applications, the user that the application will run under does not have to exist prior to installation (unlike server installations).

Page 4: documentation.pierbridge.comdocumentation.pierbridge.com/Word/Workstation...  · Web viewDate. Version. Changed by. Comments. 22 November, 2012. 1.4. C. Boyle. Added section 3.2

2 Installation Prerequisites

Item Description

Workstation Hardware As a minimum, the workstation should meet the following minimum hardware specification:

2 GB of RAM 4 GB of available hard-disk space 2 GHz or faster processor

Microsoft Windows Version The following Windows 7 versions are supported:

Microsoft Windows 7 Ultimate 64-bit Microsoft Windows 7 Ultimate 32-bit Microsoft Windows 7 Professional 64-bit Microsoft Windows 7 Professional 32-bit

.NET Framework Version .NET Framework 4.0 is required and should be installed on the workstation prior to attempting to install SendSuite Live.

Microsoft Internet Information Services (IIS) Version

Internet Information Services 7.5

Microsoft Internet Explorer Version Internet Explorer 8Internet Explorer 9 (recommended)

Microsoft ASP.NET Active Server Pages .NET windows component must be enabled. The Internet Information Services feature should be configured before installation of the .NET Framework 4.0.

Microsoft Message Queue Microsoft Message Queue feature must be enabled.

HTTP access to the SendSuite Live update server (update.sendsuitelive.com)

Internet access from the workstation is necessary to download the SendSuite Live installation components.

Page 5: documentation.pierbridge.comdocumentation.pierbridge.com/Word/Workstation...  · Web viewDate. Version. Changed by. Comments. 22 November, 2012. 1.4. C. Boyle. Added section 3.2

3 Preparing the Environment

This section covers everything you need to do to prepare a Windows 7 workstation for the installation of the core SendSuite Live components.

Use the checklist below to ensure the workstation is ready for the installation of SendSuite Live.

Does the workstation meet the following hardware specification? 2 GB RAM 4 GB of available hard-disk space 2 GHz processor

Are the following features configured? Internet Information Services (IIS) ASP.net Message Queue

See section 3.1.

Is .Net 4.0 installed?

Have you downloaded and installed SendSuite Live Setup? See section 3.3.

Do you have administrative permissions on the workstation to perform the installation?

Page 6: documentation.pierbridge.comdocumentation.pierbridge.com/Word/Workstation...  · Web viewDate. Version. Changed by. Comments. 22 November, 2012. 1.4. C. Boyle. Added section 3.2

3.1 CONFIGURING WORKSTATION FEATURESWindows features can be configured on the workstation to support the functionality of Internet Information Services (IIS), Message Queue and ASP.net. Use the Windows Features option to view, configure and amend the following Windows features.

TO CONFIGURE WORKSTATION FEATURES:

1. Click the Start button, click Control Panel, click Programs, and then click Turn Windows Features On or Off.

2. Select Web Management Tools then select IIS Management Console and IIS Management Scripts and Tools.

3. Select World Wide Web Services then select ASP.net.

4. Select Security then select Basic Authentication and Windows Authentication.

Page 7: documentation.pierbridge.comdocumentation.pierbridge.com/Word/Workstation...  · Web viewDate. Version. Changed by. Comments. 22 November, 2012. 1.4. C. Boyle. Added section 3.2

5. Select Health and Diagnostics then select Logging Tools and Tracing.

6. Select Microsoft Message Queue (MSMQ) Server then select MSMQ Triggers.

7. Click OK to save the Windows Feature settings.

Page 8: documentation.pierbridge.comdocumentation.pierbridge.com/Word/Workstation...  · Web viewDate. Version. Changed by. Comments. 22 November, 2012. 1.4. C. Boyle. Added section 3.2

3.2 URLSCAN CONFIGURATION

Note: This section explains how to configure UrlScan to allow access to any URL’s that contain a dot (period) character. If UrlScan is not in use or you have not experienced issues errors being displayed when accessing administration interfaces then skip this section.

UrlScan is a legacy IIS add-in module for IIS versions 5.0, 6.0 and 7.0. It can also be installed in version 7.5 but does require the IIS Management Compatibility role service to be installed.

Once installed, this module is designed to monitor the formatting of URL’s and block access to any that are flagged as insecure. By default, it will install as a global ISAPI filter although it can also be configured on a per-site basis. To verify whether this extension is installed you need to check the ISAPI Filters settings under either the Global or Site level in IIS manager:

UrlScan installed Globally

By default, UrlScan will block access to any URL’s that contain a dot (period) character. This is incompatible with the product, since some resources are held in a folder structure that indicates a version number and these include the period character, for example:

common/frameworks/sencha%20extjs/3.3.1/resources/css/ext-all.css

Typical symptoms of UrlScan being active with its default configuration include errors being displayed when accessing some administration interfaces:

Page 9: documentation.pierbridge.comdocumentation.pierbridge.com/Word/Workstation...  · Web viewDate. Version. Changed by. Comments. 22 November, 2012. 1.4. C. Boyle. Added section 3.2

Typical Error associated with a default installation of UrlScan

In order to reconfigure UrlScan to allow access, perform the following steps:

1. Navigate to the installation folder for UrlScan. (The default is C:\Windows\System32\inetsrv\urlscan.)

2. Open the UrlScan.ini file using a suitable text editor.

3. Find the key value, AllowDotInPath and change its value from zero (0) to one (1). (AllowDotInPath=0 becomes AllowDotInPath=1.)

4. Save this file then perform a reset of IIS.

3.3 SENDSUITE LIVE SETUPSendSuite Live Setup is a Microsoft .NET Windows application that installs and updates SendSuite Live server components.

The files that comprise the SendSuite Live server components are stored on SendSuite Live update server. The SendSuite Live Setup application downloads the files from the update server and installs them on the machine it is running on.

3.3.1 INSTALLATIONThe SendSuite Live Setup application should be installed on the machine that you want to install SendSuite Live on.

1. Download the latest SendSuite Live Setup zip file.

2. In the SendSuite Live Setup Files panel, click the link of the setup files you want to install. Save the zip file to your desktop. Then, extract the .msi file and double-click to start the installation.

Page 10: documentation.pierbridge.comdocumentation.pierbridge.com/Word/Workstation...  · Web viewDate. Version. Changed by. Comments. 22 November, 2012. 1.4. C. Boyle. Added section 3.2

3. Click Next.

4. Choose the installation path and click Next. (Click Change to choose a different location from the default.)

Page 11: documentation.pierbridge.comdocumentation.pierbridge.com/Word/Workstation...  · Web viewDate. Version. Changed by. Comments. 22 November, 2012. 1.4. C. Boyle. Added section 3.2

5. Click Install. The SendSuite Live Setup application is installed.

6. When complete, click Finish.

Page 12: documentation.pierbridge.comdocumentation.pierbridge.com/Word/Workstation...  · Web viewDate. Version. Changed by. Comments. 22 November, 2012. 1.4. C. Boyle. Added section 3.2

4 Installing SendSuite Live

This section outlines the steps to follow to install SendSuite Live on a single workstation.

4.1 INSTALLATION1. Launch the SendSuite Live Installation & Updates utility by either double-clicking the shortcut on

your desktop or via the Start menu.

2. To obtain a trial license, click Settings and select the License tab.

3. Click Request.

Page 13: documentation.pierbridge.comdocumentation.pierbridge.com/Word/Workstation...  · Web viewDate. Version. Changed by. Comments. 22 November, 2012. 1.4. C. Boyle. Added section 3.2

4. Enter the following details:

Customer Name Installer Name Installer Phone Installer Email

5. To view the host details that are sent to the server with the request, click What other details will be sent when requesting a license?

6. Click OK. The trial license is installed.

You can manage license details at any time using the Settings dialog box. Click the License tab to view the current license settings, repair a license, request a new license or re-apply the license terms to the host server.

The license key file by default on 32-bit systems is installed under “c:\Program Files\SendSuite Live\Update". For 64-bit systems, the path is “c:\Program Files (x86)\SendSuite Live\Update" however this can change depending on where you have installed SendSuite Live Setup.

The license file is an XML file detailing license terms along with a digital signature; it must remain in its current format and not be modified. If changes are made to a license file, this will result in a damaged product license. You can fix a damaged license by clicking Repair on the Settings tab.

7. Click OK to return to the welcome page. Click Manage.

Page 14: documentation.pierbridge.comdocumentation.pierbridge.com/Word/Workstation...  · Web viewDate. Version. Changed by. Comments. 22 November, 2012. 1.4. C. Boyle. Added section 3.2

For a first install, the Update and Uninstall buttons are unavailable and the Install button is automatically selected.

8. Select the application you want to install. On the Release list, select the release version. You can automatically install all available updates or you can choose to manually select updates to install. If you select the Manually select updates to install option the following dialog box is displayed.

9. Select the versions that you want to install and click Next. This screen checks your machine for the components that are essential to run SendSuite Live.

Page 15: documentation.pierbridge.comdocumentation.pierbridge.com/Word/Workstation...  · Web viewDate. Version. Changed by. Comments. 22 November, 2012. 1.4. C. Boyle. Added section 3.2

10. If the component is detected, a green tick is displayed. Once all components have been checked, click Next.

Note: If any component is not detected, or if your operating system is not currently supported by SendSuite Live, a red cross is shown; check the Status column to determine why.

11. Click Next to specify where the application will be installed on the workstation.

12. Click Next to accept the default installation directory. (You can also click to browse and select a different location.) The Database Settings dialog box is displayed.

Page 16: documentation.pierbridge.comdocumentation.pierbridge.com/Word/Workstation...  · Web viewDate. Version. Changed by. Comments. 22 November, 2012. 1.4. C. Boyle. Added section 3.2

13. If required, amend the Database Name and then click Next.

14. Specify the User Name and Password of the user that the application will run under. (Once you enter these details an application context user is created automatically.)

15. Click Test Supplied User Credentials to check the credentials and create the user.

If successful, and the user does not already exist, click OK and then click Next to continue. If the user already exists, or if the password is not accepted, an error is displayed. Click OK, re-

enter the user credentials and click Test Supplied User Credentials again.

Page 17: documentation.pierbridge.comdocumentation.pierbridge.com/Word/Workstation...  · Web viewDate. Version. Changed by. Comments. 22 November, 2012. 1.4. C. Boyle. Added section 3.2

Confirmation of successful user creation Error to indicate the password for that user is invalid according to workstation policy. User not created.

16. In the ConnectShip Server Name box, enter the name of the machine that ConnectShip is installed on and then click Test Connectship Connection. If successful, click OK and then click Next to continue.

(If ConnectShip is not required, clear the Enable Support for ConnectShip Carriers check box.)

Page 18: documentation.pierbridge.comdocumentation.pierbridge.com/Word/Workstation...  · Web viewDate. Version. Changed by. Comments. 22 November, 2012. 1.4. C. Boyle. Added section 3.2

17. In the FedEx Ship Manager Server Location box, enter the name of the machine that FSMS is installed on and do the same for the FSMS Label Server. Specify the location of the FSMS Label Folder then click Test FedEx Ship Manager Server Connection. If successful, click OK and then click Next to continue.

(If FSMS is not required, clear the Enable Support for FedEx Ship Manager Carrier check box.)

The Authentication Mode page enables you to select the required authentication mode and to create an initial user that has access to all administrative areas; it will default to Forms Authentication. This screen will only appear once when installing SendSuite Live for the first time or when updating the system to 6.6.15 and upwards.

18. If Forms Authentication is required select the Forms Authentication option, enter a username and password and confirm the password for the first administrator. If Windows authentication is required, select Windows Authentication then enter an Active Directory user group in the Managers Group box. Click Next.

Page 19: documentation.pierbridge.comdocumentation.pierbridge.com/Word/Workstation...  · Web viewDate. Version. Changed by. Comments. 22 November, 2012. 1.4. C. Boyle. Added section 3.2

Note: If Forms Authentication is selected only the user entered will be able to access the administrative interfaces; if Windows Authentication is selected only users that are members of the Local Server or Domain Group entered will be able to access the administrative interfaces. Click here for more information on Authentication Modes.

The Environment Configuration dialog box is displayed. Here, you can view the status of the tasks that are required to run SendSuite Live.

19. Once a step has completed successfully, a green tick is shown and the status is set to Done. Click Next to continue.

Note: If any step does not complete correctly, a red cross is displayed. You must review your system before attempting to re-install SendSuite Live.

Page 20: documentation.pierbridge.comdocumentation.pierbridge.com/Word/Workstation...  · Web viewDate. Version. Changed by. Comments. 22 November, 2012. 1.4. C. Boyle. Added section 3.2

20. Once SendSuite Live is downloaded click Next.

21. Click Next. SendSuite Live will now install.

The workstation installation includes SQL Server Express. Please be patient as this stage of the installation may take some time.

22. When prompted click Next.

Page 21: documentation.pierbridge.comdocumentation.pierbridge.com/Word/Workstation...  · Web viewDate. Version. Changed by. Comments. 22 November, 2012. 1.4. C. Boyle. Added section 3.2

23. When the installation has completed, click Next.

24. When the installation is complete, click Finish.

Page 22: documentation.pierbridge.comdocumentation.pierbridge.com/Word/Workstation...  · Web viewDate. Version. Changed by. Comments. 22 November, 2012. 1.4. C. Boyle. Added section 3.2

5 Installing Updates

Periodically, patch releases are made available in order to introduce fixes and amended features to the SendSuite Live system. These updates are published on handover.sendsuitelive.com in the Release Notes section. We also recommend that you review any Possible Breaking Changes.

Updates should only be applied: When the system is being installed for the first time When the system is live and the installation engineer is in consultation with the customer. It is

recommended that new updates are tested in a test environment mode in this instance.

To view available updates, click Update on the main welcome page. Here, you can view the patches that are available to install and choose whether you want to install all or a selection of updates.

TO INSTALL UPDATES:

1. Double-click the SendSuite Live Installation & Updates utility on your desktop.

2. Click Manage then click Update. The updates that are available for the components installed on the machine are listed.

3. Each patch details the fixes and features that it will add to the component. Expand the list of fixes and features and select the patches you want to install. (To select all patches for a component, click the component header.)

Note: Patches are cumulative. So, to install patch 6.6.23 you must first install all patches up to and including patch 6.6.22. If you select a patch then all the previous patches will also be selected.

4. Click Next to start the download.

Page 23: documentation.pierbridge.comdocumentation.pierbridge.com/Word/Workstation...  · Web viewDate. Version. Changed by. Comments. 22 November, 2012. 1.4. C. Boyle. Added section 3.2

5. When the download is complete, click Next.

6. Click Next to start the Installation.

7. When the installation is complete, click Finish.

Note: After applying updates it is recommended that your temporary internet files are cleared on any affected client and server machines.

Page 24: documentation.pierbridge.comdocumentation.pierbridge.com/Word/Workstation...  · Web viewDate. Version. Changed by. Comments. 22 November, 2012. 1.4. C. Boyle. Added section 3.2

6 Downloading Templates

SendSuite Live consists of many application templates and configurations. To get started you need to download the Ship and View project templates, which allow you to process and track shipments and view the shipment history.

TO DOWNLOAD TEMPLATES:

1. Double-click the SendSuite Live Installation & Updates utility on your desktop.

2. Click Manage and click Template. The project templates that are available to download are listed.

3. Each project template details the version numbers and corresponding features that it will download to your specified location. Expand the tree to select the version you want to install. (To select all versions of a template, click the template header checkbox.)

Note: You can view the features that each version provides by expanding the tree further.

4. In the Download Location box, enter the folder location you want to download the templates to or

click to browse for a folder location.

5. Click Next to start the download.

Page 25: documentation.pierbridge.comdocumentation.pierbridge.com/Word/Workstation...  · Web viewDate. Version. Changed by. Comments. 22 November, 2012. 1.4. C. Boyle. Added section 3.2

6. Click Next.

7. When the download is complete, click Finish.

Page 26: documentation.pierbridge.comdocumentation.pierbridge.com/Word/Workstation...  · Web viewDate. Version. Changed by. Comments. 22 November, 2012. 1.4. C. Boyle. Added section 3.2

7 Uninstalling SendSuite Live

You can uninstall SendSuite Live from the workstation at any time.

Important! Please be aware that uninstalling SendSuite Live will completely remove all files, folders, databases, virtual directories, services and registry entries. If you want to preserve any SendSuite Live data then please ensure that it is saved outside of the application folder structure.

1. Launch the SendSuite Live Installation & Updates utility by either double-clicking the shortcut on your desktop or via the Start menu.

2. Click Manage.

Page 27: documentation.pierbridge.comdocumentation.pierbridge.com/Word/Workstation...  · Web viewDate. Version. Changed by. Comments. 22 November, 2012. 1.4. C. Boyle. Added section 3.2

3. Select SendSuite Live and click Uninstall. Click Next.

4. If you are happy to remove the application select the I wish to proceed with the uninstallation check box and click Next.

5. Click Next. When complete click Finish.