Installing AppScan Source components in a multi-machine environment

AppScan® Source components can be installed on multiple machines. In this scenario, components are deployed in a multi-machine environment. HCL® License Server, AppScan Enterprise Server, AppScan Source client products, and the AppScan Source Database are all installed on different machines.

About this task

This scenario is divided into five sections:
Important:

Installing HCL Common License Server on Machine A

The HCL License Server is used for hosting your AppScan Enterprise Server license. It can also be used for hosting AppScan Source floating licenses, however, this is not covered in these instructions.

About this task

If you already have a supported version of HCL License Server installed, you can skip the portion of these instructions that cover HCL License Server installation - and proceed to the portion of the instructions that covers launching License Key Administrator and importing your license. Supported HCL License Server versions are outlined in the AppScan Enterprise Server system requirements and the AppScan Source system requirements.

Procedure

  1. Locate the HCL License Key Server image (on your AppScan Source product DVDs or that you downloaded as part of the AppScan Source eAssembly at FlexNet Operations).
  2. Extract the image to a local drive and, in the resulting directory, locate and run RLKSSERVER_SETUP\disk1\launchpad.exe.
  3. In the HCL License Server installer, click Install or Update HCL Common License Key Server.
  4. If HCL Installation Manager is not already installed on your system, it will launch for installation purposes.
    1. On the first page of the Install Packages wizard, ensure that the HCL Installation Manager check box, and check boxes for all entries beneath it, are selected. Click Next.
    2. On the Licenses page, read the license agreement. If you agree to the terms of the license agreement, click I accept the terms in the license agreement and then click Next.
    3. In the Location page, specify the installation directory and then click Next.
    4. A summary of what will be installed is shown on the Summary page. If you want to change your selections, click Back to return to the previous pages. When you are satisfied with your installation choices, click Install.
    5. When the installation is complete, click Restart Installation Manager. This will launch Installation Manager and allow you to install
  5. On the first page of the Install Packages wizard, ensure that the HCL Common License Key Server check box, and check boxes for all entries beneath it, are selected. Click Next.
  6. In the Prerequisites page, you are instructed to close all applications and disable anti-virus software. Complete these precautionary tasks and then click Next.
  7. On the Licenses page, read the license agreement. If you agree to the terms of the license agreement, click I accept the terms in the license agreement and then click Next.
  8. In the Location page, specify the installation directory and then click Next.
  9. Complete the Package Group page according to your needs (for example, if you are using Installation Manager for the first time and have no existing package group, leave the default settings as-is). Click Next.
  10. In the Translation Selection page, select the national languages that you want to install. Click Next.
  11. On the Features page, ensure that all features are selected and then click Next.
  12. A summary of what will be installed is shown on the Summary page. If you want to change your selections, click Back to return to the previous pages. When you are satisfied with your installation choices, click Install.
  13. When the installation is complete, click Finish and close HCL Installation Manager.
  14. Launch the HCL License Key Administrator from the Windows™ Start menu (in the Programs menu, launch IBM Rational > License Key Administrator).
  15. When the HCL License Key Administrator starts, you are prompted with the License Key Administrator Wizard (if the wizard does not open automatically, select License Keys > License Key Wizard from the main menu). In this wizard, select Import a Rational License File and then click Next.
  16. In the Import a License File panel, click Browse and then navigate to your AppScan Enterprise Server license file. Open the file with the browse dialog box and then click Import.
  17. After confirming the license or licenses that will be imported, the Restart License Server dialog box will open. Click Yes to restart the license server. If the License Server service fails to start, open the Windows Services administrative tool. In the tool, locate FLEXlm License Manager and start it.

Installing HCL AppScan Enterprise Server on Machine B

To learn how to install the Enterprise Server, refer to the interactive installation guide at HCL Software Product Documentation.

About this task

The AppScan Enterprise Planning & Installation Guide accompanies the HCL AppScan Enterprise Server installation images. The interactive installation guide can be found at http://help.hcl-software.com/appscan/Enterprise/9.0.3/helpindex_ase.html (for example, the Version 9.0.3 interactive installation guide is available at http://help.hcl-software.com/appscan/Enterprise/9.0.3/topics/roadmap_ase_install.html).

