Oracle Web Services On Demand Guide > Oracle CRM On Demand Objects Accessible Through Web Services > Core Parent Objects (Web Services v1.0) >

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.

NOTE:  To download the Book WSDL, you must be given access to the Book object. If you do not have access to the Book object, it is not available to download from the Web Services Administration pages. For assistance in gaining access to the Book object, contact your Oracle CRM On Demand service provider.

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

BookUser, SubBook.

Methods Called

Table 208 details the methods called by the Book service.

Table 208. Methods Called by Book Service
Method
Name as Defined in Service

Delete

BookDelete

DeleteChild

BookDeleteChild

Insert

BookInsert

InsertChild

BookInsertChild

InsertOrUpdate

BookInsertOrUpdate

QueryPage

BookQueryPage

Update

BookUpdate

UpdateChild

BookUpdateChild

Fields

Table 209 details the required and read-only fields for the book object.

Table 209. Required and Read-Only Fields for the Book Object
Child Component
Field Name
Type

Book (parent)

BookName

Required

BookId

Read-only

Audit Fields

Read-only

BookUser

UserAlias

Required

AccessProfileName

Required

Audit Fields

Read-only

SubBook

BookName

Required

Audit Fields

Read-only

Table 210 details the status key for the book object.

Table 210. Status Key for the Book Object
Child Component
Field Name

Book (parent)

Audit Fields

BookId

BookName

BookUser

Audit Fields

BookId

SubBook

BookId

UserId

Table 211 details the pick map fields for the book object.

Table 211. Pick Map Fields for the Book Object
Child Component
Pick Map Field
Maps To

Book

BookName

BookId

BookUser

BookName

BookId

SubBook

BookName

BookId

Table 212 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.

Table 212. Filterable Fields and User Key Fields on the Book Object's Child Components
Child Components
Filterable Fields
User Key Field Combinations

Book (parent)

All

BookId

BookName

BookUser

None

BookId

UserId

UserExternalSystemId

SubBook

None

BookId

BookName

Table 213 details the picklists available for the book object.

Table 213. 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.

Oracle Web Services On Demand Guide, Version 25.0 (Oracle CRM On Demand Release 37) Copyright © 2018, Oracle and/or its affiliates. All rights reserved. Legal Notices.