IBM Docs Lab - · PDF file© 2014 IBM Corporation Page 3 IBM Docs Architecture and Lab Setup IBM Docs – Components • Docs Service • Provides core logic for processing of documents

© 2014 IBM Corporation Page 1

IBM Collaboration Solutions – IBM Docs Technical Workshop

IBM Docs Lab Speaker:


Agenda Day 1

09:30 - 10:00 - Introduction and Overview 10:00 - 10:30 - What's new with IBM SmartCloud 10:30 - 10:45 - BREAK 10:45 - 12:00 - Introduction to IBM Docs 12:00 - 13:00 - LUNCH 13:00 - 13:45 - Details of the Lab Setup and Architecture 13:45 - 17:00 - Docs LAB - How to build a PoC / Test environment


IBM Docs Architecture and Lab Setup IBM Docs – Components •  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


Files

EJB

Docs (WAS)

Conversion (WAS)

Connections Server

File Viewer

Docs Extensions

Docs Daemon

Upload Event

HTTP/S JDBC

Inbound HTTP/S

Client IBM HTTP Server

Conversion Server

Docs/Viewer Server

Database

Directory Service

NAS/NFS

Managed Cell Deployment Manager

NFS

Implementation specific

WALTZ

HTTP

Viewer Daemon

Viewer Extensions

Upload Event

IBM Docs – Small, Simple PoC Type Deployment


IBM Docs Architecture and Lab Setup Convert on 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. Daemons 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.


IBM Docs Architecture and Lab Setup Edit Flow 1. User connects to Files Connections URL 2. If not authenticated, WebSphere shows 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


IBM Docs Architecture and Lab Setup View Flow 1. User connects to Files Connections URL 2. If not authenticated, WebSphere shows 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


EJB

Connections Cluster

Docs Daemon

Upload Event

Client IBM HTTP Server

Database DB2/HA

Directory Service w/

HA

NAS/NFS w/HA

Managed Cell Deployment Manager

Docs (WAS)

Viewer Server (WAS)

Viewer Cluster

Docs (WAS) Docs Server

(WAS)

Docs Cluster

Docs (WAS)

Conversoin

Server (WAS)

Conversion Cluster

Docs (WAS)

Proxy Server (WAS)

Proxy Cluster

Files Docs

Extensions Viewer

Extensions

Viewer Daemon

Connections Server

HTTP/S JDBC

Inbound HTTP/S

NFS

Implementation specific

WALTZ

HTTP

Upload Event

IBM Docs – Medium and Large Deployment


IBM Docs Architecture and Lab Setup Docs Proxy

•  Built upon a WebSphere proxy server •  Provides Document Affinity •  Provides compression for static files


IBM Docs Architecture and Lab Setup 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


IBM Docs Architecture and Lab Setup Shared folders in IBM Docs

DocsShare

ViewerShare

IBM Docs

IBM Docs Conversion

IBM Docs Viewer

IBM Connections File

Share


IBM Docs Architecture and Lab Setup ●  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


IBM Docs Architecture and Lab Setup •  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 2008 R2

•  Can be installed from DMGR in V1.0.5 •  Docs and Viewer extensions and daemons

•  Deployed on Connections node (from DMGR)


IBM Docs Architecture and Lab Setup •  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 IBM Connections 4.0 CR2 •  1.0.5

•  Support for IBM Connections 4.5 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.


IBM Docs Architecture and Lab Setup •  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

–  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 Architecture and Lab Setup •  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


Regular (high level) installation 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

IBM Docs Architecture and Lab Setup


Regular (high level) installation process:

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



Maintenance – iFix Process

•  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.




•  VMWare 10 or Fusion 6 is needed •  Windows 2008 Enterprise Edition 64Bit •  4 cores assigned •  12012 MB RAM assigned (more is better!)

•  Server Name: docs.ibmconnections.com

•  Installed Software: •  Domino 9 (Mail / Notifications & LDAP) •  Notes and Notes Administrator Client 9 •  WebSphere 8.0.0.5 •  IBM Connections CCM 4.5 CR4

Our demo environment is NOT offically supported, except for PoCs, since it it Windows only!


IBM Docs Architecture and Lab Setup •  Users:

•  Windows Admin: •  Administrator / Passw0rd

•  WAS Admin:

•  wasadmin / Passw0rd

•  Domino Admin: •  Administrator/ibmconnections / Passw0rd

•  Domino Certifier password: •  Passw0rd

•  HTTP Server Admin

•  wasadmin / Passw0rd

•  DB2 Admin: •  db2admin / Passw0rd •  lcuser / Passw0rd for Database access

•  Connections User: mgarden / Passw0rd


IBM Docs Architecture and Lab Setup •  Installation Paths:


IBM Docs Lab – Installing IBM Docs

Click on Administrator and login with the password „Passw0rd“


IBM Docs Lab – Installing IBM Docs In the lower left click on the Services icon.


IBM Docs Lab – Installing IBM Docs You will see that all Services, Domino, HTTP Server, WebSphere Deployment Manager as well as the Nodeagent including IBM Connections are already started.



In the first step we create the three clusters and cluster member to install IBM Docs in.


IBM Docs Lab – Installing IBM Docs Start Firefox


