Module for the BMC Remedy AR System adapter

Each command supported by the application adapter has a corresponding process in the adapter module. Top-level processes perform high-level functions and call specialized processes in subdirectories. Each subdirectory contains process directories that correspond to the operation type for that command.

Top-level processes

The top-level processes perform high-level functions and call specialized processes in the v7.0 and v7.5 directories.

The top-level processes in the AMP-AD-BMC-Remedy-ARS adapter module in the Project Explorer window execute the following version-specific BMC Remedy AR System processes:

The following table maps the adapter processes with the required actions using the Call Adapter Activity:

Adapter processes mapped to Call Adapter actions

Adapter process

Corresponding action

Delete Entry

delete

Get Entries

query

Insert Entry

set

Query Update Entry

query-update

Reset Cache

reset-cache

Update Entry

update

Query Server Info

query-server-info

Note

  • The Delete Entry, Get Entries, Insert Entry, Query Update Entry, and the Update entry processes can add, update, retrieve, and delete an attachment.
  • The file to be attached to the form must be located on the same computer where the actor adapter is enabled.
  • Attachments retrieved using an instance of the adapter are stored on the local computer where the adapter is enabled.
  • If the attachments have same file name, the file name of the new attachment is suffixed with an index to avoid overriding the existing file at a given directory location. For example, if the file name of an attachment is attach.txt that already exists in the directory and another attached file name that has to be retrieved has the same name, then the file name is suffixed with an index indicator (attach-1.txt ), and so on.

Utilities directory

The Utilities directory contains the Translate Keys to Remedy IDs Translate Keys to Remedy IDs and Set Default Adapter Name helper and constructor processes. The functional processes require complex XML inputs. You can generate these complex XML inputs using the constructor processes in the Utilities directory.

Translate Keys to Remedy IDs

The Translate Keys to Remedy IDs process translates variable context keys to BMC Remedy Action Request System (BMC Remedy AR System) IDs. The following table describes the input parameters for the Translate Keys To Remedy IDs utility.

 Inputs elements for the Translate Keys to Remedy IDs process

Input

Description

Required

<mappings>

Maps internal common element names to BMC Remedy AR System-specific IDs

This should be an XML document with a root element named "mappings", which should contain the data required to map an element name to a specified BMC Remedy AR System field name.

Yes

<query mappings>

Maps a BMC Remedy AR System field name its corresponding BMC Remedy AR System field ID

This should be an XML document with a root element named "mappings", which should contain the data required to map an BMC Remedy AR System field name to the corresponding the BMC Remedy AR System field ID.

Yes

<key 1>

Specifies the common element name to be translated to the corresponding BMC Remedy AR System field ID

Yes

<key 2>

Specifies the second common element name to be translated to the corresponding BMC Remedy AR System field ID

No

The following figure shows an XML sample of the input parameters with mappings for the Translate Key To Remedy IDs utility.
 XML sample for the mappings input parameter for the Translate Keys to Remedy IDs process

<mappings>
<!-- These are sample mappings that might work for a Remedy ARS Planned Outage schema. -->
<id type="int">Request ID</id>
<submitter type="string">Submitter</submitter>
<create-date type="date">Create Date</create-date>
<assigned-group type="string">Assigned Group</assigned-group>
<last-modified-by type="date">Last Modified By</last-modified-by>
<assigned-to type="string">Assigned To</assigned-to>
<modified-date type="date">Modified Date</modified-date>
<status type="string">Status</status>
<short-description type="string">Short Description</short-description>
<planned-begin type="string">Planned Begin</planned-begin>
<planned-end type="string">Planned End</planned-end>
<actual-begin type="string">Actual begin</actual-begin>
<actual-end type="string">Actual end</actual-end>
<device-name type="string">Device Name</device-name>
<ip-address type="string">IP address</ip-address>
<customer-name type="string">Customer Name</customer-name>
<customer-id type="string">Customer ID</customer-id>
<reason type="string">Reason</reason>
<associated-ticket-id type="string">TT ID</associated-ticket-id>
</mappings>

The following figure shows an XML sample of the input parameters with query mappings for the Translate Key To Remedy IDs utility.
 XML sample for the mappings input parameter for the Translate Keys to Remedy IDs process

<mappings>
<mapping name="Device Name">536870917</mapping>
<mapping name="Planned End">536870920</mapping>
<mapping name="Planned Begin">536870919</mapping>
<mapping name="IP address">536870926</mapping>
<mapping name="Customer Name">536870925</mapping>
<mapping name="Customer ID">536870924</mapping>
<mapping name="Actual begin">536870921</mapping>
<mapping name="Actual end">536870922</mapping>
<mapping name="TT ID">536870927</mapping>
</mappings>

The following table describes the output parameters for the Translate Key To Remedy IDs utility.
 Output elements for the Translate Keys to Remedy IDs process

Output

Description

<key 1 id>

Contains the BMC Remedy AR System field ID that corresponds to the common element name provided in the key1 input

<key 2 id>

Contains the BMC Remedy AR System field ID that corresponds to the common element name provided in the key2 input

Version directories

The v7.0 and v7.5 directories contain functional processes specific to a version of BMC Remedy AR System. A process is available for each supported operation.

  • In the v7.0 directory, the functional processes are specifically designed to interface with version 7.0 of BMC Remedy AR System.
  • In the v7.5 directory, the functional processes are specifically designed to interface with version 7.5 and later of BMC Remedy AR System.

Note

The v7.0 directory, which is the older version exists because of backward compatibility. All the processes later than BMC Remedy AR System 7.5 invoke the processes in the v7.5 directory. Therefore, for new implementations, you must use the latest version directories and mention the version number as 7.6 or later.

Was this page helpful? Yes No Submitting... Thank you

Comments