Skip to main content

12. Order Service

Accessed via client.order(). Manages the entire work order lifecycle — create → start → suspend/resume → close — using an ISA-88 based state machine.

11.1 Work Order States (ISA-88 based)

CREATE → WAIT ──start()──► START ──pause()──► PAUSE
│ │
│ resume()
│ │
▼ ▼
END ◄──end()──── START

└─ (또는) ──abort()──► ABORTED
StateMeaningTransition method
WAITWaiting (initial state right after creation)Result of create()
STARTIn progressstart(), resume()
PAUSEPausedpause()
ENDCompleted normallyend()
ABORTEDTerminated abnormallyabort()

For calls where the state transition is not possible (for example, calling start() again while already in the START state), the server returns OK along with a data.success=false response, and the V5 method returns false.

11.2 Method List

CRUD

MethodReturn typeHTTPEndpoint
create(OrderRequestV5)OrderResponseV5 or nullPOST/api/v5/order
update(order_id, OrderRequestV5)OrderResponseV5 or nullPUT/api/v5/order/{id}
delete(order_id)booleanDELETE/api/v5/order/{id}
get(order_id)OrderResponseV5 or nullGET/api/v5/order/{id}
list()List<OrderResponseV5>GET/api/v5/order
exists(order_id)booleanGET/api/v5/order/{id}/exists

Lifecycle (all return boolean)

MethodHTTPEndpoint
start(order_id)POST/api/v5/order/{id}/start
end(order_id)POST/api/v5/order/{id}/end
pause(order_id)POST/api/v5/order/{id}/pause
resume(order_id)POST/api/v5/order/{id}/resume
abort(order_id)POST/api/v5/order/{id}/abort

11.3 OrderRequestV5 / OrderResponseV5

FieldTypeDescription
order_idStringWork order ID (PK)
titleStringWork order title
descriptionStringDescription
site_idStringOwning site
asset_idStringTarget asset (Equipment)
customer_idStringCustomer (optional)
product_idStringProduct to be produced
employee_idStringAssigned employee (optional)
target_unitslongTarget quantity
unitStringUnit (EA, KG, etc.)
time_per_unit_in_mslongStandard time per unit
fix_start_timestamplongPlanned start time (milliseconds)
fix_end_timestamplongPlanned end time (milliseconds)
external_order_idStringExternal system order ID
statusString(Response only) Current state

11.4 Usage Examples

Creating a Work Order

import plantpulse.api.v5.dto.request.OrderRequestV5;
import plantpulse.api.v5.dto.response.OrderResponseV5;

OrderRequestV5 req = new OrderRequestV5();
req.setOrder_id("ORD_20260514_001");
req.setTitle("5월 14일 1교대 생산");
req.setDescription("PROD_A001 500개 생산");
req.setSite_id("SITE_DJ");
req.setAsset_id("ASSET_DJ_M_0001");
req.setProduct_id("PROD_A001");
req.setCustomer_id("CUST_001");
req.setEmployee_id("EMP_E12345");
req.setTarget_units(500);
req.setUnit("EA");
req.setTime_per_unit_in_ms(5_000);

long now = System.currentTimeMillis();
req.setFix_start_timestamp(now);
req.setFix_end_timestamp(now + 4 * 3600_000L);
req.setExternal_order_id("MES-2026-0514-001");

OrderResponseV5 created = client.order().create(req);

Standard Lifecycle

String orderId = "ORD_20260514_001";

// WAIT → START
if (!client.order().start(orderId)) {
System.err.println("시작 실패 — fix_start_timestamp가 미래이거나 이미 진행중");
return;
}

// 잠시 후 — 일시중지
client.order().pause(orderId);

// 재개
client.order().resume(orderId);

// 정상 종료
client.order().end(orderId);

Abnormal Termination

// abort 는 별도 인자 없이 호출. 상세 사유는 update() 로 description/notes 에 기록.
if (!client.order().abort("ORD_20260514_001")) {
System.err.println("중단 실패");
}

Single Lookup / Existence Check

OrderResponseV5 o = client.order().get("ORD_20260514_001");
if (o != null) {
System.out.println("상태: " + o.getStatus());
System.out.println("목표: " + o.getTarget_units() + " " + o.getUnit());
}

boolean exists = client.order().exists("ORD_20260514_001");

Full List

import java.util.List;

List<OrderResponseV5> all = client.order().list();
for (OrderResponseV5 o : all) {
System.out.printf("[%s] %s — %s%n",
o.getStatus(), o.getOrder_id(), o.getTitle());
}

In-Progress Work Orders Only (client-side filter)

import java.util.stream.Collectors;

List<OrderResponseV5> active = client.order().list().stream()
.filter(o -> "START".equals(o.getStatus())
|| "PAUSE".equals(o.getStatus()))
.collect(Collectors.toList());

Work Orders by Asset

String assetId = "ASSET_DJ_M_0001";
List<OrderResponseV5> assetOrders = client.order().list().stream()
.filter(o -> assetId.equals(o.getAsset_id()))
.collect(Collectors.toList());

Statistics by State

import java.util.Map;

Map<String, Long> byStatus = client.order().list().stream()
.collect(Collectors.groupingBy(
OrderResponseV5::getStatus,
Collectors.counting()));

byStatus.forEach((status, count) ->
System.out.printf("%s: %d건%n", status, count));

Update / Delete

// 수정 (계획 시간 연장)
OrderRequestV5 update = new OrderRequestV5();
update.setOrder_id("ORD_20260514_001");
update.setTitle("5월 14일 1교대 생산 (연장)");
// ... 모든 필드 다시 세팅 ...
update.setFix_end_timestamp(System.currentTimeMillis() + 8 * 3600_000L);
client.order().update("ORD_20260514_001", update);

// 삭제 (취소 처리)
client.order().delete("ORD_20260514_001");

11.5 Usage Scenarios

Scenario — Automatic Work Order Creation via MES Integration

import java.text.SimpleDateFormat;
import java.util.Date;

SimpleDateFormat df = new SimpleDateFormat("yyyyMMdd");
String today = df.format(new Date());

// 외부 MES 큐에서 받은 주문을 V5 Order로 변환
for (MesOrder mes : mesQueue) {
OrderRequestV5 req = new OrderRequestV5();
req.setOrder_id("ORD_" + today + "_" + String.format("%03d", mes.seq));
req.setSite_id("SITE_DJ");
req.setAsset_id(mes.equipId);
req.setProduct_id(mes.productId);
req.setTarget_units(mes.qty);
req.setExternal_order_id(mes.mesOrderId);
req.setFix_start_timestamp(mes.plannedStart);
req.setFix_end_timestamp(mes.plannedEnd);
client.order().create(req);
}

Scenario — Safe State Transition Helper

public static boolean safeStart(APIClient_V5 client, String orderId) {
OrderResponseV5 o = client.order().get(orderId);
if (o == null) {
log.warn("작업지시 없음: " + orderId);
return false;
}
if (!"WAIT".equals(o.getStatus())) {
log.warn("WAIT 상태가 아님: " + o.getStatus());
return false;
}
return client.order().start(orderId);
}

Next Steps