Skip to main content
Kinetic Community

Server Administration

The Task Server Administration allows access to the Task Server configuration properties, such as task server details, license details, polling configuration, log settings, and login configuration for the administration. This console also allows access to stop/start the Task Engine, Environment details, and downloadable log files.

Description of Task Server Administration Functions

The Task Server Administration is broken into three tabs, Properties, Task Engine, and Environment.

At the top of all of these tabs all of the task server logs are available for download.

The Properties tab allows access to  task server details, license details, polling configuration, log settings, and login configuration for the administration.

The Task Engine tab shows the current status of the Task Engine and allows for stopping/starting the engine.

The Environment tab shows license, system, server, adapter and dependency information. In Task 2.0, this tab was called "Dependencies", for those users upgrading from 2.0.Task3Administration.png

Log Files

The Setup Log is a log of the install/setup. Support may ask for this log if you are troubleshooting setup.

The Manager Log is a log that contains setup, license, task engine restart information. When logging at a debug level, this log also contains a record of the saves of the properties tab and of task trees.

The Engine Log contains information about the engine checking for and processing triggers.

The Environment Log is basically a downloadable copy of the information on the Environment tab.

The Worker Logs (zip) is a download of the worker logs. There is one worker log for each thread running. The worker log contains details of the task trees processed by that thread, including any debug output from the handlers and evaluation conditionals on tree paths.

The All Logs (zip) download contains all the logs in a zip file.

Properties

By default, the Properties tab is displayed in read-only mode. At both the top and bottom of the page, there is an "Edit Properties" button. This must be clicked to update the configurations presented on this page, and when the updates are made, the "Update Properties" button must be clicked to save the changes. The screenshots in this section will be in Edit mode because this mode occasionally displays additional fields that are hidden in read-only view. This tab is broken up into the following sections:

  • Application License
  • Remedy Server Settings
  • Kinetic Task Engine Settings
  • Debug Logger Settings
  • Configuration Administrator Credentials
Application License

The Application License validates whether this task engine is licensed with Kinetic Data. This is also where you enter a license when it is provided.

license.png

Remedy Server Settings

The Remedy Server Settings determine which Remedy server Kinetic Task will connect with.

remedySettings.png

Server Name is the name of your Remedy server. This value must match the information in your license key. If your license key was generated using the fully qualified name, you must use the fully qualified name here.

TCP Port defines the TCP Port your Remedy server is listening on. If your Remedy server is configured to use portmapper, use 0 as the value.

Username is the Remedy user that will be used by Kinetic Task to connect as the proxy user account.

Password is the password associated with the Username account.

Kinetic Task Engine Settings

The Kinetic Task Engine is a service that polls the Remedy server to check if any tasks need to be processed. The task engine service will process all records that match the Query. It polls the remedy server every X number of seconds, as defined by the Sleep Delay.

engineSettings.png

 

Kinetic Task Engine Service, if enabled, will be enabled on this web server.

Sleep Delay is the number of seconds the task engine will wait between checking for new triggers to process.

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 triggers sequentially, finishing one before starting to work on another, then sleep for the specified duration as indicated by the Sleep Delay parameter. 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.

System Owner Email is the email address that will receive messages whenever an error occurs in the Kinetic Task Engine. This field is also only shows up when Notify System Owner is selected.

Debug Logger Settings

The logger settings allow you to manage logging information.

loggerSettings.png

Log Level controls the level of information being sent to the log file. Off is lowest (nothing logged), and All is highest.

Max Log Size (Bytes) determines how large log files should be allowed to grow before a new file is started.

Configuration Administrator Credentials

Kinetic Task provides a configuration administrator user to manage the properties file. This account is NOT a Remedy account. By default, the user and password is admin/admin, but we highly recommend changing at least the password.

credentials.png

Config Admin User is the name of the configuration admin user account.

Edit Password, if checked, you will be able to modify the password associated with the Config Admin User.

Task Engine

Tasks are stopped and started from this page. Task Handlers are loaded/cached on boot and when you load new or edit existing task handlers, you'll want to top and start the Task Engine. Important note for users of multiple webservers: You must go to each individual server to stop and start Tasks for that server. 

EngineStopStart.png

Environment

This tab is information about the Task Engine configuration and it's dependencies. All of this information can be useful when troubleshooting issues with the Task Engine.

The License Information section displays the license type and expiration date.

The System Information section displays the details about the system the Task Engine is installed on.

The Server Information section displays the details about the web server (ex. Tomcat or Websphere) that the Task Engine is installed on.

The Adapter Information section displays the details about the Remedy system the Task Engine is connected to/installed on.

The Dependencies section lists the versions and locations of files/programs the Task Engine needs to function.