Skip to main content
Kinetic Community

Kinetic Task Install and Config Guide

 

 

 

 

 

KINETIC Task

service_suite_159

Installation and Configuration Guide

Version 1.0.2

 

Revised April 15, 2011

KD_footer_orange


 
Installation and Configuration Guide Version 1.0.2

© 2007 - 2011, Kinetic Data, Inc.

Kinetic Data, Inc, a BMC Software® Solutions Partner.

Remedy, a BMC Software Company

Remedy, the Remedy logo and all other Remedy product or service names and registered trademarks are trademarks of BMC Software, Inc.


Contents

 


Figures

Figure 1: InstallAnywhere timing screen. 6

Figure 2: Introduction screen. 7

Figure 3: Choose Installation Folder8

Figure 4: Installation Option. 9

Figure 5: ARS Connection information. 10

Figure 6: Configuring ARS Connection Information. 11

Figure 7: Choose a File. 12

Figure 8: Request Web User13

Figure 9: Please Wait14

Figure 10: Web Component Details - No Web Install15

Figure 11: ARS Web Configuration Information - New Tomcat Install16

Figure 12: Web Component Details - New Tomcat Install17

Figure 13: Please Wait18

Figure 14: Tomcat port in use warning. 18

Figure 15: Tomcat Shutdown Port in use warning. 19

Figure 16: Tomcat Manager User Credentials. 20

Figure 17: Tomcat Optimizations. 21

Figure 18: JDK Directory. 22

Figure 19: ARS Web Configuration Information - Existing Tomcat Install23

Figure 20: Web Component Details – Existing Tomcat Install24

Figure 21: Select the deployment folder25

Figure 22: Pre-Installation Summary. 26

Figure 23: ARS Data and/or Definition Import27

Figure 24: Installing Kinetic Task. 28

Figure 25: Install Complete. 28

Figure 26: Kinetic Task Administration Console. 33

Figure 27: Kinetic Task Administration Console - Properties. 35

Figure 28: Kinetic Task Administration Console - Task Engine. 39

Figure 29: Kinetic Task Administration Console – Logging. 40

Figure 30: Kinetic Task Administration Console - Dependencies. 41

Figure 31: Left Column Hyperlinks. 41

 


Chapter 1                             Overview

Kinetic Task

Kinetic Task is an advanced automation engine that extends approvals and task management to BMC® Remedy® and third-party enterprise applications.

Important


 

To install Kinetic Task software, an installer must be a Remedy Administrator and have some knowledge and access to your intended Web server. 

This manual is intended for AR System administrators, not users or managers.


The Installer Overview

Kinetic Task is typically installed using an executable installer and includes two parts:  Installing the Remedy forms, workflow and data, and installing a Tomcat Web Server and Kinetic Task Web component.  The installer does include an option to choose just the Remedy component, just the web server component or both, so it may be run multiple times to accommodate your environment.  

TIP


For the Remedy component, the installer can be run from any Windows machine.  The installer will connect to your Remedy server to import the necessary components and configure the necessary data. 

Often an Administrator will choose to install the Tomcat web component in a development environment to get running quickly.  Then for a staging/production environment, manually install the web application to an existing web server.


For the web component, the installer must be run on the machine that is to host your web server and again must be a Windows machine.  If you prefer to install the web component on another operating system, a different web server, or an existing Tomcat instance, just install the Remedy components and follow the directions later in this manual to manually deploy the web application. 

 

Pre-requisites

§  The machine on which the setup file will run must have either the BMC Remedy Administrator tool loaded with a version that corresponds to your Remedy AR System server or the BMC Remedy Developer Studio application.  (This is chosen as part of the installation procedure). 

§  Java Development Kit (JDK) 1.5 or greater (required only if Tomcat will be installed on this server).

§  BMC Remedy AR Server 6.3 or greater.

§  If Tomcat is not going to be installed, a stand-alone Servlet Engine such as ServletExec AS or IBM Websphere is required with JDK version 1.5 or above.

Support

For customer service support, go to the support section of our Web site http://www.kineticdata.com or call 651/556-1020.

Chapter 2                             Installation

Downloading the Installer

To download the installer, follow the instructions provided by Kinetic Data when you make your purchase.  The installer consists of one file (Setup.exe) that will be run from a Windows machine. 

Running the Installer

The following are instructions for using the installer (setup.exe). 

1.           Double click on the “KineticTask_1.0.2.exe” icon.  The InstallAnywhere timing screen will appear as the contents are unpacked.

