Workflow Naming Standards

TLP:AMBER - Limited disclosure, recipients can only spread this on a need-to-know basis within their organization and its clients. Recipients may share TLP:AMBER information with members of their own organization and its clients, but only on a need-to-know basis to protect their organization and its clients and prevent further harm 

Why is consistent naming important?

Consistent naming of workflows in a process automation platform is vital for maintaining clarity, efficiency, and overall effectiveness within an organization. It acts as a fundamental organizational tool, allowing employees to quickly identify and comprehend the purpose and scope of a workflow, thereby reducing confusion and streamlining operations. This consistency is especially crucial in environments such as Rewst where multiple workflows are developed for different purposes or clients, as it ensures that every team member, regardless of their department or level of technical expertise, can easily navigate and understand the workflow landscape.

 

Naming Best Practices

1. Prefix with Organization Name

  • Format: [OrganizationName]
  • Application: Each workflow must be prefixed with the name of the organization it is developed for, enclosed in square brackets.
  • Example: [eTop] Workflow Name

2. Descriptive Naming

  • Requirement: Workflow names must concisely yet accurately describe the function and purpose of the workflow.
  • Guidelines:
    • Use clear and simple language.
    • Avoid technical jargon unless it is widely understood within the organization.
    • Include verb-noun combination that indicate the action performed by the workflow.
      • For example, "Get Users" or "Update Mailbox Property"
      • This is similar to the naming guidelines for PowerShell modules

3. Indicating Master Workflows

  • Identifier: MASTER
  • Application: Append the term "MASTER" at the end of the name for top-level workflows that orchestrate subworkflows.
  • Example: [eTop] Data Sync MASTER

4. Version Control and Updates

  • Inclusion of Version: Where applicable, include a version number at the end of the workflow name.
  • Format: V[number]
  • Example: [eTop] User Onboarding V2
  • Guidelines:
    • Be careful not to leave multiple duplicate workflows that will not be used. If a later version workflow is put into production as a replacement to another, consider archiving the initial workflow and removing the version from the new workflow, ensuring there is no confusion over which one to use

5. Length and Readability

  • Maximum Length: Workflow names should not exceed 30 characters, including the organization prefix and version numbers.
  • Clarity: Ensure the name remains readable and understandable, even with length constraints.

6. Special Characters and Case Sensitivity

  • Allowed Characters: Use only alphanumeric characters and underscores.
  • Case Sensitivity: Workflow names should be in Camel Case for better readability.
  • Example: [eTop] Invoice Processing

7. Categories and Sub-Categorization

  • Categorization: Where applicable, include a category or sub-category prefix.
  • Example: [eTop]HR_Onboarding Process

 

Compliance and Review

  • Responsibility: It is the responsibility of the workflow creator and the respective team lead to ensure compliance with this naming policy.
  • Regular Review: This policy should be reviewed annually or as needed to adapt to organizational changes.