Вы находитесь на странице: 1из 8

Worksoft Certify

Best Practices
Naming Conventions

December 2016

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

Version Control Record


Version Date Author Description of Change
1 3/24/2009 P.Rice Bringing document up to date
2 02/23/2010 R. Page Added process naming
conventions for CRM/Web/HR
3 0323/2010 P.Rice Added additional naming
standards for integrated tests
and HR specific
4 05/17/2010 T.Morello Corrected syntax and
structure of document
5 12/21/2010 S.Carroll Added syntax for having
identical variables (from a
table or grid) that are not
duplicates for comparison
purposes. (Page 3).
6 4/7/2011 P.Rice Updated the process sub
process naming standard.
7 4/17/2013 P.Rice Updated standards

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


www.worksoft.com • 866-836-1773
Best Practices Naming Conventions

Specific Naming conventions

Naming Conventions for Variables

 Named same as the field it represents

Format: Variable names will closely resemble field names

Example: OrderType
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 (ex: Req. deliv.date), 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, to compare values, 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

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


www.worksoft.com • 866-836-1773
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

Human Resource Design

Info type Addition to Naming Convention:


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 ( _ )

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


www.worksoft.com • 866-836-1773
Best Practices Naming Conventions

 Remove spaces from descriptions and capitalize the first letter of each
word
 Integrated Processes only contain 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 an
identifier

Format: Layout Name = Process’ 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 new 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

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


www.worksoft.com • 866-836-1773
Best Practices Naming Conventions

Secondary Layout Name = MM01_CreateMasterData_3rdPartyData

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


www.worksoft.com • 866-836-1773
Best Practices Naming Conventions

Recordsets

 Recordset names will, in most cases, match the client’s test case or test
scenario name.
 Any number of recordsets are possible for any given test

Format: Test Case Name_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_TestCase001_Europe
Recordset Name = O2C_ShipBill_TestCase002_China

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


www.worksoft.com • 866-836-1773
Best Practices Naming Conventions

Dynamic Objects in HTML

 The Certify HTML interface allows you to modify an individual object’s


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 needed. This is especially helpful for
objects (such as HTML_Links) that are dynamic in nature and which could
change based on content or updates. In such a case, we would create a
single HTML_Link object under the 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 the 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>…

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


www.worksoft.com • 866-836-1773

Оценить