Technical Deep Dive. IBM Watson Content Hub UI & APIs

Transcription

1 Technical Deep Dive IBM Watson Content Hub UI & APIs

2 WCH Terms

3 A glimpse at the UI... Search Content Types Image Profiles Content Items Taxonomies Assets 4

4 Important terms to know Content Model Content Types defines structure and form for an content item Image Profiles define renditions for images Taxonomies associating used defined categories with content Taxonomy == Category 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 5

5 Authoring UI

6 Image Profiles Metadata Renditions Can be linked to image elements in content types Renditions are created on-the-fly during content item creation 7

7 Taxonomies Taxonomy == Category Categories There is a category content element Can be scoped in content type Used in search for better filtering Sample use cases: Navigation, Article hierarchy Metadata 8

8 Content Types Content structure Based on content elements Template for content items Validation properties Flat structure Content Elements Predefined set of elements Each element can be modified in the settings tab inside the content structure Metadata 9

9 Assets - Upload Upload status For bulk uploads Single asset Shows Metadata Add own tags Watson Tags (Cognitive) Based on the uploaded asset type different capabilites are enabled For Text, PDF: Concepts, Entities & Keywords For JPEG, PNG: Concepts, Faces 10

10 Assets Detail View 11

11 Content Items Metadata Image Upload new image or use the asset picker Image Renditions Based on Image Profile Resizie & Crop Renditions in the UI on the fly 12

12 Search 13

13 Roles & Lifecycle

14 User Roles Administrator Has full privileges towards content. Can add remove new users and make changes to the general settings of WCH. Manager Has full privileges towards content. Can add new taxonomies, image profiles and content types. Editor Can only create new content items and upload assets. 15 Viewer Only read access to content and assets

15 Content Items Lifecycle Current authoring lifecycle Assets are always in the state Ready Ready Subject to change Draft Create Draft Ready Create Draft Retire d Retire 16

16 Access WCH content

17 IBM Watson Content Hub Overview Authoring Content authors use the Authoring System to manage content Authoring UI (Content and Files/Assets) UI for managing content, files and (eventually) pages and sites. Secured with IBMid. Delivery The Delivery System delivers all content & assets to end users File Access Service Serves binary assets images, videos, PDFs, HTML, JS, CSS via Akamai cache Authoring search index Fast, flexible access to lists of content Publishing Content Access Service Serves JSON representation of content items Content repository A globally distributed, multi-active content repository Production search index Fast, flexible access to lists of content & files IBM API Gateway Provides a common platform for securely accessing IBM APIs Akamai CDN Caches the authoring UI for rapid global delivery IBM API Gateway Provides a common platform for securely accessing IBM APIs Akamai CDN Caches published content and assets for end-user delivery digitalexperience.ibm.com (TBC) my.digitalexperience.ibm.com (TBC) 2016 IBM

18 Ways to access REST API Retrieve content through a rich set of publicly documented API calls Command Line Interface Work 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 19

19 Public Rest API s Go to IBM API Explorer* & search for Watson Content Hub 20 *

20 Nov & Dec - Authorization needed for Authoring API - Authorization Header Authorization: Basic username:pwd <host> is the domain of content hub <tenantid> is the unique identifier for a tenant Reminder: username:pwd are Base64 encoded Response contains two cookies: x-ibm-dx-tenant-id x-ibm-dx-user-auth 21

21 Nov & Dec - Authorization only needed for Authoring API - 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 Cookies only needed in authenticated scenarios On delivery the only API to query for multiple elements 22

22 Nov & Dec - Authorization only needed for Authoring API - Resource <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 Use resource to fetch assets 23

23 Retrieving Content Best practise The authoring API provides many convienient endpoints to query for content. E.g. for content or assets search 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 content get single asset resources 24

24 Command Line Interface /Coming/December (Github) $ wchtools help Usage: wchtools <command> [options] Commands: delete [options] init [options] list [options] publish [options] pull [options] push [options] the specified artifact Init the settings to access IBM WCH List changed local/remote artifacts Create a new publishing job Pull modified authoring artefacts from IBM WCH Push modified authoring artefacts to IBM WCH 25

25 Search & Filter Asset Picker 26 Integration into web applications Easy See WCH Sample Pages.

26 Watson Content Hub Get started on the IBM Marketplace Asset publishing: Released today 27

27 Sven Sterbling Join the conversation Blog, YouTube, Twitter and Facebook

28 Further material

29 Further Information about WCH IBM Marketplace: Developer Center: WCH Sample Page 30

30 Further Information about WCH Stephen Mello Blog: Bernd Ritz Blog: 31

31 Content Items Lifecycle Example V1 Draft Ready Create Draft Ready Create Draft Retire d Retire 32

32 Content Items Lifecycle Example Draft Ready Create Draft V1 Ready Create Draft Retire d Retire 33

33 Content Items Lifecycle Example V2 Draft Ready Create Draft V1 Ready Create Draft Retire d Retire 34

34 Content Items Lifecycle Example Draft Ready Create Draft V2 Ready Create Draft Retire d Retire 35

35 Content Items Lifecycle Example Draft Ready Create Draft Ready V2 Create Draft Retire d Retire 36