Service Manager Connexion Package


Specific to: Service Manager Oxygen 2.0 and later.

This package integrates a Self Help project providing a set of procedures or end points, to exchange information with Service Manager.

  • End points enable business users to search, create, modify and delete objects in Service Manager.
  • They are based on the methods of the REST API Service Manager.
  • They can only be used via parent procedures located in any other Self Help project in the domain. Open url.png See Advanced package use.
     

The package is delivered in the form of an archive to import into a Self Help domain.

  • Once installed, the file explorer of the Studio Edit mode displays a set of global objects, low level procedures and termination points grouped together by business object: Assets, Employees, Tickets etc.

Notes

  • You can use the connexion package with all the Self Help projects.
  • The package itself can not be used. End points are called by parent procedures using an alias. Open url.png See the list of end points.
  • The name of the connection package archive indicates the date and the environment.
        example EV|Integration|SM 201908|UAP

Connexion package composition

         Service Manager connexion package tree.png

(1): Global objects used to configure the connection package. Open url.png See the procedure.

(2): Low level procedures used by end points to exchange information with Service Manager.

(3): Help and configuration test procedures, as well as several use cases featuring end points. This folder can be imported and used separately by any other project in the same domain.

(4): All folders by business object (Actions, Assets, CI etc.) grouping end points used to exchange information with  Service Manager parent procedures located in any other project in the domain.

List of connexion package end points

Actions

Procedure Alias View
List of actions listActions REST method Advanced use:

Open url.png   Input / output parameters

Update an action updateAction REST method
End an action associated to a ticket finishAction REST method
List of actions to validate for an employee actionsToValidateByEmployee (advanced method)

Assets

Note: The Assets term includes equipment, licenses, contracts.

Procedure Alias View
Create an asset createAsset REST method Advanced use:

Open url.png   Input / output parameters

Update an asset updateAsset REST method
View an asset getAsset REST method
View a list of assets listAssets REST method
List of assets of an employee listAssetsEmployee (advanced method)
Search for assets searchAssets (advanced method)

Configuration items(CI)

Procedure Alias View
Create a CI createCI REST method Advanced use:

Open url.png   Input / output parameters

Update a CI updateCI REST method
View a CI getCI REST method
View a list of CIs listCIs REST method
Search for CIs searchCIs (advanced method)

Employees

Procedure Alias View
Create an employee createEmployee REST method Advanced use:

Open url.png   Input / output parameters

Update an employee updateEmployee REST method
View an employee getEmployee REST method
View a list of employees listEmployees REST method
Search for employees searchEmployees (advanced method)

Departments

Procedure Alias View
View a department getDepartment REST method Advanced use:

Open url.png   Input / output parameters

View a list of departments listDepartements REST method
Search for departments searchDepartments (advanced method)

Known errors

Procedure Alias View
View a known error getKnownError REST method Advanced use:

Open url.png   Input / output parameters

View a list of known errors listKnownErrors REST method
Search for known errors searchKnownErrors (advanced method)

Locations

Procedure Alias View
View a location getLocation REST method Advanced use:

Open url.png   Input / output parameters

View a list of locations listLocations REST method
Search for locations searchLocations (advanced method)

Manufacturers

Procedure Alias View
View a manufacturer getManufacturer REST method Advanced use:

Open url.png   Input / output parameters

View a list of manufacturers listManufacturers REST method
Seach for manufacturers searchManufacturers (advanced method)

Problems

Procedure Alias View
View a problem getProblems REST method Advanced use:

Open url.png   Input / output parameters

View a list of problems listProblems REST method
Search for problems searchProblems (advanced method)

Internal query

Procedure Alias View
Internal query InternalQuery REST method Advanced use:

Open url.png   Input / output parameters

SLA

Procedure Alias View
View a SLA getSla REST method Advanced use:

Open url.png   Input / output parameters

View a list of SLAs listSlas REST method
Search for SLAs searchSlas (advanced method)

Tickets

Note: The Tickets term includes incidents, service requests, change requests, investment requests.

Procedure Alias View
Create a ticket createTicket REST method Advanced use:

Open url.png   Input / output parameters

Update an action associated to a ticket createActionLinkToTicket REST method
Create a task for a ticket createTaskLinkToTicket REST method
Update a ticket updateTicket REST method
Resume a ticket restartTicket REST method
Suspend a ticket suspendTicket REST method
Close a ticket closeTicket REST method
Upload a document uploadDocuments REST method
View justification (comment) for a ticket getComment REST method
View a ticket getTicket REST method
View a list of tickets listTickets REST method
Create a closed ticket createClosedTicket (advanced method)
List of tickets for an asset listTicketsAsset (advanced method)
List of tickets for an employee listeTicketsEmployee (advanced method)
Search for tickets searchTickets (advanced method)

Procedures

How to install the Service Manager connection package

Step 1: Install the connection package

1. Download the file below to your workstation.
         Download icon.png Service Manager connection package

2. Go to the Studio Edit mode and import the file into a domain.
A new Self Help Service Manager project is created. All procedures are automatically added to the tree structure.

Step 2: Configure the connection package

    Open url.png See the procedure.

Step 3: Test the connection package

1. Copy the Examples and Help folder into the dedicated project.

2. Run a few procedures to make sure they work correctly.

How to configure the Service Manager connection package

1. Enter all the parameters of the oSetup variable indicated below, which are required to call the REST API Service Manager.
 

auth: Object containing all the information required for authentication.

  • password(): Password associated to the account.
  • type: Type of authentication (Basic, OAuth, etc.).
     

isActive: Indicates if integration into the project library is required (value true), or not (value false).

url: Object containing all server parameters.

  • account: Segment of URL for the account of the instance to integrate.
    • Default value: account 50005 - Sandbox.
  • api: Segment of URL for the API of the instance to integrate.
  • segment: Segments of URL for business objects.
    • Each segment is a pre-configured text.
  • server: Segment of URL for the server to integrate.
  • version: Segment of URL for the API version of the instance to integrate.

How to use the Service Manager connection package

    Open url.png See a use case: How to create a ticket in Service Manager.

Tags:
Last modified by Unknown User on 2020/05/14 11:21
Created by Administrator XWiki on 2019/12/10 17:21

Shortcuts

Recent changes
•  Service Manager
•  Service Apps
•  Self Help

Glossary

Powered by XWiki ©, EasyVista 2020