Delivered Web ServicesThis appendix discusses the delivered web services for CRM common components and how to view message elements for tasks and call reports.
Delivered Web ServicesThis section discusses:
Task web service.
Call report web service.
See Also
Working with Business Processes and Web Services
Task Web ServicePeopleSoft CRM delivers these service operations for the Task web service:
This service operation is a synchronous process that takes these inputs to create a task: subject and task type (task types are user defined, for example: MEETING, PHONECALL, and APPOINTMENT).
Optionally, you can supply information on contacts, transactions, assignments and notes to be associated with the task. For each of the optional information you want to add to the task, these values are required as inputs:
(For Contact) Contact Person ID and contact role type.
Make sure that the person ID entered is valid for the call report creation.
(For Transaction) Transaction type, transaction market, and transaction SYNC ID.
(For Assignment) Task assignee and contact role type.
(For Note) Note summary and start date.
This service operation returns the ID of the task once it is created successfully. No recurring tasks can be created through this web service for this release. Attachments cannot be added as part of the task notes.
This service operation is a synchronous process that takes a valid task ID (full ID; partial ID is considered invalid) and returns the task and its detailed information. It returns an empty result set if the ID is invalid. The user ID that is passed in the message determines the tasks that the user is authorized to view.
This service operation is an asynchronous operation that notifies the calling process when a task is completed or canceled. It takes the task ID and sends a response message to notify the calling process when the status of the specified task is changed to either completed or canceled.
This service operation is a synchronous process that takes any of these inputs and returns return a list of tasks and their associated information that match the specified search criteria:
Task subject.
Task type.
Task priority.
Task status.
Task start date.
Task end date.
Task owner.
If no matches are found, the system returns an empty result set.
This service operation is a synchronous process that takes any of these inputs and returns task types that match the specified search criteria:
Task type.
Active flag (Y/N).
Task type description.
Application usage (for example, ALL = All Applications; CHMG = Change Management; FLDS = Field Service; HLPD = HelpDesk; PIM = Personal Information Mgmt; SSP = Strategic Planning; SALS = Sales; SUPP = Support).
If no matches are found, the system returns an empty result set.
This service operation is a synchronous process that takes these inputs to add, delete, or update task assignees:
Task ID.
Assigned To Person ID.
Update Action (ADD = Add; DEL = Delete; UPD = Update).
You can also specify these attributes as inputs when you add, delete or update task assignees: assigned status (ACPT = Accepted; CMPL = Completed; DCLN = Declined; OPEN = Assigned) , contact BO ID, contact role type ID, customer BO ID (make sure that the ID is valid), and customer role type ID.
Note. In order to update a task assignee, the status of the task cannot be Complete or Canceled. Also, the current user has to have access to the task (as defined by the dataset rule RB_MY_TASK) and meets one of these conditions: the user is the owner of the task, OR the user is the assignee of the task and the action selected is UPD, OR the user has manager privileges but is not an assignee of the task.
At the end of the operation, the system returns three pieces of information in the response message: Task ID that was passed in the request message, return code (0 if operation was successful; 1 if failed), and a return message explaining details of the error.
This service operation is a synchronous process that takes these inputs to add, delete, or update task contacts:
Task ID.
Contact Person ID.
Update Action (ADD = Add; DEL = Delete; UPD = Update).
You can also specify these attributes as inputs when you add or update task contacts: contact BO ID, contact role type ID, customer BO ID (make sure that the ID is valid), customer role type ID, and the Primary indicator (Y/N).
Note. In order to update a task contact, the status of the
task cannot be Complete or Canceled.
Also, the current user has to have access to the task (as defined by the dataset
rule RB_MY_TASK).
You can only have one primary contact in a task. Therefore, if you
specify a contact that you add or update as primary, the primary contact flag
of the rest of the contacts in the same task is then set to N.
At the end of the operation, the system returns three pieces of information in the response message: Task ID that was passed in the request message, return code (0 if operation was successful; 1 if failed), and a return message explaining details of the error.
This service operation is a synchronous process that takes the task ID as the input to update task headers. You can specify these attributes that you want to update in the task, which include:
Task Type.
Subject.
Task Priority (task priorities are user defined, for example, 1 = High; 2 = Medium; 3 = Low).
Status (for example, CMPL = completed; CNCL = Canceled; INPR = In Progress; OPEN = Open).
Start Date.
Start Time.
End Date.
End Time.
Time Zone.
Location.
Private flag (Y/N).
Application Usage.
Person ID of the owner.
Description.
Note. In order to update a task header, the status of the task cannot be Complete or Canceled. Also, the current user has to have access to the task (as defined by the dataset rule RB_MY_TASK), and the user must either be the owner of the task, or has manager privileges (but is not an assignee of the task).
At the end of the operation, the system returns three pieces of information in the response message: Task ID that was passed in the request message, return code (0 if operation was successful; 1 if failed), and a return message explaining details of the error.
This service operation is a synchronous process that takes these inputs to add, delete, or update task notes:
Task ID.
Note's Sequence Number.
If you add a new note, the system assigns the next available sequence number to the new note and ignores the one that is supplied.
Task Summary.
Update Action (ADD = Add; DEL = Delete; UPD = Update).
You can specify these attributes as inputs when you add or update task notes: subject, start date, end date, and description.
Note. In order to update a task note, the status of the task cannot be Complete or Canceled. Also, the current user has to have access to the task (as defined by the dataset rule RB_MY_TASK),
At the end of the operation, the system returns three pieces of information in the response message: Task ID that was passed in the request message, return code (0 if operation was successful; 1 if failed), and a return message explaining details of the error.
This service operation is a synchronous process that takes these inputs to add or delete transactions on tasks:
Task ID.
Transaction Type (transaction types are user defined, for example, COMPANY, LEAD, OPPRT, and PARTNER).
Update Action (ADD = Add; DEL = Delete).
Transaction Market.
Transaction SYNC ID.
This is the SYNC ID for the corresponding transaction type ID. Make sure that you enter a valid ID.
Note. In order to update a task transaction, the status
of the task cannot be Complete or Canceled.
Also, the current user has to have access to the task (as defined by the dataset
rule RB_MY_TASK).
You can only have one primary transaction in a task. Therefore, if you
specify a transaction that you add or update as primary, the primary contact
flag of the rest of the transactions in the same task is then set to N.
At the end of the operation, the system returns three pieces of information in the response message: Task ID that was passed in the request message, return code (0 if operation was successful; 1 if failed), and a return message explaining details of the error.
This table provides the technical names, operation type, and messages names of the service operations that are related to the Task web service:
|
Service Operation |
Operation Type |
Request Message |
Response Message |
|
Create Task(RB_TASK_CREATETASK) |
Synchronous |
RBTASKCREATEREQ |
RBTASKCREATERES |
|
Get Task (RB_TASK_GETTASK) |
Synchronous |
RBTASKGETREQ |
RBTASKGETRES |
|
Notify on Task Complete (RB_TASK_NOTIFYONCOMPLETE) |
Asynchronous (Request/Response) |
RBTASKNOTIFYON |
RBTASKNOTIFYON |
|
Search Task(RB_TASK_SEARCHTASK) |
Synchronous |
RBTASKSEARCHREQ |
RBTASKSEARCHRES |
|
Get a List of Task Types (RB_TASK_TASKTYPELIST) |
Synchronous |
RBTASKTYPELISTREQ |
RBTASKTYPELISTRES |
|
Update Task Assignee (RB_TASK_UPDATEASSIGNEE ) |
Synchronous |
RB_TASK_UPD_ASGN_REQ |
RB_TASK_RESULT_RES |
|
Update Task Contact (RB_TASK_UPDATECONTACT ) |
Synchronous |
RB_TASK_UPD_CNTCT_REQ |
RB_TASK_RESULT_RES |
|
Update Task Header (RB_TASK_UPDATEHEADER) |
Synchronous |
RB_TASK_UPD_HDR_REQ |
RB_TASK_RESULT_RES |
|
Update Task Note (RB_TASK_UPDATENOTE) |
Synchronous |
RB_TASK_UPD_NOTE_REQ |
RB_TASK_RESULT_RES |
|
Update Task Transaction (RB_TASK_UPDATETRANSACTION) |
Synchronous |
RB_TASK_UPD_TXN_REQ |
RB_TASK_RESULT_RES |
Call Report Web ServicePeopleSoft CRM delivers these service operations for the Call Report web service:
This service operation is a synchronous process that takes these inputs to create a call report: subject and event type (user maintained, some values are MTG, PHON, and OTHE) for the call report.
Optionally, you can supply information on contacts, transactions, and notes to be included in the call report. For each of the optional information you want to add to the call report, these values are required as inputs:
(For Contact) Person ID.
Make sure that the person ID entered is valid for the call report creation.
(For Transaction) Transaction type, transaction market, and transaction SYNC ID.
(For Note) Note summary.
This service operation returns the ID of the call report once it is created successfully.
This service operation is a synchronous process that takes the call report ID and returns the call report and its detailed information (if the ID is valid). It returns an empty result set if the ID is not valid.
Note. In order to get results successfully, the current user must have access to that call report (as defined by the call report dataset rule RD_CR_LIST_TXN).
This service operation is a synchronous process that takes at least one of these inputs to find and return call reports that match the search criteria:
Call report ID.
Call report subject.
Call report date.
Call report type.
Call report location.
You can also specify the call report related task ID and application usage as additional criteria. This service operation returns one or more call reports that satisfy the search criteria. It returns an empty result set if it cannot find any call report matching the search criteria. The RB_MORERES_FLAG flag is set to True if more than 300 call reports are found.
Note. In order to get search results successfully, the current user must have access to them (as defined by the call report dataset rule RD_CR_LIST_TXN).
This service operation is a synchronous process that takes the call report ID and attributes that you want to update in the call report, which can be:
Call report event type (user defined).
Call report subject.
Call report date.
Call report location.
Application usage (for example, ALL = All Applications; CHMG = Change Management; FLDS = Field Service; HLPD = HelpDesk; PIM = Personal Information Mgmt; SSP = Strategic Planning; SALS = Sales; SUPP = Support).
Note. In order to update a call report header, the current user must have access to that call report (as defined by the dataset rule RD_CR_LIST_TXN).
At the end of the operation, the system returns three pieces of information in the response message: Call Report ID that was passed in the request message, return code (0 if operation was successful; 1 if failed), and a return message explaining details of the error.
This service operation is a synchronous process that takes these inputs to add, delete, or update call report contacts:
Call report ID.
Contact Person ID.
Make sure that the person ID entered is valid for the call report creation.
Update action (ADD = Add; DEL = Delete; UPD = Update).
Note. In order to add, update, or delete a call report contact, the current user must have access to that call report (as defined by the dataset rule RD_CR_LIST_TXN).
You can specify these attributes as inputs when you add or update contacts: contact BO ID, contact role type ID, customer BO ID (make sure that the ID is valid), customer role type ID, and primary indicator (Y/N).
Note. Note that you can only have one primary contact in a call report. Therefore, if you specify a contact that you add or update as primary, the rest of the contacts in the same call report have their primary contact flag set to N.
At the end of the operation, the system returns three pieces of information in the response message: Call Report ID that was passed in the request message, return code (0 if operation was successful; 1 if failed), and a return message explaining details of the error.
This service operation is a synchronous process that takes these inputs to add, delete, or update call report notes:
Call report ID.
Note's Sequence number.
If you add a new note, the system assigns the next available sequence number to the new note and ignores the one that is supplied is ignored.
Update action (ADD = Add; DEL = Delete; UPD = Update).
Note. In order to add, update, or delete a call report notes, the current user must have access to that call report (as defined by the call report dataset rule RD_CR_LIST_TXN). You can specify these attributes as inputs when you add or update notes: note summary, start date, end date, and description.
At the end of the operation, the system returns three pieces of information in the response message: Call Report ID that was passed in the request message, return code (0 if operation was successful; 1 if failed), and a return message explaining details of the error.
Update Call Report Transaction
This service operation is a synchronous process that takes these inputs to add or delete call report transactions:
Call report ID.
Transaction type (transaction types are user defined, for example, COMPANY, LEAD, OPPRT, and PARTNER).
Update action (ADD = Add; DEL = Delete).
Transaction Market.
Transaction SYNC ID.
This is the SYNC ID for the corresponding transaction type ID. Make sure that you enter a valid ID.
Note. In order to add or delete a call report transaction, the current user must have access to that call report (as defined by the call report dataset rule RD_CR_LIST_TXN).
In addition, you can specify a transaction as the primary one when you add or delete transactions. If you specify one transaction in the call report as primary (flag set to Y), the system sets this flag to N for other transactions in the call report as there can only be one primary transaction in a call report.
At the end of the operation, the system returns three pieces of information in the response message: Call Report ID that was passed in the request message, return code (0 if operation was successful; 1 if failed), and a return message explaining details of the error.
This table provides the technical names, operation type, and messages names of the service operations that are related to the Call Report web service:
|
Service Operation |
Operation Type |
Request Message |
Response Message |
|
Create Call Report(RD_CALL_REPORT_CREATE) |
Synchronous |
RD_CALL_REPORT_CREATE_REQ |
RD_CALL_REPORT_CREATE_RES |
|
Get Call Report (RD_CALL_REPORT_GET) |
Synchronous |
RD_CALL_REPORT_GET_REQ |
RD_CALL_REPORT_GET_RES |
|
Search Call Reports(RD_CALL_REPORT_SEARCH) |
Synchronous |
RD_CALL_REPORT_SEARCH_REQ |
RD_CALL_REPORT_SEARCH_RES |
|
Update Call Report Header(RD_CALL_REPORT_UPDATEHEADER) |
Synchronous |
RD_CALL_REPORT_UPD_HDR_REQ |
RD_CALL_REPORT_RESULT_RES |
|
Update Call Report Contact(RD_CALL_REPORT_UPDATECONTACT) |
Synchronous |
RD_CALL_REPORT_UPD_CNTCT_REQ |
RD_CALL_REPORT_RESULT_RES |
|
Update Call Report Note(RD_CALL_REPORT_UPDATENOTE) |
Synchronous |
RD_CALL_REPORT_UPD_NOTE_REQ |
RD_CALL_REPORT_RESULT_RES |
|
Update Call Report Transaction (RD_CALL_REPORT_UPDATETRANS) |
Synchronous |
RD_CALL_REPORT_UPD_TXN_REQ |
RD_CALL_REPORT_RESULT_RES |
Viewing Message Elements for Tasks and Call ReportsYou can view the elements and fields that are included in each operation message for Task and Call Report web services through PeopleTools.
To view a list of field names and aliases for a particular message:
Select PeopleTools, Integration Broker, Integration Setup, Messages.
Enter RB_TASK in the Message Name field and click Search. The system lists all the messages that are related to the Task web service.
To view messages that are related to the Call Report web service, enter RD_CALL_REPORT in the Message Name field.
Select the message you want to view.
Click the message name link under the Parts grid.
The system opens the Message Definition page in a new browser.
Click the plus sign next to the table name at the bottom of the page to view the fields and aliases associated with the message.