Context Equivalent of RaiseIntent - Issue 213 #268

sgd2z · 2020-10-19T16:02:06Z

PR for Issue #213

mattjamieson · 2020-10-21T19:39:39Z

Is there any scenario where we would want to raiseContext with a target? I can see it being potentially useful where the target is known but the Desktop Agent has UI (or other) features for intent resolution which can be used prior to passing the intent+context to the target.

raiseContext(context: Context, target?: string);

rikoe · 2020-10-22T10:17:38Z

Is there any scenario where we would want to raiseContext with a target? I can see it being potentially useful where the target is known but the Desktop Agent has UI (or other) features for intent resolution which can be used prior to passing the intent+context to the target.
raiseContext(context: Context, target?: string);

@mattjamieson I agree, it doesn't hurt, and is consistent with raiseIntent. Although to be consistent with #272 it should probably be raiseContext(context: Context, target?: string | AppMetadata) 😉

mattjamieson · 2020-10-22T10:20:07Z

[...] to be consistent with #272 it should probably be raiseContext(context: Context, target?: string | AppMetadata) 😉

👍, might also be nice to define:

type Target = string | AppMetadata;

rikoe · 2020-10-22T10:22:00Z

docs/api/ref/DesktopAgent.md

@@ -20,6 +20,7 @@ interface DesktopAgent {
  findIntent(intent: string, context?: Context): Promise<AppIntent>;
  findIntentsByContext(context: Context): Promise<Array<AppIntent>>;
  raiseIntent(intent: string, context: Context, target?: string): Promise<IntentResolution>;
+  raiseContext(context: Context): Promise<IntentResolution>;


I would prefer if we can call this raiseIntentForContext.

There are two reasons for this:

You can't raise a "context", that doesn't make sense intuitively.

raiseIntent and raiseIntentForContext would follow the same pattern as findIntent and findIntentsByContext, one of which takes an intent name, and the other just a context. It's good symmetry.

That's a good suggestion. Also makes explaining it simpler. I'll update the PR and docs.

maybe 'raiseIntentsByContext' ?

rikoe · 2020-10-22T10:23:55Z

docs/api/ref/DesktopAgent.md

+```ts
+raiseContext(context: Context): Promise<IntentResolution>;
+```
+Raises a context to the desktop agent to resolve. Raise context deals with the case where a context can have multiple associated intents. Similar to raiseIntent without a target, it provides the opportunity for Intent and target selection, which can result in a call to raiseIntent with a target under the hood to provide Intent resolution.


This description doesn't make sense to me, mostly I think because it is not clear what "raising a context" means if you don't understand that under the covers the desktop is looking up intent(s) for the context and asking the user to pick one.

I think it is good if FDC3 (at this stage) only have one "thing" that can be "raised", but there are different ways of doing so, i.e. based on name, and based on context.

rikoe · 2020-10-22T10:24:44Z

docs/api/spec.md

@@ -78,29 +78,31 @@ Examples of End Points include:
 ### Open an Application by Name
 Linking from one application to another is a critical basic workflow that the web revolutionized via the hyperlink.  Supporting semantic addressing of applications across different technologies and platform domains greatly reduces friction in linking different applications into a single workflow.

-### Raising Intents
+### Raising Intents or Contexts


This could be changed back to just Raising Intents - there is not an additional concept to understand.

rikoe · 2020-10-22T10:25:43Z

docs/api/spec.md

 Often, we want to link from one app to another to dynamically create a workflow.  Enabling this without requiring prior knowledge between apps is a key goal of FDC3.

-Intents provide a way for an app to request functionality from another app and defer the discovery and launching of the destination app to the Desktop Agent.  There are multiple models for interop that Intents can support.
+Intents provide a way for an app to request functionality from another app and defer the discovery and launching of the destination app to the Desktop Agent.  There are multiple models for interop that Contexts and Intents can support.


Here as well, this paragraph really refers to Intents, not to Contexts (which can't be raised in and of themselves) - just sticking to Intents as the thing that can be raised will make this clearer.

rikoe · 2020-10-22T10:27:05Z

docs/api/spec.md


 - **Chain**:  In this case the workflow is completely handed off from one app to another (similar to linking).   Currently, this is the primary focus in FDC3
 - **Client-Service**: A Client invokes a Service via the Intent, the Service performs some function, then passes the workflow back to the Client.  Typically, there is a data payload type associated with this intent that is published as the standard contract for the intent.
 - **Remote API**: An app wants to remote an entire API that it owns to another App.  In this case, the API for the App cannot be standardized.  However, the FDC3 API can address how an App connects to another App in order to get access to a proprietary API.

+A Context can be associated with multiple intents. For example, an instrument could be associated with ViewChart, ViewNews, ViewAnalysis or some other intent. Raising a context provides the opportunity for the system or the user to select the appropriate Intent for the selected Context and resolve that Intent.


"Raising an intent by context provides" .... "for the provided Context" (the context isn't being selected, the intent is).

rikoe · 2020-10-22T10:27:46Z

docs/api/spec.md

 #### Intent Resolution
-Raising an Intent will return a Promise-type object that will resolve/reject based on a number of factors.
+Raising an Intent or a Context will return a Promise-type object that will resolve/reject based on a number of factors.


The title says "Intent Resolution", but it then talks about "Raising an Intent or Context" - removing the concept of raising "contexts" removes this ambiguity.

rikoe · 2020-10-22T10:29:18Z

docs/api/spec.md

- Intent was resolved unambigiously and the recieving app was launched successfully.
- Intent was ambigious, a resolution was chosen by the end user and the chosen application was launched succesfully.
+- Intent was resolved unambiguously and the receiving app was launched successfully.
+- Intent was ambiguous, a resolution was chosen by the end user and the chosen application was launched successfully.


I think in this case the intent resolution return type should tell you which intent was ultimately selected by the user, otherwise this information is lost.

rikoe · 2020-10-22T10:30:51Z

docs/api/spec.md

+}
+catch (er){
+    console.log(er.message);
+}


I suggest expanding IntentResolution with an intentName property, which will match the provided name when using raiseIntent, but will be populated with the selected intentName when resolved by the user or desktop agent based on context alone.

I suggest expanding IntentResolution with an intentName property, which will match the provided name when using raiseIntent, but will be populated with the selected intentName when resolved by the user or desktop agent based on context alone.

Just to confirm, will consider this as a separate Issue/PR 👍

sgd2z · 2020-10-22T12:37:27Z

Is there any scenario where we would want to raiseContext with a target? I can see it being potentially useful where the target is known but the Desktop Agent has UI (or other) features for intent resolution which can be used prior to passing the intent+context to the target.
raiseContext(context: Context, target?: string);

Interesting idea. We should discuss in the meeting. I was thinking that raiseContext would eventually result in a raiseIntent call with a target and only added a raiseContext without a target. For drag and drop I was thinking of private temporary channel broadcast.

kriswest

WG feedback: Addition to API makes sense, some changes requested for @sgd2z to make:

update function name to raiseIntentForContext
add optional target parameter for filtering purposes
ensure that docs are clear that IntentResolver UI should ask you to select an intent (which the resolver doesn't do at the moment), then an app to resolve it (unless a target was specified)

Consider:

naming: should intent be plural? IMHO no :-)
(Separate issue) extend IntentResolution to return the intent name (string) and target (AppMetadata) selected in the resolver (helps developers know where it should have gone, possibly log the action for product Intelligence).

sgd2z · 2020-11-17T20:01:25Z

PR has been updated with feedback and based on our discussions

docs/api/spec.md

src/api/DesktopAgent.ts

docs/api/ref/DesktopAgent.md

Context Equivalent of RaiseIntent

a3b3802

finos-cla-bot bot added the cla-present label Oct 19, 2020

rikoe suggested changes Oct 22, 2020

View reviewed changes

kriswest requested changes Oct 22, 2020

View reviewed changes

PR & Discussion feedback

f8b66e1

sgd2z requested review from rikoe, nkolba and kriswest November 17, 2020 20:01

sgd2z mentioned this pull request Nov 17, 2020

Intent Resolution Should Contain selected Intent #284

Closed

Merge branch 'master' into context-equivalent-of-raiseIntent

677ffc9

sgd2z commented Dec 3, 2020

View reviewed changes

docs/api/spec.md Outdated Show resolved Hide resolved

Update docs/api/spec.md

c0c7285

sgd2z commented Dec 3, 2020

View reviewed changes

src/api/DesktopAgent.ts Outdated Show resolved Hide resolved

sgd2z commented Dec 3, 2020

View reviewed changes

docs/api/ref/DesktopAgent.md Outdated Show resolved Hide resolved

sgd2z commented Dec 3, 2020

View reviewed changes

docs/api/ref/DesktopAgent.md Outdated Show resolved Hide resolved

Apply suggestions from code review

1bb4e99

rikoe approved these changes Dec 4, 2020

View reviewed changes

rikoe mentioned this pull request Jan 7, 2021

Standard WG Meeting - Jan 7, 2020 #298

Closed

19 tasks

rikoe approved these changes Jan 26, 2021

View reviewed changes

rikoe merged commit 3006545 into finos:master Jan 26, 2021

rikoe added this to the 1.2 milestone Jan 26, 2021

kriswest deleted the context-equivalent-of-raiseIntent branch October 8, 2021 11:39

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Context Equivalent of RaiseIntent - Issue 213 #268

Context Equivalent of RaiseIntent - Issue 213 #268

sgd2z commented Oct 19, 2020

mattjamieson commented Oct 21, 2020

rikoe commented Oct 22, 2020

mattjamieson commented Oct 22, 2020

rikoe Oct 22, 2020

sgd2z Oct 22, 2020 •

edited

Loading

nkolba Oct 22, 2020

rikoe Oct 22, 2020

rikoe Oct 22, 2020

rikoe Oct 22, 2020

rikoe Oct 22, 2020

rikoe Oct 22, 2020

rikoe Oct 22, 2020

rikoe Oct 22, 2020

rikoe Oct 22, 2020

sgd2z Nov 18, 2020

sgd2z commented Oct 22, 2020

kriswest left a comment •

edited

Loading

sgd2z commented Nov 17, 2020

Context Equivalent of RaiseIntent - Issue 213 #268

Context Equivalent of RaiseIntent - Issue 213 #268

Conversation

sgd2z commented Oct 19, 2020

mattjamieson commented Oct 21, 2020

rikoe commented Oct 22, 2020

mattjamieson commented Oct 22, 2020

Choose a reason for hiding this comment

sgd2z Oct 22, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sgd2z commented Oct 22, 2020

kriswest left a comment • edited Loading

Choose a reason for hiding this comment

sgd2z commented Nov 17, 2020

sgd2z Oct 22, 2020 •

edited

Loading

kriswest left a comment •

edited

Loading