Installing and Configuring PTF

This chapter presents an overview of the PTF development environment and discusses how to:

Click to jump to parent topicUnderstanding the PTF Development Environment

The following diagram illustrates the PeopleSoft Test Framework (PTF) development environment:

Diagram of the PTF development environment

A PTF development environment consists of the following elements:

The PTF client is a standalone program that runs on a Microsoft Windows workstation.

The PTF client connects to the PeopleSoft application database where test assets are stored using a secure HTTPS connection through Integration Broker Web Services.

The PTF client connects to the PeopleSoft application that is to be tested through a Microsoft Internet Explorer browser session. The browser connects to the PeopleSoft application using HTTP through the PeopleSoft Pure Internet Architecture (PIA).

Note. The PeopleSoft application database where test assets are stored and the PeopleSoft application that is to be tested are not required to be on the same database, but we strongly recommend you use the same database for both.

Click to jump to parent topicConfiguring an Environment for PTF

PTF test assets (tests and test cases) are stored in tables in a PeopleSoft application database.

Any application database certified to run on PeopleTools 8.51 or greater can be used as a PTF environment.

This section discusses how to:

  1. Verify Integration Broker setup.

  2. Set up security.

  3. Configure the Web Profile.

  4. Define PTF Configuration Options.

Click to jump to top of pageClick to jump to parent topicVerifying Integration Broker Setup

To verify that Integration Broker is set up for your application:

  1. In your PeopleSoft application, navigate to PeopleTools, Integration Broker, Configuration, Gateways.

  2. Verify that the Gateway URL field references the correct machine name.

  3. Click the Ping Gateway button.

  4. Verify that the message returns a status of ACTIVE.

  5. Click the Gateway Setup Properties link.

  6. Sign on to access integrationGateway.properties file.

  7. The default user ID is administrator, and the default password is password.

  8. Verify that the Gateway Default App Server URL is specified.

This is an example of the Gateways page:

The port number in the URL (80 in this example) is the http port of the web server. The default is 80.

This is an example of a Ping message showing ACTIVE status:

Click the Gateway Setup Properties link on the Gateways page to access the PeopleSoft Node Configuration page, as shown in this example:

The port number in the App Server URL (9040 in this example) generally corresponds with the JSL Port Number as defined in the Application Server configuration. The default port number is 9000.

When the web server is connected to more than one database you will need to enter a node name, as defined in PeopleSoft Nodes on the PeopleSoft Node Configuration page, in the Node ID field of the PTF Signon dialog box. Contact your Integration Broker administrator to determine the correct node name to use. If no node is defined in PeopleSoft Nodes on this page, leave the Node ID field of the PTF Signon dialog blank.

See Creating a Connection to a PTF Environment.

Note. If you rerun the PIA installer, the PeopleSoft Node Configuration page data is cleared and needs to be reentered.

See Creating a Connection to a PTF Environment.

Verify that the Default User ID for the ANONYMOUS node has, at a minimum, a PTF User role.

  1. Navigate to Integration Broker, Integration Setup, Nodes.

  2. Select the ANONYMOUS node.

  3. Note the Default User ID.

  4. Navigate to PeopleTools, Security, User Profiles, User Profiles.

  5. Select the User ID you identified in Step 3.

  6. Access the Roles tab.

  7. Verify that one of the PTF roles is present.

    See Setting Up Security.

If Integration Broker is not set up correctly, contact your Integration Broker administrator.

See Also

Administering PeopleSoft Integration Broker

Click to jump to top of pageClick to jump to parent topicSetting Up Security

Users connecting to a PTF test environment must have one of these roles associated with their user ID:

This table details the privileges associated with the PTF security roles:

Privilege

PTF User

PTF Editor

PTF Administrator

Run Tests

Yes

Yes

Yes

Create, Modify, and Delete Tests

No*

Yes

Yes

Create, Modify, and Delete Test Cases

Yes

Yes

Yes

Create or Modify Execution Options

No

No

Yes

