Workato Naming Convention Best Practices
Maintaining a standard naming convention in Workato is key to an organized workspace and easy asset retrieval. While each Workato instance may have unique needs, establishing consistent rules provides a reliable foundation that you can customize as required.
Naming Convention Example
[MK]-MITF-FCT-03 > Update Lead in Marketo
How the Naming Convention Works
This naming structure includes five essential components:
- Department
- Project ID
- Asset ID
- Order ID
- Description
Department
Each department is identified by a two-letter ID enclosed in brackets, like [MK] for Marketing. Here’s a table of example department codes:
| Department ID | Department Name |
|---|---|
| CS | Customer Service |
| FI | Finance/Accounting |
| GN | General |
| HR | Human Resources |
| IT | Information Technology |
| LG | Legal |
| MK | Marketing |
| SC | Supply Chain |
| SL | Sales |
Project ID
Use a four-letter code to group related recipes and connections within a project. For example, MITF could stand for "Marketo Instance Transfer Flow." Keep documentation of assigned project IDs to prevent duplicates.
Asset ID
The asset ID indicates the type of asset (e.g., trigger, webhook, or function). Here are some suggested asset codes:
| Asset ID | Asset Name |
|---|---|
| API | API recipe |
| APP | Workato APP |
| BOT | Workbot |
| FCT | Function recipe |
| TRG | Triggered by App |
| WBH | Webhook recipe |
Order ID
Using an order ID clarifies the sequence within a process, such as the third step in a lead update workflow. Order IDs are helpful for identifying the role of each recipe in a sequence.
Description
The description provides context for the recipe, separated by a ‘>’ symbol. For example, "Update Lead in Marketo" provides clarity about the recipe’s purpose.
Naming Convention Document
For ease of use, refer to this Google Sheet with formulas and lookups to help maintain consistent naming conventions.