Skip to main content
Kinetic Community

Admin

Collection of consoles including setup, licensing, logs, and importing and configuring Handlers and Sources. IMPORTANT: Many of these properties relate to just this instance of the Task Engine. If you need to change multiple instances you need to login to those specific task

Engine

This console has the single purpose of starting and stopping the task engine. It will only affect the engine on the same web instance, not all instances related to a database. Use the buttons on the right side of the page to Start or Stop the task engine.

admin_engine.png

Unlicensed Mode

When you first start Kinetic Task (using the instructions above) it will be running in unlicensed mode. In unlicensed mode there will be an orange bar on the top of the page, notifying you that Kinetic Task has not been licensed.

Besides the orange bar there is also a technical limitation to unlicensed mode. The Task Engine will only process so much work at a time. After the set amount of work has been processed (25 runs) the engine will stop and need to be restarted manually via the consoles.

When the engine has stopped for this reason, there will be another message displayed beneath the orange Unlicensed bar.

To restart the engine you can click the Engine link in the message, or you can select the Admin tab on the top and then the Engine tab on the left. This will take you to the Task Engine page.

task_engine.png

 

Setup

Includes four dialogs that relate to initial install of Kinetic Task and any changes that could be made.

System

Contains Properties about the task engine that are saved to the database. These are originally set during the install.

admin_setup_system.png

Sleep Delay. Number of seconds that engine waits before checking for new triggers.

Max Threads. Number of current workers. Setting to 0 defaults to one meaning triggers are processed one at a time. More than one thread will process that many triggers simultaneously.

Trigger Query. Default is 'Selection Criterion'=null. Change this value to have this engine only process triggers with the set value. Trigger creation must include the specified value.

Configurator Username & Password. Update the default username|password used to originally access the consoles during install. Default values are admin|admin.

Log Level. Determines the amount of information created in the log. The three levels are:

  • INFO. Least amount. Common Production setting.
  • DEBUG. Common Development setting.
  • TRACE. As much information as possible. Common Troubleshooting setting.

Log Size. Set in MB. Logs are available from the Logs link on the left side of the page.

License

Holds the license key and information about the key including Company and expiration. Export License button exports the key and associated information as a text file. Potentially used for troubleshooting or database updates. Import License requires a specific format and has internal error checking.

admin_setup_license.png

Authentication

Determines what system is used to authenticate to the Task Engine and Consoles. The application comes with a basic authenticator using the User information from the Permissions console. Changing the Authenticator drop-down to Proxy and providing different information in the Authenticator JSP could allow the use of SSO.

admin_setup_authentication.png

Change Database

Clicking the Change Database button will run a portion of the install process to connect the web instance to a new database. You are responsible to make sure that the database is running, compatible, and ready for the install process. Warnings are posted on this panel.

Sample screen with the included H2 database

** IMPORTANT NOTE ** Kinetic Task comes with an embedded H2 database to make it easy to get started. This database is not meant for Production Use. Until you configure Kinetic Task for a there will be a warning message displayed at the top of each page, and a more detailed error on the Change Database console.

Clicking on the Change Database button starts the process of configuring Task to point to another database. Three other database options are available, Oracle, Microsoft SQL Server and PostgreSQL.

Here are examples of the dialogs for Microsoft SQL Server and Oracle:

task4_admin_setup_db_sql_server.png              task4_admin_setup_db_oracle.png

Before you can use another database, you need to have two things done by your DBA.

  1. Database needs to be created. In Oracle this is called a Tablespace. In SQL Server and Postgres it is a Database.
  2. A user - DB Owner must be created for the Database or Tablespace so the database create process has the rights to create and manage tables.

Load balancing Task is simple. Each engine is installed separately and then they are connected to the same database. You do not have to put a load balancer in front of the Task web servers, just configure each Task engine to the same source. Having each Task engine connected to the same database will stop any duplicate record processing.

Sources

Sources define the inputs to the task engine. You provide a name and policy rule for each source.

The base Kinetic Task source has a type of Kinetic Task. All other sources have a type of Adhoc. An initial Playground source is included with the install. See the Getting Started Guide for specifics.

Example list of Sources:

admin_sources_list.png

Example Details:

admin_sources_details.png

Use the table at the bottom to add/remove policy rules to the source.

 

Categoriesadmin_category_new.png

Categories are used to put task handlers into logical groups. They can also be used to restrict access via Policy Rules. The list of Categories can be sorted by Category name and date. Click on Delete and confirm to remove the Category.

Clicking on either the Add New Category or the category name brings you to the same New/Edit dialog.

Name. Unique and required. Value must be less than 255 characters. Categories are not shown on the builder unless they contain task handlers.

Description. Optional descriptive text for your category.

Handlers Tables. Select or remove Handlers for use in trees.

Routines Tables. Add or remove Routines for use in trees

Policy Rules. Apply rules to limit access, on the tree builder, to this category.

 

Environment

This console is broken into four sections, License, System Information, Server Information, and Adapter Information. Much of the information here is useful during troubleshooting, maintenance, and upgrades.

License

This is the same information as the License panel in the Setup console without the ability to add or export a license key.

System Information

Includes information on the operating system, java, and available memory.

Server Information

Information on the web server that is hosting the task instance.

Adapter Information

Information on the database adapter and the database being used.

Logs

Five different logging options are available from this console, Engine, Manager, Setup, Download Worker, and Download All. The first three options (non-download) open the log in a new tab/window. The amount of information in the log is controlled on the Setup console. There are 10 backups kept of each log (.0 through .9). Depending on setting, environment and other factors the logs can roll over very quickly.

Engine Logs

Contains the actions that the engine is taking including exceptions and stack traces. This log is helpful for troubleshooting trees and handlers.

Manager Log

This log displays information related to the task consoles like changes to privacy rules, permission issues, and user authentication. It is useful when troubleshooting any issues with the console(s).

Install Log

Information related to the install of the application.

Download Worker Logs (.zip)

Collection of all the information on engine processing.

Download Logs

The download options will include all the backup copies of the logs selected.

System Errors

Errors unrelated to trees or handlers. Format is the same as errors from handlers but they cannot be retried.