Using IBM Knowledge Center for CICS products
CICS documentation can be used in a downloadable version of the IBM Knowledge Center. You can run the IBM Knowledge Center for CICS products either stand-alone or under an application server. Stand-alone, the IBM Knowledge Center for CICS products runs on AIX, Windows, or Linux. Under an application server, the IBM Knowledge Center for CICS products runs on AIX, Windows, Linux, and Linux for z Systems.
- Installing the IBM Knowledge Center application, by using one of the packages on DVD of the IBM Knowledge Center for CICS products. You get the DVD for download, or as a physical DVD, from IBM Shopz. The publication number for this DVD is GC34-7459. After your initial installation, you need to install the application again only if there is a new version of the application from IBM and you want to move to that version.
- Installing CICS documentation into the application. You get the documentation from the CICS information download site. After your initial installation, you need to install the documentation again only if IBM makes updates to the documentation and you want to pick up those updates.
Installing IBM Knowledge Center for CICS products stand-alone
- From the supplied DVD or DVD image, extract the .zip or .tar application
package for your target operating system to your system. The packages
are called KC_CI_x.x.x.date-FPx.platform,
where x is the version and fix pack level of IBM
KC, date is the date that it was provided by IBM,
and platform is one of:
- aix.ppc64
- linux.i386
- linux.ppc64
- linux.x86_64
- win32
- win64
- Create a directory to contain the IBM Knowledge Center. On UNIX, make sure that you have read- and write-access to this directory.
- Extract the files from the downloaded package into your new installation directory. The extract creates two directories: KnowledgeCenter and licenses. Ensure that the folder called KnowledgeCenter has read and write access.
- Start the IBM Knowledge Center. To do this, go to the bindirectory under KnowledgeCenter and run the file that is called startKC. (On UNIX, make sure that this file is executable.)
- To verify the installation, open the IBM Knowledge Center. To do this, from a browser, connect to the IBM Knowledge Center on http://localhost:9090/kc, with the host name and port number that was allocated by the startKC job. You see the IBM Knowledge Center welcome page but the Table of Contents is empty of product documentation. To add documentation into the installed IBM Knowledge Center, see Adding documentation into the IBM Knowledge Center for CICS products.
Installing under WebSphere Application Server Liberty profile
- From the supplied DVD or DVD image, extract the .war package to your system. The package is called KC_CI_x.x.x.date-FPx.war, where x is the version and fix pack level of IBM KC, and date is the date that it was provided by IBM.
- Create a WebSphere Application Server Liberty profile server to run the IBM Knowledge Center.
- In this Liberty server, create a folder that holds the contents of the IBM Knowledge Center installation package: for example, a folder that is called kc.war off the /apps directory of your Liberty KC server.
- Extract the files from the downloaded war file into your new folder.
- Add a web application setting for the IBM Knowledge Center. You
do this by editing the server.xml in the directory of your Liberty
KC server. For example:
<server description="kc"> where "kc" is the name of your IBM KC server <featureManager> <feature>jsp-2.2</feature> <feature>jndi-1.0</feature> <feature>jaxrs-1.1</feature> <feature>jpa-2.0</feature> <feature>servlet-3.0</feature> <feature>localConnector-1.0</feature> </featureManager> <httpEndpoint host="*" httpPort="9090" id="defaultHttpEndpoint"/> where httpPort specifies the port that you want to use for the IBM Knowledge Center. 9090 is the default. <webApplication contextRoot="/kc" id="kc" location=$${server.config.dir}/apps/kc.war" name="kc" /> where location specifies the path to the folder where you unzipped the downloaded .war file. </server> - Specify a JVM property for KC_HOME. This property sets the path
to the directory where the product documentation is stored. (If you
haven't yet downloaded documentation, see Adding documentation into the IBM Knowledge Center for CICS products.
You don't have to set up the directory for the documentation before
you set the KC_HOME property, but the directory must be in place when
you start the IBM Knowledge Center for CICS products . To specify a JVM property, append to the jvm.options file in the directory of your Liberty KC server, as follows:
-DKC_HOME=pathwhere path is the directory into which you extracted the product documentation. For example, on Windows: -DKC_HOME=c:\KCHome
- Restart your Liberty KC server.
Adding documentation into the IBM Knowledge Center for CICS products
The documentation to go into the IBM Knowledge Center for CICS products is not supplied on the DVD. This is because the CICS documentation team can get updates to the documentation to you more frequently and more quickly through FTP.
To add the documentation for multiple products, repeat the steps below for each documentation package.
- Download the .zip package for CICS documentation to your system from the CICS information download site.
- Create a directory to contain the CICS documentation and extract the files from the documentation package to this directory. The extracted package has two directories: runtime and usr. There is also a file called kc.properties.
- For an installation of IBM Knowledge Center for CICS products products under an application server only, check that the path that you specified on the KC_HOME property is the path to this directory.
- For a stand-alone installation of IBM Knowledge Center for CICS products
only, copy the documentation into your empty IBM Knowledge Center application. To do this, copy both
the extracted runtime and usr directories into the root of your installed IBM Knowledge Center for CICS products . The root directory is
KnowledgeCenter, by default. To preserve any other content that you installed,
ensure that you merge with the existing contents.
You can leave the file called kc.properties in the directory where you extracted the contents of the documentation package. It is needed there for an installation of IBM Knowledge Center for CICS products under an application server. For a stand-alone installation, the kc.properties file is included in the KC application.
- Restart your IBM Knowledge Center for CICS products . To do this, for the stand-alone installations, run the startKC file in the bin directory of your installed IBM Knowledge Center. For an installation under WebSphere Application Server Liberty profile, start your Liberty KC server.
Launching the IBM Knowledge Center for CICS products
To view the documentation, from a browser, connect to the IBM Knowledge Center on http://localhost:9090/kc, with the host name and port number that were allocated by the startKC job for a standalone installation, or by the server.xml settings for an installation under an application server.