File:Documentation/Kinetic_Task_Documentation/Kinetic_Task_Install_and_Config_Guide/image003.jpg

Figure 1: InstallAnywhere timing screen

2.           The InstallAnywhere Introduction screen states the software title and version currently being installed on your system. InstallAnywhere will guide you through the installation.

File:Documentation/Kinetic_Task_Documentation/Kinetic_Task_Install_and_Config_Guide/image004.jpg

Figure 2: Introduction screen

 

3.           Click Next.


 

4.           From the Choose Install Folder screen select where you would like to install the locally installed components.

 

File:Documentation/Kinetic_Task_Documentation/Kinetic_Task_Install_and_Config_Guide/image005.jpg

Figure 3: Choose Installation Folder

 

5.           Click Next.


 

6.           The Installation option screen appears.  From here you can choose to install the ARS Definitions and/or installation options for the web component.

7.           Check the ARS checkbox to install the Remedy forms and workflow for Kinetic Task.

8.           Choose the web component option that is appropriate:

a.     Local Tomcat webserver:  A new instance of Apache Tomcat will be installed in the installation folder selected in step 4, and configured for use with Kinetic Task.

b.     Add to an existing Kinetic Tomcat installation: Apache Tomcat will not be installed with this option.  Select this option if an Apache Tomcat instance already exists on the local server.  The web application files will be installed inside this existing Tomcat instance. This is most common if you have another Kinetic Data application installed prior to Kinetic Task.

c.     Don’t install web component:  No web component files or Tomcat instance will be installed.

 

File:Documentation/Kinetic_Task_Documentation/Kinetic_Task_Install_and_Config_Guide/image006.jpg

Figure 4: Installation Option


 

Installing ARS Definitions and Data

If you chose to install the ARS component, you will need to provide the installer with the AR Server information that you are installing Kinetic SR to.

1.             From the ARS Connection Information Screen enter your ARS information including login information, server and ports. 

This information is used to connect to your AR Server if you are installing the ARS components, and for the web server configuration, as well. 

 

File:Documentation/Kinetic_Task_Documentation/Kinetic_Task_Install_and_Config_Guide/image007.jpg

Figure 5: ARS Connection information

 

2.     Enter the AR Server name or your Remedy server name. 

3.             Enter the Login name.  If installing the ARS components, this person must have administrator access.  It will be through this user that the forms and definitions will be imported into your server.  If only the web component is being installed, this user can be an existing Kinetic “default web user” or an Administrator.

4.             Enter the corresponding Password for the login name.

5.             Enter TCP and RPC ports.  If you have ports configured for your AR Server, enter them here.  If you do not then leave them as “0.”

6.             Enter the Authentication string if used.  If not, leave blank. 

7.             Review all lines for accuracy. 

8.             Click Next. 

Please wait while Kinetic Task is being configured.  The system is retrieving the server version and applying the correct information, as well as verifying that the user is an Administrator and has the correct permissions. 

 

File:Documentation/Kinetic_Task_Documentation/Kinetic_Task_Install_and_Config_Guide/image008.jpg

Figure 6: Configuring ARS Connection Information

 


If you are installing on a Remedy 6.3.0 server you will be now see the Choose a File screen.  This screen asks you to choose the location of your Remedy Administrator tool.  This happens because the API used by this installer cannot run against a 6.3 server so an Admin tool must be used.

 

File:Documentation/Kinetic_Task_Documentation/Kinetic_Task_Install_and_Config_Guide/image009.jpg

Figure 7: Choose a File

 

9.             The file location will be prepopulated with the location of any Remdy Administrator tool that the installer was able to find on the local system.  If this is not the correct location, select the location of the Remedy Administrator tool (aradmin.exe) that you wish to use by clicking the Choose button.

10.  Click Next.


The Kinetic Task Web User screen appears (NOTE:  Screen does not appear when only installing into an existing Kinetic Tomcat instance). Kinetic Task needs to create a default user record with the appropriate credentials to handle some interactions with the AR Server.  The user entered here will be created with the appropriate groups and a fixed license.

 

File:Documentation/Kinetic_Task_Documentation/Kinetic_Task_Install_and_Config_Guide/image010.jpg

Figure 8: Request Web User

 

Note:  If there are multiple web servers connecting to a single Remedy server, other users will need to be manually created; one for each web server.

 

11.          By default, this login name is called KD_WEBUSER.  You may change it if you see fit.