IBM Docs Lab – Installing IBM Docs Go to the WebSphere Integrated Solutions Console and log in with wasadmin and Passw0rd: https://docs.ibmconnections.com:9043/ibm/console/logon.jsp


IBM Docs Lab – Installing IBM Docs Click on Servers / Clusters / WebSphere application server clusters


IBM Docs Lab – Installing IBM Docs Click on „New...“


IBM Docs Lab – Installing IBM Docs Enter ConversionCluster as the Cluster name (or choose your own, but remember it, as you will need it later on). Then click „Next“.


IBM Docs Lab – Installing IBM Docs Enter ConversionMember1 as the Member name (or choose your own). If you have more than one node, then you could choose the one you want this member to be deployed in. Click „Next“.


IBM Docs Lab – Installing IBM Docs As we have only one node we do not need to create any additional cluster members. Click „Next“.


IBM Docs Lab – Installing IBM Docs Now you get a summary screen. Check the values for typing errors and then click „Finish“. Now the new Cluster is being created. Depending on the speed of the machine this may take some minutes.


IBM Docs Lab – Installing IBM Docs You do not need to click „Save“ now. Click on „New...“ instead, as we still need to create two more Clusters.


IBM Docs Lab – Installing IBM Docs Enter DocsCluster as the Cluster name (or choose your own, but remember it, as you will need it later on). Then click „Next“.


IBM Docs Lab – Installing IBM Docs Enter DocsMember1 as the Member name (or choose your own). Click „Next“.






IBM Docs Lab – Installing IBM Docs You do not need to click „Save“ now. Click on „New...“ instead, as we still need to create one more Cluster.


IBM Docs Lab – Installing IBM Docs Enter ViewerCluster as the Cluster name (or choose your own, but remember it, as you will need it later on). Then click „Next“.


IBM Docs Lab – Installing IBM Docs Enter ViewerMember1 as the Member name (or choose your own). Click „Next“.






IBM Docs Lab – Installing IBM Docs Now we click on „Save“ to save our changes and have them pushed down to the Nodes.


IBM Docs Lab – Installing IBM Docs Once the synchronization is complete for the cell, click „OK“.


IBM Docs Lab – Installing IBM Docs Select the three newly-created Clusters and click on „Start“.





Next we need to create the Database for IBM Docs. We will be installing the new database in the same instance that is already exisiting from the IBM Connections Installation.


IBM Docs Lab – Installing IBM Docs Open a Command Promt.


IBM Docs Lab – Installing IBM Docs Go to the folder: C:\Install\IBMDocs_R1051_FP\Docs\DocsApp\setupDB and start the DB2 command line environment with db2cmd .


IBM Docs Lab – Installing IBM Docs In the new windows run createDb.bat . Be patient, it will take a while until you see changes on the screen.


IBM Docs Lab – Installing IBM Docs Everything should be successfull:


IBM Docs Lab – Installing IBM Docs Next we need to run the updateDBSchema.bat file.


IBM Docs Lab – Installing IBM Docs You should not have seen any errors.


IBM Docs Lab – Installing IBM Docs We will be using the standard lcuser that is being used by Connections, too. To do so, we need to run a script, that grants the lcuser the necessary access rights to the IBM Docs database. Inside the folder you can find a file called appGrants.sql_huh. I have already changed it to the user lcuser (standard is docsuser). Rename that file to appGrantslcuser.sql.


IBM Docs Lab – Installing IBM Docs We now need to run that script with the following command: db2 -f appGrants.sql


IBM Docs Lab – Installing IBM Docs With this script having ran successfully we are done creating the IBM Docs database.


IBM Docs Lab – Installing IBM Docs Now we need to create two shared directories: DocsShare and ViewerShare . As we have only a single machine we just create the propper directory. In a multimachine environment we would need to set it up via NFS share. Open a file explorer and go to C:\IBM\Connections\data\shared to create these two folders:




IBM Docs Lab – Installing IBM Docs Now we need to edit the cfg.properties of the 5 features we are going to install: Conversion Server Docs Server Viewer Server Docs Extension Viewer Extension We will not be installing the Docs Proxy server, as the proxy servers only task is to ensure, that two users trying to edit a file will be routed to the same Docs instance. As we only have one, this functionality is not needed.


IBM Docs Lab – Installing IBM Docs In the File Explorer, go to C:\Install\IBMDocs_R1051_FP\Conversion\DocsConversion\installer to edit the settings for the Conversion Server.


IBM Docs Lab – Installing IBM Docs Fill out the fields fitting your environment. Please try to do it on your own and do not use the provided final files unless really needed. This editing process is currently the cause of most failures in installations and it is of importance to have understood what each section means. This can be achieved by reading and trying to understand it. ;)


IBM Docs Lab – Installing IBM Docs The same must be done for the cfg.properties in the following four remaining folders:

C:\Install\IBMDocs_R1051_FP\Docs\DocsApp\installer C:\Install\IBMDocs_R1051_FP\Docs\DocsLCExtension\installer C:\Install\IBMDocs_R1051_FP\Viewer\Viewer\installer C:\Install\IBMDocs_R1051_FP\Viewer\ViewerLCCustomizeApp\installer


