You are on page 1of 40

INSTALLATION

GUIDE

SecureClient
Version 5.6

August, 2010
DIG0000SC560

ii

iii

Copyright Axway Software, 2010.


All rights reserved.
This documentation describes the following Axway software: SecureClient.
No part of this publication may be reproduced, transmitted, stored in a retrieval system, or translated into any human or computer language,
in any form or by any means, electronic, mechanical, magnetic, optical, chemical, manual, or otherwise, without the prior written permission
of the copyright owner, Axway Software.
This documentation, provided for informational purposes only, may be subject to significant modification. The descriptions and information
in this documentation may not necessarily accurately represent or reflect the current or planned functionalities of this product. Axway Software may change this publication, the product described herein, or both. These changes will be incorporated in new versions of this documentation. Axway Software does not warrant that this documentation is error free.
Axway Software recognizes the rights of the holders of all trademarks used in its publications.

Chapter 1 - Introduction

About this guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1


Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Related documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Axway Global Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Chapter 2 - Hardware and Platform Requirements

Hardware Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Operating System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

Chapter 3 - Installing SecureClient

Running the SecureClient Scheduler as a service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5


Installing SecureClient from the command line . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Installing SecureClient using the GUI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Installing SecureClient using silent installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Chapter 4 - Upgrading to SecureClient 5.6

15

Upgrading SecureClient from the command line . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15


Upgrading SecureClient using the GUI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Chapter 5 - Uninstalling SecureClient

25

Uninstalling SecureClient from the command line . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25


Uninstalling SecureClient using the GUI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Uninstalling SecureClient from the command line in silent mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Chapter 6 - SecureClient compatibility with SecureTransport

31

Migrating SecureTransport Client configuration data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31


Executing SecureClient from the command line using SecureTransport Client syntax . . . . . . . . 33
Migrating SecureTransport Client scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

iii

SECURE CLIENT 5.6 USERS GUIDE

vi

SecureClient

Introduction

The SecureClient 5.6 Installation Guide provides information about how to


install SecureClient software on various supported platforms. Refer to the
SecureClient 5.6 Release Notes for upgrade information. For additional software
configuration information, refer to the SecureClient 5.6 Users Guide.
This document is intended for administrators who are familiar with the various
types of file transfer protocols used by SecureClient.

About this guide


This guide provides instructions for installing and upgrading Axway SecureClient. For information using and configuring SecureClient, see the Axway
SecureClient Users Guide.

Audience
This guide is written for users who are responsible for installing, managing, and
migrating SecureClient. This document assumes that users have a good understanding of SecureClient.

Related documentation
For additional information about how to configure and administer SecureClient see the following sources:

Axway SecureClient 5.6 Users Guide


This guide presents an overview of SecureClient and describes its functions and explains how to use them.

INTRODUCTION
ABOUT THIS GUIDE

Axway SecureClient 5.6 Release Notes


The Release Notes include up-to-date information related to new features
in this release, and known limitations.

Axway Global Support


Axway Global Support offers technical support for Axway products.
Axway also offers product customization and special services through the
Axway Professional Services Organization. Contact Axway Global Support for
more information.
When contacting Axway Global Support, have the following information:

Product version and operating system version.

The text of the error or warning message.

A description of the problem and attempts made to fix the problem.

You can contact Axway Global Support using one of the following methods:
Online
https://support.axway.com
Email
support@axway.com
Phone
Go to https://support.axway.com. Click the Contact Axway Support link
to display our list of regional support contact phone numbers, and then
locate the phone number appropriate for your location.

Hardware and Platform


Requirements
This section describes hardware and platform requirements for Axway SecureClient.

Hardware Requirements
Disk Space

500 MB

RAM

256 minimum 512 recommended

Operating System Requirements


Axway SecureClient can be installed on any of the following platforms. The
following table shows the supported versions for each platform.

Operating System

Supported Version

IBM AIX

5.3, 6.1

HP-UX

11.11

RedHat Enterprise Linux

5.x

Oracle Solaris

9, 10

SUSE Linux Enterprise Server

10.3

HARDWARE AND PLATFORM REQUIREMENTS


OPERATING SYSTEM REQUIREMENTS

Operating System
Microsoft Windows

Supported Version
XP, 2003, Vista, 7

Installing SecureClient

The SecureClient installer offers three types of installation: silent, command


line, or GUI. This chapter provides procedures for all three types of installation.
Go to the section that applies to your system.

