Find Change operation for the CA Service Desk adapter

The Find Change operation retrieves change records from the CA Service Desk application.

The following table describes the <items> XML elements for the Find Change operation.

Note

Use the <items> element when you call an adapter from an out-of-the-box process in TrueSight Orchestration Development Studio. Use the adapter request XML when you create a custom process by using the Call Adapter activity in TrueSight Orchestration Development Studio.

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

Element	Definition	Required
`<operation-name>`	Specifies the name of the operation: `find-change`	Yes
`<arguments>`	Specifies a list of arguments that are required for the `find-change` operation	Yes
`<target>`	Specifies the connection information for the target where the request will be executed If this element is not specified, the adapter uses the configuration information specified in the Grid Manager. You can specify the following XML elements within this element: `<soap-url>` `<host>` `<user-name>` `<password>` `<port>` `<protocol>` `<install-certificate>` `<allow-unsigned-certificate>` `<passphrase>`	Conditional; required if adapter configuration is left empty.
`<soap-url>`	Specifies the URL for the remote SOAP service The `<soap-url>` element has the following formats: For insecure communication: `<soap-url>http://` <IPAddress or hostname> `:` portNumber `</soap-url>` For secure communication: `<soap-url>https://` <IPAddress or hostname> `:` portNumber `</soap-url>` IPAddress is the IP address of the computer where the application server is installed. hostName is the name of the computer where the application server is installed. portNumber specifies the port on which the application server is running, even if it is the default (otherwise, the adapter fails to install the certificate and adapter requests fail). Default value (for secure communication): 443 Sample URL: `https://machine_name.domain_name.com: 8443/axis/services/USD_R11_WebService?wsdl`	Conditional; required if `<host>` is not specified. If both `<soap-url>` and `<host>` are specified, `<soap-url>` takes precedence.
`<host>`	Specifies the host name or IP address of the server where CA Service Desk is installed	Conditional; required if `<soap-url>` is not specified. If both `<soap-url>` and `<host>` are specified, `<soap-url>` takes precedence.
`<user-name>`	Specifies the user name for the CA Service Desk server authentication	No
`<password>`	Specifies the password that corresponds to the user name The password element can contain an `encryption-type` attribute.	No
`encryption-type`	Indicates whether the password specified is encrypted Valid values: Base64, Plain (default)	No
`<port>`	Specifies the communication port for the CA Service Desk application Valid values: Any positive integer Default values: 8080 for http, 8443 for https	No
`<protocol>`	Specifies the communication protocol for the CA Service Desk application Valid values: http, https (default)	No
`<install-certificate>`	Specifies whether to install security certificates automatically If you prefer to have security certificates installed automatically (a common practice), set the value of this element to true. If you prefer to manually export the security certificate from the CA Service Desk server and manually import it into the TrueSight Orchestration's local peer's cacerts file (a rare practice), set the value of this element to false. Valid values: true, false (default)	No
`<allow-unsigned-certificate>`	Specifies whether to allow unsigned certificates from trusted zones If you are using self-signed SSL certificates (a common practice), set the value of this element to true. On ecommerce sites or military installations, if you need to use signed certificates such as Verisign or Thawte (a rare practice), set the value of this element to false. Valid values: true, false (default)	No
`<passphrase>`	Specifies the password to the keystore file (cacerts) local to the TrueSight Orchestration peer Default value: changeit Warning The value of the `<passphrase>` element is the passphrase for the cacerts certificate stored on the TrueSight Orchestration local peer (CDP or AP) and not the CA Service Desk target host. Changing the passphrase can be difficult and might destroy the integrity of the cacerts security file. Verify the cacerts passphrase using the following command in UNIX or Linux: $ /opt/bmc/ao/cdp/jvm/bin/keytool -list -keystore /opt/bmc/ao/cdp/jvm/lib/security/cacerts	No
`<change-number>`	Specifies the identification number of the change to be retrieved Valid values: A valid change number	No
`<assignee>`	Specifies the name of the person to whom the change record is assigned Valid values: A valid name in the format - lastName,firstName,middleName For example: If last name, first name, and middle name exist, the value is - lastName,firstName,middleName. If only last name exists, the value is - lastName. If last name and middle name exist, the value is - lastName,,middleName.	No
`<created-by>`	Specifies the name of the person who created the change record Valid values: A valid name in the format - lastName,firstName,middleName For example: If last name, first name, and middle name exist, the value is - lastName,firstName,middleName. If only last name exists, the value is - lastName. If last name and middle name exist, the value is - lastName,,middleName.	No
`<group>`	Specifies the name of the group to which the change record is assigned Valid values: A valid group name	No
`<closure-code>`	Specifies the closure code for the change record Valid values: See the Administration section of the CA Service Desk application for a complete list of supported values. Note You can customize the existing default list. Adding new values is also supported.	No
`<priority>`	Specifies the priority associated with the change record Valid values: See the Administration section of the CA Service Desk application for a complete list of supported values. Note You can customize the existing default list.	No
`<risk>`	Specifies the risk associated with the change order Valid values: See the Administration section of the CA Service Desk application for a complete list of supported values. Note You can customize the existing default list.	No
`<is-active>`	Specifies whether the change is active Valid values: true, false	No
`<affected-end-user>`	Specifies the name of the end user who is affected by the change Valid values: A valid name in the format - lastName,firstName,middleName For example: If last name, first name, and middle name exist, the value is - lastName,firstName,middleName. If only last name exists, the value is - lastName. If last name and middle name exist, the value is - lastName,,middleName.	No
`<requestor>`	Specifies the name of the person who requested the change Valid values: A valid name in the format - lastName,firstName,middleName For example: If last name, first name, and middle name exist, the value is - lastName,firstName,middleName. If only last name exists, the value is - lastName. If last name and middle name exist, the value is - lastName,,middleName.	No
`<status>`	Specifies the status of the change record Valid values: See the Administration section of the CA Service Desk application for a complete list of supported values. Note You can customize the existing default list. Adding new values is also supported.	No
`<category>`	Specifies the category associated with the change Valid values: See the Administration section of the CA Service Desk application for a complete list of supported values. Note You can customize the existing default list. Adding new values is also supported.	No
`<is-template>`	Specifies whether the change record is a template Valid values: true, false	No
`<cab-approval>`	Specifies whether the change has the Change Advisory Board's approval Valid values: yes, no	No
`<cab>`	Specifies the Change Advisory Board associated with the change record Valid values: See the Administration section of the CA Service Desk application for a complete list of supported values.	No
`<is-child>`	Specifies whether the change record has a parent change assigned Valid values: true, false	No
`<impact>`	Specifies the impact associated with this change record Valid values: See the Administration section of the CA Service Desk application for a complete list of supported values. Note You can customize the existing default list.	No
`<sla-violation>`	Specifies whether the change record is associated with a service level agreement (SLA) violation Valid values: true, false	No
`<summary>`	Specifies a summary of information associated with the change record Valid values: Any string	No
`<description>`	Specifies the description text associated with the change record Valid values: Any string	No
`<business-case>`	Specifies the business case associated with the change record Valid values: Any string	No
`<backout-plan>`	Specifies the actions to be taken to restore the service if the associated change fails Valid values: Any string	No
`<business-justification>`	Specifies the business justification associated with the change record Valid values: Any string	No
`<parent-change>`	Specifies the parent change associated with the change record Valid values: A valid change ID	No
`<root-cause>`	Specifies the root cause associated with the change record Valid values: See the Administration section of the CA Service Desk application for a complete list of supported values. Note You can customize the existing default list. Adding new values is also supported.	No
`<earliest-schedule-start-date>`	Retrieves all change records with `<schedule-start-date>` greater than or equal to the value specified Valid values: DateTime in the format mm/dd/yyyy hh:mm am/pm. For example, 10/04/2011 09:27 pm.	No
`<latest-schedule-start-date>`	Retrieves all change records with `<schedule-start-date>` less than or equal to the value specified Valid values: DateTime in the format mm/dd/yyyy hh:mm am/pm. For example, 10/04/2011 09:27 pm.	No
`<earliest-schedule-end-date>`	Retrieves all change records with `<schedule-end-date>` greater than or equal to the value specified Valid values: DateTime in the format mm/dd/yyyy hh:mm am/pm. For example, 10/04/2011 09:27 pm.	No
`<latest-schedule-end-date>`	Retrieves all change records with `<schedule-end-date>` less than or equal to the value specified Valid values: DateTime in the format mm/dd/yyyy hh:mm am/pm. For example, 10/04/2011 09:27 pm.	No
`<earliest-need-by-date>`	Retrieves all change records with `<need-by-date>` greater than or equal to the value specified Valid values: DateTime in the format mm/dd/yyyy hh:mm am/pm. For example, 10/04/2011 09:27 pm.	No
`<latest-need-by-date>`	Retrieves all change records with `<need-by-date>` less than or equal to the value specified Valid values: DateTime in the format mm/dd/yyyy hh:mm am/pm. For example, 10/04/2011 09:27 pm.	No
`<earliest-open-date>`	Retrieves all change records with `<open-date>` greater than or equal to the value specified Valid values: DateTime in the format mm/dd/yyyy hh:mm am/pm. For example, 10/04/2011 09:27 pm.	No
`<latest-open-date>`	Retrieves all change records with `<open-date>` less than or equal to the value specified Valid values: DateTime in the format mm/dd/yyyy hh:mm am/pm. For example, 10/04/2011 09:27 pm.	No
`<earliest-resolve-date>`	Retrieves all change records with `<resolve-date>` greater than or equal to the value specified Valid values: DateTime in the format mm/dd/yyyy hh:mm am/pm. For example - 10/04/2011 09:27 pm.	No
`<latest-resolve-date>`	Retrieves all change records with `<resolve-date>` less than or equal to the value specified Valid values: DateTime in the format mm/dd/yyyy hh:mm am/pm. For example, 10/04/2011 09:27 pm.	No
`<earliest-close-date>`	Retrieves all change records with `<close-date>` greater than or equal to the value specified Valid values: DateTime in the format mm/dd/yyyy hh:mm am/pm. For example, 10/04/2011 09:27 pm.	No
`<latest-close-date>`	Retrieves all change records with `<close-date>` less than or equal to the value specified Valid values: DateTime in the format mm/dd/yyyy hh:mm am/pm. For example, 10/04/2011 09:27 pm.	No
`<earliest-estimated-completion-date>`	Retrieves all change records with `<estimated-completion-date>` greater than or equal to the value specified Valid values: DateTime in the format mm/dd/yyyy hh:mm am/pm. For example, 10/04/2011 09:27 pm.	No
`<latest-estimated-completion-date>`	Retrieves all change records with `<estimated-completion-date>` less than or equal to the value specified Valid values: DateTime in the format mm/dd/yyyy hh:mm am/pm. For example, 10/04/2011 09:27 pm.	No
`<earliest-actual-completion-date>`	Retrieves all change records with `<actual-completion-date>` greater than or equal to the value specified Valid values: DateTime in the format mm/dd/yyyy hh:mm am/pm. For example, 10/04/2011 09:27 pm.	No
`<latest-actual-completion-date>`	Retrieves all change records with `<actual-completion-date>` less than or equal to the value specified Valid values: DateTime in the format mm/dd/yyyy hh:mm am/pm. For example, 10/04/2011 09:27 pm.	No
`<least-estimated-cost>`	Retrieves all change records with `<estimated-cost>` greater than or equal to the value specified Valid values: Any positive integer	No
`<greatest-estimated-cost>`	Retrieves all change records with `<estimated-cost>` less than or equal to the value specified Valid values: Any positive integer	No
`<least-actual-cost>`	Retrieves all change records with `<actual-cost>` greater than or equal to the value specified Valid values: Any positive integer	No
`<greatest-actual-cost>`	Retrieves all change records with `<actual-cost>` less than or equal to the value specified Valid values: Any positive integer	No
`<least-estimated-duration>`	Retrieves all change records with `<estimated-duration>` greater than or equal to the value specified Valid values: Duration in the format hh:mm:ss. For example, 10:20:30.	No
`<greatest-estimated-duration>`	Retrieves all change records with `<estimated-duration>` less than or equal to the value specified Valid values: Duration in the format hh:mm:ss. For example, 10:20:30.	No
`<least-actual-duration>`	Retrieves all change records with `<actual-duration>` greater than or equal to the value specified Valid values - Duration in the format hh:mm:ss. For example, 10:20:30.	No
`<greatest-actual-duration>`	Retrieves all change records with `<actual-duration>` less than or equal to the value specified Valid values: Duration in the format hh:mm:ss. For example, 10:20:30.	No
`<implementation-plan>`	Specifies the implementation plan associated with the change record Valid values: Any String value	No
`<number-of-records>`	Specifies the number of records to retrieve Valid values: Any positive integer Default value: -1 (Retrieves a maximum of 250 records)	No
`<additional-search-arguments>`	Specifies the custom search query involving one or more attributes Valid values: See the CA Service Desk application and its Technical Reference Guide for valid search query.	No

