Hello David,
We're working on the event with the V5 upgrade. Once this design done we'll upgrade all API.
Of course the event will be able to identify several attributes requiring value.
Do not took it as granted as we're still working on it but to provide you a glimpse ... this is what you can have (example on quote api but same pattern will apply):
{
"correlationId": "qs1-k33",
"description": "QuoteInformationRequiredEvent illustration",
"domain": "Commercial",
"eventId": "966",
"eventTime": "2021-09-27T07:43:59.059Z",
"eventType": "QuoteInformationRequiredEvent",
"priority": "1",
"timeOcurred": "2021-09-27T07:43:59.059Z",
"title": "QuoteInformationRequiredEvent",
"event": {
"quote": {
"id": "5252",
"href": "https://host:port/quoteManagement/v4/quote/5252",
"@type": "EntityRef",
"@referredtype": "Quote"
},
"informationRequired": {
"informationRequiredPath": [
{
"op": "add",
"path": "agreement.id"
},
{
"op": "add",
"path": "contactMedium"
}
]
}
},
"reportingSystem": {
"id": "123",
"name": "CRM app",
"@type": "ReportingResource",
"@referredType": "LogicalResource"
},
"source": {
"id": "123",
"name": "CRM app",
"@type": "ReportingResource",
"@referredType": "LogicalResource"
},
"@baseType": "Event",
"@type": "QuoteInformationRequiredEvent"
}
The informationRequired is an array of operation and path. Here in the example a agreement id and a complete contact medium structure is missing.
Hope it helps.
Ludovic
------------------------------
Ludovic Robert
Orange
My answer are my own & don't represent necessarily my company or the TMF
------------------------------
Original Message:
Sent: Mar 04, 2022 07:51
From: David Whitfield
Subject: TMf 641 - Information Required Event
Hey @Ludovic Robert any thoughts on this at all?
My other consideration since i first posted this question is that we have decided to extend TMF and do an early implementation of the Amend Task based resource. Since our thoughts were that an information required event would require that to be submitted (which could involve a new additional characterisitc) i'm not sure how this would be communicated by this event?
Obviously where there might be more than 1 is still i think the open point on how this would be communicated
------------------------------
David Whitfield
TalkTalk Group
Original Message:
Sent: Nov 19, 2021 11:04
From: David Whitfield
Subject: TMf 641 - Information Required Event
Hey @Ludovic Robert, do you know if this has got fixed as it seems that the swagger and user guide still doesnt contain this?
On another point where by there is more than one field which requires an update how is this communicated by the information required event?
------------------------------
David Whitfield
TalkTalk Group
Original Message:
Sent: Mar 10, 2021 03:27
From: Ludovic Robert
Subject: TMf 641 - Information Required Event
Hello Rati,
This is an already identify defect (see https://projects.tmforum.org/jira/browse/AP-2240 )
resourceType and filedPath attributes must be present in xxxxxAttributeValueChange & xxxxxInformationRequired notification structure.
I will check internally in our team progress on this Jira.
Thanks for the head up.
Ludovic
------------------------------
Ludovic Robert
Orange
My answer are my own & don't represent necessarily my company or the TMF
Original Message:
Sent: Mar 09, 2021 22:03
From: Rati Mehrotra
Subject: TMf 641 - Information Required Event
Hi @Ludovic Robert,
There was two fields for resourceType and filedPath in 641 v3( as shown below) , but in 641 v4 there is only fieldPath. Was there some decision made for removing the resourcePath in v4?
Thanks for your support.
Rati Mehrotra
@Uma Lakshman
------------------------------
Rati Mehrotra
Telstra Corporation
Original Message:
Sent: Feb 03, 2021 18:07
From: Lancy Mendonca
Subject: TMf 641 - Information Required Event
Hi Ludovic
Thanks for providing the response on field path. Noticed that the field path is a string and so can be used to flag that multiple fields have been updated or mutiple information is needed as part of the AttributeChange and InformationRequiredEvent. I could use some form of separator to separate the multiple field paths I assume
------------------------------
Lancy Mendonca
Original Message:
Sent: Sep 29, 2020 04:33
From: Lancy Mendonca
Subject: TMf 641 - Information Required Event
Hello Ludovic
Thank you very much for the response. That has definitely addressed my question.
Regards
Lance
------------------------------
Lancy Mendonca
Original Message:
Sent: Sep 29, 2020 02:48
From: Ludovic Robert
Subject: TMf 641 - Information Required Event
Hello Lance,
Specifically in the structure of the event 'xxxInformationRequired' and 'xxxAttributeValueChangeEvent' you'll find an attribute fieldPath: The path identifying the object field concerned by this notification. This will allow you to specify the path to the field requiring some information (something like this for example if we are waiting service characteristic valued for service order item 2 ..."fieldPath": "serviceOrder/456/serviceOrderItem/2/service/serviceCharacteristic/3").
Hope it helps,
Ludovic
------------------------------
Ludovic Robert
Orange
My answer are my own & don't represent necessarily my company or the TMF
Original Message:
Sent: Sep 24, 2020 10:26
From: Lancy Mendonca
Subject: TMf 641 - Information Required Event
Hi
Looking at the Service Ordering Management API User Guide for v20.5 it states
'The Pending state is used when an order/item is currently in a waiting stage for an action/activity to be completed before the order/item can progress further, pending order amend or cancel assessment. In situations where Access Seeker action is required, an "information required" notification will be issued on transition into this state. '
Looking at the JSON body for the event it states
{ "eventId":"00001", "eventTime":"2015-11-16T16:42:25-04:00", "eventType":"ServiceOrderInformationRequiredEvent", "event": { "serviceOrder" : {-- SEE ServiceOrder RESOURCE SAMPLE --} } }
How does the Service Order defined within the event - "event": { "serviceOrder" : {-- SEE ServiceOrder RESOURCE SAMPLE --} } communicate what information is required so that the information can be procured and the service order patched moving the service Order from Pending to InProgress. It would be useful to be able to send a 'code' that indicates what information is required.
Thoughts on how this can be implemented
------------------------------
Lance
------------------------------