Manually integrating IBM Docs with Connections
Connections is supported on a larger set of operating systems than what IBM Docs officially supports. IBM Docs and File Viewer extensions are required to be installed on the Connections server. If the operating system does not support the scripts provided or does not support the required level of Python, you might need use a manual process to integrate IBM® Docs into your IBM® Connections deployment.
Procedure
- Import an object type for IBM Docs files.
- Copy the <Unzipped_Docs_Install_Package>/config/ibmdocs.xml file to the Connections Files customization folder (<connections_install>\data/shared/customization/objecttypes).
- Configure the URL customizer (files-url-config.xml)
- Locate files-url-config.xml in the WebSphere® Application Server Deployment
Manager configuration folder.Example: was_install/profiles/Dmgr01\config\cells\CELLNAME\LotusConnections-config\files-url-config.xml.
- Copy and paste the following example into the XML file,
within the existing <config></config> tags. If you are using
different ports for HTTP and HTTPS, you must update the port numbers.
<objectType name="ibmdocs:file" urlCustomizer="com.ibm.lconn.share.platform.url.DefaultURLCustomizer"> <property name="server.port.http" value="[default port, like 80] "/> <property name="server.port.https" value="[ssl port, like 443]"/> <property name="link.custom" value="/docs/app/doc/lcfiles/{fileId}/editorview/content"/> </objectType>
- Locate files-url-config.xml in the WebSphere® Application Server Deployment
Manager configuration folder.
- Configure files-config.xml file for IBM Docs.
- Locate files-config.xml in the WebSphere Application Server Deployment
Manager configuration folder.Example: was_install/profiles/Dmgr01/config/cells/CELLNAME/LotusConnections-config/files-config.xml
- Copy and paste the following content (used to define
the app-connector role that is used in later steps) into the XML file,
within the existing <config></config> tags:
<actionControl> <objectType id="00000000-00000-0000-0001-00000000000000"> <actions> <action enabled="true" name="uploadNewVersion"/> <action enabled="true" name="download"/> <action enabled="false" name="downloadEmptyFile"/> <action enabled="true" name="restoreVersion"/> </actions> </objectType> </actionControl>
- Locate files-config.xml in the WebSphere Application Server Deployment
Manager configuration folder.
- In the WebSphere Application
Server administrative console, map a user to the app-connector role
for Files. This user is used by IBM Docs to communicate
with Files. Note: If you are using a user other than the default Connections administrator associated with the J2C Alias connectionsAdmin, ensure that this user is also assigned as an administrator.
- Log in to the WebSphere Application Server Deployment Manager administrative console from the browser.
- Click Applications > Application types > Websphere enterprise applications.
- Click the Files application.
- Click the security role for user/group mapping.
- Select app-connector. Click Map users.
- Type the ID that you are using for the IBM Docs administrator, and click search.
- Select the name from the available column and click the right-arrow to move the name to the selected column.
- Click OK, and then click OK again to close the security role mapping screen.
- Save the changes to the master configuration.
- Disable the Open this File feature.
In Connections Files, a user, when downloading a file, can open it
directly in the browser instead of saving it. Whether the file can
be opened is determined by local applications. When IBM Docs and File Viewer are enabled, Open
this File is not needed because users can use IBM Docs or File Viewer to open the file.
There are two ways to disable the feature:
- To disable the feature for all files, set <inlineDownload enabled="false"/> in files-config.xml.
- To disable the feature for a file type, set openFromWeb="false"
for corresponding mime-type in mime-files-config.xml, for example:
<mapping mediaType="document" mimeType="application/vnd.oasis.opendocument.text"> <extension openFromWeb="false">odt</extension> </mapping>
- Synchronize changes and restart the applications:
- Open the WebSphere Application Server Deployment Manager administrative console from the browser, and click System administration > Nodes.
- Restart the Files application from Applications > Application Types > Websphere enterprise applications.
- Step 6b should have resulted in importing the ibmdocs.xml file
content automatically. To verify that the object type was imported,
complete the following steps:
- In a terminal window, start the wsadmin administrative
interface from the Deployment Manager. When prompted, specify your WebSphere Application Server
credentials.
- cd /opt/IBM/WebSphere/AppServer/profiles/Dmgr01/bin
- ./wsadmin.sh –lang jython
- Run the following command to verify that the object
was imported:
- execfile("filesAdmin.py")
- Use FilesObjectTypeService.browseTypes() to look for
the localName of the returned types to see whether ibmdocs.xml is
there. If it is, do not import it again. If it is not there, run
the following commands to import the object type:
- FilesObjectTypeService.importType(/opt/IBM/Connections/data/shared/customization/objecttypes/ibmdocs.xml)Note: You must specify the full path to the ibmdocs.xml file.
- FilesObjectTypeService.browseTypes() (Confirms that the object type was successfully imported)
- FilesObjectTypeService.importType(/opt/IBM/Connections/data/shared/customization/objecttypes/ibmdocs.xml)
- In a terminal window, start the wsadmin administrative
interface from the Deployment Manager. When prompted, specify your WebSphere Application Server
credentials.
- Select all Connections nodes, and click Full Resynchronize to synchronize your changes to all cluster nodes.
- Ripple-start the common, infra, and Files Connections clusters.