Sales Forecast
Service to operate on forecast items. The supported operations are create, update, get, and delete. Forecast items are snapshots of revenues predicted to close within the forecast period.
Life Cycle Status: Active
QName: {http://xmlns.oracle.com/apps/sales/salesForecasting/forecasts/forecastService/}ForecastIntegService
Service WSDL URL: https://servername/crmService/ForecastIntegService?WSDL
Logical Business Objects
-
CRM : Sales Forecasting
-
CRM : Sales Forecasting
Relationships
The following table describes how this service data object is related to other service data objects or business object services.
| Relationship Type | Object or Service |
|---|---|
|
Handles |
|
|
Handles |
Operations
createItem
A web service method to create a forecast item from a revenue item.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
revnId |
long |
The ID of the revenue which needs to be converted to a forecast item. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
void |
The parameter returns the created forecast item for the method createItem. |
deleteItem
A web service method which deletes a forecast item.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
itemId |
long |
The ForecastItemId is passed as an input to delete a forecast item. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
void |
The parameter returns the deleted forecast item for the method deleteItem. |
getForecastItemDetail
A web service method which returns a forecast item object for a given forecast item ID.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
forecastItemId |
long |
The ForecastItemId is passed as input to get details on a forecast item. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The parameter returns a forecast item detail object for the method getForecastItemDetail. |
updateForecastItemDetail
Updates the forecast item and synchronizes the underlying revenue attributes.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
forecastItemDetail |
Forecast Item |
The ForecastItemDetail object is passed as input to update a forecast item. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The parameter returns a forecast item detail object. |
findForecastItemDetail
Finds a particular record or set of records based on the criteria.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
findCriteria |
{http://xmlns.oracle.com/adf/svc/types/}FindCriteria |
The parameter to set the criteria to find the set of records. |
|
findControl |
{http://xmlns.oracle.com/adf/svc/types/}FindControl |
The filtering condition to separate out the set of records. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The parameter returns the type of item object for the method findForecastItemDetail. |
getTerritoryForecast
A web service method which obtains territory forecast details based on key information.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
forecastParticipantId |
long |
The system generated unique participant identifier to get territory forecast details. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The parameter returns the territory forecast details for the method getTerritoryForecast. |
updateTerritoryForecast
A web service method to update territory forecast details.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
territoryForecast |
Forecast Territory Details |
The input parameter to update territory forecast details. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The parameter returns the updated territory forecast details for the method updateTerritoryForecast. |
findTerritoryForecast
A web service method to find territory forecast based on a set of criteria.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
findCriteria |
{http://xmlns.oracle.com/adf/svc/types/}FindCriteria |
The parameter to set the find criteria for territory forecast. |
|
BindParticipantId |
long |
The parameter to find territory forecast based on participant ID criteria. |
|
BindFcstHeaderId |
long |
The parameter to find territory forecast based on header ID criteria. |
|
BindForecastName |
string |
The parameter to find territory forecast based on forecast name criteria. |
|
BindTerritoryId |
long |
The parameter to find territory forecast based on territory ID criteria. |
|
BindTerritoryVersionId |
long |
The parameter to find territory forecast based on territory version ID criteria. |
|
BindOwnerResourceId |
string |
The parameter to find territory forecast based on owner resource ID criteria. |
|
BindForecastType |
string |
The parameter to find territory forecast based on forecast type criteria. |
|
findControl |
{http://xmlns.oracle.com/adf/svc/types/}FindControl |
The filtering condition to separate out the set of records. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The parameter returns the output list of values from find service. |
getDfltObjAttrHints
Retrieves user interface hints, such as the service data object label and object attribute labels, for the specified service data object and locale. As a prerequisite, invoke the getEntityList operation defined on this service to get the list of possible values for the viewName request payload element.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
viewName |
string |
The service view usage name, an internal name for the service data object. Specify the value of the <name> element from the getEntityList operation response payload. |
|
localeName |
string |
The locale to use when evaluating locale-based user interface hints. The localeName is in ISO 639-1 format. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
{http://xmlns.oracle.com/adf/svc/types/}ObjAttrHints |
The label and user interface hints for the specified service data object and its attributes in a name-value pair format. |
getServiceLastUpdateTime
Returns the date and time when the schema files referenced in the service definition last changed.
Life Cycle Status: Active
Request Payload
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
{http://xmlns.oracle.com/adf/svc/types/}dateTime-Timestamp |
The date and time when the service definition last changed in ISO 8601 format. |
getEntityList
Gets the list of service data objects defined on this service.
Life Cycle Status: Active
Request Payload
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
{http://xmlns.oracle.com/adf/svc/types/}ServiceViewInfo |
A list of service data objects defined on this service. For each service data object, the result includes the QName, internal name, and boolean values indicating whether create, update, merge, and delete operations can be performed on the object. |
Security
The following tables list the privileges required to perform the service operations, and the duty roles that each privilege is granted to.
Service Operations to Privileges Mapping
| Operation Name | Privilege Code | Privilege Name | Privilege Description |
|---|---|---|---|
|
updateForecastItemDetail |
ZSF_MANAGE_SALES_FORECAST_PARTICIPANT_PRIV |
Manage Sales Forecast Participant |
Allows viewing and submitting of all sales forecasts. Also includes the ability to submit and reject all child territories. |
|
getForecastItemDetail |
ZSF_MANAGE_SALES_FORECAST_PARTICIPANT_PRIV |
Manage Sales Forecast Participant |
Allows viewing and submitting of all sales forecasts. Also includes the ability to submit and reject all child territories. |
|
deleteItem |
ZSF_MANAGE_SALES_FORECAST_PARTICIPANT_PRIV |
Manage Sales Forecast Participant |
Allows viewing and submitting of all sales forecasts. Also includes the ability to submit and reject all child territories. |
|
createItem |
ZSF_MANAGE_SALES_FORECAST_PARTICIPANT_PRIV |
Manage Sales Forecast Participant |
Allows viewing and submitting of all sales forecasts. Also includes the ability to submit and reject all child territories. |
|
updateTerritoryForecast |
ZSF_MANAGE_SALES_FORECAST_PARTICIPANT_PRIV |
Manage Sales Forecast Participant |
Allows viewing and submitting of all sales forecasts. Also includes the ability to submit and reject all child territories. |
|
getTerritoryForecast |
ZSF_MANAGE_SALES_FORECAST_PARTICIPANT_PRIV |
Manage Sales Forecast Participant |
Allows viewing and submitting of all sales forecasts. Also includes the ability to submit and reject all child territories. |
|
findTerritoryForecast |
ZSF_MANAGE_SALES_FORECAST_PARTICIPANT_PRIV |
Manage Sales Forecast Participant |
Allows viewing and submitting of all sales forecasts. Also includes the ability to submit and reject all child territories. |
|
findForecastItemDetail |
ZSF_MANAGE_SALES_FORECAST_PARTICIPANT_PRIV |
Manage Sales Forecast Participant |
Allows viewing and submitting of all sales forecasts. Also includes the ability to submit and reject all child territories. |
Privileges to Duty Roles Mapping
| Privilege Code | Granted to Duty Role Code | Granted to Duty Role Name | Granted To Duty Role Description |
|---|---|---|---|
|
ZSF_MANAGE_SALES_FORECAST_PARTICIPANT_PRIV |
ORA_ZBS_SALES_RESTRICTED_USER_JOB |
Sales Restricted User |
Has the same scope of visibility as the Sales Manager role to application data but can only view or read most of that data. The ability to create, update or delete data is restricted to notes, activities, attachments and reports. |
|
ZSF_MANAGE_SALES_FORECAST_PARTICIPANT_PRIV |
ORA_ZSF_SALES_FORECASTING_DUTY |
Sales Forecasting |
Manages sales forecasts, sales forecast items, sales forecast adjustments, and sales forecast item adjustments. Additional duties include exporting forecast information. |
|
ZSF_MANAGE_SALES_FORECAST_PARTICIPANT_PRIV |
ORA_ZSF_SALES_FORECASTING_MANAGEMENT_DUTY |
Sales Forecasting Management |
Manages sales forecasts, sales forecast items, sales forecast adjustments, and sales forecast item adjustments. Additional duties include exporting forecast information and managing subordinates forecasts. |
|
ZSF_MANAGE_SALES_FORECAST_PARTICIPANT_PRIV |
ORA_ZSF_SALES_FORECASTING_DELEGATED_MANAGEMENT_DUTY |
Sales Forecasting Delegated Management |
Manages sales forecasts, sales forecast items, sales forecast adjustments, and sales forecast item adjustments. Additional duties include exporting forecast information and managing forecasts on behalf of other users. |
Duty Roles to Duty or Job Roles Mapping
| Duty Role Code | Granted to Duty or Job Role Code | Granted to Duty or Job Role Name | Granted To Duty or Job Role Description |
|---|---|---|---|
|
ORA_ZBS_SALES_RESTRICTED_USER_JOB |
ORA_ZCA_ACCESS_GROUPS_ENABLEMENT_DUTY |
Access Groups Enablement |
Enables the Access Groups functionality. |
|
ORA_ZBS_SALES_RESTRICTED_USER_JOB |
ORA_MKL_LEAD_REGISTRATION_PROCESSING_READ_ONLY_DUTY |
Lead Registration Processing Read Only |
Read Only role for Lead Registration Processing Duty. |
|
ORA_ZBS_SALES_RESTRICTED_USER_JOB |
ORA_MOO_OPPORTUNITY_SALES_MANAGER_READ_ONLY_DUTY |
Opportunity Sales Manager Read Only |
Read Only role for Opportunity Sales Manager Duty. |
|
ORA_ZBS_SALES_RESTRICTED_USER_JOB |
ORA_MOO_OPPORTUNITY_SALES_REPRESENTATIVE_READ_ONLY_DUTY |
Opportunity Sales Representative Read Only |
Read Only role for Opportunity Sales Representative Duty. |
|
ORA_ZBS_SALES_RESTRICTED_USER_JOB |
ORA_MOO_OPPORTUNITY_TERRITORY_RESOURCE_READ_ONLY_DUTY |
Opportunity Territory Resource Read Only |
Read Only role for Opportunity Territory Resource Duty. |
|
ORA_ZBS_SALES_RESTRICTED_USER_JOB |
ORA_MKT_PERSONAL_CAMPAIGN_MANAGEMENT_READ_ONLY_DUTY |
Personal Campaign Management Read Only |
Read Only role for Personal Campaign Management Duty. |
|
ORA_ZBS_SALES_RESTRICTED_USER_JOB |
ORA_ZSP_PRODUCT_RECOMMENDATION_ANALYSIS_READ_ONLY_DUTY |
Product Recommendation Analysis Read Only |
Read Only role for Product Recommendation Analysis Duty |
|
ORA_ZBS_SALES_RESTRICTED_USER_JOB |
ORA_ZSF_SALES_FORECASTING_MANAGEMENT_READ_ONLY_DUTY |
Sales Forecasting Management Read Only |
Read Only role for Sales Forecasting Management Duty. |
|
ORA_ZBS_SALES_RESTRICTED_USER_JOB |
ORA_MKL_SALES_LEAD_FOLLOW_UP_MANAGEMENT_READ_ONLY_DUTY |
Sales Lead Follow Up Management Read Only |
Read Only role for Sales Lead Follow Up Management Duty. |
|
ORA_ZBS_SALES_RESTRICTED_USER_JOB |
ORA_MKL_SALES_LEAD_FOLLOW_UP_READ_ONLY_DUTY |
Sales Lead Follow Up Read Only |
Read Only role for Sales Lead Follow Up Duty |
|
ORA_ZBS_SALES_RESTRICTED_USER_JOB |
ORA_ZCM_SALES_PARTY_MANAGEMENT_READ_ONLY_DUTY |
Sales Party Management Read Only |
Read Only role for Sales Party Management Duty. |
|
ORA_ZBS_SALES_RESTRICTED_USER_JOB |
ORA_SVC_SR_CONTRIBUTOR |
Service Request Contributor |
Can create Service Requests and help with resolution of the Service Request. Has basic Service Request Management capabilities. Would not be able to respond to customer, assign SR to a user or change the status of a SR. |
|
ORA_ZBS_SALES_RESTRICTED_USER_JOB |
ORA_MOT_TERRITORY_MANAGEMENT_READ_ONLY_DUTY |
Territory Management Read Only |
Read Only role for Territory Management Duty. |