Reopen Change operation

The Reopen Change operation reopens a change record.

The following table describes the elements of the <items> XML element and the adapter request. If not specified, the valid value for an element is assumed to be a string.

Elements for the <items> XML element and adapter request for the Reopen Change operation

Element

Definition

Required

<operation-name>

Specifies the name of the operation: reopen-change

Yes

<model>

Contains the other elements in the request

Yes

<keys>

Contains elements that uniquely identify a record

The <keys> element must contain a unique string. The server can choose an auto generated key for the record.

Yes

<instance>

Specifies a unique record The children of the <instance> element describe the fields of the record.

The only two higher-level elements are <keys> and <instance>. All other elements are child elements of the <instance> element.

Yes

<header>

Specifies the header information of the change record; is a structure-type element

Yes

<change-number>

Specifies the unique ID of a change record that is used as the key to identify the record

You can specify the <change-number> element in the <keys> element or in the <instance> element.

Valid value: Any unique string

No

<category>

Specifies the category of the change record

Note: The behavior of some parameters might change depending on the selected category. For example, Change Coordinator is a required parameter for the Unplanned Change category but an optional parameter for all other categories.

Valid values:

  • CI group
  • Default
  • Hardware
  • Maintenance
  • Network
  • Release Management
  • Software
  • Subscription
  • Unplanned Change

No

<status>

Specifies the status of a change

Valid values:

  • initial
  • waiting
  • reopened
  • closed

    Note: You must specify initial as the first status for a new change.

No

<approval-status>

Specifies the status of the approval for the change

Valid values:

  • pending
  • approved
  • deny
  • retract

No

<requested-by>

Specifies the name of the person who is requesting the change

Valid value: Any string, or an existing contact record

Conditional; required only if the category is CI Group

<assigned-to>

Specifies the name of the person to whom the change is assigned

Valid value: Any string, or an existing contact record

No

<assignment-group>

Specifies the assignment group for the change

Valid values: Application, Hardware, Network, Service Desk, Service Manager, Email/Webmail (Africa), Email/Webmail (Asia), Email/Webmail (Australia), Email/Webmail (Europe), Email/Webmail (North America), Email/Webmail (South America), Field Support (Africa), Field Support (Asia), Field Support (Australia), Field Support (North America), Field Support (South America), Intranet/Internet Support (Africa), Intranet/Internet Support (Asia), Intranet/Internet Support (Australia), Intranet/Internet Support (Europe), Intranet/Internet Support (North America), Intranet/Internet Support (South America), Office Supplies (Africa), Office Supplies (Asia), Office Supplies (Australia), Office Supplies (Europe), Office Supplies (North America), Office Supplies (South America), Office Support (Africa), Office Support (Asia), Office Support (Australia), Office Support (Europe), Office Support (North America), Office Support (South America), Operating System Support (Africa), Operating System Support (Asia), Operating System Support (Australia), Operating System Support (North America), Operating System Support (South America), SAP Support (Africa), SAP Support (Asia), SAP Support (Australia), SAP Support (North America), and SAP Support (South America)

Yes

<coordinator>

Specifies the name of the person coordinating the change

Valid value: Any string, or an existing contact record

No

<coordinator-phone>

Specifies the phone number of the coordinator for the change

Valid value: Any string

No

<planned-start-date>

Specifies the planned start date of the change

Valid value: Date and time in the YYYY.MM.DD HH:MM:SS format
For example: 2008.11.01 08:00:00

No

<planned-end-date>

Specifies the planned end date of the change.

Valid value: Date and time in the YYYY.MM.DD HH:MM:SS format
For example: 2008.11.01 08:00:00

Note: The <planned-end-date> value must be greater than the <planned-start-date> value.

No

<reason>

Specifies the reason for the change

Valid value: Any string

No

<current-phase>

Specifies the current phase of the change

The <current-phase> values can be added, updated, and deleted by using the HP Service Manager application.

Valid values:

  • Let the server decide the default phase by not specifying this element.
  • Specify the phase, based on the category of the change record, as follows:
    • CI Group: CIGroupDesign
    • Default: Change Logging
    • Hardware: Change Logging
    • Maintenance: Change Logging
    • Network: Change Logging
    • Release Management: Assess
    • Software: Change Logging
    • Subscription: Subscription Approval
    • Unplanned Change: Discovery Assessment

No

<risk-assessment>

Specifies the assessment of the risk related to the change

The list is customizable, and you can add items to or delete items from this list.

Valid values:

  • 0: no risk
  • 1: low risk
  • 2: some risk
  • 3: moderate risk
  • 4: high risk
  • 5: very high risk

