Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

This content has been archived and is no longer being updated.

Links may not function; however, this content may be relevant to outdated versions of the product.

Configuring the framework

Updated on September 25, 2019

Ask a question or post a comment

After the Test Management Framework (TMF) is installed, there are some configuration steps you must do before you and other operators can use it to test target applications.

These steps are:

  1. Create environment records for each target test system
  2. Configure operators for TMF
  3. Configure the email account for sending email notifications when testing work is assigned
  4. Enable full-text searching
  5. Optional: Set up connectivity to PMF for bug reports from failed tests
  6. Optional: If you create your own implementation layer from the framework, update the standard model rule
  7. Optional: If this system is solely for TMF, configure the system name to reflect it is a TMF system

Step 1: Create environment records that connect TMF to the target test systems

To manage the testing of applications in Process Commander systems, TMF must connect to those target test systems. In TMF, you create environment records that provide the information that TMF needs to connect to the test systems and the applications that you want to test on those systems.

Complete the steps in TMF - Setting up connectivity to target test systems before creating environment records for those test systems.

The target system must be up and running while you complete this step.

To create an environment record connecting TMF to a target test system:

  1. Log into TMF as TestManager using password install.
  2. Select Maintain > Environment Data.
  3. Click Add. The New Environment section displays.
  4. In the New Environment section, enter a name and select the type of system. Optionally enter a description for the environment.

New Environment section

  1. Enter the URL information for the target system. If the system is using the standard URL for a Process Commander system of the form hostname:port/prweb, then select Auto Generated URL and enter the information.

    If the target system has a system URL and SOAP URL that are different from the standard form, or if the system does not have a port or a context root, select Enter URL Data Manually and enter the URL information.

Fields for URL without a port or a context root

In a demonstration, proof of concept, or other similar situations, it can be convenient to run TMF and the target test system on the same server. In that type of set up, you must specify the server's IP address as the host name in the system's environment record in TMF, and not the server name:

New environment when target system is on the same server as TMF

  1. Enter an operator ID and password.

    TMF uses this operator ID's credentials to access the target system. This operator ID must have the appropriate credentials to see the testing applications in the system and see the automated unit test cases and use case rules in those testing applications.

    Optionally, after the environment is added, you can update the application information to use different operator IDs for different applications in the same target test environment. This allows you to test multiple applications in the same test environment without having to give a single operator ID access to all of the applications. If the information for a particular application in the environment record specifies an operator ID, TMF uses that operator ID's credentials instead of the one specified at the environment level.

  2. Click Create.

    The tab refreshes and displays the Add Applications to the Environment section. At this point, you must specify at least one application in the target environment.

    At this point, if TMF cannot establish connectivity with the target test system, error messages display. Resolve the issue reported in the error message, and then click Create again to proceed.
  3. Click Add a row. The Add Applications window opens.

Add Applications window

  1. Select an application and version. Click OK to add the application and close the window, or click Add to continue adding more applications.
  2. When you are finished adding the applications to be tested from the target system, click Save Environment. Then click Saveto save the completed environment record.

    The newly added environment appears in the list of environments in the Maintain Environment Data section.

  3. Repeat for each target system you want to use with TMF.

Typically after adding an environment, you customize the information about the applications (for example, what bug tracking system to use for tests in an application). For information about customizing testing application information, see Manage testing environments.

Step 2: Configure operators for TMF

Operators in the framework system include:

  • Users to whom testing tasks can be assigned (sometimes referred to as "testing resources"). For example, a typical role on a testing team is a "tester" who creates functional tests, runs them, and reports bugs about test failures.
  • Users who manage and assign testing work. For example, typically the manager of the testing team assigns specific testing work to different people on the team.
  • Users who maintain the TMF system itself (for example, the system administrator).

To configure appropriate operators for TMF:

  1. Determine who is on your testing team (testers, lead testers, managers, system administrators).
  2. Create appropriate Operator IDs for them in the TMF system.

    TMF ships with the standard Operator ID rules, with default passwords set to install (see the table below). The TMSysadmin operator can copy these Operator ID rules to use as starting points to create and configure your TMF system's users and testing resources.

  3. Log in as TestManager (or as an operator having the appropriate role and portal such as those used by the PegaTestMgmt:Manager access group)
  4. Associate specific environment records with the particular users who are to perform testing tasks on those test systems and applications.
    Every user who is to perform testing tasks and every testing team manager needs to be assigned one default environment (target system and application). Only operators having the PegaTestMgmt:Manager access role can assign environments to other users.

    To associate environment records with users, Click Maintain > Resources, select one of your operators, and click Update. Specify the environments for that operator by following the steps in Maintain Resources.

Operator ID rules shipped with TMF

If you create your own implementation layer on TMF, copy the access groups referenced by your operators and update them to reference your implementation's class group and RuleSet.

The following Operator ID rules are shipped with the framework. Passwords are set to install. These can be copied as starting points to create and configure your framework operators and test resources.

Operator IDFull Name (in Operator ID)Access GroupTeam role
TestManagerTest ManagerPegaTestMgmt:ManagerAssigns and manages testing tasks and resources
LeadTesterLead TesterPegaTestMgmt:LeadTesterTeam leader of testing team, performs testing assignments
Tester1Q.A. TesterPegaTestMgmt:TesterTester, performs testing assignments
TMSysadminTest Mgmt Sys AdministratorPegaTestMgmt:DevSystem administration using the Designer Studio

Related V6.1 SP1 help topics:About Operator ID data instances; About Access Group data instances

Step 3: Configure the email account for sending email notifications

TMF uses an email account data instance named PegaTestMgmt-Execution.Notify as to send email notifications to testing resources when new work is assigned to them. To successfully use this feature, update the PegaTestMgmt-Execution.Notify instance with your organization's appropriate email account and address information. This account is used as the sender's account ("From:" account) when the system sends the email notification to the testing resource.

Before you begin, gather the following information:

  1. The IP address or domain name of your email server.
  2. The email account (email address and password) that TMF is to use to send these emails.
  3. Whether the host is configured to use Secured Socket Layer (SSL).

To configure the email account:

  1. Log into TMF as TMSysadmin, or as an operator having the appropriate role and portal, such as those used by the PegaTestMgmt:Dev access group.
  2. In the Designer Studio, open the Outbound Email gadget by clicking Pega button> Integration > Email > Outbound Email.
  3. Open the rule for the PegaTestMgmt-Execution.Notify email account.

Open PegaTestMgmt-Execution.Notify account from Outbound Email gadget

  1. In the Email Account form, specify the appropriate values for your email system. If your email system uses Secured Socket Layer, select Secure.

Email Account form

It is a best practice to use the same email address in the Email Address and Reply To fields. Otherwise, if they do not match, the message might be flagged as spam or junk mail by the recipient's email server.

  1. Save your changes.
  2. To test the connectivity of this account, click the Test Connectivity button.

Step 4: Enable full-text searching

The framework uses the Lucene full-text search to enable users to search for test-related items by text string.

For information about enabling the full-text search, see the help topic: Understanding full-text search. Follow the steps outlined in the "Allowing users to search work objects" section of that help topic.

Step 5: Optional: Set up connectivity to PMF for bug reports from failed tests

If you have installed the Project Management Framework (PMF), you can configure TMF to enable your testers to use PMF to assign and track bug records when they perform their testing assignments. First you create an environment record for PMF and then you update the environment records for those applications with which you want to associate PMF for bug tracking.

To configure TMF to use PMF as a bug tracking system in application testing

  1. Log into TMF as TestManager, or as an operator with the appropriate access role and portal, such as those used by the PegaTestMgmt:Manager access group.
  2. Click Maintain > Environment Data, and then add an environment record for PMF, selecting Bug Tracking as the Type. See Step 1 in this article, and Manage testing environments.
  3. Select the environment record for a target system that has applications with which you want to use PMF for bug tracking and click Update.
  4. Select an application and click Update. The Update Application Version window displays.
  5. In the Bug Tracking System field, select PMF.
  6. Click Save to save the updated application record.
  7. Repeat steps 3 through 6 for each testing application where you want to report bugs found during testing to your PMF system.

Step 6: Optional: If you create your own implementation layer from the framework, update the standard model rule

The framework uses a model rule named ImplementationSettings to default values for properties that are universally applied to work throughout a project lifecycle. These properties define the work classes and work prefixes used to create and manage your projects.

If you create an implementation layer, modify the model rule:
  1. Locate the ImplementationSettings model rule and save a copy to your RuleSet.
  2. Update the values as appropriate for your implementation. For example, if you want a different prefix for test suites, you might change the default STE- value to SUI-.
  3. Save your model rule.

ImplementationSettings model rule

Related help topic: About Model rules

Step 7: Optional: If this system is solely for TMF, configure the system name to reflect it is a TMF system

If your organization has multiple Process Commander systems, giving each a unique name to reflect what it is used for can be helpful to system administrators who have to maintain those systems. If TMF is the only framework installed in this Process Commander system, you can configure the system name to reflect it is for TMF.

For information on how to change the system name, see the help topic: When and how to change a system name.

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us