Working with Lotus Web Content Management Web Content Integrator and Problem Determination

Size: px

Start display at page:

Download "Working with Lotus Web Content Management Web Content Integrator and Problem Determination"

Meagan Riley
5 years ago
Views:

Dinesh Ramakrishnan Lotus Web Content Management

1 Working with Lotus Web Content Management Web Content Integrator and Problem Determination Dinesh Ramakrishnan Lotus Web Content Management Level 2 Support dineshb@us.ibm.com 2010 IBM Corporation

2 Agenda Overview What is Web Content Integrator Working with Web Content Integrator WCI Feeds Configuring WebSphere Portal to consume the feed Applying debug, test fixes and fixes for WCI Known Issues 2

3 Overview The main goal of this presentation is to give an introduction to W eb Content Integrator (W CI). How to troubleshoot problems reported, debug and resolve the problems 3

4 What is Web Content Integrator The Web Content Integrator is a solution for integrating externally managed Web content with WebSphere Portal. Through the use of standard content syndication feed technologies based on RSS 2.0, the Web Content Integrator provides a loosely-coupled mechanism for transferring published content and meta data to the portal after they have been approved in the source system. Once the IBM content Software and meta Group data have Lotus been transferred softwareto the portal, it is possible to leverage the built-in content management features of WebSphere Portal to secure, personalize, and display the content to end users. 4

5 Working with Web Content Integrator Information on working with IBM Web Content Integrator is documented in Info center in below URL. topic=/com.ibm.wp.ent.doc_v615/wci/wci_intro.html To use the Web Content Integrator you have to : Create a feed on your source system using the Web Content Integrator feed format specification. Configure WebSphere Portal to consume the feed 5

6 WCI Feeds The input to the Web Content Integrator is a content feed which complies with the RSS 2.0 format. RSS, or Really Simple Syndication, is an XML-based format that is widely used for syndicating content from sources. The core feed format is relatively simple, with only a limited number of IBM elements Software that need Group to be specified Lotus for software each item in the feed. The RSS 2.0 specification allows the base format to be extended using XML namespaces to support additional functionality In order to enable a deeper level of control over how items are created in Web Content Management, an RSS extension has been defined which contains elements that map to many of the attributes of the W eb Content Management object model. 6

7 WCI Feeds RSS Namespace Extension for Web content Process Control Elements Location Control Elements Identity control elements Profile Control Elements The authoringtemplate element Element control element W orkflow control elements Security control elements 7

8 WCI Feeds Refer to Info center for more details on WCI/RSS Feeds and RSS Namespace Extension for W eb content topic=/com.ibm.wp.ent.doc_v615/wci/wci_ff_spec.html topic=/com.ibm.wp.ent.doc_v615/wci/wci_ff_nse.html Refer to below link for Sample Feeds in Info center topic=/com.ibm.wp.ent.doc_v615/wci/wci_ff_examples.html 8

9 Configuring WebSphere Portal to consume the feed Must have WebSphere Portal / Lotus Web Content Management Feature Pack or later installed. Access Portal Administration page, Feed Configuration section, and define the feed by Selecting New. Complete all the fields that are required and save. Then select the feed and click consume, to consume the Feed and create W CM contents. 9

10 Configuring WebSphere Portal to consume the feed 10

11 Configuring WebSphere Portal to consume the feed In the above screenshot, I have created a Feed DRCreateContent, to create a content in WCM Library WCISampleLib, and I also created a DRWCI-SLOT in Portal that has the author user and password. Refer to Portal Info center on how to create your own Credential Slot. Also we need to have the required design elements created prior to creating any content items, just like you need to have when working through the Authoring Portlet. Once the above steps are completed, Select the Feed and click Consume. 11

12 Configuring WebSphere Portal to consume the feed 12

13 Working with WCI Feed jobs You can define a WCI feed job to manage a group of feed configurations and apply a schedule to them. You can Start, Stop, Suspend, Resume and Delete a feed job as needed. More details in below link v6r1/index.jsp?topic=/com.ibm.wp.ent.doc_v615/ wci/wci_feed_manage_working.html 13

