Show TOC

Function documentationDocument Template Designer

 

You can use this function to put CRM data from a Web service into a document in either Microsoft Word or Adobe PDF format (for example, for printing purposes). Note that Adobe PDF documents are read-only.

You can design a template for an object such as an opportunity, which specifies the layout, logo formatting, and so on, of your document. The system fills the document with CRM data at runtime.

Note Note

SAP does not provide default templates.

End of the note.

Prerequisites

Adobe PDF

For integration with Adobe, you use the following:

  • Adobe Reader on all system clients

  • Adobe LiveCycle Designer for the designer’s machine (included with SAP GUI)

Use the document template designer only when you are familiar with using Adobe LiveCycle Designer. For more information about using Adobe LiveCycle Designer, see the help documentation supplied by Adobe.

Microsoft Word

For integration with Microsoft Word, you use one of the following releases:

  • Microsoft Office 2003 Professional

  • Microsoft Office 2003 Professional Enterprise

  • Microsoft Office 2007 (or later)

Use the document template designer only when you are familiar with Microsoft Office. For more information about using Microsoft Word, especially Custom XML (Microsoft Office 2003 only) or content controls (Microsoft Office 2007 or later), see the help documentation supplied by Microsoft.

Microsoft Word 2007 or Later

  • You have installed the Active Component Framework (ACF) on the computers that you use to create Word files from document templates during runtime. You download ACF from the SAP Service Marketplace at Start of the navigation path http://www.service.sap.com/patchesInformation published on non-SAP site Next navigation step A - Z Index Next navigation step A Next navigation step ACF Next navigation step ACF <Release> Next navigation step Win32 End of the navigation path. For more information about the installation of ACF, see SAP Note 766191Information published on SAP site.

  • You have installed the SAP data panel for Microsoft Word on the computers that you use to define templates at design time. You download the SAP data panel from the SAP Service Marketplace at Start of the navigation path http://www.service.sap.com/patchesInformation published on non-SAP site Next navigation step Installations and Upgrades Next navigation step Browse our Download Catalog Next navigation step SAP Frontend Components Next navigation step SAP Data Panel for MS Word End of the navigation path. Note that you do not need to install the SAP data panel on computers that only use the templates during runtime.

Note Note

In the standard delivery, the system opens Microsoft Word within a separate browser window during runtime. However, if you want to use Microsoft Word outside of a browser window (that is, as Microsoft Word normally runs), enter parameter ID CRM_OI_EXTERN with parameter value X in transaction SU3. In this case, the system opens an empty browser window in the background that you must not close while Microsoft Word is open. When you close Microsoft Word, the system automatically closes the empty browser window.

End of the note.
Adobe and Microsoft Word

  • You have a Web service to supply data to the template.

    The Web service needs to be set to productive and released in the logon client.

  • You have activated the service crm_oi in SAP CRM (transaction SICF).

  • You have made the following security settings in your browser:

    • You have enabled your browser to initialize and script ActiveX controls not marked as safe for scripting

    • You have enabled your browser to run ActiveX controls and plug-ins

    • You have enabled your browser to allow active scripting

  • If you want to create documents and make them available in content management, you have defined profiles for document templates in Customizing for SAP CRM under Start of the navigation path Customer Relationship Management Next navigation step Basic Functions Next navigation step Content Management Next navigation step Define Document Template Profile End of the navigation path.

Features

Adobe PDF

For Adobe PDF templates, the document template designer uses the Adobe LiveCycle Designer, which is structured as follows:

  • XML structure pane

    The left-hand side of each Adobe LiveCycle Designer page incorporates a pane to view data that contains, in an XML structure, all CRM data available for the business object for which you are creating the template. You can choose elements in the XML structure and add them to the template. For example, you can create one–to–many relationships in the template, such as, items in a sales order.

    Note Note

    Text elements displayed are in context, that is, you cannot enter line items in the template before you have entered a header.

    End of the note.

  • Adobe LiveCycle Designer body pages

    • You can create, edit, and format your document template in the Adobe LiveCycle Designer body pages. You do this by adding elements from the XML pane. You then add and format your own input in the fields appended to these elements.

    • You use the Adobe LiveCycle Designer features to format the text in your template.

    • You can choose to preview the PDF.

Microsoft Word 2003

The document template designer is structured as follows:

  • XML structure pane

    On the right-hand side of each Microsoft Word page, the document template designer incorporates an XML structure pane that contains all CRM data available for the business object for which you are creating the template. The pane is divided into the following parts:

    • The upper part displays text elements added to the template in an XML tree structure.

    • The lower part contains a list of elements that you can choose to add to the template.

      This list only contains one element, which becomes the parent node of the XML tree structure. After you add this parent node to your template, the list expands to display more data elements that you can add to the template. These added elements appear as child nodes in the XML tree structure.

    Note Note

    Text elements displayed are in context, that is, you cannot enter line items in the template before you have added a header.

    End of the note.

  • Microsoft Word page

    You can create, edit, and format your document template on the Microsoft Word page. You do this by adding text elements from the XML pane. You then add and format your own input between the XML tags that appear on the page.

Microsoft Word 2007 (or Later)

The document template designer is structured as follows:

  • Microsoft Word add-in

    The SAP data panel add-in shows the XML structure of the assigned Web service in Microsoft Word.

  • Microsoft Word page

    You can create, edit, and format your document template on the Microsoft Word page. You do this by adding text elements from the SAP data panel. You then add and format your own input between the content controls that appear on the page.

Adobe PDF and Microsoft Word

You can incorporate tables into your template and you can nest tables insides tables. Note that multiple-line objects (for example, lists) must be inserted into a table. Otherwise, your document will be incomplete at runtime.

Example Example

1 business partner has 3 addresses and each address has 5 telephones.

End of the example.

Activities

Depending on your system landscape, you might want to use your templates in other systems. You can transport your templates manually in Customizing for Customer Relationship Management by choosing Start of the navigation path Basic Functions Next navigation step Content Management Next navigation step Transport Document Template End of the navigation path.

More Information

Creating Adobe Templates

Creating Microsoft Word Templates

Web Services

Creating a Web Service