Order Status Master

Order Status Master Module - User Guide

1. Introduction ๐Ÿ“

The Order Status Master module allows administrators to define the various stages that a Sales Order passes through during its lifecycle. These statuses provide real-time visibility into the order pipeline, from initial receipt to final fulfillment or cancellation.

โ„น๏ธ

In the overall business flow:

  1. It categorizes Sales Orders based on their progress (e.g., Draft, OK, Shipped).
  2. It drives Reporting Filters in order analysis and dispatch dashboards.
  3. It ensures Process Consistency by standardizing the terminology used across the sales team.

Typically, this module is managed by Sales Operations and System Administrators.


2. Getting Started with Order Status ๐Ÿš€

Accessing the Module

Navigate to the Order Status Index via the Sales Setup or Master Data menu.

The Index View

The index displays the system-generated Status Code, the Short Name, and a detailed Description for each status.


3. Features โœจ

๐Ÿ—๏ธ Customizable Lifecycle

Every business has a unique workflow. This module allows you to:

  • Define custom status names that match your internal vocabulary (Description up to 50 characters).
  • Assign short codes (up to 5 characters, e.g., OK, CLD, PND) for quick identification in dense data grids.
  • MRP Demand Flag (Consider for Mrp): Toggle Yes or No (default No) to define whether sales orders under this status should be considered active demand by the Material Requirements Planning (MRP) engine.
  • Pending Report Flag (Consider for Pending Order Report): Toggle Yes or No (default No) to govern whether orders with this status appear in pending sales order reports.
  • Capacity Cap: The module is engineered to hold a maximum of 99 status types. This ensures that the order lifecycle remains streamlined and prevents “Status Bloat” that can complicate reporting.

๐Ÿ›ก๏ธ Referential Integrity & Protected System Status

  • System Status 00 Protection: Status Code 00 is reserved by the system. The application displays: “This is the System generated record. You may not modify or delete it.” and blocks any attempt to edit or delete it.
  • Usage Protection: To maintain data consistency, the system includes a background integrity check. You cannot delete an Order Status if it is currently assigned to any existing Sales Order (“Master Record is live. You may not delete it.”).
  • Duplicate Prevention: Both the Short Name and the Description are strictly validated for uniqueness to prevent confusion during data entry.

4. Complete Flow ๐Ÿ”„

Define the Status

  • Navigate to the Order Status Index (/orderstatusmstindex) and click “Create New”.
  • Enter a comprehensive Description (up to 50 characters, e.g., Approved for Production).
  • Enter a Short Name (up to 5 characters, e.g., APP).
  • Set Consider for Mrp: Select Yes if this status indicates a confirmed order that production should plan material for, otherwise No.
  • Set Consider for Pending Order Report: Select Yes if this order represents unfulfilled pending commitment, otherwise No.

System Validation & Save

  • The system checks if the Short Name and Description are unique.
  • It verifies that the 99-record limit has not been exceeded.
  • Upon saving, the system redirects to /orderstatusmstdetails/{id}.

Transactional Usage

  • Users can now select this status in the Sales Order screens.
  • The MRP engine and Pending Order reports automatically read the configured operational flags to include or exclude orders with this status.

5. Validations and Logic โš ๏ธ

Validation TypeWhat is checked?Error Message / Action
System Record 00Attempting to modify or delete status code 00.“This is the System generated record. You may not modify or delete it.”
Uniqueness (Short Name)If the Short Name already exists.“Short Name already exist”
Uniqueness (Description)If the Full Description is taken.“Description already exist”
Capacity CheckEnsures total records are less than 99.“This table can hold a maximum of 99 records…”
Reference CheckChecks if the status is used in transactions before deletion.Alert: “Master Record is live. You may not delete it.”
Length ConstraintsDescription up to 50 characters; Short Name up to 5 characters.Standard input length validations.

6. Related Reports ๐Ÿ“Š

  • ๐Ÿงพ Order Status Master List: Export all defined statuses to review your organization’s sales workflow.
  • ๐Ÿ“‹ Pending Sales Order Reports: Filters orders according to the Consider for Pending Order Report flag.

7. Best Practices / Tips ๐Ÿ’ก

  • MRP Flag Caution: Be careful when setting Consider for Mrp = Yes. Setting this on tentative or unconfirmed statuses could trigger unnecessary raw material purchase requisitions.
  • Define “OK” Early: Usually, the status code OK is reserved for confirmed orders ready for processing with both MRP and Pending Order flags set to Yes.
  • Audit Before Deleting: If you need to remove a status, first update any historical or open orders currently using that status to an active alternative.