Appendix: Delivered Web Services and Service Operations

This appendix discusses the delivered web service and service operations for the Correspondence Management component.

Delivered Web Services

This section discusses:

• Correspondence Management web services.

• How to view the Correspondence Management message elements.

Note. PeopleBooks provide functional descriptions of the web services (for example, list of operations and their descriptions) delivered by their applications. For technical information of these web services, refer to the web services documentation that is available after the installation of the application CD. Locate the Web Services Doc folder under %PSHOME% and open the index.html file in that folder to access information about various web services.

See Also

Working with Business Processes and Web Services

Correspondence Management Web Services

PeopleSoft CRM delivers these service operations for the Correspondence Management web service:

• Deliver to Email

  Sends mail correspondence through PeopleSoft correspondence infrastructure. You need to send the context ID and a list of recipient IDs. If you do not send the context ID, then (by default) the system uses the component and market specified in the input to search for the context ID. The message objects (MsgObject) defined in the Web Services Description Language (WSDL) are optional. They are used to send CC (carbon copy) and BCC (blind carbon copy) email addresses and to specify the message subject and message body text. The supports for the transactions and subinteractions are completed by sending the PeopleSoft record name and attributes in name/value pair format.

• Deliver to Printer

  The Deliver to Printer web service is similar to Deliver to Email. Instead of sending the correspondence as an email, you send the correspondence to a printer. In this case, you need to send the printer ID in the message.

• Simple Send Email

  Simple Send Email is designed to do simple email. All you need to do is send From, To, CC, and BCC addresses as well as message subject and message text. The system sends out the emails without passing through the PeopleSoft Correspondence Management infrastructure. It uses a predefined package to send email out and leaves a trace record in the outbound queue.

Note. All three operations, if successful, return a correspondence ID so you can identify the correspondence. These operations, however, do not support file attachments.

This table provides the technical names, operation type, and messages names of the service operations that are related to the Correspondence Management web services:

Viewing the Correspondence Management Message Elements

You can view the elements and fields that are included in each Correspondence Management operation message through PeopleTools.

To view a list of field names and aliases for a particular message:

1. Select PeopleTools, Integration Broker, Integration Setup, Messages.

2. Enter CMF_WEB in the Message Name field and click Search.

   The system lists all the messages that are related to Correspondence Management.

3. Select the message you want to view.

4. Click the message name link under the Parts grid.

   The system opens the Message Definition page in a new browser.

5. 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.