Error Management Process

Overview: BizFirst maintains a centralized error management system that allows developers to define, document, and troubleshoot standard errors across all products. Every error code gets a dedicated page in the public documentation portal.

The Error Management Workflow

The process consists of three main stages:

1. Define Errors

Create error codes with categories, error codes, and descriptions. Supports 100,000+ codes per product.

2. Document

Write comprehensive error documentation with solutions.

3. Publish

Publish to the portal and make available via public URL.

4. Pick Code

Step-by-step quick reference to pick new error codes systematically.

5. Scalability

Understand the hierarchical structure supporting 900,000 total codes.

Key Concepts

Error Code Format

All error codes follow this naming convention:

Error-{PRODUCT}-{NUMBER}
Example: Error-FlowStudio-100090

Components:

{PRODUCT} — Name of the application (e.g., FlowStudio, AppStudio, ProcessEngine)
{NUMBER} — Unique numeric identifier (typically 5-6 digits)

Public URL Mapping

Documentation is published to the community portal:

Local path: C:\BizFirstGO_FI_AI\UserGuides\docs\WebSites\ErrorCodes\
Public URL: docs.BizFirst.com/WebSites/ErrorManagement/ErrorCodes/Error-{PRODUCT}-{NUMBER}.html

Who Can Create Error Codes?

Any BizFirst or community developer can define and debug standard errors. This distributed approach ensures errors are documented close to where they're implemented.

Directory Structure

UserGuides/docs/WebSites/
├── ErrorManagement/
│   ├── Process/           ← You are here
│   │   ├── index.html
│   │   ├── 01-defining-errors.html
│   │   ├── 02-documentation.html
│   │   └── 03-publishing.html
│   └── ErrorCodes/
│       ├── Index.html
│       ├── Error-FlowStudio-100090.html
│       └── Error-AppStudio-200001.html
└── index.html

Quick Start Checklist

Read Defining Errors to understand error code structure
Follow Documentation template for error pages
Use Publishing steps to make errors public