The following figure illustrates a sample adapter request for the Find Change operation:

Sample adapter request for the Find Change operation


<casd-request>
  <operation-name>find-change</operation-name>
  <arguments>
    <target>
      <soap-url>https://machine.domain.com:8443/axis/services/USD_R11_WebService?wsdl</soap-url>
      <host>172.11.11.111</host>
      <user-name>username</user-name>
      <password>password</password>
      <port>8443</port>
      <protocol>https</protocol>
      <use-ssl-certificate>true</use-ssl-certificate>
      <allow-unsigned-certificate>true</allow-unsigned-certificate>
      <install-certificate>true</install-certificate>
      <passphrase>changeit</passphrase>
    </target>
    <change-number>330</change-number>
    <assignee>ServiceDesk</assignee>
    <created-by>ServiceDesk</created-by>
    <group>g1</group>
    <closure-code>Successful</closure-code>
    <priority>3</priority>
    <risk/>
    <is-active>true</is-active>
    <affected-end-user>System_AM_User</affected-end-user>
    <requestor>ServiceDesk</requestor>
    <status>open</status>
    <category>Add.Telco.Handset</category>
    <is-template/>
    <cab-approval>yes</cab-approval>
    <cab>Test Group</cab>
    <impact>1-Entire Organization</impact>
    <summary>Test summary</summary>
    <description>Test description</description>
    <business-case>b2</business-case>
    <backout-plan>bp</backout-plan>
    <business-justification>bj</business-justification>
    <is-child/>
    <parent-change>96</parent-change>
    <implementation-plan/>
    <root-cause>A</root-cause>
    <sla-violation/>
    <earliest-schedule-start-date/>
    <latest-schedule-start-date/>
    <earliest-schedule-end-date/>
    <latest-schedule-end-date/>
    <earliest-need-by-date/>
    <latest-need-by-date/>
    <earliest-open-date/>
    <latest-open-date/>
    <earliest-close-date/>
    <latest-close-date/>
    <earliest-resolve-date/>
    <latest-resolve-date/>
    <earliest-estimated-completion-date/>
    <latest-estimated-completion-date/>
    <earliest-actual-completion-date/>
    <latest-actual-completion-date/>
    <least-estimated-cost/>
    <greatest-estimated-cost/>
    <least-actual-cost/>
    <greatest-actual-cost/>
    <least-actual-duration/>
    <greatest-actual-duration/>
    <least-estimated-duration/>
    <greatest-estimated-duration/>
    <number-of-records>-1</number-of-records>
    <additional-search-arguments/>
  </arguments>
