The Content Model

Former Member — Wed, 05 Aug 2020 14:58:45 GMT

Current Revision posted to Developer Training by Former Member on 08/05/2020 14:58:45

Most information within Verint Community and interactions with Verint Community conform to the platform's content model, an abstract, global organization of all content and its associated containing structures to enable platform-level global functionality.

[toc]

What is the Content Model?

The content model is an abstract representation of general content and its containing structures. This generic model is used to provide global services from the platform to enable consistent interactions and simplified extensibility and integration. The content model consists of three types of entities: Containers, Applications, and Content.

Containers

Containers are the top-level organization structure for content. On their own, containers offer little functionality aside from organizing applications, which contain content. Containers can be nested within themselves to provide deep navigational structures.

Within Verint Community, the most prominent example of a container is a group.

Applications

Applications exist within a single container and are the direct owner of content. That is, all content exists within a single application which exists within a single container. Within Verint Community, applications are are used as the basis for URL routes and permissions/security.

An example of an application in Verint Community is a blog.

Content

Content exists within a single application and represents authored, not structural, information. Most interactions within Verint Community are on content. Likes, bookmarks, comments, activity streams, notifications, search, etc occurs on content.

An example of content in Verint Community would be a post within a blog.

An Internal Example: Forums

The forums functionality in Verint Community consists of the "Forums" application which references the "Groups" container (that is, a forum exists within a group). The forums functionality defines two types of content: "Forum Threads" and "Forum Replies" both of which are defined to exist within the "Forums" application. The forums application types, forum threads content type, and forum replies content type are registered with the Verint Community platform via [[Plugins|plugins]], specifically as an [[api-documentation:IApplicationType Plugin Type|IApplicationType]] (for the forum application type) and [[api-documentation:IContentType Plugin Type|IContentType]] (for the forum thread and forum reply content types).

By integrating directly using server-installed code, the forums functionality connects its data store of forum data to the platform, extending the platform's "Group" container type and using other plugin types to define URLs/routes to access forum data through the Verint Community web UI, permissions to secure forum data, as well as integrating with search, likes, bookmarks, and other platform-defined services.

An External Example: URLs

External integrations can also make use of the content model and associated platform services via an [[Authentication|OAuth client]] and the [[REST API]]. An OAuth client is an external integration that uses the REST API to interact with the Verint Community platform. OAuth clients can use Verint Community services on external URLs.

In this situation, the OAuth client represents an application in the content model, extending the top-level group (container) of the Verint Community site. URLs referenced using the OAuth client when interacting with the REST API are interpreted as content associated to the OAuth client within Verint Community. This enables the OAuth client (external integration) to use platform-defined services such as bookmarking, liking, commenting, rating on data not stored within Verint Community but able to be referenced by a unique URL.

Content and Core Services

As mentioned earlier, Verint Community provides global services to interact with data socially. These "core services" act on the content model. Some examples of core services provided by the Verint Community platform and how they interact with the content model is below:

How do I interact with the Content Model?

How you use the content model depends largely on whether you're implementing an external integration, integrating using plugins installed within Verint Community, or using content while customizing the Verint Community user interface:

Within an External Integration

With an [[External Integration|external integration]], you're primarily interacting with Verint Community using [[REST API|the REST API]]. You can use the installed content model implementations (groups, blogs, forums, etc) regardless of how you [[Authentication|authenticate your REST requests]].

If you want to use Verint Community services on external content, you can [[Authentication|authenticate your REST requests using OAuth]]. By using an OAuth client, you can reference URLs within the context of your OAuth client and use Verint Community's content services by providing a ContentUrl to supporting services via their REST APIs.

Using Plugins Installed within Verint Community

[[Plugins]] can interact with content generically or specifically using the [[In-Process API|in-process API]] to automate existing behavior or to expose functionality on existing content in a new way.

The Verint Community platform also enables the implementation of new content model entities and types via content-related plugins: [[api-documentation:IContainerType Plugin Type|IContainerType]], [[api-documentation:IApplicationType Plugin Type|IApplicationType]], and [[api-documentation:IContentType Plugin Type|IContentType]]. These base plugin types can be extended to add support for Verint Community services via extensions to these base plugin types. For an example of implementing a custom application, see [[Creating Custom Applications and Content]] and [[Adding Core Service Support to Content]].

When Customizing the User Interface

[[Widgets]] can interact with content generically or specifically using the widget API to expose existing data in a new way.

Tags: Applications, Containers, Content

The Content Model

Ben Tiedt — Thu, 13 Jun 2019 19:39:42 GMT

Revision 2 posted to Developer Training by Ben Tiedt on 06/13/2019 19:39:42

Most information within Telligent Community and interactions with Telligent Community conform to the platform's content model, an abstract, global organization of all content and its associated containing structures to enable platform-level global functionality.

[toc]

What is the Content Model?

Containers

Within Telligent Community, the most prominent example of a container is a group.

Applications

