Create Items process for the BMC Remedy AR System adapter

The Create Items process creates one or more records in a specified schema within BMC Remedy Action Request (AR) System.

The following BMC Communities video (2:10) shows how to create a user in BMC Remedy ITSM by using the BMC Remedy AR System actor adapter.

https://www.youtube.com/watch?v=dhc-CS3nrCI&feature=youtu.be

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

Input elements for the Create 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 insert a record into a BMC Remedy AR System schema

Note

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

Yes

<batch process items>

Indicates that all <item> elements in the XML document must be processed by the adapter in a batch mode

Default value: false

No

<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 created

Note

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

No

<connection parameters>

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

No

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

<items> XML for the Create Items process

<items>
  <item>
   <schema>Sample:Cities</schema>
   <fields>
    <values>
      <field name="City">Delhi</field>
      <field name="Airport Code">Del</field>
      <field name="Diary Field">Enter data in Diary Field</field>
    </values>
   </fields>
 </item>
</items>

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

Output element for the Create 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 output elements for the Create Items process when the <batch-process-items> element is set to false:

Output elements for the Create Items process when <batch process items> is false

<set-action-result>
 <entry-id>000000000000179</entry-id>
</set-action-result>

The following figure illustrates the output elements for the Create Items process when the <batch process items> element is set to true:

Output elements for the Create Items process when <batch process items> is true

<set-action-result>
  <entries>
    <metadata>
      <entry-count>2</entry-count>
    </metadata>
    <entry>
      <entry-id>000000000000076</entry-id>
    </entry>
    <entry>
      <entry-id>000000000000077</entry-id>
    </entry>
  </entries>
</set-action-result>

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

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

<items>
<item>
<schema>WOI:WorkOrderInterface_Create</schema>
<fields>
  <values>
      <field name="Work Order Type">2000</field>
      <field name="Manager Support Organization">IT Support</field>
      <field name="Manager Support Group Name">Backoffice Support</field>
      <field name="Company">Global</field>
      <field name="Request Manager Company">Calbro Services</field>
      <field name="Customer Organization" />
      <field name="Customer First Name">John</field>
      <field name="Customer Last Name">Smith</field>
      <field name="Last Name">Smith</field>
      <field name="First Name">John</field>
      <field name="Location Company">Calbro Services</field>
      <field name="Summary">My_Workorder3</field>
      <field name="Customer Company">My_company</field>
  </values>
</fields>
</item>
</items>

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

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

<set-action-result>
  <entry-id>000000000000102</entry-id>
</set-action-result>

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

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

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

<items>
<item>
<schema>WOI:WorkOrderInterface</schema>
<fields>
  <values>
      <field name="Work Order Type">2000</field>
      <field name="Company">My_company</field>
      <field name="Customer Organization" />
      <field name="Customer First Name">John</field>
      <field name="Customer Last Name">Smith</field>
      <field name="Last Name">Smith</field>
      <field name="First Name">John</field>
      <field name="Location Company">Calbro Services</field>
      <field name="Customer Company">My_company</field>
      <field name="Description">Test_company</field>
      <field name="Work Order ID">WO0000000000214</field>
Work Order ID
  </values>
</fields>
</item>
</items>

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

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

<set-action-result>
  <entry-id>000000000000102</entry-id>
</set-action-result>

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

Comments

  1. Allen Paul

    Is this compatible with the latest ARS version 18.08?

    Oct 31, 2018 04:45
    1. Shweta Hardikar

      Hi Allen,

      We have introduced support for ARS 18.08 for sure. However, if you are wondering about the <version> element, let me check with the team and update the docs accordingly. See Supported application versions for the application adapters for all the latest info.

      Nov 01, 2018 12:28