Show TOC

Function documentationExternal Interface

 

The external interface enables you to create a Web Request on the basis of an imported XML request file. A service transaction is also generated with the linked XML request data in the Web Client with this offline mode, as with the online mode. You can also include files, as attachments, in a Web request by means of the external interface.

Examples of applications for using the external interface are:

  • To generate Web requests submitted by requesters on paper forms (for example, PDF forms).

    In this case, the request data must be scanned onto paper and then converted into an XML request file by an external program. You can include the scanned document in the Web request as an attachment.

  • To forward request data incorrectly derived from one organization to another using the Remote Function Call (RFC). This generates a Web request automatically in the receiver organization.

The following figure illustrates one of the above-mentioned application examples: The request data submitted on paper must be scanned and then converted into an XML request file by an external program. The request data is formatted with the required parameters and the external interface is called using RFC. The corresponding request is generated in SAP CRM based on the request data (service transaction with the linked request data).

The external interface also supports the optional transfer of files as attachments for the service process (represented by the dashed line below).

Prerequisites

  • The correct request category including the corresponding request data structure and transaction type are maintained for the respective request in Customizing for SAP CRM.

  • Web request-conform XML file:

    The imported XML file has a XML data structure that corresponds with the request category and uses the same XML tags that appear in the request data structure of the Web request.

  • If the business partner is entered for the creator and requester, their master data must be created in the corresponding business partner roles.

Features

Function Module CRM_WEBREQ_EXTERN_CREATE

The RFC-compatible function module CRM_WEBREQ_EXTERN_CREATE is delivered for the external interface. The parameter Request Category determines the Web request to be created. The parameter Requester is used to assign the corresponding business partner in the role Sold-To Party. As extra parameters, you can enter the optional parameters Creator, a Category of CRM Activity Management, and a freely definable parameter.

The parameters can also be transferred to the external interface using BAdI method FORM_ON_CREATION. Note that a customer-enhancement is only supported for this BAdI method.

Function Module CRM_WEBREQ_EXTERN_CREATE_DOC

This function module enables you to include additional files with a Web request, as attachments. Both compressed and uncompressed files of various formats are supported. The number of file attachments is not restricted. The attachments are appended to the respective CRM service process, from where it can be called.

Parameter Category

You can classify Web requests according to their origin using parameter Category. This way it is possible to distinguish between requests created online and those created offline. The field Category is hidden by default and can be selected for display in service process processing using the function Personalize.

You define the respective categories in Customizing for CRM by choosing Start of the navigation path Customer Relationship Management Next navigation step Transactions Next navigation step Settings for Activities Next navigation step Maintain Categories, Goals, and Priorities Next navigation step Maintain Categories End of the navigation path.

Demo Programs

CRM_WEBREQ_EXTERN_WITH_UPLOAD

In the SAP GUI, two demo programs are provided for you to test the functions of the external interface:

  • Program CRM_WEBREQ_EXTERN_WITH_UPLOAD supports the offline creation of Web requests without attachments.

  • Program CRM_WEBREQ_EXTERN_WITH_UPLOADA supports the offline creation of Web requests with attachments.

Start the demo programs in transaction SE38. For more information, see the program documentation.

See also:

For more information about the use of the external interface, see the relevant function module documentation in transaction SE37.