Skip to Main Content
Return to Navigation

Installing a PTF Client

A PTF client is an installation of the PTF executable software on an individual user’s machine. It is the program that users run in order to create and execute automated tests. PTF test assets are not saved to the client machine. Rather, they are saved to an application database environment configured to exchange information with the PTF client. A PTF client does not need to be, and usually is not, installed on the same machine that hosts the PeopleSoft application environment.

This section discusses how to:

  1. Verify requirements.

  2. Configure the browser security settings.

  3. Install PTF client software.

  4. Create a connection to a PTF environment.

  5. Select a PTF environment.

  6. Configure local options.

  7. Configure execution options.

Verifying Requirements

PTF client installation has the following requirements:

  1. Microsoft Windows operating system.

  2. Microsoft Internet Explorer.

    PTF does not support any browsers other than Microsoft Internet Explorer.

  3. Microsoft .NET Framework v4.0.

    If Microsoft .NET Framework v4.0 is not present, the PTF Installer returns the following error during installation:

    Image: Microsoft .NET Framework error message

    This example illustrates the message received when Microsoft .NET Framework Version 3.5 is not present in the environment.

    Microsoft .NET Framework error message
  4. In order to install PTF, you will need read and write access to the PTF home directory (C:\Program Files\PeopleSoft\PeopleSoft Test Framework) by default.

  5. PTF will need runtime access to the PTF data directory (C:\Documents and Settings\<User>\ApplicationData\PeopleSoft\PeopleSoft Test Framework by default).

Configuring the Browser Security Settings

You must configure the client browser Security settings to accept the test application URL.

If browser security settings are not properly configured you may encounter problems with PTF test playback.

To configure the browser security settings:

  1. In Microsoft Internet Explorer, select select Tools, then select Internet Options.

  2. In the Internet Options dialog box, access the Security tab.

  3. Click the Local intranet button.

  4. Click the Sites button.

  5. Click the Advanced button.

  6. In the Add this website to the zone field, enter the domains for the test applications.

  7. Add entries for both http and https.

    For example:

    http://*.<domain_name>
    https://*.<domain_name>

    Determine the domain name based on the URL for the test application. For example, if the URL is:

    http://myserver.us.oracle.com:80/PTTRN/signon.html

    then the domain name is us.oracle.com

  8. Click the Add button.

  9. Click the Close button.

  10. Click the OK button to close each open dialog box.

This example shows the Local intranet dialog box:

Image: Microsoft Internet Explorer Local intranet dialog box

This example illustrates the Microsoft Internet Explorer Local intranet dialog box

Microsoft Internet Explorer Local intranet dialog box

Configuring Browser Settings with Windows 7

If you are using Windows 7, confirm the following settings:

  • Enable Protected Mode should be set on.

    In IE select Tools, Internet Options, Security, highlight Internet and select Enable protected Mode

    Image: Enable Protected Mode on

    This example illustrates setting Enable Protected Mode on.

    Enable Protected Mode on
  • Browser zoom is set to 100%

    Check the lower right-hand corner of the browser and make sure it displays 100% for the zoom level.

Installing PTF Client Software

To install the PTF client software:

  1. In Windows Explorer, navigate to the setup.exe executable.

    If you are installing on a machine that has a PeopleTools 8.51 or later installation, setup.exe is located in the <PS_HOME>\setup\PsTestFramework directory.

    If you are installing PTF client on another machine, the path will be \\<machine_name>\<PS_HOME>\setup\PsTestFramework. Your network administrator will need to make the directory accessible to users.

  2. Run setup.exe.

    The installation wizard appears.

  3. Click the Next button.

  4. You are prompted to select a folder where the wizard will install files. The default location is C:\Program Files\PeopleSoft\PeopleSoft Test Framework.

    You can accept the default location or click the Browse button to select a different location.

  5. Click the Next button.

    The Ready to Install the Program page appears.

  6. Click the Install button.

    The InstallShield Wizard Complete page appears.

  7. Click the Finish button to dismiss the install wizard.

    Your PTF client software installation is complete.

  8. To verify your installation, do any of the following:

    • Locate the PTF shortcut on your desktop.

    • Navigate to Start, All Programs, PeopleSoft Test Framework.

    • In Windows Explorer, navigate to C:\Program Files\PeopleSoft\PeopleSoft Test Framework (or the installation directory you specified in Step 3).

