Manufacturing order (Version 2) (Deprecated)

Context of use

The webservices described below relate to the management of Manufacturing orders (MO) used in MES.

They are used for example in the case where the MO planning is defined by an ERP or a SCP system.

The MO are intended for use :

  • in MES Performance (OEE monitoring,…​)

  • in MES Operations (monitoring of material yields…​)

  • or in both contexts at the same time

For the entity “Manufacturing order”, the operations available are :

An external MO can’t be delete using a webservice.

Endpoints

Create / update new external MO

/companies/{companyCode}/establishments/{establishmentCode}/external-mos

Description

This endpoint allows to create or update an external MO.

If the external MO number is unknown (or not set), a new MO will be created.

Otherwise, the existing MO will be updated (provided it has not already been started).

Parameters

Type Name Description Schema Associated rules

Path

companyCode
required

Current context company code

string

Path

establishmentCode
required

Current context establishment code

string

Body

body
required

MO to create or update

Responses

HTTP Code Description Schema

201

Successfully created / updated

No Content

400

Functional error

No Content

500

Internal server error

No Content

Consumes

  • application/json

Produces

  • application/json

Import entity list

/companies/{companyCode}/establishments/{establishmentCode}/external-mos/import

Parameters

Type Name Description Schema Associated rules

Path

companyCode
required

Current context company code

string

Path

establishmentCode
required

Current context establishment code

string

Responses

HTTP Code Description Schema

202

Accepted

No Content

400

Functional error

No Content

500

Internal server error

No Content

Consumes

  • application/json

Produces

  • application/json

Data structure

ExternalMO

Description of an external manufacturing order (MO), i.e. a MO created outside the MES.

Name Description Value Associated rules

companyCode
required

Company code

string

establishmentCode
required

Establishment code

string

moNbExt
required

External MO number

string

R1

itemCode
required

Reference item code

string

R2

quantity
required

Quantity

beginAt
required

Planned begin date time

datetime (ISO-8601)

R3

endAt
optional

Planned end date time

datetime (ISO-8601)

R3

manufacturing
optional

Manufacturing data

R11

performance
optional

Performance data

R12

batchCode
optional

Batch code

string

R4

criterionValues
optional

List of MO Criterion values

comment
optional

Mo comment

string

R5

ManufactMo

Description of the data relative to MES Operations (manufacturing monitoring).

These data are compulsory for MES Operations, but not required for MES Performance.

At least one ot the 2 of ManufactMo and PerformanceMo should be set.

Name Description Value Associated rules

activitiesSequence
optional

activities sequence to use

R6

activity
optional

activity to use

R7

PerformanceMo

Description of the data relative to MES Performance (EEO monitoring…​).

These date are compulsory for MES Performance, but not required for MES Operations.

At least one ot the 2 of ManufactMo and PerformanceMo should be set.

Name Description Value Associated rules

lineCode
required

line code

string

R7

lineConfigurationCode
optional

line configuration code

string

R8

seqNumberInDay
optional

Order number of the mo for the production day

integer

R10

ManufactMoActivitiesSequence

Name Description Value Associated rules

code
required

activities sequence code

string

R7

ManufactMoActivity

Name Description Value Associated rules

code
required

activity code

string

R7

operatingProcessCode
optional

operating process code

string

R9

Rules

R1

moNbExt should contain 12 characters or less. Authorized characters are numbers, letters, and the 4 following characters : - _ + $ moNbExt is recorded in uppercase mode (no differences between lower and uppercase).

If a manufacturing order (MO) exists for companyCode, establishmentCode and moNbExt as external id, this MO will be updated. Otherwise a new MO is created.

The update consists in the deletion of the existing MO, and the creation of a new MO with the new data.

In the following contexts, the MO can’t be updated :

  • it has already been started

  • it has been split (MO scheduling feature, in MES Performance)

  • it has been cut in technical MO (in MES Operations)

If moNbExt is not set, a new MO is created without external id.

This MO could not be updated using webservices.

R2

itemCode should be an existing production item for companyCode and establishmentCode.

In the case of an update, the itemCode should not be different from the one of the existing MO.

R3

beginAt is required.

If endAt is not set, the end date will be calculated in MES.

If both beginAt and endAt are set, beginAt should be strictly before endAt.

R4

batchCode is optional; if it is set, and if there is no batch with this code, the batch is created.

R5

comment is optional.

?? Nombre de caractères autorisés ??

R6

It is required to set at least one and only one between activity and activities sequence.

Activity or activities sequence should be existing for companyCode, establishmentCode and itemCode.

In the case of an activity, operating process can be set (cf. Rule 9).

In the case of activities sequence, operating processes can’t be set (default operating processes are used : “default” or 1st one).

R7

lineCode should refer to a resource that exists for these companyCode and establishmentCode.

This resource should be a production line.

R8

If lineConfigurationCode is set, it should be one configuration of lineCode.

If it is not set, first line configuration which suits will be used.

If lineConfigurationCode is not set, there should be a configuration of lineCode that can produce itemCode.

R9

operatingProcessCode should exist for companyCode, establishmentCode, itemCode and activity.

If operatingProcessCode is not set, default operating process of the activity is used.

If there is no default operating process, the first operating process (in alphabetic order) is used.

R10

seqNumberInDay is a positive integer.

It is used to order MO in the same day.

R11

If manufactMO is set, the unit should be the unit of activity or activities sequence, or there should be a conversion with unitCode on reference item.

R12

If performanceMO is set, the unit should be lineCode cadency unit, or there should be a conversion between unitCode and lineCode cadency unit.