Maintenance outage for upgrade on Sunday, September 22

This site, docs.bmc.com, will be inaccessible for two hours starting at 8 AM CDT, Sunday, September 22, for a platform upgrade.

Page tree

Maintenance outage for upgrade on Sunday, September 22

This site, docs.bmc.com, will be inaccessible for two hours starting at 8 AM CDT, Sunday, September 22, for a platform upgrade.

Skip to end of metadata
Go to start of metadata

Integrating with Remedy Action Request System enables you to collect and search change and incident management data.

Use the following information to understand the integration process:

Before you begin

Ensure that you have a Remedy user with Administrator privileges to connect with the Remedy AR Server and at a minimum access one of the following applications based on the kind of data that you want to collect:

  • Change Management
  • Incident Management

The credentials of this user will be required while integrating with Remedy Action Request System and collecting change and incident management data.

Key steps to an effective integration

The following table describes the high-level steps involved in performing this integration.

See System requirements to understand the supported versions of Remedy Action Request System.

High-level stepsAdditional information
1Configure the REST API on the Remedy AR Server.

Configuring the REST API

Note: The connection type for which you configure the REST API must be same as the connection type of the Remedy AR server used for integration.

2

Integrate with Remedy Action Request System.

Integrating with Remedy Action Request System
3Start data collection.Collecting change management and incident management data
4Search and analyze the data collected.

Getting started with search

Search commands

Integrating with Remedy Action Request System

  1. Navigate to Administration > External Configurations.
  2. Select AR Configuration on the list at the top-left of your screen.

  3. Provide the following details and click Save.

    FieldInstruction
    External Configuration Name
    Provide a name to identify this external configuration.
    Connection type

    Select http or https depending on the connection type of the AR Server.

    Note: The connection type selected here must match the connection type for which REST API is configured.

    AR Host name/IP

    Provide the host name or the IP address to connect with the AR Server.

    Note: If you provide a fully-qualified domain name or host name, ensure that it resolves to the same IP as that of the computer that hosts the AR Server. 

    AR Host Port

    Based on the connection type, provide the HTTP or HTTPS port number to connect with the Remedy AR Server.

    For more information, see Communication ports and protocols.

    User nameProvide the user name to connect with the Remedy AR Server and one of the following applications (at a minimum):
    • Change Management
    • Incident Management
    PasswordProvide the password to connect with the Remedy AR Server and one of the following applications (at a minimum):
    • Change Management
    • Incident Management
    Get Applications

    Click to retrieve the applications from which you want to collect data. From the list displayed, select one or more applications.

    Note: With this integration, you can only collect change management and incident management data. Therefore, you can only retrieve Change Management and Incident Management applications.

Collecting change management and incident management data

After integrating with Remedy Action Request System, you need to create the Monitor using external configuration data collector to start collection of change management or incident management data. A single data collector can collect data from one application (change management or incident management application) only. To collect data from more than one application, you need to create those many data collectors. This applies even if you created an external configuration with both change management and incident management applications selected.

The following sections discuss various aspects related to data collection:

How is the collected data made available for search?

When data collection starts, data is indexed and made available on the Search page in the form of raw data and fields. Typically, a change management (or incident management) form contains a list of many entries (or fields). During data collection, a set of these entries is automatically collected. But from this initial set, a limited set is selected to be indexed and a further limited set is selected to be extracted as fields (name=value pairs) and displayed on the Search page.

For more information about the entries (or fields) collected, see List of entries (or fields) collected automatically.

Notes

  • Entries from the work notes section can only be indexed and displayed as part of the raw data (and not fields).
  • Data collected from configuration items (CIs) is displayed as the value of the HOST field (in your search results).
    This information can provide you additional context while troubleshooting issues.

Methods of customizing entries collected

As part of data collection, you can collect entries from the change and incident forms (or tickets) as well as associated work notes and configuration items (CI).

You can change the settings that govern the kind of entries (or fields) that must be collected from the change (or incident) forms and associated work notes and CIs.

To change these settings, you need to run the configureexternalfields CLI command. Changes made by running the command can be applied at a global level (for all data collectors) or at an individual data collector level.

At any given time, a minimum set of default fields are always extracted and displayed on the Search page. For more information about the default fields extracted, see About field extraction.

Note

By default, only computer system type of CIs (BMC_COMPUTERSYSTEM) are collected.

You can customize the CI types that must be collected by modifying the value of a setting (as explained in the following procedure).

