Back to BMC Remedy Integrations
Handler · Version 1

BMC ITSM7 Work Order Work Info Create CE BMC Remedy

Download GitHub

About

Creates Work Info entries related to a Work Order. The relationship is established by placing the Work Order ID in the 'Work Order ID' field on the 'WOI:WorkInfo' form.

The Include Review Request parameter invokes a method that builds and places a link in the Notes field on the Work Info entry. When this link is clicked, the original service request submission is opened in the read-only Review Request mode.

The Include Question Answers parameter invokes a method which builds a question and answer pair display of the service request submittal. These data elements are placed in the Notes field of the Work Info entry. This provides a quick view of the triggering service request submittal data.

The Work Info entry accommodates up to three file attachments. When configuring the task, this handler expects the value Menu Label of the attachment question. The handler will use this name to locate the attachment file within the Remedy forms of the Kinetic Request application. If more than three attachments are needed, it is recommended to create additional Work Info entries.

The following data is used to create the 'WOI:WorkInfo' record:

  • Sets the 'Detailed Description' field to a concatenation of the following:

    • The URL link to the Review Request view of the triggering Kinetic Request submission (if provided).
    • The value of the "Work Info Notes" parameter.
    • The formatted string of Question name to full answer pairs (if provided).
  • Sets the 'Work Order Entry ID' field to the result of a lookup to the WOI:WorkOrder form. The lookup is done using the work order id parameter and the resulting entry's request id is used.

  • Attaches the files associated to the specified Attachment field menu label parameters to the specified fields:

    • 'z2AF Work Log01' => "Attachment Question Menu Label 1"
    • 'z2AF Work Log02' => "Attachment Question Menu Label 2"
    • 'z2AF Work Log03' => "Attachment Question Menu Label 3"
  • Sets the following field values to the specified values:

    • 'Secure Work Log' => "No"
    • 'View Access' => "Internal"
    • 'Communication Source' => "Web"
    • 'z1D Previous Operation' => "SET"
    • 'Status' => "Enabled"
    • 'Work Log Type' => "General Information"
  • Sets the following field values to the values of the specified parameters:

    • 'Work Order ID' => "Work Order ID"
    • 'Description' => "Work Info Summary"
    • 'Detailed Description' => "Work Info Notes"
    • 'Work Log Date' => "Work Info Submit Date"
    • 'Work Log Submitter' => "Submitter"
Configurations
Name Description Sample
api_server Kinetic Request CE API Web Application http://server:port/kinetic
api_username Name of user account that has permission to use the API
api_password Password for the API user *********
space_slug Slug of the Space where the User will be created.
ars_server Remedy Server Name or IP Address
ars_username Remedy Login Name
ars_password Remedy Password *********
ars_port Remedy TCP Port 0
ars_prognum Remedy RPC Prognum 0
ars_authentication Remedy Authentication String
enable_debug_logging Enable debug logging if the value is set to 'Yes'. No
Parameters
Name Description Sample
Work Order ID: The work order id number of the work order to associate the Work Order Work Info entry with.
Include Review Request: Option to prepend the review request URL to the Notes of the Work Order Work Info entry.
Include Question Answers: Option to append the question answer pairs to the Notes of the Work Order Work Info entry.
Work Info Summary: Sets the Summary of the Work Order Work Info entry.
Work Info Notes: Sets the Notes of the Work Order Work Info entry.
Work Info Submit Date: Sets the Date of the Work Order Work Info entry.
Attachment Input Type Choose Field if the input for the attachment info as a Field Name or choose JSON if the input is an attachment's JSON from the Get Attachment Info handler. Note that if Field is specified, the fields entered should only allow one attachment. Field
Attachment Field 1: The Field Name of an attachment question to retrieve an attachment from.
Attachment Field 2: The Field Name of an attachment question to retrieve an attachment from.
Attachment Field 3: The Field Name of an attachment question to retrieve an attachment from.
Attachment JSON 1: The Field Name of an attachment question to retrieve an attachment from.
Attachment JSON 2: The Field Name of an attachment question to retrieve an attachment from.
Attachment JSON 3: The Field Name of an attachment question to retrieve an attachment from.
Submitter: Sets the Submitter of the Work Order Work Info entry.
Locked: Sets the Work Order Work Info entry Locked status.
View Access: Sets the Work Order Work Info entry to Public or Internal.
Work Info Source: Sets the Work Order Work Info Communication Source value. Options include to Email, Fax, Phone, Voice Mail, Walk In, Pager, System Assignment, Web, and Other.
Work Info Type: Sets the Work Order Work Info Type value. Many options exist for this field. The most commonly used is 'General Information'
Submission ID: The id of the CE submission to retrieve answers for.
Space Slug: Can be used to override the info parameter provided.
Results
Name Description
Entry Id The Request Id of the generated Work Order Work Info entry.
Changelog

BMCITSM7WorkOrderWorkInfoCreate_CE (2016-07-20)

  • Initial version. See README for details.
Download GitHub

On This Page

Looking for a workflow engine? Learn more about the Kinetic Data Enterprise Workflow Platform. Check it out
Return to Top