Standard services
The following table introduces the standard services of Unica Content Integration. Hence, none of the service names listed herein should be used for any custom service implementation. Content Integration SDK provides standard interfaces and types to implement these standard services. These interfaces and types are discussed in more detail in subsequent sections.
Standard service name | Description |
---|---|
|
Simple search service responds to the content search requests received by Content Integration Framework. This service accepts the search query string along with required result pagination details. Based on the success of search operation, it returns the search result for given search query and according to the required pagination. This is a mandatory service for the plugin. |
list-folders |
This is an optional service. Folder is a general term used to
represent a container object used in target system to hierarchically
organize the contents. This service is invoked to render the list of
folders & sub-folders to facilitate navigation through such
hierarchically organized
contents. Note: list-folders and
list-contents are correlated services.
Implementation for both services must exist for content
navigation to function properly. |
list-contents |
This is an optional service. This service is invoked for listing
the contents belonging to a particular
folder. Note: list-folders and
list-contents are correlated services.
Implementation for both services must exist for content
navigation to function properly. |
get-content-details |
Implementation of this service is useful for retrieving the
details of an individual content. Contents obtained using
simple-search & list-contents
services are referenced further in other Unica
products. Users might want to see the details of already referenced
content at later point of time. Therefore, we encourage to implement
this service to facilitate users to see the content details on
demand. |
get-object-schema |
This is an optional service. Implementation of this service is useful for allowing Centralized Offer Management users to map content attributes with offer attributes. And subsequently derive the values for mapped offer attributes from corresponding content attributes by selecting the desired content from Content Picker. Thus, if implemented, this service facilitates usage of other content attributes in addition to the content URL for offer creation. |
resource-loader |
This service is useful when direct download of the content from
target system is not feasible. This service is not mandatory and
should be implemented only when following challenges are
encountered:
|
list-content-categories |
Content can be logically categorized by its natural
classification. For example, Digital content can be categorized into
Images, Documents, Multimedia (audios and videos), Archives etc.
Similarly, E-commerce products can be categorized into several broad
categories, such as Electronics, Healthcare, Books, Furniture etc.
Content Integration Framework allows following ways of conveying
such content categorization to facilitate searching contents within
specific category.
|
get-cognitive-analysis |
This is an optional service. If implemented, it is used to fetch cognitive details associated with the given image, subject to the "Preferred cognitive service provider" configuration in Unica Platform. |