User Guide

Introduction

SMA Connector for SCSM allows you to automate specific activities from a work item by using a SMA runbook. It works the same way as the out of box SCORCH connector does, but allows you to use the newer SMA automation platform.

Main Features:

  • Used to trigger a SMA runbook for it process automation
  • New activity type that can be directly integrated in processes (e.g. service or change requests)
  • Checks status of triggered runbook and updates status in Service Manager

Installation

Installation

The installation is performed using the management pack import functionality of SCSM. Please refer to the Microsoft TechNet Library for more information on how to import management packs:

http://technet.microsoft.com/en-us/library/hh524269.aspx

Follow these steps to install itnetX SMA Connector for SCSM:

  1. Log on to SCSM Workflow server using an account with administrative privileges in SCSM. The SCSM Workflow Server is by default the first SCSM Management Server installed.
  2. For SCSM 2012, copy the \2012\itnetX.SMAConnector.Workflows.dll, for SCSM 2016, copy the \2016\itnetX.SMAConnector.Workflows.dll to the SCSM installation directory. By default, this is C:\Program Files\Microsoft System Center 2012\Service Manager\ for SCSM 2012 (including SP1), C:\Program Files\Microsoft System Center 2012 R2\Service Manager\ for SCSM 2012 R2, and C:\Program Files\Microsoft System Center\Service Manager\ for SCSM 2016.
  3. For SCSM 2012, import the itnetX.SMAConnector.2012.mpb management pack.
    For SCSM 2016, import the itnetX.SMAConnector.2016.mpb management pack.
  4. Import the itnetX.SCSM.Licensing.Library.mpb Management Pack into your SCSM environment.
  5. Import the itnetX.SCSM.SMAConnectorv1.LicenseInfo.mp or the itnetX.SCSM.scsmProdPackv1.LicenseInfo (Bundle license for Productivity Pack) Management Pack into your SCSM environment.
  6. Restart the SCSM Console.

Configuration

Operaio SMA Connector for SCSM needs some additional configuration after the installation completes.

Create a new SMA Connector

Follow the steps below to create a new SMA Connector after the installation:

  1. In the console navigate to Administration -> Connectors
  2. In the Tasks pane click Create connector -> itnetX SMA Connector
  3. Enter a Name and optionally a Description for the connector. Check the Connector Enabled checkbox, if the connector should be enabled after creation and specify the interval for the runbook synchronization with SMA:
  4. In the connection tab, enter the URL of the SMA Web Service.
    Sample for SMA Web Service URL: https://SIXSMA01.ix.lab:9090/
  5. Optionally specify a Runbook filter to filter the runbooks which should be synchronized from SMA.
    The following example excludes all “Sample” Runbooks:
    startswith(RunbookName, 'Sample-') eq false
  6. Choose the status which should be used in SCSM for Suspended runbooks (default is failed)
  7. Select an existing Run As Account for the SMA Connection or create a new one by using the New… button.
    Note: The needed rights for the SMA Run As Accounts are: Read and Execute rights for jobs in SMA.
  8. If you want to ignore SSL Errors from your Web Service URL, check the Ignore SSL Errors box.
  9. With the Test… button you can test the connection and review the list of available runbooks in SMA:

    The output of the test can look like the following:
  10. When the connection was successful save the connector by pressing OK.

Modify a SMA Connector

If you need to change setting of the SMA Connector after creation you can follow the steps below:

  1. In the console navigate to Administration -> Connectors
  2. Select the SMA Connector from the list and double click it
  3. Now you can modify the settings of the SMA Connector. When you’re done you can save the new configuration.

Delete a SMA Connector

If you want to delete an existing SMA Connector you can follow the steps below:

  1. In the console navigate to Administration -> Connectors
  2. Select the SMA Connector you want to delete and click Remove in the Tasks pane:

Create SMA Activity Template

In this section we’re going to describe how to configure a new activity template for a runbook which was synchronized from SMA. This activity template can be used in, for example, a Service Request or Change Request. To create a new activity template you can follow the steps below:

  1. In the console navigate to Library -> itnetX SMA -> All SMA Runbooks
  2. Select the runbook from the list for which you want create an activity template.
  3. Click Create activity template in the Tasks pane
  4. Enter a Name and optionally a Description for the Template and select a Management pack, where it should be saved
  5. In the General Tab of the activity form, specify a Title and select if the runbook should be Ready for Execution. If this property is set the runbook will execute right after the activity is in progress. If it is not set, an analyst needs to manually check this attribute.
  6. In the Runbook section you can map the parameters which are used in this runbook:
  7. When you’re done you can save the activity by pressing OK.

Do not use the Apply button as this can cause issues with the template.

Use SMA Activity Template

In the following we’re going to describe how to use the previously created SMA Runbook Activity template. In this example we will use this activity for a Service Request:

  1. In the console move to the Work Items section and create a new Service Request
  2. Enter the needed information for the Service Request like Title, Urgency, etc. and move to the Activities tab.
  3. Add a new Activity by pressing the + button:
  4. Select you previously created SMA Runbook Activity template:
  5. Review the settings and save it by pressing OK
  6. To review the output, when the activity has completed, you can open the Service Request move to the Activities section and double click the activity.
  7. In the activity form under the Runbook tab, you can see the job output: