Worksoft Certify

Best Practices
Naming Conventions
February 2017

Worksoft, Inc. • 15851 Dallas Parkway, Suite 855 • Addison, TX 75001

www.worksoft.com • 866-836-1773

Version Control Record
Version Date
1 3/24/2009
2 02/23/2010
3 0323/2010
4 05/17/2010
5 12/21/2010
6 4/7/2011
7 2/22/2017
Best Practices
Naming Conventions
Author Description of Change
P.Rice Bringing document up to date
R. Page Added process naming conventions
for CRM/Web/HR
P.Rice Added additional naming standards
for integrated tests and HR specific
T.Morello Corrected syntax and structure of
document
S.Carroll Added syntax for having identical
variables (from a table or grid) that
are not duplicates for comparison
purposes. (Page 3).
P.Rice Updated the process sub process
naming standard.
R. Hahn Refresh of document to include folder
structure convention

2017 Worksoft, Inc. All rights reserved. Worksoft and Worksoft Certify are registered trademarks of
Worksoft, Inc. All other marks are property of their respective owners.
Page 2 of 10
 Best Practices
Naming Conventions

Table of Contents
Definition .................................................................................................................................... 4
Purpose ..................................................................................................................................... 4
Worksoft Naming Standards and Best Practices ........................................................................ 4
Conventions for Worksoft Elements ........................................................................................... 5
Variables ..................................................................................................................................... 5
Transaction Code/Component or Unit Test Process ................................................................... 5
SAP Human Resource Info Types .............................................................................................. 6
Integrated or End to End Test Process ........................................................................................ 6
Data Layouts ............................................................................................................................... 6
Recordsets ................................................................................................................................... 7
Dynamic Objects in HTML ........................................................................................................ 8
Conventions for Folder Structures .............................................................................................. 9
Processes ..................................................................................................................................... 9
Sub Processes (t-codes/components) .......................................................................................... 9
Utilities...................................................................................................................................... 10

2017 Worksoft, Inc. All rights reserved. Worksoft and Worksoft Certify are registered trademarks of
Worksoft, Inc. All other marks are property of their respective owners.
Page 3 of 10
 Best Practices
Naming Conventions

Definition
In the Worksoft Automated Testing methodology, a naming standard is the set of rules governing
the character sequence to be used for identifiers of things like processes, variables, record sets,
folders, and other entities used in the Worksoft Certify test automation tool set.

Purpose
A good naming standard helps to create order and reduce confusion. When working in a shared
environment like the one we use for Certify, the use of consistently structured names greatly
reduces confusion. With multiple individuals re-using Certify entities, the ability to glance at the
name and quickly determine the true content or functionality is crucial as it greatly reduces the
likelihood of confusion.

Using Certify will result in an inventory of multiple testing assets. In many situations the
creators of the original test assets will not be the same as those tasked with maintaining them.
The use of naming standards will make it significantly easier for subsequent generations of
Quality Analysis analysts and developers to understand what the Certify processes are doing and
how to fix or re-use the processes for new business testing needs.

The use of a standard naming convention when using Certify will help group and categorize
testing assets, thereby simplifying and speeding up the tasks of sorting, searching and reporting.
Worksoft Naming Standards and Best Practices
The Certify naming best practices are intended to cover all Certify entities including processes,
sub-processes (t-codes/components), data layouts, record sets, variables, as well as the folder
structures in which they are stored.

2017 Worksoft, Inc. All rights reserved. Worksoft and Worksoft Certify are registered trademarks of
Worksoft, Inc. All other marks are property of their respective owners.
Page 4 of 10
 Best Practices
Naming Conventions
Conventions for Worksoft Elements
Variables
 Variables are the containers that hold data as a business process is being executed and
reflect the fields where data are being entered or displayed on a transactional or web
page. Variables should reflect the name of the field as they are displayed on the screen.
In most cases variables already exist which allow you to pull the variable directly from
the variable folder (just make sure it is the correct type like text versus numeric). You
should only create variables as a last resort for items that do not exist. For example, if
your screen name is Company Code you can use an existing variable called Company or
Company Code, whichever exits. Creating variables at random and not using existing
variables can cause a bloated mess in the variable folder(s) and make it difficult to debug
the processes you are creating. You should never create folders for variables as this leads
to confusion due to multiple variables with the same name and other maintenance
headaches.

• Named same as the field it represents

Format: Variable names will closely resemble field names

Example: Order Type

Ship-to party
Exp.date (Ex: if field is “Expiration Date” then make use of Exp. Date
rather than create a new variable

• If a field needs more than one variable, then delimit the variable with a _VariantName

Example: Req. deliv.date_Format Type

Req. deliv.date_Date

• If a variable needs to be assigned more than one value at the same time, for example for
comparison purposes, then the same variable name should be used with a ‘#’ to indicate that
it indeed is a necessary variable and not a duplicate of an existing variable.

Example: Customer#1 is not equal to Customer#2 (from a table or grid).

Transaction Code/Component or Unit Test Process

• Transaction codes (Tcodes) or components are capitalized
• Separate descriptions by an underscore ( _ )
• Remove spaces from descriptions and capitalize the first letter of each word
2017 Worksoft, Inc. All rights reserved. Worksoft and Worksoft Certify are registered trademarks of
Worksoft, Inc. All other marks are property of their respective owners.
Page 5 of 10
 Best Practices
Naming Conventions

Format: TCode_Description1_Description2_Description3
Component_ComponentDescription

Example: VA01_CreateStandardOrder_SingleItem
Example: VA01_CreateContractOrder_MultipleItems
Example WebOrder_SelectionPane

If a process uses a child process to work with a multi-element object such as a table or
grid it should be extended with the parent process name +, _C , + additional description.

Example: VA01_CreateContractOrder_MultipleItems
Example: VA01_CreateContractOrder_MultipleItems_C _TableInput

SAP Human Resource Info Types

For transactions that encapsulate functionality (for example HR transactions such as PA30 and
PA40), it is best to subdivide processes further than the transaction level. For HR transactions,
the use of Info Types is recommended for naming and defining processes. HR processes may
also be grouped by Country or State (e.g. CA for Canada or CA for California).

Format: Transaction_IT<ITypeNumber>_<InfoTypetext>_<Country or State>

Examples:
PA40_IT0068_GarnishmentCompensation_CA
PA40_IT0068_NewInitialBalance
PA40_IT0071_PensionFunds_GB

Integrated or End to End Test Process

• Separate Test names and descriptions by an underscore ( _ )
• Remove spaces from descriptions and capitalize the first letter of each word
• Integrated Processes contain only calls to other processes and Comments.

Format: ApplicationArea_Description1_Description2_Description3

Example: O2C_ShipBill_ConstantQuote
CRM_CustomOrder_ProcessThroughSAP
WebOrder_FromBrowser_ToSAP_ToMainframe

Data Layouts
• Named exactly as the Process Name
• Variant Layouts will have the same name as the Process name plus identifier
2017 Worksoft, Inc. All rights reserved. Worksoft and Worksoft Certify are registered trademarks of
Worksoft, Inc. All other marks are property of their respective owners.
Page 6 of 10
 Best Practices
Naming Conventions

Format: Layout Name = Processes Name (not test case name)

Example: Process Name = VA01_StandardOrder

Layout Name = VA01_StandardOrder

Process Name =MM01_CreateMasterData

Layout Name = MM01_CreateMasterData

Example: Integrated Test Name = O2C_ShipBill_ContractQuote

Layout Name = O2C_ShipBill_ContractQuote

• Highlight the Certify Process name while in the process data editor, then use the copy
function. When creating the record layout paste the copied process name into the layout
name field.
• Provide a description if needed
• Most Certify processes have only one layout associated with it. However there may be a need
to have more than one. In this case use the same name as the original layout and add a variant
identifier

Example: Process Name = MM01_CreateMasterData

Primary Layout Name = MM01_CreateMasterData
Secondary Layout Name = MM01_CreateMasterData_3rdPartyData

Recordsets
• Named exactly as the Process Name
• Any number of recordsets are possible for any given test

Format: Process name and purpose

Example: Process Name = VA01_StandardOrder

Layout Name = VA01_StandardOrder
Recordset Name= VA01_StandardOrder_InternationalCustomers
Recordset Name= VA01_StandardOrder_NationalCustomers

Example: Integrated Test Name = O2C_ShipBill_ContractQuote

Layout Name = O2C_ShipBill_ContractQuote
Recordset Name=O2C_ ShipBill_ContractQuote _Europe
Recordset Name=O2C_ ShipBill_ContractQuote _China

2017 Worksoft, Inc. All rights reserved. Worksoft and Worksoft Certify are registered trademarks of
Worksoft, Inc. All other marks are property of their respective owners.
Page 7 of 10
 Best Practices
Naming Conventions

Dynamic Objects in HTML

• The Certify HTML interface allows you to modify individual objects attributes to dynamic
via a placeholder. This allows the object to be found or indentified at run time by telling the
HTML interface to substitute the placeholder with the actual value we are looking for. This
is especially helpful for objects (such as HTML_Links) that are dynamic in nature; could
change based on content or updates. In such a case we would create a single HTML_Link
object under that mapped web page that contains the link name REPLACEME. A line in
Certify would then use the Set Attribute action against that object to replace REPLACEME
placeholder with the actual link text (example: Set Attribute | Replace REPLACEME | News
FEED)

• Name the object using a generalized name rather than a specific name +
(REPLACEME=inner text)
Example: Dynamic Link (REPLACEME=inner text)
Example: Dynamic Window (REPLACEME=caption)

• Name the placeholder in that object REPLACEME (all capital letters)

Example: Original Object Attributes:
…<V criteria=”contains”>News Feed</V>…
Example: Modified Object Attributes
…<V criteria=”contains”>REPLACEME</V>…

2017 Worksoft, Inc. All rights reserved. Worksoft and Worksoft Certify are registered trademarks of
Worksoft, Inc. All other marks are property of their respective owners.
Page 8 of 10
 Best Practices
Naming Conventions

Conventions for Folder Structures

Successful metric reporting via our development and execution dashboard products relies on a
solid and consistent folder structure within Certify. Without this structure, metric reporting will
be flawed and the possibility of co-mingling of test assets across multiple environments may
occur (production support vs project). Worksoft can provide tools and training to assist in
defining appropriate folder structures to reflect organization and testing areas.

Processes
For example, the folder name for Order to Cash integrated business processes in Certify would
be defined as (OTC) Order to Cash. The ‘OTC’ acronym will be used in naming all Order to
Cash processes stored under this folder…i.e. OTC_StandardOrder_MultipleLineItems. This
reflects the use of the folder structure acronym while supporting a strong definition for the
process. Following this procedure makes it easy to find the process will reside within the (OTC)
Order to Cash folder.

Certify Process Folder Structure

Sub Processes (t-codes/components)

Transactional or unit tests (sub process) which makes up the integrated test follows a similar
standard. The folder name reflects the acronym for the SAP application area against which the
transactional or unit tests are written. A folder which contains unit tests written for SAP
manufacturing execution transactions would be labeled ‘ME’. Using these acronyms we start all
transactional processes with the acronym and an underscore (_). SAP’s Create Purchase Order
transaction is ME21N and could represent many types of purchase orders. Following our
naming convention we would name a standard purchase order process
ME21N_StandardPurchaseOrder and store it in the ‘ME’ file folder.

2017 Worksoft, Inc. All rights reserved. Worksoft and Worksoft Certify are registered trademarks of
Worksoft, Inc. All other marks are property of their respective owners.
Page 9 of 10
 Best Practices
Naming Conventions
Sub-Processes (t-codes/components)

Utilities
Utilities are sub processes that can be used by many different business processes. They can be routines
related to dates, financial processes, clean up, and conversion routines. This is a small sampling of
utilities that already exist within Certify for your use. All utilities start with UTL_ followed by a
descriptor showing what it is used for. An example is UTL_ConvertDatetoJulianFormat. This would
convert a standard date format to Julian.

Utility Folder Structure

2017 Worksoft, Inc. All rights reserved. Worksoft and Worksoft Certify are registered trademarks of
Worksoft, Inc. All other marks are property of their respective owners.
Page 10 of 10