No

<priority>

Specifies the priority of the change as specified by the user who created the ticket

Valid value: Any valid string

Default value: The value specified for the <urgency> element

No

<date-entered>

Specifies the date when the change record was entered into the system

The value of the <date-entered> element is specified by the HP Service Manager application in the YYYY.MM.DD HH:MM:SS format.
For example, 2008.11.01 08:00:00.

You cannot specify your inputs to set the <date-entered> field. However, you can use the <date-entered> field to retrieve a record.

No

<open>

Specifies whether the change record is in an open state

Valid values:

  • true (default): Indicates that the change record is open
  • false: Indicates that the change record is closed

    Note: If you specify an invalid value, it is replaced with the default value.

No

<backout-duration>

Specifies the time required to roll back the change, if necessary

Valid value: Any input in the DurationType format
For example, P15DT10H30M20S: 15 days, 10 hours, 30 minutes, and 20 seconds

No

<close-time>

Specifies the date and time when the record was closed

Valid value: Date and time in the YYYY.MM.DD HH:MM:SS format

You cannot specify your inputs to set this field. However, you can use this field to retrieve a record.

No

<foreign-i-d>

Specifies the foreign ID of the change

Valid value: Any string

No

<R-f-c-type2>

Specifies the type of the request for change (RFC)

Valid values: Any string

No

<company>

Specifies the name of the company for the change

Valid value: Any string

No

<brief-description>

Specifies the title or a brief description of the change

Valid value: Any string

No

<subcategory>

Specifies the subcategory for the specified category

Valid value: Any string

No

<s-l-a-agreement-i-d>

Specifies the service level agreement (SLA) ID of the change

Valid values: Any integer

The HP Service Manager application contains a customizable string set. You can add entries to and delete entries from the set. You can provide an application-specific mapping of integers in the <items> XML to the set.
For example: 155 > ACME Bronze

No

<description-structure>

Specifies an array of descriptions of the change; is a structure-type element

Yes

<description>

Specifies a title or a descriptive of the change; is an array -type element

No

<justification>

Specifies the justification for the change; is an array-type element

No

<backout-method>

Specifies the method to use to roll back the change, if necessary

No

<middle>

Specifies an array of descriptions of the change; is a structure-type element

Yes

<configuration-item>

Specifies the configuration item associated with the change

The <configuration-item> element is the first entry of the <assets> element. Complete Xpath: items > item > model > instance > middle > assets

No

<location>

Specifies the location information about the change

Valid value: Any string

No

<misc1>

Specifies miscellaneous information about the change

Valid value: Any string

No

<misc2>

Specifies miscellaneous information about the change

Valid value: Any string

No

<outage-start>

Specifies the outage start date and time associated with the change

Valid value: Date and time in the YYYY.MM.DD HH:MM:SS format
For example: 2008.11.01 08:00:00

No

<outage-end>

Specifies the outage end date and time associated with the change

Valid value: Date and time in the YYYY.MM.DD HH:MM:SS format
For example: 2008.11.01 08:00:00

No

<scheduled-outage-start >

Specifies the scheduled outage start date and time associated with the change

Valid value: Date and time in the YYYY.MM.DD HH:MM:SS format
For example: 2008.11.01 08:00:00

No

<scheduled-outage-end>

Specifies the scheduled outage end date and time associated with the change

Valid value: Date and time in the YYYY.MM.DD HH:MM:SS format
For example: 2008.11.01 08:00:00

No

<actual-outage-start>

Specifies the actual outage start date and time associated with the change

Valid value: Date and time in the YYYY.MM.DD HH:MM:SS format
For example: 2008.11.01 08:00:00

No

<actual-outage-end>

Specifies the actual outage end date and time associated with the change

Valid value: Date and time in the YYYY.MM.DD HH:MM:SS format
For example: 2008.11.01 08:00:00

No

<misc-array1>

Specifies a miscellaneous array element for the change

No

<misc-array2>

Specifies a miscellaneous array element for the change

No

<misc-array3>

Specifies a miscellaneous array element for the change

No

<assets>

Specifies the configuration items associated with the change record; is an array-type element

Multiple configuration items can be associated with a change.

No

<estimate-description>

Specifies the description of the estimate obtained for the change

Valid value: Any string

No

<estimate-price>

Specifies the estimated price for implementing the change Valid value: Any string

No

<actual-cost>

Specifies the actual cost of implementing the change

Valid value: Any string

No

<actual-price>

Specifies the actual price for implementing the change

Valid value: Any string

No

<close>

