Naming

---

Naming data

When naming data items includng Input data, Output data, Variables and Constants, the general best practice is to use nouns rather than verbs. Here's why and some additional guidelines to help you:

Why use nouns

• Clarity: Nouns clearly describe the data the item represents, making it easier to understand what kind of information the item holds.

• Consistency: Data items often represent attributes or characteristics of things (e.g., user, order, product), which are best expressed with nouns.

• Avoid ambiguity: Verbs imply actions or processes, which can create confusion about the nature of the data. Nouns make it clear that the data item contains a specific type of information.

Best practices for naming data items

• Be descriptive: Use names that clearly describe the data contained in the data item. For example, use first_name instead of name to avoid ambiguity between first and last names.

• Use consistent naming conventions: Stick to a consistent format throughout your automation. Common conventions include:

  • CamelCase (e.g., firstName)
  • snake_case (e.g., first_name)
  • PascalCase (e.g., FirstName)

• Avoid abbreviations: Unless widely understood or standardised in your organisation, avoid abbreviations that might not be immediately clear to others. For example, use EmailAddress rather than EmailAddr.

• Consider context: Include context where necessary to avoid confusion. For instance, if you have multiple fields related to an address, use names like ShippingAddress and BillingAddress.

• Be concise: While being descriptive is important, try to keep field names concise to avoid excessively long names. Strive for a balance between clarity and brevity.

• Use singular nouns: Fields generally represent single pieces of information, so use singular nouns rather than plural ones. For example, use OrderDate instead of OrderDates.

Examples

• AmountClaimed, OrderDate, ProductPrice, CustomerEmail

In summary, using nouns for data items ensures that names are descriptive, clear, and consistent. This approach makes your automation easier to understand and maintain.

Naming trigger steps

This section isn’t ready just yet—we’re working on it! Please check back soon, and if you need help right away, feel free to ask in our Community Forum.

Naming activity steps

This section isn’t ready just yet—we’re working on it! Please check back soon, and if you need help right away, feel free to ask in our Community Forum.

Naming branch steps

This section isn’t ready just yet—we’re working on it! Please check back soon, and if you need help right away, feel free to ask in our Community Forum.

Naming end steps

This section isn’t ready just yet—we’re working on it! Please check back soon, and if you need help right away, feel free to ask in our Community Forum.