IBM Docs Lab – Installing IBM Docs Conversion Example: # IBM Conversion section [Conversion] # conversion_install_root: # Specify the location where you want to install IBM Conversion service conversion_install_root=C:\IBM\IBMConversion # docs_shared_storage_type: # Specify the storage type which you want to share the conversion file with IBMDocs server. # If you install IBMDocs and IBMConversion server in one machine, you should specify this value as "local". # If you install IBMDocs and IBMConversions server on different machines and the remote shared directory is NFS, # you should specify this value as "nfs". docs_shared_storage_type=local # viewer_shared_storage_type: # Specify the storage type which you want to share the conversion file with IBMDocs Viewer server. # If you install IBMDocs Viewer and IBMConversion server in one machine, you should specify this value as "local". # If you install IBMDocs Viewer and IBMConversions server on different machines and the remote shared directory is NFS, # you should specify this value as "nfs". If you use CIFS as shared directory, you should specify this value as "cifs". # CIFS automation mount is not supported, you need to follow installation guide to mount this type of storage. viewer_shared_storage_type=local # docs_shared_storage_local_path: # The value can be a local directory or a local mount point for a shared remote directory, # which must point to the same directory specified by shared_data_dir in IBM Docs cfg.properties. # If the value is a local mount point on Windows, it must be a drive name (such as W:). docs_shared_storage_local_path=C:\IBM\Connections\data\shared\DocsShare # docs_shared_storage_remote_server: # The host name or IP address of the remote shared storage server for IBM Docs, # valid only when docs_shared_storage_local_path points to a driver-based path. docs_shared_storage_remote_server=nas-docs.ibm.com


IBM Docs Lab – Installing IBM Docs Conversion Example Part 2: # docs_shared_storage_remote_path: # The shared remote path on the shared storage server for IBM Docs, valid # only when docs_shared_storage_local_path points to a driver-based path. docs_shared_storage_remote_path=/opt/IBM/IBMDocs/data/shared # viewer_shared_storage_local_path: # The value can be a local directory or a local mount point for a shared remote directory, # and must point to the same directory specified by shared_data_dir in File Viewer cfg.properties. # If the value is a local mount point on Windows, it should be a drive name (such as Y:). viewer_shared_storage_local_path=C:\IBM\Connections\data\shared\ViewerShare # viewer_shared_storage_remote_server: # The host name or IP address of the remote shared storage server for File Viewer, # valid only when viewer_shared_storage_local_path points to a driver-based path. viewer_shared_storage_remote_server=nas-docs.ibm.com # viewer_shared_storage_remote_path: # The shared remote path on the shared storage server for File Viewer, valid # only when viewer_shared_storage_local_path points to a driver-based path. viewer_shared_storage_remote_path=/opt/IBM/IBMDocs/data/shared # was_install_root: # Specify the installation location of your WebSphere Application Server Network Deployment # on Linux, the default location is /opt/IBM/WebSphere/AppServer # on Windows, the default location is C:\Program Files\IBM\WebSphere\AppServer was_install_root=C:\IBM\WebSphere\AppServer # was_soap_port: # Specify the Deployment Manager SOAP port, default is 8879 was_soap_port=8879


IBM Docs Lab – Installing IBM Docs Conversion Example Part 3: # scope: # Specify the scope you want the application to be installed, the value can be: # Server: If you want the application to be installed on a single server # Cluster: If you want the application to a cluster scope=Cluster # scope_name: # If the scope=Cluster, specify the cluster name # If the scope=Server, specify the application server name # you also must specify node_name where the application server is on, if the scope is server scope_name=ConversionCluster # node_name: # If the scope=Server, this value must not be empty, must be the node name of the application server is on node_name= # sym_count: # number of symphony process instances # recommended value is equals to CPU core number of your machine or double # for example, the node has 4 CPU, each has 2 cores, the value can be set to 8 or 16 sym_count=4 # sym_start_port: # Specify the starting port number that symphony process can be listening on # if you have 2 symphony instance, starting port is 8100, then 8100, 8101 will be used sym_start_port=8100 # decide the software deployment mode, now supports only two options: SC (SmartCloud) and Premise (On-Premise), the default value is 'Premise' software_mode = Premise


IBM Docs Lab – Installing IBM Docs Docs Example: #IBM Docs section [Docs] # docs_install_root: # Specify the location where you want to install IBM Docs docs_install_root=c:\IBM\IBMDocs # shared_data_dir: # Location to the shared directory for data store. # For a networked, multi-node configuration, there must be a shared space between the nodes # that running IBM Docs and IBM Conversion applications. # This space is used as a data store for IBM Docs, and exchange conversion result with IBM Conversion. shared_data_dir=C:\IBM\Connections\data\shared\DocsShare # was_install_root: # Specify the installation location of your WebSphere Application Server Network Deployment # on Linux, the default location is /opt/IBM/WebSphere/AppServer # on Windows, the default location is C:\Program Files\IBM\WebSphere\AppServer was_install_root=C:\IBM\WebSphere\AppServer # was_soap_port: # Specify the Deployment Manager SOAP port, default is 8879 was_soap_port=8879 # scope: # Specify the scope you want the application to be installed, the value can be: # Server: If you want the application to be installed on a single server # Cluster: If you want the application to a cluster scope=Cluster


