1. No category

Session JMP303
IBM Docs Architecture, Deployment,
and Cloud Considerations
Christopher Gloe, IBM
Michael Britt, IBM
© 2014 IBM Corporation
Please Note
IBM’s statements regarding its plans, directions, and intent are subject to change or withdrawal without notice at IBM’s sole
discretion.
Information regarding potential future products is intended to outline our general product direction and it should not be
relied on in making a purchasing decision.
The information mentioned regarding potential future products is not a commitment, promise, or legal obligation to deliver
any material, code or functionality. Information about potential future products may not be incorporated into any contract.
The development, release, and timing of any future features or functionality described for our products remains at our sole
discretion
Performance is based on measurements and projections using standard IBM benchmarks in a controlled environment.
The actual throughput or performance that any user will experience will vary depending upon many factors, including
considerations such as the amount of multiprogramming in the user’s job stream, the I/O configuration, the storage
configuration, and the workload processed. Therefore, no assurance can be given that an individual user will achieve
results similar to those stated here.
2
Agenda

●

3
Architecture
– Brief IBM Docs introduction
– High level overview of architecture
●
Docs
●
Conversion
●
Viewer
●
Mobile
Planning, Management and Maintenance
– Capacity Planning
– Scaling Considerations
– Client/Server requirements
– Performance Tuning
– Administration/Configuration
●
Install Process
●
iFix Process
●
Upgrade Process
– Troubleshooting
Deployment Models and Work Flows
– Edit, View, Publish
– High Availability Architecture
Extending the IBM Portfolio with IBM Docs
Solutions
●
Web-based editors
Creating, sharing and collaboratively
authoring
●
Documents, spreadsheets and
presentations
●
●
Fidelity
●
Editing functionality
●
Social capability
●
Mobility
●
Version management
●
Portfolio Integration
Problems
Delivery model
Collaborating, co-authoring is
painful, too much manual effort
involved.
●
●
Desktop applications (MS Office and
Apache Open Office) are too heavy
for majority of generic document
authors.
●
4
Key Focus
On Premise (3-4 times a year)
SmartCloud (monthly)
●
*Same code base for on-premise and
SmartCloud
IBM Docs – 2013 Highlights
SmartCloud
SmartCloud Docs
(April – June)

Spreadsheets: Copy/paste
between desktop and Docs,
CSV/TXT import and export,
page up/down & resize
performance improvement.





SmartCloud Docs
(January – March)
Presentations: Copy/paste
images/basic text between
desktop and Docs, Table
improvements, Basic Object
formatting - vertical alignment.

Common: Fidelity and editor
improvements,
Accessibility, Recently
opened files
Document: Long distance
performance improvement.

Spreadsheets: Cut
Common: Maintain original
formats (MS, ODF), OOXML
template support, Safari 6 and
Chrome support

Documents: Copy/Paste
enhancements
SmartCloud Docs
(July – September)

Improved OOXML support

iPad: On/offline view across all
applications, document online
editing.

Spreadsheets: Long distance
performance improvement,
freeze windows, type ahead,
basic charts, cell borders

Presentations: Core editor
improvements, clear formatting

iPad: New Presentation model.

Spreadsheets: Sheet/range protection,
multi-column operation, .xlsx export,
10k row support, chart set properties.

Presentations: Long distance
performance improvements, shape
and chart rendering, hyperlinks,
find/replace, basic object
formatting, .pptx export

Q3 2013
Q2 2013
Q1 2013
SmartCloud Docs
(October – December)

Q4 2013
IBM Docs v1.0.3
●
On-Premises
IBM Docs v1.0.4
IBM Docs v1.0.5

SmartCloud January – June content
●

SmartCloud July – Sep content

WAS 8

IC 4.5
●
IBM File Viewer (iNotes, Connections)

IBM’s statements regarding its plans, directions, and intent are subject to change or withdrawal
without notice at IBM’s sole discretion. Information regarding potential future products is intended to
outline our general product direction and it should not be relied on in making a purchasing decision.
The information mentioned regarding potential future products is not a commitment, promise, or
legal obligation to deliver any material, code or functionality. Information about potential future
products may not be incorporated into any contract. The development, release, and timing of any
future features or functionality described for our products remains at our sole discretion.
IBM Connections Mobile w/Docs Mobile

Blue text denotes adjacent offering
5
IBM Docs Evolution - 2013
IBM Docs V1.0.3
Support for Connection 4.0 and 4.5
Support for WAS 7.0.0.25
● iPad support
● Enable entitlement to select users/groups
● Improved performance
●
●
IBM Docs V1.0.4
Support for Connection 4.5
Support for WAS 8.0.0.5
● File Viewer support for Windows/Linux and centralized
deployment.
● Oracle DB support.
● Increased file size limits for docs/spreadsheets.
● TAM/Webseal support
●
●
IBM Docs V1.0.5
Support for Connection 4.5
Support for WAS 8.0.0.6
● Support for SLES
● Support export of OOXML file types for presentations
and spreadsheets.
● SAML
●
●
6
IBM Docs – Components





