Hi Yannick,
unfortunately I don't know any documentation from IBM except the links Priyal mentioned.
However, your question has also bothered me several times. I have created the following listing based on the edsPlugin:
ResponseFilter
| filteredServices |
added by edsPlugin
clientContext.action |
| "/cm/openContentClass", "/p8/openContentClass", "/cmis/openContentClass", "/od/openContentClass", "/box/openMetadataTemplate" |
|
| "/p8/openItem", "/cm/openItem", "/cmis/openItem", "/od/openItem", "/box/openItem" |
|
| "/p8/getLaunchParameters", "/p8/getStepParameters" |
|
| "/p8/getDependentParameters" |
|
| "/p8/getDependentAttributeInfo", "/cm/getDependentAttributeInfo", "/cmis/getDependentAttributeInfo", "/od/getDependentAttributeInfo", "/box/getDependentAttributeInfo" |
"workflow" |
| "/cm/openSearchTemplate", "/p8/openSearchTemplate", "/od/openSearchTemplate" |
"openSearchTemplate" |
| "/p8/getFilterCriteria" |
|
| "/cm/getStepParameters" |
|
| "/cm/getDependentParameters" |
"workflow" |
| "/pluginRepository" |
|
RequestFilter
| filteredServices |
added by edsPlugin
clientContext.action |
| "/p8/addItem", "/cm/addItem", "/cmis/addItem", "/od/addItem", "/box/addItem", "/p8/addLargeItem", "/cm/addLargeItem", "/p8/setupForAsperaAdd" |
"addItem"
"addLargeItem"
"setupForAsperaAdd" |
| "/p8/checkIn", "/cm/checkIn", "/cmis/checkIn", "/box/checkIn" |
"checkIn" |
| "/p8/editAttributes", "/cm/editAttributes", "/cmis/editAttributes", "/od/editAttributes", "/box/editAttributes" |
"editAttributes" |
| "/p8/search", "/cm/search", "od/search" |
|
| "/p8/completeStep" |
"completeStep" |
| "/cm/completeStep" |
"completeStep" |
| "/pluginRepository" |
|
This is undocumented behavior. So you can't rely on it. But maybe that's a good starting point.
That along with an activity diagram of which user action calls which services should be what you're looking for.
For displaying attribute values, you don't need to get the entire choice list but only the displayName via the EDS (if it differs from the value). Only for the action "editAttributes" you need the whole choice list.
But with all these considerations it is challenging to write a well readable and well maintainable code ;-) Currently, if we depend on the context of an action in a use case, we prefer to implement an ICN plugin than to use an EDS.
By the way:
A choice list
of thousands items via the EDS means that the entire choice list is transferred to the client each time. Maybe you can work better with dependent choice lists to reduce the list by filtering. Or implement a custom attribute editor that retrieves values from the external data source only when some characters are entered.
------------------------------
Christoph Sünderkamp
------------------------------
Original Message:
Sent: Tue September 20, 2022 02:12 PM
From: Yannick Martin
Subject: Navigator - External Data Services - use cases
Hi Priyal,
thank you for all these links.
Is there an additional description about the possible combination between actions and request modes ?
Or all the combinations of the couple action/request mode are to be handled by the EDS application ?
Thanks again
------------------------------
Yannick Martin
Original Message:
Sent: Tue September 20, 2022 07:06 AM
From: Priyal Mujumdar
Subject: Navigator - External Data Services - use cases
Hi,
I think you might find below IBM Technotes helpful.
https://www.ibm.com/docs/en/content-navigator/3.0.x?topic=SSEUEX_3.0.8/com.ibm.developingeuc.doc/eucap001.htm
https://www.ibm.com/support/pages/register-and-configure-eds-plug-reference-custom-eds-data-source-plug
https://www.ibm.com/docs/en/content-navigator/3.0.x?topic=SSEUEX_3.0.8/com.ibm.developingeuc.doc/eucap005.htm
The sample example in this technote explains how to accomplish data source access from EDS plugin.
Sample source code for the example is also available here - https://github.com/ibm-ecm/ibm-content-navigator-samples
------------------------------
Priyal Mujumdar
Original Message:
Sent: Tue September 20, 2022 06:55 AM
From: Yannick Martin
Subject: Navigator - External Data Services - use cases
Hi,
we're searching the documentation about the detailled behaviour of the EDS plugin.
The question is : when is the eds called by the Navigator and what for ?
As example when in the browse view, a document is clicked, the EDS application is called twice with action = null dans action = editProperties.
2 widgets seem to call the EDS.
If all theses rules are well known, we can tune the EDS behaviour when we have, as example, a proprerty with a choice list (from DB) of thousands items.
Thanks for help
------------------------------
Yannick Martin
------------------------------