Skip to main content
Kinetic Community

KS TSK Seed (Remedy)

The KS_TSK_Seed form exposes Kinetic Task API calls via a native BMC® Remedy® form.

Details

The KS_TSK_Seed form provides a very simple interface for calling the Kinetic Task API.  The form has three tabs, the Start Triggers tab, the Deferral Triggers tab, and the Admin tab.  The first two tabs are used for calling the createStart and createDeferred API methods, and the Admin tab is used to track the overall process of the request.

At a high level, KS_TSK_Seed functions as a staging form that Remedy workflow can push to.  Filters on the KS_TSK_Seed form then validate the request and attempt to create the trigger.  If the API request was successful, the Trigger ID field will be populated with the id of the trigger that was created.  If the API request was not successful, such as when invalid parameters are provided, the Failure Reason field will be populated and a Kinetic Task exception record will be created.  This exception record will be visible from the Kinetic Task management console.  The filters on KS_TSK_Seed will never raise a Remedy error message, so pushing to KS_TSK_Seed will never cause calling workflow to fail.

The Status field is visible across all three tabs.  A status of New indicates that the API workflow should be executed when the record is saved.  A status of Failed indicates the API workflow processed the request and encountered an error (in which case the Failure Reason field will be populated).  A status of Completed indicates that the API workflow processed the request successfully (in which case the Trigger Id field will be populated).  The Handled status is not ever automatically set, and is intended to be manually set if an error was encountered and handled.

Start Triggers Tab

The Start Triggers tab contains all of the fields necessary to make call the createStart API method.  For additional details about the createStart API method and its parameters, please see the generic API Reference page.

KS_TSK_Seed-StartTriggers.png

Deferral Triggers Tab

The Deferral Triggers tab contains all of the fields necessary to make call the createDeferred API method.  For additional details about the createStart API method and its parameters, please see the generic API Reference page.

KS_TSK_Seed-DeferralTriggers.png

Admin Tab

The Admin tab contains the core system fields and fields used to track the overall process of the request (Trigger ID and Failure Reason).  Typically, this tab will not need to be used, but can be helpful when troubleshooting API integration issues.

KS_TSK_Seed-Admin.png

Integration Workflow

In order to integrate a Remedy application with Kinetic Task, workflow (IE and Active Link or Filter) needs to be written with a push fields action that creates a new request with the necessary fields.  As an example, a screenshot of the relevant Kinetic Survey task integration package workflow is shown below.

KS_TSK_Seed-SampleWorkflow.png