Contains elements that specify the closure details and comments for the change record; is a structure-type element

Yes

<completion-code>

Specifies the completion code for the change

Valid value: Any decimal

No

<closing-comments>

Specifies the closure comments for the change; is an array-type element

No

<urgency>

Specifies the level of urgency for the change

Valid values:

  • 1: Critical
  • 2: High
  • 3: Average
  • 4: Low

No

<initial-assessment>

Specifies the initial assessment of the change

Valid values:

  • 1: Enterprise
  • 2: Site/Dept
  • 3: Multiple Users
  • 4: User

No

<service>

Specifies the service to be used for the change

Valid values: Applications, E-mail / Webmail (Africa), E-mail / Webmail (Asia), E-mail / Webmail (Australia), E-mail / Webmail (Europe), E-mail / Webmail (North America), E-mail / Webmail (South America), Education, Handheld, PDA & Telephony, Intranet / Internet (Africa), Intranet / Internet (Asia), Intranet / Internet (Australia), Intranet / Internet (Europe), Intranet / Internet (North America), Intranet / Internet (South America), MyDevices, Printing (Africa), Printing (Asia), Printing (Australia), Printing (Europe), Printing (North America), Printing (South America), Service Management

No

<requested-date>

Specifies the requested end date for the change

Valid value: Date and time in the YYYY.MM.DD HH:MM:SS format
For example: 2008.11.01 08:00:00

No

The following figure displays the sample adapter request for the Reopen Change operation.

Sample adapter request for the Reopen Change operation


 <hp-service-manager-request>
    <entity>change</entity>
    <entity-type />
    <request>
      <operation-name>reopen-change</operation-name>
      <parameters>
        <reopen-change-request>
          <model>
            <keys>
              <change-number>
                <value>C10095</value>
                <type>String</type>
              </change-number>
            </keys>
            <instance>
              <header>
                <type>Structure</type>
                <category>
                  <value>Hardware</value>
                  <type>String</type>
                </category>
                <requested-by>
                  <value>AARON, JIM</value>
                  <type>String</type>
                </requested-by>
                <reason>
                  <value>reason</value>
                  <type>String</type>
                </reason>
                <current-phase>
                  <value>Change Logging</value>
                  <type>String</type>
                </current-phase>
                <risk-assessment>
                  <value>0</value>
                  <type>String</type>
                </risk-assessment>
                <brief-description>
                  <value>This should be the Title for the Change</value>
                  <type>String</type>
                </brief-description>
                <assignment-group>
                  <value>Application</value>
                  <type>String</type>
                </assignment-group>
              </header>
              <description-structure>
                <type>Structure</type>
                <description>
                  <type>Array</type>
                  <description>
                    <!--zero or more array elements follow-->
                    <element>
                      <value>First Line of Description</value>
                      <type>String</type>
                    </element>
                    <element>
                      <value>Second Line of Description</value>
                      <type>String</type>
                    </element>
                  </description>
                </description>
                <justification>
                  <type>Array</type>
                  <justification>
                    <!--zero or more array elements follow-->
                    <element>
                      <value>justification line 1</value>
                      <type>String</type>
                    </element>
                    <element>
                      <value>justification line 2</value>
                      <type>String</type>
                    </element>
                  </justification>
                </justification>
                <backout-method>
                  <type>Array</type>
                  <backout-method>
                    <!--zero or more array elements follow-->
                    <element>
                      <value>back out method line 1</value>
                      <type>String</type>
                    </element>
                    <element>
                      <value>back out method line 2</value>
                      <type>String</type>
                    </element>
                  </backout-method>
                </backout-method>
              </description-structure>
              <middle>
                <type>Structure</type>
                <configuration-item>
                  <value>MyDisplayDevice1</value>
                  <type>String</type>
                </configuration-item>
                <location>
                  <value>Location</value>
                  <type>String</type>
                </location>
                <misc1>
                  <value>misc1</value>
                  <type>String</type>
                </misc1>
                <misc2>
                  <value>misc2</value>
                  <type>String</type>
                </misc2>
                <misc-array1>
                  <type>Array</type>
                  <misc-array1>
                    <!--zero or more array elements follow-->
                    <element>
                      <value>misc array 1 - 1</value>
                      <type>String</type>
                    </element>
                    <element>
                      <value>misc array 1 - 2</value>
                      <type>String</type>
                    </element>
                  </misc-array1>
                </misc-array1>
                <misc-array2>
                  <type>Array</type>
                  <misc-array2>
                    <!--zero or more array elements follow-->
                    <element>
                      <value>misc array 2 - 1</value>
                      <type>String</type>
                    </element>
                    <element>
                      <value>misc array 2 - 2</value>
                      <type>String</type>
                    </element>
                  </misc-array2>
                </misc-array2>
                <misc-array3>
                  <type>Array</type>
                  <misc-array3>
                    <!--zero or more array elements follow-->
                    <element>
                      <value>misc array3 - 1</value>
                      <type>String</type>
                    </element>
                    <element>
                      <value>misc array3 - 2</value>
                      <type>String</type>
                    </element>
                  </misc-array3>
                </misc-array3>
                <assets>
                  <type>Array</type>
                  <assets>
                    <!--zero or more array elements follow-->
                    <element>
                      <value>SDP</value>
                      <type>String</type>
                    </element>
                  </assets>
                </assets>
                <estimate-description>
                  <value>estimate description</value>
                  <type>String</type>
                </estimate-description>
                <estimate-price>
                  <value>estimate price</value>
                  <type>String</type>
                </estimate-price>
                <actual-cost>
                  <value>Actual Cost</value>
                  <type>String</type>
                </actual-cost>
                <actual-price>
                  <value>actual price</value>
                  <type>String</type>
                </actual-price>
              </middle>
              <close>
                <type>Structure</type>
                <completion-code>
                  <value>5</value>
                  <type>Decimal</type>
                </completion-code>
                <closing-comments>
                  <type>Array</type>
                  <closing-comments>
                    <!--zero or more array elements follow-->
                    <element>
                      <value>closing comment line 1</value>
                      <type>String</type>
                    </element>
                    <element>
                      <value>closing comment line 2</value>
                      <type>String</type>
                    </element>
                  </closing-comments>
                </closing-comments>
              </close>
              <urgency>
                <value>1</value>
                <type>String</type>
              </urgency>
              <initial-assessment>
                <value>3</value>
                <type>String</type>
              </initial-assessment>
              <service>
                <value>Applications</value>
                <type>String</type>
              </service>
              <requested-date>
                <value>2009.12.31 12:30:00</value>
                <type>DateTime</type>
              </requested-date>
            </instance>
          </model>
        </reopen-change-request>
      </parameters>
    </request>
  </hp-service-manager-request>


