Register Shop Floor actions¶
These services invoke actions and register shop floor activities, enabling automation of shop floor operations.
Receive Order¶
This service requires input parameters such as Location Number
where the Main Product will be received, Quantity
, and an Operation ID
or the combined Order number
, Release number
, Sequence number
, and Operation number
. If not issued, Components are backflushed, and simplified material check enabled. Support for Lot batch number
and Serial numbers
is included. Serial Number Products can only be received one at a time. You can report a Handling Unit
, but it cannot be generated automatically.
Report Analysis Result¶
This service allows incremental registration of Quality Results
to a Data Point
on an Analysis Number
. If the required sample size has been registered, you can set Complete
to "true." Values sent to a Data Point are handled based on the data type:
- Attribute: Sending a Result increments the number of Nonconforming by one, and the Result value is added to the current value of Nonconformities.
- Categorical: Sending the Category Value ID as the Result increments the registered value in the corresponding result category by one.
- Variable: Sending the result registers the value in ascending order of the available result number.
Serial Numbers
can also be entered.
Use the Get Operation Info API to get information about the shop order analysis. The DataPoints
array contains information that is useful to register results. This payload includes RemainingVariableQuantity
which informs how many variable samples remaining to register.
Note¶
You can only complete an analysis with this API. The confirmation needs to be done manually. The service user account will be the registered user connected to the results in the "Entered By" field.
Start Operation¶
This service allows you to start machine Time Type
activities, such as Production or Setup, on a given Operation ID
and Resource Id
.
Stop Operation¶
This service stops ongoing machine time activity on a given Operation ID
. You can also register Interruption causes
, and if Close Operation
is set to true, the operation can be closed.
Report Quantity Complete¶
This service registers the produced quantity for a specified Operation ID
. If Close Operation
is set to true, it can be used to close the operation. By default, the Time of production
is set to the current site time, but you can override it by adding the time of production in the payload.
Report Quantity Scrap¶
This service registers scraped quantity
and scrap reason
for a specified Operation ID
. If the Close Operation
parameter is set to true, this API can be used to close the operation as well. The Time of production
defaults to the current site time but can be overwritten by specifying the production time in the payload.
Scrap Component¶
Registers a scraped quantity
and scrap reason
of a material line component for a specified Line Item Number
. Based on Order Number
, Release Number
, Sequnce Number
, Location Number
and Revision number
. Only Distribute Scrap is supported. When scraping components that have not yet been issued they are automatically backflushed. Tracked components needs to be issued before you can scrap them.
Issue Component Line¶
Issue a material line component quantity using Line Item Number
. Based on Order Number
, Release Number
, Sequnce Number
, Location Number
and Revision number
. Lot Batch Number
, Serial Number
, Waiver/Deviation/Rejection Number
, Handling Unit Id
and Catch Quantity Issue
are supported.
Note¶
It is not possible to retrieve the Revision Number of the component consumed from stock using the integration API; this information must be added manually when Revision changes.
Only register a Catch Quantity Issue
value if the component has Catch UoM Enabled in Part settings.
Issue Component Part¶
This API has the same functionality as the Issue Component Line API but uses the Part Number
as input key instead. The Part Number occur on multiple material lines, this action can not be invoked, the Issue Component Line must be used instead.
Start Machine Downtime¶
The service initiates Downtime on a specified Resource ID
or Work Center
within a particular site
. If only a Work Center is set, all resources in that Work Center are affected by the downtime. You can also enter a Downtime Cause
when initiating downtime.
Stop Machine Downtime¶
The service is used to stop ongoing Downtime on a specified Resource ID
or Work Center
within a specific site
.
Prerequisites¶
To utilize these services, you must have a service account with an appropriate Permission Set and access to the relevant site. For example, if you need to enter the Time of production
on dates in the past, the service account should be configured as a financial user.