Book
The book object provides a way of segmenting data according to the organizational units of your business, such as territories or products. Administrators can create book hierarchies based on how they want to organize your information, and then set up users to have the appropriate level of access to books.
Usage
To specify when book assignments become active for accounts and contacts, you can update the StartDate and EndDate fields of the Book child object through Web service calls. If you do not specify a start date for a book assignment, then the assignment becomes active immediately. You can also update the FuturePrimary field to specify whether the book that you assign to an account or contact is to become the primary book for that account or contact when the book assignment becomes active.
The FuturePrimary field is not visible in the Oracle CRM On Demand UI and the StartDate and EndDate fields are read-only in the UI. For more information about time-based book assignments, see Oracle CRM On Demand Online Help
Parent Objects
Account, Activity, Contact, Custom Object 1 - 3, Lead, Household, Lead, Opportunity, Product Category, Service Request.
Child Components
Methods Called
The following table details the methods called by the Book service.
Method | Name as Defined in Service |
---|---|
BookDelete |
|
BookDeleteChild |
|
BookInsert |
|
BookInsertChild |
|
BookInsertOrUpdate |
|
BookQueryPage |
|
BookUpdate |
|
BookUpdateChild |
Fields
The following table details the required and read-only fields for the book object.
Child Component | Field Name | Type |
---|---|---|
Book (parent) |
BookName |
Required |
BookId |
Read-only |
|
Read-only |
||
BookUser |
UserAlias |
Required |
AccessProfileName |
Required |
|
Read-only |
||
SubBook |
BookName |
Required |
Read-only |
The following table details the status key for the book object.
Child Component | Field Name |
---|---|
Book (parent) |
|
BookId |
|
BookName |
|
BookUser |
|
BookId |
|
SubBook |
BookId |
UserId |
The following table details the pick map fields for the book object.
Child Component | Pick Map Field | Maps To |
---|---|---|
Book |
BookName |
BookId |
BookUser |
BookName |
BookId |
SubBook |
BookName |
BookId |
The following table provides a list of the filterable fields for the child components of the book object, and a list of user key combinations for each child component.
Child Components | Filterable Fields | User Key Field Combinations |
---|---|---|
Book (parent) |
All |
BookId |
BookName |
||
BookUser |
None |
BookId |
UserId |
||
UserExternalSystemId |
||
SubBook |
None |
BookId |
BookName |
The following table details the picklists available for the book object.
Child Component | Field Name |
---|---|
Book (parent) |
BookType |
ParentBookName |
|
BookUser |
UserAlias |
BookRole |
|
AccessProfileName |
For more information on the fields accessible through the Book Web service, go to the Web Services Administration page within the Oracle CRM On Demand application and generate the WSDL file for the book object.