592 intent proposal create interaction #747

pauldyson · 2022-06-08T17:00:31Z

Closes #592

linux-foundation-easycla · 2022-06-08T17:00:35Z

The committers listed above are authorized under a signed CLA.

✅ login: milindchidrawar (9f6294f, 6accbc1, 10f1e44)
✅ login: pauldyson / name: Paul Dyson (d74f407)

netlify · 2022-06-08T17:00:39Z

✅ Deploy Preview for lambent-kulfi-cf51a7 ready!

Name	Link
🔨 Latest commit	`a3c3f2f`
🔍 Latest deploy log	https://app.netlify.com/sites/lambent-kulfi-cf51a7/deploys/637c75aff6e9870008552940
😎 Deploy Preview	https://deploy-preview-747--lambent-kulfi-cf51a7.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

pauldyson · 2022-06-09T07:11:33Z

@kriswest @mistryvinay the PR build is failing because we reference TimeRange (as discussed at the last working group) and whilst it is documented, the TS definition appears to be missing. I'm happy to add it but I'm assuming it should be in master rather than this branch.

mistryvinay · 2022-06-09T08:53:04Z

@kriswest @mistryvinay the PR build is failing because we reference TimeRange (as discussed at the last working group) and whilst it is documented, the TS definition appears to be missing. I'm happy to add it but I'm assuming it should be in master rather than this branch.

Hi @pauldyson i think the issue you are seeing is because of this https://github.com/finos/FDC3/pull/724/files#r881622916 will let @kriswest comment if this is correct.

…3/master build.

Yannick-Malins · 2022-07-21T15:51:03Z

should this be called "record interaction"? reading through the PR code I got the impression that this was a generic way to start an interaction through various channels. but discussing with the domain experts it's more a case of recording an existing interaction to CRM or similar?

kriswest · 2022-07-21T16:20:21Z

@Yannick-Symphony I believe it's Create as in CRUD. It's following the naming conventions at https://fdc3.finos.org/docs/next/intents/spec#intent-name-prefixes (although looks like we went off-piste with 'Get' rather than 'Retrieve'.