Use Log Manager

No

No

Yes

Define Configuration Options

No

No

Yes

Create Test Maintenance Reports

No

No

Yes

Create Test Coverage Reports

No

No

Yes

*PTF User can create, modify, and delete tests only in myFolder.

Modify Test includes these actions:

Note. The Default User ID for the ANONYMOUS node must have, as a minimum, a PTF User role.

If PTF security is not configured properly ou may receive the following error when signing on the the PTF client:

Signon error message

Possible causes and solutions for this error are:

See Also

Administering User Profiles

Defining PTF Configuration Options

Creating Test Maintenance Reports

Creating Test Coverage Reports

Click to jump to parent topicConfiguring the Web Profile

Configure the PeopleSoft application you are testing to generate HTML for testing.

  1. Navigate to the PeopleTools, Web Profile, Web Profile Configuration.

  2. Select the profile name for your environment. (This is the web profile that was selected during web server installation.)

  3. Click the Debugging tab.

  4. Check the Generate HTML for Testing checkbox.

    If this option is not selected PTF will not record HTML objects correctly.

  5. Check the Show Connection & Sys Info checkbox.

    If this option is not selected PTF will not record menu, component, and page metadata correctly.

Click to jump to parent topicDefining PTF Configuration Options

This section discusses the page used to configure PTF options.

Click to jump to top of pageClick to jump to parent topicPage Used to Define Configuration Options

Page Name

Definition Name

Navigation

Usage

Configuration Options

PSPTTSTCONFIG

PeopleTools, Lifecycle Tools, Test Framework, Define Configuration Options

Specify whether to allow untrusted SSL certificates.

Click to jump to top of pageClick to jump to parent topicDefining Configuration Options

Access the Configuration Options page (PeopleTools, Lifecycle Tools, Test Framework, Define Configuration Options).

Allow Untrusted SSL

Select to allow untrusted SSL certificates.

Use Page Prompt

Select to use Page Prompt and PromptOK steps during recording in place of menu navigation. The Use Page Prompt option is also available on the PTF Test Recorder toolbar. The option selected here is the default for all users in this environment. The option selected on the PTF Test Recorder toolbar overrides this selection for that recording session.

See PagePage.

Use Message Recognition

Select to automatically create entries for the Message Recognition feature during recording. The Use Message Recognition option is also available on the PTF Test Recorder toolbar. The option selected here is the default for all users in this environment. The option selected on the PTF Test Recorder toolbar overrides this selection for that recording session.

Process Server List

Add process server names to the list that can be selected in Execution Options.

See Configuring Execution Options.

If you receive the following error message, select the Allow Unstrusted SSL checkbox if you want to enable PTF to connect without a trusted SSL certificate:

Error Message: PTF is trying to do a connection with Untrusted SSL Certificate.

Click to jump to parent topicInstalling 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.

Click to jump to top of pageClick to jump to parent topicVerifying 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 v3.5.

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

  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).

Click to jump to top of pageClick to jump to parent topicConfiguring 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 Tools, 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://rtdc79614vmc.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:

Microsoft Internet Explorer Local intranet dialog box

Click to jump to top of pageClick to jump to parent topicInstalling 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:

Click to jump to top of pageClick to jump to parent topicCreating 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:

    rtdc79614.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://rtdc79614vmc.dsi-inet.peoplesoft.com:443/PSIGW/HttpListeningConnector

    Use Proxy

    Select this field if using a proxy server.

    When you select this checkbox 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.

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:

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:

Signon error message

Possible causes and solutions for this error are:

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

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.

Untrusted SSL Certificate error message

See Defining PTF Configuration Options.

Click to jump to top of pageClick to jump to parent topicSelecting 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.

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.

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.

Click to jump to top of pageClick to jump to parent topicConfiguring 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.

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.

Click to jump to top of pageClick to jump to parent topicConfiguring 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.

Click to jump to parent topicConfiguring Execution Options in PTF Client