Applications exist within a single container and are the direct owner of content. That is, all content exists within a single application which exists within a single container. Within Telligent Community, applications are are used as the basis for URL routes and permissions/security.

An example of an application in Telligent Community is a blog.

Content

Content exists within a single application and represents authored, not structural, information. Most interactions within Telligent Community are on content. Likes, bookmarks, comments, activity streams, notifications, search, etc occurs on content.

An example of content in Telligent Community would be a post within a blog.

An Internal Example: Forums

The forums functionality in Telligent Community consists of the "Forums" application which references the "Groups" container (that is, a forum exists within a group). The forums functionality defines two types of content: "Forum Threads" and "Forum Replies" both of which are defined to exist within the "Forums" application. The forums application types, forum threads content type, and forum replies content type are registered with the Telligent Community platform via [[Plugins|plugins]], specifically as an [[api-documentation:IApplicationType Plugin Type|IApplicationType]] (for the forum application type) and [[api-documentation:IContentType Plugin Type|IContentType]] (for the forum thread and forum reply content types).

By integrating directly using server-installed code, the forums functionality connects its data store of forum data to the platform, extending the platform's "Group" container type and using other plugin types to define URLs/routes to access forum data through the Telligent Community web UI, permissions to secure forum data, as well as integrating with search, likes, bookmarks, and other platform-defined services.

An External Example: URLs

External integrations can also make use of the content model and associated platform services via an [[Authentication|OAuth client]] and the [[REST API]]. An OAuth client is an external integration that uses the REST API to interact with the Telligent Community platform. OAuth clients can use Telligent Community services on external URLs.

In this situation, the OAuth client represents an application in the content model, extending the top-level group (container) of the Telligent Community site. URLs referenced using the OAuth client when interacting with the REST API are interpreted as content associated to the OAuth client within Telligent Community. This enables the OAuth client (external integration) to use platform-defined services such as bookmarking, liking, commenting, rating on data not stored within Telligent Community but able to be referenced by a unique URL.

Content and Core Services

As mentioned earlier, Telligent Community provides global services to interact with data socially. These "core services" act on the content model. Some examples of core services provided by the Telligent Community platform and how they interact with the content model is below:

How do I interact with the Content Model?

How you use the content model depends largely on whether you're implementing an external integration, integrating using plugins installed within Telligent Community, or using content while customizing the Telligent Community user interface:

Within an External Integration

With an [[External Integration|external integration]], you're primarily interacting with Telligent Community using [[REST API|the REST API]]. You can use the installed content model implementations (groups, blogs, forums, etc) regardless of how you [[Authentication|authenticate your REST requests]].

If you want to use Telligent Community services on external content, you can [[Authentication|authenticate your REST requests using OAuth]]. By using an OAuth client, you can reference URLs within the context of your OAuth client and use Telligent Community's content services by providing a ContentUrl to supporting services via their REST APIs.

Using Plugins Installed within Telligent Community

The Telligent Community platform also enables the implementation of new content model entities and types via content-related plugins: [[api-documentation:IContainerType Plugin Type|IContainerType]], [[api-documentation:IApplicationType Plugin Type|IApplicationType]], and [[api-documentation:IContentType Plugin Type|IContentType]]. These base plugin types can be extended to add support for Telligent Community services via extensions to these base plugin types. For an example of implementing a custom application, see [[Creating Custom Applications and Content]] and [[Adding Core Service Support to Content]].

When Customizing the User Interface

[[Widgets]] can interact with content generically or specifically using the widget API to expose existing data in a new way.

The Content Model

Ben Tiedt — Tue, 04 Jun 2019 20:31:06 GMT

Revision 1 posted to Developer Training by Ben Tiedt on 06/04/2019 20:31:06

[toc]

What is the Content Model?

Containers

Within Telligent Community, the most prominent example of a container is a group.

Applications

Applications exist within a single container and are the direct owner of content. That is, all content exists within a single application which exists within a single container. Within Telligent Community, applications are are used as the basis for URL routes and permissions/security.

An example of an application in Telligent Community is a blog.

Content

An example of content in Telligent Community would be a post within a blog.

An Internal Example: Forums

By integrating directly using server-installed code, the forums functionality connects its data store of forum data to the platform, extending the platform's "Group" container type and using other plugin types to define URLs/routes to access forum data through the Telligent Community web UI, permissions to secure forum data, as well as integrating with search, likes, bookmarks, and other platform-defined services.

An External Example: URLs

External integrations can also make use of the content model and associated platform services via an [[Authentication|OAuth client]] and the [[REST API]]. An OAuth client is an external integration that uses the REST API to interact with the Telligent Community platform. OAuth clients can use Telligent Community services on external URLs.

Content and Core Services

How do I interact with the Content Model?

Within an External Integration

Using Plugins Installed within Telligent Community

When Customizing the User Interface

[[Widgets]] can interact with content generically or specifically using the widget API to expose existing data in a new way.