Siebel CRM Web Services Reference > Siebel CRM Primary Web Services >

Universal Inbox


Universal Inbox is an existing business service providing functionality to create, update Inbox items or owner, invoke actions, and so on. This can be modified to include methods to invoke Approve and Reject Actions that will be deployed as a Web service.

Universal Inbox Operations

For a list of operations associated with this Web service, see Table 1422.

Table 1422. Universal Inbox Operations
Name
Description

UniversalInboxCallAction

Executes the action registered for a specific Inbox Item type.

Request Message Description: UniversalInboxCallAction

For a description of this request message, see Table 1423.

Table 1423. Request Message Description: UniversalInboxCallAction
Node
Description
Type

InboxItemId

InboxItemId

String

ActionLIC

ActionLIC

String

InboxTypeName

InboxTypeName

String

OwnerId

OwnerId

String

ObjectId

ObjectId

String

Response Message Description: UniversalInboxCallAction

For a description of this response message, see Table 1424.

Table 1424. Response Message Description: UniversalInboxCallAction
Node
Description
Type

Status

Call status.

String

Error message

Error message returned, if any.

String

This operation will return the following messages:

  • Errors such as post-approval action not configured.
  • User-friendly error message, for example, when the same inbox item is concurrently updated by two Siebel Self-Service users. Messages such as "This has already been approved by a different user" appear if the action has been approved. If the action has been rejected, then the message: this has already been rejected by a different user appears.
  • Returning the actual error message, if any, from the workflow that is being invoked. Since the Self-Service workflow is invoked synchronously, all error messages will be propagated.
  • CallAction business service method will detect and return error messages raised by the Action business service. Web service Infrastructure will detect that the CallAction business service method has returned an error code and create a SOAP fault.
Invalid input conditions

InboxItemId and ActionName are required input parameters to execute the action. Comments is an optional parameter.

Processing errors

Errors occurring during workflow execution and so on will be handled by Web services framework and the error extracted will be sent as SOAP fault.

Universal Inbox Application Interface

This topic describes the application objects called by this Web service. For more information on application implementation, refer to your application development documentation on Oracle Technology Network.

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see Table 1425.

Table 1425. Universal Inbox Service Object
Node
Description
Type

Universal Inbox

Not applicable

CSSUInboxSvc

Data Object (Integration Object)

Since all Input and Output parameters are Strings, Integration Object is not required.

Example Package for Universal Inbox

To view an example of messages for this Web service, navigate to the documentation library for Siebel Business Applications on Oracle Technology Network, and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Extract the files in the zip file.

Request

See the following file to view the sample code:

...\UniversalInbox\UniversalInbox_request.xml

Response

See the following file to view the sample code:

...\UniversalInbox\Universal_Inbox_response.xml

Interface Description (WSDL) for Universal Inbox

To view the interface description for this Web service, navigate to the documentation library for Siebel Business Applications on Oracle Technology Network, and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Extract the files in the zip file.

...\UniversalInbox\UniversalInbox.wsdl

Siebel CRM Web Services Reference Copyright © 2018, Oracle and/or its affiliates. All rights reserved. Legal Notices.