Kinetic Request Approval Create Version 4

The approval submission record, stored in the KSSRVCustomerSurvey_base form, is created to interact with the Kinetic Request approval process (see the Request Manager Training Manual for more information on Kinetic Request approvals). This handler retrieves the submission record that has an 'Instance Id' that matches the 'Lookup Id' parameter and copies the data necessary to execute the Kinetic Request approval process.

  • Copies the 'Lookup Id' parameter into the 'Lookup Value Id' field.

  • Copies all of the attribute field values.

  • Copies various required core fields (including 'ApplicationName', 'AssigneeGroup', 'Category', 'CategoryInstanceID', 'Company ID', 'Company Name', 'DataSet', 'Form', and 'SurveyMethod').

  • Copies the OriginatingID and OriginatingID_Display fields from the originating submission record.

  • Sets the 'Originating Form' field to the value of the SuveyTemplateName on the originating submission record.

  • Sets the 'Submission Type' field to "Approval".

  • Sets the 'ng_EndpointSecret' field to the deferral token of this task.

  • Sets the MessageTemplateInstanceID to the Instance Id of the message template (KSMSGMessageTemplate records, configurable from the Service Catalog Console) that was specified by the 'Message Template Name' parameter.

  • Sets the SurveyInstanceID field the the Instance Id of the service item that was specified by the 'Approval Template' parameter.

  • Maps the following approval field values from the specified info values:

    • 'ValidationStatus' => "Initial Validation Status"
  • Maps the following approval field values from the specified parameters:

    • 'Contact Info Value' => "Approver Email"
    • 'First Name' => "Approver First Name"
    • 'Last Name' => "Approver Last Name"
    • 'Submitter' => "Approver Login"
    • 'Survey Template Name' => "Approval Template Name"
    • 'NotesForCustomer' => "Notes for Customer"

Parameters

Name Description
Approver Login: The Remedy login name of the approver.
Approver Email: The email address of the approver.
Approver First Name: The first name of the approver.
Approver Last Name: The last name of the approver.
Message Template Name: The name of the message template to use for the approval.
Approval Template Catalog Name: The name of the catalog the template for approval belongs to.
Approval Template Name: The name of the template to use for the approval.
Lookup Id: The instance id of the Kinetic Request submission that is being approved.

Sample Configuration

Name Description
Approver Login:
Approver Email:
Approver First Name:
Approver Last Name:
Message Template Name:
Approval Template Catalog Name:
Approval Template Name:
Lookup Id:

Results

Name Description
Instance Id The Remedy Instance Id of the generated approval submission. This value is available immediately upon creation of this node.
Validation Status The validation status of the completed approval submission. This value is not available until the deferring process completes this node.

Changelog

KineticRequestApprovalCreate_V4 (2014-12-08)

  • Added new 5.2 fields. NOTE: This is NOT backwards compatible.

KineticRequestApprovalCreate_V3 (2013-08-17)

  • Removed 'Approval Question Label', 'Approval Value', and 'Denial Comments Label'

parameters. These were in place for old Kinetic Request workflow that

automatically created task triggers when the approvals were completed.

Now the task engine is used to create these triggers therefore these values

are obsolete.

  • Removed the 'Notes For Customer' parameter, it is not commonly used in newer

implementations.

  • The 'Message Template Name' parameter is no longer required when configuring

this handler. If no message template is specified the Approval record

will need to be set to a "Sent" status manually for most portal pages to

work properly.

KineticRequestApprovalCreate_V2 (2010-03-18)

  • Set the Approval Template Catalog Name parameter to default to the current

catalog, but it can also be changed to use an approval form from another

catalog.

  • Added additional 'Validation Status' deferred variable to the node.xml file to

represent the value of the completed approval submission validation status.

  • Modified how OriginatingID and OriginatingID_Display are retrieved so that

OriginatingID_Display is properly retrieved.

  • Remapped the 'Form' attribute to properly populate based on the

'SuveyTemplateName' of the originating request.

KineticRequestApprovalCreate_V1 (2010-12-01)

  • Initial version. See README for details.


Related Handlers

