Unsupported content

 

This version of the product has reached end of support. The documentation is available for your convenience. However, you must be logged in to access it. You will not be able to leave comments.

Delete Items process for the BMC Remedy AR System adapter

The Delete Items process removes a record from a specified schema in BMC Remedy Action Request (AR) System.

The following table describes the input elements for the <items> XML for the Delete Items process.

Input elements for the Delete Items process

Input

Description

Required

<adapter name>

Specifies the name of the adapter to be used for the process, as configured in Grid Manager

Default value: ARSadapter

No

<items>

Specifies the XML document containing the elements required to delete a record from a BMC Remedy AR System schema

Note

Specify values for each field required by BMC Remedy AR System to delete a complete record.

Yes

<version>

Specifies the version of the BMC Remedy AR System application

Valid values:

  • v7.0
  • v7.5
  • v7.6
  • v8.0
  • v8.1
  • v9.0
  • v9.1

Yes

<item type>

Indicates the type of record to be deleted

Note

<item type> is not currently being used by the Delete Items process.

No

<connection parameters>

Contains the metadata required by the adapter to connect to the target

Note

<connection parameters> is not currently being used by the Delete Items process.

No

The following figure shows the sample <items> XML for the Delete Items process:

<items> XML for the Delete Items process

<items>
  <item>
    <schema>AR System schema from which entry will be removed</schema> 
    <entry-id>AR System entry ID for the record to be removed</entry-id>
  </item>
</items>

The following figure shows the output elements for the sample Delete Items process when <batch process items> is set to false:

XML sample of the output elements for the Delete Items process when <batch process items> is false

<delete-action-result> 
  <entries> 
    <metadata> 
      <entry-count>1</entry-count> 
    </metadata> 
  </entries> 
</delete-action-result>

The following figure illustrates the XML sample of the output elements for the Delete Items process when <batch process items> is set to true.

XML sample of the output elements for the Delete Items process when <batch process items> is true

 <delete-action-result>
  <entries>
    <entry>
      <entry-id>000000000000085</entry-id>
      <entry-count>1</entry-count>
    </entry>
    <entry>
      <entry-id>000000000000086</entry-id>
      <entry-count>1</entry-count>
    </entry>
  </entries>
</delete-action-result>

The following figure shows a sample <items> XML for the Delete Items process using the WorkOrderInterface_Create (Normal) form:

<items> XML for the Delete Items process using the WorkOrderInterface_Create (Normal) form

<items>
<item>
<schema>WOI:WorkOrderInterface_Create</schema>
<entry-id>000000000000102</entry-id>
</item>
</items>

The following figure illustrates the output elements for the Delete Items process using the WorkOrderInterface_Create (Normal) form:

Output elements for the Delete Items process using the WorkOrderInterface_Create (Normal) form

<set-action-result>
<schema>WOI:WorkOrderInterface_Create</schema>
<entry-id>000000000000102</entry-id>
</set-action-result>

The WorkOrderInterface is a self-join form, and therefore you cannot execute the Delete Items process using this form.

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

Comments