7
Docs Service
–
Provides core logic for processing of documents
●
Session Handling (interfaces to/from the clients)
●
Document Session Management
●
Operational Transformation Services (OT Engine for co-editing)
●
Draft Management, Job Manager, Cache Management, Interface with Conversion
Document Format Conversion Server (Conversion Service)
–
Convert between source and destination formats based on source and target MIME types
–
Used for Upload, Edit, Publish, View, Download As (as needed)
Rendition Manager (Viewer Service)
–
Enables viewing of the latest published version of a document (Documents, Spreadsheets,
Presentations, PDFs)
–
Provides a slide show mode for presentations
Docs Proxy
–
Provides document session affinity to enable co-editing when multiple IBM Docs servers are
deployed
–
Provides performance enhancements by enabling compression of static content.
Docs and Viewer Extensions
–
Provide new buttons and button actions
–
Launch client browser into the Docs or Viewer session
–
Provide daemons used during upload events to pre-convert newly uploaded documents
–
Extend Connections Files and Communities to enable IBM Docs integration
IBM Docs – Logical Topology
Viewer Service
Viewer Service
viewer.ear
viewer.ear
concord.viewer.war
concord.viewer.war
/concord/viewer/*
/concord/viewer/*
HTTP(S)
Storage
(NFS)
Conversion Service
Conversion Service
Docs Proxy
Docs Proxy
concord.conversion.ear
concord.conversion.ear
concord.conversion.war
concord.conversion.war
/concord/conversion/*
/concord/conversion/*
docs.renovations.com
docs.renovations.com
HTTP(S)
Database
router plugin
router plugin
HTTP(S)
HTTP(S)
Document Service
Document Service
concord.doc.ear
concord.doc.ear
concord.doc.war
concord.doc.war
/concord/app/*
/concord/app/*
HTTP(S)
Directory
Service
rtc4web.war
rtc4web.war
/concord/rtc4web/*
/concord/rtc4web/*
XTAF
Spell Checker
Service
8
IBM Docs – High Level Architecture
Document
Document Service
Service
XTAF
XTAF
OT
OTServices
Services
HeartBeat
Service
OT Engine
Operation
Queue
Messaging
Service
Adapter
Web Messaging Service
(RTC4Web)
Flush
Flush
Document
Document
Services
Services
Draft
Draft
Management
Management
Collaboration
Collaboration
Services
Services
Cache
Cache
Management
Management
Service Adapter Layer
Directory
Directory
Repository
Repository
Authentication
Authentication
Assignment
Assignment
Job
Job
Manager
Manager
Conversion
Conversion Service
Service
ConversionService
Service
Conversion
Connector
Connector
Document
DocumentSession
Session
Management
Management
Spell Checker
Core Logic
Push
Push
RESTFul Service Processor
Session State Engine
Conversion Bundles
Convert
Convert
Oracle
Oracle
Outside
OutsideInIn
Symphony
Symphony
ODF
ODFToolkit
Toolkit
OSGi
OSGiFramework
Framework
Open
Open
Save
Save
Upload
Upload
WALTZ
WALTZ
Autosave
Autosave
Metadata
Metadata
Docs
Docs
extension
extension
Database
Storage
Directory
iNotes
Files
Collaboration Applications
9
Docs
Docs
extension
extension
Communities
High Level Architecture -- Collaboration Applications

IBM Docs is an extension to Connections
–
Implemented using Connections UI extension capabilities
–
New buttons and links in Connections Files and Communities pages
–
–
10
Allows user to create, view and edit documents.
Integrates with an existing Files repository
●
Connections Files at this time
●
Intend to support FileNet through CCM in a future release
High level Architecture – Document Service


11
WebSphere based enterprise application
Provides core logic for processing of the documents
–
Communicates with Connections file repository to get uploaded documents
–
Manages drafts in the storage area
●
Drafts refer to internal format and storage used during edit sessions for existing docs.
●
Used by conversion, document and viewer services
–
Provides co-editing capabilities
●
Uses rtc4web technology to push messages from server to clients
●
Utilizes Operational Transformation (OT) engine to solve confilicts if editing same document to
merge messages.
–
Utilizes DB to store metadata
●
Used for document, user and for session affinity
●
Not heavy usage of DB.
–
Utilizes Directory service
●
Uses WALTZ to communicate with Directory Service
●
Uses profile information in DS for showing users in editing sessions
●
Doesn't need more than what is currently used by Connections.
High level Architecture – Conversion Service
WebSphere based enterprise application
Converts various supported file types
– Provides HTTP based RESTful APIs to provide conversion services
– Converts MS and ODF formats for documents, presentations, spreadsheets to internal
HTML/JSON/CSS formats used by IBM Docs editors
●
Uses Symphony binaries for conversion of MS binary formats
●
Uses Conversion Engine for conversion of OOXML formats
●
Uses ODF toolkit for conversion of ODF formats
●
Uses Oracle Outside-in for viewing


12
IBM Docs – Conversion Service
Current
Upcoming...
Conversion
Conversion Service
Service
OOXML
OOXML
Conversion Bundles
MS
binary
Conversion
Conversion
Engine
Engine
ODF
Symphony
Symphony
ODF
HTML
JSON
Java
Java
Converter
Converter
MS
binary
Oracle
Oracle
Outside-In
Outside-In
PDF
OSGi
OSGiFramework
Framework
HTML
JSON
V1.0.5
13
Replace image based view with html based viewer
●
Content can be accessible
●
Improve fidelity
● Introduced a new conversion engine to better support
OOXML formats
●
Improve fidelity
●
Current support in V1.0.5 for export of OOXML file
types (pptx, xlsx)
●
Intend to support Docx export in future release
●
Reusable by mobile offline
●
IBM Docs – Conversion Service con't
For IBM Docs V1.0.5
–
Support export of MS OOXML formats
●
pptx, xlsx is supported in V1.0.5
●
Intend to support docx in future release due to paginated editor features requirements
–
Provide new conversion engine focusing on OOXML import/export
●
Functionality issues with OOXML
●
Will improve performance and fidelity
●
Reusable component within IBM Docs (ex. Mobile offline capabilities)
14
High Level Architecture – Viewer (Rendition Manager)
Rendition
Rendition Manager
Manager
Document
Document
Services
Services
Cache
Cache
Management
Management
Job
Job
Manager
Manager
Temp
TempStorage
Storage
Management
Management
Service Adapter Layer
Repository
Repository
Authentication
Authentication
Assignment
Assignment
Conversion Bundles
Oracle
Oracle
Outside
OutsideIn
In
Convert
Convert
ODF
ODFToolkit
Toolkit
Viewer
Viewer
Client
Client
OSGi
OSGiFramework
Framework
Viewer
Viewer
extension
extension
Directory
iNotes
Files
Collaboration Applications
15
Symphony
Symphony
EJB
EJB
Upload
Upload
WALTZ
WALTZ
Caching
Caching
Storage
Directory
Directory
Conversion
Conversion Service
Service
ConversionService
Service
Conversion
Connector
Connector
RESTFul Service Processor
Core Logic
Viewer
Viewer
extension
extension
Communities
High level Architecture – Viewer con't



16
Extension to Connections using Connections UI Extension capabilities
–
Also known as Rendition Manager
–
Provides ability to view latest published version of document
–
Shown as View button/link in Connections Files and Communities
WebSphere based enterprise application
–
Shares drafts and Conversion service with Docs service
Currently shipped with IBM Docs
–
Also included in the IBM Collaboration Solutions Catalog
IBM Docs – Mobile Architecture
17
IBM Docs – Mobile Architecture con't


18
IBM Docs V1.0.5 can be used through multiple devices
–
1.0.5 On-premise and SmartCloud
●
IPad using Connections Mobile App from Apple store
●
iOS6+ support
–
Intend to support Android devices in future release through Android App from Google Play store
Utilize hybrid model to provide mobile capabilities
–
Minimizes development
–
Quicker to market with features
–
Done utilizing native code and native support within iPad OS
●
UIWebview provides embedded browser and internal javascript engine
●
Provides consistent iPad look and feel
IBM Docs
Planning, Management and Maintenance
19
Techline Sizing Process for IBM Docs
●
●
20
Reminders
● Conversion server must run on Windows
● Viewer can run on Linux or Windows
● Remainder of components supported on Linux only
● Review the current releases detailed system requirements at:
http://www.ibm.com/support/docview.wss?uid=swg27036813
Process
● Techline is set up to prepare a sizing for IBM Docs.
● Questionaire must be completed by the customer
● Report will be sent.
IBM Docs High Level Capacity Info
What's needed for a small sizing
●
IBM Docs can support 800 concurrent users on a 8 core Environment.
●
●
●
●
●
●
●
21
4cores 8GB Conversion server
1core 8GB Document Server
1core 8GB DB2 Server
1core 8GB Proxy server
1core 2GB HTTP server.
Assumption: 15% of concurrent user are editing. 65% cache hit rate and the server
hardware is reasonably current.
Note: In a production environment avoid single core servers.
IBM Docs High Level Capacity Info
●
What's needed for a larger sizing (without HA)
●
The capacity baseline of 5000 concurrent users has been verified in the lab
●
●
●
●
●
●
22
6 Conversion servers (4cores 8GB)
2 Document servers (4cores 8GB)
1 DB2 server (4cores 32GB)
1 proxy server (2cores 8GB)
1 HTTP server (2cores 4GB)
IBM Docs should be able to support up to 10,000 concurrent users with more hardware
resource (in almost linear relationship)
IBM Docs – Capacity Limitations and Key Points
●
To support high capacity, conversion server should be deployed on a virtualized
environment.
●
●
23
Note: Conversion Server scales better horizontally than vertically
● The recommend CPU cores per VM is 4.
● Performance testing was run in a virtualized environment.
To support high capacity, fast data transfer rates between the conversion server and NFS
server are necessary.
● In general, with 1Gbps switch network, the NFS server should be able to support an 80MB
per second data transfer rate. Lower than 30MB per second data transfer rate will impact
capacity and response times.
IBM Docs – Capacity Limitations and Key Points con't
●
●
●
24
IBM Docs will occupy considerable storage space on the NFS server.
● On average, one document needs about 6MB for draft storage.
In Production Environment
● Consider HA for all components
IBM Docs will be deployed with IBM Connections.
● IBM Docs may increase the Files adoption and bring additional overhead.
Example Techline Sizing Results
25
IBM Docs – Client requirements



26
IBM Docs is web-based and supports mobile devices via mobile app.
Browser support
–
1.0.5
●
Firefox 9, ESR 10, 11, 12, 13, 14, 15, 16, ESR 17, 18, 19, 20, 21, 22, 23, 24, ESR24, 25
●
IE 9, 10
●
Chrome 24, 25, 26, 27, 28, 29, 30
●
Safari 5.1, 6.0
Mobile
–
1.0.5: iPad running iOS6+ with Connections Mobile App
–
Intend to support Android devices in a future release
IBM Docs – Server requirements


IBM Docs Components (Viewer, Docs, Conversion, Proxy, Extensions) required to be deployed in
same cell as Connections.
–
V1.0.3: WAS 7 (7.0.0.25) support only
–
V1.0.5: WAS 8 (8.0.0.6+) support only
Connections requirements
–
Depending on which Connections version is installed could dictate which IBM Docs version to
install.
–
1.0.3
●
Support Connections 4.0 CR2 or Connections 4.5
–
1.0.5
●
Support only Connections 4.5 (CR2+).
Note: If customer environment only has Connections 4.0 CR2, you will need to install IBM
Docs V1.0.3 and upgrade to V1.0.4 or V1.0.5 when Connections is upgraded to V4.5.
27
IBM Docs – Server requirements con't

28
IBM Docs non-specific prerequisite components
–
NFS/NAS
●
Shared storage used between Docs, Conversion and Viewer services.
●
Must be an NFSv3 server whether it be a NAS or separate server.
●
Minimum throughput requirements for IBM Docs available.
–
Directory Service
●
Docs doesn't need anything above what Connections uses
●
Tivoli Directory Server 6.2
●
MS Active Directory 2008 R2
–
Database
●
V1.0.3: DB2 9.7
●
V1.0.5: DB2 10.1, Oracle 11g Release 2
●
Database can be shared with Connections
IBM Docs – Server requirements con't




29
Conversion service
–
Requires Windows 2008 R2
Docs service
–
V1.0.3: RHEL 5 (5.7+)
–
V1.0.5: RHEL 5 (5.9+), RHEL 6 (6.4+), SLES 11 (SP3+)
Viewer service (Rendition manager)
–
V1.0.3: RHEL 5 (5.7+)
–
V1.0.5: RHEL 5 (5.9+), RHEL 6 (6.4+), SLES 11 (SP3+), Windows
●
Can be installed from Dmgr in V1.0.5
Docs and Viewer extensions and daemons
–
Deployed on Connections node
Performance Tuning





30
JVMs are tuned during application deployment (Heap, etc)
# Nodes in cluster
–
Deploy another using install_node.sh
# Symphony Instances
–
No > #cores * 2
–
Process to add additional is in the Installation Guide
# Oracle Outside-In Instances
–
Process to add additional is in the Installation Guide
# Co-editors
–
5 is the supported value and what UX suggests as well as what our Performance numbers
assume. Modify (with permission) in <DOCS_INSTALL_DIR>/config/concord-config.json
"max-users-per-session" : "5",
Performance Tuning – Continued

Housekeeping settings
–
Modify in <DOCS_INSTALL_DIR>/config/concord-config.json
"House_Keeping" :
{
"frequency" : "weekly",
"age_threshold_of_draft_per_org" : "90",
"size_threshold_of_draft_per_org" : "0.9",
"age_threshold_of_rendition_cache_per_org" : "90",
"size_threshold_of_rendition_cache_per_org" : "0.9"
},

Conversion tweaks
–
Modify (with permission) in <CONVERSION_INSTALL_DIR>/config/conversion-config.json
"document": {
"max-page-count":150,
"max-pure-text-size":768
},
"spreadSheet":{
"max-sheet-rows":5000,
"cell-max-num":200000,
"formula-cell-max-num":20000
},
"presentation":{
"max-pages": 75,
"max-graphics": 1500,
"encode-graphics": true,
"encode-threshold-graphics": 2048
},
31
Performance Tuning – Continued



32
Maximum number of File Descriptors (system and JVM)
–
Set sysctl.conf property
●
fs.file-max = 753000
●
sysctl -p
–
Update websphere to increase the allowed max file descriptors
●
WAS_ROOT/WebSphere/AppServer/profiles/AppSrv01/bin/setupCmdLine.sh
●
Uncomment/update the line 'ulimit -n 65536'
●
Restart the Node Agent and Server.
Maximium number of File Descriptors per user
–
Update limit.conf file
●
Set soft and hard ulimit values to 65536 (ensure less then fs.file-max)
Server reached MaxClient Setting (IBM HTTP Server)
–
Technote with instructions
IBM Docs Release Install Process
Prereqs

IBM Connections

WebSphere Application Server (Windows/Linux)

Database

NFS
Obtain the IBM Docs install packages and unzip in the desired locations.
For Docs, a database instance will need to be created:

./createDB.sh

./updateDBSchema.sh
For each IBM Docs component:

Modify cfg.properties for your environment

Run the install script
–
./install.sh
For each additional Docs and Conversion node (clustered environment):

Copy cfg.properties from first node to cfg.node.properties on node N

Run the install script for each subsequent node
–
./install_node.sh
Post install steps
●
Update plugin-cfg.xml
●
Map webserver
●
Others
33
Maintenance – iFix Process


34
Fixes not likely due to frequency of releases
Fix Central - www.ibm.com/support/fixcentral
–
Product Group: Lotus
–
Select from Lotus: Docs
–
Installed Version: 1.0.5
–
Platform: All
–
Release notes will include installation instructions
Maintenance - Release Upgrade Process
For the database component:

./updateDBSchema.sh
For each additional component:

Review the new version of cfg.properties for new/updated properties

Update previous install <INSTALL_DIR>/cfg.properties (or cfg.node.properties as appropriate) with any
changes

Run the upgrade script
–
./upgrade.sh -installRoot <INSTALL_DIR>
For each additional Docs and Conversion node (clustered environment):

Copy cfg.properties from first node to cfg.node.properties on node N

Run the upgrade script for each subsequent node
–
./upgrade_node.sh
Documents are migrated (if necessary) during first touch.
35
Troubleshooting




36
All components log to the JVM SystemOut.log
–
WAS Console allows setting down to component level, the detail level desired.
●
com.ibm.concord.viewer is for Viewer logging
●
com.ibm.concord.* is for Docs Server logging
●
com.ibm.rtc.* is for rtc4web logging
●
com.ibm.conversion.* is for Conversion Server logging
●
com.ibm.concord.* is for Docs Proxy logging
–
Detailed tracing logged to trace.log
Routing and availability can be tested with:
–
https://<ihshostname>/<component>/version.txt
(where component is docs, conversion, or viewer)
–
For example https://renovations.com/conversion/version.txt
Use test cases from IBM Docs Deployment Guide
Review support pages:
–
http://www.ibm.com/support/entry/portal/overview/software/lotus/ibm_docs
Frequent Reported Problems – NFS access issues (in log)




37
Match the UID used for the Docs WAS instance
Specify owner and authorities correctly
Set Registry Entries correctly
IBMConversion mounts the shares at startup, the other components must be mounted manually, via fstab,
etc.
Frequent Reported Problems – Buttons don't show up





38
Docs Servers must be active
Connections modifications have to have been done (correctly)
Applications must be mapped to the web server(s)
Routing must be correct in IHS (manual additions for Docs Proxy)
Connections Clusters must have been restarted (Files, Infra, Common)
Frequent Reported Problems – Create works, but not Publish



39
Conversion must be active
Docs must be able to reach Conversion
–
Internal routing (concord-config.json), firewalls
Docs must be able to reach back to Files
–
Internal routing (concord-config.json), firewalls,
–
Files app-connector and admin roles
com.ibm.concord.job.exception.JobExecutionException:
com.ibm.concord.spi.exception.RepositoryAccessException
Frequent Reported Problems – Publish performance is poor




40
NFS access speeds not being met
NETBIOS still enabled?
Antivirus running on network drives?
Enough Symphony Instances?
Frequent Reported Problems – Co-Edit Issues/Delays


41
Overwrite of plugin-cfg.xml changes
–
Left as automatic regeneration and propogation
–
Normal admin practice to regen and propogate after updates
WebChat and Docs rtc4web collisions
IBM Docs
Deployment Models and Work Flows
42
IBM Docs – Deployment models


43
Small Simple deployment
–
Typical deployment for PoC
–
Minimal servers
–
Doesn't provide any HA capabilities
Medium and Large deployment
–
Standard deployment for test and production environments
–
Utilizes WebSphere clusters for Docs, Conversion, Viewer, and Docs Proxy
●
Provides HA
●
Ability to scale to size needed
IBM Docs – Small, Simple PoC Type Deployment
Connections Server
EJB
Files
Docs
Extensions
Upload
Event
Viewer
Extensions
Inbound HTTP/S
HTTP
JDBC
HTTP/S
NFS
WALTZ
Implementation
specific
Upload
Event
Viewer
Daemon
Docs
Daemon
Database
Client
Directory
Service
IBM HTTP
Server
Conversion Server
Conversion
(WAS)
NAS/NFS
Docs/Viewer Server
Docs
(WAS)
File Viewer
Managed Cell
44
Deployment Manager
IBM Docs – Convert on Upload
Upload Flow
1. User connects to Files Connections URL
2. If not authenticated, Websphere shows Docs or Connections login and authenticates user with directory
service (eg. LDAP, AD, TDS)
3. LTPA token/J2EE principal added to browser cookies
4. User clicks Upload File and select file to upload to Connections Files
5. File upload completes and upload event is sent
6. Event triggers Docs and Viewer daemons
7. Deamons call Docs service
8. Docs service goes to Connections File repository and gets the file
9. Docs service creates a draft folder on NFS server
10. Docs service copies the document from Connections File repository to draft folder
11. Docs service invokes Conversion service.
12. Docs service returns control back to Daemon
13. (In separate process)
1. Conversion service converts from current format to requested format (HTML/CSS for editors)
2. Conversion service stores converted results back on NFS server.
45
IBM Docs – Small, Simple PoC Type Edit Flow
Edit Flow
1. User connects to Files Connections URL
2. If not authenticated, Websphere shows Docs or Connections login and authenticates user with directory
service (eg. LDAP, AD, TDS)
3. LTPA token/J2EE principal added to browser cookies
4. User clicks Edit of File
5. Docs Extension returns /docs URL
6. Browser opens new window/tab with URL to Docs Editor
a) Document converted through Conversion service (if not already converted)
b) Displayed in browser
7. User makes changes to document
a) Messages sent to Docs server to update the draft (and Co-editors if necessary)
8. User publishes the document
a) Message sent to Docs server to publish the draft
b) Docs server calls conversion server to export the HTML to correct document format
c) Conversion server stores the result of the publish to NFS
d) Docs server retrieves the result of the publish from NFS
e) Docs server calls Connections to store the new version
46
IBM Docs – Small, Simple PoC View Flow
View Flow
1. User connects to Files Connections URL
2. If not authenticated, Websphere shows Docs or Connections login and authenticates user with directory
service (eg. LDAP, AD, TDS)
3. LTPA Token/J2EE principal added to browser cookies
4. User clicks View of File
5. Viewer Extension returns /viewer URL
6. Browser opens new window/tab with URL to Viewer
a) Document converted to MS Office format by Conversion service (if not already converted)
b) Document converted to images for view (if not already converted)
c) Displayed in browser
47
Inbound HTTP/S
HTTP
JDBC
HTTP/S
IBM Docs – Medium and Large Deployment
NFS
WALTZ
Implementation
specific
Connections Cluster
Connections Server
Files
Docs
Extensions
Upload
Event
Viewer
Extensions
Upload
Event
Docs
Daemon
Viewer
Daemon
EJB
Database
DB2/HA
Viewer Cluster
Docs
Viewer
Server
(WAS)
(WAS)
Client
IBM HTTP Server
Proxy Cluster
Proxy
Docs
Server
(WAS)
(WAS)
Docs Cluster
Docs
Docs Server
(WAS)
(WAS)
Conversion Cluster
Docs
Conversoin
Server
(WAS)
(WAS)
Managed Cell
48
Deployment Manager
Directory
Service w/
HA
NAS/NFS
w/HA
Docs Proxy



49
Built upon a WebSphere proxy server
Provides Document Affinity
Provides compression for static files
Document Affinity
Client
User
1
IHS
/docs A
Any Proxy
/docs A
Docs DB
Docs
Session cookie?
no
AnyDocs
Session cookie?
no
Existing edit session?
no
Create Session Entry
Server Docs1
Document A
New Session cookie
Session cookie?
yes
User
2
/docs A
/docs A
Docs1 (from cookie)
Session cookie?
no
AnyDocs
Session cookie?
no
Existing edit session?
yes Retrieve Session Entry
Server Docs1
Document A
New Session cookie
50
IBM Docs – Scalable Deployment Flow
Edit Flow
1. User connects to Files Connections URL
2. If not authenticated, Websphere shows Docs or Connections login and authenticates user with directory
service (eg. LDAP, AD, TDS)
3. LTPA token/J2EE principal added to browser cookies
4. User clicks Edit of File
5. Docs Extension returns /docs URL
6. URL directs /docs to docs proxy who routes to appropriate docs instance to enable co-editing
7. Browser opens new window/tab with URL to Docs Editor
a) Document converted through Conversion service (if not already converted)
b) Displayed in browser
8. User makes changes to document
a) Messages sent to Docs server to update the draft (and Co-editors if necessary)
9. User publishes the document
a) Message sent to Docs server to publish the draft
b) Docs server calls conversion server to export the HTML to correct document format
c) Conversion server stores the result of the publish to NFS
d) Docs server retrieves the result of the publish from NFS
e) Docs server calls Connections to store the new version
51
IBM Docs – High Availability/Load Balancing Design
IBM Docs Components
1. Docs Proxy
●
WebSphere Cluster HA
2. Docs
●
Client detects outage, restarts document affinity flows
3. Conversion
●
WebSphere Cluster HA (but requires user action for resubmission)
4. Viewer
●
WebSphere Cluster HA (Viewer client automatically resubmits if failure detected)
Non IBM Docs Specific Components
NFS (suggest NAS with 3rd Party HA implementation)
Database (DB2/HA)
IHS (merged routing tables) – front end reverse proxy (such as WebSeal)
Connections (WebSphere Cluster HA)
LDAP (HA configuration)
52
Docs Node Failure
Client
User
1
IHS
/docs A
Any Proxy
/docs A
Docs DB
Docs
Session cookie?
no
AnyDocs
Session cookie?
no
Existing edit session?
no
Create Session Entry
Server Docs1
Document A
New Session cookie
Session cookie?
yes
Docs1 (from cookie)
Failure indication (503) or Heartbeat detects outage
Clear Session cookie
Server Docs1 fails
Session cookie?
no
AnyDocs
Session cookie?
no
Existing edit session?
On Docs2? yes/
no
Update Session Entry
Server Docs2
Document A
New Session cookie
53
2014 Themes - IBM Docs and SmartCloud
Docs
“Delivering full collaboration on informal
documents”
Core Editing
Business As Usual
One
person edits
everyone else
watches
Project
management
stops at the
document editor
Focus on basic user
scenario, then advanced
user scenario
§



Conversations
are
asynchronous to
the file editor

Teams
must
coordinate files
edited offline
.docx support, and new
Document editor supported
by layout engine,
pagination.
Enrich Spreadsheet with
more features for basic
and advanced users
Continue to refractor
Presentation editor to build
a strong foundation, adding
strong shape support.
Files experience
improvement on draft and
version

HTML based viewers

Upload New Version
Users
must
download to find
what they're looking
for
Mobile
Collaborative editing online
or offline
Reduce manual efforts to
enable focus on content
editing
Offline edit

Section assignments
Presentation edit


Sametime Chat and Meetings
integration
Spreadsheet edit


Change tracking

Revision management
Integration

Foundation
Enable content editing in
business context
CCM/ECM integration

Public API to enable 3rd party
integrators
Quality improvements

BIDI compliance

Increased scalability




Public API to allow 3rd party
plugins
Embedded viewer in Connections
Web font

ud
Q3 roll-up
Teams
edit files within
Sametime Meetings
Light-weight
workflow ensures
everyone knows their
assignment
Instantly
communicate within
the file editor
Team
FileSync makes
certain everyone has
the latest version anywhere
are view and
files within
Connections using
embedded viewers
SmartCloud –Agile Release Cycle
miseQ2 roll-up
e
r
P
On
Social Business
Users
NFR updates

o
rtCl
a
m
S
54
Social
Collaboration
Q4 roll-up
IBM Docs References



55
IBM Docs Wiki (Install and User Guides, System Requirements, etc)
–
www.lotus.com/ldd/docswiki.nsf
IBM SmartCloud Docs (has trials available)
–
www.ibm.com/cloud-computing/social/us/en/ibmdocs/
IBM Greenhouse Docs (on-premise type deployment)
–
greenhouse.lotus.com
Engage Online

SocialBiz User Group socialbizug.org
– Join the epicenter of Notes and Collaboration user groups

Follow us on Twitter
– @IBMDocs, @IBMConnect, and @IBMSocialBiz

LinkedIn http://bit.ly/SBComm
– Participate in the IBM Social Business group on LinkedIn:

Facebook https://www.facebook.com/IBMSocialBiz
– Like IBM Social Business on Facebook

Social Business Insights blog ibm.com/blogs/socialbusiness
– Read and engage with our bloggers

DeveloperWorks www.ibm.com/developerworks
– IBM Docs community
56
Acknowledgements and Disclaimers
Availability. References in this presentation to IBM products, programs, or services do not imply that they will be available in all countries in which IBM operates.
The workshops, sessions and materials have been prepared by IBM or the session speakers and reflect their own views. They are provided for informational purposes only, and
are neither intended to, nor shall have the effect of being, legal or other guidance or advice to any participant. While efforts were made to verify the completeness and accuracy of
the information contained in this presentation, it is provided AS-IS without warranty of any kind, express or implied. IBM shall not be responsible for any damages arising out of the
use of, or otherwise related to, this presentation or any other materials. Nothing contained in this presentation is intended to, nor shall have the effect of, creating any warranties or
representations from IBM or its suppliers or licensors, or altering the terms and conditions of the applicable license agreement governing the use of IBM software.
All customer examples described are presented as illustrations of how those customers have used IBM products and the results they may have achieved. Actual environmental
costs and performance characteristics may vary by customer. Nothing contained in these materials is intended to, nor shall have the effect of, stating or implying that any activities
undertaken by you will result in any specific sales, revenue growth or other results.
© Copyright IBM Corporation 2014. All rights reserved.
 U.S. Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
 IBM, the IBM logo, ibm.com, Lotus and IBM Docs are trademarks or registered trademarks of International Business Machines Corporation in the United States, other countries, or both. If these and other IBM
trademarked terms are marked on their first occurrence in this information with a trademark symbol (® or ™), these symbols indicate U.S. registered or common law trademarks owned by IBM at the time this
information was published. Such trademarks may also be registered or common law trademarks in other countries. A current list of IBM trademarks is available on the Web at “Copyright and trademark information” at
www.ibm.com/legal/copytrade.shtml
 The information contained in this publication is provided for informational purposes only. While efforts were made to verify the completeness and accuracy of the information contained in this publication, it is provided AS
IS without warranty of any kind, express or implied. In addition, this information is based on IBM’s current product plans and strategy, which are subject to change by IBM without notice. IBM shall not be responsible for
any damages arising out of the use of, or otherwise related to, this publication or any other materials. Nothing contained in this publication is intended to, nor shall have the effect of, creating any warranties or
representations from IBM or its suppliers or licensors, or altering the terms and conditions of the applicable license agreement governing the use of IBM software.
 References in this presentation to IBM products, programs, or services do not imply that they will be available in all countries in which IBM operates. Product release dates and/or capabilities referenced in this
presentation may change at any time at IBM’s sole discretion based on market opportunities or other factors, and are not intended to be a commitment to future product or feature availability in any way. Nothing
contained in these materials is intended to, nor shall have the effect of, stating or implying that any activities undertaken by you will result in any specific sales, revenue growth or other results.
 Performance is based on measurements and projections using standard IBM benchmarks in a controlled environment. The actual throughput or performance that any user will experience will vary depending upon many
factors, including considerations such as the amount of multiprogramming in the user's job stream, the I/O configuration, the storage configuration, and the workload processed. Therefore, no assurance can be given
that an individual user will achieve results similar to those stated here.
 All customer examples described are presented as illustrations of how those customers have used IBM products and the results they may have achieved. Actual environmental costs and performance characteristics
may vary by customer.
Adobe, the Adobe logo, PostScript, and the PostScript logo are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States, and/or other countries.
Java and all Java-based trademarks are trademarks of Sun Microsystems, Inc. in the United States, other countries, or both.
Microsoft and Windows are trademarks of Microsoft Corporation in the United States, other countries, or both.
Intel, Intel Centrino, Celeron, Intel Xeon, Intel SpeedStep, Itanium, and Pentium are trademarks or registered trademarks of Intel Corporation or its subsidiaries in the United States and other countries.
UNIX is a registered trademark of The Open Group in the United States and other countries.
Linux is a registered trademark of Linus Torvalds in the United States, other countries, or both. Other company, product, or service names may be trademarks or service marks of others.
All references to Renovations Corporation refer to a fictitious company and are used for illustration purposes only.
Other company, product, or service names may be trademarks or service marks of others.
57