12.          Enter a Password.  Use your company’s normal protocol. 

13.          Click Next.


Again, please wait

File:Documentation/Kinetic_Task_Documentation/Kinetic_Task_Install_and_Config_Guide/image011.jpg

Figure 9: Please Wait

 

14.          The Web component details screen appears.  


Web Component Details

The Web Component Details screen will vary in appearance based on options you selected in a previous screen.  The following sections will walk you through the remainder of the installation based on the options you have selected.

 

 

Don’t install web component

If you selected the “Don’t install web component” option you will still be prompted for a couple of simple web component details.  These items will be used to configure the Remedy data for the application

 

File:Documentation/Kinetic_Task_Documentation/Kinetic_Task_Install_and_Config_Guide/image012.jpg

Figure 10: Web Component Details - No Web Install

 

1.             Enter the Web Server Name used in your implementation.  This is typically the name of the web server, but may be an alias or an IP number.  This will be used for configuring the sample data.  This field is not visible if not installing the ARS component.  Example:  “mywebserver.mycompany.com” or “209.98.44.22”.

2.             Enter the Port Number that the Tomcat server is or will be listening  on.  By default, Tomcat listens on port 8080. 

3.             Click Next.  This will take you to the Pre-Installation Summary and you can skip the remainder of this section.

 

 

Installing a Local Tomcat Web Server

 

The first screen shown depends if the ARS component is being installed, or if you are only installing the web component.  If you are only installing the web component, you will see a screen to enter the ARS information that your web component will be conecting to.  This information is needed to automatically configure the Kinetic SR web application properties file.

 

File:Documentation/Kinetic_Task_Documentation/Kinetic_Task_Install_and_Config_Guide/image013.jpg

Figure 11: ARS Web Configuration Information - New Tomcat Install

 

1.     Enter the AR Server name or your Remedy server name. 

Note:  If you typically connect to your AR Server via a fully qualified name, enter that name here. 

Example: ARServer.mycompany.com

This server name must exactly match the server name provided to Kinetic Data when generating your license key. 

 

2.             Enter TCP and RPC ports.  If you have ports configured for your AR Server, enter them here.  If you do not then leave them as “0.”

3.         Enter the Authentication string if used.  If not, leave blank. 

 

4.         Kinetic SR needs to create a default user record with the appropriate credentials to handle some interactions with the AR Server.  The user entered here will be created with the appropriate groups and a fixed license.  Enter the Login name of the Kinetic Web User.

5.         Enter the corresponding Password for the login name.

6.         Click Next. 

 

File:Documentation/Kinetic_Task_Documentation/Kinetic_Task_Install_and_Config_Guide/image014.jpg

Figure 12: Web Component Details - New Tomcat Install

 

7.             Enter the Web Server Name to use for your installation.  This is typically the name of the web server, but may be an alias or an IP number.  This will be used for configuring the sample data.   Example:  “mywebserver.mycompany.com” or “209.98.44.22”.  Note:  this field is not visible if not installing the ARS component.

8.             Enter the Port Number you want the Tomcat server to listen on.  By default, Tomcat listens on port 8080.  If the port entered here is already in use by another application (another Tomcat instance for example), you will be alerted and prompted to select a new port number.

9.             Enter the Shutdown Port Number for Tomcat to listen for the shutdown command from the system.  If the port entered here is already in use by another application (another Tomcat instance for example), you will be alerted and prompted to select a new shutdown port number.

10.          Choose which Tomcat administration application to install with the Tomcat server.  These applications are useful for administering and managing the Tomcat server, but they are not required.

11.          Click Next.  A Please Wait screen appears while Kinetic SR configures your system.

 

File:Documentation/Kinetic_Task_Documentation/Kinetic_Task_Install_and_Config_Guide/image015.jpg

Figure 13: Please Wait

 

12.       If you have entered a Port number that is currently in use, a warning dialog will appear.  Click OK for the previous screen to appear and enter the new Port number.

 

File:Documentation/Kinetic_Task_Documentation/Kinetic_Task_Install_and_Config_Guide/image016.png

Figure 14: Tomcat port in use warning

 

13.       If you have entered a Shutdown Port number that is currently in use, a warning dialog will appear.  Click OK for the previous screen to appear and enter the new Shutdown Port number.

 

File:Documentation/Kinetic_Task_Documentation/Kinetic_Task_Install_and_Config_Guide/image017.jpg

