Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Functional

#Interface

Requirement


Additional InformationSign-Off
1CPS-E-08.eNCMP is to merge CM Notification Subscriptions create request and forward those to DMI plugin. (Interface to be added).
  • Prevent unnecessary subscription updates to nodes already involved in a subscription to the same path and datastore.
  • For possible combinations, see table below

 kieran mccarthy Signed off .

2CPS-E-08.e

Last lights out: upon subscription Delete request only when there is no more subscription for a cm-handle & xpath & datastore combination a subscription-delete request will be sent to the relevant DMI(s).


 

3CPS-E-08.eA single client subscription request should result into a maximum of one request per DMI. Of course there can be several messages if more than 1 DMI is involved.

 

4CPS-E-08.eAmalgamate response should include rejected/accepted/pending DMI responses received within 30 seconds. A client shall be notified of available DMI subscription information after 30 seconds.  Subsequent DMI subscription updates shall be notified to clients as they become available.
  • Same schema for all notifications.
  • Subsequent notifications contains the state of all cmhandles involved in the subscription. 

 

5CPS-NCMP-I-01CM Handle deletion should NOT update subscription details. Do NOT delete dmi-subscription entry until owning subscription is deleted, see issue #4 below

 

6CPS-E-08.eBackward compatible with 'basic' created/delete operations.. TBD


 

7
Order of the create/delete subscription needs to be discussed . TBD.

...


Error ScenarioExpected behaviorSign-off
1DMI Downrejectedpending

 

2DMI Not responding withing 30 secpending

 

