ibm connections demo assistant

© 2014 IBM Corporation

IBM Connections Demo Assistant

Author: Paul GodbyIBM Ecosystem DevelopmentDuration: 15 minutes

Agenda

● Overview● XML Input Files● Configuration● Execution● Demo

Typical Demo Scenario

● Obtain an IBM Connections server instance● Request a SoftLayer device● Request / Download Showcase servers● Create a local VMware image● Etc...

● Log in to IBM Connections and realize there's no data!● Begin logging in multiple users and creating demo data

● This could take hours (or even days!)● Repeat the same process for each demo

IBM Connections Demo Assistant

● A data population tool for IBM Connections● Data supplied via XML files● Simple configuration via a properties file● Can be executed from any machine that can access IBM Connections via HTTP● Uses IBM Connections REST and OpenSocial APIs to create demo data

● Benefits● Fill your IBM Connections server instance with demo data...with a single command!● Create your demo data in minutes, as opposed to hours (or even days)!● Reuse XML data files to reproduce data set across multiple environments● Spend more time preparing for the live demo / customer

Agenda

● Overview● XML Input Files● Configuration● Execution● Demo

XML Input Files

● Data is supplied in the form of XML input files● You can create the following types of demo data in IBM Connections

● Activity Streams: events and microblogs● Activities: activities, sections, entries, and todos● Blogs: blogs, blog posts● Bookmarks: bookmarks● Communities: data for (most) embedded apps, subcommunities● Files: files, folders● Forums: forums, topics, replies● Profiles: network invitations● Wikis: wikis, pages

● For some of the data, you may also add: comments, likes, members, etc.● For a full list of supported features / data, consult the included file: icda.xml● More features will be added over time!

Authors

● ICDA uses REST and OpenSocial APIs that require HTTP Basic Authentication● Must supply username / password for any demo user that will be creating data

● For the data sections of the XML file, you reference the UID attribute of the author● The tool will retrieve the username / password from the authors section and

subsequently create the provided data for that particular demo user

Data Example: Activity

Files

● Upload files into IBM Connections by placing the file in the files subdirectory● Supply the appropriate data via XML

● The tool will check for the existence of the file in the files subdirectory● If found: will upload the supplied file● If NOT found: will create an empty file, with the given name, and then upload

● If you only intend to show one file in your demo, put it in the files subdirectory● Create the illusion of lots of files in Connections via extra XML entries

Agenda

● Overview● XML Input Files● Configuration● Execution● Demo

Update the supplied properties file

● Settings contained in file named: icda.properties

Delete Content

● When the tool starts, it will check the supplied delete flags in icda.properties● If a valid author (from the XML input file) is found, ALL content of that type will be

deleted for the specified user (not just the content created by ICDA!)● Useful for:

● Resetting the server between demos● Testing new XML input files

● This is an Optional configuration!● If you do not want to delete content, leave these flags blank (or comment out)

Agenda

● Overview● XML Input Files● Configuration● Execution● Demo

Using the tool

● This is a command-line driven tool● Configuration supplied via icda.properties● Data supplied via XML input file

● Tool may be executed from any machine that can access IBM Connections via HTTP● Does not need to reside on the server

● Requirements● A Java Runtime Environment (1.6+)

● From a command-line:

java -jar ICDA.jar

OR, if no environment variables are set, provide the full path to the JRE...

/opt/IBM/WebSphere/AppServer/java/jre/bin/java -jar ICDA.jar

Agenda

● Overview● XML Input Files● Configuration● Execution● Demo

Things you should know...

● This is NOT an official IBM tool!● No official support● Use at your own risk

● This tool is intended for demos / PoCs only!● Should not be used in a live production environment

● Can be found in a wiki in from one of the Connections deployments● Installation, configuration, and execution instructions● XML Input file overview● Troubleshooting● Feedback

● IBM Internal: ● https://w3-connections.ibm.com/wikis/home?lang=en-us#!/wiki/ICS%20Demo%20Tools

● IBM External:● https://greenhouse.lotus.com/wikis/home?lang=en-us#!/wiki/ICS%20Demo%20Tools

Thanks!

● Access FREE education on the IBM Collaboration Solutions portfolio of products today!

1. Visit the IBM Greenhouse and create a free account.

Link → http://greenhouse.lotus.com/

2. Visit the IBM Collaboration Solutions Ecosystem Development Community

Link → https://greenhouse.lotus.com/communities/community/icsecod

3. Learn new skills and share these links with your friends and colleagues!