You can define execution options either in the PTF client or using the Define Execution Options page in the PeopleSoft Internet Architecture.

This section describes how to define execution options in the PTF client.

In the PTF client, available execution options are listed in the left pane of the Execution Options dialog. The settings for the selected execution option are in the right pane.

These buttons are available on the toolbar:

Click to add a new execution option.

Click to remove an execution option from the list.

Click to save changes and close the dialog box.

Click to close the dialog box without saving changes.

The following fields are on the Options tab:

Name

Enter a name for this execution option. You can use any name.

Prompt for Options

Specify whether the Execution Options dialog box should appear when a user executes a test.

Application

URL

Enter the URL for the PeopleSoft application to be tested.

User

Enter a valid user name for the application database.

Password

Enter the login password for the user.

Process Server

Select a process server from the drop-down list. This list is populated by the Process Server List field in the Configuration Options page.

See Defining Configuration Options.

Date Format

Select a date format.

Output

LogFolder

Select or enter the folder name to which logs will be written. If the folder does not exist it will be created.

Verbose

Specify whether to use verbose logging.

Select Yes to log a detail line in the log for each step executed in the test.

Select No to log only the test rollup status (Pass or Fail) at the test level and to log a detail line for failed steps.

Debugging

Skip PageSave

Select Yes to prevent a test from executing a save. You would, for instance, select this option to avoid duplicate values in the application database if you plan to run a test repeatedly.

Skip RunRequest

Select Yes to prevent the test from executing process requests.

Advanced Options Tab

This example shows the Execution Options dialog - Advanced Options tab in the PTF client:

The Advanced Options tab supplies the information required to connect to multiple portal URLs and to enable persistent variables.

The following fields are on the Advanced Options tab:

PeopleTools Tab

This example shows the Execution Options dialog - PeopleTools tab in the PTF client:

The PeopleTools tab supplies the information required to connect to DataMover.

The following fields are on the PeopleTools tab:

Tools Path (PsHome)

Enter the path to PS_HOME for this environment.

Connection Type

Select the connection type.

Server Name

Enter the name of the database server.

The Server Name field is enabled only for Sybase and Informix platforms.

Database Name

Enter the name of the database for this environment.

User ID

Enter a valid database user name.

Password

Enter the password for this user.

DMS Input Path

Enter the Datamover input path.

DMS Output Path

Enter the Datamover output path.

DMS Working Path

Enter the Datamover working path.

Default Execution Option

When a user clicks the Accept button in the Execution Options dialog box, PTF stores the name of the selected execution option and uses it, by default, in subsequent test recordings and executions. A link in the lower right corner of the PTF application window displays the name of the default execution option. You can click the link to open the Execution Options dialog box.

Overriding the Default Execution Option

Use an Execution step with a Set_Options action in a shell test to override the default execution option.

See ExecutionExecution.

See Also

Use Execution Options

Click to jump to parent topicConfiguring Execution Options in PeopleSoft Internet Architecture

This section describes how to define execution options using the Define Execution Options page.

Click to jump to top of pageClick to jump to parent topicPage Used to Define Execution Options

Page Name

Definition Name

Navigation

Usage

Execution Options

PSPTTSTEXEOPTIONS

PeopleTools, Lifecycle Tools, Test Framework, Define Execution Options

Define PTF configuration options.

Click to jump to top of pageClick to jump to parent topicConfiguring Execution Options

You can also define and modify execution options through a PeopleSoft application component. Only a user with the PTF administrator role is able to access the component.

To access Execution Options, select PeopleTools, Lifecyle Tools, Test Framework, Define Execution Options.

This example shows the Execution Options component - Options page in PIA:

The fields on the Options page are the same as the fields on the Options tab in the PTF client, with the exception that you cannot modify passwords on the PeopleSoft application component.

This example shows the Execution Options component – PeopleTools page:

The fields on the PeopleTools page are the same as the fields on the PeopleTools tab in the PTF client, with the exception that you cannot modify passwords on the PeopleSoft application component.