</casd-request>

The following figure illustrates the adapter response for the sample request:

Sample adapter response for the Find Change operation


<casd-response>
  <metadata>
    <status>success</status>
    <response-count>1</response-count>
  </metadata>
  <responses>
    <response>
      <metadata>
        <status>success</status>
        <count>1</count>
      </metadata>
      <items>
        <item>
          <Handle>chg:400238</Handle>
          <description>Test description</description>
          <actions></actions>
          <is-active>YES</is-active>
          <actual-completion-date>11/08/2011 02:27 PM</actual-completion-date>
          <actual-implementation-start-date>11/30/2011 02:31 PM</actual-implementation-start-date>
          <actual-implementation-end-date>11/30/2011 02:31 PM</actual-implementation-end-date>
          <actual-cost>2000</actual-cost>
          <actual-duration>10:40:00</actual-duration>
          <affected-end-user>System_AM_User,,</affected-end-user>
          <assignee>ServiceDesk,,</assignee>
          <backout-plan>bp</backout-plan>
          <business-case>b2</business-case>
          <call-back-date></call-back-date>
          <call-back-flag>0</call-back-flag>
          <category>Add.Telco.Handset</category>
          <change-number>330</change-number>
          <close-date></close-date>
          <closure-code>Successful</closure-code>
          <implementation-plan></implementation-plan>
          <estimated-completion-date>11/05/2011 02:26 PM</estimated-completion-date>
          <estimated-cost>1000</estimated-cost>
          <estimated-duration>02:30:50</estimated-duration>
          <group>g1</group>
          <id>400238</id>
          <impact>1-Entire Organization</impact>
          <business-justification>bj</business-justification>
          <last-modified-by>ServiceDesk,,</last-modified-by>
          <created-by>ServiceDesk,,</created-by>
          <modified-date>11/23/2011 04:38 PM</modified-date>
          <need-by-date>11/08/2012 11:32 AM</need-by-date>
          <open-date>11/23/2011 04:38 PM</open-date>
          <organization>org2</organization>
          <parent-change>96</parent-change>
          <priority>3</priority>
          <predicted-sla-violation>0</predicted-sla-violation>
          <product></product>
          <project>Test1</project>
          <requestor>ServiceDesk,,</requestor>
          <resolve-date></resolve-date>
          <risk></risk>
          <root-cause>A</root-cause>
          <schedule-start-date>11/03/2011 02:25 PM</schedule-start-date>
          <schedule-end-date>11/04/2011 12:55 AM</schedule-end-date>
          <schedule-duration>10:30:00</schedule-duration>
          <service-date></service-date>
          <service-num></service-num>
          <sla-violation>0</sla-violation>
          <start-date></start-date>
          <status>Open</status>
          <summary>Test summary</summary>
          <template-name></template-name>
          <cab>Test Group</cab>
          <cab-approval>YES</cab-approval>
          <string1></string1>
          <string2></string2>
          <string3></string3>
          <string4></string4>
          <string5></string5>
          <string6></string6>
          <type-of-contact></type-of-contact>
        </item>
      </items>
    </response>
  </responses>
</casd-response>

Find Change operation for the CA Service Desk adapter

Comments