The Kinetic Task Administration 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. This console is broken down into four tabs.
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.
Figure 2: 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.
- Enable/disable theAPI Impersonated User setting. The impersonate user functionality has three requirements:
The AR Server must be at least version 7.0
The AR API used by the web application must be at least version 7.0
The default web user account must be a Remedy Administrator (Fixed write license and in the Administrator group
- 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.
- 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.
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.
Figure 3: Kinetic Task Administration Console - Task Engine
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.
Figure 4: Kinetic Task Administration Console – Logging
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.
Figure 5: Kinetic Task Administration Console - Dependencies
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.
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.