Page tree
Skip to end of metadata
Go to start of metadata

You can create, enable, and update task templates for automation jobs by using a web service called TMS_TaskTemplateServiceInterface. 

The information helps you understand how a a task template is created for an automation job when an external automation system integrates with the BMC Remedy Change Management system. Task templates created using this interface are utilized in the Change-Initiated Job use case.

Using this interface, you can create a task template to publish details about automation jobs or you can update job details. For details about supported job types, see Selecting and configuring supported job types

The task template is associated by the change management system with a change record. To associate a task template with your change record, see  Relating predefined task group or task templates to a change request  in BMC Remedy Change Management 9.1 online documentation.

TMS_TaskTemplateServiceInterface web service

Use this web service to:

  • Create a task template to publish job details. 
  • Update a task template based on any updates in the job details.

Accessing the web service

You can access the TMS_TaskTemplateServiceInterface using a web service client. For example, using a client such as the SOAP UI, enter the web service URL in the following format to connect to the web service.

http://<midtier_server>:<port>/arsys/WSDL/public/
<ARservername>/TMS_TaskTemplateServiceInterface

For example:

http://myMidtierServer:8080/arsys/WSDL/public/
myARServer/TMS_TaskTemplateServiceInterface

Fields in TMS_TaskTemplateServiceInterface web service

Populate the following fields to create a task template or update these fields if any job definition is updated.

 FieldDescriptionMandatory for input by automation system
1SourceIDA unique ID of the source automation system that is creating the task template.Yes
2JobID

A unique ID of the automation job. 

Yes
3

JobType

The type of the job.Yes
4

JobName

The name of the job.Yes
5

JobDescription

The description of the automation job.Yes
6

JobDetailedDescription

The detailed description of the automation job that includes information about the derived values such as JobName, JobType, Schedule and Priority.Yes
7

JobVersion

The version of the job.Yes
8StatusThe status of the task template. The status can be either Enabled or Offline.
Yes

10

TemplateCategoryTier1

The category of task templates.

If you do not provide any input, the default value is Change Management System.

No
11LocationCompany

The location of the company.

If you do not provide any input, the default value is user company.

No
12Priority

The priority of the Request For Change (RFC), which can be High, Medium or Low.

If you do not provide any input, the default value is Medium.

No

Web service operations

In TMS_TaskTemplateServiceInterface, you use the TaskTemplate_ProcessInterfaceData operation to create or update task templates.

 Create a task template

 This function enables you to create a task template and populate details of the job. Ensure that you provide the following mandatory inputs required to create a task template:

  • Source ID
  • JobID
  • JobType
  • JobName
  • JobDescription
  • JobDetailedDescription
  • JobVersion
  • Status
 Update a task template

Using this function you can update an existing task template.

You can update the fields provided in the following table to update a task template:

Field NameAction
JobName

 

 

To update these fields, you need to disable the existing template and create a new task template with updated value.

JobDescription
JobDetailedDescription
JobType

JobVersion

You can update this field in the existing template, only if no values are provided in other job fields.
StatusYou can update the status of task template to Enabled/Offline.

Related topics

Service-oriented interface

Receiving change record updates