14 Must Gather Information. WCI MustGather can be found in below link that provides instructions on gathering Trace and Required docs. Trace: com.ibm.workplace.feed.*=finest Also collect the WCMConsumerPlugin.properties from below location <W P_profile_root>/installedApps/NodeName/ FeedService.ear/config/plugins/ Feed File(s), This could be a copy of the RSS feed that was being processed at the time an error occurred. Alternatively, it may be a collection of feeds that will allow you to reproduce a particular scenario 14

15 WCM Design Artifacts In order to reproduce a problem on a different server it may be necessary to create some design artifacts in WCM This information can usually be gleaned from the feed files, but it is better to get it explicitly spelled out. Authoring template names plus associated element names and types Workflow names plus associated stage names and actions It may also be possible to use library import / export tools to get this information 15

16 Reading logs. Each time the Content Integrator runs a job the same sequence of operations takes place for each task that is listed in the job s task list: Task startup messages are printed The feed is retrieved and parsed The items from the feed are filtered and sorted The items from the feed are processed one-by-one 16

17 Any items containing references which could not be resolved on the first pass are re-processed Task completion messages are printed Recognizing the types of log messages that correspond to each operation IBM can help Software you pinpoint Group the section Lotus of the software log on which you need to focus your attention. Some common message logged in the traces are discussed in the next slides. 17

18 Reading logs Task start and end Messages Task start messages [4/8/10 0:38:33:875 EDT] FeedService 3 getfeedservice: ENTRY [4/8/10 0:38:33:875 EDT] FeedService 3 getfeedservice: [4/8/10 0:38:33:875 EDT] FeedService 3 getfeedservice: = Starting new IBM Feed Service = [4/8/10 0:38:33:875 EDT] FeedService 3 getfeedservice: EXIT and [4/8/10 0:38:54:812 EDT] FeedService 3 performtask: ENTRY [4/8/10 0:38:54:859 EDT] WCMConsumerPl 3 performaction: Entry WCMConsumerPlugin.performAction [4/8/10 0:38:54:859 EDT] WCMConsumerPl = Starting WCM Consumer Plugin Operation = [4/8/10 0:38:54:859 EDT] WCMConsumerPl 3 Processing Task: DRCreateContent Action: CONSUME 18

19 Task completion messages [4/8/10 0:39:00:156 EDT] FeedService 3 updatetask: Task DRCreateContent updated. [4/8/10 0:39:00:156 EDT] FeedService 3 updatetask: EXIT [4/8/10 0:39:00:156 EDT] WCMConsumerPl 3 Set task last run date to: Thu Apr 08 00:38:54 EDT 2010 [4/8/10 0:39:00:156 EDT] WCMConsumerPl 3 [4/8/10 0:39:00:187 EDT] PluginPropert 3 getproperty: key: enable.output.feed val: false [4/8/10 0:39:00:187 EDT] WCMConsumerPl 3 consumefeed: Exit WCMConsumerPlugin.consumeFeed [4/8/10 0:39:00:187 EDT] WCMConsumerPl 3 [4/8/10 0:39:00:187 EDT] WCMConsumerPl 3 ---= Completed Processing Task: DRCreateContent action: CONSUME =--- 19

20 Search the trace.log file for the string --= to quickly locate the start and end points of each task If something caused the WCI to end abnormally while processing the feed then the completion messages may not get written to the log. Search the system log files for error messages and/or stack traces that correspond to the time of the last message written in the trace.log 20