Creating a Connection to a PTF Environment

To create a connection to a PTF environment:

  1. Run the PTF client.

    Either double-click the PTF shortcut on your desktop or navigate to Start, All Programs, PeopleSoft Test Framework.

  2. The PeopleSoft Test Framework - Signon dialog box appears. If you have not yet created a connection to a PTF environment, the environment signon dialog box is empty and the fields are disabled.

  3. Click the New button.

    Enter details for the following fields:

    Name

    Enter a descriptive name for this environment. You can use any name.

    Server:Port

    Enter the server name and port for the environment. Contact your Integration Broker administrator or system administrator for the correct values.

    The format for the Server:Port field is:

    <machine_name>:<https_port>

    For example:

    myserver.us.oracle.com:443

    If the https port is the default 443 the port is optional.

    You can also enter a complete https URL in this format:

    https://<machine_name>:<https_port>/PSIGW/HttpListeningConnector
    

    For example:

    https://myserver.us.oracle.com:443/PSIGW/HttpListeningConnector
    Use Proxy

    Select this field if using a proxy server.

    When you select this check box the Proxy Information link is enabled.

    Proxy Information

    Click this link to enter details for the proxy server.

    Enter the following information for the proxy server:

    • Server: Enter the server name

    • Port: Enter the server port.

    • User: Enter the user ID for the proxy server.

      If you use network authentication, use the DOMAIN\USER format.

    • Password: Enter the password.

    Node ID

    This field is required if more than one database is connected to the server. Enter the name of the PeopleSoft node with which the integration gateway is to communicate.

    Contact your Integration Broker administrator or system administrator for the correct values.

    See Verifying Integration Broker Setup.

    User

    Enter a valid user ID for the PeopleSoft application that contains the environment. The user ID must have one of the PTF security roles assigned. Contact your security administrator to add the role if required.

    If this user ID does not have PTF access you will receive a signon error:

    See Setting Up Security.

    Password

    Enter the password for this user.

  4. Click the OK button.

    PTF launches with a connection to the designated environment.

The following example shows a completed PeopleSoft Test Framework - Signon dialog box. In this example the Node ID field is left blank because the default gateway is used.

Image: Example of a Completed Environment Signon Dialog Box

This example illustrates a completed environment signon dialog box.

Example of a Completed Environment Signon Dialog Box

This example shows a completed PeopleSoft Test Framework - Signon dialog box where the default gateway is not used, which requires a Node ID to be specified:

Image: Example of a Completed Environment Signon Dialog Box with Node ID Specified

This example shows a completed PeopleSoft Test Framework - Signon dialog box where the default gateway is not used, which requires a Node ID to be specified.

Example of a Completed Environment Signon Dialog Box with Node ID Specified

Note: Contact your Integration Broker administrator to determine the correct value to use for the Node ID field.

Troubleshooting Tips

This section shows some of the errors you might encounter when attempting to signon to PTF and suggests possible solutions.

You will receive the following signon error if PTF security has not been configured correctly:

Image: Signon ErrorMessage

This example illustrates a Signon error message when PTF security has not been configured correctly.

Example of Signon Error message

Possible causes and solutions for this error are:

  • The user ID and password you entered are not valid for the PeopleSoft application corresponding to the entry in the Server:Port field.

  • The user ID you entered in the User field in the Environment Login does not have PTF privileges. Add at least the PTF User role to the user profile.

  • The user ID for the ANONYMOUS node does not have PTF privileges. Add at least the PTF User role to the user profile.

You will receive the following error message if you specified the wrong HTTPS port in the environment login URL:

Image: Wrong HTTPS Error Message

This example illustrates the error message received when the wrong HTTPS is entered.

Wrong HTTPS Error Message

