Application Integrations Tutorial - Creating a Change

Document created by Sarah Nielsen Employee on Jan 24, 2017Last modified by Sarah Nielsen Employee on Jan 24, 2017
Version 3Show Document
  • View in full screen mode

Application Integrations Tutorial

This tutorial will walk you through the example of Creating a Change with the Application Integrations feature by utilizing the Samanage RESTful API. This example will contain the action intended as well as the contents intended for the various sections of the Application Integrations setup.

 

Before integrating with the Samanage API, you will need to add the integration within the “Application Integrations”  setup menu within the Setup section.

 

Let’s jump into the example!

 

Creating a Change

The Application Integrations feature will allow you to create a change within your Samanage account as the part of your Service Catalog workflow. This can be helpful when using the Service Catalog to assist with requesters being able to create changes from the Service Portal. When creating a change request Service Catalog item, you can automatically create the change within the Changes section in Samanage. The following example outlines the process of creating a change within a change request Service Catalog item.

 

The following variables have been defined within the Service Catalog “Variables” menu for this item and will be used to capture the requester's input when submitting this service request.

 

  • Change Title (text field)
  • Change Description (text field)
  • Change Plan (text field)
  • Test Plan (text field)
  • Rollback Plan (text field)
  • Planned Start (date field)
  • Planned End (date field)

 

In order to use the Application Integrations feature with the Samanage API, you will need to utilize the “Name”, “Application”, “HTTP Method”, “URL”, “Additional Headers” and “Body” sections of the Application Integrations setup menu within the Service Catalog item. The following section will guide you through the contents that you will need to enter for each section based on this example.

 

Name

Name: each Application Integration item within the process workflow will require a name

 

Application/HTTP Method

Application: Samanage

HTTP Method: POST

 

URL

URL: https://api.samanage.com/changes.xml

 

Additional Headers

Name: Content-Type

Value: application/xml

 

Body

<change>

  <name>{{Change Title}}</name>

  <requester><email>{{Requester}}</email></requester>

  <state>Open</state>

  <description>{{Change Description}}</description>

  <priority>Medium</priority>

  <change_plan>{{Change Plan}}</change_plan>

  <rollback_plan>{{Rollback Plan}}</rollback_plan>

  <test_plan>{{Test Plan}}</test_plan>

  <planned_start_at>{{Planned Start}}</planned_start_at>

  <planned_end_at>{{Planned End}}</planned_end_at>

  <site><name>{{Site}}</name></site>

  <department><name>{{Department}}</name></department>

</change>

1 person found this helpful

Attachments

    Outcomes