Difference between revisions of "Activities"

Revision as of 12:08, 11 October 2016

Activity

There are 2 types of activities:

1. Activities for real time intelligence needs : activities with Reasoners
2. Activities for bridge execution on the edge : activities without Reasoners, but including Actors, with the goal of defining services for the edge, that will include access to thing and observation types required by the edge intelligence running on a bridge

Activity is a resource that links resource types Actor, Observer, Reasoner, Actions, Topics, Things, Observations and Observation Production Configuration with the objectives of:

• Deploy and publish Reasoners to be executed in the cloud
• Publish Observation production configuration to be executed at M2MBridge
• Deploy Edge Reasoners to be executed in the M2MBridge
• SaaS unit of deployment
  • Allow followers to subscribe to activities

Observers

The activities have three collections of observers

• Observers
• Observers for API
• Observers for Follower

The first collection contains the activity observers while the other two are links to query observers that will be shared with those subscribed to the service associated to the current activity. For details on defining or executing observers, please see Observers.

Actors

• Actors are resources that define access control policies to thing and notification types
• Actors are defined for a tenant and they are not shared with other tenants (although their names must be unique accross tenants)
• Actors are associated to activities, meaning that the follower admin that subscribes to the service will acquire all those access control policies. The follower admin can then selectively give actors to the other followers he invites.

Thing types

• Things types are used in observers and reasoners
• Access to thing types is defined in the actors that are associated to the activity
• Thing types have a configuration for the production of observations that is used in the activity. Each thing type has the set of observations it may produce. This will be the observations available for selection when configuring the observation production of that thing type inside the activity observation production configuration

Notification types

See Notifications

• Notifications are defined as types in the same way that things and observations are.
• A notification type contains well-known supported properties, such as subject and body.
• Notifications types can be used in actor's policies to define access to the instances of the notifications types
• Instances of a notification type can be generated using an action notify in a reasoner

Reasoners

See Reasoners

Actions

See Actions

CRUD operations

• When a CRUD (Create/Update/Delete) operation is executed over a thing instance an observation type observationresourcecrud is sent to the topic /crud/<thingType> example "topic": "/crud/endCustomer"
• This option is configured at Activity by adding the thing type to the Crud observations producers list

API's observers

• List of observers published with the activity for integration, it can be requested by followers with access policies to the resources used in the configuration of the observer.

Validation for publication

In order to be published, an activity must be a valid json resource according to its metadata. All resources contained in the activity must also be valid for their metadata. The follower specific validations are also performed on the activity (some generate warning, others generate errors that will not allow publication)

• Types involved in reasoners, observers and actors must be published
  • If there is an unpublished type that is used, and it is owned by the activity owner, a warning is generated
  • If the unpublished type is owned by another user, an error is generated
• Types used in actors are involved in reasoners or observers (if not, a warning is generated)
• Actors must not contain policies for notifications of a different activity
• Reasoners must have topic, actions, and must have been run at least one in the debugger

Publishing

Actions taken upon activity publication:

• The service for the activity is generated/updated
• The observation production configuration, API Observers and Follower Observers are shared with service subscribers
• A test user with the role follower is created.

Unpublishing

The topology of an activity can be undeployed by selecting the activity, and going to the Execution Status menu, where actions can be taken on the topology, such as watching the logs, and undeploying the topology. Note that the unpublish process has no effect on the publication of the activity, so all the resources shared, and the actors given to users subscribed to the activity remain unchanged. The undeploy process has effect only on the topology.

Test User with role Follower

• The test follower is automatically created when the creator publishes an activity
• It is automatically subscribed to the service
• Its credentials are sent by email to the creator.
• It is generated with an ID in the form of follower_<creatorId>@@<creatorEmailDomain>.
• This test follower allows the creator to test the follower experience, without having to create a new user and subscribe it to the services.

When to deploy and publish

• A new reasoner has been created
• An existing reasoner has been modified or deleted
• A new action has been created
• An existent action have been modified or deleted
• Observation production configuration has changed
• Actors has been modified

Deployed activities are stooped for a short period of time an restarted

When to publish only

Publishing an activity is needed when:

• A new configuration of observation production is added
• A new observer is added to the list of Follower Observers or API Observers

How it works