Changes

MRO Material Management

38,486 bytes added, 18 June

! Type

! Meaning

! Stored or calculated

| ~~ITEM_NUMBER~~LK_MATERIAL_MASTER| ~~string~~MaterialMaster| ~~Item number or material number of~~ Link to the material masterdata.| Stored link

| ~~PACKAGING_UNIT~~LK_STORAGE_LOCATION| ~~string~~StorageLocation| ~~Packaging unit of~~ Link to the storage location where the materialis located.| Stored link

| double

| ~~Packaging size~~Material quantity.Inherited from GoodsMovement.| Stored property

| int

| Underlying integer value for the material ~~type~~status.| Stored property

| enum

=== Material ~~type~~ status ===

The ~~typed~~ material ~~type accessor~~ status is stored in MATERIAL_STATUS and exposed through the typed accessor ~~MaterialType~~MaterialStatus.

Known values are:

* {| class="wikitable"! Value! Numeric value! Meaning|-| ~~SpareParts~~Undefined* | 0| No specific material status is defined.|-| ~~Consumables~~Inactive* | 10| Material is inactive.|-| ~~Tools~~Active| 20| Material is active.|}

'''Open point:''' ~~No explicit SAP or ERP synchronization behavior was found in the~~ The inspected class information does not show specific methods that automatically change MaterialStatus. Status changes outside these classesare unclear from code. </div> === Reserved quantity === ~~ITEM_NUMBER~~RESERVED_QUANTITY ~~may correspond~~ is calculated at read time. The calculation uses reservations where: * LK_MATERIAL points to ~~an external~~ the current material ~~number~~* STATUS is ReservationStatus.Confirmed The calculated value is the ~~exact SAP~~sum of QTY_PLANNED</~~ERP mapping~~ span> of these confirmed reservations. <div style="border-left: 4px solid #36c; background-color: #f8f9fa; padding: 10px 12px; margin: 12px 0;">'''Important:''' RESERVED_QUANTITY is ~~unclear from~~ not treated as a normal stored quantity in the business logic. It is computed from confirmed Reservation objects.</div> === Available quantity === The available ~~code information~~material quantity is calculated by the method AvailableQuantity(). <div style="font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 8px 10px; margin: 10px 0;">AvailableQuantity = QUANTITY - RESERVED_QUANTITY</div> === Active reservations === The method HasActiveReservation() checks whether active reservations exist for the material. It queries reservations where: * LK_MATERIAL points to the current material* STATUS is lower than or equal to ReservationStatus.Confirmed This means the method considers reservations up to the confirmed state as active. === Delete behavior === Material.InternalDeleteAllowed() prevents deleting a material if it still has quantity or active reservations. Deletion is only allowed if the base delete conditions are fulfilled and: * QUANTITY is lower than or equal to 0* HasActiveReservation() returns false <div style="border-left: 4px solid #d33; background-color: #fff5f5; padding: 10px 12px; margin: 12px 0;">'''Restriction:''' A Material cannot be deleted while it has a quantity greater than 0 or active reservations.

</div>

== ~~Material~~ Reservation ==

=== Purpose ===

~~Material~~Reservation represents a material ~~instance or stock entry in MRO~~reservation for a task.

It inherits from GoodsMovement and therefore uses the inherited QUANTITY property as its material quantity.

A * a task via LK_TASK* a material ~~links to~~via LK_MATERIAL

* a material master via It stores the planned reservation quantity in ~~LK_MATERIAL_MASTER~~QTY_PLANNED* a storage location via and can also store an actual quantity through the overridden ~~LK_STORAGE_LOCATION~~QUANTITYproperty.