21 Reading Logs Retrieving & Parsing the Feed [4/8/10 0:38:55:203 EDT] RomeFeedParse 3 parsefeed: Begin parsing the retrieved feed The character encoding has been detected as UTF-8 [4/8/10 0:38:55:250 EDT] WCMModulePars 3 parse: Begin parsing feed entry: Release 2.0 Announcement [4/8/10 0:38:55:265 EDT] WCMModulePars 3 addlocations: Created Path object with path: /WCISite/WCISiteArea and library: -Default- [4/8/10 0:38:55:265 EDT] WCMModulePars 3 setworkflow: Setting WCMModule's workflow: WCISampleLib/ SimpleWF and stage: Publish Stage [4/8/10 0:38:55:265 EDT] WCMModulePars 3 addcomponents: Parsing component element with name: Abstract and type: text [4/8/10 0:38:55:265 IBM EDT] Software WCMModulePars Group 3 addcomponents: Lotus Created Component software object: Abstract [4/8/10 0:38:55:265 EDT] WCMModulePars 3 addcomponents: Parsing component element with name: Body and type: rich text [4/8/10 0:38:55:265 EDT] WCMModulePars 3 addcomponents: Created Component object: Body [4/8/10 0:38:55:265 EDT] WCMModulePars 3 addcomponents: Parsing component element with name: Main Image and type: image [4/8/10 0:38:55:265 EDT] WCMModulePars 3 addcomponents: File name: ibm-logo.gif [4/8/10 0:38:55:265 EDT] WCMModulePars 3 addcomponents: Created Component object: Main Image [4/8/10 0:38:55:265 EDT] WCMModulePars 3 parse: End parsing feed entry: Release 2.0 Announcement [4/8/10 0:38:55:265 EDT] RomeFeedParse 3 parsefeed: Finished parsing feed of type rss_2.0 with encoding UTF-8 21

22 [4/8/10 0:38:55:281 EDT] RomeRSSFeedHa 3 getallentries: Getting ROME meta data Modules for Release 2.0 Announcement [4/8/10 0:38:55:281 EDT] RomeRSSFeedHa 3 getallentries: Got 1 Modules from the feed entry. [4/8/10 0:38:55:281 EDT] RomeRSSFeedHa 3 getallentries: Found Module with URI: ibmfeedsvc/wcm/1.0 [4/8/10 0:38:55:281 EDT] RomeRSSFeedHa 3 getallentries: The entry contains the WCM Module: WCMModuleImpl.objectType=Content WCMModuleImpl.owners[0]=wps admin WCMModuleImpl.childrenAction=null Pay attention to the character encoding that is listed in the message highlighted in blue above. This shows the encoding that the Consumer will attempt to use when parsing the feed. If this doesn t match the actual encoding of the feed there could be problems and an error message will normally be listed next. Character encoding issues are usually due to a mismatch with the value in the content-type HTTP header field. 22

23 The getallentries messages will be repeated for each entry in the feed. These occur as the WCI is interpreting the custom namespace. If you are logging DEBUG messages you will see an additional listing for each feed entry which displays the values found in each of the custom namespace elements in that entry. This can be used to validate that the WCI was able to get the intended data IBM from Software the feed. Group Lotus software 23

24 Reading Logs Filtering & Sorting the Feed Entries [4/8/10 0:38:55:281 EDT] WCMConsumerPl 3 sort: ADDS: 1 [4/8/10 0:38:55:281 EDT] WCMConsumerPl 3 sort: Adding Content object: Release 2.0 Announcement [4/8/10 0:38:55:281 EDT] WCMConsumerPl 3 sort: UPDATES: 0 [4/8/10 0:38:55:281 EDT] WCMConsumerPl 3 sort: DELETES: 0 [4/8/10 0:38:55:281 EDT] WCMConsumerPl 3 sort: EXIT [4/8/10 0:38:55:359 IBM EDT] Software WCMConsumerPl Group 3 consumefeed: Lotus software Workspace established for user: wps admin [4/8/10 0:38:55:390 EDT] WCMConsumerPl 3 consumefeed: Attempting to locate a WCM DocumentLibrary with id : 8ca06d0041ddd2e59c86bf9532c646c5 [4/8/10 0:38:55:390 EDT] WCMConsumerPl 3 getdocumentlibrarybyid: DocLib Id is 8ca06d0041ddd2e59c86bf9532c646c5 [4/8/10 0:38:55:421 EDT] WCMConsumerPl 3 getdocumentlibrarybyid: found a DocLib com.ibm.workplace.wcm.api.wcm_documentlibrary@cbcdbf27 [4/8/10 0:38:55:421 EDT] WCMConsumerPl 3 consumefeed: Found a WCM DocumentLibrary called: wcisamplelib. All operations will be conducted against this library. 24

