Technical Deep DiveIBM Watson Content Hub UI & APIs

WCH Terms

IBM Digital Experience

4

A glimpse at the UI...

Search

Content Items

Assets

Content Types

Image Profiles

Taxonomies

IBM Digital Experience

Content Types –defines structure and form for an content item

5

Important terms to know

Taxonomy == Category

Image Profiles –define renditions for images

Taxonomies –associating used defined categories with content

Content Items –Instance of a content item based on a content type

Assets –such as Images, PDFs, Textfiles

Search –Integrating content & assets into the search infrastructure

Content Model

Content

Authoring UI

IBM Digital Experience

7

Image Profiles

Metadata

Renditions▪ Can be linked to image elements in content

types▪ Renditions are created on-the-fly during

content item creation

IBM Digital Experience

8

Taxonomies

MetadataCategories▪ There is a category content element▪ Can be scoped in content type▪ Used in search for better filtering▪ Sample use cases: Navigation, Article

hierarchy

Taxonomy == Category

IBM Digital Experience

Metadata

9

Content Types

Content Elements▪ Predefined set of

elements▪ Each element can

be modified in the settings tab inside the content structure

Content structure▪ Based on content elements▪ Template for content items▪ Validation properties▪ Flat structure

IBM Digital Experience

10

Assets - Upload

Upload status▪ For bulk uploads

Watson Tags (Cognitive)▪ Based on the uploaded asset type different

capabilites are enabled▪ For Text, PDF: Concepts, Entities & Keywords▪ For JPEG, PNG: Concepts, Faces

Single asset▪ Shows Metadata▪ Add own tags

IBM Digital Experience

11

Assets – Detail View

IBM Digital Experience

12

Content Items

Image Renditions▪ Based on Image Profile▪ Resizie & Crop Renditions in the UI on the fly

Image▪ Upload new image or use the asset picker

Metadata

IBM Digital Experience

13

Search

Roles & Lifecycle

IBM Digital Experience

15

User Roles

Editor –Can only create new content items and upload assets.

Manager –Has full privileges towards content. Can add new taxonomies, image profiles and content types.

Administrator –Has full privileges towards content. Can add remove new users and make changes to the general settings of WCH.

Viewer –Only read access to content and assets ☺

IBM Digital Experience

Content Items Lifecycle

16

Draft Ready

Retire

Deleted

Ready

RetireCreate Draft

Delete

DeleteCreate Draft

Delete

▪ Current authoring lifecycle

▪ Assets are always in the state

‘Ready‘

▪ Subject to change

Access WCH content

IBM Digital Experience

Delivery

The Delivery System delivers all content & assets to end users

Authoring

Content authors use the Authoring System to manage content

IBM Watson Content Hub Overview

© 2016 IBM

Publishing

digitalexperience.ibm.com (TBC) my.digitalexperience.ibm.com (TBC)

Authoring UI (Content and Files/Assets)UI for managing content, files and (eventually) pages and sites. Secured with IBMid.

Authoring search indexFast, flexible access to lists of content

Content repositoryA globally distributed, multi-active content repository

IBM API GatewayProvides a common platform for securely accessing IBM APIs

Akamai CDNCaches the authoring UI for rapid global delivery

File Access ServiceServes ‘binary’ assets – images, videos, PDFs,

HTML, JS, CSS – via Akamai cache

Content Access ServiceServes JSON representation of content items

Production search indexFast, flexible access to lists of content & files

IBM API GatewayProvides a common platform for securely accessing IBM APIs

Akamai CDNCaches published content and assets for end-user delivery

IBM Digital Experience

Ways to access

19

Command Line InterfaceWork with your content and assets on your local machine and sync your changes back to WCH

Asset Picker Integrate the asset picker into your application and consume all WCH assets in a easy fashion

REST APIRetrieve content through a rich set of publicly documented API calls

IBM Digital Experience

20

Public Rest API‘sGo to IBM API Explorer* & search for Watson Content Hub

* https://developer.ibm.com/api/

IBM Digital Experience