IBM Docs Lab – Installing IBM Docs Docs Example Part 2: # scope_name: # If the scope=Cluster, specify the cluster name # If the scope=Server, specify the application server name # you also must specify node_name where the application server is on, if the scope is server scope_name=DocsCluster # node_name: # If the scope=Server, this value must not be empty, must be the node name of the application server is on node_name= # Below is supported database product list # 1. db2 # 2. oracle db_type=db2 # db_hostname: # The machine hostname of the database server where you create IBM Docs database db_hostname=docs.ibmconnections.com # The port number of the database server that is serving access # for DB2, db_port is 50000 by default # for Oracle, db_port is 1521 by default db_port=50000 # The database name, default value is CONCORD for DB2, and idocs for Oracle, # if you set different name, please make sure you have created it with valid sql scripts db_name = CONCORD


IBM Docs Lab – Installing IBM Docs Docs Example Part 3: # db_jdbc_driver_path # the location of the DB2 or Oracle JDBC driver library, # for Oracle, it is ojdbc6.jar # for DB2, it is db2jcc.jar and db2jcc_license_cu.jar db_jdbc_driver_path=C:\IBM\SQLLIB\java # conversion_url: # The hostname, port and context path for IBM Conversion service # Input the host address of the load balancing server if the conversion service is clustered conversion_url=http://docs.ibmconnections.com/conversion # ic_admin_j2c_alias: # IBM Connections administrative user's J2C alias for IBM Docs # The J2C alias must exists in WebSphere Application Server deployment where IBM Docs is on # and, the administrative user this J2C alias represents to must already bind with security roles # that IBM Docs requires ic_admin_j2c_alias=connectionsAdmin # files_url: # The hostname, port and context path for IBM Connections Files application # Input the host address of the load balancing server if the Files application is clustered # Input the host name address of the webseal server when integrate with TAM without SPNEGO # Single sign-on requires that the browser pass LTPA cookies to WebSphere Application Server. # These cookies must contain the fully qualified host name, please use fully qualified host name in the url. files_url=http://docs.ibmconnections.com/files # email_url: # The hostname, port and context path for Email Notification service url # Input the host address of the load balancing server when the Connections application is clustered # Input the host name address of the webseal server when integrate with TAM without SPNEGO email_url=http://docs.ibmconnections.com/connections


IBM Docs Lab – Installing IBM Docs Docs Example Part 4: # auth_type: # The authentication type of Docs # Input the value as "TAM" when integrate with TAM without SPNEGO # Input the default "FORM" value for other cases # Input the value as "SAML" when setup SAML2.0 Single Sign On auth_type=FORM # auth_host: # The authentication server host of Docs # Input the host address of webseal when anth_type=TAM, the value can not be null in this case. # Input the host address of the load balancing server when the Connections application is clustered, the value can be null in this case. # When setup SAML2.0, Input the host address of the load balancing server when the Connections application is clustered, the value can be null in this case. auth_host=https://localhost # multitenancy enablement, false means installation to single tenant environment. mt=false # decide the software deployment mode, now supports only two options: SC (SmartCloud) and Premise (On-Premise), the default value is 'Premise' software_mode = Premise # spreadsheet_nodejs_install: # Switch on/off of whether or not to install NodeJS dedicated calculation server for spreadsheet. # Don't set to "true" in SC Feb release. spreadsheet_nodejs_install=


IBM Docs Lab – Installing IBM Docs Docs Extension Example: #IBM Docs extension plug-in for IBM Connections [ICExt] # extension install root # Specify the location where you want to install IBM Docs Extension ext_install_root=c:\IBM\IBMDocs\extension # was_dm_profile_root: # Specify the location of your WebSphere Application Server DeploymentManager profile # on Linux, the default location is /opt/IBM/WebSphere/AppServer/profiles/Dmgr01 # on Windows, the default location is C:\Program Files\IBM\WebSphere\AppServer\profiles\Dmgr01 was_dm_profile_root=C:\IBM\WebSphere\AppServer\profiles\Dmgr01 # was_soap_port: # Specify the Deployment Manager SOAP port, default is 8879 was_soap_port=8879 # ic_extension_path: # Location where IBM Connections extension installed to, Docs extension should installed on that path, # For default IBM Connections depolyment, the path may be /opt/IBM/LotusConnections/data/shared/provision/webresources, # For some deployment topologies, it should be a shared folder between WAS dmgr and each node with the same path, like # /mnt/nas//LotusConnections/data/shared/provision/webresources, # So be careful to set the right path depending on your actual environment. ic_extension_path=C:\IBM\Connections\data\shared\provision\webresources # deamon_shared_path: # You should set a path for Docs to install daemon files, # For default IBM Connections deployment, the path may be /opt/IBM/LotusConnections/data/shared, # For some deployment topologies, it should be a shared folder between WAS dmgr and each node with the same path, like /mnt/nas//LotusConnections/data, # So be careful to set the right path depending on your actual environment. deamon_shared_path=C:\IBM\Connections\data\shared\