25 The filter rule is specified in the Task configuration. Content items that don t satisfy the filter rule will not be processed and a corresponding message will be logged here. The WCI sorts the entries in the feed prior to processing them. Thus the order IBM in Software which the entries Group are listed Lotus in this software part the log will likely be different than the order in which the entries appear in the feed. The entries will actually be processed in the order they are listed here. 25

26 Reading Logs Processing Feed Entries [4/8/10 0:38:55:421 EDT] WCMConsumerPl 3 consumefeed: Begin processing feed entry 1 of 1: Action: add Title: Release 2.0 Announcement DisplayTitle: null Description: This is a content item. Entry pubdate: Tue Mar 02 10:34:00 EST 2010 Entry author: null Authors[0]: wps admin Owners[0]: wps admin GUID: Link: Object Type: Content Content Type: WCISampleLib/Article Library: null Default Content: null Location[0]: /WCISite/WCISiteArea Parents[0]: Children Action: null Children Position: null Keywords: software,content management Component[0].name: Abstract Component[1].name: Main Image Component[2].name: Body Workflow: WCISampleLib/SimpleWF Workflow Stage: Publish Stage Publication Date: Tue Mar 02 10:34:00 EST 2010 Expiration Date: Wed Mar 02 10:34:00 EST 2011 General Date One: Tue Mar 02 10:34:00 EST 2010 General Date Two: User Entitlement[0]: [all users] 26

27 Reading Logs Processing Feed Entries [4/8/10 0:38:55:421 EDT] WCMConsumerPl 3 processentry: ENTRY [4/8/10 0:38:55:421 EDT] WCMConsumerPl 3 processentry: No library was specified in the feed. Using the default WCM Library: wcisamplelib [4/8/10 0:38:55:437 EDT] WCMObjWrapper 3 createwrapper: ENTRY [4/8/10 0:38:55:437 EDT] WCMObjWrapper 3 createwrapper: EXIT [4/8/10 0:38:55:437 EDT] WCMConsumerPl 3 getwcmobjectfromguid: ENTRY [4/8/10 0:38:55:437 EDT] IdMappingQuer 1 executing query : 'SELECT * FROM jcr.objects WHERE TASK_ID =? AND EXTERNAL_GUID =?' with params : {1279bfb21d , } [4/8/10 0:38:55:437 EDT] IdMappingQuer 1 found 0 IdMapping objects for above query : [] [4/8/10 0:38:55:437 IBM EDT] Software IdMapImpl I getallidsforguid: Group Found 0 entries Lotus for GUID: software in Job: 1279bfb21d [ a variety of messages will appear here depending on the type of item being processed and the contents of the feed entry. ] [4/8/10 0:38:58:015 EDT] AEditableWrap 3 saveobject: WCM ID after successful save: com.ibm.workplace.wcm.api.wcm_content/release 2.0 Announcement/f42ac400420a80f8ae10ef75e23b0488/PUBLISHED [4/8/10 0:38:58:015 EDT] AEditableWrap 3 saveobject: EXIT [4/8/10 0:38:58:015 EDT] WCMConsumerPl 3 updateitem: Added object : Release 2.0 Announcement -- Status: WARN 27

28 Reading Logs Adding/Updating A Content Item Adding or updating a Content Item through the WCI follows a consistent procedure. Search for a pre-existing version of the item in WCM If one is found it will be updated, otherwise a new one will be created Verify that all Categories and SiteAreas referenced in the feed entry exist in WCM Create any that don t already exist Update Identity information (Name, Display Title, etc.) 28

29 Update Entitlements Apply Categories Apply Keywords Update Components Set the Workflow & Workflow Stage Update Locations Update the ID Mapping in the Feed Service DB Every other object type (Site, Library File Component, etc.) goes through a similar process 29

