Bookshelf Home | Contents | Index | PDF     

Siebel Applications Administration Guide > Configuring the Inbox >

Universal Inbox Business Service Methods

This topic discusses the Universal Inbox business service and lists its methods.

The following definitions apply to the Universal Inbox Business Service:

  • Inbox item and Inbox item owner. For most of this chapter, the term Inbox item has been used synonymously with Inbox item owner. But to understand how the methods for the Universal Inbox business service work, it is necessary to distinguish between the Inbox item and the inbox item owner. This distinction follows:
    • The Inbox item. The record that appears in the Submitted Items views.
    • The Inbox item owner. The record that appears in Inbox Items and Completed Items views. Owner information is contained in this record. Typically there are one or more Inbox item owner records associated with one Inbox item record.
  • Name-value pairs. In addition to the predefined fields that belong to the Inbox item records (such as, type name, expiration date), there is provision to store additional data with the Inbox item in the form of name-value pairs. The name-value pairs are typically used to record data specific to the underlying feature object. The name-value pairs are stored in the Inbox Parameters table associated with the Inbox item.

Figure 6 shows the relationship between Inbox items and Inbox item owners.

Figure 6. Relationship Between Inbox Items and Inbox Item Owners

Table 18 lists the methods for the Universal Inbox business service.

Table 18. Universal Inbox Business Service Methods
Method Name
Description

CreateInboxEx

Creates an Inbox item and an Inbox item owner.

CreateInbox

Creates multiple Inbox items and multiple Inbox item owners.

CreateInboxItem

Creates multiple Inbox items.

CreateInboxOwner

Creates multiple Inbox item owners for an Inbox item.

IsInboxItemExisted

Checks if an Inbox item exists.

GetInboxItemInfo

Returns field values from an Inbox item and, if GetParams is true, returns the name-value pairs for the Inbox item.

GetInboxParamInfo

Returns the name-value pairs for an Inbox item.

GetInboxOwnerInfoEx

Returns field values for an Inbox item owner.

GetInboxOwnerInfo

Returns field values for multiple Inbox item owners for a given Inbox item, and returns information about the action status of the items.

SetInboxParamInfo

Inputs name-value pairs for an Inbox item.

UpdateInboxItemInfo

Updates field values for an Inbox item.

DeactivateInboxItem

Deactivates all Inbox item owners for an Inbox item and updates field values for that Inbox item.

DeactivateInboxOwner

Deactivates an Inbox item owner, and updates the field values for that Inbox item owner.

UpdateInboxOwnerInfo

Updates field values for an Inbox item owner.

DeleteInboxItem

Deletes an Inbox item and all associated Inbox item owners.

Initialize

Creates an Inbox item and starts the business service method defined in the Initialize action. This method is intended for use only by those upgrading from the 7.5.3 version of the Siebel application.

RouteInboxItem

Deactivates existing Inbox item owners and creates new Inbox item owners for an Inbox item. This method is intended for use only by those upgrading from the 7.5.3 version of the Siebel application. For more information about this method, see Siebel Database Upgrade Guide.
    
Siebel Applications Administration Guide Copyright © 2013, Oracle and/or its affiliates. All rights reserved. Legal Notices.