Error Code Picker — Quick Reference
Step-by-step guide to pick and create new error codes.
Purpose: Quick reference for developers to systematically pick new error codes from 100,000 available codes per product.
Step 1: Identify Your Product (100,000 codes each!)
Each product has 100,000 error codes available. Choose your product:
| Product | Range | Available |
|---|---|---|
| FlowStudio | 100000-199999 |
100,000 codes |
| AppStudio | 200000-299999 |
100,000 codes |
| AtlasForms | 300000-399999 |
100,000 codes |
| Octopus | 400000-499999 |
100,000 codes |
| Passport | 500000-599999 |
100,000 codes |
| WorkDesk | 600000-699999 |
100,000 codes |
| BizFirstObserve | 700000-799999 |
100,000 codes |
| EdgeStream | 800000-899999 |
100,000 codes |
| Custom/Integration | 900000-999999 |
100,000 codes |
Step 2: Choose Feature Area (10,000 codes per feature)
Use the second digit to organize features. Each feature gets 10,000 codes.
FlowStudio Example (100000-199999):
🔄 Execution
100000-109999
10,000 codes
📦 Nodes
110000-119999
10,000 codes
🎨 Canvas
120000-129999
10,000 codes
📊 DataBinding
130000-139999
10,000 codes
🔒 Security
140000-149999
10,000 codes
💾 Store/State
150000-159999
10,000 codes
🔗 Integration
160000-169999
10,000 codes
📈 Observability
170000-179999
10,000 codes
⚙️ Configuration
180000-189999
10,000 codes
🔖 Reserved
190000-199999
10,000 codes
Step 3: Identify Sub-Category (within 1,000-code feature block)
Each feature block has 1,000 codes organized by error type:
| Range (within feature) | Error Type | Example (Execution) |
|---|---|---|
XX0000-XX0099 |
Validation/Input | 100000-100099 |
XX0100-XX0199 |
Execution/Runtime | 100100-100199 |
XX0200-XX0299 |
Data/Binding | 100200-100299 |
XX0300-XX0399 |
State/Store | 100300-100399 |
XX0400-XX0499 |
Permission/Security | 100400-100499 |
XX0500-XX0599 |
Configuration | 100500-100599 |
XX0600-XX0699 |
Integration/API | 100600-100699 |
XX0700-XX0799 |
UI/Presentation | 100700-100799 |
XX0800-XX0899 |
Resource/Performance | 100800-100899 |
XX0900-XX0999 |
Miscellaneous/Other | 100900-100999 |
Step 4: Find Next Available Number
Method A: Quick Commands
# Find highest number in your product
grep -r "Error-FlowStudio-" src/ packages/ | \
grep -o "[0-9]\{6\}" | sort -n | tail -1
# List all errors for your product (sorted)
ls ErrorManagement/ErrorCodes/Error-FlowStudio-*.html | sort -V
Method B: Check Error Index
- Open:
ErrorManagement/ErrorCodes/Index.html - Find your product section
- See "Next Available" number (automatically updated)
Method C: Manual Verification
- Open:
C:\BizFirstGO_FI_AI\UserGuides\docs\WebSites\ErrorManagement\ErrorCodes\ - List files:
ls Error-FlowStudio-*.html | sort -V - Scan the highest numbers
- Add 1 → That's your new code
Step 5: Validate Uniqueness
# Check if this code already exists
grep -r "Error-FlowStudio-100091" .
# Should return: No matches
# Check documentation
ls ErrorManagement/ErrorCodes/Error-FlowStudio-100091.html
# Should return: No such file
Step 6: Create Your Error Code
In Your Code
TypeScript/JavaScript:
const errorCode = 'Error-FlowStudio-100091';
throw new Error(`[${errorCode}] Description of what went wrong`);
console.error(`[${errorCode}] Additional context here`);
C#:
const string errorCode = "Error-FlowStudio-100091";
throw new ApplicationException($"[{errorCode}] Description of what went wrong");
Format Rules
✓ GOOD: Error-FlowStudio-100091
✗ BAD: error-flowstudio-100091
✗ BAD: Error_FlowStudio_100091
✗ BAD: ErrorFlowStudio100091
Step 7: Create Documentation Page
File Location:
C:\BizFirstGO_FI_AI\UserGuides\docs\WebSites\ErrorManagement\ErrorCodes\
Error-FlowStudio-100091.html
Use Template: Copy from Error-FlowStudio-100090.html and customize
Step 8: Update Master Index
File Location:
C:\BizFirstGO_FI_AI\UserGuides\docs\WebSites\ErrorManagement\ErrorCodes\
Index.html
Add new error card to your product section.
Step 9: Commit Your Changes
git add:
- src/.../your-file-with-error-code
- UserGuides/docs/WebSites/ErrorManagement/ErrorCodes/Error-FlowStudio-100091.html
- UserGuides/docs/WebSites/ErrorManagement/ErrorCodes/Index.html
git commit -m "Add Error-FlowStudio-100091: Brief description"
Final Checklist
Common Mistakes
❌ Avoid:
- Inconsistent formatting (underscores instead of hyphens)
- Reusing existing error codes
- Non-sequential numbering
- Code without documentation
- Documentation without index update
✓ Do:
- Follow the pattern:
Error-{Product}-{Number} - Check existing codes first
- Document immediately after creating
- Update index at the same time
- Commit code + docs together