The following figure displays an adapter response for the Reopen Change operation.

Sample adapter response for the Reopen Change operation


<hp-service-manager-response>
  <metadata>
    <count>1</count>
  </metadata>
  <responses>
    <response>
      <metadata>
        <count>1</count>
      </metadata>
      <item>
        <metadata>
          <status>success</status>
        </metadata>
        <parameters>
          <model>
            <keys>
              <change-number>
                <value>C10095</value>
                <type>String</type>
              </change-number>
            </keys>
            <instance>
              <header>
                <type>Structure</type>
                <change-number>
                  <value>C10095</value>
                  <type>String</type>
                </change-number>
                <category>
                  <value>Hardware</value>
                  <type>String</type>
                </category>
                <status>
                  <value>reopened</value>
                  <type>String</type>
                </status>
                <approval-status>
                  <value>approved</value>
                  <type>String</type>
                </approval-status>
                <requested-by>
                  <value>AARON, JIM</value>
                  <type>String</type>
                </requested-by>
                <assignment-group>
                  <value>Application</value>
                  <type>String</type>
                </assignment-group>
                <coordinator>
                  <value>Change.Coordinator</value>
                  <type>String</type>
                </coordinator>
                <reason>
                  <value>reason</value>
                  <type>String</type>
                </reason>
                <current-phase>
                  <value>Change Logging</value>
                  <type>String</type>
                </current-phase>
                <risk-assessment>
                  <value>0</value>
                  <type>String</type>
                </risk-assessment>
                <priority>
                  <value>2</value>
                  <type>String</type>
                </priority>
                <date-entered>
                  <value>2010.01.08 17:45:02</value>
                  <type>DateTime</type>
                </date-entered>
                <open>
                  <value>true</value>
                  <type>Boolean</type>
                </open>
                <backout-duration>
                  <value>PT0S</value>
                  <type>Duration</type>
                </backout-duration>
                <close-time>
                  <value>2009.12.29 15:32:15</value>
                  <type>DateTime</type>
                </close-time>
                <company>
                  <value>advantage</value>
                  <type>String</type>
                </company>
                <brief-description>
                  <value>This should be the Title for the Change</value>
                  <type>String</type>
                </brief-description>
              </header>
              <description-structure>
                <type>Structure</type>
                <description>
                  <type>Array</type>
                  <description>
                    <element>
                      <value>First Line of Description</value>
                      <type>String</type>
                    </element>
                    <element>
                      <value>Second Line of Description</value>
                      <type>String</type>
                    </element>
                  </description>
                </description>
                <justification>
                  <type>Array</type>
                  <justification>
                    <element>
                      <value>justification line 1</value>
                      <type>String</type>
                    </element>
                    <element>
                      <value>justification line 2</value>
                      <type>String</type>
                    </element>
                  </justification>
                </justification>
                <backout-method>
                  <type>Array</type>
                  <backout-method>
                    <element>
                      <value>back out method line 1</value>
                      <type>String</type>
                    </element>
                    <element>
                      <value>back out method line 2</value>
                      <type>String</type>
                    </element>
                  </backout-method>
                </backout-method>
              </description-structure>
              <middle>
                <type>Structure</type>
                <configuration-item>
                  <value>SDP</value>
                  <type>String</type>
                </configuration-item>
                <location>
                  <value>Location</value>
                  <type>String</type>
                </location>
                <misc1>
                  <value>misc1</value>
                  <type>String</type>
                </misc1>
                <misc2>
                  <value>misc2</value>
                  <type>String</type>
                </misc2>
                <misc-array1>
                  <type>Array</type>
                  <misc-array1>
                    <element>
                      <value>misc array 1 - 1</value>
                      <type>String</type>
                    </element>
                    <element>
                      <value>misc array 1 - 2</value>
                      <type>String</type>
                    </element>
                  </misc-array1>
                </misc-array1>
                <misc-array2>
                  <type>Array</type>
                  <misc-array2>
                    <element>
                      <value>misc array 2 - 1</value>
                      <type>String</type>
                    </element>
                    <element>
                      <value>misc array 2 - 2</value>
                      <type>String</type>
                    </element>
                  </misc-array2>
                </misc-array2>
                <misc-array3>
                  <type>Array</type>
                  <misc-array3>
                    <element>
                      <value>misc array3 - 1</value>
                      <type>String</type>
                    </element>
                    <element>
                      <value>misc array3 - 2</value>
                      <type>String</type>
                    </element>
                  </misc-array3>
                </misc-array3>
                <assets>
                  <type>Array</type>
                  <assets>
                    <element>
                      <value>SDP</value>
                      <type>String</type>
                    </element>
                  </assets>
                </assets>
                <estimate-description>
                  <value>estimate description</value>
                  <type>String</type>
                </estimate-description>
                <estimate-price>
                  <value>estimate price</value>
                  <type>String</type>
                </estimate-price>
                <actual-cost>
                  <value>Actual Cost</value>
                  <type>String</type>
                </actual-cost>
                <actual-price>
                  <value>actual price</value>
                  <type>String</type>
                </actual-price>
              </middle>
              <close>
                <type>Structure</type>
                <completion-code>
                  <value>5</value>
                  <type>Decimal</type>
                </completion-code>
                <closing-comments>
                  <type>Array</type>
                  <closing-comments>
                    <element>
                      <value>closing comment line 1</value>
                      <type>String</type>
                    </element>
                    <element>
                      <value>closing comment line 2</value>
                      <type>String</type>
                    </element>
                  </closing-comments>
                </closing-comments>
              </close>
              <urgency>
                <value>1</value>
                <type>String</type>
              </urgency>
              <initial-assessment>
                <value>3</value>
                <type>String</type>
              </initial-assessment>
              <service>
                <value>Applications</value>
                <type>String</type>
              </service>
              <requested-date>
                <value>2009.12.31 12:30:00</value>
                <type>DateTime</type>
              </requested-date>
              <closure-comments>
                <type>Array</type>
                <closure-comments>
                  <element>
                    <value>reject</value>
                    <type>String</type>
                  </element>
                </closure-comments>
              </closure-comments>
              <uniquequery>header,number="C10095"</uniquequery>
              <recordid>C10095 - This should be the Title for the Change</recordid>
            </instance>
          </model>
          <messages>
            <element>
              <value>Change C10095 Phase Change Logging Updated by falcon.</value>
            </element>
            <element>
              <value>Test value 1.</value>
            </element>
            <element>
              <value>Test value 2.</value>
            </element>
          </messages>
          <status>SUCCESS</status>
          <message>Success</message>
          <schema-revision-date>2010.01.08 00:00:00</schema-revision-date>
          <schema-revision-level>4</schema-revision-level>
          <return-code>0</return-code>
        </parameters>
      </item>
    </response>
  </responses>
</hp-service-manager-response>
Was this page helpful? Yes No Submitting... Thank you

Comments