This documentation supports the 21.05 version of BMC Service Level Management. To view an earlier version, select the version from the product version menu.

Integrating BMC Service Level Management with third-party applications by using SOAP web services

See the following sections for information on how to use BMC Service Level Management(Service Level Management) web services and how to display Service Level Management status in custom applications:

  • Registration of Service Level Management web services
  • Customizing published Service Level Managementweb services


Registration of Service Level Management web services

During the installation of Service Level Management, the web services are registered using the AR System Web Services Registry form. After installation, you can register additional web services by entering data in this form.

The entries in the AR System Web Services Registry form for Service Level Management are shown in the following table. 

Fields on the AR System Web Services Registry form

Field name

Field value

Business Name

BMC

Application Name

SLM

Description

A short description of the service (typically the expanded name of the web service)

Web Service

The name of the web service

Version

1.0

Build WSDL URL

Yes

Web Server Address

The mid tier address, for example*

http://*midTierServer:portNumber

MidTier Root

arsys

ARServer

The name of the AR System server

WSDL URL

The URL to access the WSDL

Build End Point URL

Yes

Web Server Address

The Mid Tier address (including port number)

MidTier Root

arsys

ARServer

The name of the AR System server

End Point URL

The URL of the end point to access the web service

Publish to Registry

Yes

Recommended Value

Yes

Registration Status

The status of the registration of the web service

Access the WSDL and the web services with the following URLs:

  • WSDL—http://*midTierServer:portNumber/arsys/WSDL/public/*ARServerName/webServiceName
  • End point for BMC SLM web services—http://*midTierServer:portNumber/arsys/services/ARService?server=*ARServerName&webService=webServiceName/

Customizing published Service Level Management web services

Service Level Management web services require a web services client and use the SOAP protocol. The web services provide Get operations to retrieve data for reporting. You can customize these published web services to meet your business requirements.

The following web services are provided:

  • SLA compliance status
  • Service targets list based on goal
  • Service targets related to agreement
  • Contracts related to agreement

Compliance Status (Get)

The following table provides details of BMC SLM SLM_SLAList_ComplianceStatus web service:

Name

SLM_SLAList_ComplianceStatus

Form

SLM: SLACompliance

Operation

Compliance Status (Get)

Request parameters

  • SLA Name (String)
  • Review Period (Selection)

Response parameters

  • Compliance Status
  • SLA Name
  • Impact Cost
  • Penalty/Reward
  • Met Percent
  • Performance Goal
  • Review Period

Qualification

SLAName' = XPATH(/ROOT/@SLAName) AND 'EventFrequency' = XPATH(/ROOT/@ReviewPeriod) AND 'MeasurementDone' = "No"

AgreementList (Get)

The following table provides details of BMC SLM SLM_SLAList_ComplianceStatus web service. 

Name

SLM_SLAList_ComplianceStatus

Form

SLM: SLACompliance

Operation

AgreementList (Get)

Request parameters

  • Compliance Status (Selection)
  • Start Time (Date Time)
  • End Time (Date Time)

Response parameters

List of Agreements with

  • SLA Name
  • Met Percent
  • Compliance Target
  • Compliance Met
  • Compliance Status

Qualification

ComplianceStatus' = XPATH(/ROOT/@ComplianceStatus) AND ( 'CalculateNowDateTime' >= XPATH(/ROOT/@StartTime) AND 'CalculateNowDateTime' <= XPATH(/ROOT/@EndTime) ) AND 'MeasurementDone' = "No"

Relatedservice targetList (Get)

The following table provides details of BMC SLM SLM_Relatedservice targetList web service. 

Name

SLM_Relatedservice targetList

Form

SLM:SLAComplianceHistory

Operation

Relatedservice targetList (Get)

Request parameters

  • SLA Name (String)
  • Review Period (Selection)

Response parameters

List of Service Targets with

  • service target Name
  • service targetPeriodStatus
  • GoalType
  • Met Percent
  • Performance Goal
  • Review Period
  • SLAName
  • SLA ID

Qualification

SLAName' = XPATH(/ROOT/@SLAName) AND 'EventFrequency' = XPATH(/ROOT/@ReviewPeriod) AND 'MeasurementDone' =
"No"

Service targetList (Get)