~~It also exposes calculated~~ === Important properties === {| class="wikitable"! Property! Type! Meaning! Important behavior|-| LK_TASK| Task| Link to the task for which the material is reserved.| Setter is blocked when status is Issued or Confirmed.|-| LK_MATERIAL| Material| Link to the material being reserved.| Setter is blocked when status is Issued or Confirmed.|-| STATUS| int| Underlying integer value for the reservation status.| Changes are validated by AllowStatusChange(int newStatus).|-| Status| ReservationStatus| Typed accessor for STATUS.| Uses the ReservationStatus enum.|-| QTY_PLANNED| double| Planned quantity for the reservation.| Setter validates through AllowQuantityPlanned(double).|-| QUANTITY| double| Actual reservation quantity. Overrides GoodsMovement.QUANTITY.| Setter validates through AllowQuantity(double).|} === Reservation status === The reservation status is stored in STATUS and ~~availability~~ exposed through the typed accessor Status. Known values of ReservationStatus are: {| class="wikitable"! Status! Numeric value! Meaning|-| Planned| 0| Reservation is planned.|-| Confirmed| 10| Reservation is confirmed and contributes to the material's reserved quantity.|-| Issued| 20| Material has been physically issued.|-| Cancelled| 30| Reservation was cancelled. This is only allowed if the reservation has not been issued.|-| Expired| 50| Reservation has expired.|} === Status change rules === Status changes are controlled by AllowStatusChange(int newStatus). The following rules are applied: * no status change is allowed when the current status is Issued* changing from Confirmed back to Planned is not allowed* other status changes are allowed by this method <div style="border-left: 4px solid #d33; background-color: #fff5f5; padding: 10px 12px; margin: 12px 0;">'''Restriction:''' Once a reservation has status Issued, its status can no longer be changed by the normal status setter logic.</div> === Planned quantity validation === The setter of QTY_PLANNED validates changes through AllowQuantityPlanned(double). A new planned quantity is only allowed if: * Status is ReservationStatus.Planned* LK_MATERIAL is assigned* the new quantity is greater than 0* the new quantity is lower than or equal to LK_MATERIAL.AvailableQuantity() <div style="border-left: 4px solid #36c; background-color: #f8f9fa; padding: 10px 12px; margin: 12px 0;">'''Quantity rule:''' A planned reservation quantity can only be set while the reservation is still Planned and only if the selected material has enough available quantity.</div> === Actual quantity validation === The overridden QUANTITY setter validates changes through AllowQuantity(double). A new actual quantity is only allowed if: * the new quantity is greater than 0* the status is either Planned or Confirmed === Link editing rules === The setters of LK_TASK and LK_MATERIAL are guarded by reservation status. The links cannot be changed when the reservation is: * Issued* Confirmed This prevents changing the task or material after the reservation has reached a more binding status. == StorageLocation == === Purpose === StorageLocation represents a physical storage location. It is a functional location specialization and can be linked from Material via LK_STORAGE_LOCATION. A storage location stores information about storage type, dimensions, access type, label, level, position, and occupancy.

=== Important properties ===

! Type

! Meaning

~~! Stored~~ |-| STORAGE_TYPE| int| Underlying integer value for storage type.|-| StorageType| enum| Typed accessor for STORAGE_TYPE.|-| MAX_WEIGHT| double| Maximum allowed weight for the storage location.|-| MAX_VOLUME| double| Maximum allowed volume for the storage location.|-| LENGTH| double| Length of the storage location.|-| WIDTH| double| Width of the storage location.|-| HEIGHT| double| Height of the storage location.|-| ACCESS_TYPE| int| Underlying integer value for access type.|-| AccessType| enum| Typed accessor for ACCESS_TYPE.|-| STORAGE_LABEL| string| Label of the storage location.|-| LEVEL| int| Level of the storage location.|-| POSITION| string| Position identifier.|-| OCCUPANCY_STATUS| int| Underlying integer value for occupancy status.|-| OccupancyStatus| enum| Typed accessor for OCCUPANCY_STATUS.|} === Storage type === Known values of StorageType are: * Floor* Shelf* Rack* Bin* Pallet* Container === Access type === Known values of AccessType are: * Manual* Forklift* Crane* Automated === Occupancy status === Known values of OccupancyStatus are: * Empty* Partial* Full* Reserved* Blocked* OutOfService <div style="border-left: 4px solid #f0ad4e; background-color: #fff8e5; padding: 10px 12px; margin: 12px 0;">'''Open point:''' The inspected StorageLocation information does not show automatic occupancy calculation. It is unclear from code whether OCCUPANCY_STATUS is updated manually, by workflow logic, or ~~calculated~~by another module.</div> == Relations == The following relations are relevant for material management. {| class="wikitable"! Relation! Source! Target! Meaning

| ~~Link to the~~ Links a material instance to its master data.~~| Stored link~~

| ~~Link to the storage location~~ Defines where the material is ~~located~~stored.~~| Stored link~~

| Defines which material is reserved.

| Defines the task for which the material is reserved.

== Quantity concepts ==

=== Material quantity ===

The material quantity is stored in Material.QUANTITY.

Because Material inherits from GoodsMovement, the property is inherited from the base class.

=== Reserved quantity ===

The reserved quantity is exposed through Material.RESERVED_QUANTITY.

It is calculated by summing the QTY_PLANNED values of confirmed reservations for the material.

Only reservations with Status equal to ReservationStatus.Confirmed are included in this calculation.

=== Available quantity ===

Available quantity is calculated by Material.AvailableQuantity().

AvailableQuantity = QUANTITY - RESERVED_QUANTITY

</div>

=== Planned reservation quantity ===

The planned reservation quantity is stored in Reservation.QTY_PLANNED.

It can only be set if:

* the reservation is still Planned

* a material is assigned

* the quantity is greater than 0

* the quantity does not exceed the material's available quantity

=== Actual reservation quantity ===

The actual reservation quantity is stored in Reservation.QUANTITY.

This property overrides GoodsMovement.QUANTITY and can only be set if the status is Planned or Confirmed and the new quantity is greater than 0.

=== Quantity overview ===

{| class="wikitable"

! Quantity

! Property / method

! Object

! Stored or calculated

! Notes

| Material quantity

| ~~double~~Material| Stored| ~~Material quantity.~~ Inherited from GoodsMovement.~~| Stored property~~

| Reserved quantity

| ~~double~~Material| Calculated| Sum of ~~planned quantities~~ QTY_PLANNED of confirmed reservations for ~~this~~ the material.~~| Calculated property~~

== Reservation workflow ==

=== Creating or editing a reservation ===

A reservation links a material to a task.

For a reservation to define its planned quantity correctly:

# Status must still be Planned.

# QTY_PLANNED must not exceed LK_MATERIAL.AvailableQuantity().

=== Confirmed reservations ===

When a reservation is confirmed, it contributes to the material's reserved quantity.

This affects the available quantity of the material because:

AvailableQuantity = QUANTITY - sum(QTY_PLANNED of confirmed reservations)

</div>

LMA

420

edits

Changes

MRO Material Management

UBIK Wiki / Augmensys