KAPP Assignment Group Membership Lookup
Retrieves the login and email information for the assignee or group members of the specified group.
Kinetic Assignment Record Update
Updates the Request Due Date, Work Order Due Date, and/or Priority field(S) on a specific record from the KS_RQT_Assignment form.
Kinetic Cost Calculate Costs
Returns an XML listing record ids found in the KS_SRV_Helper form.
Kinetic Helper Record Find All
Returns an XML listing record ids found in the KS_SRV_Helper form.
Kinetic Request Answer Create
Creates a Submission Answer
Kinetic Request All Answers Retrieve
Retrieves Submission Answers
Kinetic Request Attribute Create
Populates Attributes Records (Settings Tab) for Service Items from a CSV data file
Kinetic Request Checkbox To XML
This handler converts a Kinetic Request checkbox answer into an XML string.
Kinetic Request Email Message Create
Creates a Kinetic message record using the specified message template. Once the Kinetic Request message poller process the record, an email message is generated and sent to the target recipient.
Kinetic Request Service Item Add Attribute
This handler adds an attribute to the given service item.
Kinetic Request Service Item Detect Attribute
This handler checks to see if a specific attribute is defined for the given service item.
Kinetic Request Service Item Detect
This handler checks to see if a given service item already exists.
Kinetic Request Service Item Remove Attribute
This handler removes a specific attribute that is defined for the given service item. If multiple instances of the same attribute are defined for the same service item, they are all removed.
Kinetic Request Service Item Rename
This handler renames a given service item.
Kinetic Request Service Item Update Status
This handler updates the status of a given service item.
Kinetic Request Base Submission Retrieve
Retrieves a specific Kinetic Request base record from the KS_SRV_CustomerSurvey_base form.
Kinetic Request Submission Build Attachment URL
Builds and returns URL for a file download of an attachment that was uploaded as a question answer.
Kinetic Request Submission Build Review Request Url
Builds and returns the URL that corresponds to a review request view of the desired Kinetic Request submission.
Kinetic Request Submission Close All Open
Updates the Validation Status, the status that is displayed to the end user, of the specified submission record and sets the Request Status to "Closed" for all open requests associated with the provided originating ID.
Kinetic Request Submission Close
Updates the Validation Status, the status that is displayed to the end user, of the specified Kinetic Request submission record and sets the Request Status to "Closed".
Kinetic Request Submission Create Answers
This handler creates answer records related to the specified submission given one or multiple JSON answer sets.
Kinetic Request Submission Create
Creates a new base submission using the information specified.
Kinetic Request Submission Dataset Retrieve
Returns all dataset values for a given submission. For use inside of subtrees.
Kinetic Request Submission Format Answers HTML
Builds a simple result string by formatting a specified subset of answers for the source Kinetic Request submission.
Kinetic Request Submission Format Answers
Builds a simple result string by formatting a specified subset of answers for the source Kinetic Request submission.
Kinetic Request Submission Get Answer Set
This handler builds a JSON answer set for the current submission. The JSON structure maps question labels to their corresponding answers.
Kinetic Request Submission Update Answers
This handler creates or update answer records related to the specified submission given one or multiple JSON answer sets.
Kinetic Request Submission Update Status 7
Updates the Status field (ID 7 not validation Status).
Kinetic Request Submission Update Status
Updates the Validation Status, the status that is displayed to the end user, of the specified Kinetic Request submission record.
Kinetic Submission Complete
Sets a submission to complete and triggers the complete workflow, such as firing triggers
Kinetic Submission Retrieve Attribute
Retrieves the Kinetic Request base request with the specified values
Kinetic Submission Update Attribute
Updates the Kinetic Request base request with the specified values
Kinetic Table Data Create
Creates an entry in the CUSTOM:KS_SRV_TableData_base form
Kinetic Tabular Data Find
Retrieves request IDs (field 1) and Instance IDs (field 179) for Remedy entries for the form used for storing table data.
Kinetic Tabular Data Retrieve
Retrieves a single CUSTOM:KS_SRV_TableData_base entry/saved table row with the instance id specified.