The following table provides details of BMC SLM SLM_service targetListbasedonGoal web service.

Name

SLM_service targetListbasedonGoal

Form

SLM: Measurement

Operation

service targetList (Get)

Request parameters

  • Goal Status (Selection)
  • Start Time (Date Time)
  • End Time (Date Time)

Response parameters

List of Measurement Records with

  • service target Name
  • service target ID
  • Status
  • Goal Type
  • Ticket ID/Asset ID

Qualification

MeasurementStatus' = XPATH(/ROOT/@MeasurementStatus) AND ('OverallStartTime' >= XPATH(/ROOT/@StartTime) AND 'OverallStartTime' <= XPATH(/ROOT/@EndTime) ) AND 'MeasurementDone' = "No" AND 'Lastservice targetMeasurement' = "Yes"

Service targetstatus(Get)

The following table provides details of BMC SLM SLM_service targetListbasedonGoal web service.

Name

SLM_service targetListbasedonGoal

Form

SLM: Measurement

Operation

service targetstatus(Get)

Request parameters

  • service target Name (String)
  • Start Time (Date Time)
  • End Time (Date Time)

Response parameters

List of Measurement Records with

  • service target Name
  • service target ID
  • Measurement Status

Qualification

'service targetTitle' = XPATH(/ROOT/@service targetName) AND ('OverallStartTime' >= XPATH(/ROOT/@StartTime) AND 'OverallStartTime' <= XPATH(/ROOT/@EndTime) ) AND 'MeasurementDone' = "No" AND 'Lastservice targetMeasurement' = "Yes"

MeasurementList (Get)

The following table provides details of BMC SLM SLM_service targetListbasedonGoal web service.

Name

SLM_service targetListbasedonGoal

Form

SLM: Measurement

Operation

MeasurementList (Get)

Request parameters

  • service target Name (String)
  • Start Time (Date Time)
  • End Time (Date Time)

Response parameters

List of Measurement Records with

  • service target Name
  • service target ID
  • Status
  • Goal Type
  • Ticket ID/Asset ID

Qualification

'service targetTitle' = XPATH(/ROOT/@service targetName) AND ('OverallStopTime' >= XPATH(/ROOT/@StartTime) AND 'OverallStopTime' <= XPATH(/ROOT/@EndTime) ) AND 'MeasurementDone' = "No"

AgreementList (Get)

The following table provides details of BMC SLM SLM_ContractRelatedSLAs web service.

Name

SLM_ContractRelatedSLAs

Form

SLM:SLAComplianceConstract_Join

Operation

AgreementList (Get)

Request parameters

  • Contract Name (String)
  • Start Time (Date Time)
  • End Time (Date Time)

Response parameters

List of related Agreements with

  • Agreement Name
  • Met Percent
  • Compliance Status
  • Goal Type
  • SLA Type
  • Contract Name
  • Contract ID
  • Contract Status and other Contract Details

Qualification

'InstanceName1' = XPATH(/ROOT/ContractName) AND ( 'CalculateNowDateTime' >= XPATH(/ROOT/StartTime) AND 'CalculateNowDateTime' <= XPATH(/ROOT/EndTime) ) AND 'MeasurementDone' = "No"

ContractList (Get)

The following table provides details of BMC SLM SLM_ContractRelatedSLAs web service.

Name

SLM_ContractRelatedSLAs

Form

SLM:SLAComplianceConstract_Join

Operation

ContractList (Get)

Request parameters

  • Agreement Name (String)
  • Start Time (Date Time)
  • End Time (Date Time)

Response parameters

List of related Contracts with

  • Contract Name
  • Met Percent
  • Compliance Status
  • Goal Type
  • SLA Type
  • Agreement Name
  • Contract ID
  • Contract Status and other Contract Details

Qualification

'instanceName2' = XPATH(/ROOT/SLAName) AND ( 'CalculateNowDateTime' >= XPATH(/ROOT/StartTime) AND 'CalculateNowDateTime' <= XPATH(/ROOT/EndTime) ) AND 'MeasurementDone' = "No"


For information about AR System web services, see Publishing a web service.


Related topics

Customizing-BMC-Service-Level-Management-by-using-overlays

From the AR System online documentation:

Registering a web service

Registering, modifying, and de-registering web services

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*