The default port is 443. If a different port was specified during installation, you will need to contact your system administrator to determine the correct port number.

If you receive the following error message, select Allow Untrusted SSL on the Configuration Options page.

Image: Untrusted SSL Certificate Error Message

This example illustrates the error message received when Untrusted SSL Certificate has not been selected and no certificate has been installed.

Untrusted SSL Certificate Error Message

See Defining PTF Configuration Options.

Selecting a PTF Environment

When you launch PTF again, the PeopleSoft Test Framework - Signon dialog box appears with the last environment you used automatically selected.

You can enter the password and click the OK button to launch PTF using that environment, or you can click the New button to create another environment login.

Image: New PeopleSoft Test Framework - Signon Dialog Box

This example illustrates the dialog box for creating a new PTF environment login.

New PeopleSoft Test Framework - Signon Dialog Box

If you have created other environment signons, click the Previous button to select another environment signon.

Click the Edit button to edit the currently selected environment signon.

Image: Example of PeopleSoft Test Framework - Signon dialog box showing previously used test environments

This example illustrates the PeopleSoft Test Framework - Signon dialog box showing previously used test environments.

Example of PeopleSoft Test Framework - Signon dialog box showing previously used test environments

Environment signon settings are specific to the machine on which the PTF client is installed. The environment signon settings are stored in the environments.xml file in the PTF data directory (C:\Documents and Settings\<User>\Application Data\PeopleSoft\PeopleSoft Test Framework) by default.

Note: The environment password is not stored in the environments.xml file.

Configuring Local Options

Select Local Options from the PTF menu to access the Local Options dialog box. Use Local Options to configure timeouts for processes launched from a PTF test.

Local options are specific to the machine on which the PTF client is installed. The local options settings are stored in the localoptions.xml file in the PTF data directory (C:\Documents and Settings\<User>\Application Data\PeopleSoft\PeopleSoft Test Framework) by default.

Image: Local Options Dialog Box

This example illustrates the fields and controls on the Local Options dialog box. You can find definitions for the fields and controls later on this page.

Local Options Dialog Box

Run Settings

Queued: Timeout (min)

Enter the time in minutes for a process to be queued before PTF logs a warning or a fail message.

Queued: Log Result

Specify whether a timeout causes PTF to log a warning or a fail message. If LogFail is selected and Stop on Error is set in the Debug menu, then execution will stop if a timeout occurs.

Posting: Timeout (min)

Enter the time in minutes for a process to post before PTF logs a warning or a fail message.

Posting: Log Result

Specify whether a timeout causes PTF to log a warning or a fail message. If LogFail is selected and Stop on Error is set in the Debug menu, then execution will stop if a timeout occurs.

Processing: Timeout (min.)

Enter the time in minutes for a process to complete before PTF logs a warning or a fail message.

Grid Options

Show Field Label

Select Tooltip to show field labels as tooltips (hover text). Select Column to show field labels in a column in the test window.

Auto-Check Syntax

Select Yes to be prompted to check syntax every time you save a test.

Note: Changes made to the Local options settings will take affect the next time PTF client is opened or after a PTF test suite refresh.

Configuring Execution Options

Use Execution Options to configure settings for the PeopleSoft applications you test with PTF.

You can access Execution Options either through a PeopleSoft application browser session, or through the PTF client.

Select Execution Options from the PTF menu. (The PTF menu is labeled with the name of the current PTF environment.) You can also access the Execution Options dialog box by clicking the Execution Options link in the lower right corner of the PTF application window. The Execution Options link is labeled with the name of default execution option.

Execution options are stored as part of the metadata for a PTF environment and can be viewed and selected in the PTF client by all users of that environment. Only a PTF administrator (a user with the PTF Administrator role) is able to insert, delete, or modify execution options.

Note: Because test assets are PeopleTools-managed objects, we strongly recommend that you run tests only against the database on which they are stored. As part of the PTF maintenance process, PTF synchronizes test definitions with application metadata definitions. If tests are run against a different application database, you may encounter problems when an application is customized or upgraded. A PTF administrator can limit execution options to environments running against the same database where test assets are stored.