Hi Meirav
I get your point: The work Specification is managed by the Workforce management, and it allows exposing the list of work "request-able". If you do not use it (and it is fair) you have to be sure to have a way to explicitly and consistently allow requester to specify the work expected.
For your example, I guess the POST should be something like this:
{
"description": "Simplified Exemple of a workOrder",
"externalId": "1236",
"priority": "1",
"requestedCompletionDate": "2022-01-04T15:30:23.367Z",
"workOrderItem": [
{
"id": "1",
"description": "Description of the first Work item",
"action": "add",
"work": {
"description": "Install a new device",
"place": [
{
"name": "Meirav's house",
"role": "InstallationPlace"
}
],
"relatedParty": [
{
"name": "Meirav",
"role": "Contact"
}
],
"workSpecification": {
"id": "123",
"name": "DeviceInstallation"
}
}
}
]
}
We can have another work specification for DeviceMaintenance or DeviceRepair, etc...
By the way, I was not able to associate device in the request (resource in TMF wording).
Probably,
@Pierre Robitaille who lead this API work could provide additional feedbacks.
Hope it helps
Ludovic
------------------------------
Ludovic Robert
Orange
My answer are my own & don't represent necessarily my company or the TMF
------------------------------
Original Message:
Sent: Dec 30, 2021 04:27
From: meirav gat sherman
Subject: TMF697 - what is expected to be provided by the client in workOrderItem as part of creation of a new workOrder
Hi Ludovic,
Thanks for you reply. i'd like to refer to it and state the issues that i am not fully clear on.
You wrote:
1. Yes, it should be. The workOrderItem.id is an internal index of the item within this order. This id has only to be unique within the workOrder.
Meirav: So this is an internal indexing generated by me. i am cool with it.
2. The work specification is used to describe which work is requesting. For me, it is mandatory for a new work request else how you will specify what is
Meirav: i agree that i need to specify the work, but lets assume i want to install a terminal. so i surely need to send the location and the type of device/s. but these are sent in the under the order and place parameters. what else is required in the WorkSpecificationRef? if i send an id and name of a specific WorkSpecification, is that my internal generated input? i assume not. and in that case it means that i need to hold a full list of all the relevant work specifications that are mastered in the workforce mng system.
I dont think its correct. Why?
1. It is a duplication of information and what i see as an unnecessary coupling. When my workforce mng system will update its list of work specs, they will have to make sure i am aligned with them.
2. i need to hold a mapping between between category ("install"), deviceType, deviceMake/model, and maybe more and the workspecification. It seems like the workforce mng system responsibility.
I will be happy to discuss it further.
Meirav
------------------------------
meirav gat sherman
Amdocs Management Limited
Original Message:
Sent: Dec 30, 2021 03:31
From: Ludovic Robert
Subject: TMF697 - what is expected to be provided by the client in workOrderItem as part of creation of a new workOrder
Hello Meirav
WorkOrder follow the same pattern as all order API. The WorkOrder itself is some kind of header and each work requested are described in one WorkOrderItem. A workOrder could describe n requests for work (and so n WorkItems). The information at WorkOrder level are common for all WorkItem.
1. Yes, it should be. The workOrderItem.id is an internal index of the item within this order. This id has only to be unique within the workOrder.
2. The work specification is used to describe which work is requesting. For me, it is mandatory for a new work request else how you will specify what is expecting (unless it is implicit). The cardinality in the API is 0,1 to accommodate UC where an existing Work is in progress (like recurring work) and the workOrder/workorderItem is used to modify or terminate it (In this case the work.id is required).
Hope it helps,
Ludovic
------------------------------
Ludovic Robert
Orange
My answer are my own & don't represent necessarily my company or the TMF
Original Message:
Sent: Dec 21, 2021 11:59
From: meirav gat sherman
Subject: TMF697 - what is expected to be provided by the client in workOrderItem as part of creation of a new workOrder
hi,
I'm designing a fulfillment process where the orchestrator is sending a creation WO request.
In the current swagger i need to send a mandatory parameter - WorkOrderItem.
This complex structure specifies the Id and action as mandatory attributes.
My question are:
1. The WorkOrderItem Id is expected to be generated by the client?
2. WorkOrderItem has a workSpecification parameter. its not mandatory but i have a discussion with colleagues on whether the client needs to send any information in there.
My approach is to guarantee a decoupling of the orchestrator and the work force system and not send any work specifications. Orchestrator can send the required equipment, the location, the order action, but not the type of work that needs to be done.
Interested to get your inputs.
Meirav
------------------------------
meirav gat sherman
Amdocs Management Limited
------------------------------