Changes

MRO Material Management

14,912 bytes removed, 19 June

'''Summary:''' The MRO material management features provide the foundation for handling materials, material master data, reservations, storage locations, and goods movements in MRO workflows. The central objects are Material, MaterialMaster, and Reservation, GoodsMovement, and StorageLocation. Materials are linked to master data and storage locations. Reservations are created manually by users and link materials to tasks ~~and define planned or actual quantities for maintenance work~~.

</div>

MRO material management is used to support maintenance work with ~~the~~ required spare parts, consumables, tools, or other material items.

~~In a maintenance workflow, users may need to know:~~ * Users can see which material is required for a task* which material master data belongs to a material* , where the material is stored* , how much material is available* , how much material is ~~already~~ reserved* which reservations exist for a task* whether a reservation is planned, ~~confirmed, issued, cancelled, or expired~~ ~~The material management implementation separates the general material catalogue from the actual material quantity~~ and which reservation ~~handling~~status applies.

== Basic concept ==

~~The material management implementation is built around the following main objects:~~

{| class="wikitable"

|-

| Reservation

| Workflow ~~/ transaction~~ object| Represents a manually created material reservation for a task. It links a material to a task and stores planned and actual quantities.

|-

| GoodsMovement

| ~~Base~~ Technical base class

| Provides the common QUANTITY property used by both materials and reservations.

|-

| StorageLocation

| ~~Storage master / location~~ Related storage object| Represents a physical storage location ~~and stores storage-related information such as storage type, dimensions, access type, and occupancy status~~for materials.

|}

'''Core idea:''' MaterialMaster defines what the material is. Material represents the material in ~~the MRO~~ stock or material context. Reservation links a material to a task and reserves a planned quantity for maintenance execution.

</div>

| Goods Movement

| UBIK.MRO.GoodsMovement

| ~~Base~~ Technical base class

| Provides QUANTITY to derived objects

|-

| Functional location specialization

| Referenced by Material via LK_STORAGE_LOCATION

|}

~~== GoodsMovement ==~~

~~=== Purpose ===~~

GoodsMovement is the base class for material-related quantity-bearing objects.

~~It defines the common quantity concept used by both:~~

* Material

* Reservation

~~=== Important properties ===~~

~~{| class="wikitable"~~

~~! Property~~

~~! Type~~

~~! Meaning~~

|-

| QUANTITY

~~| double~~

| Quantity value for the goods movement. For Material, this is the material quantity. For Reservation, this is the actual reservation quantity and has reservation-specific validation.

|}

It stores item-level master data that can be referenced by material instances in MRO.

~~A material master describes the material independently from a concrete reservation or task.~~

=== Important properties ===

| ITEM_NUMBER

| string

| Item number or material number ~~of the material master~~.

|-

| PACKAGING_UNIT

| string

| Packaging unit ~~of the material~~.

|-

| PACKAGING_SIZE

| UNIT_OF_MEASURE

| string

| Unit of measure ~~used for the material~~.

|-

|-

| MANUFACTURER_COMPANY_NAME

=== Material type ===

~~The typed material type accessor is~~ Known values of MaterialType. ~~Known values~~ are:

* SpareParts

* Consumables

* Tools

== Material ==

* a material master via LK_MATERIAL_MASTER

* a storage location via LK_STORAGE_LOCATION

~~It also exposes calculated reservation and availability logic.~~

=== Important properties ===

| Calculated property

|-

|}

=== Material status ===

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

~~Known values are:~~The property is managed by the user or administrator. The system does not change it automatically.

{| class="wikitable"

| Inactive

| 10

| Material is inactiveand should not be used for new reservations.

|-

| Active

| 20

| Material is activeand can be used for reservations.

|}

=== Reserved quantity ===

The calculated value is the sum of QTY_PLANNED of these confirmed reservations.

~~<div style="border-left: 4px solid #36c; background-color: #f8f9fa; padding: 10px 12px; margin: 12px 0;">~~

'''Important:''' RESERVED_QUANTITY is not treated as a normal stored quantity in the business logic. It is computed from confirmed Reservation objects.

~~</div>~~

=== Available quantity ===

The available material quantity is calculated by ~~the method~~ AvailableQuantity().

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

=== Purpose ===

Reservation represents a manually created material reservation for a task.

It links:

* a material via LK_MATERIAL

It stores the planned reservation quantity in QTY_PLANNED and ~~can also store an actual quantity through~~ the ~~overridden~~ actually issued or consumed quantity in QUANTITY ~~property~~.

=== Important properties ===

| Setter is blocked when status is Issued or Confirmed.

|-

| STATUS / Status| int/ enum| ~~Underlying integer value for the reservation~~ Reservation status.

| Changes are validated by AllowStatusChange(int newStatus).

|-

| Status

| ReservationStatus

| Typed accessor for STATUS.

| Uses the ReservationStatus enum.

|-

| QTY_PLANNED

| QUANTITY

| double

| ~~Actual reservation~~ Actually issued or consumed quantity. Overrides GoodsMovement.QUANTITY.

| Setter validates through AllowQuantity(double).