Running the SecureClient Scheduler as a service


During the installation, you have the option of installing SecureClient Scheduler
as a service. If you choose this option, be sure to set up the Scheduler with the
following considerations in mind:

When you register the SecureClient Scheduler as service, the account


under which the service will run must be the same as the account you use
for script execution and other usage. This enables the Scheduler and
SecureClient GUI to share the same configuration and have the same
access rights to the file system.

The service cannot be run as the Local System account.

If you run the scheduler as a Windows service, the service account must
have Log on as a service permissions.

Scheduler service is not started after the installation. You must manually
start the service from the Services snap-in of the Microsoft Management
Console.

Scheduler service will fail to start without any message if no license is


installed.

Startup behavior of the service (automatic or manual) can be changed


from the Services snap-in in the Microsoft Management Console.

INSTALLING SECURECLIENT
INSTALLING SECURECLIENT FROM THE COMMAND LINE

Installing SecureClient from the command line


PREREQUISITE
For this installation, you must ensure that no previous instance of SecureClient
is installed on your system. If you have any previous version of SecureClient,
uninstall it before you install version 5.6.
TASK

1.

Download the software for your operating system fromt he Axway


server at www.axway.com.

2.

Execute the the.exe file (for Windows) or the .bin file (for AIX, Linux, or
UNIX) to start the installer.
STEP RESULT: The installer screen is displayed, showing the instructions.

3.

Press Enter to continue.


STEP RESULT: The License Agrement is displayed.

INSTALLING SECURECLIENT
INSTALLING SECURECLIENT FROM THE COMMAND LINE

4.

Type y to accept the agreement.


STEP RESULT: The Installation Folder screen is displayed.

5.

Press Enter to accept the default installation folder, or type the absolute path to a different folder.
STEP RESULT: The Java Virtual Machine screen is displayed.

6.

Type the number of the Java Virtual Machine you want to use and press
Enter.
ADDITIONAL INFORMATION: Installing Java Unrestricted Policies will modify the
JRE used by the SecureClient in order to enable stronger cryptography.
Depending on your country's laws, you might not be allowed to use this
option. For more information refer to the Java SE Security documentation
STEP RESULT: If you select any number other than 1, the Java Cryptography
Extension screen is displayed.

INSTALLING SECURECLIENT
INSTALLING SECURECLIENT FROM THE COMMAND LINE

7.

Determine whether you want to enable Java cryptography, enter the


appropriate response, and press Enter.
STEP RESULT: The Scheduler Settings screen is displayed.

8.

Type y to install the scheduler as a Windows service and press Enter.


a

Enter your User ID and press Enter.

Enter your User password and press Enter

Reenter your User password to confirm it and press Enter.

STEP RESULT: The Installation Summary screen is displayed.

9.

Press Enter to start the installation.


STEP RESULT: The Installation Complete screen is displayed.

10.

Press Enter to exit the installation.

INSTALLING SECURECLIENT
INSTALLING SECURECLIENT USING THE GUI

Installing SecureClient using the GUI


Axway SecureClient can be easily installed using InstallAnywhere wizard
included as part of the SecureClient software.
TASK

1.

Download the software for your operating system from the Axway
server at www.axway.com.

2.

Once the software files are downloaded, click on the .exe (for Windows
OS) or .bin (AIX, Linux, or UNIX) file to start the install wizard.
STEP RESULT: On a Windows system, for example, the following InstallAnywhere interface is displayed.

3.

If you want to continue the installation, click Next.


STEP RESULT: The License Agreement is displayed.

INSTALLING SECURECLIENT
INSTALLING SECURECLIENT USING THE GUI

4.

Select accept the terms of the License Agreement and click Next.
STEP RESULT: The Installation Folder page is displayed.

5.

Choose the folder where you want to install SecureClient, or click Next
to accept the default location.
STEP RESULT: The Java Virtual Machine page is displayed.

10

INSTALLING SECURECLIENT
INSTALLING SECURECLIENT USING THE GUI

6.

Select the Java Virtual Machine you want to use and click Next.
STEP RESULT: The Scheduler Settings page is displayed.

11

INSTALLING SECURECLIENT
INSTALLING SECURECLIENT USING THE GUI

7.

Determine whether or not you want to install Scheduler as a service.

If you dont want to install Scheduler as a service. simply click Next and
the Installation Summary page will be displayed.

To install Scheduler as a service, do the following:

Select the check box for Install Scheduler as a service.

Enter your User ID information in the User ID field.

Enter your password in the Password field.

Reenter you password in the Retype Password field.

Click Next

STEP RESULT: The Installation Summary page is displayed.

8.

Click Install to begin the installation.


STEP RESULT: The Installing SecureClient page is displayed, showing a progress
bar during the installation. When the installation is completed, the Installation
Completed window is displayed.

12

INSTALLING SECURECLIENT
INSTALLING SECURECLIENT USING SILENT INSTALLATION

9.

Click Done to exit the installation and begin using SecureClient.

Installing SecureClient using silent installation


Use the silent installation to install SecureClient on multiple machines in a
network. This installation is similar to the command line installation but
accepts the defaults and requires no responses from you.
TASK

1.

Download the software for your operating system from the Axway
server at www.axway.com.

2.

Once the software files are downloaded, run the installer from a
command prompt as follows: path_to_installer -i silent.
Where path_to_installer is the absolute path to the SecureClient installer.
ADDITIONAL INFORMATION: You have the option of using the response file or not.
If you choose not to use the response file, the installation proceeds with the
default options.

3.

To override the default properties while installing SecureClient, run the


installer from the command prompt as follows: path_to_installer

13

INSTALLING SECURECLIENT
INSTALLING SECURECLIENT USING SILENT INSTALLATION

-i silent -f path_to_response_file. Where


path_to_installer is the absolute path to the SecureClient
installer and path_to_response_file is the path to the response
file. Response files are text files that you create with each line in the
format: key=value. To specify the SecureClient installation directory use
the property USER_INSTALL_DIR. See the following example:

WindowsUSER_INSTALL_DIR=C:\\Program
Files\\Axway\\Axway SecureClient

4.

UNIXUSER_INSTALL_DIR=/opt/Axway/SecureClient

To install the Scheduler as a Windows service, use the following properties:

NT_SERVICE_INSTALL: Valid values are: true - install the Scheduler as a


service, false - do not install the Scheduler as a service.
NT_SERVICE_USER: Existing Windows user specified in the following
format: UserID, DomainName\\UserID, .\\UserID. The service process
will be logged on as this user.
NT_SERVICE_PWD: Password of the user specified by the
NT_SERVICE_USER property.
Example:
NT_SERVICE_INSTALL=true
NT_SERVICE_USER=.\\Administrator
NT_SERVICE_PWD=adminPass

5.

Check the exit code of the installation process to determine the result.
ADDITIONAL INFORMATION: 0 = Installation was successful, 1 = a non-fatal error, -1
= a fatal error. For more information on the installer exit codes refer to the
InstallAnywhere User Guide.

14

Upgrading to SecureClient 5.6


You can upgrade to Axway SecureClient 5.6 using either the command line or
the GUI. However, you must ensure that you have only one instance of SecureClient currently installed on your system before you begin the upgrade.

Upgrading SecureClient from the command line


Use this procedure to upgrade to SecureClient 5.6 if you have previous versions
of SecureClient installed on your system.
TASK

1.

Download the software for your operating system from the Axway
server at www.axway.com.

2.

Execute the .exe file (for Windows) or the .bin file (for AIX, Linux, or
UNIX) to start the installer.
STEP RESULT: The upgrade screen is displayed, showing the instructions.

3.

Press Enter to continue.


STEP RESULT: The License Agreement is displayed.

15

UPGRADING TO SECURECLIENT 5.6


UPGRADING SECURECLIENT FROM THE COMMAND LINE

4.

Type y to accept the agreement.


STEP RESULT: The Installation Folder screen is displayed.

5.

Press Enter to accept the default installation folder, or type the absolute path to a different folder.
STEP RESULT: The Java Virtual Machine screen is displayed.

6.

Type the number of the Java Virtual Machine you want to use and press
Enter.
ADDITIONAL INFORMATION: Installing Java Unrestricted Policies will modify the
JRE used by the SecureClient in order to enable stronger cryptography.

16

UPGRADING TO SECURECLIENT 5.6


UPGRADING SECURECLIENT FROM THE COMMAND LINE

Depending on your country's laws, you might not be allowed to use this
option. For more information refer to the Java SE Security documentation
STEP RESULT: If you select any number other than 1, the Java Cryptography
Extension screen is displayed.

7.

Determine whether you want to enable Java cryptography, enter the