API - Authorization

▪ Reminder: username:pwd are Base64 encoded

▪ Response contains two cookies:

• x-ibm-dx-tenant-id

• x-ibm-dx-user-auth

21

https://<host>/api/<tenantId>/login/v1/basicauth

Header

Authorization: Basic username:pwd

<host> is the domain of content hub

<tenantId> is the unique identifier for a tenant

Nov & Dec - Authorization needed for Authoring

IBM Digital Experience

API - Search

22

https://<host>/api/<tenantId>/authoring/v1/search

Params:

See Apache Solr for all available search params

Cookies:

x-ibm-dx-tenant-id; x-ibm-dx-user-auth

<host> is the domain of content hub

<tenantId> is the unique identifier for a tenant

Nov & Dec - Authorization only needed for Authoring

▪ Cookies only needed in authenticated scenarios

▪ On delivery the only API to query for multiple elements

IBM Digital Experience

API - Resource

23

https://<host>/api/<tenantId>/authoring/v1/resources/

<resId>

Cookies:

x-ibm-dx-tenant-id; x-ibm-dx-user-auth

<host> is the domain of content hub

<tenantId> is the unique identifier for a tenant

<resId> unique identifier for a resource

Nov & Dec - Authorization only needed for Authoring

▪ Use resource to fetch assets

IBM Digital Experience

Retrieving Content – Best practise

24

search

resourcescontent

get single asset

▪ The authoring API provides

many convienient endpoints

to query for content. E.g. for

content or assets

▪ Those APIs will not be

available with the delivery

APIs

▪ The recommended approach

is to use the search API for

those use cases

get single content item

IBM Digital Experience

Command Line Interface /Coming/December (Github)

$ wchtools ––help

Usage: wchtools <command> [options]

Commands:

delete [options] Delete the specified artifact

init [options] Init the settings to access IBM WCH

list [options] List changed local/remote artifacts

publish [options] Create a new publishing job

pull [options] Pull modified authoring artefacts from IBM WCH

push [options] Push modified authoring artefacts to IBM WCH

25

IBM Digital Experience

26

Asset PickerIntegration into web applicationsEasy ☺ See WCH Sample Pages.

Search & Filter

Watson Content Hub

27

Get started on the IBM MarketplaceAsset publishing: Released today ☺

Join the conversationBlog, YouTube, Twitter and Facebook

Sven Sterblingsterbling@de.ibm.com

Further material

IBM Digital Experience

Further Information about WCH

IBM Marketplace: https://www.ibm.com/marketplace/cloud/cloud-cms-solution/us/en-us

Developer Center:https://developer.ibm.com/wch/

WCH Sample Pagehttp://samples.watsoncontenthub.io/sample-pages/index.html

30

IBM Digital Experience

Further Information about WCH

Stephen Mello Blog:https://www.ibm.com/blogs/commerce/2016/09/theres-better-way-manage-content/

Bernd Ritz Blog:https://www.ibm.com/blogs/websphere-commerce/die-bedeutung-von-cognitive-content/

31

IBM Digital Experience

Content Items Lifecycle – Example

32

Draft Ready

Retire

Deleted

Ready

RetireCreate Draft

Delete

DeleteCreate Draft

Delete

V1

IBM Digital Experience

Content Items Lifecycle – Example

33

Draft Ready

Retire

Deleted

Ready

RetireCreate Draft

Delete

DeleteCreate Draft

Delete

V1

IBM Digital Experience

Content Items Lifecycle – Example

34

Draft Ready

Retire

Deleted

Ready

RetireCreate Draft

Delete

DeleteCreate Draft

Delete

V1V2

IBM Digital Experience

Content Items Lifecycle – Example

35

Draft Ready

Retire

Deleted

Ready

RetireCreate Draft

Delete

DeleteCreate Draft

Delete

V2

IBM Digital Experience

Content Items Lifecycle – Example

36

Draft Ready

Retire

Deleted

Ready

RetireCreate Draft

Delete

DeleteCreate Draft

Delete

V2