What to do next

If AppScan Source was installed prior to installing the Enterprise Server, you will need to register the Database with the Enterprise Server. A utility for doing this is included with AppScan Source. Information about this can be found at Registering the AppScan Source Database with AppScan Enterprise Server.

If you need to uninstall the Enterprise Server, you must delete its installation directory before installing it again.

Installing AppScan Source client products on Machine C

About this task

Note that the order in which you install AppScan Source client products and the AppScan Source Database does not matter. The client products can be installed before you install the database - or vice-versa.

Procedure

  1. Locate the HCL AppScan Source product zip file (in your AppScan Source media pack - or the electronic image that you downloaded as part of an AppScan Source eAssembly at FlexNet Operations).
  2. Extract the image to a local drive. In the resulting directory:

    Detailed information about launching the installation wizard can be found at Starting the installation wizard.

  3. You are presented with a screen that allows you to select the national language that will be displayed in the installation panels. Select the language and click OK to proceed.
  4. After you launch the installation wizard, the Welcome - Installation Wizard panel opens and recommends that you quit any open applications. Click Next to begin the installation procedure.
  5. In the Component Selection installation panel, select Client Component Selection and then choose the components to install:
    • AppScan Source for Analysis
    • AppScan Source Command Line Interface
    • AppScan Source for Development for Eclipse, RAD, MobileFirst (not selected by default)
    • Windows only: AppScan Source for Development for Visual Studio 2013 (not selected by default)(this option is only available if the installer has detected Microsoft Visual Studio 2013 on your system)
    • Windows only: AppScan Source for Development for Visual Studio 92 (not selected by default)(this option is only available if the installer has detected Microsoft Visual Studio 2012 on your system)
    • Windows only: AppScan Source for Development for Visual Studio 2010 (not selected by default)(this option is only available if the installer has detected Microsoft Visual Studio 2010 on your system)

    By default, when Client Component Selection is selected, the AppScan Source for Development plug-in components are deselected and all other components are selected.

    After you have selected the components that you want to install, click Next to advance to the next installation panel.

  6. In the Installation Target Specification page, specify the installation directory. The default directories, by operating system, are:
    • 32-bit versions of Microsoft Windows:
      <SYSTEMDRIVE>:\Program Files\HCL\AppScanSource
    • 64-bit versions of Microsoft Windows:
      <SYSTEMDRIVE>:\Program Files (x86)\HCL\AppScanSource
    • Linux: If you are the root user, the Installation Wizard installs your software in /opt/hcl/appscansource. If you are not the root user, you can install the AppScan Source for Development Eclipse plug-in - which installs to <home_directory>/AppScan_Source by default.
    • macOS: /Applications/AppScanSource.app
    Important:
    • The installation directory name can only contain English characters. Folders with names containing non-English characters are not permitted.
    • If you are installing on Windows, you must have Administrator privileges to install AppScan Source components.
    • If you are installing on Linux, you must have root privileges to install AppScan Source server components.

    Click Next to advance to the next installation panel.

  7. In the language pack selection panel, choose the language packs to install. When you install a language pack, the AppScan Source user interface will display in that language when it runs on an operating system that is running that locale.

    By default, English is selected (and cannot be deselected). If the installation wizard is displaying a national language other than English (in other words, a language other than English was selected in the installation wizard welcome panel), that language will also be selected in this panel (however, it can be deselected).

    After you have selected the language packs that you want to install, click Next to advance to the next installation panel.

    Note: If you do not install a specific language pack, you will not be able to add that language post-installation.
  8. Review and accept the terms of the license agreement and then click Next to continue.
  9. Review the summary of installation options before proceeding. If you want to change your selections, click Previous to return to the previous pages. When you are satisfied with your installation choices, click Install. The installer copies files to the hard disk drive.

    For Linux server installations only: After copying files, you must identify the daemon user. Select Create User 'ounce' or Run with Existing User, either to create the default user, ounce, or run with an existing user. (The installation validates that the user exists. Note that the selected user must have a valid shell.)

    During the installation, clicking Cancel at any time results in the uninstallation of all components.

  10. In the Installation Complete panel, you can initiate product activation immediately after exiting the installation wizard by selecting Launch HCL AppScan Source License Manager. Click Done to complete the standard installation and exit the Installation Wizard.
  11. In the License Manager utility:
    1. To apply a license file, click Import and then browse to your downloaded AppScan Source license.
    2. To apply a floating license, click Configure license servers and then click Add. Enter the information for the host machine that contains the floating license.
    See Activating the software for additional activation instructions.