appropriate response, and press Enter.
STEP RESULT: The Scheduler Settings screen is displayed.

8.

Type y to install the scheduler as a Windows service and press Enter.


a

Enter your User ID and press Enter.

Enter your User password and press Enter

Reenter your User password to confirm it and press Enter.

STEP RESULT: The Installation Summary screen is displayed.

9.

Press Enter to start the installation.


STEP RESULT: The Installation Complete screen is displayed.

17

UPGRADING TO SECURECLIENT 5.6


UPGRADING SECURECLIENT FROM THE COMMAND LINE

10.

18

Press Enter to exit the installation.

UPGRADING TO SECURECLIENT 5.6


UPGRADING SECURECLIENT USING THE GUI

Upgrading SecureClient using the GUI


Use this procedure to upgrade to SecureClient 5.6 using the graphical user interface.
TASK

1.

Download the software for your operating system from the Axway
server at www.axway.com.

2.

Once the software files are downloaded, click on the .exe (for Windows
OS) or .bin (AIX, Linux, or UNIX) file to start the install wizard.
STEP RESULT: The Upgrading SecureClient page is displayed.

3.

If you want to continue the upgrade, click Next.


STEP RESULT: The License Agreement is displayed.

19

UPGRADING TO SECURECLIENT 5.6


UPGRADING SECURECLIENT USING THE GUI

4.

Select I accept the terms of the License Agreement and click Next.
STEP RESULT: The Installation Folder page is displayed.

5.

Choose the folder where you want to install SecureClient, or click Next
to accept the default location.
STEP RESULT: The Java Virtual Machine window is displayed.

20

UPGRADING TO SECURECLIENT 5.6


UPGRADING SECURECLIENT USING THE GUI

6.

Select the Java Virtual Machine you want to use and click Next.
STEP RESULT: The Scheduler Settings page is displayed.

21

UPGRADING TO SECURECLIENT 5.6


UPGRADING SECURECLIENT USING THE GUI

7.

Determine whether or not you want to install Scheduler as a service.

If you dont want to install Scheduler as a service. simply click Next and
the Installation Summary page will be displayed.

To install Scheduler as a service, do the following:

Select the check box for Install Scheduler as a service.

Enter your User ID information in the User ID field.

Enter your password in the Password field.

Reenter you password in the Retype Password field.

Click Next

STEP RESULT: The Installation Summary page is displayed.

8.

Click Install to begin the installation.


STEP RESULT: The Installing SecureClient page is displayed, showing a progress
bar during the installation. When the installation is completed, the Installation
Completed window is displayed.

22

UPGRADING TO SECURECLIENT 5.6


UPGRADING SECURECLIENT USING THE GUI

9.

Click Done to exit the installation and begin using SecureClient.

23

UPGRADING TO SECURECLIENT 5.6


UPGRADING SECURECLIENT USING THE GUI

24

Uninstalling SecureClient
Axway SecureClient can be easily uninstalled using the command line, the GUI,
the silent mode, or the following mode on Windows system.
TASK

From the Control panel, select Add or Remove programs, select SecureClient, and click Remove.

Uninstalling SecureClient from the command


line
TASK

1.

In the directory where Axway SecureClient is installed, such as,