IBM Docs Lab – Installing IBM Docs Docs Extension Example Part 2: # files_scope: # Specify the scope where Connections Files application installed to. # The IBM Docs extension plug-in need to be installed where Connections Files application is. # The value can be: # Server: If the Files application is installed on a single server # Cluster: If the Files application is installed on a cluster files_scope=Cluster # files_scope_name: # If the scope=Cluster, specify the cluster name # If the scope=Server, specify the application server name # you also must specify node_name where the application server is on, if the scope is server # you must specify where the Files application is on files_scope_name=Cluster2 # files_node_name: # If the scope=Server, this value must not be empty, must be the node name of the Files application is on files_node_name= # news_scope: # Specify the scope where Connections News application installed to. # The IBM Docs event handler need to be installed where Connections News application is. # The value can be: # Server: If the News application is installed on a single server # Cluster: If the News application is installed on a cluster news_scope=Cluster


IBM Docs Lab – Installing IBM Docs Docs Extension Example Part 3: # news_scope_name: # If the scope=Cluster, specify the cluster name # If the scope=Server, specify the application server name # you also must specify node_name where the application server is on, if the scope is server # you must specify where the News application is on news_scope_name=InfraCluster # news_node_name: # If the scope=Server, this value must not be empty, must be the node name of the News application is on news_node_name= # common_scope: # Specify the scope where Connections Common application installed to. # The value can be: # Server: If the Common application is installed on a single server # Cluster: If the Common application is installed on a cluster common_scope=Cluster # common_scope_name: # If the scope=Cluster, specify the cluster name # If the scope=Server, specify the application server name # you also must specify node_name where the application server is on, if the scope is server # you must specify where the Common application is on common_scope_name=InfraCluster # common_node_name: # If the scope=Server, this value must not be empty, must be the node name of the Common application is on common_node_name= # Specify the context path and host name for the events handler daemon thread to access IBM Docs application # Input the host address and port of the load balancing server if the IBM Docs application is clustered docs_server_url=http://docs.ibmconnections.com/docs


IBM Docs Lab – Installing IBM Docs Docs Extension Example Part 4: # ignore_event: # Specify whether handles events of Lotus Connections, if do not want to handle the events, the set ignore_event=true, otherwise set ignore_event=false ignore_event=false # auth_type: # The authentication type of IBM Docs # Input the value as "SAML" when enable SAML SSO # Input the default "BASIC" value for other cases auth_type=BASIC # docs_admin_j2c_alias: # Only needed when auth_type is "SAML". It is IBM Docs administrative user's J2C alias for IBM Connections, default as "docsAdmin". # If you need to change the default value, the new J2C alias must exists in WebSphere Application Server deployment where IBM Connections is on, # and the administrative user of this J2C alias represents to must already bind with security roles that IBM Connections requires. docs_admin_j2c_alias=connectionsAdmin # Specify the version of IBM Connections where you deploy IBM Docs extension plug-in, # Different version would apply related installation process, # WARNING: The version property must be one major_number.minor_number format, supported choice [3.0 , 3.5 , 3.6 , 4.0 , 4.5] ic_version = 4.5


IBM Docs Lab – Installing IBM Docs Viewer Example: # Only mandatory properties are required to change [Viewer] #### Mandatory Properties #### # Location to the shared directory for data store. # For a networked, multi-node configuration, there must be a shared space between the nodes # that running Viewer application and Conversion Server # This space is used as a data store for Viewer application, and exchange conversion result with IBM Conversion. shared_data_dir=C:\IBM\Connections\data\shared\ViewerShare # Specify the installation location of your WebSphere Application Server Network Deployment # on Linux, the default location is /opt/IBM/WebSphere/AppServer # on Windows, the default location is C:/Program Files/IBM/WebSphere/AppServer was_install_root=c:\IBM\WebSphere\AppServer # Specify the Deployment Manager SOAP port, default is 8879 was_soap_port=8879 # The hostname, port and context path for Conversion server # Input the host address of the load balancing server if the conversion service is clustered # To verify the URL, try use conversion_url/version.txt in the browser address bar, and see if there's a proper response conversion_url=http://docs.ibmconnections.com/conversion # "files_path" must be empty if Viewer application is installed on the same node as Connections # If Viewer application is installed on different nodes than Connections, # it should be the Viewer local path to access Connections' FILES_CONTENT_DIR which is a WAS variable that can be found on WAS admin console, Environment->WebShere variables files_path=C:\IBM\Connections\data\shared\files\upload


IBM Docs Lab – Installing IBM Docs Viewer Example Part 2: # If the environment also has IBM Docs, there's "Edit" button can be enabled on IBM File Viewer client, by which, the user can be navigated to the editor client. # Yes to enabled the button, No to hide editor_installed=Yes # scope: # Specify the scope you want the application to be installed, the value can be: # Server: If you want the application to be installed on a single server # Cluster: If you want the application to be installed on a cluster scope=Cluster # scope_name: # If the scope=Cluster, specify the cluster name # If the scope=Server, specify the application server name # you also must specify node_name where the application server is on, if the scope is server scope_name=ViewerCluster # node_name: # If the scope=Server, this value must not be empty, must be the node name of the application server is on node_name= # cache control setting, this is used for iNotes only.the value is "Yes" or "No" # If yes, we use 1 hour as the max-age value. browser_cache=No # print setting, this is used for iNotes only, the value is "Yes" or "No" enable_print=No # auth_type:The authentication type of Viewer application # Input the value as "TAM" when integrate with TAM without SPNEGO # Input the default "FORM" value for other cases auth_type=FORM


