Using the RightNow SOAP API Destroy Objects activity

Use the RightNow SOAP API Destroy Objects activity to delete objects such as Account, Answer, Contact, Incident, Meta Answer, Opportunity, Organization, Purchased Product, Sales Product, Task and so on, from the RightNow server. If you delete the primary object, all the corresponding sub objects related to the primary object will also be deleted.

About this task

Use this task to delete objects in the RightNow server. The call to this activity is a synchronous call where the input data is sent to the activity for processing and the response is sent back to the orchestration.

To configure the RightNow SOAP API Destroy Objects activity, complete the following steps:

Procedure

  1. In an active orchestration, open the Activities tab and expand the RightNow SOAP API folder contents.
  2. Drag the Destroy Objects activity icon onto the orchestration. The RightNow SOAP API Destroy Objects activityChecklist is displayed.
  3. In the Checklist, click Summary.
  4. Review the contents of the Activity Name field, and make the required changes.
  5. In the Checklist, click Pick Endpoint.
  6. Click Browse and use the Project Explorer dialog box to select the relevant RightNow SOAP API endpoint.
  7. Optional: You can create the endpoint by clicking New and specifying the required connection details. Click OK to save and use the endpoint for this configuration.
    Note: For more information, see Creating and editing a RightNow SOAP API endpoint.
  8. To make required changes to the selected endpoint configuration, click Edit to access the options in a separate window. Any changes you make globally affects all uses of the endpoint in active orchestrations.
  9. In the Checklist, click Configure.
  10. Click Browse to select the object type. The Browse RightNow SOAP API window is displayed.
  11. In Browse RightNow SOAP API, you can either filter the object type by specifying the object type in the Search for an object type field, or select the object type from the object type list. Click OK. The object field preferences are displayed.
  12. In Object Field Preferences, select the fields that you would like to map by selecting the corresponding field name check boxes.
  13. In the Checklist, click Retry. Review the default settings and make the required changes. For more information, see Specifying retry parameters for RightNow SOAP API activities.
  14. Select the Map Inputs in the Checklist. The XML Schemas generated from the selected object of the Destroy Objects activity are displayed as nodes under the request input parameter in the To Activity panel.
  15. Create a map between the orchestration variables and the input parameter of the activity.
    Note: Values must be provided at run time for any mandatory elements of the input structure. A value can be provided by specifying a default value for element or by linking the element with an input node. During run time if no value is provided for a mandatory element, the activity throws an exception, which is reported by the Web Management Console. If a value is not provided at run time for an optional input parameter, no exception is thrown during run time.
  16. Select the Map Outputs in the Checklist. The XML Schema generated to hold the response of the activity is displayed as nodes under the response output parameter in the From Activity panel.
  17. Create a map between the output parameters and orchestration variables.

Results

You have configured the RightNow SOAP API Destroy Objects activity.



Feedback | Notices


Timestamp icon Last updated: Thursday, December 17, 2015


http://pic.dhe.ibm.com/infocenter/wci/v7r0m0/topic/com.ibm.wci.doc/RightNowSOAPAPI_destroy_activity.html