|}

=== Reservation status ===

The reservation status is stored in STATUS and exposed through the typed accessor Status.

Known values of ReservationStatus are:

| Cancelled

| 30

| Reservation was cancelled~~. This is only allowed if the reservation has not been issued~~.

|-

| Expired

* LK_MATERIAL is assigned

* the new quantity is greater than 0

* the new quantity is lower than or equal to LK_MATERIAL.AvailableQuantity()

* Issued

* Confirmed

~~This prevents changing the task or material after the reservation has reached a more binding status.~~

== StorageLocation ==

=== Purpose ===

StorageLocation ~~represents~~ is a related object used to represent a physical storage location.

~~It is~~ A material can reference a ~~functional~~ storage 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 and values ===

{| class="wikitable"

! Property

! Type

! ~~Meaning~~Values / meaning

|-

| STORAGE_TYPE / StorageType| int/ enum| ~~Underlying integer value for storage type.~~Floor, Shelf, Rack, Bin, Pallet, Container

|-

| ~~StorageType~~ACCESS_TYPE / AccessType| int / enum| ~~Typed accessor for~~ ~~STORAGE_TYPE~~Manual, Forklift, Crane, Automated.

|-

|-

| STORAGE_LABEL

| string

| Position identifier.

|-

| OCCUPANCY_STATUS

~~| int~~

~~| Underlying integer value for occupancy status.~~

|-

| OccupancyStatus

~~| enum~~

| Typed accessor for OCCUPANCY_STATUS.

|}

==GoodsMovement = ~~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* OutOfServiceGoodsMovementis a technical base class.

It provides the common QUANTITY property for material-related objects such as Material and Reservation.

== Relations ==

~~The following relations are relevant for material management.~~

{| class="wikitable"

== 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().

~~<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>~~

~~=== 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"

|-

| Available quantity

| AvailableQuantity()

| Material

| Calculated

| Validated by AllowQuantityPlanned(double).

|-

| ~~Actual reservation~~ Actually issued or consumed quantity

| QUANTITY

| Reservation

=== Creating or editing a reservation ===

Reservations are created manually by the user.

A reservation links a material to a task.

# LK_MATERIAL must be set.

# LK_TASK ~~should~~ must point to the task requiring the material.

# Status must still be Planned.

# QTY_PLANNED must be greater than 0.

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

This affects the available quantity of the material ~~because:~~.

* if a reservation has status Confirmed, it is set to Issued

* otherwise, it is set to Cancelled

The changed reservations are added to the unsaved children through AddToUnsavedChildren(reservation) so that the changes are persisted.

* the task through LK_TASK

* the planned quantity through QTY_PLANNED

* the actually issued or consumed quantity through QUANTITY

* the reservation state through Status

This means that material usage is tracked at task level ~~in the inspected implementation~~. ~~== Goods movement usage ==~~ GoodsMovement is the common base class for quantity-bearing material objects. Both Material and Reservation inherit from it and expose QUANTITY. ~~In the inspected implementation:~~ * Material.QUANTITY represents the material quantity* Reservation.QUANTITY represents the actual quantity for the reservation and applies reservation-specific validation* Reservation.QTY_PLANNED represents the planned reserved quantity* Material.RESERVED_QUANTITY is calculated from confirmed reservations

== Example workflow ==

~~=== Scenario ===~~

~~A task requires one spare part from stock.~~

=== Step 1: Material master exists ===

~~The~~ A spare part is defined as a MaterialMaster.

{| class="wikitable"

| 0

|-

| AvailableQuantity()

| 10

|}

=== Step 3: Reservation is created for a task ===

A user manually creates a Reservation and links the material to the task.

{| class="wikitable"

| 1

|}

~~The planned quantity is allowed because the material has enough available quantity.~~

=== Step 4: Reservation is confirmed ===

| 1

|-

| Material.AvailableQuantity()

| 9

|}

=== Step 5: Actual quantity is entered === The actually issued or consumed quantity is stored in Reservation.QUANTITY. {| class="wikitable"! Property! Example|-| Reservation.QUANTITY| 1|} === Step 6: Task is finished ===

When the task is finished, CloseReservations() is called.

== Validation and business rules ==

~~The following business rules are implemented in the inspected material management logic.~~

{| class="wikitable"

| AllowQuantityPlanned(double)

|-

| Actual ~~reservation~~ issued or consumed quantity

| QUANTITY must be greater than 0.

| AllowQuantity(double)

|-

| Actual ~~reservation~~ issued or consumed quantity

| QUANTITY can only be changed while the reservation is Planned or Confirmed.

| AllowQuantity(double)

| Material deletion

| Material cannot be deleted while QUANTITY is greater than 0.

| InternalDeleteAllowed()

|-

| Material deletion

| Material cannot be deleted while active reservations exist.

| InternalDeleteAllowed() and HasActiveReservation()

|}

== See also ==

* [[MRO (Plugin)]]

* [[MRO_Objects_(Client)]]

* [[MRO_Implemented_Objects]]

* [[MROMaintenancePlans]]

LMA

420

edits