Figure 15: Tomcat Shutdown Port in use warning

 

14.       If you selected to install either the Tomcat Manager Application or the Tomcat Admin Application, a screen will appear to that allows you to create a Tomcat manager/admin user.  Please note, this user is not a Remedy user and will not create a record in the Remedy User form.  It is simply an account on the Tomcat server to allow access to the Tomcat Manager and Tomcat Admin applications.  This screen will be skipped if you did not select to install either application.

 

 File:Documentation/Kinetic_Task_Documentation/Kinetic_Task_Install_and_Config_Guide/image018.jpg

Figure 16: Tomcat Manager User Credentials

 

15.         Click Next.

16.         The Tomcat optimization screen will appear.  Here you can choose to install Tomcat with performance tuned production mode optimizations, or development mode settings (default).

a.     Production mode optimizations tell Tomcat to only compile JSP pages when the service starts.  This provies better performance because the Tomcat server doesn’t need to check the JSP pages for changes every time the page is served.  If any JSP pages are changed however, the Tomcat service will need to be restarted for the changes to become effective. 

b.     Development mode settings allow the JSP pages to compile on the fly, without requiring a Tomcat service restart.  There is a performance penalty with this because the Tomcat server must check the JSP page for changes every time the page is served.

17.        The Min Heap Size is the amount of memory allocated to the Java Virtual Machine when the Tomcat service starts.  The maximum value that Microsoft Windows supports is 1024 MB.

18.        The Max Heap Size is the maximum amount of memory allocated to the Java Virtual Machine.  The maximum value that Microsoft Windows supports is 1024 MB.

 

File:Documentation/Kinetic_Task_Documentation/Kinetic_Task_Install_and_Config_Guide/image019.jpg

Figure 17: Tomcat Optimizations

 

19.       Click Next.


 

 

File:Documentation/Kinetic_Task_Documentation/Kinetic_Task_Install_and_Config_Guide/image020.jpg

Figure 18: JDK Directory

 

20.       From the JDK Directory screen (Shown for new Tomcat installations only), locate an existing JDK installation folder.  Click Choose to browse for the location.  JDK 1.5 or greater is required.

 

21.       Click Next.  You will see another Please Wait screen followed by the Pre-Installation Summary.  You can skip the remainder of this section to receive instructions on finishing your installation.


Installing into an Existing Tomcat Server

The first screen shown depends if the ARS component is being installed, or if you are only installing the web component.  If you are only installing the web component, you will see a screen to enter the ARS information that your web component will be conecting to.  This information is needed to automatically configure the Kinetic Task web application properties file.

 

File:Documentation/Kinetic_Task_Documentation/Kinetic_Task_Install_and_Config_Guide/image021.jpg

Figure 19: ARS Web Configuration Information - Existing Tomcat Install

 

1.     Enter the AR Server name or your Remedy server name. 

Note:  If you typically connect to your AR Server via a fully qualified name, enter that name here. 

Example: ARServer.mycompany.com

This server name must exactly match the server name provided to Kinetic Data when generating your license key. 

 

2.           Enter TCP and RPC ports.  If you have ports configured for your AR Server, enter them here.  If you do not then leave them as “0.”

3.           Enter the Authentication string if used.  If not, leave blank. 

 

4.           Enter the Login name of an existing Kinetic Web User.

5.           Enter the corresponding Password for the login name.

6.           Click Next.

 

File:Documentation/Kinetic_Task_Documentation/Kinetic_Task_Install_and_Config_Guide/image022.jpg

Figure 20: Web Component Details – Existing Tomcat Install

 

1.     Click Next.


 

2.     The Web server directory screen appears.

 

File:Documentation/Kinetic_Task_Documentation/Kinetic_Task_Install_and_Config_Guide/image023.jpg

Figure 21: Select the deployment folder

 

3.         Choose the “webapps” folder for your existing Kinetic Tomcat installation.  This is where the “kineticTask” web application will be installed.

4.         Click Next.


Completing The Installation

1.             From the Pre-Installation Summary screen, please review the following for accuracy before continuing. 

 

File:Documentation/Kinetic_Task_Documentation/Kinetic_Task_Install_and_Config_Guide/image024.jpg

Figure 22: Pre-Installation Summary

 

2.         Click Next.


 

3.         If you selected to install the ARS portion, the ARS Data and/or definition import screen appears verifying that you have elected to import ARS data and/or definitions. 

 

