give your community owners the reports they really need
DESCRIPTION
This is my presentation on creating customized Cognos reports for IBM Connections which I gave at the IBM Connections usergroup V in Zurich #soccnxTRANSCRIPT
Give your Community Owners the Reports they really need!
© 20
13 B
elsoft
AG
| ww
w.be
lsoft.c
h
Legal disclaimer
§ This is a TECHNICAL session § You will see some lines of code
-> if you feel offended you can still leave the room § I‘m not a developer
-> my coding is awful § Views and opinions expressed are mine alone and do not represent the official views
of my employer (my boss has no clue what I’m talking about) § I’m a kind of Administrator but if you do Connections you will turn out to be a
-> see next slide
Get off the Visitors WiFi, I need it for my live demo!
© 20
13 B
elsoft
AG
| ww
w.be
lsoft.c
h
About me
kbild.ch
xing.com/profile/Klaus_Bild
twitter.com/kbild
linkedin.com/in/kbild
© 20
13 B
elsoft
AG
| ww
w.be
lsoft.c
h
Agenda
§ Metrics overall system architecture 1. Prepare your environment 2. Define the custom report & check dimensions/events 3. Create Report 4. Insert Chart 5. Define data items 6. Add data items to axes 7. Format the chart 8. Filter data / work with parameters 9. Add Report to Community Report list § Parameters / Expressions / Some examples
© 20
13 B
elsoft
AG
| ww
w.be
lsoft.c
h
Metrics overall system architecture
Connections
Activities
Communities
Files
Forums
Wikis
Blogs
Profiles
Dogear
Cognos BI Server
Content Manager Report Studio Framework Manager Transformer
Cognos Metrics Models & Reports
Metrics Component Events Capture Raw Metrics DB
Power Cube User
© 20
13 B
elsoft
AG
| ww
w.be
lsoft.c
h
Before we start a performance trick
§ Yes, Cognos HW requirements are enormous but there are some tricks to speed up report creation:
http://www-10.lotus.com/ldd/lcwiki.nsf/dx/Reduce_the_community_metrics_request_waiting_time_in_IBM_Connections_4.0_Metrics i.e. „last quarter“ and all people groups were removed...
© 20
13 B
elsoft
AG
| ww
w.be
lsoft.c
h
Before you start read this (aka RTFM)
§ Connections 4.0 Metrics Reports Introduction - http://goo.gl/CHSsn Lists all 110 reports (50 community reports)
§ Using the Metrics application in IBM Connections 4.0 - http://goo.gl/r1oF7 Did you know that there are right click actions?
§ PowerCube dimensions - http://goo.gl/OR04d
§ Community report customization for Connections 4.0 Metrics - http://goo.gl/ObcYF
§ Create new Cognos metrics report - http://goo.gl/ROFgt
§ Customizing reports based on the events captured in Metrics4.0 - http://goo.gl/dvXF0
© 20
13 B
elsoft
AG
| ww
w.be
lsoft.c
h
1. Prepare your environment
§ Open http://cognosserver.example.com:port/cognos/servlet/dispatch/ext § Create a folder for your custom reports
© 20
13 B
elsoft
AG
| ww
w.be
lsoft.c
h
1. Prepare your environment
§ Look at the the actual reports and don‘t use same names for your custom reports 'jobtemplate’ & 'jobtemplate1’ in Public Folders > IBMConnectionsMetrics > Metrics > static & click on „Set properties“
© 20
13 B
elsoft
AG
| ww
w.be
lsoft.c
h
1. Prepare your environment
§ Start the Report Studio via Launch menu § Choose the Metrics folder as package source
- If you don‘t see the link for Report Studio or the welcome screen use an alternative browser
- I would recommend to use Firefox Version 3.5/3.6!
© 20
13 B
elsoft
AG
| ww
w.be
lsoft.c
h
2. Define the custom report & check dimensions/events
§ Define the report on paper
§ Data for Community Wiki/Blog/Forum § Number of visits per App § Date range (hours, day, week) § Line chart
# vi
sits
Blogs, Forum, Wiki
© 20
13 B
elsoft
AG
| ww
w.be
lsoft.c
h
2. Define the custom report & check dimensions/events
§ Cross check Powercube dimensions http://goo.gl/OR04d § Regular dimensions
- DATE: This is a time dimension, which indicates the time that an event was generated. This dimension break down time into year, month, week, and day levels. - SOURCE: This dimension indicates the application that generated the event. - SCOPE: This dimension indicates the scope of the content that is referred to by the event. - ITEM: This dimension indicates the type of the content that referred by the event. - EVENT: This dimension indicates the action of the event. - COMMUNITY: This dimension indicates the community that the event happens. - UNIQUE EVENT: This dimension indicates the action of the event in the calculation of unique people and content. - ATTRIBUTE1: The categories of this dimension comes from the specified attribute of profile, and this can be customized by system administrator. - ATTRIBUTE2: The categories of this dimension also comes from the specified attribute of profile, and this can be customized by system administrator. - ATTRIBUTE3: The categories of this dimension also comes from the specified attribute of profile, and this can be customized by system administrator.
§ Measure dimensions - EVENT_COUNT: This measure dimension is used for the calculation of event counting. - DAILY_UNIQUE_USER: This measure dimension is used for the calculation of unique user number in day level. - WEEKLY_UNIQUE_USER: This measure dimension is used for the calculation of unique user number in week level. - MONTHLY_UNIQUE_USER: This measure dimension is used for the calculation of unique user number in month level. - DAILY_UNIQUE_CONTENT: This measure dimension is used for the calculation of unique content number in day level. - MONTHLY_UNIQUE_CONTENT: This measure dimension is used for the calculation of unique content number in month level. - WEEKLY_UNIQUE_CONTENT: This measure dimension is used for the calculation of unique content number in week level.
- INITIAL_COUNT: This measure dimension is used for the calculation of initial count. - ZERO: This measure dimension represents 0 in the calculation.
No report for hour of day possible
© 20
13 B
elsoft
AG
| ww
w.be
lsoft.c
h
2. Define the custom report & check dimensions/events
§ Download „Events&Reports in Metrics.ods“, check if data is captured in events: http://goo.gl/So73x
Events List&Basic Reports
What? Details Which entries?
Which action? Action type for calculations?
Used in which report? Source app?
Calculated Reports
© 20
13 B
elsoft
AG
| ww
w.be
lsoft.c
h
§ MEASURE : EVENT_COUNT § ITEM : DEFAULT § EVENT: VISIT
§ SOURCE : BLOGS, FORUMS, WIKIS
§ DATE : DAY/WEEK/MONTH/YEAR level from 'DATE' dimension
2. Define the custom report & check dimensions/events
y-axis
Series
x-axis
Number of visits
App
Date range
© 20
13 B
elsoft
AG
| ww
w.be
lsoft.c
h
3. Create Report
§ Start with an empty report
or
© 20
13 B
elsoft
AG
| ww
w.be
lsoft.c
h
4. Insert Chart
§ There are 81 different chart types! (Column, Bar, Progressive, Pareto, Line, Pie/Donut, Area, Combination,Scatter/Bubble/Point, Radar/Polar, Gauge, Metrics Range, Microchart)
© 20
13 B
elsoft
AG
| ww
w.be
lsoft.c
h
§ App (BLOG, FORUMS, WIKIS)
5. Define data items
set ([BLOGS],[FORUMS],[WIKIS])
© 20
13 B
elsoft
AG
| ww
w.be
lsoft.c
h
§ App (BLOG, FORUMS, WIKIS)
5. Define data items
© 20
13 B
elsoft
AG
| ww
w.be
lsoft.c
h
§ Number of visits (DEFAULT, VISIT, EVENT_COUNT)
5. Define data items
.../ITEM/ITEM/Members/DEFAULT
.../EVENT/EVENT/Members/VISIT
.../Measures/EVENT_COUNT
tuple([DEFAULT],[VISIT], [EVENT_COUNT])
© 20
13 B
elsoft
AG
| ww
w.be
lsoft.c
h
6. Add data items to axes
First we use all months as data range
© 20
13 B
elsoft
AG
| ww
w.be
lsoft.c
h
7. Format the chart
© 20
13 B
elsoft
AG
| ww
w.be
lsoft.c
h
8. Filter data / work with parameters
-> right now we have number of visits to all blogs/forums/wikis for all months We want to restrict the data to the actual community and use the date range of the view selector
© 20
13 B
elsoft
AG
| ww
w.be
lsoft.c
h
8. Filter data / work with parameters
filter([METRICS_TRX_CUBE].[COMMUNITY].[COMMUNITY].[COMMUNITY NAME] , [METRICS_TRX_CUBE].[COMMUNITY].[COMMUNITY].[COMMUNITY NAME].[COMMUNITY NAME - Category Code]=?dcommunityid?)
?dcommunityid? -> this parameter will take the actual community id and will pass it to the report
© 20
13 B
elsoft
AG
| ww
w.be
lsoft.c
h
8. Filter data / work with parameters
uplevel, upnum, endDate -> this expression will give us the date range of the view selector
lastPeriods(?upnum?, ancestor(#'[METRICS_TRX_CUBE].[DATE].[DATE].[DAY]->:[PC].[@MEMBER].['+ prompt('endDate', 'integer') +']'#, #prompt('uplevel', 'integer')#))
© 20
13 B
elsoft
AG
| ww
w.be
lsoft.c
h
§ Date range
8. Filter data / work with parameters
© 20
13 B
elsoft
AG
| ww
w.be
lsoft.c
h
8. Filter data / work with parameters
© 20
13 B
elsoft
AG
| ww
w.be
lsoft.c
h
9. Add Report to Community Report list
§ On the Cognos dashboard find the 'jobtemplate1' under folder Public Folders > IBMConnectionsMetrics > Metrics > static and click on „Set properties“
© 20
13 B
elsoft
AG
| ww
w.be
lsoft.c
h
9. Add Report to Community Report list
§ On the Connections server check out and edit the reports-config.xml file
§ Check in reports-config.xml § Add your custom labels to com.ibm.connections.metrics.ui.strings.ui.properties file
(inside the customization/strings folder)
Name of custom report (case sensitive!)
Unique name Label string
© 20
13 B
elsoft
AG
| ww
w.be
lsoft.c
h
9. Add Report to Community Report list
§ Go to you Connections environment and open up the Metrics page of a Community, you should now see the new Category and your custom report
§ Click on „Update metrics“ to see results of your custom report
© 20
13 B
elsoft
AG
| ww
w.be
lsoft.c
h
Parameters
§ dcommunityid = Category Code of actual Community § communityid = CommunityID of actual Community § endDate = Yesterday § coverinvaliddate, installedapps, lclocale, metricsstartdate, range, rangetype,
showuserinfo, sourceid, spanweeks, uplevel, upnum § Standard views:
- Last 7 days -> upnum 7, uplevel 0, range 7, rangetype D - Last 4 weeks -> upnum 5, uplevel 1, range 4, rangetype W - Last 12 months -> upnum 12, uplevel 2, range 12, rangetype M - All years -> upnum 100, uplevel 3, range 0, rangetype A
© 20
13 B
elsoft
AG
| ww
w.be
lsoft.c
h
Parameters
§ i.e. installedapps -> create a report for all used apps inside a community - _-1_ -> Related Communities - _1_ -> Activities - _2_ -> Blog - _3_ -> Bookmarks - _5_ -> Files - _6_ -> Forum - _12_ -> Wiki - _15_ -> Ideation Blog - _19_ -> Media Gallery
§ i.e. lclocale -> use for language specific settings
if( ?installedapps? contains '_1_' )
then ([ACTIVITIES]) else (NULL)
© 20
13 B
elsoft
AG
| ww
w.be
lsoft.c
h
Expressions / Some examples
§ Show communities that were created in a certain week: filter([METRICS_TRX_CUBE].[COMMUNITY].[COMMUNITY].[COMMUNITY NAME], tuple([COMMUNITIES], [COMMUNITY], [CREATE], [EVENT_COUNT], [5/8])>0 )
§ Return "Last Week" as the week variable prevMember(parent( #'[METRICS_TRX_CUBE].[DATE].[DATE].[DAY]->:[PC].[@MEMBER].['+ timestampMask($current_timestamp,'yyyymmdd') +']'# ))
§ Date Range - Show the last 6 months lastPeriods(6, closingPeriod([METRICS_TRX_CUBE].[DATE].[DATE].[MONTH]))
§ Total in-/active communities (not created or updated within variable „Date Range“) total( 1 within set filter ([METRICS_TRX_CUBE].[COMMUNITY].[COMMUNITY].[COMMUNITY NAME], total ((tuple([CREATE])+tuple([UPDATE])) within set [Date Range]) = 0)) total( 1 within set filter ([METRICS_TRX_CUBE].[COMMUNITY].[COMMUNITY].[COMMUNITY NAME], total ((tuple([CREATE])+tuple([UPDATE])) within set [Date Range]) > 0)) same and no vists within „Date Range“ total( 1 within set filter ([METRICS_TRX_CUBE].[COMMUNITY].[COMMUNITY].[COMMUNITY NAME], total ((tuple([CREATE])+tuple([UPDATE]) +tuple([VISIT])) within set [Date Range]) = 0)) total( 1 within set filter ([METRICS_TRX_CUBE].[COMMUNITY].[COMMUNITY].[COMMUNITY NAME], total ((tuple([CREATE])+tuple([UPDATE]) +tuple([VISIT])) within set [Date Range]) > 0))
§ How many people have updated the photo in their profile tuple([PROFILES] , [PROFILE.PHOTO] , [USER_UPDATE] , [WEEKLY_UNIQUE_USER] , [4/7] )
© 20
13 B
elsoft
AG
| ww
w.be
lsoft.c
h
Additional remarks
§ Not all reports use the metrics reports package - That’s not a standard power cube dimension?! - MetricsCubeDS/MetricsDBQuery - Uses METRICS_CUBE_DS not
METRICS_TRX_CUBE & is not documented L
§ Look at the default reports to learn how to create advanced reports § Creation of a custom report is not simple
and I don’t think that a business user can do it (…should be possible) § Cognos offers endless possibilities
© 20
13 B
elsoft
AG
| ww
w.be
lsoft.c
h
© 20
13 B
elsoft
AG
| ww
w.be
lsoft.c
h
Contact me
kbild.ch
xing.com/profile/Klaus_Bild
twitter.com/kbild
linkedin.com/in/kbild