30 Reading Logs Isolating Problem Areas Understanding the sequence of actions will help you locate the relevant information in the logs when troubleshooting a problem. Enabling logging at the TRACE level can make it easier to see where each action begins and ends by showing ENTRY and EXIT messages for each method. [4/8/10 0:38:56:312 EDT] AEditableWrap 3 updateidentityinfo: ENTRY [4/8/10 0:38:56:312 EDT] AEditableWrap 3 updateidentityinfo: Adding authors: [wps admin] [4/8/10 0:38:56:328 EDT] AEditableWrap 3 updateidentityinfo: Adding owners: [wps admin] [4/8/10 0:38:56:328 EDT] AEditableWrap 3 updateidentityinfo: EXIT 30

31 Reading Logs Isolating Problem Areas [4/8/10 0:38:56:796 EDT] ContentWrappe 3 setworkflowstage: ENTRY [4/8/10 0:38:56:796 EDT] WCMConsumerUt 3 clearcachebyname: cache name: Release 2.0 Announcement documenttype: com.ibm.workplace.wcm.api.wcm_content [4/8/10 0:38:56:796 EDT] WCMConsumerUt 3 NameTypeKey.hashCode: [4/8/10 0:38:56:796 EDT] WCMConsumerUt 3 NameTypeKey.hashCode: [4/8/10 0:38:56:796 EDT] WCMConsumerUt 3 NameTypeKey.hashCode: [4/8/10 0:38:56:796 EDT] ContentWrappe 3 setworkflowstage: Feed specified workflow: WCISampleLib/ SimpleWF and workflow stage: Publish Stage [4/8/10 0:38:56:796 IBM EDT] Software ContentWrappe Group 3 setworkflowstage: Lotus Content is not software currently assigned to a [4/8/10 0:38:56:796 EDT] WCMConsumerUt 3 findbyname: Search library: WCISampleLib for an object named: SimpleWF [ com.ibm.workplace.wcm.api.wcm_workflow other type: com.ibm.workplace.wcm.api.wcm_workflow [4/8/10 0:38:56:796 EDT] WCMConsumerUt 3 findbyname: Found at least one DocumentId in the cache for object: WCISampleLib/SimpleWF [4/8/10 0:38:56:796 EDT] ContentWrappe 3 setworkflowstage: Found a Workflow object in WCM called WCISampleLib/SimpleWF with ID: com.ibm.workplace.wcm.api.wcm_workflow/simplewf/ deee4f804198cc1081b6bd2074a06c13/published [4/8/10 0:38:56:828 EDT] ContentWrappe 3 setworkflowstage: WorkflowStage[0]: Publish Stage [4/8/10 0:38:56:843 EDT] ContentWrappe 3 setworkflowstage: currentstgidx=0 / targetstgidx=0 [4/8/10 0:38:56:843 EDT] ContentWrappe 3 setworkflowstage: The Workflow contains a stage named: Publish Stage [4/8/10 0:38:56:843 EDT] ContentWrappe 3 setworkflowstage: The content was already in the desired workflow stage. [4/8/10 0:38:56:843 EDT] ContentWrappe 3 setworkflowstage: EXIT 31

32 Applying Debug, Test fix and fixes. The FeedService.jar & FeedServiceWCMPlugin.jar are located in the directory \wp_profile\portalserver\wcm\shared\app If any test fix/debug from L3/Debug extract to this directory and restart the server, unless an alternate instruction is provided. WCI fixes / APAR'S are also integrated into WCM Cumulative Fix for Feature Pack and later. Would recommend to apply the latest CF and run the required task to install any fixes. At the least would recommend CF30 or later, as this fixes multiple problem identified. Refer to CF Readme for list of fixes 32

WCI Feed Service Servlet

WCI Feed Service Servlet Muhammad Mokhtar, IBM Portal and WCM SME Page 1 of 14 Introduction... 3 Objective... 3 Document Scope... 3 Web Content Integrator... 3 Feed Service System Design... 4 Using Web