Process

More Process-API information can be found here: REST API documentation - Process

Process description

A process is the link between entities on our platform. Every order, pick job, handover job etc., references one process, and every process keeps the IDs of it's entities. Furthermore, the process houses the different status of the different domains, modules, and entities.

Important note

The expression domain for the fields in the process class is not correct. Correct is module instead of domain. This will be fixed in the future.

Some fields of the process class:

{
    "id": "111-222-333",
    // ...
    "pickJobRefs": [],
    "handoverJobRefs": [],
    // ...
    "status": "CREATED",
    "domsStatus": "CREATED",
    "returnStatus": "NOT_AVAILABLE",
    "operativeStatus": "CREATED",
    "domainStatuses": [
        "PICKING": "CREATED",
        // ...
    ],
    "lastDomainEntityStatuses": [
        {
            "domain": "PICKJOB",
            "status": "CREATED",
            "entityId": "123456789"
        },
        // ...
    ]
    // ...
}

Process statuses calculation flow

The different status of the process are calculated depending on their predecessors. The start status is the lastDomainEntityStatuses (at the bottom in the image), with this the domainStatuses are calculated. domsStatus and operativeStatus are calculated from the domainStatuses. The final overall status based on domsStatus and operativeStatus.

Description of different status

Preface

Our platform contains different domains and modules. Every domain has multiple modules, and every module includes entities like a PickJob in the PICKING module or a RoutingPlan in the ROUTING module.

For the different Process-Status-Calculation, only the DOMS and LOCAL OPERATIONS modules are taken into account.

lastDomainEntityStatuses

Contains only the last status of every entity. An entity (e.g. RoutingPlan, PickJob or HandoverJob) status change in a module (e.g. PACKING or ORDER), will update the entry of the corresponding entity in this list.

Example JSON:

"lastDomainEntityStatuses": [
    {
        "domain": "ROUTING_PLAN",
        "status": "FINISHED",
        "entityId": "ROUTING-A-0000-1111"
    }, {
        "domain": "ROUTING_PLAN",
        "status": "FINISHED",
        "entityId": "ROUTING-B-0000-1111"
    }, {
        "domain": "PICKJOB",
        "status": "CREATED",
        "entityId": "PICK-A-2222-3333"
    },
    // ...
]

Because the noticed status in lastDomainEntityStatuses must be work with all entities from different modules, these saved status are NOT the original status that is defined in the module. The original status is mapped into one, which can be used across all modules.

domainStatuses

Contains module clean statuses that will be calculated from the module entities from the lastDomainEntityStatuses. For example, we have ONE status for PICKING or SHIPPING.

Example JSON:

"domainStatuses": [
    "ORDER": "FINISHED",
    "ROUTING_PLAN": "FINISHED",
    "PICKING": "CREATED",
    // ...
]

The status enum type is the same like in lastDomainEntityStatuses, DomainStatus and can be found in our REST API documentation.

domsStatus, operativeStatus & inventoryStatus

Each of these three statuses contains a clear domain status. For the calculation of these three statuses, the associated module statuses from the domainStatuses list are taken.

status

This is the overall status, and it will be calculated with the three status domsStatus, operativeStatus and inventoryStatus.

returnStatus

This status tracks the progress of returns associated with this order. As long as no returns are in progress, this status will be NOT_AVAILABLE. Contrary to other process status like domsStatus or operativeStatus, the returnStatus does not influence the overall status of the process. This is because an order is counted as complete once all its items are shipped. If a return is issued later on, the progress should not be reopened. The process will remain CLOSED, only its returns will be IN_PROGRESS.