Naming conventions in Enterprise 11
- Updated: 2022/08/10
Naming conventions in Enterprise 11
Review the capitalization and spacing styling in names.
Use bumpyCasing for variables and CamelCasing for task names.
-
CamelCase—The practice of writing compound words or phrases where each
word or abbreviation begins with a capital letter. For example
PrintUtility
. -
bumpyCase—The same, but always begins with a lower letter. For example
backgroundColor
.
The following is a list of naming restrictions:
- Do not use underscores—Underscores waste space and do not provide any value in these contexts. Readability can be achieved by using Bumpy Casing and Camel Casing.
-
Consistent values and flags—Always use lowercase Boolean values
"true"
and"false"
. Do not deviate; use this method of defining a Boolean state. This also applies to flags. Always use"true"
or"false"
for Boolean variables; never a 0 or 1 or anything else. -
Variable names—Do not include numbers in variable names.
Avoid single character variable names. Never use
i
orx
for example. Use a variable name that provides some clue about the variable purpose. -
Flag and Script names—Name flags with Is, Has, Can, Allows or Supports,
such as
isAvailable
,isNotAvailable
,hasBeenUpdated
.Name scripts with a noun, noun phrase, or adjective such as Utility or Helper—for example
FileSaveHelper.atmx
. -
Pre-fixed fields—Do not prefix fields. For example, do not use
g_
ors_
or just_
.Exception is the letter
v
as a prefix in order to make finding variables easier. -
Verb-object naming—Also use verb-object pairs when naming scripts such as
GetMostRecentVersion
.Name variables with a descriptive name such as
employeeFirstName
orsocialSecurityNumber
. - Restricted words—Do not use reserved keywords such as Automation Anywhere or Automation Anywhere Files to name folders. If you name a folder using these reserved keywords and reference a file saved under this folder in your bot, you will encounter an error while running the bot.