File:Documentation/Kinetic_Task_Documentation/Kinetic_Task_Install_and_Config_Guide/image025.jpg

Figure 23: ARS Data and/or Definition Import

 

4.         Click Install.  This process will take a while as Remedy forms, workflow and data are imported to the AR System Server.  Please do not interrupt the process until the Install Complete notification has appeared. 

 

File:Documentation/Kinetic_Task_Documentation/Kinetic_Task_Install_and_Config_Guide/image026.jpg

Figure 24: Installing Kinetic Task

 

5.             After the installation is complete, you may be asked to restart your computer if the Tomcat Web Server was installed.  

 

File:Documentation/Kinetic_Task_Documentation/Kinetic_Task_Install_and_Config_Guide/image027.jpg

Figure 25: Install Complete

6.             From the Install Complete screen click either, Yes, restart my system, or No, I will restart my system myself. 

7.             Click Done.  The installation of Kinetic Task is finished.

 

Congratulations.  Kinetic Task is now installed on your server. 

If any warnings occurred you can view the log files in the installation directory you chose at the beginning of the installation.

Inside the logs directory, an individual log is created for each component installed and data file imported. 

 

Note:  For each set of data imported, see .arx.log.  For each set of work flow imported, see .def.log (Remedy forms). 

 

Support:  For customer service, please contact the support section of our web site http://www.kineticdata.com or call 651/556-1020.   


Chapter 3                             Other Web Servers

 

Kinetic Task can be installed with a stand-alone Apache Tomcat server for easy deployment.  However, in many situations, another Servlet Container may be required. 

 

Kinetic Task is created as a standard J2EE web application and can be deployed into almost any standard Web Server/Servlet Container including Tomcat, Websphere, and ServletExec AS. 

 

The following sections describe the general process for deploying to other servlet containers.   Each container may have other processes for deploying an application.  Please refer to your specific documentation for complete instructions.

 

Note:  The terminology for web servers may be confusing.  Servlet containers are often called web servers.  However, not all web servers are servlet containers and some servlet containers require a separate web server.  Some examples may help:

 

  • IIS:  Web Server (not a servlet container)
  • ServletExec IS:  A lightweight servlet container that requires a web server front end like IIS.  This is what Remedy Mid-Tier was bundled with prior to version 7.
  • ServletExec AS:  The application server version of ServletExec.  This can run as a servlet container and web server, or can connect up to IIS or other web servers for front end page serving.
  • Apache Tomcat:  An open source servlet container that can also be used as a stand-alone web server.
  • Apache Web Server:  An open-source web server.  This is not a servlet container, and is often paired with Tomcat as a back-end servlet container.

 

Deploying Kinetic Task

Deploying Kinetic Task to a web server involves moving the directories included in your installation to your web server as well as configuring some of the web server properties.  

 

NOTE:  If you need a WAR file for your environment (Web application archive), it can be found in the Web folder of the Installation Directory listed below. 

 

Terminology:

  • Installation Directory: This is a backup copy of the web application files that the installer placed on the local hard drive.  The default location for this directory is C:\Program Files\Kinetic Apps\Kinetic Task\.
  • Deployment Directory <webapps>: This is the directory where your web server is hosting your web application.  Please consult your web server manual if you need help determining where your web server’s deployment directory is located.
    • An example for Tomcat would be: <TomcatDir>\webapps\
    • An example for ServletExec AS would be:  C:\Program Files\New Atlanta\Servlet Exec AS\se-<instance>\webapps\

 

 

  1. Locate the installation directory chosen at the beginning of the installation process.  The required files have been included in the Web directory.
     
  2. Move the “kineticTask” directory into the web server’s deployment directory for automatic deployment, or another desired location on your web server.
     
  3. Add the kineticTask application context to your web server configuration.  This is often done from a management/configuration screen for your environment.  Typically this involves:
    1. Naming the application. Example “KineticTask”
    2. Including the URL context.  The default is “/kineticTask/”
    3. Including the path to the kineticTask directory moved in step 2.
    4. NOTE: If a Tomcat server is used and the application was moved into the Tomcat deployment directory, this step is not necessary as Tomcat will automatically add the application when the service is started.
       
  4. Include the ARS API files specific to your ARS installation.  If you are installing Kinetic Task on the same instance of a web server running BMC Remedy Mid-tier, please read the next section on Shared Java Resources before doing this step.

    The kdi_arshelpers.jar file is included as part of Kinetic Task.  The other API files are also included in the installation directory.  However, we suggest getting the latest version/patch that your ARS Server is using.  You can typically find these in your AR System/ARServer/Api/lib directory, or in the WEB-INF/lib directory of your Mid-Tier installation.  These can also be downloaded from http://www.ARSWiki.org.

    Place these files in the <webapps>/kineticTask/WEB-INF/lib directory.  This would include minimally:
    1. kdi_arshelpers.jar found in <installation directory>/Web/
    2. arapi6x/7x.jar
    3. arutil6x/7x.jar
    4. If no other Remedy applications are installed on your machine (such as Midtier/Flashboards/Email Engine etc), you will also need to include the Remedy API dynamic link library (DLL) files.  You can look in the <installation directory>/Web/<your AR Version> to see what files are necessary.   The location of the API DLL files must be included in the system PATH.

 

  1. If you had to add the location of the Remedy API DLLs to the system PATH variable, you will need to restart your server.

 

  1. Restart your Web Server/Servlet Container.

 

  1. You are now ready to configure your Kinetic Task web application with your Remedy server information.  Please see the next section Configuring the Web Application Properties.

 

