Update Items process for the BMC Remedy AR System adapter

The Update Items process updates entries in the BMC Remedy Action Request (AR) System schema with a specified value.

The following table describes the input elements for the <items> XML for the Update Items process:

Input elements for the Update 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 update a record in a BMC Remedy AR System schema	Yes
`<batch process items>`	Indicates that all the `<item>` elements in the XML document must be used to update records in a batch mode Valid values: true, false (default)	No
`<version>`	Specifies the version of the BMC Remedy AR System application Valid values: v7.0, v7.5, v7.6, v8.0, v8.1	Yes
`<item type>`	Indicates the type of record to be obtained Note `<item type>` is not currently being used by the Update Items process.	Yes
`<connection parameters>`	Contains the metadata required by the adapter to connect to the target Note `<connection parameters>` is not currently being used by the Update Items process.	No

The following figure shows the XML sample of the input elements for the Update Items process:

<items> XML for the Update Items process

<items>
   <item>
   <schema>Sample:Cities</schema>
    <updated-field>Diary Field</updated-field>
       <updated-field-value>Update Diary Field</updated-field-value>
     <entry-id>000000000000013</entry-id>
   </item>
</items>

The following table describes the output element for the Update Items process:

Output element for the Update Items process

Output	Description
`<adapter response>`	Specifies the XML document returned by the adapter request executed on the BMC Remedy AR System

The following figure illustrates the XML sample of the output elements for the Update Items process when <batch process items> is set to false:

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

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

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

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

<update-action-result>
  <entries>
    <entry>
      <entry-id>000000000000004</entry-id>
      <entry-count>1</entry-count>
    </entry>
    <entry>
      <entry-id>000000000000090</entry-id>
      <entry-count>1</entry-count>
    </entry>
    <entry>
      <entry-id>000000000000091</entry-id>
      <entry-count>1</entry-count>
    </entry>
    <entry>
      <entry-id>000000000000092</entry-id>
      <entry-count>1</entry-count>
    </entry>
 </entries>
</update-action-result>

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

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

<items>
<item>
<schema>WOI:WorkOrderInterface_Create</schema>
<updated-field>Status</updated-field>
<updated-field-value>Rejected</updated-field-value>
<entry-id>000000000000001</entry-id>
</item>
</items>

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

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

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

The following figure shows a sample <items> XML for the Update Items process using the WorkOrderInterface (Self-Join) form:

<items> XML for the Update Items process using the WorkOrderInterface (Self-Join) form

<items>
<item>
<schema>WOI:WorkOrder</schema>
<updated-field>Summary</updated-field>
<updated-field-value>updated by John</updated-field-value>
<entry-id>WO0000000000105</entry-id>
</item>
</items>

The following figure illustrates the output elements for the Update Items process using the WorkOrderInterface (Self-Join) form:

Output elements for the Update Items process using the WorkOrderInterface (Self-Join) form

<remedy-action>
    <entry-id>WO0000000000105</entry-id>
    <schema>WOI:WorkOrder</schema>
    <values>
      <field name="Summary" xml:space="preserve">updated by John</field>
    </values>
  </remedy-action>

Update Items process for the BMC Remedy AR System adapter

Comments