IBM Connections Extensions to the Data Model
Added by IBM contributorIBM | Edited by Claudia R Elbourn on June 11, 2015
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

The IBM Connections data model uses existing Activity Stream data model elements wherever possible. However in some cases there is no equivalent and IBM Connections needs to introduce a new property.

This are generally all contained in the entry.connections property.

  • actionable = true/false - this specifies if the entry in question corresponds to a pending user action (i.e. would be present if the action required view was chosen)
  • saved = true/false - this specifies if the entry in question has been saved (i.e. would be present if the saved view was chosen)
  • broadcast = true/false - this indicates if the entry is a status_update
  • rollupid = {id} - if supplied, IBM Connections uses this to 'group' events that are deemed to be on the same object. If not present, IBM Connections uses the object id provided
  • rollupUrl = {url} - a URL that will return all events associated with this rollup id
  • canUnfollow = true/false - this variable signifies to the consumer whether it is possible to unfollow the actor/ community/ application ... that caused this event to show in the stream
  • shortTitle = {string} - a string that represents a shorter version of the title that doesn't mention the Object (suitable for displaying in Object history)
  • plainTitle = {string} - a non-HTML (plain text) version of the title
  • isPublic = true/false - a boolean string that indicates whether this event is public or private

Other IBM Connections extensions are embedded in the properties to which they apply, through the use of a new property titled "connections". For example, for users recognised by IBM Connections, their status/ state is provided in a state property. Possible values for the state variable include ("active" or "inactive"). For example:

 "author": { 

"connections": { 

"state": "active"

},

"objectType": "person",

"id": "urn:lsid:lconn.ibm.com:profiles.person:xyz",

"displayName": "John Doe"

},

"id": "urn:lsid:lconn.ibm.com:wikis.article:xyz",

"displayName": "a child page of a wiki",

"published": "2012-08-20T14:40:13.420Z",

"url": "https://<servername>/wikis/home/wiki/a%20new%20wiki/page/a%20child%20page%20of%20the%20wiki"

}, 

IBM Extensions to the Base Schema of activity streams


In this section we present extensions to the Verb and Object Types in the base schema of Activity Streams. 

Verbs

  • unknown -- An IBM Connections default for unknown events from an IBM Connections Application
  • request-join -- A request by the object of type person to join the target of type community (defined below)

Object Types

  • task-list -- Represents a list of tasks (defined below) that can be used to accomplish a goal.
  • task -- Represents a document / text that elucidates a process to accomplish a goal. 
  • todo -- Represents a note/ text for future consumption. 
  • blog -- Represents a collection of articles that relate more specifically to questions/ discussions and or opinions. In the context of IBM Connections this represents an IBM Connections Blog.  
  • trackback -- ??
  • community -- Represents a collection of people that have a shared interest and place to collaborate on that shared interest. In the context of IBM Connections this represents an IBM Connections Community. 
  • forum -- Represents a container for multiple topics of discussion. In the context of IBM Connections this represents an IBM Connections Forum. 
  • wiki --- Represents a collection of articles that relate to a knowledge domain. In the context of IBM Connections this represents an IBM Connections Wiki.