IBM Docs Lab – Installing IBM Docs Viewer Example Part 3: # auth_host:The authentication server host of Viewer application # Input the host address of webseal when anth_type=TAM, the value can not be null in this case. # Input the host address of the load balancing server when the Connections application is clustered, # the value can be null in this case. auth_host=https://localhost # multitenancy enablement, false means installation to single tenant environment. multi_tenancy=false #### Optional Properties #### # Specify the location where you want to install Viewer application # The default value is /opt/IBM/FileViewer on linux,and C:/IBM/FileViewer on windows. viewer_install_root= # Frequency to do house keeping # Settings can be now, hourly, daily, weekly and monthly, "weekly" days as default. housekeeping_frequency=weekly # Setting for how long to clean the old version of a document cache # "1" days as default. housekeeping_age_threshold_of_rendition_old_version=1 # Setting for how long to clean the latest version of a document cache # "30" days as default. housekeeping_age_threshold_of_rendition_latest_version=30 # Setting to trigger latest version cleaning # Settings is recommended to be any number between [64, ~], "256"GBs as default. housekeeping_size_threshold_of_rendition_cache=256


IBM Docs Lab – Installing IBM Docs Viewer Extension Example: #IBM Viewer extension plug-in for IBM Connections [ICExt] # Specify the location where you want to install File Viewer Extension ext_install_root=C:\IBM\FileViewer\Extension # Specify the location of your WebSphere Application Server DeploymentManager profile # on Linux, the default location is /opt/IBM/WebSphere/AppServer/profiles/Dmgr01 # on Windows, the default location is C:/Program Files/IBM/WebSphere/AppServer/profiles/Dmgr01 # Use "/" as the path separator was_dm_profile_root=C:\IBM\WebSphere\AppServer\profiles\Dmgr01 # Specify the Deployment Manager SOAP port, default is 8879 was_soap_port=8879 # To enable document conversion on files upload, set this value to Yes or No. enable_upload_conversion=Yes # auth_type: # The authentication type of File Viewer # Input the value as "SAML" when enable SAML SSO # Input the default "BASIC" value for other cases auth_type=BASIC # viewer_admin_j2c_alias: # Only needed when auth_type is "SAML". # File Viewer administrative user's J2C alias for IBM Connections, for example "viewerAdmin". # The J2C alias must exists in WebSphere Application Server deployment where IBM Connections is on # and, the administrative user of this J2C alias represents to must already bind with security roles # that IBM Connections requires viewer_admin_j2c_alias=connectionsAdmin


IBM Docs Lab – Installing IBM Docs Viewer Extension Example Part 2: # Specify the scope where Connections Files application installed to. # Viewer extension plug-in need to be installed where Connections Files application is. # The value can be: # Server: If the Files application is installed on a single server # Cluster: If the Files application is installed on a cluster files_scope=Cluster # If the scope=Cluster, specify the cluster name # If the scope=Server, specify the application server name # you also must specify node_name where the application server is on, if the scope is server # you must specify where the Files application is on files_scope_name=Cluster2 # If the scope=Server, this value must not be empty, must be the node name of the Files application is on files_node_name= # Specify the scope where Connections News application installed to. # The IBM Docs extension plug-in need to be installed where Connections News application is. # The value can be: # Server: If the News application is installed on a single server # Cluster: If the News application is installed on a cluster news_scope=Cluster # If the scope=Cluster, specify the cluster name # If the scope=Server, specify the application server name # you also must specify node_name where the application server is on, if the scope is server # you must specify where the News application is on news_scope_name=InfraCluster


IBM Docs Lab – Installing IBM Docs Viewer Extension Example Part 3: # If the scope=Server, this value must not be empty, must be the node name of the News application is on news_node_name= # common_scope: # Specify the scope where Connections Common application installed to. # The value can be: # Server: If the Common application is installed on a single server # Cluster: If the Common application is installed on a cluster common_scope=Cluster # common_scope_name: # If the scope=Cluster, specify the cluster name # If the scope=Server, specify the application server name # you also must specify node_name where the application server is on, if the scope is server # you must specify where the Common application is on common_scope_name=InfraCluster # common_node_name: # If the scope=Server, this value must not be empty, must be the node name of the Common application is on common_node_name= # Specify the context path and host name for the events handler daemon thread to access Viewer application # Input the host address and port of the load balancing server if the Viewer application is clustered viewer_server_url=http://docs.ibmconnections.com/viewer


IBM Docs Lab – Installing IBM Docs Now we can start installing IBM Docs! Open a command prompt and go to the following folder: C:\Install\IBMDocs_R1051_FP\Conversion\DocsConversion\installer and run install.bat .


IBM Docs Lab – Installing IBM Docs Type „a“ and hit Enter to accept the license agreement:


IBM Docs Lab – Installing IBM Docs Now enter the wasadmin and hit return to continue:


IBM Docs Lab – Installing IBM Docs Enter the password of the wasadmin: Passw0rd and hit enter.


