Bookshelf Home | Contents | Index | PDF     

Applications Administration Guide > Configuring the Inbox >

Universal Inbox Business Service Methods

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

Definitions needed to understand the Universal Inbox Business Service (see also Figure 12):

  • 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 two:
    • The Inbox item. This is the record that appears in the Submitted Items views.
    • The Inbox item owner. This is the record that appears in Inbox Items and Completed Items views. Owner information 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 12.  Relationship Between Inbox Items and Inbox Item Owners
Click for full size image

Table 20 lists the Universal Inbox business service methods.

Table 20.  Universal Inbox Business Service Methods
 
Method Name
Description

1

CreateInboxEx

This method creates an Inbox item and an Inbox item owner.

2

CreateInbox

This method creates multiple Inbox items and multiple Inbox item owners.

3

CreateInboxItem

This method creates multiple Inbox items.

4

CreateInboxOwner

This method creates multiple Inbox item owners for an Inbox item.

5

IsInboxItemExisted

This method checks if an Inbox item exists.

6

GetInboxItemInfo

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

7

GetInboxParamInfo

This method returns the name-value pairs for an Inbox item.

8

GetInboxOwnerInfoEx

This method returns field values for an Inbox item owner.

9

GetInboxOwnerInfo

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

10

SetInboxParamInfo

This method inputs name-value pairs for an Inbox item.

11

UpdateInboxItemInfo

This method updates field values for an Inbox item.

12

DeactivateInboxItem

This method deactivates all Inbox item owners for an Inbox item and updates field values for that Inbox item.

13

DeactivateInboxOwner

This method deactivates an Inbox item owner and updates field values for that Inbox item owner.

14

UpdateInboxOwnerInfo

This method updates field values for an Inbox item owner.

15

DeleteInboxItem

This method deletes an Inbox item and all associated Inbox item owners.

16

Initialize

This method is intended for use only by those upgrading from the 7.5.3 version of the application.

This method creates an Inbox item and starts the business service method defined in the Initialize action.

17

RouteInboxItem

This method is intended for use only by those upgrading from the 7.5.3 version of the application. For more information about this method, see Upgrade Guide for the operating system you are using.

This method deactivates existing Inbox item owners and creates new Inbox item owners for an Inbox item.
    
Applications Administration Guide