Maximo 7.6.0.5+ : Installing Standalone Help

June 30, 2016 RichardLesses

Maximo Asset Management Feature Pack 7.6.0.5 changed the way Maximo help works. Instead of building and deploying the MAXIMOIEHS ear file to the MAXIMOIEHS  Enterprise application, Maximo now points help to ibm.com.

image

image

 

In System Properties, there are is new default values pointing to where Help is:

Property Name Pre-Maximo 7.6.0.4 Default Value Maximo 7.6.0.5 Default Value
mxe.help.host 127.0.0.1 www.ibm.com
mxe.help.maximohelplink com.ibm.mam.doc,welcome.html com.ibm.mam.doc,welcome.html
mxe.help.path /help/ /support/knowledgecenter/
mxe.help.port 80 80
mxe.help.protocol http http
mxe.help.useKCHelp* 0 1
mxe.help.viewsearchtiplink com.ibm.mbs.doc,mbs_common/c_advanced_search_tips.html com.ibm.mbs.doc,mbs_common/c_advanced_search_tips.html

Please look at Shane's excellent post on changing which version of Maximo it points to on www.ibm.com it points to, as Help for 7.6.0.5 is currently English only. *The mxe.help.useKCHelp property was added in Maximo 7.6.0.4. This means that, in Maximo 7.6.0.4, you can change mxe.help.useKCHelp from 0 to 1, mxe.help.host to www.ibm.com, mxe.help.path to /support/knowledgecenter/ and mxe.help.port to port 80. After you save and apply Live Refresh, Clicking on help links will be redirected to Maximo 7.6.0.0 help.

If your environment does not allow Maximo users to access the Internet, you can download help packages from Fix Central that contain the same documentation packages that are available online in IBM® Knowledge Center. You add the help packages and configuration files to a local installation of IBM Knowledge Center.

See Installing IBM Knowledge Center and help packages for Maximo Asset Management products. Listed below are packages for Knowledge Center, and help packages. Multilingual help packages and Additional Industry Solution packages will be released in the future.

 

IBM Knowledge Center installers

IBM Knowledge Center 1.5 Linux 64-bit: 7.6.0.5-TIV-KCLIN64-FP0001
IBM Knowledge Center 1.5 AIX 64-bit: 7.6.0.5-TIV-KCAIX64-FP0001
IBM Knowledge Center 1.5 Win64: 7.6.0.5-TIV-KCWIN64-FP0001

 

Add-On and Industry Solution Product-specific help

Maximo Asset Management 7.6.0.5: 7.6.0.5-TIV-MAMKCEN-FP0001

Maximo Asset Management Multitenancy 7.6.0.5: 7.6.0.5-TIV-MTKCEN-FP0001

Search for Add-On/Industry Solution help packages under their product names

Maximo for Aviation 7.6.2: 7.6.2-TIV-MAVMKCEN-FP0001

Maximo Asset Configuration Manager 7.6.2 7.6.2-TIV-ACMKCEN-FP0001

Maximo Asset Management Scheduler 7.6.3 7.6.3-TIV-MSCKCEN-FP0001

Maximo for Service Providers 7.6.2 7.6.2-TIV-SPRKCEN-FP0001

Maximo for Transportation 7.6.2 7.6.2-TIV-TRNKCEN-FP0001

 

Installing Stand-alone Help

Extract the IBM Knowledge Center package to the location where you want to install it. The default installation location is C:\KnowledgeCenter. If you install IBM Knowledge Center to a different location, you must update the path value in the taxonomy.properties file for each help package that you install.

imageExtract a help package to a temporary location. The extracted files include one or more plugin folders, a properties file and a taxonomy file.

Copy all com.ibm.prod.doc plugin folders from the help package to the install_home/KnowledgeCenter/usr/content/KCXhtml directory.

image

Copy the properties file to the configuration directory, for example to install_home/KnowledgeCenter/usr/conf/SSLKT6_7.6.0.5.properties. Open the properties file in a text editor and update the path value, if necessary, to point to the installed location. For example, change the value of the Path property from C:/KnowledgeCenter/usr/content/KCXhtml to E:/IBM/SMP/KnowledgeCenter/usr/content/KCXhtml, where IBM Knowledge Center is installed at E:/IBM/SMP/KnowledgeCenter.

 

image

Replace the install_home/KnowledgeCenter/usr/taxonomy/KC_taxonomy.ditamap with the version of the KC_taxonomy.ditamap file that is included in the help package.

image

From a command prompt or terminal window in the install_home/KnowledgeCenter/bin directory, run startKC.bat or startKC.sh to start IBM Knowledge Center.

image

In a browser, open http://install_home:9090/kc to view the product help.

To redirect the application help links to point to your local installation of IBM Knowledge Center, in the System Properties application, filter for mxe.help properties. In the following table, the application server is at mymaximo.acme.com, and the Maximo application server is running on port 9082.

 

Property Name http://mymaximo.com:9082/maximo
mxe.help.host mymaximo.acme.com
mxe.help.maximohelplink com.ibm.mam.doc,welcome.html
mxe.help.path /kc/
mxe.help.port 9082
mxe.help.protocol http
mxe.help.useKCHelp 1
mxe.help.viewsearchtiplink com.ibm.mbs.doc,mbs_common/c_advanced_search_tips.html

Save the changes and click Live Refresh to update the values in the product database.

To stop IBM Knowledge Center, in the install_home/KnowledgeCenter/bin directory, run stopKC.bat or stopKC.sh.

Previous Article
Updating or Changing the ownership of an existing query in Maximo

In Maximo you have public queries created by an user and then you may want to change the ownership of the q...

Next Article
Changing the default help location in Maximo 7.6.0.5
Changing the default help location in Maximo 7.6.0.5

In Maximo 7.6.0.5 a new help system was introduced, which instead of building a help ear and deploying loca...

×

Want our latest news? Subscribe to our blog!

Last Name
First Name
Thank you!
Error - something went wrong!