Automated Actions Parameters

srenault-meeds commented 7 months ago

Rationale

We have built-in connectors and we aim to provide more and more connectors to our users.

Yet, now that we are about to finish the Twitter connector implementation, it is time to take a step back.

Indeed, a review of the action creation drawer is needed so our Program Owners can create the automatic flow they need. That means, that depending on the event, they will be able to clearly identify which action will be gamified.

1. Functional Requirements

Top User Stories

Creation / update of a manual action

No change for this case.

Creation / update of an automatic action

Given the program owner chooses to add an automatic action, then a second step is added called "Create the automatic flow" so he can detail the use case as he wants:

The application needs to be chosen. In case, no connector is configured but the Meeds one, then events selection is proposed directly
Once the application is chosen, the program owner will have to precise the event. Depending on the case, additional options can be requested. Here are examples:

Send a kudos (meeds) / Set your profile avatar (meeds) > No additional detail requested
Create a task (meeds) > Ability to add the link of the project OR to choose any project (if rewarding admin)
Like an activity (meeds) -> Need to choose the space > then add the link of the activity or any activity of that space -> Can choose any space (if reward admin) > then any like to any activity will be considered
Mention an account (X) > Remind the account enabled to be watched and if more than one, then list choices so the user can identify it
Like a tweet (X) OR Repost a tweet (X) > Tweet link (no ability to check "Any" as it requests to have a bigger plan so in order to avoid losing request credits, we limit the search to one tweet AND no use case interesting to gamify any like to any tweet) -> A check is done if this tweet is related to a configured account to be watched
Create a Pull Request (GitHub) > Organization to select (if more than one set) > Repository selection upon permissions set from admin (or any if reward admin)
Create an issue (GitHub) > Organization to select (if more than one set) > Repository selection upon permissions set from admin (or any if reward admin) > Project to select

Once the second step of the creation of an automatic action is completed, the program owner can decide in the third step:
- if the action should be announced in the audience
- how achievement can be announced (by default, it is disabled) for an additional check when needed
- conditions to achieve (duration, recurrence, action)

Impacts

Gamification

Update of action creation / update drawer

Notifications

NA

Analytics

NA

Unified Search

NA

2. Technical Requirements

Expected Volume & Performance

Security

NA

Extensibility

A program owner has to be provided to manage creation and update automatic action and its details (application, space, entityId ...).
Each connector has to be able to add specific settings for events inside the action drawer UI.
Each trigger has to be able to add specific settings inside the action drawer UI.

Configurability

NA

Upgradability

An upgrade has to be made for rules to use eventId instead of the event title.

Existing Features

NA

Feature Flags

No feature flag is needed.

4. Software Architecture

Security

NA

REST endpoints

REST endpoint has to be added to serve new assets:

/gamification/triggers: this will allow to retrieve configured triggers switch installed addons. (Readonly listing)

Access UI

Action drawer UIs have to be extensible (injected using extensionRegistry) so that it prepares integration with each connector.

Data and persistence

There is no need to add a new table or column, all event specifications will be stored in the already existing table GAMIFICATION_EVENT_SETTINGS

srenault-meeds commented 7 months ago

@margondicco Please can you review it? Thanks Additional explaination available here: https://builders.meeds.io/portal/meeds/activity?id=7163

margondicco commented 7 months ago

Hello Go Fonc

srenault-meeds commented 7 months ago

Thanks. Ready for tech spec @AzmiTouil cc @boubaker

boubaker commented 7 months ago

Thanks @AzmiTouil.

Ready for tech review by DAO members (eXo : @rdenarie )

rdenarie commented 7 months ago

go tech

plamarque commented 5 months ago

Renamed MIP to be more descriptive. This filter is about enabling automated actions to have extra params in order to capture more granular events.

AzmiTouil commented 4 months ago

ACC and PRs ready for review by the DAO members (cc @rdenarie ) (Connector documentation) NB: the exoplatform connector must have an extension as a default connector to be displayed in the administration interfaces and list its events.

rdenarie commented 4 months ago

Hello @AzmiTouil Can you add more detail and example (the meeds example) about what I need to do for the 'exoplatform' connector ?

In addition, as I can see, modifications are not present in https://exo-mips-ft.meeds.io/

AzmiTouil commented 4 months ago

Hello @rdenarie yes, an extension for the exoplatform connector to define the image/icon, description, and if it's a default connector. meeds extension :

extensionRegistry.registerExtension('engagementCenterConnectors', 'connector-extensions', {
  id: 'meeds',
  name: 'meeds',
  image: '/gamification-portlets/images/connector/meeds.svg',
  title: 'Meeds',
  description: 'gamification.admin.meeds.label.description',
  defaultConnector: true,
  rank: 10
});

Acceptance up to date!

rdenarie commented 4 months ago

thanks for the example, have you a url of this code in meeds module ? thanks

srenault-meeds commented 4 months ago

@rdenarie I think that you can check this documentation https://builders.meeds.io/portal/g/:spaces:developers/developers/notes/394

In the meantime, I have found that you have some css overlap to check in the eXo-mips. Indeed, something is not ok in the action drawer. See below:

AzmiTouil commented 4 months ago

https://github.com/Meeds-io/gamification/blob/develop/portlets/src/main/webapp/vue-app/connectors-extensions/extensions.js#L19. For more detail about connector (Connector documentation) Thanks.

rdenarie commented 3 months ago

Hello On connecteurs page in administration there is a js error : It is present on both acc.

I'm not sure it is related to this development.

Can you check on your side ? If it is related, it should be fixed I think If it is not related, you can proceed to merge

Thanks

AzmiTouil commented 3 months ago

Hello On connecteurs page in administration there is a js error : It is present on both acc.

I'm not sure it is related to this development.

Can you check on your side ? If it is related, it should be fixed I think If it is not related, you can proceed to merge

Thanks

Hello @rdenarie Yes, it's related to this MIP. Fix added to gamification PR!

Thanks

rdenarie commented 3 months ago

ok, then you can proceed to merge.

Meeds-io / MIPs