Configuring the Web Application Properties

If you have successfully deployed the Kinetic Task web application, you will need to configure it with the Remedy server information, and a few other configuration items.

 

  1. Open your web browser and connect to the Administration Console.  http://<webservername>:<port>/<context>/AdminConsole

 

Replace the following items with your web server specific values:

<webservername>         Name or IP of your web server.

<port>                                  Port your web server uses (8080)

<context>                           Context of application (kineticTask)

 

  1. This web page requires authentication to gain access to it.  Only Remedy Administrators have access to it, with the exception of a configuration administrator user.  This user is necessary for first time access to the system because a Remedy server has not yet been configured, so the web application doesn’t know where to authenticate.

 

  1. Log in with the default configuration administrator for this web server (admin/admin).  After logging in, the credentials for this user may be changed.

 

  1. Now edit the properties for your Remedy server.

 

File:Documentation/Kinetic_Task_Documentation/Kinetic_Task_Install_and_Config_Guide/image028.jpg

Figure 26: Kinetic Task Administration Console

 

  1. Click the ‘Edit Properties’ button to enter your Remedy server and user properties.  Please see Web Admin Console - Properties Tab for a description of each property.

 

  1. Click the ‘Update Properties’ to save your changes, or click the ‘Cancel’ link to discard your changes.

 

 

Shared Remedy Java Resources

Because the BMC Remedy Java API uses a JNI interface, there are some special requirements if the Servlet Container running Kinetic Task is also running BMC Remedy Mid-Tier. 

 

A few notes on sharing a servlet container:
 

  • ServletExec ISAPI is not supported if Mid-Tier is already installed inside this container because shared libraries are not available.  ServletExec AS is supported, and ServletExec ISAPI is supported if Kinetic Task is the only Remedy-based web application running.
     
  • If you are setting up a new environment we suggest installing BMC Remedy Mid-Tier first.  Testing your install, then installing Kinetic Task Web component as described earlier.

 

Important Note:  Kinetic Task cannot be installed in a Servlet Container running BMC Knowledge Management.  If your Servlet Container is running BMC Knowledge Management, you will need to install another instance of the Servlet Container, or another Servlet Container altogether.

 

Shared Jar files

To run the applications together in the same instance, you must move some jar files that both applications need to a directory that is available to your container for this purpose.  To do this:

 

  1. Copy the kdi_arshelpers.jar from your kineticTask/WEB-INF/lib directory.  You will need this file in step 4.

 

  1. Copy the arapi6x/7x.jar and arutil6x/7x.jar from BOTH the kineticTask/WEB-INF/lib AND your Mid-Tier/WEB-INF/lib directories.  You will need these files in step 4.

 

  1. Place these files in the shared directory for your servlet container:

 

    1. For Tomcat this is in <tomcat_folder>/shared/lib/
       
    2. For ServletExec AS, this is <servletexec_folder>/<SE instance>/classes/

      For SE you must also alter the <servletexec_folder> /<SE instance>/StartServletExec.bat script to include these three files in the classpath. You will see a –classpath line followed by many paths, each separated by a semi-colon.  Enter the path to each jar after the last item in the path.
       
    3. For other web servers or more information, please your specific server’s documentation.

 

  1. In a shared environment, you should not include the other DLL’s/libraries that you would typically include in your kineticTask/WEB-INF/lib directory.  These are already included in the Mid-Tier server and added to the PATH environment variable for your server. 

 

