Skip to main content

Order_Type_SalesOrder

Order_Type_SalesOrder = 1

Example

procedure ScriptEvent(var Value: variant);
begin
// Existing scripts may still use the compatibility alias.
if Order_Type_SalesOrder = Type_SalesOrder then
Value := Type_SalesOrder_String; // 'SalesOrder'
end;

Usage

Order_Type_SalesOrder provides deprecated order-type alias value 1 for compatibility with scripts that predate Type_SalesOrder.

Value

PropertyValue
Script typeLongInt
Numeric value1
Preferred identifierType_SalesOrder
Canonical codeType_SalesOrder_String = SalesOrder
Database domainOrder_Type.Num and Order_Hdr.TypeNum

Additional Technical Info

Order_Type_SalesOrder is a deprecated compatibility alias for the sales order type. Its fixed LongInt value is 1, identical to Type_SalesOrder. Existing scripts can read it, but new or revised scripts should use the Type_* family.

The alias identifies a type; it does not create, validate, route or persist an order.

Implementation

Native source places Order_Type_SalesOrder in an explicitly deprecated block and gives it value 1. The PascalScript importer retains the LongInt name for backwards compatibility. The preferred Type_SalesOrder constant is independently registered with the same value.

A fresh VxData database seeds Order_Type row 1 with code SalesOrder. Current GetOrderTypeNum and GetOrderTypeCode implementations use preferred Type_* constants and String partners, not the deprecated Order_Type_* names.

Behaviour

Reading the alias produces the same integer as Type_SalesOrder. The runtime integer does not retain which identifier spelling was used. Current deprecation is advisory: registration remains available and does not itself emit a warning.

The Velox constant tag map exposes Type_SalesOrder, not Order_Type_SalesOrder. Use <!Type_SalesOrder!> for a numeric configuration tag.

Edge cases and quirks

  • There is no Order_Type_SalesOrder_String compatibility constant. Use Type_SalesOrder_String for the canonical code.
  • Numeric values overlap other order/status families and are not type-safe in PascalScript. Use this domain only for order type fields such as Order_Hdr.TypeNum.
  • The generated index does not carry a deprecation flag even though native source marks this alias deprecated; the source-backed warning is therefore in the Markdown body.
  • Current source declares no removal version. Do not infer either permanent support or a scheduled removal.

Side effects

Reading or comparing Order_Type_SalesOrder has no I/O or state-changing side effect. Persistence, routing and event selection belong to the caller and configuration.

Errors

Reading the alias does not raise an error. A value from the wrong domain can select incorrect processing; persistence outside valid Order_Type keys can fail the relevant database constraint.

Performance and concurrency

This is an immutable compiled value. Access is constant-time, allocates no persistent resource and carries no shared mutable state.

Remarks

The example is source-reviewed and non-destructive. When editing an existing script, replace the deprecated name with Type_SalesOrder; the numeric result remains 1.

Related entries

Created 2026-07-15