CreateBaseVirtualPosition

Virtual Position Creation and Quantity Calculation

Inventory Position Retrieval & Validation

• The rule first retrieves the corresponding inventory position for the virtual position being created. It uses the `{virtualCatalogueInventoryCatalogueRef}` event attribute (as the inventory catalog reference) and constructs the inventory position reference based on the following convention:
  • If `inventoryPositionRef` is not provided, the reference follows the format:
    `{productRef}:{locationRef}:DEFAULT`
• Once the inventory position is retrieved, the rule validates its fields. If any issues are detected, an exception is thrown, as outlined in the Exceptions section.

Effective Quantity Calculation

• To create a virtual position, the system calculates its effective quantity—the final quantity after applying relevant buffer values to the on-hand inventory quantity. (See Quantity Calculation section for details.)
• After determining the effective quantity, the virtual position is created with:
  • `{targetVirtualPositionRef}` as the virtual position reference
  • `{virtualCatalogueRef}` as the virtual catalog reference
  • `BASE` as the virtual position type
• Finally, the rule generates an inline event with the following attributes:
  • `{entityRef}` = `{targetVirtualPositionRef}`
  • `{entityType}` = `VIRTUAL_POSITION`
  • `{entitySubtype}` = `BASE`

Quantity Calculation

The effective quantity of a virtual position (type `BASE`) is determined by evaluating exclusion buffers and quantity buffers.

• Exclusion Buffer Check
  • The rule checks if an exclusion buffer applies to the virtual position.
  • If an active exclusion buffer is found, the effective quantity is immediately set to 0, and the calculation stops. (See Exclusion Control Buffer Calculation for details.)
• Quantity Buffer Check
  • If no exclusion buffers are found, the rule calculates the quantity buffer.
  • The buffer value is added to the on-hand inventory quantity to determine the effective quantity.
  • If the resulting value is negative, the effective quantity is set to 0.
  • The final quantity is assigned to the new virtual position. (See Quantity Buffer Calculation for details.)
• No Controls Applied
  • If no controls are present, the effective quantity is equal to the on-hand value of the inventory position.

Exclusion Control Buffer Calculation

• The rule retrieves all product categories using `{productRef}` and `{virtualCatalogueProductCatalogueRef}` event attributes.
• It generates potential exclusion control references based on `{virtualCatalogueControlGroupRef}`, `{productRef}`, and category references:
  • `{virtualCatalogueControlGroupRef}:EXCLUSION:{productRef}`
  • `{virtualCatalogueControlGroupRef}:EXCLUSION:{category_ref}` (for each category)
• The rule attempts to fetch ACTIVE controls using these references.
  • If at least one active exclusion control is found, the effective quantity is set to 0, and the process stops.
  • If no exclusion controls are found, the rule proceeds to Quantity Buffer Calculation.

Quantity Buffer Calculation

• The rule retrieves product categories using `{productRef}` and `{virtualCatalogueProductCatalogueRef}` event attributes.
• It generates quantity buffer control references using `{virtualCatalogueControlGroupRef}`, `{locationRef}`, `{productRef}`, and category references:
  • `{virtualCatalogueControlGroupRef}:QUANTITY_BUFFER:{productRef}:{locationRef}`
  • `{virtualCatalogueControlGroupRef}:QUANTITY_BUFFER:{productRef}`
  • `{virtualCatalogueControlGroupRef}:QUANTITY_BUFFER:{locationRef}`
  • `{virtualCatalogueControlGroupRef}:QUANTITY_BUFFER:{category_ref}` (for each category)
• The rule attempts to fetch ACTIVE controls using these references.
  • If controls are found, they are sorted in ascending order by their `executionOrder`.
  • The rule selects the lowest executionOrder control with a valid buffer value.
  • This value is added to the on-hand inventory quantity to determine the effective quantity.
  • If no valid buffer controls exist, the effective quantity defaults to the on-hand inventory value.