IMPORTANT NOTE:  When you upgrade your Mid-Tier server in a shared environment you will need to again remove the jars from your Mid-Tier/WEB-INF/lib directory.  You should replace the files in the shared directory with these new files.

Chapter 4                             Kinetic task Administration Console

 

Overview

The Web Admin Console is designed so that an administrator can configure and administer the Kinetic Task application using a web browser from any computer that has access to the web server.

 

Properties Tab

The Properties tab provides the ability to configure the web application settings, so it knows what Remedy server to connect to, what Remedy user credentials to use to login with, etc.  Each property setting is described below.

File:Documentation/Kinetic_Task_Documentation/Kinetic_Task_Install_and_Config_Guide/image029.jpg

Figure 27: Kinetic Task Administration Console - Properties

Remedy Server Settings
  • Enter the Server Name of your Remedy server.  This should either be the server’s DNS name or IP address.  The value you enter here must match the value used to generate the Kinetic Task licenses.

 

  • Enter the Remedy server’s TCP Port.  If your Remedy server uses portmapper, enter 0.

 

  • Enter the Remedy server’s RPC Port.  If your Remedy server is not using a specific RPC port, enter 0.

 

·         Enter the maximum number of API connections allowed in the API Connection Limit field.

 

Encryption Settings
  • If you would like the web application to store the web user passwords encrypted in the properties file, check the Encrypt Passwords checkbox.

 

Web User Settings
  • Enter the Default User and Default Password for the Remedy user account that the web application will use to create Remedy records.  This must be an existing Remedy user and it must have a fixed write license.  This user also must belong to the KS_CORE and KS_SRV groups at a minimum.

 

  • You may also enter an optional Alternate User and Alternate Password.  This user account will be used if the default user account is not available or cannot connect to Remedy for some reason.  You can also choose to leave this value blank.

 

Kinetic Task Engine Settings
  • Indicate if the task engine should run on this web server by checking the Enable checkbox.  Kinetic Request uses the task manager to process tasks, such as approval records or to create records in other AR System forms, that are defined in service items.  The task manager polls the Remedy server to check if there are any tasks ready for processing.

 

·         The Sleep Delay property is the number of seconds the task engine will wait between checking for new triggers to process.  This value is only used if the Max Threads setting is set to 0. 

 

·         Max Threads indicates the number of worker threads the task engine will use to process triggers. If set to 0, the task engine will only use one worker thread in a synchronized manner, meaning it will process all the triggers with one worker thread, then sleep for the specified duration as indicated by the Sleep Delay parameter, then wake up and process the new triggers. If this value is set higher than 0, that many worker threads will be available to process triggers simultaneously. More threads require more memory and higher CPU utilization.

 

·         Query Limit is the maximum number of triggers that will be processed during each wake cycle. If there are more triggers than the value of the query limit, the remaining triggers will be processed in future wake cycles.

 

·         The Query parameter allows the user to customize what trigger records are selected by a specific engine. This is typically only applicable in multiple task engine environments.

·         Cache Handlers allows the task engine to cache the task handler files in memory. Changes to the task handler file will not be applied until the web server is restarted. This provides a performance improvement over loading the task handler file every time it is needed.

 

·         Auto-Deploy Handlers allows the task engine to automatically retrieve the task handler zip file from the Remedy server, and deploy it to the web server. This only works when Cache Handlers is enabled.

 

·         Outgoing Mailbox ID is used to identify a specific Remedy mailbox to use when generating system emails. This value corresponds to the 'Unique Identifier' field on the AR System Email Mailbox Configuration form. If this value is left blank, the default outgoing mailbox will be used.

 

·         Notify Process Owner tells the task engine to send an email to the process owner when an error occurs with that process tree. The process owner is configurable for each task process tree by clicking the 'Configure' button in the Task Builder, and configuring the email address in the Author field.

 

·         Notify System Owner tells the task engine to send an email to the system administrator when any error occurs in the task engine. When selected, a text input field will appear that will accept an email address, or a comma separated list of email addresses.

 

 

Default Logger Settings

·         Enter the Log Level that the system will use to determine what level of detail the information is written to the log file.  The values are listed in order of detail from least (Off) to most (All).  A higher detailed value provides more logging information, but is also more resource intensive on your server.

 