C:\Program Files\Axway\SecureClient, open the Uninstall directory, and
click Uninstall.exe (for Windows) or Uninstall (for (AIX, Linux, or UNIX).
STEP RESULT: The uninstall screen is displayed, asking you to confirm removal.

2.

Type y to completely remove SecureClient.


STEP RESULT: The configuration screen is displayed, asking if you want to save
your current configuration.

25

UNINSTALLING SECURECLIENT
UNINSTALLING SECURECLIENT USING THE GUI

3.

Type y to keep your configuration files or n to remove them.


STEP RESULT: The uninstall complete screen is displayed, showing that SecureClient was successfully uninstalled.

Uninstalling SecureClient using the GUI


TASK

1.

In the directory where Axway SecureClient is installed, such as,


C:\Program Files\Axway\SecureClient, open the Uninstall directory, and
click Uninstall.exe (for Windows) or Uninstall (for (AIX, Linux, or UNIX).
STEP RESULT: The Maintenance Mode window is displayed.

26

UNINSTALLING SECURECLIENT
UNINSTALLING SECURECLIENT USING THE GUI

2.

Click Next.
STEP RESULT: The Uninstall Notice window is displayed.

3.

Click Uninstall to complete the uninstallation.


STEP RESULT: The Uninstall Completed window is displayed.

27

UNINSTALLING SECURECLIENT
UNINSTALLING SECURECLIENT FROM THE COMMAND LINE IN SILENT MODE

4.

Click Done to close the window and exit the uninstallation.

Uninstalling SecureClient from the command


line in silent mode
TASK

1.

Run the uninstaller from a command prompt as follows:


path_to_uninstaller -i silent. Where
path_to_uninstaller is the absolute path to the SecureClient
uninstaller.
ADDITIONAL INFORMATION: To obtain the path_to_uninstaller, go to the
directory where SecureClient is installed, for example, C:\Program
Files\Axway\SecureClient. Inside that directory is the subdirectory Uninstall
that contains the uninstaller: Uninstall.exe (Windows) or Uninstall (UNIX)
STEP RESULT: This command will uninstall SecureClient and keep the SecureClient configuration files.

2.

28

To remove the SecureClient configuration files as well, run the uninstaller as follows: path_to_uninstaller -i silent -f
path_to_response_file. Where path_to_uninstaller is
the absolute path to the SecureClient uninstaller and

UNINSTALLING SECURECLIENT
UNINSTALLING SECURECLIENT FROM THE COMMAND LINE IN SILENT MODE

path_to_response_file is the path to the response file.


Response files are text files that you create with each line in the format:
key=value. Use the property USER_INPUT_KEEP_SC_CONF with
possible values: y, Y, n, N; y, Y - do not remove SecureClient configuration files; n, N- remove SecureClient configuration files.

29

UNINSTALLING SECURECLIENT
UNINSTALLING SECURECLIENT FROM THE COMMAND LINE IN SILENT MODE

30

SecureClient compatibility with SecureTransport


If you use the SecureTransport Client, you can replace it with Axway SecureClient and maintain a high level of compatibility with your SecureTransport
server. Axway SecureClient provides a GUI utility to help you migrate your
existing SecureTransport site and preference data to work with Axway SecureClient. In addition, Axway SecureClient provides a command-line utility that
allows you to use the same familiar SecureTransport Client syntax to schedule
file transfers in Axway SecureClient.

Migrating SecureTransport Client configuration data


You can migrate your existing SecureTransport Client site and preference data
to help you maintain a high level of compatibility between Axway SecureClient
and SecureTransport server.
If you have already configured Axway SecureClient and there is a conflict
between the existing configuration data and the SecureTransport client data
being imported the existing Axway SecureClient configuration will be overwritten.
NOTE:

TASK

1.

Start the SecureTransport Migration tool. Navigate to the folder in


which you installed Axway SecureClient, and double-click stclientmigrate.cmd.
STEP RESULT: The SecureTransport Migration tool main window is displayed.

31

SECURECLIENT COMPATIBILITY WITH SECURETRANSPORT


MIGRATING SECURETRANSPORT CLIENT CONFIGURATION DATA

2.

Click the folder icon to open the Open File dialog box, and navigate to
the location where your SecureTransport Client files reside.
STEP RESULT: The Open File dialog box displays the folders within the location
to which you navigated.

3.

Click Open.
STEP RESULT: SecureTransport Migration tool finds the proper site and preference configuration data in your ST Client directory and uses it to populate the
Sites and Preferences panes in the main window.

32

SECURECLIENT COMPATIBILITY WITH SECURETRANSPORT


EXECUTING SECURECLIENT FROM THE COMMAND LINE USING SECURETRANSPORT CLIENT SYNTAX

4.

Click Migrate.
STEP RESULT: The SecureTransport Migration tool window is dismissed and the
Site and Preference data is imported into Axway SecureClient.

Executing SecureClient from the command line


using SecureTransport Client syntax
You can execute Axway SecureClient from the command line using the same
familiar SecureTransport Client syntax with the added benefit of using the
Axway SecureClient transfer engine.
TASK

Execute the stclient.cmd command and use the same syntax you would
for the stclient.exe command.

33

SECURECLIENT COMPATIBILITY WITH SECURETRANSPORT


MIGRATING SECURETRANSPORT CLIENT SCRIPTS

Migrating SecureTransport Client scripts


You can use your existing SecureTransport Client scripts in Axway SecureClient.
TASK

In each script you want to migrate, replace each occurrence of


stclient.exe with stclient.cmd.
ADDITIONAL INFORMATION: Be sure to include the proper path to the stclient.cmd
file.

34