To customize CI types to be collected

  1. Navigate to the computer hosting the Collection Station (or the Collection Agent) that you are using to collect Remedy data.
  2. Based on the agent type that you are using to collect data, go to the customizable location of the agent.properties file of the Collection Station (or Collection Agent).
    For more information, see Modifying the configuration files.
  3. Edit the agent.properties file and add the following properties:

    Type of dataProperty
    Change

    ar.application.change_management.host.field.class=Lookup Keyword#BMC_COMPUTERSYSTEM

    ar.application.change_management.host.field=Request Description01

    Incidentar.application.incident_management.host.field.class=Lookup Keyword#BMC_COMPUTERSYSTEM

    ar.application.incident_management.host.field=Request Description01

    In the preceding table, the following definitions apply:

    • Lookup Keyword indicates the CI field name which determines the class ID based on which the CI type (or class value) is determined.
    • The value after the hash sign (BMC_COMPUTERSYSTEM) indicates the CI type (or class value) corresponding to the class ID (Lookup Keyword).
    • Request Description01 indicates the CI field name that determines the host name that must be displayed as the value of the HOST field (in the search results).

  4. Change the value after the hash sign (#). To collect additional CI types, you need to specify a comma-separated list.

    Note

    If you customize the Lookup Keyword and Request Description01 field names by using the configureexternalfields CLI command, then you need to ensure that you update the new CI field names as well as the value after the hash sign.

    Example

    ar.application.change_management.host.field.class=Lookup Keyword#BMC_VIRTUALSYSTEMENABLER


    ar.application.incident_management.host.field.class=Lookup Keyword#BMC_COMPUTERSYSTEM,BMC_CLUSTER

  5. Restart the Collection Station (or Collection Agent).

    For more information, see Starting or stopping product services.

List of entries (or fields) collected automatically

During data collection, the following set of total entries are automatically collected from the change management (or incident management) form. These entries are derived from the response received when you run the REST API for getting details of all entries on a form. For more information, see REST API for getting details of multiple entries.

Change and incident management form entries (or fields) collected automatically

The following tables provides the list of entries (or fields) collected from the change and incident tickets (or forms). Also, these tables provide information about the entries that are displayed as fields as part of the search results.

The field settings can be changed by running the configureexternalfields CLI command CLI command.

Change Management

Entry name (in Remedy)1

Displayed as part of fields (in the search results)?

Field name (in IT Data Analytics)

Assigned Support CompanyYesAssigned_Support_Company
Assigned Support OrganizationYesAssigned_Support_Organization
Categorization Tier 1NoNot applicable
Categorization Tier 2NoNot applicable
Categorization Tier 3NoNot applicable

Change Request Status

YesChange_Request_Status
Change TimingYesChange_Timing
Change TypeYesChange_Type
Closed_DateNoNot applicable
CompanyNoNot applicable
DescriptionYesDescription
ImpactYesImpact
Infrastructure Change IDYesInfrastructure_Change_ID
Last Modified DateYesLast_Modified_Date
PriorityYesPriority
Product Cat Tier 1NoNot applicable
Product Cat Tier 2NoNot applicable
Product Cat Tier 3NoNot applicable
Reason For ChangeYesReason_For_Change
ResolutionNoNot applicable
Resolution CategoryNoNot applicable
Risk LevelYesRisk_Level
Scheduled Start DateNoNot applicable
SLA Response StatusNoNot applicable
SLM Status

Yes

SLM_Status
Status ReasonYesStatus_Reason
Submit DateYesSubmit_Date
SubmitterYesSubmitter
UrgencyYesUrgency

Incident Management

Entry name (in Remedy)1

Displayed as part of fields (in the search results)?Field name (in IT Data Analytics)

Assigned Group

Yes

Assigned_Group

Assigned Support CompanyYesAssigned_Support_Company
Assigned Support OrganizationYesAssigned_Support_Organization
AssigneeYesAssignee
Categorization Tier 1NoNot applicable
Categorization Tier 2NoNot applicable
Categorization Tier 3NoNot applicable
CompanyYesCompany
DescriptionYesDescription
ImpactYesImpact
Incident NumberYesIncident_Number
Last Modified DateYesLast_Modified_Date
OrganizationNoNot applicable
PriorityYesPriority
Product Categorization Tier 1NoNot applicable
Product Categorization Tier 2NoNot applicable
Product Categorization Tier 3NoNot applicable
Short DescriptionNoNot applicable
SLM StatusYesSLM_Status
StatusYesStatus
Submit DateYesSubmit_Date
SubmitterYesSubmitter
UrgencyYesUrgency

1 When you change field settings to add new field names, ensure that the new field name matches the name that appears in the preceding table, under the Entry name (in Remedy) column.

Work notes-related entries (or fields) collected automatically

The following table provides the list of entries (or fields) automatically collected from the work notes section (associated with the change and incident forms).

Note

When you search, entries (or fields) collected from the work notes section are not displayed as fields, instead, this information is only available as part of the raw data.

The field settings can be changed by running the configureexternalfields CLI command CLI command.

Change Management
Incident Management

Submitter

Submitter

Submit DateSubmit Date
StatusStatus
Short DescriptionShort Description
DescriptionDescription
Detailed DescriptionDetailed Description
Work Log Submit DateWork Log Submit Date
Work Log SubmitterWork Log Submitter
Work Log TypeWork Log Type
Infrastructure Change IDIncident Entry ID

Configuration items-related entries (or fields) collected automatically

The following table provides the list of entries (or fields) automatically collected from the configuration items (CIs) (associated with the change and incident forms).

Note

When you search, entries (or fields) collected from the CIs are displayed as a comma-separated list of values of the HOST field. Unlike other forms from which Remedy data can be collected, no entry (or field) is displayed as part of raw data or as fields on searching.

The field settings can be changed by running the configureexternalfields CLI command CLI command.

Change Management
Incident Management

Lookup Keyword

Lookup Keyword

Request Description01Request Description01