Installing the AppScan Source Database on Machine D

About this task

Note that the order in which you install AppScan Source client products and the AppScan Source Database does not matter. The client products can be installed before you install the database - or vice-versa.

Procedure

  1. Locate the HCL AppScan Source product zip file (in your AppScan Source media pack - or the electronic image that you downloaded as part of an AppScan Source eAssembly at FlexNet Operations).
  2. Extract the image to a local drive. In the resulting directory:

    Detailed information about launching the installation wizard can be found at Starting the installation wizard.

  3. You are presented with a screen that allows you to select the national language that will be displayed in the installation panels. Select the language and click OK to proceed.
  4. After you launch the installation wizard, the Welcome - Installation Wizard panel opens and recommends that you quit any open applications. Click Next to begin the installation procedure.
  5. In the Component Selection installation panel, select Server Component Selection and then ensure that AppScan Source Database is selected. Click Next to advance to the next installation panel.
  6. In the Server Connection panel, choose one of these options:
    • I will connect to an AppScan Server instance: Selecting this option allows you to test the remote AppScan Enterprise Server to ensure that it is available for connection to AppScan Source. To test the server connection, complete these fields:
      • AppScan Enterprise Server: Specify the hostname for your remote AppScan Enterprise Server instance in the existing URL format.
      • Product Administrator: Specify your AppScan Enterprise Server administrator user ID.
      • Password: Specify the password for your AppScan Enterprise Server administrator user ID.

      When the server settings have been entered, click Test Connection to ensure that the server will be available for connection to AppScan Source.

    • Let me proceed without specifying a server: Select this option to proceed without specifying a server.
    Important:
    • If the Enterprise Server that you will connect to is enabled for NIST 800-131a compliance, you cannot test a connection to the server. In this case, proceed without specifying a server. After the installation of AppScan Source and the Enterprise Server are complete, follow the instructions for Registering the AppScan Source Database with AppScan Enterprise Server, ensuring that the Force TLSv1.2 option is applied.
    • If your AppScan Enterprise Server has been set up with Common Access Card (CAC) authentication, select Let me proceed without specifying a server and then use the appscanserverdbmgr_cac utility for all server connection settings and tests.

    Click Next to advance to the next installation panel.

  7. In the Installation Target Specification page, specify the installation directory. The default directories, by operating system, are:
    • 32-bit versions of Microsoft Windows:
      <SYSTEMDRIVE>:\Program Files\HCL\AppScanSource
    • 64-bit versions of Microsoft Windows:
      <SYSTEMDRIVE>:\Program Files (x86)\HCL\AppScanSource
    • Linux: If you are the root user, the Installation Wizard installs your software in /opt/hcl/appscansource. If you are not the root user, you can install the AppScan Source for Development Eclipse plug-in - which installs to <home_directory>/AppScan_Source by default.
    • macOS: /Applications/AppScanSource.app
    Important:
    • The installation directory name can only contain English characters. Folders with names containing non-English characters are not permitted.
    • If you are installing on Windows, you must have Administrator privileges to install AppScan Source components.
    • If you are installing on Linux, you must have root privileges to install AppScan Source server components.

    Click Next to advance to the next installation panel.

  8. If the HCL AppScan Source Database component was selected for installation in the Server Component Selection page, the database selection panel displays. In this page, select the Install solidDB® radio button and then click Next to advance to the next installation panel.
  9. If you choose to install a solidDB database in the Database selection panel, you are prompted with the Configure solidDB Admin User panel. In it, configure the solidDB database administrator account. The default database administrator user name and password are both dba. You cannot change this user name, however, the password can be changed.
    Note: To learn how to change the user password after completing the product installation, see Changing solidDB user passwords after installation.

    Click Next advance to the next installation panel.

  10. The Configure solidDB AppScan Source User panel allows you to configure the solidDB AppScan Source database user account. You can retain the default user name, ounce, and default password, ounce. All components that read from or write to the AppScan Source Database use this account.
    Note:
    • If you change the user names and passwords, you must keep a record of the new configuration in case your HCL support representative requires access to your AppScan Source Database.
    • To learn how to change the user password after completing the product installation, see Changing solidDB user passwords after installation.

    Click Next to advance to the next installation panel.

  11. In the language pack selection panel, choose the language packs to install. When you install a language pack, the AppScan Source user interface will display in that language when it runs on an operating system that is running that locale.

    By default, English is selected (and cannot be deselected). If the installation wizard is displaying a national language other than English (in other words, a language other than English was selected in the installation wizard welcome panel), that language will also be selected in this panel (however, it can be deselected).

    After you have selected the language packs that you want to install, click Next to advance to the next installation panel.

    Note: If you do not install a specific language pack, you will not be able to add that language post-installation.
  12. Review and accept the terms of the license agreement and then click Next to continue.
  13. Review the summary of installation options before proceeding. If you want to change your selections, click Previous to return to the previous pages. When you are satisfied with your installation choices, click Install. The installer copies files to the hard disk drive.

    For Linux server installations only: After copying files, you must identify the daemon user. Select Create User 'ounce' or Run with Existing User, either to create the default user, ounce, or run with an existing user. (The installation validates that the user exists. Note that the selected user must have a valid shell.)

    During the installation, clicking Cancel at any time results in the uninstallation of all components.

  14. In the HCL AppScan Enterprise Server Configuration panel, specify the settings that will allow a solidDB database to connect to the AppScan Enterprise Server. Select the Configure the AppScan Enterprise Server now check box and complete these settings:
    • AppScan Enterprise Server: Specify the URL for your AppScan Enterprise Server instance (for example, https://MachineB.mydomain.com:9443/ase).
    • User ID: Specify your AppScan Enterprise Server user ID. By default, the user ID is ADMIN (change this value as needed). If the server is configured for Windows authentication, enter the Windows user ID that was used when your account was added to the server (the user ID must be in the format <host name>\<user id>).
    • Password: Specify the password for your AppScan Enterprise Server user ID.
    • Database Host Name: Specify the fully-qualified host name for the machine on which you have installed the AppScan Source Database (for example, MachineD.mydomain.com).
      Note: The entry in this field should always be the fully-qualified host name of the machine on which the installer is running. This value should be pre-filled in this field at install time and should only be changed if the value has pre-filled incorrectly.

    Click Next to advance to the next installation panel.

    Note: If you will be using an Oracle database, ensure that Configure the AppScan Enterprise Server now is not selected and then click Next. This installation panel is not used for registering an Oracle database with the Enterprise Server. Instead, configure the database connection post-installation using a utility that is included with AppScan Source. Information about this can be found at Registering the AppScan Source Database with AppScan Enterprise Server . This utility can also be used to configure a solidDB connection instead of using this installation panel.
  15. In the Installation Complete panel, you can initiate product activation immediately after exiting the installation wizard by selecting Launch HCL AppScan Source License Manager. Click Done to complete the standard installation and exit the Installation Wizard.
  16. In the License Manager utility:
    1. To apply a license file, click Import and then browse to your downloaded AppScan Source license.
    2. To apply a floating license, click Configure license servers and then click Add. Enter the information for the host machine that contains the floating license.
    See Activating the software for additional activation instructions.

Logging into AppScan Source

About this task

Refer to the section below for a description of the fields requested when you log in. For detailed information, see Logging in to AppScan Enterprise Server from AppScan Source products.

Procedure

  • User ID: Specify your user ID.
  • Password: Specify the password for your user ID.
  • AppScan Enterprise Server: Specify the hostname for your AppScan Enterprise Server instance in the existing URL format. For this installation scenario, specify the fully-qualified host name of the machine on which the AppScan Enterprise Server is installed.
    Tip: If the fully-qualified host name does not work, try entering the IP address of the host machine.