·         Enter the Max Log Size to limit the log file.  The logger is configured as a rolling file appender, which means that when the log file reaches the max size limit, it will be closed and a new file will be started.  This prevents the file from growing too large, and allows administrators the ability to delete old log data without having to stop the web server.

 

·         If you want to further customize the information that is captured, enter the location of the logging properties file in the Log Properties File field.

 

 

SSO Adapter Settings

If you have a single sign-on solution that your company uses, and would like to include Kinetic Task with the technology, you need to tell the web application where this adapter is located.  For more information on writing a single sign-on adapter to work with Kinetic Task, please see the Kinetic Task Single Sign-On Adapter Tech Note.

 

·         The SSO Adapter Class setting is the name of the SSO Java Class.  If the SSO adapter is not used, leave this value blank.

 

·         The SSO Adapter Properties setting is the fully qualified filename of the SSO adapter properties if the adapter uses a properties file.

 

Configuration Administration Credentials

The configuration administration user is a built-in user for the web application.  This user has the ability to configure the web application properties to connect to a Remedy server.  This user is strictly used for configuring the web application, and is completely independent from Remedy.  Therefore, the user does not exist in the Remedy User table.

 

·         Enter the configuration administrator username in the Config Admin User field.  The default value is admin.

 

·         Enter the configuration administrator password in the Edit Password field.  The default value is admin.

 

Task Engine Tab

The Task Engine tab provides the ability to start and stop the Kinetic Task Engine service if it has been enabled on the Properties tab.  This service polls your AR System server at regular intervals, creating approvals and other AR System records when indicated.  The status is also displayed, indicating if the service is currently running, stopped, or in a failed state.

 

Typically, this service runs on one web server.  Care should be taken if running in multiple web servers to alter the query so each web server is handling a subset of all tasks.  This query is managed in the properties tab of the Web Administration Console on each of your web servers.

 

File:Documentation/Kinetic_Task_Documentation/Kinetic_Task_Install_and_Config_Guide/image030.jpg

Figure 28: Kinetic Task Administration Console - Task Engine

 

Logging Tab

The logging tab displays a snapshot of the latest 200 entries from the web application log file.   This provides an easy way to view the log file for administrators that do not have file system access to the web server.

Note:  The information displayed on this page is a snapshot of the last 200 entries in the log file when the tab was clicked.  This is not live information.  The page must be refreshed to load log entries that came in after the page was originally loaded.

Also provided on this tab is a link to download the entire log file to your local computer.

File:Documentation/Kinetic_Task_Documentation/Kinetic_Task_Install_and_Config_Guide/image031.jpg

Figure 29: Kinetic Task Administration Console – Logging

 

 

Dependencies Tab

The dependencies tab displays important information about the Java library dependencies for the Kinetic Task web application.  It displays the name of all the dependent libraries, along with the version number (or file date if version is not available), the full name of the library’s jar file, and the confidence level of the version information. 

This could be helpful information when working with Kinetic Data support in troubleshooting an issue.

File:Documentation/Kinetic_Task_Documentation/Kinetic_Task_Install_and_Config_Guide/image032.jpg

Figure 30: Kinetic Task Administration Console - Dependencies

 

 

Left Column Hyperlinks

There are two hyperlinks located in the left hand column that lead to the Kinetic Task Configuration Console and the Kinetic Task Management Console.

 

File:Documentation/Kinetic_Task_Documentation/Kinetic_Task_Install_and_Config_Guide/image033.jpg

Figure 31: Left Column Hyperlinks

 

Task Configuration

The Kinetic Task Configuration Console is a web based console that allows users to manage task handlers.  From here you can import handlers and assign them to categories to be used in the Task Builder.  For more information on this console please see the Kinetic Task User Guide.

 

 

Task Management

The Kinetic Task Management Console is a web based console that allows a user to see information about the Task Engine as well as about individual task processes.  From here you can see any exceptions that have been generated within the Task Engine.  Here you can also view details of a specific process including the number of exceptions thrown, as well as the number of triggers and task instances that have been generated from the process.  For more information on this console please see the Kinetic Task User Guide.

 

 

Installation Troubleshooting

If you encounter errors, and the installation will not continue, you may wish to try running the installer again in debug mode.  To do this, exit the current installation, then run the installation executable again.  Before the progress bar reaches 100%, hold down the Ctrl key until a Windows command terminal opens.  This command terminal is a live log of the installation application, and will hopefully give some additional information to what is causing the error.  Do not close this command terminal, or the installation application will exit.