Workflow Naming Convention
Essential knowledge
Author:
Fluent Commerce
Changed on:
24 Oct 2023
Overview
The Workflow Naming Convention is a set of guidelines recommended for Orchestrated Entity Types in the Fluent Order Management System. This convention will help you:
- Apply best practices for naming entities to achieve better implementation standards;
- Make names consistent and ensure that names are recognisable and can be supported in the future;
- Avoid unexpected system behaviour and decrease the likelihood of error because of incorrect symbol or space usage.
Key points
- The Naming Best Practice of workflow rule and ruleset.
Naming Best Practice
- Orchestrated Entities Types are named consistently
- Use intuitive, familiar terminology where possible
- Orchestrated Entities Type names should be short and descriptive (no more than 25 characters)
- Use only English characters
- Orchestrated Entities Types names are case sensitive, e.g., "CLICK_COLLECT" and "click_collect" are two different Types
- Use uppercase letters and underscores (uppercase snake) for word separation, e.g., MY_ORDER_TYPE
Not Recommended:
- Unclear, vague words or abbreviations that are not commonly understood
- Regionally specific terms and phrases can be spelled differently in different versions of English (for example, fulfillment and fulfilment)
Not Supported:
- Symbol characters: < > \ / | " ? [ ] ; = + & $ α β
- Non-English-based symbols as part of the name, e.g., ü, ä, ß
- Spaces are not supported. We recommend using underscores (_) instead, e.g., use and not
`MY_CUSTOM_TYPE``MY CUSTOM TYPE`
Example Names: Order Types
Consider the following examples when you create a new Order Type.
- - standard eCommerce order type with the home delivery method
`ONLINE_HD` - - standard eCommerce order type with the click-and-collect delivery method
`ONLINE_CC` - - orders for moving stock from store to store
`TRANSFER`