IBM Docs Lab – Installing IBM Docs Now the installation of the Conversion Server will start. If anything goes wrong the installer will automatically roll back all changes and allow to restart once you have found and solved the issue.

You will see the message „ERROR: The process „soffice.bin“ not found twice. This is not an actual error. Before installing the soffice component the installer is checking, if it is already installed and running.


IBM Docs Lab – Installing IBM Docs While the installation is going on, you will see two or more blank windows popping up. These are the newly created conversion processes soffice.bin that are doing the conversion of ODF-Files and binary MS Office documents. You can ignore them, they will pop up periodically until later on, when we change these tasks to run hidden.


IBM Docs Lab – Installing IBM Docs The installation of the conversion server was successful:


IBM Docs Lab – Installing IBM Docs In the Docs server installation folder there is unfortunately the Python folder missing. This is due to the fact, that the IBM Docs component is not yet supported for Windows. We copy it from the Conversion server installation folder: C:\Install\IBMDocs_R1051_FP\Conversion\DocsConversion\installer\Python to C:\Install\IBMDocs_R1051_FP\Docs\DocsApp\installer


IBM Docs Lab – Installing IBM Docs Then we edit the install.bat in the following folder: C:\Install\IBMDocs_R1051_FP\Docs\DocsApp\installer


IBM Docs Lab – Installing IBM Docs In there we add the following line right underneath the copyright section: set path="./Python";%path%


IBM Docs Lab – Installing IBM Docs In the command line we now change to the following path: C:\Install\IBMDocs_R1051_FP\Docs\DocsApp\installer and start the install.bat there to install the IBM Docs server component.


IBM Docs Lab – Installing IBM Docs Now again type „a“ and hit return to accept the license terms.


IBM Docs Lab – Installing IBM Docs Enter the WAS Admin user account: wasadmin and hit Enter.


IBM Docs Lab – Installing IBM Docs Now enter the WAS Admin password: Passw0rd and hit Return to go on.


IBM Docs Lab – Installing IBM Docs Now we enter the DB2 user „lcuser“ and hit Return.


IBM Docs Lab – Installing IBM Docs The lcuser password required now is Passw0rd . Hit Enter to continue.


IBM Docs Lab – Installing IBM Docs The IBM Docs application is now being installed.


IBM Docs Lab – Installing IBM Docs The IBM Docs server has been installed successfully.


IBM Docs Lab – Installing IBM Docs Now we are going to install the IBM Docs extension. This part will install the necessary integration of the Docs application in IBM Connections, such as the „Create new..“ and „Edit in IBM Docs“ buttons. In the command line we now change to the following path: C:\Install\IBMDocs_R1051_FP\Docs\DocsLCExtension\installer and start the install.bat


IBM Docs Lab – Installing IBM Docs Again press „a“ and then Enter to accept the license agreement.


IBM Docs Lab – Installing IBM Docs Enter „wasadmin“ and hit Return.


IBM Docs Lab – Installing IBM Docs Enter „Passw0rd“ and hit Enter to start the installation.


IBM Docs Lab – Installing IBM Docs The installation was successful:


IBM Docs Lab – Installing IBM Docs Now we need to install the Viewer component: In the command line change to the following path: CC:\Install\IBMDocs_R1051_FP\Viewer\Viewer\installer and run install.bat


IBM Docs Lab – Installing IBM Docs Once more type „a“ and hit Enter to accept the license terms.


IBM Docs Lab – Installing IBM Docs Enter „wasadmin“ and hit Return.


IBM Docs Lab – Installing IBM Docs Enter the wasadmin password: Passw0rd and hit Enter to start the installation of the Viewer component.


IBM Docs Lab – Installing IBM Docs This installation was successful, too.


IBM Docs Lab – Installing IBM Docs Now last but not least we install the Viewer Extension, which enables the „View“ button in Connections and triggers the automatic conversion of uploaded documents. Switch to the following path and start the install.bat: C:\Install\IBMDocs_R1051_FP\Viewer\ViewerLCCustomizeApp\installer


IBM Docs Lab – Installing IBM Docs Accept the terms and conditions once more by typing „a“ and hitting the Return key afterwards.


IBM Docs Lab – Installing IBM Docs Enter „wasadmin“ once more and hit Enter.


IBM Docs Lab – Installing IBM Docs Enter „Passw0rd“ a last time and hit Return to start the installation.


IBM Docs Lab – Installing IBM Docs The Viewer extension has been installed, too.


IBM Docs Lab – Installing IBM Docs Now we have to more steps to do: 1.  We need to map the new applications to the HTTP Server

2.  We need to modify the task to run the converters to run hidden and without being logged in


IBM Docs Lab – Installing IBM Docs To map the new applications to the HTTP server open the browser and go to the WebSphere Integrated Solution Console and log in as wasadmin with Passw0rd.


IBM Docs Lab – Installing IBM Docs Now navigate to Applications / Application Types / WebSphere enterprise applications and click on IBMConversion .


IBM Docs Lab – Installing IBM Docs Now click on Manage Modules.


IBM Docs Lab – Installing IBM Docs Select all Modules and then select BOTH the cluster ConversionsCluster as well as webserver1 node and click Apply (Not OK!).