Note that intents also have display names (although there is a slight problem with them as each app defines them #312 - it hasn't been high on the list to solve however so is still open).

kriswest · 2022-07-21T16:22:04Z

@pauldyson @milindchidrawar could you resolve conflicts - when you push it'll re-run the checks and should pass now.

kriswest · 2022-07-21T16:46:09Z

docs/context/spec.md

+- [`fdc3.interaction`](ref/Interaction) ([schema](/schemas/next/interaction.schema.json))
 - [`fdc3.instrument`](ref/Instrument) ([schema](/schemas/next/instrument.schema.json))
 - [`fdc3.instrumentList`](ref/InstrumentList) ([schema](/schemas/next/instrumentList.schema.json))


pls move after the fdc3.instrument* types

Suggested change

- [`fdc3.interaction`](ref/Interaction) ([schema](/schemas/next/interaction.schema.json))

- [`fdc3.instrument`](ref/Instrument) ([schema](/schemas/next/instrument.schema.json))

- [`fdc3.instrumentList`](ref/InstrumentList) ([schema](/schemas/next/instrumentList.schema.json))

- [`fdc3.instrument`](ref/Instrument) ([schema](/schemas/next/instrument.schema.json))

- [`fdc3.instrumentList`](ref/InstrumentList) ([schema](/schemas/next/instrumentList.schema.json))

- [`fdc3.interaction`](ref/Interaction) ([schema](/schemas/next/interaction.schema.json))

kriswest · 2022-07-21T16:47:27Z

src/context/schemas.json

+  "Interaction": ["https://fdc3.finos.org/schemas/next/interaction.schema.json"],
  "Instrument": ["https://fdc3.finos.org/schemas/next/instrument.schema.json"],
  "InstrumentList": ["https://fdc3.finos.org/schemas/next/instrumentList.schema.json"],


Alphabetical order

Suggested change

"Interaction": ["https://fdc3.finos.org/schemas/next/interaction.schema.json"],

"Instrument": ["https://fdc3.finos.org/schemas/next/instrument.schema.json"],

"InstrumentList": ["https://fdc3.finos.org/schemas/next/instrumentList.schema.json"],

"Instrument": ["https://fdc3.finos.org/schemas/next/instrument.schema.json"],

"InstrumentList": ["https://fdc3.finos.org/schemas/next/instrumentList.schema.json"],

"Interaction": ["https://fdc3.finos.org/schemas/next/interaction.schema.json"],

kriswest · 2022-07-21T16:48:46Z

src/intents/Intents.ts

@@ -13,4 +13,5 @@ export enum Intents {
  ViewProfile = 'ViewProfile',
  ViewQuote = 'ViewQuote',
  ViewResearch = 'ViewResearch',
+  CreateInteraction = 'CreateInteraction',


Add in alphabetical order pls

kriswest · 2022-07-21T16:49:03Z

src/intents/standard intents.json

+    },
+    {
+      "name": "CreateInteraction",
+      "displayName": "Create Interaction"


Add in alphabetical order pls

kriswest · 2022-07-21T16:49:12Z

website/sidebars.json

@@ -52,6 +52,7 @@
          "intents/ref/ViewProfile",
          "intents/ref/ViewQuote",
          "intents/ref/ViewResearch",
+          "intents/ref/CreateInteraction",


Add in alphabetical order pls

kriswest · 2022-07-21T16:49:42Z

website/sidebars.json

+          "context/ref/Interaction",
          "context/ref/Instrument",
          "context/ref/InstrumentList",


Alphabetical order pls

Suggested change

"context/ref/Interaction",

"context/ref/Instrument",

"context/ref/InstrumentList",

"context/ref/Instrument",

"context/ref/InstrumentList",

"context/ref/Interaction",

kriswest · 2022-07-21T16:51:03Z

website/yarn.lock

@@ -4,34 +4,41 @@

 "@ampproject/remapping@^2.1.0":
  version "2.2.0"
-  resolved "https://registry.yarnpkg.com/@ampproject/remapping/-/remapping-2.2.0.tgz#56c133824780de3174aed5ab6834f3026790154d"
+  resolved "https://registry.npmjs.org/@ampproject/remapping/-/remapping-2.2.0.tgz"


Minor, but probably best to remove file from PR

kriswest · 2022-07-21T16:54:55Z

Added suggestions for alphabetical order corrections, couldn't do them all unfortunately.
If you do them here you can then merge this into your other PR #761 OR you can rebase that PR off master to remove this one's changes from it (technically better as it makes them independent and the diffs are nicer - however I think both will go in at around same time).

mistryvinay · 2022-07-22T10:18:28Z

hi @kriswest
I also have this PR which is awaiting approval by @milindchidrawar @pauldyson to resolve some of the above. singletracksystems#7

milindchidrawar · 2022-08-02T06:09:57Z

Hi @kriswest @mistryvinay many thanks for the feedback. I will be working through these updates ahead of our next working group meeting and will let you know if I have any questions.

mistryvinay

LGTM

kriswest

Theres still a small handful of minor changes to do here - but otherwise this looks good to me!

kriswest · 2022-10-06T12:34:47Z

CHANGELOG.md

@@ -56,6 +56,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 * Added an `interop` field to AppD application records, replacing the `intents` field, to more fully describe an app's use of FDC3 and enable search for apps that 'interoperate' with a selected app ([#697](https://github.com/finos/FDC3/pull/697))
 * Added `AppIdentifier` type, which is a new parent of `AppMetadata` and clarifies required fields for API call parameters which now prefer `appId` and `instanceId` over `name` ([#722](https://github.com/finos/FDC3/pull/722))
 * Added a `getAppMetdata()` function to the desktop agent that can be used to retrieve the full `AppMetadata` for an `AppIdentifier` and reduced types such as `IntentResolution.source` and `ContextMetadata.source` from `AppMetadata` to `AppIdentifier` to clarify what fields a developer can rely on and that they should manually retrieve the full `AppMetadata` when they need it for display purposes. ([#751](https://github.com/finos/FDC3/pull/751))
+* Added `CreateInteraction` intent. To be used when a user wants to record an interaction into a system.  New context `Interaction` also introduced. An interaction might be a call, IM, email, a meeting (physical or virtual) or the preparation of some specialist data. ([#747](https://github.com/finos/FDC3/pull/747))


Apologies @milindchidrawar this should go into the unreleased section at the top of this file, as 2.0 was already released

kriswest · 2022-10-06T12:38:20Z

docs/context/ref/Interaction.md

+---
+# `Interaction`
+
+An interaction is a significant direct exchange of ideas or information between a Sell Side party and one or more Buy Side parties. An interaction might be a call, a meeting (physical or virtual), an IM or the preparation of some specialist data.


Small edits suggested:

Suggested change

An interaction is a significant direct exchange of ideas or information between a Sell Side party and one or more Buy Side parties. An interaction might be a call, a meeting (physical or virtual), an IM or the preparation of some specialist data.

An `Interaction` is a significant direct exchange of ideas or information between a number of participants, e.g. a Sell Side party and one or more Buy Side parties. An `Interaction` might be a call, a meeting (physical or virtual), an IM or the preparation of some specialist data.

Can you elaborate on how 'preparation of some specialist data' is an interaction?

kriswest · 2022-10-06T12:39:09Z

docs/context/ref/Interaction.md

+
+Notes:
+
+- interactionType SHOULD be one of 'Instant Message', 'Email', 'Call', or 'Meeting' although other values can be provided


Suggested change

- interactionType SHOULD be one of 'Instant Message', 'Email', 'Call', or 'Meeting' although other values can be provided

- `interactionType` SHOULD be one of `'Instant Message'`, `'Email'`, `'Call'`, or `'Meeting'` although other string values are permitted.

kriswest · 2022-10-06T12:40:35Z

docs/context/ref/Interaction.md

+Notes:
+
+- interactionType SHOULD be one of 'Instant Message', 'Email', 'Call', or 'Meeting' although other values can be provided
+- origin indicates the application or service that the interaction was created from to aid in tracing the source of the interaction


Suggested change

- origin indicates the application or service that the interaction was created from to aid in tracing the source of the interaction

- `origin` is used to represent the application or service that the interaction was created from to aid in tracing the source of an interaction.

kriswest · 2022-10-06T12:45:06Z

docs/intents/ref/CreateInteraction.md

+---
+# `CreateInteraction`
+
+Create an interaction with a list of contacts.


Suggested change

Create an interaction with a list of contacts.

Create a record documenting an interaction (calls, meetings, etc.) between a list of contacts.

docs/intents/ref/CreateInteraction.md

kriswest · 2022-10-06T12:48:04Z

src/context/ContextTypes.ts

+  origin?: string;
+}
+
+export interface InstrumentList {


Copy paste error? This already appears on lines 168-173

Also, this looks like a manual addition as there are other parts that are missing (martialling functions to/from JSON).

That's not the end of the world as we'll re-generate this file after a merge to master. Hence, feel free to either correct this or remove the changes to this file entirely.

Hi @kriswest thanks for your patience with this. This should all be taken care of now.

src/context/schemas/interaction.schema.json

website/static/schemas/next/interaction.schema.json

kriswest · 2022-11-03T11:21:18Z

@milindchidrawar spotted another minor error in the schema - please commit the suggestions I've just added.

Co-authored-by: Kris West <kris@cosaic.io>

mistryvinay

LGTM

pierreneu · 2023-01-05T13:25:25Z

@pierreneu the intention is that it is a single interaction (conversation) whether it is one message or a whole series of them

I guess that's fine. So there is a single initiator to the interaction, and when we are reporting several messages as part of one interaction, the initiator field cannot be used to track the sender of each message.
If we want to track who said what with the current format, we would need to add the user names directly within the Description field.

kriswest · 2023-02-02T15:25:14Z

@mistryvinay this PR has conflicts with master again, however, i would suggest just going ahead and starting off a consolidated PR (branch off master), merge this into it (may require @milindchidrawar to merge master and resolve conflicts again, apologies), then we can merge in others (e.g. TransactionResult, Symphony PRs) and submit that consolidated PR to SWG for inclusion.

milindchidrawar and others added 4 commits June 7, 2022 15:13

add-create-interaction-intent

9f6294f

add-create-interaction-intent

6accbc1

add-create-interaction-intent

10f1e44

Interaction context added

d74f407

mistryvinay added enhancement New feature or request intents Context Data & Intents Contexts & Intents Discussion Group labels Jun 9, 2022

update CreateInteraction to use origin instead of source

6abb14d

kriswest mentioned this pull request Jun 9, 2022

Ensure types are generated when new contexts are merged into master branch #749

Closed

mistryvinay added a commit that referenced this pull request Jul 1, 2022

Update to PR #747 to resolve conflicts with Master

5d44e13

mistryvinay added 2 commits July 4, 2022 17:07

Updated 592-intent-proposal-create-interaction branch with latest FDC…

a117878

…3/master build.

Updates to sidebar.json and comments in CHANGELOG.md

d3b02df

kriswest mentioned this pull request Jul 21, 2022

592 771 context proposal TransactionResult #761

Merged

kriswest reviewed Jul 21, 2022

View reviewed changes

mistryvinay mentioned this pull request Oct 4, 2022

Context Data & Intents Discussion group - 6 Oct 2022 #826

Closed

14 tasks

updated CHANGELOG.MD to remove reference to View Interaction

8b040d9

mistryvinay approved these changes Oct 6, 2022

View reviewed changes

kriswest requested changes Oct 6, 2022

View reviewed changes

milindchidrawar and others added 2 commits October 18, 2022 11:15

Merge branch 'finos:master' into 592-intent-proposal-create-interaction

0b67e69

updates to context and intent descriptions and cleanup ContextTypes.ts

25f1efa

mistryvinay mentioned this pull request Oct 31, 2022

Context Data & Intents Discussion group - 3 Nov 2022 #845

Closed

12 tasks

Merge branch 'finos:master' into 592-intent-proposal-create-interaction

b62d702

kriswest reviewed Nov 3, 2022

View reviewed changes

src/context/schemas/interaction.schema.json Outdated Show resolved Hide resolved

kriswest reviewed Nov 3, 2022

View reviewed changes

website/static/schemas/next/interaction.schema.json Outdated Show resolved Hide resolved

milindchidrawar and others added 5 commits November 15, 2022 16:40

Update src/context/schemas/interaction.schema.json

ef838e1

Co-authored-by: Kris West <kris@cosaic.io>

Update website/static/schemas/next/interaction.schema.json

bb01a1c

Co-authored-by: Kris West <kris@cosaic.io>

Merge branch 'finos:master' into 592-intent-proposal-create-interaction

b404098

add ViewInteractions to the list of related intents

5491a09

remove lock file from PR

a3c3f2f

mistryvinay mentioned this pull request Nov 30, 2022

Context Data & Intents Discussion group - 1 Dec 2022 #868

Closed

9 tasks

mistryvinay reviewed Jan 3, 2023

View reviewed changes

mistryvinay requested a review from kriswest January 3, 2023 12:22

mistryvinay mentioned this pull request Jan 3, 2023

Context Data & Intents Discussion group - 5 Jan 2023 #888

Closed

8 tasks

mistryvinay mentioned this pull request Jan 31, 2023

Context Data & Intents Discussion group - 2 Feb 2023 #903

Closed

8 tasks

mistryvinay mentioned this pull request Feb 27, 2023

Context Data & Intents Discussion group - 2 Mar 2023 #916

Closed

15 tasks

mistryvinay changed the base branch from master to context-data-and-intents-consolidated-update-branch-2.1 March 22, 2023 13:16

mistryvinay merged commit 35d90e2 into finos:context-data-and-intents-consolidated-update-branch-2.1 Mar 22, 2023

kriswest modified the milestones: 2.1-candidates, 2.1 Apr 27, 2023

kriswest removed this from the 2.1 milestone Jul 25, 2023

bingenito mentioned this pull request Nov 6, 2023

Update to FDC3 2.1 finos/fdc3-dotnet#74

Closed

18 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

592 intent proposal create interaction #747

592 intent proposal create interaction #747

pauldyson commented Jun 8, 2022

linux-foundation-easycla bot commented Jun 8, 2022 •

edited

Loading

netlify bot commented Jun 8, 2022 •

edited

Loading

pauldyson commented Jun 9, 2022

mistryvinay commented Jun 9, 2022

Yannick-Malins commented Jul 21, 2022

kriswest commented Jul 21, 2022

kriswest commented Jul 21, 2022

kriswest Jul 21, 2022

kriswest Jul 21, 2022

kriswest Jul 21, 2022

kriswest Jul 21, 2022

kriswest Jul 21, 2022

kriswest Jul 21, 2022

kriswest Jul 21, 2022

kriswest commented Jul 21, 2022

mistryvinay commented Jul 22, 2022

milindchidrawar commented Aug 2, 2022

mistryvinay left a comment

kriswest left a comment

kriswest Oct 6, 2022

kriswest Oct 6, 2022

kriswest Oct 6, 2022

kriswest Oct 6, 2022

kriswest Oct 6, 2022

kriswest Oct 6, 2022

kriswest Oct 6, 2022

milindchidrawar Oct 18, 2022

kriswest commented Nov 3, 2022

mistryvinay left a comment

pierreneu commented Jan 5, 2023

kriswest commented Feb 2, 2023

	An interaction is a significant direct exchange of ideas or information between a Sell Side party and one or more Buy Side parties. An interaction might be a call, a meeting (physical or virtual), an IM or the preparation of some specialist data.
	An `Interaction` is a significant direct exchange of ideas or information between a number of participants, e.g. a Sell Side party and one or more Buy Side parties. An `Interaction` might be a call, a meeting (physical or virtual), an IM or the preparation of some specialist data.


		Notes:

		- interactionType SHOULD be one of 'Instant Message', 'Email', 'Call', or 'Meeting' although other values can be provided

	- interactionType SHOULD be one of 'Instant Message', 'Email', 'Call', or 'Meeting' although other values can be provided
	- `interactionType` SHOULD be one of `'Instant Message'`, `'Email'`, `'Call'`, or `'Meeting'` although other string values are permitted.

	- origin indicates the application or service that the interaction was created from to aid in tracing the source of the interaction
	- `origin` is used to represent the application or service that the interaction was created from to aid in tracing the source of an interaction.

	Create an interaction with a list of contacts.
	Create a record documenting an interaction (calls, meetings, etc.) between a list of contacts.

592 intent proposal create interaction #747

592 intent proposal create interaction #747

Conversation

pauldyson commented Jun 8, 2022

linux-foundation-easycla bot commented Jun 8, 2022 • edited Loading

netlify bot commented Jun 8, 2022 • edited Loading

✅ Deploy Preview for lambent-kulfi-cf51a7 ready!

pauldyson commented Jun 9, 2022

mistryvinay commented Jun 9, 2022

Yannick-Malins commented Jul 21, 2022

kriswest commented Jul 21, 2022

kriswest commented Jul 21, 2022

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

kriswest commented Jul 21, 2022

mistryvinay commented Jul 22, 2022

milindchidrawar commented Aug 2, 2022

mistryvinay left a comment

Choose a reason for hiding this comment

kriswest left a 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

kriswest commented Nov 3, 2022

mistryvinay left a comment

Choose a reason for hiding this comment

pierreneu commented Jan 5, 2023

kriswest commented Feb 2, 2023

linux-foundation-easycla bot commented Jun 8, 2022 •

edited

Loading

netlify bot commented Jun 8, 2022 •

edited

Loading