Skip to Content

Integration functions

The Submit, Modify, and Query functions are integration functions.

Related topics

Developing-integrations-by-using-SOAP-web-services

Integration-methods

Configuring-the-CAIPluginRegistry-form

Overview-of-the-platform-REST-API

Submit functions

Submit functions are used to create a record; for example, opening a form in New mode, and then saving it as a new record. Each subsection describing submit functions can contain the following tables:

  • Required input field values
    These fields are required and a record is not created if they have null values.
  • Optional input field values
    These fields are not required to create an entry, but they might need to be populated, depending on the status the entry to be created. (See the Notes column in each table for more information about specific fields).
  • Fields set by workflow
    The values in these fields are generated by workflow that is triggered by the input fields (required and optional) only. When using web services, they are not exposed to the user; for example, when you populate the Impact and Urgency fields, the Priority field value is calculated.
  • After a record is created successfully, the newly created record ID is returned.

Modify functions

The creation of work log entries is the only workflow triggered by a modify function. When using web services, if there are populated fields in the main form that you want to modify, specify those values in the corresponding web service fields.

Error
Warnings
  • If you specify a null value, the null value overwrites the value currently in the form.
  • There is no returned value to signal that a record has been modified.

Query functions

The query functions are web service-specific operations.
When you use web service functions, you must specify the ticket number on which to query (< module>Query_Service ), or a valid AR System qualification--if you query from a list of entries (< _module>_QueryList_service ).

The "LIKE" operator is used in the qualification of an unlimited character field length. This field type is stored as a CLOB in the database; for example, the Justification field on the Purchase Requisition.

Integrations between applications

BMC Helix ITSM applications provide a set of interfaces that can be used for integrations between applications.

Application interfaces

Reference

BMC Helix ITSM: Asset Management includes interface forms and web services. The BMC Helix CMDB API can be used for creating, modifying, and deleting CIs and relationships.

Change Management interfaces include a set of AR System forms that provide the ability to define, query, and modify both change requests and release requests.

The interfaces also include web services interfaces that are built on these forms to provide a mechanism for interacting with the BMC Helix ITSM: Change Management application by using web services. The interfaces, including web services, are available for both the BMC Helix ITSM: Change Management and Release Management modules.

The Incident Management and Problem Management interfaces include a set of AR System forms that provide the ability to define, query, and modify incidents. They also include web services interfaces that are built on these forms to provide a mechanism to interact with the Incident Management feature by using web services.

Important: To avoid breaking legacy integrations, any AR System user can create tickets in BMC Helix ITSM, without complete Incident permissions or Incident Management user license to create tickets. For example, an event occurs in an event management system that causes the web services client to connect to BMC Helix ITSM and create an Incident. In this case, the user is not an incident user but an AR System user who can create.

 

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

BMC Helix ITSM 25.4