IBM Docs Lab – Installing IBM Docs You should see both now in the server section:

Click OK to continue.


IBM Docs Lab – Installing IBM Docs We do not need to save, yet. Click OK once more.


IBM Docs Lab – Installing IBM Docs Now we select click on IBMDocs and then on Manage Modules .


IBM Docs Lab – Installing IBM Docs Now select all Modules again and select both the DocsCluster as well as webserver1 and click Apply.


IBM Docs Lab – Installing IBM Docs You should see each Module mapped to these two servers now. Click OK.


IBM Docs Lab – Installing IBM Docs Still no need to save now. Click OK again.


IBM Docs Lab – Installing IBM Docs Now we select click on IBMDocsSanity and then on Manage Modules .


IBM Docs Lab – Installing IBM Docs Now select all Modules again and select both the ConversionCluster as well as webserver1 and click Apply.






IBM Docs Lab – Installing IBM Docs Now we select click on Spellcheck4IBMDocs and then on Manage Modules .


IBM Docs Lab – Installing IBM Docs Now select all Modules again and select both the DocsCluster as well as webserver1 and click Apply.






IBM Docs Lab – Installing IBM Docs Finally we select click on ViewerApp and then on Manage Modules .


IBM Docs Lab – Installing IBM Docs Now select all Modules again and select both the ViewerCluster as well as webserver1 and click Apply.




IBM Docs Lab – Installing IBM Docs Now we can click on Save.


IBM Docs Lab – Installing IBM Docs Click OK when synchronizing the cell is complete.


IBM Docs Lab – Installing IBM Docs Now we change the way the conversion tasks are configured. To do so start the Task Scheduler:


IBM Docs Lab – Installing IBM Docs Select „Task Scheduler Library“ in the left pane and then double-click the „kill_timeout“-task.


IBM Docs Lab – Installing IBM Docs Now select: „Run whether user is logged on or not“, „Do not store password. ..“ as well as „Hidden“. Now click OK.


IBM Docs Lab – Installing IBM Docs Now double-click on sym_monitor


IBM Docs Lab – Installing IBM Docs Now select: „Run whether user is logged on or not“, „Do not store password. ..“ as well as „Hidden“. Now click OK.


IBM Docs Lab – Installing IBM Docs We are done. Now it‘s time for a reboot. Then log back in as Administrator using the password Passw0rd.


IBM Docs Lab – Installing IBM Docs Now wait until IBM Connections is done loading. This may take a while, as the nodeagent is set to start deferred to avoid timing issues with IBM Connections loading while the database or other components are not there, yet. Check if all services are started before proceeding.


IBM Docs Lab – Installing IBM Docs Now open the browser and go to the WebSphere Integrated Solution Console and log in as wasadmin with Passw0rd.


IBM Docs Lab – Installing IBM Docs Click on Servers / Server Types / WebSphere application servers, you should see Cluster1_server1, Cluster2_server1 as well as InfraCluster_server1 with a deep green status running. If not, please wait until they have finished loading (press the refresh button next to Status to see the status change).


IBM Docs Lab – Installing IBM Docs Now select ConversionMember1 and DocsMember1 and click Start. Do not start ViewerMember1, as IBM Docs 1.0.5.x contains a bug, requiring the Viewer Server to be started after the Conversion Server is running.


IBM Docs Lab – Installing IBM Docs Once the servers are running select ViewerMember1 and click Start here, too.


IBM Docs Lab – Installing IBM Docs Now it‘s time to log out the wasadmin (important!) and start testing IBM Docs: Open in your browser the following URL: http://docs.ibmconnections.com/files/app and login as mgarden using the password Passw0rd. We now see „New“ and the option to create new Documents using IBM Docs.


IBM Docs Lab – Installing IBM Docs Let‘s click on a Document first:


IBM Docs Lab – Installing IBM Docs Now select „View“. This will trigger the conversion server to convert the document and start the viewer.


IBM Docs Lab – Installing IBM Docs Seeing the document tells us, that both Viewer as well as Conversion server work. Now let‘s test the Docs Server by clicking on the Edit button.


IBM Docs Lab – Installing IBM Docs Congratulations, with this screen you have sucessfully installed IBM Docs on a single Windows machine!


Agenda Day 2

09:30 - 11:00 - IBM Connections and Docs Sizing, Architecture and Deployment 11:00 - 11:15 - BREAK 11:15 - 12:00 - Configuration of NFS, Security/Permissions, Network settings 12:00 - 13:00 - LUNCH 13:00 - 14:00 - Performance Tuning, Optimization and Troubleshooting 14:00 - 14:45 - Backup, Restore and Security Configurations for IBM Docs 14:45 - 15:00 - BREAK 15:00 - 15:30 - Wrap up.

© 2014 IBM Corporation Page 158 IBM Collaboration Solutions -- Digital Experience Enablement Series

We appreciate your feedback. Please fill out the survey form in order to improve this educational event.

SIMPLIFIED CHINESE HINDI JAPANESE

ARABIC RUSSIAN TRADITIONAL CHINESE TAMIL THAI

FRENCH

GERMAN

ITALIAN

SPANISH

BRAZILIAN PORTUGUESE