3create for non-existing cm handle id (NO DMI)accept subscription with rejected single cm-handle (2 with error details

 

4delete for non-existing cm handle id(silently?) ignore
5any operation on non-existing xpathignore? (no or minimal validation, see issue #5)
6delete for non existing name/client-idTBD, should be handle in 'basic' solution
7delete for no existing cm-handle idignore? (no or minimal validation, see issue #5)
8error upon error

An error scenario on a second subscription for the same cm-handle/xpath as a previous subscription which did not complete successfully (yet)

to be discussed, see tabel below


...

Max TBDAvg: 200Max: 
#ParameterExpectationNotesSign-off
1Maximum number of cm data subscriptions200

kieran mccarthy confirmed

 

2Maximum, Average CM Handles per subscription 

Avg:

200

Max: 500 (document only)

kieran mccarthy to confirm
Note: consider limit and future 'simple' ALL (wildcard) option when above that limit

 

3Maximum, Average XPaths per CmHandleAvg: 10

 

4Status update processing time limitBased on the numbers above working out the current state of each cm handle/xpath combination could be slow!

kieran mccarthy order of 30 seconds (NCMP side)

 

Out-of-scope

  1. CM Notification Forwarding Check: When forwarding CM Notification NCMP will not check the content to see if the is a valid active subscription. It is assumed that the DMI Plugin as acted on the 'delete subscription' request (that request is NCMPs responsibility). And of course there wil be timing issues it also possible a CM Notification was send just after the subscription-delete was send (from client) but before the whole change had acted upon that. 
  2. Retry: NCMP will only report when actions are pending or rejected. NCMP will not implement a retry mechanism
  3. Wildcards: Wildcards or similar functionality where one string represent 0 or more xpaths is not covered as part of this requirement but it should be kept in mind as a future possibility
  4. Dynamic Topic: Topic for CM Data Notifications back to client will be hardcode for now. 
    Study shoudl consider compatibility with an 'ALL' cm handles options

...


IssueNotes Decision
1Is it intended that CM Notification subscription request  cover (all) descendants of the given xpath too?!e.g.. if a child is removed and there is a subscription for the parent node, will a notification be send (grandchild, child leaf updates etc.) I hope NOT!
Consider:
  • Risk of client effectively subscribing to ALL data in a cm handle by specifying top level datanode(s)
  • Complexity (i.e. cost of) of merge operation. It might even required NCMP to check relevant dat model
  • Future use of wildcards, could be a viable alternative for including descendants

kieran mccarthy descendant not covered by 'basic' paths Wildcard will cover this kind of function in future 

2Could xpath point to an element that does not exist (yet)if not how, how can I client be informed about a create event? 

kieran mccarthy  yes, xpath can point to things that don't exist yet (not even in the curernt model when an upgraded is pending)

3Should NCMP support re-homing, moving of a CM Handle from one DMI to another?assume only trough delete & create 

kieran mccarthy out of scope 

4CM Handle Delete: Should DMI or Clients be sent a subscription update 

do NOT delete dmi-subscription entry until owning subscription is deleted
(just ignore upon future delete if cm handle is gone altogether)

Note. LCM is already broadcast (today) 


  • kieran mccarthy re-use existing LCM event → also send it on topic for he subscription (currently fixed topic)
  • Need to upgrade to CloudEevent format
  • Add subscription id (name+client id) to header (so client can filter)
5Validation of xpathoptions order of implement and also performance cost!
  1. none
  2. xpath-parser
  3. model check
  4. instance check

kieran mccarthy not required right now 

6can DMI plugin 'reject' a subscription create (for a given cm-handle-xpath combination)As NCMP might not validate as per issue#5 the DMI=plugin or component further down might have to reject an invalid xpath...

Priyank Maheshwari 

yes currently DMI can use response to say which cm handles are not accepted i.e. rejected' (but not 'pending') 

kieran mccarthyconfirms DMI can reject whole subscription

7implementation question: should 'rejected' DMI-subscriptions be storednot needed as whole subscription should be rejected

kieran mccarthyconfirms

8Dimensioning of DB depends on #cm handles, #subscriptions and #xpaths per subscription, this could be too big for fast processing of updates! Need to agree maximum and possibly realistic average/total number of entries based on the characteristics  above
The team is blocked until this becomes clear as it wil affect the way the data needs to be modelled exactly
ongoing but not completed!
9Maximum (error) message sizetheoretically all cm handles and all xpaths combinations could be rejected or pending leading to a very large error message!

Toine Siebelink no longer relevant given and max decided 

10can each CM-Handle have different set of xpath(s) per subscriptionthe  current 'basic' solution only supports a common set of datastore/xpaths (filter)

 kieran mccarthy Yes, clients will create only one subscription and they might have different needs for different nodes (cm handles) 

11can the same cm handle/xpath have different subscriptions with different datastores, does that affect the cm data notifications send (which datastore applies)
  • can register on any (passthrough) datastore
    • running
    • operational

  • compulsory, validation needed
  • part of KEY (unique entry) so cmHandle+datastore+xpath is the key 


kieran mccarthy datastore included.

Although this wiki-page will not be updated where cmHandle+xpath is mentioned as  unique entry etc. this should now include a third field: datastore as well.

12Will migration from 'basic' be supportedPreferred to ask customers to create new subscriptions

kieran mccarthy no need to support (migration) of 'basic' solution. Development of 'basic' solution can be stopped!

13list v list instances filtering

/p/c1
/p/c1[@key=23]
Are these different paths or not (from ncmp point of view)
*List instances might not always be supported, depending DMI Plugin impl.

kieran mccarthy yes, from NCMP point of view a list and a list entry are different xpaths

14confirm subscription id (currently subscription name + client id)

kieran mccarthy to clarify ASAP including exact format

all prefer a single id-field

just subscirption-id (String)

15what subscription details should be send when there is a change (in the union)
  1. just delta
  2. just union
  3. union and delta (delta flagged) 

(after initial meeting) kieran mccarthy & Toine Siebelink  agreed that because of the possible size of the union (200x200x10=400,000) it is only feasible to send the delta ie option 1.

16one DMI rejects whole (see decision #6) subscription (affected cmhandles) but other DMI accepts the same subscription, is this possible how to handle

kieran mccarthy only sends message back to client about rejected DMIs i.e. the subscription can be partially 'active'

...