You are on page 1of 64

SAP Document Builder: Business Scenario Configuration Guide

Release 7.02 SP06

SAP Solution Manager

06.06.2011

Copyright
Copyright 2011 SAP AG. All rights reserved. SAP Library document classification: PUBLIC No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP AG. The information contained herein may be changed without prior notice. Some software products marketed by SAP AG and its distributors contain proprietary software components of other software vendors. Microsoft, Windows, Excel, Outlook, and PowerPoint are registered trademarks of Microsoft Corporation. IBM, DB2, DB2 Universal Database, System i, System i5, System p, System p5, System x, System z, System z10, System z9, z10, z9, iSeries, pSeries, xSeries, zSeries, eServer, z/VM, z/OS, i5/OS, S/390, OS/390, OS/400, AS/400, S/390 Parallel Enterprise Server, PowerVM, Power Architecture, POWER6+, POWER6, POWER5+, POWER5, POWER, OpenPower, PowerPC, BatchPipes, BladeCenter, System Storage, GPFS, HACMP, RETAIN, DB2 Connect, RACF, Redbooks, OS/2, Parallel Sysplex, MVS/ESA, AIX, Intelligent Miner, WebSphere, Netfinity, Tivoli and Informix are trademarks or registered trademarks of IBM Corporation. Linux is the registered trademark of Linus Torvalds in the U.S. and other countries. Adobe, the Adobe logo, Acrobat, PostScript, and Reader are either trademarks or registered trademarks of Adobe Systems Incorporated in the United States and/or other countries. Oracle is a registered trademark of Oracle Corporation. UNIX, X/Open, OSF/1, and Motif are registered trademarks of the Open Group. Citrix, ICA, Program Neighborhood, MetaFrame, WinFrame, VideoFrame, and MultiWin are trademarks or registered trademarks of Citrix Systems, Inc. HTML, XML, XHTML and W3C are trademarks or registered trademarks of W3C, World Wide Web Consortium, Massachusetts Institute of Technology. Java is a registered trademark of Sun Microsystems, Inc. JavaScript is a registered trademark of Sun Microsystems, Inc., used under license for technology invented and implemented by Netscape. SAP, R/3, SAP NetWeaver, Duet, PartnerEdge, ByDesign, SAP BusinessObjects Explorer, StreamWork, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and other countries. Business Objects and the Business Objects logo, BusinessObjects, Crystal Reports, Crystal Decisions, Web Intelligence, Xcelsius, and other Business Objects products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of Business Objects Software Ltd. Business Objects is an SAP company.

SAP Document Builder: Business Scenario Configuration Guide

SAP Solution Manager

06.06.2011

Sybase and Adaptive Server, iAnywhere, Sybase 365, SQL Anywhere, and other Sybase products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of Sybase, Inc. Sybase is an SAP company. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary. These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.

SAP Document Builder: Business Scenario Configuration Guide

SAP Solution Manager

06.06.2011

Icons in Body Text


Icon Meaning Caution Example Note Recommendation Syntax

Additional icons are used in SAP Library documentation to help you identify different types of information at a glance. For more information, see Help on Help General Information Classes and Information Classes for Business Information Warehouse on the first page of any version of SAP Library.

Typographic Conventions
Type Style Example text Description Words or characters quoted from the screen. These include field names, screen titles, pushbuttons labels, menu names, menu paths, and menu options. Cross-references to other documentation. Example text EXAMPLE TEXT Emphasized words or phrases in body text, graphic titles, and table titles. Technical names of system objects. These include report names, program names, transaction codes, table names, and key concepts of a programming language when they are surrounded by body text, for example, SELECT and INCLUDE. Output on the screen. This includes file and directory names and their paths, messages, names of variables and parameters, source text, and names of installation, upgrade and database tools. Exact user entry. These are words or characters that you enter in the system exactly as they appear in the documentation. Variable user entry. Angle brackets indicate that you replace these words and characters with appropriate entries to make entries in the system. Keys on the keyboard, for example, F2 or ENTER.

Example text

Example text <Example text>

EXAMPLE TEXT

SAP Document Builder: Business Scenario Configuration Guide

SAP Solution Manager

06.06.2011

SAP Document Builder: Business Scenario Configuration Guide ................................................. 8 Documentation Landscape for SAP Solutions .......................................................................... 8 SAP Notes ............................................................................................................................... 8 SAP Document Builder Activation ............................................................................................ 9 Microsoft Word DOCX Activation .......................................................................................... 9 Data Migration ...................................................................................................................... 9 Element Text and Fill-Ins Activation .................................................................................... 10 System Connections .............................................................................................................. 10 Checking RFC Connections................................................................................................ 10 Checking HTTP Services.................................................................................................... 10 Roles ..................................................................................................................................... 11 Content Manager................................................................................................................ 11 Professional Contract Author .............................................................................................. 12 Legal Contract Author......................................................................................................... 12 Contract Viewer .................................................................................................................. 12 Attribute Library Administrator ............................................................................................ 13 Clause Library Administrator............................................................................................... 13 Template Library Administrator ........................................................................................... 13 User/Author ........................................................................................................................ 13 Group Manager .................................................................................................................. 14 Manager ............................................................................................................................. 14 Assign Users to Roles ........................................................................................................ 15 Business Customizing............................................................................................................ 15 Setting Document Numbering ............................................................................................. 15 Defining Contents ............................................................................................................... 16 Establishing Naming Conventions ...................................................................................... 16 Defining Output Types ........................................................................................................ 17 Questions Asked to an Author ............................................................................................ 17 Defining Content Modifiers ................................................................................................. 18 Setting Default Contents..................................................................................................... 19 Defining a Root Variable for a Content ................................................................................ 19 Defining Variables .............................................................................................................. 19 Defining Element and Output Formats ................................................................................ 21 Defining Element Text Formats........................................................................................... 21 Setting Default Element Text Format .................................................................................. 21 Defining Configuration Parameters ..................................................................................... 22

SAP Document Builder: Business Scenario Configuration Guide

SAP Solution Manager

06.06.2011

Editing Element Texts in WordML ....................................................................................... 27 Editing Element Texts in DOCX .......................................................................................... 28 Creating a Table of Contents in DOCX ............................................................................... 28 Adding Fill-Ins to WordML Element Texts ........................................................................... 29 Adding Fill-Ins to DOCX Element Texts .............................................................................. 29 Defining XML Schemas ...................................................................................................... 30 Adding Schemas to the Schema Library ............................................................................. 31 Editing Element Texts in HTML........................................................................................... 31 Defining Overlays for WordML and DOCX Texts................................................................. 32 Uploading Overlays for WordML and DOCX Texts .............................................................. 34 Defining Overlays for HTML Texts ...................................................................................... 35 Defining Regulation Sets .................................................................................................... 35 Defining Element Types...................................................................................................... 36 Defining Elements .............................................................................................................. 36 Setting Element Inclusion ................................................................................................... 38 Ordering Elements in a Section .......................................................................................... 40 Defining Element Properties ............................................................................................... 40 Defining Prescriptions and Guidance .................................................................................. 41 Defining References ........................................................................................................... 41 Defining Alternate Elements ............................................................................................... 42 Form and Report Elements................................................................................................. 42 Defining Form Interfaces .................................................................................................... 43 Adding Fill-Ins to SAP Interactive Forms by Adobe ............................................................. 44 Establishing a Document Structure ..................................................................................... 46 Defining Document Types .................................................................................................. 47 Defining Document Formats ............................................................................................... 47 Defining Document Groups................................................................................................. 48 Defining Document Selections ............................................................................................ 48 Assigning Regulation Sets to Document Selections ............................................................ 49 Assigning Elements to Document Selections ...................................................................... 49 Setting Document Expiration .............................................................................................. 50 Defining Rules .................................................................................................................... 50 Document Content Checks ................................................................................................. 52 Run Extended Content Check ......................................................................................... 52 List Variables .................................................................................................................. 53 List Structure and Related Variables ............................................................................... 53 List Variable-Reference Associations .............................................................................. 54

SAP Document Builder: Business Scenario Configuration Guide

SAP Solution Manager

06.06.2011

List Standard Elements ................................................................................................... 54 List Rules........................................................................................................................ 55 Check Document Selections ........................................................................................... 55 List Document Selections................................................................................................ 55 Notify Content Managers for Rules that Cannot Be Determined....................................... 56 Workflows .............................................................................................................................. 56 Checking Workflows ........................................................................................................... 58 Web Services ........................................................................................................................ 58 Using Old Proxy Method Used as Web Service .................................................................. 59 Checking Web Services...................................................................................................... 59 Defining Client Proxies ....................................................................................................... 60 Defining Logical Ports......................................................................................................... 60 Integration with SAP NetWeaver Exchange Infrastructure ...................................................... 61 Document Archiving............................................................................................................... 63 Extract SAP Document Builder Documents......................................................................... 63 Delete SAP Document Builder Documents ......................................................................... 63 Notify Processor Prior to Document Expiration.................................................................... 64

SAP Document Builder: Business Scenario Configuration Guide

SAP Solution Manager

06.06.2011

SAP Document Builder: Business Scenario Configuration Guide


The SAP Document Builder Business Scenario Configuration Guide (BSCG) describes the configuration steps required to create legally compliant documents. This guide addresses new configuration and does not cover changes relevant to existing implementations. The SAP Document Builder BSCG covers the entire document lifecycle process.

Target Group
This guide addresses Basis and application consultants.

Implementation Considerations
The implementation steps that you must perform are described in Business Customizing.

Documentation Landscape for SAP Solutions


This section provides you with an overview of the major sources of information available to you on SAP solutions and business scenarios. Always use the current documents in your implementation.

Business Scenario Configuration Guide (BSCG)


This document describes the settings you use to configure the SAP application components and third-party applications required for a business scenario. It contains information specific to business scenarios for the particular Customizing activity. It does not reiterate the Customizing documentation but makes reference to particular Customizing texts.

Customizing
You adjust SAP systems to your customer requirements in Customizing. You can find Customizing activities for all SAP components coupled with general documentation in the SAP GUI system. The structure is component oriented, without reference to a business scenario. The BSCG establishes the link between Customizing and the various business scenarios.

SAP Library
This contains the complete documentation of SAP components.

SAP Notes
This section lists the SAP Notes referenced in this BSCG. Note Number 1046791 1336593 1084258 Title Using WordML as a Text Format in Document Builder 3.0 Automatic Generation of the TOC in the WORDML Assembled Doc Integrating PS SRM and Document Builder

SAP Document Builder: Business Scenario Configuration Guide

SAP Solution Manager

06.06.2011

1154999 802189 517484 1568676 1400966 1584938

Using the Adobe LiveCycle PDF Renderer Using the Apache/FOP PDF Renderer Inactive Services in the Internet Communication Framework SAP Document Builder DOCX editing downport to SAP_BS_FND 702 PSDOCB 3.0 to Document Builder 7.02/BS_FND 7.02 Migration WORDML to DOCX Format Content Migration

SAP Document Builder Activation


You use this function to activate the business function FND, SAP Document Builder (/IPRO/FND_DOCUMENT_BUILDER).

Prerequisites
You activated the SAP Document Builder business function in the SAP Customizing Implementation Guide under Activate Business Functions.

Microsoft Word DOCX Activation


You use this function to integrate SAP Document Builder with Microsoft Word 2007 DOCX.

Prerequisites
You installed SAP Document Builder 7.02 SP06. If you installed SAP Document Builder 7.02 SP05 or lower, see SAP Note 1568675. You activated the business function, SAP Document Builder (/IPRO/FND_DOCUMENT_BUILDER) in Customizing under Activate Business Functions. You activated the business function, FND, Microsoft Word 2007 Support for DOCX (/IPRO/FND_DOCB_WORD2007) in Customizing under Activate Business Functions.

Data Migration
You use this process to migrate data from SAP Document Builder 3.0 to SAP Document Builder 7.02.

Prerequisites
You installed SAP Document Builder 3.0.

Activities
To migrate your data from SAP Document Builder 3.0 to SAP Document Builder 7.02, see SAP Note 1400966.

SAP Document Builder: Business Scenario Configuration Guide

SAP Solution Manager

06.06.2011

To migrate your Customizing data from SAP Document Builder 3.0 to SAP Document Builder 7.02, see SAP Note 1584938.

Element Text and Fill-Ins Activation


You use this function to streamline the UI by combining the individual pages. You configure variable visibility on the dialog UI, document summary, or both. The variable visibility streamlines the document generation process with questions in the business process.

Prerequisites
You activated the business function, SAP Document Builder (/IPRO/FND_DOCUMENT_BUILDER) in Customizing under Activate Business Functions. You activated the business function, FND, Element Text and Fill-Ins UI (/IPRO/FND_DOCB_FILLINS) in Customizing under Activate Business Functions.

System Connections
This section contains information about connecting the systems in an SAP system landscape and involves the following: Defining logical systems and assigning clients in the online transaction processing (OLTP) system Determining the systems, servers, clients, distribution models, and the like, in the system when the SAP application component is installed Completing the configuration settings and performing other activities required for the interactions in an SAP system landscape

Checking RFC Connections


You use this step to check RFC connections relevant for SAP Document Builder.

Procedure
1. Run transaction Configuration of RFC Connections. 2. Open the HTTP Connections to External Server folder (type G). You can use one or more of the following connections when you configure SAP Document Builder: APACHE-FOP G Rendering of FOP to PDF LC ADS GEN G Adobe LiveCycle PDF Generator 7.0

Checking HTTP Services


You use this step to check the HTTP services relevant to SAP Document Builder.

Procedure
1. Run transaction Maintain Services.

SAP Document Builder: Business Scenario Configuration Guide

10

SAP Solution Manager 2. Click Execute. 3. At the bottom of the screen, choose DEFAULT_HOST IPRO. 4. Check whether the IPRO node contains the following: Document Builder Cockpit (WD_COCKPIT) Document Builder (WD_DOCB) Document Builder Element Management (WD_ELEMENT) SAP BC

06.06.2011

WEBDYNPRO

If you experience ICF errors, see SAP Note 517484.

Roles
This section lists the roles that are shipped with SAP Document Builder. To assign users to roles, perform Assign Users to Roles [Page 15]. The following roles are available: Content Manager (/IPRO/CONTENT_MANAGER) Professional Contract Author (/IPRO/PROF_CONTRACT_AUTHOR) Legal Contract Author (/IPRO/CONTRACT_AUTHOR) Contract Viewer (/IPRO/CONTRACT_VIEWER) Attribute Library Administrator (/IPRO/ATTR_LIBRARY_ADMIN) Clause Library Administrator (/IPRO/CLAUSE_LIBRARY_ADMIN) Template Library Administrator (/IPRO/TMPL_LIBRARY_ADMIN) User / Author (/IPRO/AUTHOR) Group Manager (/IPRO/GROUP_MANAGER) Manager (/IPRO/ MANAGER)

Content Manager
Technical name: /IPRO/CONTENT_MANAGER

Tasks
The content manager configures document content in Customizing and is an important actor in SAP Document Builder. Given the complexity of some configuration activities, the content manager must be an IT expert with a highly technical profile. Manager authorizations are required to create, edit, or delete system templates. IMG authorizations are required. Typically, the content manager creates and modifies content in Customizing. This includes defining the following: Configuration parameters and variables

SAP Document Builder: Business Scenario Configuration Guide

11

SAP Solution Manager

06.06.2011

Rules in Formula Builder, regardless of complexity Elements Templates

Integration
The content manager receives input from all other roles to define accurate and legally compliant content.

Professional Contract Author


Technical name: /IPRO/PROF_CONTRACT_AUTHOR

Tasks
Professional contract authors have extended authorizations and perform the following: View clauses in the clause library Assign clauses to a contract Replace clauses with alternate clauses Modify clauses in a contract Select a legal template to create a legal contract View legal contracts

Legal Contract Author


Technical name: /IPRO/CONTRACT_AUTHOR

Tasks
Legal contract authors have extended authorizations similar to professional contract authors. Contrary to professional contract authors, legal contract authors cannot insert clauses from the clause library. Legal contract authors perform the following: Modify clauses in a contract Select a legal template to create a legal contract View legal contracts

Contract Viewer
Technical name: /IPRO/CONTRACT_VIEWER

Tasks
Contract viewers view legal contracts.

SAP Document Builder: Business Scenario Configuration Guide

12

SAP Solution Manager

06.06.2011

Attribute Library Administrator


Technical name: /IPRO/ATTR_LIBRARY_ADMIN

Tasks
Attribute library administrators create and modify SAP Document Builder variables in Customizing under Basic Functions Variables Define Variables.

Clause Library Administrator


Technical name: /IPRO/CLAUSE_LIBRARY_ADMIN

Tasks
Clause library administrators create and modify clauses in Document Builder Cockpit.

Template Library Administrator


Technical name: /IPRO/TMPL_LIBRARY_ADMIN

Tasks
Template library administrators create and modify templates in SAP Document Builder.

User/Author
Technical name: /IPRO/AUTHOR

Tasks
Depending on the business area, a user can be a contracting officer, a human resources officer, or a procurement specialist. Procurement specialists must have a purchasing or business administration background, as well as significant experience in government contracting. Extensive computer literacy is required. Their tasks include contract awards, contract administration, and contract termination. Users or authors have the same authorizations as professional contract authors and perform the following: Create, update, and delete their own documents Create, update, and delete their own user templates Create, update, and delete their own user elements Copy or reassign user templates to another user, due to vacation or job reassignment

SAP Document Builder: Business Scenario Configuration Guide

13

SAP Solution Manager

06.06.2011

Group Manager
Technical name: /IPRO/GROUP_MANAGER

Tasks
Group managers are users with extended privileges. A group manager supervises a group of users. Group managers monitor the user templates and user elements belonging to their group. To an inventory control point (ICP), group managers perform the following: Create, update, and delete user templates and user elements Copy and reassign user templates and user elements from one user to another

A group manager cannot copy and reassign user templates and user elements across ICPs. Create, edit, and delete system templates in each ICP

Manager
Technical name: /IPRO/ MANAGER

Tasks
A manager is a group manager with extended privileges. Managers monitor all users templates and elements. In addition to those performed by group managers, managers perform the following: Create, edit, and delete a template or element for any user Copy and reassign user templates and user elements across groups Complete system administration-related tasks

Authorization Objects
Authorization object Document Builder Authorizations (/IPRO/DCSL) enables you to execute specific functions of SAP Document Builder. To define authorization object /IPRO/DCSL, proceed as follows: 1. Run transaction Maintain Authorization Objects. 2. Expand the DOCB node and double-click Document Builder Authorizations (/IPRO/DCSL). This authorization object contains the following: /IPRO/CTNT Defines the content specifier /IPRO/DCSL Defines the document selection

SAP Document Builder: Business Scenario Configuration Guide

14

SAP Solution Manager

06.06.2011

/IPRO/COMP Defines the document component (element or template) /IPRO/GRP Defines the group to which the component belongs ACTVT Defines the allowed activity

Assign Users to Roles


You can assign system users to roles so that they can perform the related tasks.

Prerequisites
You made roles available in the system.

Procedure
To assign users to roles, proceed as follows: 5. Run transaction Role Maintenance. 6. Enter the technical name of the role. 7. Click Change. 8. Select the User tab page and assign one or more users to the role. 9. Save your changes.

Business Customizing
This section contains information about the Customizing settings in each of your systems. Using business Customizing, you can meet the specific requirements of your company by adjusting the delivered functionality as follows: Organizational unit Master data Process

Setting Document Numbering


You can check the delivered document number range and view the current document number. The system assigns a 15-digit number to each new document.

After initial maintenance, the SAP Document Builder application controls the number range. Manually adjusting the number range after making the initial settings can result in corrupted data.

SAP Document Builder: Business Scenario Configuration Guide

15

SAP Solution Manager

06.06.2011

Procedure
Perform the activity in Customizing under Basic Functions Set Document Number Ranges. Content-Independent Settings

Defining Contents
If required, you can use content modifiers to enable various locations to share the same underlying content while retaining features specific to each individual location.

Procedure
To define contents, proceed as follows: 1. In Customizing under Basic Functions description. 2. Leave the Variable field empty. Define Contents, enter an identifier and a

You must perform the step, Defining a Root Variable for a Content, then return to this step and enter the variable here. 3. Activate the workflow function for documents and templates. This enables you to trigger the document approval process and the template review process when an element is changed.

Establishing Naming Conventions


The SAP Document Builder system may contain several elements, variables, and other objects, and more than one person can be involved in the configuration and maintenance process. We recommend you establish consistent naming conventions for easier retrieval. By default, the Element field is used for element ordering within each grouping in a document section. You define element ordering in Customizing under Document Management Document Ordering Define Ordering. We recommend you use a naming convention that orders the elements in accordance with your business rules.

Use the customer namespace to create content and related objects. If you use the SAP namespace, your entries can be overwritten.

Example
ZDOC_CONTACT_EMAIL (simple variable) 52.202-1 (specific clause in the US Federal Acquisition Regulation) 52.202-1 (ID of the related rule) 2.201 (prescription for FAR clause 52.202)

SAP Document Builder: Business Scenario Configuration Guide

16

SAP Solution Manager

06.06.2011

Defining Output Types


You identify the output early in the blueprinting process.

Prerequisites
You have implemented the Business Add-In (BAdI) Generic Output Interface to generate your desired outputs. You can use this BAdI to modify the default implementation to satisfy your requirements.

Procedure
...

To define output types, proceed as follows: 1. In Customizing, choose Basic Functions Output Control Define Output Types.

2. To enable the system to generate the correct output type, choose Business Add-Ins Assembly and Output Generic Output Interface.

Example
The following are defined by output types: Document Reviewers checklist SF33 form

More Information
SAP Note 115499 SAP Note 802189

Questions Asked to an Author


This process describes the mechanism that underlies the questions asked to an author during the dialog process.

Prerequisites
You have performed the following activities in Customizing: Document Management Document Management Selections Document Group and Selection Document Group and Selection Define Regulation Sets Standard Elements Rule Management Define Variables Define Elements Define Rules Define Document Groups Define Document

Regulation Sets and Elements Regulation Sets and Elements Regulation Sets and Elements Basic Functions Variables

SAP Document Builder: Business Scenario Configuration Guide

17

SAP Solution Manager

06.06.2011

Process Flow
The document selections presented to the user are filtered on the basis of the document group, so the appropriate document selections are available as options. A document selection contains default properties such as style, overlay, and ordering, as well as sections to structure your documents. The authors document selection determines which regulation sets are evaluated, which identify all the elements evaluated for inclusion in the document. Elements are included based on settings or rules. You define inclusion settings at the element or document selection level. If a rule is evaluated, the element rule contains variables. Since the system dynamically determines follow-on questions, it is not necessary to go through all variables in an element rule. Those variables are the questions asked to the user. The items configured in the content work together to support document generation as follows: Document Selection
...

Regulation Sets

Elements

Variables

Questions

1. User selects the appropriate document. 2. Selected document determines the relevant regulation sets. 3. Regulation sets contain the relevant elements. 4. Elements have an associated Boolean rule containing variables or fill-in variables. 5. Variables are the questions asked to the user in the dialog process.

Result
A list of questions is generated. The user determines the structure of the document using the list.

Defining Content Modifiers


You create content modifiers to enable the system to support a basic content with an option to override default values.

Prerequisites
You have performed Customizing under Basic Functions Define Content Modifiers.

Procedure
...

To define content modifiers, proceed as follows: 1. Choose System User Profile Own Data and select the Parameter tab page.

2. On an empty line, enter the following: Parameter ID: /IPRO/Content Parameter value: default content 3. Save your entries.

Example
A government agency shares basic content at the US federal level but requires content modifiers for offices or locations because of their unique processes to procure commodities. Offices can share FAR and Defense Federal Acquisition Regulation Supplements (DFARS) clauses but have their local content.

SAP Document Builder: Business Scenario Configuration Guide

18

SAP Solution Manager

06.06.2011

Setting Default Contents


You set content as default to enable content managers to access the content when they perform Customizing activities filtered by content.

Procedure
...

To set default contents, proceed as follows: 1. Choose System User Profile Own Data.

2. Select the Parameter tab page. 3. On an empty line, enter the following: Parameter ID: /IPRO/Content Parameter value: default content 4. Save your entries.

Defining a Root Variable for a Content


You define a root variable and assign it to a content.

Prerequisites
You have performed Defining Contents.

Procedure
...

To define a root variable for a content, proceed as follows: 1. In Customizing under Basic Functions Variables and create a new entry. Variables Define Variables, choose Structure

2. Set the Display checkbox to make the root variable and all subordinate variables visible on the Dialog tab page.

Result
You assign the root variable to the content you defined in Defining Contents.

Defining Variables
You use this procedure to create variables. SAP Document Builder distinguishes between decision variables and fill-in variables. Decision variables determine the outcome of rule evaluation; whereas fill-in variables provide text in elements (see Adding Fill-Ins to Element Texts). Data are provided by the user or by external systems. Variables are split into the following: Structure variables provide a root for the highest node in the document data tree and enable you to group variables in accordance with functional similarity. Simple variables are standalone variables grouped into structure variables.

SAP Document Builder: Business Scenario Configuration Guide

19

SAP Solution Manager

06.06.2011

Table variables are used for forms, reports, and element selection, and are displayed in elements in the form of tables.

You can delete variables by setting the status to Inactive. These variables are no longer used in new documents, but are available in draft documents to maintain continuity until the user validates the deletion by clicking Update Report. If a rule contains an inactive variable, it is not considered in the document generation process. We recommend not deleting variables in a productive system as users can encounter errors when opening saved and released documents. We recommend setting variables to Inactive instead of deleting them.

Prerequisites
You are familiar with transaction ABAP Dictionary.

Procedure
...

To define variables, proceed as follows: 1. In Customizing under Basic Functions variable. Variables Define Variables, create a root

2. Create as many structure variables as required. 3. Create the variables you need to build your document.

Example
Simple variable EST_VAL_CURR CURCY USD EST_VAL_NORM LS_CURR16 Structure variable DELIVERY_PERIOD_S DURATION 3 Delivery period, a structure variable containing 110001.01

END_DATE_TIME 2 START_DATE_TIME 1

See Also
The following reports are available for tracking purposes in Customizing under Basic Functions Variables Information Systems: Display Variables not Contained in Structure Variable (/IPRO/IMG_LIST_UNSTRUCTURED) Display Variable Structure (/IPRO/IMG_DISPLAY_VARS)

SAP Document Builder: Business Scenario Configuration Guide

20

SAP Solution Manager

06.06.2011

Defining Element and Output Formats


You determine the text format and the output format in the configuration process. You determine if the SAP BTF HTML editor is sufficient or if you require Microsoft Word/DSO Framer or another editor, if you require a Microsoft Word output or PDF, and if you need forms embedded into your documents. These criteria determine system configuration.

Procedure
Once you make these decisions, you set up the correct parameters, install the required client software, and implement the following BAdIs: /IPRO/EDITOR /IPRO/ASSEMBLY_DEF /IPRO/OUTPUT See SAP Notes referenced in this document for implementation details.

Defining Element Text Formats


You check the formats in which you can edit text in elements. SAP Document Builder supports the following: DOCX HTML WordML

Procedure
You perform the activity In Customizing under Basic Functions Define Text Format. Content-Independent Settings

Certain formats are delivered by SAP.

Setting Default Element Text Format


You specify a default text format for all elements in a specific content.

Procedure
To set the default element text format, in Customizing under Basic Functions Define Configuration Parameters, enter the parameter FORMAT and the required parameter value (DOCX, HTML, or WORDML).

DOCX content configuration steps differ from the other formats, including the following: Defining the overlay setup

SAP Document Builder: Business Scenario Configuration Guide

21

SAP Solution Manager

06.06.2011

Certain configuration parameters: FORMAT is mandatory CLS_TITLES_ON, CLS_TITLE_LIST_LEVEL, CLS_TITLE_LIST_STYLE, CLS_TITLE_NUMBERED, SEC_TITLES_ON, SEC_TITLE_LIST_LEVEL, SEC_TITLE_LIST_STYLE, SEC_TITLE_NUMBERED, SEC_TITLE_TEXT_STYLE, SECTION_TOC are recommended parameters and used to provide styling aspects to the Microsoft Word document An alternative way to set up the section title text BAdI implementations for the editor and assembly are delivered and do not need to be implemented

WordML content format configuration steps differ from other formats, including the following: Defining the overlay setup Certain configuration parameters: FORMAT and SY_STYLES_OVERLAY are mandatory CLS_TITLES_ON, CLS_TITLE_LIST_LEVEL, CLS_TITLE_LIST_STYLE, CLS_TITLE_NUMBERED, SEC_TITLES_ON, SEC_TITLE_LIST_LEVEL, SEC_TITLE_LIST_STYLE, SEC_TITLE_NUMBERED, SEC_TITLE_TEXT_STYLE, SECTION_TOC are recommended parameters and can be used to provide styling aspects to the Microsoft Word document An alternative way to set up the section title text BAdI implementations for the editor and assembly

Result
This parameter defines the default standard element format.

More Information
For more information, see Defining Overlays for WordML and DOCX Texts in Microsoft Word. For more information, see Defining Elements.

Defining Configuration Parameters


You specify configuration parameters for a specific content.

Procedure
To define configuration parameters, in Customizing under Basic Functions Define Configuration Parameters, enter the parameter and the required parameter value.

SAP Document Builder: Business Scenario Configuration Guide

22

SAP Solution Manager

06.06.2011

The only parameter mandatory for all configurations is FORMAT. The SYS_STYLES_OVERLAY is mandatory for WORDML format. The rest are optional but support the configuration of various features as described in the following table:

Parameter FORMAT

Value Example WORDML

Potential Values DOCX WORDML HTML

Significance Mandatory parameter; defines element format Defines SAP SRM system integrated into SAP Document Builder Workflow notifications for content issues can be sent to the content manager (CM). Enables integration of the SAP NetWeaverbased Adobe forms functionality Enables rendering with APACHE-FOP Enables rendering with XML Mind This parameter is required if you opted for Adobe LiveCycle to assemble documents for HTMLbased content. This parameter is required if Adobe LiveCycle is used to assemble documents for contents that use WORDML. Activates the application log Enables the Append Note feature Refers to the text string used to prefix

LOGSYS

SITCLNT

System+CLNT+Client Number

CM

SMITH

User name of content manager

ADS

ADS

Refers to the RFC connection for the SAP NetWeaver Adobe Document Services Refers to the RFC connection for the Apache FOP server Refers to the RFC connection for the XML Mind The value is the logical port of the SAP Document Builder Adobe LiveCycle client proxy for HTML assembly. The value is the logical port of the SAP Document Builder Adobe LiveCycle client proxy for WordML assembly. X or omit parameter Y or omit parameter Text string

APACHE

APACHE-FOP

XMLMIND

XMLMIND

LPCONFIG_LC_HTML

LC_ASSM2

LPCONFIG_LC_WORDML

LC_ASSM2

APP_LOG APPEND_NOTE APPEND_NOTE_PREFIX

X Y *Appended note

SAP Document Builder: Business Scenario Configuration Guide

23

SAP Solution Manager

06.06.2011 an author's appended note to a standard element. This parameter is used with the APPEND_NOTE parameter when set to Y.

USER_STAT_ACTIVE

X or omit parameter

Enables the User Status Workflow feature This enables track changes made to simple variables in Customizing. The user, date, and timestamp are collected in table /IPRO/TVARCHANGE When clicking Log Off, this URL is called Enables you to specify information written to the application log during the receipt of XI inbound messages in the SAP Document Builder system. This parameter is not required. When you specify this parameter, the fields to be written to the application log are selected. Refers to the deletion of documents. A T value for this parameter indicates documents are logically deleted. An F value or any other parameter indicates documents are physically deleted. This parameter is optional when a physical deletion is planned. Opens the variable reference text pop-up

VAR_LOGGING

ON

ON or omit parameter

LOGOUT_URL INB_LOGHDR_CONFG

www.sap.com 0,3,4,10,11,12,20,23

Any URL Numeric values separated by a comma

DELETE_IS_LOGICAL

T, F, or omit parameter

P_EXT_WINDOW

Y or omit parameter

SAP Document Builder: Business Scenario Configuration Guide

24

SAP Solution Manager

06.06.2011 in the browser instead of a standard pop-up.

The following are WORDML and DOCX content parameters: Parameter SYS_STYLES_OVERLAY Value Example ZSYSOVERLAY Potential Values Name of the system overlay in the activity in Customizing for Document Builder Content Manager under Document Management Define Overlay Omit parameter or any value other than Y Significance Mandatory for WORDML content; defines the system style overlay for a WORDML content. Not relevant for DOCX content.

CLS_TITLES_ON

Only relevant when CLS_TITLE_NUMBERED = Y and you want element titles numbered in the assembled document. When the value of this parameter is set to Y, the CLS_TITLE_LIST_STYLE must be set.

CLS_TITLE_LIST_LEVEL

A numeric value

Only relevant when CLS_TITLES_ON = Y and CLS_TITLE_NUMBERED = Y. This parameter is a numeric value one more than the value of the SEC_TITLE_LIST_LEVEL parameter Only relevant when CLS_TITLES_ON = Y and CLS_TITLE_NUMBERED = Y. This style is used to format the LIST numbering used for numbering the element titles. Only relevant when SEC_TITLES_ON = Y. This style is used to 25

CLS_TITLE_LIST_STYLE

CLAUSETITLELIST

A named style in the Microsoft Word overlay file.

CLS_TITLE_TEXT_STYLE

CLAUSEHEADER

A named style in the Microsoft

SAP Document Builder: Business Scenario Configuration Guide

SAP Solution Manager Word overlay file. SEC_TITLES_ON Y Omit parameter for no titles A numeric value

06.06.2011 format the section titles text. Turns section titles on or off Only relevant when SEC_TITLES_ON = Y and SEC_TITLE_NUMBERED = Y. This parameter should be a numeric value that is one less than the value of CLS_TITLE_LIST_LEVEL parameter. Only relevant when SEC_TITLES_ON = Y and SEC_TITLE_NUMBERED = Y. This style is used to format the list used for numbering the section titles. If SEC_TITLE_NUMBERED =Y, then section titles are numbered in the assembled document. Only relevant when SEC_TITLES_ON = Y. This style is used to format the section titles text. If TOC_SECTION is set to the section containing the Table of Contents element together with section ordering configuration, some cover page elements can be handled. For more information about creating a table of contents, see SAP Note 1336593 for WORDML content.

SEC_TITLE_LIST_LEVEL

SEC_TITLE_LIST_STYLE

SECTIONHEADERLIST

A named style in the Microsoft Word overlay file.

SEC_TITLE_NUMBERED

Omit parameter

SEC_TITLE_TEXT_STYLE

SECTIONHEADER

A named style in the Microsoft Word overlay file. Name of the section that contains the Table of Contents element.

TOC_SECTION

TOC

Result
These parameters configure the system to support various features.

SAP Document Builder: Business Scenario Configuration Guide

26

SAP Solution Manager

06.06.2011

Editing Element Texts in WordML


You create WordML texts for elements using Microsoft Word 2003 in Customizing.

Prerequisites
You have done the following: Installed Microsoft Word 2003 Professional, Service Pack 2 Installed the DSO Framer Control ActiveX and configured your web browser to support WordML Implemented BAdI Replace Editor (/IPRO/EDITOR) to set Microsoft Word as the default editor Created all variables needed in your content Generated the XML schema for Microsoft Word

Procedure
To install and register the DSO Framer Control ActiveX, proceed as follows: 1. Download the DSO Framer Package as described in SAP Note 1046791. 2. Save the package file DsoFramer_KB311765_x86.exe to a temporary location on your PC. 3. Extract the files to the specified folder. 4. Copy the DSOFRAMER.OCX file to C:\WINDOWS\SYSTEM32. 5. In Windows, choose Programs 6. Select C:\WINDOWS\SYSTEM32. 7. Type RGSVR32 DSOFRAMER.OCX to register the ActiveX. 8. Confirm the registration message and type EXIT to close Command Prompt. To configure your Web browser, proceed as follows: 1. Start Internet Explorer. 2. Choose Tools 3. Select Security. 4. Select the Local Intranet Web content zone. 5. Click Custom Level. 6. Check under ActiveX controls and plug-ins whether the Automatic prompting for ActiveX control option is set to Enabled. To generate the XML schema for Microsoft Word, see Defining XML Schemas [Page 30]. To add the schema to Microsoft Word, see Adding Schemas to the Schema Library [Page 31]. To edit WordML texts, proceed as follows: 1. In Customizing for Document Builder Content Management, perform the activity under Regulation Sets and Elements Standard Elements Define Elements. 2. In the dialog structure, click Texts. 3. Specify the full-text type and the WordML format. SAP Document Builder: Business Scenario Configuration Guide 27 Internet Options. Accessories Command Prompt.

SAP Solution Manager 4. Click Create Text to start Microsoft Word with the appropriate XML tags.

06.06.2011

5. Save the text to the SAP default folder location, as defined in Options on the SAP GUI. 6. Click Upload to save the text to the document repository.

Result
Microsoft Word starts with the appropriate XML tags.

Editing Element Texts in DOCX


You create DOCX texts for elements using Microsoft Word 2007 in Customizing.

Prerequisites
You have done the following: Created all variables needed in your content Generated the XML schema for Microsoft Word.

Procedure
To generate the XML schema for Microsoft Word, see Defining XML Schemas [Page 30]. To add the schema to Microsoft Word, see Adding Schemas to the Schema Library [Page 31]. To edit DOCX texts, proceed as follows:
...

1. In Customizing for Document Builder Content Management, perform the activity under Regulation Sets and Elements Standard Elements Define Elements. 2. In the dialog structure, click Texts. 3. Specify the full-text type and the DOCX format. 4. Click Create Text to start Microsoft Word with the appropriate XML tags. 5. Save the text to the SAP default folder location, as defined in Options on the SAP GUI. 6. Click Upload to save the text to the document repository.

Result
Microsoft Word starts with the appropriate XML tags.

Creating a Table of Contents in DOCX


You use this procedure to create a DOCX table of contents.

Procedure
...

To create a table of contents, proceed as follows: 1. Create a new section (for example, TOC) and assign an order value less than other section order values. 2. Create an element (for example, TOCELEMENT) with ELEMENT TYPE=B and include it in the TOC section.

SAP Document Builder: Business Scenario Configuration Guide

28

SAP Solution Manager

06.06.2011

3. Create an element text by applying content schema and include Table of Contents from the Microsoft menu. 4. Upload the element text to the IMG.

Adding Fill-Ins to WordML Element Texts


You create fill-ins to enable the system to provide data in element texts.

Prerequisites
You have generated a WordML schema and added it to the schema library in Microsoft Word, as described in Defining XML Schemas and Adding Schemas to the Schema Library.

Procedure
To add fill-ins to element texts, proceed as follows: 1. In Element Management, create a full-text in WordML format.

The <contractDoc> and <clause tags> are created automatically. 2. Choose View Task Pane to display the XML structure. The XML structure reflects the XML schema you have created and contains all the required variables. 3. You can write text within the standard <clause> tags and select the tags that are displayed in the XML Structure pane. 4. Save your changes.

The document must be error-free.

Adding Fill-Ins to DOCX Element Texts


You create fill-ins to enable the system to provide data in element texts.

Prerequisites
You have generated an XML schema and added it to the schema library in Microsoft Word, as described in Defining XML Schemas and Adding Schemas to the Schema Library.

Procedure
To add fill-ins to element texts, proceed as follows:
...

1. In Element Management, create a full-text in DOCX format.

The <contractDoc> and <clause tags> are created automatically. 2. Choose Developer Structure to display the XML structure. The XML structure reflects the XML schema you have created and contains all the required variables. 3. You can write text within the standard <clause> tags and select the tags that are displayed in the XML Structure pane.

SAP Document Builder: Business Scenario Configuration Guide

29

SAP Solution Manager 4. Save your changes.

06.06.2011

The document must be error-free.

Defining XML Schemas


You generate XML files and schemas for multiple purposes. XML schemas are associated with XML documents and validate XML documents. XML schemas have a namespace defined by a URI. In SAP Document Builder, URIs are based on the content name. In this step, you create the following XML files and schemas: WSDL As described in Defining a Root Variable for a Content, you define a root variable to describe a variable tree. When you integrate SAP Document Builder with other components, you use the SAP NetWeaver Exchange Infrastructure to exchange information in the form of XML files. Part of this information is based on the structure of the variable tree and is in WSDL. XML schema for Microsoft Word Microsoft Word requires an XML schema of a variable tree to map data. XML schema for Adobe LiveCycle Designer Adobe LiveCycle Designer requires an XML schema of a variable tree to map data.

Prerequisites
You have performed the following: Defining a Root Variable for a Content Defining Variables

Procedure
To define XML schemas, proceed as follows: 1. In Customizing under Basic Functions Variables Output as WSDL, select the relevant option. 2. Run the report. 3. Choose XML Download to download the new schema to your local PC. Information Systems Display

Result
You can now add the new schemas to the schema library in Microsoft Word, as described in Adding Schemas to the Schema Library.

We do not recommend that you change variables after you generate an XML schema; you can regenerate the XML schema to reflect these changes. Ensure you download the XML schema to the same location as the original one.

SAP Document Builder: Business Scenario Configuration Guide

30

SAP Solution Manager

06.06.2011

Adding Schemas to the Schema Library


You can add XML schemas to a schema library in Microsoft Word to support fill-in variables in elements. Fill-in variables allow you to enter data, for example, an amount.

Prerequisites
You have performed the following: Defining a Root Variable for a Content Defining Variables Defining XML Schemas

Procedure
To use XML schemas in Microsoft Word for one or more WordML documents, you create an XML schema library in Microsoft Word as follows: 1. On the Microsoft Word menu bar, choose Tools 2. Under XML Schema, choose Add Schema. 3. In the Add Schema dialog, select the schema you want to link to the current document. 4. In the Schema Settings dialog, leave the Alias field blank and click Enter. The XML schema is marked as attached and its URI is displayed. 5. Click Enter to exit the dialog box. To manage your schemas, proceed as follows: 1. Choose Schema Library. You add new schemas or delete existing ones. 2. In the new document, the XML Structure interface panel is displayed on the right side of the screen. If the interface panel is not displayed, choose View Task Pane. The interface panel contains all the variables you defined for a specific content, but they are not grouped by structures. Templates and Add-Ins.

Result
You can add XML tags to your Microsoft Word text that correspond to fill-in variables.

Editing Element Texts in HTML


You can create HTML texts for elements using the BTF editor in Customizing. You can copy HTML text from Microsoft Word 2003 into the BTF editor.

Prerequisites
You have implemented BadI Replace Editor (/IPRO/EDITOR) to set the BTF editor as default.

Procedure
To edit element texts in HTML, proceed as follows: 1. In Customizing for Document Builder Content Management, perform the activity under Regulation Sets and Elements Standard Elements Define Elements.

SAP Document Builder: Business Scenario Configuration Guide

31

SAP Solution Manager 2. In the dialog structure, choose Texts to write text for the selected element. 3. Specify the full text type and the HTML format. 4. Choose Create Text to start the BTF editor.

06.06.2011

You can insert fill-in variables when creating your texts. 5. Save the text. To copy and paste text from Microsoft Word 2003 into the BTF editor, proceed as follows:
In Micr osof t Wor d 20 03, c hoos e File Sav e as W eb Pag e.

1. In Microsoft Word 2003, choose File

Save as Web Page.

2. Enter a new file name with the suffix .html and under Save as type, select Web Page, Filtered (*.htm, *.html).

By selecting Web Page, Filtered, the Microsoft Word 2003 application deletes tags from the file specific to Microsoft Word. 3. Save the filtered HTML file. 4. Open the file and copy the contents in the SAP Document Builder BTF editor.

You can copy text from an HTML file on a Web site and paste it into Microsoft Word 2003.

Result
The BTF editor starts and you created your element text.

Defining Overlays for WordML and DOCX Texts


You create overlays to provide headers, footers, and page numbers to your documents.

Prerequisites
You have performed the following: Defining XML Schemas Adding Schemas to the Schema Library

Procedure
To create a new Microsoft Word document, proceed as follows: 1. Start Microsoft Word and choose File 2. Choose File New.

Save As and save the document as XML.

For DOCX, you can insert a variable into the header or footer. You do not insert contractDoc or clause tags into the overlay. To create headers and footers, proceed as follows:

SAP Document Builder: Business Scenario Configuration Guide

32

SAP Solution Manager 3. Choose View Headers and Footers.

06.06.2011

4. Insert the logo or required text at header level. 5. Save your changes. 6. Insert the logo or required text at footer level. 7. Save your changes. To insert tables, proceed as follows: 1. Choose Table Insert Table.

2. Apply formatting for the tables. 3. Save your changes. To format bulleted lists, proceed as follows: 1. Enter a list in the document. 2. Select the list. 3. Choose Format Bullets and Numbering.

4. Select the Bulleted tab page. 5. Select one of the available formats and click OK. This creates a bulleted list with the applied bullet formatting. The specified bullet formatting is used as the default bullet list formatting in the assembled document. 6. Save your changes. To format numbered lists, proceed as follows: 1. Enter a list in the document. 2. Select the list. 3. Choose Format Bullets and Numbering.

4. Select the Numbered tab page. Select one of the available formats and click OK. This creates a numbered list with the applied number formatting. The specified number formatting is used as the default numbered list formatting in the assembled document. 5. Save your changes. To format list styles for section headers, proceed as follows: 1. Choose Format Style and Formatting. A task pane is display the relevant styles and the related formatting information. 2. Click New Style to create a new style for the Lists of Section Headers. Enter a name containing the characters A-Z, a-z, and 0-9. Do not use white spaces or underscores.

If you plan to create multiple overlays, ensure the name styles are the same in all overlays. 3. Enter the style information as follows: a. Style type: Paragraph b. Style based on: Normal c. Style for following paragraph: Normal 4. To format font, proceed as follows:

SAP Document Builder: Business Scenario Configuration Guide

33

SAP Solution Manager a. Choose Format Font.

06.06.2011

b. Enter the font information. c. To specify the list format, choose Format Numbering.

d. Select the Numbered tab page, select a numbering format, and click OK. e. The new style is added to the style list in the Style and Formatting task pane. f. Save your changes. This new style is saved as a part of the file. You need to specify this style name as a value for the SEC_TITLE_LIST_STYLE parameter in Customizing under Basic Functions Define Configuration Parameters. To number element titles, proceed as follows: 1. Perform the steps that apply style formatting and use a different name for the new style. 2. Enter the style information. 3. To format font, choose Format 4. Save your changes. 5. The new style is added to the style list in the Style and Formatting task pane. 6. Save your changes. This new style is saved as a part of the file. You need to specify this style name as a value for the CLS_TITLE_TEXT_STYLE parameter in Customizing under Basic Functions Define Configuration Parameters. To format section headers, proceed as follows: 1. Perform the previous steps and use a different name for the new style. 2. Save your changes. 3. Select all the content of the document body except the header and footer and delete it. 4. Save your changes. Your XML overlay file now contains headers and footers. Font.

See SAP Note 1336593 for more information about the automatic generation of a table of contents in a WordML assembled document.

Uploading Overlays for WordML and DOCX Texts


You upload new overlays to the SAP Document Builder system.

Prerequisites
You have created a document containing the required document-level styling in Microsoft Word 2003 XML or DOCX format.

Procedure
To upload overlays, proceed as follows:
...

1. In Customizing for Document Builder Content Management, perform the activity under Document Management Define Overlays. 2. Create an entry and click Manage Overlay Text to upload the previously created document.

SAP Document Builder: Business Scenario Configuration Guide

34

SAP Solution Manager

06.06.2011

Result
You specify the overlay in Customizing under Document Management Selection Define Document Selections. Document Group and

Defining Overlays for HTML Texts


You create overlays to provide headers and footers to your documents, as well as page numbers and watermarks.

Prerequisites
You have created an empty PDF document with Adobe Acrobat containing all the required document-level styling.

Procedure
To define overlays for HTML texts, proceed as follows: 1. In Customizing, perform the activity under Document Management Define Overlays.

2. Create an entry and choose Manage Overlay Text to upload the previously created document.

Result
You specify the overlay in Customizing under Document Management Selection Define Document Selections. Document Group and

Defining Regulation Sets


You can define regulation sets to group elements.

A regulation set component is required to define elements, prescription, guidance, and references.

Prerequisites
You have performed the step Defining Contents.

Procedure
In Customizing, perform the activity under Regulation Sets and Elements Sets. Define Regulation

Result
You can assign one or more default regulation sets to a document selection, as described in Assigning Regulation Sets to Document Selections.

Example
The FAR governs public procurement processes in the United States.

SAP Document Builder: Business Scenario Configuration Guide

35

SAP Solution Manager

06.06.2011

Defining Element Types


You define element types to describe the various parts of a document. Element types are used when you define element ordering, as described in Ordering Elements in a Section. SAP Document Builder ships with predefined element types such as element, header, footer, report, table, and form.

Procedure
In Customizing, perform the activity Basic Functions Element Types. Content-Independent Settings Define

Defining Elements
You define standard and alternate elements to build your document. You edit them in WordML, DOCX, or in HTML. In SAP Document Builder, the following elements are available: Element Standard element Description The constituent piece of document, which can be published in the form of clauses, forms, or reports, available to all authors An element available to a particular user A section of a document containing different information than the base element to which it is assigned A text element used as a section header A text element used as a section footer A format that enables users to enter data processed by the system and supports frames, fill-ins, and checkboxes A format that enables you to display data in tabular form An element for WordML content that contains the table of contents for a document; the table of contents can be used for HTML content that uses third-party tools

User element Alternate element

Header Footer Form

Report Table of contents

You can set an elements status to Inactive. Elements marked Inactive are not used in new documents, but are available in draft documents to maintain continuity until the user validates the deletion by clicking Update Report. If a rule contains an inactive element, it is not considered in the document generation process.

We recommend not deleting elements in a productive system, but setting elements to Inactive. Elements can be included or excluded based on rules using Formula Builder, document selection configuration, or manually. You use rules and configuration to include an element as mandatory,

SAP Document Builder: Business Scenario Configuration Guide

36

SAP Solution Manager

06.06.2011

optional, or using a rule. When included as mandatory, you can delete the element from the document. A rule can be authored to include an element as mandatory, optional, or recommended. Active elements are available to document authors and can be included in a document. Draft or inactive elements are hidden. For changes requiring workflow approval, a new element version is created, whereas changes not requiring workflow approval are applied to the current element version. You can specify whether a change requires workflow approval or not by implementing the BAdI Trigger Approval Workflow (/IPRO/MATERIAL).

The Element field is used for element ordering within each grouping in a document section. Element ordering is defined in Customizing under Document Management -> Document Ordering -> Define Ordering. Plan your naming convention accordingly so the elements are ordered properly. This default ordering can be overwritten using the BAdI Define Element Ordering Sequence (/IPRO/ORDER_DEF).

Prerequisites
You have done the following: Performed the step Defining Regulation Sets Performed the step Editing Element Texts in WordML or Editing Element Texts in DOCX

Procedure
To create shortcuts, proceed as follows: 1. Select the Favorites folder under the SAP Easy Access Menu. 2. Right-click to open the context menu. 3. Click Add other objects. 4. Select Web Dynpro Application. 5. Enter the technical name of the Web Dynpro application and a description. To add the SAP Document Web Dynpro shortcut, enter /IPRO/WD_DOCB. To add the Document Builder Cockpit shortcut, enter /IPRO/WD_COCKPIT. 6. Click Enter. In a WordML or DOCX document, do one of the following: Configure an element as a header element. Use section title text configured for the document selection. This is established in Customizing under Document Management Document Group and Selection Define Document Selections in the subfolder Sections. You must set the configuration parameter SEC_TITLES_ON with value Y.

SAP Document Builder: Business Scenario Configuration Guide

37

SAP Solution Manager

06.06.2011

Using this configuration makes defining standard elements for the sections headers an obsolete step.

Setting Element Inclusion


You can set default values for element inclusion. You can define default values for element inclusion at the following two levels: Element format Document selection

Element Format
For each default element format, you must define a setting (mandatory, optional, or rule) to include this element in a document format. Note that this setting applies to all documents of this format. If the element does not have a default location and inclusion defined for a specific document format, it will not be considered for a document of that format. Settings The following settings are available: Mandatory The element is included in a document and cannot be deleted. A rule for this element is evaluated in case the rule results in other actions that would include or exclude other elements. However, this element is included as mandatory regardless of what its rule or any other rule determines. For example, if any rule tries to explicitly exclude this element, the element will still be included in the document. Optional The element is included in a document for this format and can be deleted. This setting overrides any rule that tries to include or exclude this element. A rule associated with this element is evaluated in case the rule results in other actions that would include or exclude other elements. However, this element is included as optional regardless of what its rule or any other rule determines. For example, if any rule tries to explicitly exclude this element, the element will still be included in the document. If including this element in a document is contingent on a more complex rule, we suggest that you set this feature to rule and author a rule supporting the criteria. Rule By default, the element is not included in a document. A rule for the element may include it. Rules may be authored to include an element as mandatory, optional, or recommended. Mandatory elements cannot be deleted from a document while optional or recommended elements can. The rule setting also explicitly supports excluding an element. This allows for more sophisticated logic to determine if and which circumstances include an element.

Document Selection
For each document selection, you can define one setting per element. Settings at the document selection level override the default element level. These settings enable you to add elements, including section headers or forms that are unique to this document but not required by all documents of the same format. For example, a Standard Form 33 may not be mandatory at the default element level but could be mandatory at the document selection level.

SAP Document Builder: Business Scenario Configuration Guide

38

SAP Solution Manager Settings

06.06.2011

The above-mentioned settings can be applied at the document selection and element level to override the settings of the default element format. You can manually insert and mark elements as mandatory, optional or rule that is used for this particular document selection and that may be different than the element format default. The following settings are available: Mandatory Overrides any setting at the element format level. The element cannot be deleted from the document. This element rule is evaluated as described above for rule side effects. However this element is included as mandatory in the document regardless of its associated rule or any other rule. Optional Overrides any setting at the element format level. The element can be deleted from the document. This element rule is evaluated as described above for rule side-effects. However, this element is included as optional in the document regardless of its associated rule or any other rule. Rule Overrides any setting at the element format level. This allows Content Managers to override a setting at the default element format level.

Procedure
Proceed as follows for setting default inclusion at the element format level: 1. Perform the Customizing activity for Document Builder Content Management under Regulation Sets and Elements Standard Elements Define Elements. 2. Select an existing element or create a new one. 3. Choose Element Format in the dialog structure. 4. Create a new entry. 5. Set the relevant inclusion attribute for the selected element. 6. Save your entries. Proceed as follows for setting default inclusion at the document selection level: 1. Perform the Customizing activity for Document Builder Content Management under Document Management Document Group and Selection Define Document Selections. 2. Select an existing element or create a new one. 3. Choose Element Properties in the dialog structure. 4. Create a new entry. 5. Set the relevant inclusion attribute for the selected element. 6. Save your entries.

SAP Document Builder: Business Scenario Configuration Guide

39

SAP Solution Manager

06.06.2011

Ordering Elements in a Section


You can associate a document ordering with a document selection to tell the system how to order elements within a section when a document is created. In each section, you can order elements based on the following: The regulation set to which they belong The element type Any element property, as defined in Defining Element Properties

Prerequisites
You have performed the following: Defining Regulation Sets Defining Document Formats

Procedure
In Customizing, perform the activity under Document Management Define Ordering. Document Ordering

Result
You can associate the new ordering with one or more document selections by performing Customizing under Document Management Document Group and Selection Define Document Selections.

Defining Element Properties


You can create custom properties and assign them to elements to further order elements in a section.

Prerequisites
You have performed the step Defining Elements.

Procedure
In Customizing, perform the activity under Regulation Sets and Elements Define Properties.

Result
You can assign the property to a specific element. To do so, proceed as follows: 1. Perform the activity in Customizing for Document Builder Content Management under Regulation Sets and Elements Standard Elements Define Elements. 2. Select the relevant element. 3. In the dialog structure, choose Properties and assign the property to the element. Also, you can refer to this property in Customizing under Document Management Ordering Define Ordering. Document

SAP Document Builder: Business Scenario Configuration Guide

40

SAP Solution Manager

06.06.2011

Defining Prescriptions and Guidance


You can define prescriptions and guidance and assign them to the relevant elements. A prescription is a text assigned to an element that describes how an element should be used and how it should included in a document. In contrast, a guidance is a variant of a prescription.

Prerequisites
You have performed the step Defining Elements.

Procedure
Before you assign a prescription and/or a guidance to an element, you must assign it to a regulation set. To do so, proceed as follows: 1. In Customizing, perform the activity under Regulation Sets and Elements References, Prescriptions, and Guidance. Define

2. Create an entry and go one step back. You can either create a text from scratch or upload an existing text from your PC. To assign a prescription and/or a guidance to an element, proceed as follows: 1. In Customizing, perform the activity under Regulation Sets and Elements Elements Define Elements. Standard

2. In the dialog structure, click Prescription or Guidance and create a new entry.

Result
You can view the prescription and guidance texts on the user interface as follows: 1. Select a document in a specific content. 2. Choose Document Summary. 3. Select an element in the list. 4. Choose Print Preview.

Prescription and guidance texts are not assembled.

Example
An organization has three locations and each location uses the same prescription but interprets it slightly differently. In this case, there would one prescription and three different guidance texts.

Defining References
You define help texts to describe variables.

Prerequisites
You have performed the step Defining Variables.

SAP Document Builder: Business Scenario Configuration Guide

41

SAP Solution Manager

06.06.2011

Procedure
In Customizing, perform the activity under Regulation Sets and Elements Prescriptions, and Guidance. Define References,

Result
You can associate the newly created reference with the relevant variable by performing Customizing under Basic Functions Variables Define Variables.

Defining Alternate Elements


You define alternate elements as variants of the standard elements to which they are assigned. You assign one or more alternate elements to an element.

Prerequisites
You have performed the step Defining Elements.

Procedure
To define alternate elements, proceed as follows: 1. In Customizing under Regulation Sets and Elements element. 2. In the dialog structure, click Alternate Elements. Define Elements, select an existing

Form and Report Elements


Forms and reports are an integral part of document content and can be inserted into complex contract documents to support data entry, frames, fill-ins, and checkboxes. Forms are defined as elements in Customizing. You can define forms as output types; the form is standalone and not part of a complex document. The following are examples of US government forms: SF26 Award/Contract SF30 Amend/Mod SF33 Solicitation, Offer, and Award

Prerequisites
Before you can start designing forms, you have performed the following: Installed the SAP Adobe LiveCycle tool Created the associated variables in Customizing under Basic Functions Variables Define Variables Created a form element in Customizing under Regulation Sets and Elements Standard Elements Define Elements and assigned the related variables Run report Display Output as WSDL (/IPRO/OUTPUT_WSDL) and generated a form XML schema if you opted for an XML interface Set up the RFC destination for the Adobe LiveCycle PDF Generator (LC ADS GEN). This connection is type G (HTTP connection to external server).

SAP Document Builder: Business Scenario Configuration Guide

42

SAP Solution Manager

06.06.2011

Activities
...

1. To implement forms successfully, you design the forms, map the relevant data in SAP Document Builder to the form, and include required logic. 2. To design forms or reports, you use Form Builder enhanced with Adobe LiveCycle. This solution is known as SAP Interactive Forms by Adobe.

Result
You can embed forms into an assembled document with an assembly tool. With this tool, you can merge elements of different formats into a PDF. You cannot assemble PDF forms in the final PDF with the Apache/FOP renderer. You can create separate PDF attachments. SAP Document Builder supports the PDF forms, but they are not embedded into the assembled PDF file.

More Information
See Customizing under Basic Functions Output Control Define Output Definition and Regulation Sets and Elements Standard Elements Define Elements.

Defining Form Interfaces


You define form interfaces for SAP Interactive Forms by Adobe on the basis of previously defined schemas. A form interface enables you to map SAP Document Builder variables to form fields.

You can assign one interface to a form, but an interface can be used by more than one form.

Prerequisites
You have performed the following: Defining a Root Variable for a Content Defining Variables Defining XML Schemas [Page 30]

Procedure
To define form interfaces, proceed as follows: 3. Run transaction Form Builder. 4. Select Interface and choose Create. 5. Enter the name of the interface and a description. 6. Select the XML Schema-Based Interface type. 7. In the File field, specify the path of the XML schema you have created in Defining XML Schemas and choose Load. 8. Select the Interface tab page to view the newly generated interface.

SAP Document Builder: Business Scenario Configuration Guide

43

SAP Solution Manager

06.06.2011

Adding Fill-Ins to SAP Interactive Forms by Adobe


You create fill-ins to enable the system to provide data in SAP Interactive Forms by Adobe.

Prerequisites
You have done the following: Generated a form schema, as described in Defining XML Schemas Created a form interface, as described in Defining Form Interfaces Installed SAP Interactive Forms by Adobe SAP Interactive Forms by Adobe is based on transaction Form Builder enhanced with Adobe LiveCycle Designer. Defined the RFC connection to Adobe Document Server using transaction RFC Destinations

Procedure
To add fill-ins to SAP Interactive Forms by Adobe, proceed as follows: 1. Run transaction Form Builder. 2. Select Form and choose Create. 3. Enter a description and an existing form interface when prompted. 4. Choose Save. 5. Select Layout to view the work area: the Data View on the left pane displays the Document Builder variables, the Body Page on the right pane the form you want to design. 6. You can drag and drop variables from the Data View to the Body Page on the empty form. 7. Save your changes and choose PDF Preview on the right pane to view the form in PDF format.

Design and Mapping Issues


Design and Mapping Form Builder is launched from Customizing when you select a newly created form and choose Edit Form. In Form Builder, you design the form and define the related interface, which can be either ABAP Dictionary-based, XML, or SmartForms compatible. ABAP code is converted to XML and sent to Adobe LiveCycle, where it is finally saved as XML. The interface enables you to map the form fields to the associated variables in the SAP Document Builder system. A form can only have one interface, whereas an interface can be used by multiple forms. In Form Builder, you can create subroutines, specify code initialization to handle mapping, and define import and export parameters.

SAP Document Builder: Business Scenario Configuration Guide

44

SAP Solution Manager

06.06.2011

Interface Definition In the interface definition, created on the Form Interface tab page, SAP Document Builder forms require the following import and export parameters: Import Parameters PT_TOC_ENTRY with type /IPRO/TT_TOC_ENTRY PT_PARAM with type /IPRO/TT_VAR_PAIR (contains all SAP Document Builder variables associated with the form element) Variable Definition You define variables for each SAP Document Builder variable under Global Definitions Global Code Data, after which you assign the variable values to the variables under Initialization Initialization. Web Service Definition Using transaction Maintain Services, you create a Web service to be used for all forms whose URL must be linked to the Submit button in the form. By doing so, you allow form field data to be posted back to the SAP Document Builder system. File Output The output is a PDF file. Form Representation As described above, a form may be either a PDF attachment to the document output or an element in the assembled document output. If the form is a PDF attachment, you must implement Business Add-In (BAdI) Generic Output Interface (/IPRO/OUTPUT). When the form is embedded in the assembled document, then the form is an element contained in the document. Note that the assembly server must be able to support the technical features of merging this PDF with other files to create the document output PDF file. Report Elements A report, also be referred to as a schedule, contains a table of information formatted to satisfy business requirements. For example, the line items in a contract may be considered to be a report. To define a report element, proceed as follows: 1. Create an element that has the element type Report. 2. Create an output type for the subject report. Export Parameters /1BCDWB/FORMOUTPUT with type FPFFORMOUTPUT

See Also
For more information, see the following on SAP Help Portal at http://help.sap.com: SAP NetWeaver by Key Capability Services Smart Forms Application Platform by Key Capability Business Business

SAP NetWeaver by Key Capability Application Platform by Key Capability Services Interactive Forms by Adobe

SAP Document Builder: Business Scenario Configuration Guide

45

SAP Solution Manager

06.06.2011

Establishing a Document Structure


You define the structure of a document based on the following: Type Format Selection Styles Overlay Ordering

Procedure
Perform the following steps in Customizing under: 1. Document Management Define Document Types Document types enable you to distinguish documents in a particular area. You can define the following procurement documents: RFx, RFI, RFP, and RFQ. 2. Document Management Define Document Formats and Sections Document formats enable you to specify for what purpose documents are used. Sections are used to structure documents. You can define sections A, B, C, 1, 2, and 3. 3. Document Management Document Group and Selection Define Document Groups and Define Document Selections Document groups enable you to group document selections and to display only those documents that are relevant to an author, whereas document selections are unique combinations of document types and document formats containing default properties such as style, overlay, sections, and ordering. 4. Document Management Style Management Define Styles Styles include a list of parameters containing specific information on font and paragraph formatting, indent, and other features. 5. Document Management Style Management Define Overlay Specifies the headers and footers for a document. 6. Document Management Document Ordering Define Ordering Specifies how elements should be ordered overall or by section in the document.

Result
You can create the documents required by your organization.

SAP Document Builder: Business Scenario Configuration Guide

46

SAP Solution Manager

06.06.2011

Defining Document Types


You use document types to categorize documents.

Prerequisites
You have performed Defining Contents.

Procedure
In Customizing for Document Builder Content Management, perform the activity under Document Management Define Document Types.

Result
You use document types in combination with document formats to define document selections.

Defining Document Formats


You define document formats to structure documents using sections. Document formats are used in combination with document types to define document selections.

Prerequisites
You have performed Defining Contents.

Procedure
In Customizing, perform the activity under Document Management and Sections. Define Document Format

Result
You can combine the document format with a document type into a document selection, as described in Defining Document Selections.

Example
Commercial Construction Uniform Contract Format (UCF)

SAP Document Builder: Business Scenario Configuration Guide

47

SAP Solution Manager

06.06.2011

Defining Document Groups


You define document groups to categorize document selections.

Prerequisites
You have performed Defining Contents.

Procedure
In Customizing, perform the activity under Document Management Define Document Groups.

Defining Document Selections


Document selections are a unique combination of document style and document format. You configure default properties such as style, overlay, and ordering.

Prerequisites
You have performed the following: Defining Contents Defining Document Types Defining Document Formats Defining Document Groups

Procedure
In Customizing, perform the activity under Document Management Selections. In the dialog structure, specify the following: Document type and format Sections (based on the selected document format) Document group Define Document

Result
You have a flexible framework that enables you to structure complex documents and create the related elements, for example, clauses, reports, and forms.

SAP Document Builder: Business Scenario Configuration Guide

48

SAP Solution Manager

06.06.2011

Assigning Regulation Sets to Document Selections


You assign one or more regulation sets to a document selection to add the required elements to a document.

Prerequisites
You have performed the following: Defining Document Selections Defining Regulation Sets

Procedure
To assign regulation sets to document selections, proceed as follows: 1. In Customizing under Document Management Document Group and Selection Document Selections, select Default Regulation Sets. 2. Specify the relevant regulation sets. Define

Assigning Elements to Document Selections


You assign elements to a document selection. A document is generated in the context of a particular document selection. A document selection determines the elements to be included in a document.

You perform this step when the inclusion criterion for the element is unique for this document. In this case, the inclusion defined at element level is overridden in Customizing under Regulation Sets and Elements Standard Elements Define Elements.

Prerequisites
You have performed the following: Defining Elements Defining Document Selections

Procedure
To assign elements to document selections, proceed as follows: 1. In Customizing under Document Management Document Group and Selection Document Selections, select Element Properties. 2. For each element, check one of the following inclusion attributes: Rule The system evaluates a rule to determine whether the element must be included. Mandatory The system always includes the element using the current document selection. The Define

SAP Document Builder: Business Scenario Configuration Guide

49

SAP Solution Manager

06.06.2011

included element cannot be deleted under the Element Summary tab page on the user interface. Optional The system always includes the element using the current document selection. The included element can be deleted under the Element Summary tab page on the user interface.

Setting Document Expiration


You notify a document owner of released documents about to expire in a specific content or in all contents.

Prerequisites
Documents are available in the system.

Procedure
In Customizing, perform the activity under Document Management Notify Agent Prior to Document Expiration. Document Expiration

Defining Rules
You use this process to create rules. Elements are assigned to rules, which may be based on an interpretation of the associated prescriptions or guidance. Rule evaluation enables you to add elements to and exclude elements from a document. You can author both simple and complex rules. SAP Document Builder uses Formula Builder, a built-in formula editor, to perform rule evaluation. You can build virtually any rules, regardless of complexity.

You use the document selection as a parameter in the rule to determine clause inclusion/exclusion using this criterion. You can set variables with values to support advanced logic requirements.

Prerequisites
You have performed Defining Variables and Defining Elements.

Procedure
In Customizing, perform the activity under Regulation Sets and Elements Define Rules. Rule Management

Features
The following features apply to your rules: Authored in a specific structure and syntax Test a condition to take action Nested by means of the TRUE and FALSE actions to test another condition Use functions to perform TRUE and FALSE actions. Additional functions are by the relevant BadI

SAP Document Builder: Business Scenario Configuration Guide

50

SAP Solution Manager

06.06.2011

Authored in normal and in expert mode; expert mode enables you to type rules directly Refer to the evaluation of another rule

Structure
The structure of a rule contains a conditional statement, a true action, and a false action: IF(Conditional Statement, True Action, False Action) You can use the following functions and conditions: Include Mandatory Element Include Optional Element Include Recommended Element Exclude Element Is Value in Table Is Element Included Is Element Excluded Is Precondition Valid Is Value in Table AND OR NOT =, <>, >, < For the sake of clarity, the procedure has been broken down into subprocedures.

Building a Conditional Statement


To build a conditional statement, proceed as follows: 1. On the function panel in the middle of the screen or in the right pane, select the IF function. The function is displayed as follows on the upper part of the screen: IF( , , ) 2. The cursor is automatically positioned between the opening parenthesis and the first comma. 3. Select a variable in the left pane. You can use various search criteria. You can for example filter variables by type, search for text contained in a variable or sort variables. The formula is displayed as follows: IF(VAR1, , ) 4. Select a conditional statement in the middle of the screen or in the right pane. The formula is displayed as follows: IF(VAR1=, , ) 5. Select String to enter a character string (for example X). The formula is displayed as follows: IF(VAR1=X, , )

SAP Document Builder: Business Scenario Configuration Guide

51

SAP Solution Manager 6. Select the next logical statement in the right pane.

06.06.2011

7. Finish the conditional statement by going through the steps 4 to 6. Your formula should look like this: IF(VAR1=X OR VAR2=X, ) 8. Position your cursor after the last comma and go through the second step.

Building a TRUE Action


Select a function in the right pane (for example INCLUDE_MANDATORY_ELEMENT). Your formula should look like this: IF(VAR1=X OR VAR2=X, INCLUDE_MANDATORY_ELEMENT ()) After selecting a function, proceed as follows: 1. Position your cursor after the function and between the opening and closing parenthesis. 2. Select the relevant element in the left pane. You can use the Show me filter to display only elements. Your formula could look like this: IF(VAR1=X OR VAR2=X, INCLUDE_MANDATORY_ELEMENT (REG1 CLAUSE 1A)) 3. Save your formula.

Building a FALSE Action


Perform the same steps as above for building a TRUE action.

Result
You have built a formula that you can use to determine element inclusion or exclusion.

Document Content Checks


Customizing contains a set of reports the content manager can use to check document content for errors and to create hands-on lists. For more information, see Customizing under Content Checks. After you run a report, the ALV provides you with a set of tools that enables you to print data, export data, or send data as an attachment.

Run Extended Content Check


This report enables content managers to check whether the following are true: The selected content has a structure variable assigned as the root variable. At least one document number range has been set. The configuration parameters have been maintained. At least one regulation set has been set up. At least one document group has been set up. At least one document selection has been set up. At least one ordering has been set up. At least one element ordering per ordering has been set up. SAP Document Builder: Business Scenario Configuration Guide 52

SAP Solution Manager

06.06.2011

Prerequisites
You have performed the following activities in Customizing under Basic Functions Basic Functions Basic Functions Variables Define Variables Set Document Number Ranges

Content-Independent Settings Define Configuration Parameters

Regulation Sets and Elements Document Management Document Management

Define Regulation Sets Define Document Groups

Document Group and Selection Define Document Selections Define Ordering

Define/Change Document Ordering

Activities
To perform a content check, proceed as follows: 1. Perform the activity in Customizing under Content Checks Check. Run Extended Content

2. Enter the relevant content and run the report. The system displays a list of the performed checks and their results.

List Variables
This report enables content managers to list all the variables in the selected content. You choose to list a specific variable type or all variables.

Prerequisites
You have performed the activity in Customizing under Basic Functions Variables and defined the relevant variables. Variables Define

Activities
To list the variables in a content, proceed as follows: 1. Perform the activity in Customizing under Content Checks List all Variables.

2. Enter the relevant content, specify the variable type, and run the report. The system displays all the variables and their attributes in the selected content.

List Structure and Related Variables


This report enables content managers to list all of the structure variables as well as the included variables.

Prerequisites
You have performed the activity in Customizing under Basic Functions Variables and defined the relevant variables. Variables Define

SAP Document Builder: Business Scenario Configuration Guide

53

SAP Solution Manager

06.06.2011

Activities
To list a structure variable and the variables included in that structure, proceed as follows: 1. Perform the activity in Customizing under Content Checks and Related Variables. Run List Structure Variables

2. Enter the relevant content and run the report. The system displays all the structure variables and related variables in the selected content.

List Variable-Reference Associations


This report enables content managers to list all the variable-reference associations in the selected content.

Prerequisites
You have performed the following activities in Customizing under Basic Functions and associated the variables with the relevant references: Define Variables Link References to Variables Variables

Activities
To list variable-reference associations, proceed as follows: 1. Perform the activity in Customizing under Content Checks Associations. List Variable-Reference

2. Enter the relevant content and run the report. The system displays all the variables and the related references in the selected content.

List Standard Elements


This report enables content managers to list the standard elements and their attributes in the selected content.

Prerequisites
You have performed the activity in Customizing under Basic Functions Elements Define Elements and defined the relevant elements. Regulation Sets and

Activities
To list all of the standard elements in a content, proceed as follows: 1. Perform the activity in Customizing under Content Checks Check. Run Extended Content

2. Enter the relevant content and run the report. The system displays all the standard elements and their attributes in the selected content.

SAP Document Builder: Business Scenario Configuration Guide

54

SAP Solution Manager

06.06.2011

List Rules
This report enables content managers to list all of the rules in the selected content.

Prerequisites
You have performed the activity in Customizing under Basic Functions Elements Rule Management Define Rules. Regulation Sets and

Activities
To list all of the rules in a content, proceed as follows: 1. Perform the activity in Customizing under Content Checks List Rules.

2. Enter the relevant content and run the report. The system displays all the rules in the selected content, including the code.

Check Document Selections


This report enables content managers to check document selections for errors.

Prerequisites
You have performed the activity in Customizing under Document Management Group and Selection Define Document Selections. Document

Activities
To check your document selections for errors, proceed as follows: 3. Perform the activity in Customizing under Content Checks Check Document Selections.

4. Enter the relevant content and run the report. The system displays all the document selections in the selected content.

List Document Selections


This report enables content managers to list all the document selections and their details in the selected content.

Prerequisites
You have performed the activity in Customizing under Document Management Group and Selection Define Document Selections. Document

Activities
To list document selections and their details, proceed as follows: 1. Perform the activity in Customizing under Content Checks List Document Selections.

2. Enter the relevant content and run the report. The system displays all the document selections in the selected content.

SAP Document Builder: Business Scenario Configuration Guide

55

SAP Solution Manager

06.06.2011

Notify Content Managers for Rules that Cannot Be Determined


You use this report to enable content managers to check the application log to which errors are written when an author generates a document and the system cannot do the following: Determine whether to either include or exclude an element based on a rule Find a variable referred to in a rule Find an element referred to in a rule

Prerequisites
You have defined the following settings in Customizing under Basic Functions Define Configuration Parameters: Configuration Parameter CM APP_LOG Parameter Value Content managers user name X

You specify the contact persons ID when you assign the content managers user name to the configuration parameter CM. By assigning the value X to the configuration parameter APP_LOG, you ensure that errors are written to the log.

Activities
To ensure that an e-mail is sent to the content manager in case errors occur upon document generation, proceed as follows: 1. Perform the activity in Customizing under Content Checks Undetermined Rules. Notify Content Manager for

2. Enter a valid date range and the relevant content, and run the report. If there are errors to be reported, an e-mail is sent to the inbox of the Business Workplace of the relevant contact person.

You can set up this report to run as a batch job.

Workflows
SAP Document Builder ships with a range of preconfigured workflows that are triggered when changes are made to elements, documents, and templates. In addition to the standard workflows, you can also define user-specified statuses and corresponding workflows for elements, documents, and templates if you want to use statuses other than the statuses delivered by SAP. In Translation is an example of a user-specified status that can be added to the list of delivered statuses for elements. The following preconfigured workflows are available:

SAP Document Builder: Business Scenario Configuration Guide

56

SAP Solution Manager

06.06.2011

Object SAP Document Builder Document

Workflow Automatic Approval (WS40400020) One-Step Approval (WS40400006)

SAP Document Builder Template

Automatic Approval (WS40400019) One-Step Approval (WS40400012)

SAP Document Builder Element

Automatic Approval (WS40400023) N-Step Approval (WS40400009)

Custom Element

Automatic Approval (WS40400033) One-Step Approval (WS40400025)

Workflows Supporting the Document Approval Process Based on your Customizing settings, one of the following workflows is started after a document has been released and all element modifications have been approved: One-Step Approval Workflow for Document (40400006) If this workflow is active, new or changed documents require approval by one person. 0-Step Approval Workflow for Document (40400020) If this workflow is active, documents are automatically approved. You can activate the document approval workflow at content level in Customizing for Document Builder Content Management under Basic Functions Define Contents. Workflows Supporting the Template Approval Process Based on your Customizing settings, one of the following workflows is started after a template has been released: One-Step Approval Workflow for Template (40400012) If this workflow is active, new or changed templates require approval by one person. 0-Step Approval Workflow for Template (40400019) If this workflow is active, templates are automatically approved. Workflows are started when an active element is changed in a template. A list of all affected templates is displayed and you can select which templates you want to update. A new version is created for all updated templates and a workflow is started for each individual template. You can activate the template approval workflow at content level in Customizing for Document Builder Content Management under Basic Functions Define Contents. Workflows Supporting the Element Change Process The following workflows are started after an element has been released, meaning that the status has been set to Active: N-Step Approval Workflow for Template (40400009) If this workflow is active, new or changed elements require approval from more than one person. 0-Step Approval Workflow for Template (40400023) If this workflow is active, elements are automatically approved.

SAP Document Builder: Business Scenario Configuration Guide

57

SAP Solution Manager Custom Elements

06.06.2011

For custom elements, the following workflows are used and started when an active standard element is changed in a document: One-Step Approval WF for Custom El. (40400025) If this workflow is active, new or changed custom elements require approval by one person. 0-Step Approval Workflow for Custom El. (40400033) If this workflow is active, custom elements are automatically approved. You can activate the element change workflow at element level by setting the relevant checkbox in Customizing for Document Builder Content Management under Basic Functions Regulation Sets and Elements Standard Elements Define Elements. You can define user-specified statuses by implementing Business Add-In (BAdI) BADI for User Status Management (/IPRO/WFL_USRSTATUS).

Checking Workflows
You use this to check available workflows.

Procedure
To check workflows, proceed as follows: 1. Run transaction Workflow Builder. 2. Click the arrow next to the Workflow field. 3. Navigate to Cross Application Components Builder. General Application Functions Document

Web Services
You use Web services on various platforms to exchange data over the Internet. The Web service Old Proxy Method Used as Web Service (/IPRO/CALL_DOCB) allows SAP Document Builder to be called by SAP Supplier Relationship Management (SAP SRM), Procurement for Public Sector (PPS). You can check it in transaction Web Service Administration. For more information, see SAP Note 1084258.

Currently, SAP Document Builder integration is only provided by PPS. To complete configuration, do the following: Check the client proxy in the system from which you call the web service using transaction Object Navigator. In the PPS system, the proxy is called CO_IPRO_CALL_DOCB. Define the logical port for the client proxy in the PPS system using transaction Maintain Logical Ports. This port must correspond to the one you defined in Customizing for SAP Supplier Relationship Management under SRM Server Cross-Industry Functions Integration with SAP Document Builder Set Up Integration with SAP Document Builder. You must use the default Business Add-In (BAdI) implementation under Customer

SAP Document Builder: Business Scenario Configuration Guide

58

SAP Solution Manager Enhancements (BAdIs) Integration with SAP Document Builder with SAP Document Builder.

06.06.2011 Set Up Integration

Prerequisites
You have done the following: Defined the required variables for your content in Customizing under Basic Functions Variables Define Variables Generated the WSDL in Customizing under Basic Functions Systems Display Output as WSDL Variables Information

You can manage Web services if you have the Web Service Administrator role (SAP_BC_WEBSERVICE_ADMIN).

More Information
For more information, see SAP Help Portal under SAP NetWeaver 7.0 Glance IT Scenarios at a Glance Enabling Enterprise Services. SAP NetWeaver at a

Using Old Proxy Method Used as Web Service


You use this to integrate SAP Document Builder with SAP Supplier Relationship Management (SAP SRM), Procurement for Public Sector (PPS), and has the following parameters: INPUT XML message created using the Web Services Description Language (WSDL) report (/IPRO/OUTPUT_WSDL) in Customizing and downloaded to a local PC OUTPUT Field structure corresponding to the variable structure contained in the above XML message and supplemented with the GUID and version fields

Prerequisites
You are authorized to perform this activity.

Procedure
To integrate SAP Document Builder with PPS, proceed as follows: 1. Define a client proxy in the system from which you want to call the Web service. 2. Define the logical port for the client proxy.

Checking Web Services


You use this to check the available Web services and to activate Web service Old Proxy Method Used as Web Service (/IPRO/CALL_DOCB).

Procedure
To check available Web services, proceed as follows: 1. Run transaction Web Service Administration for SOAP Runtime.

SAP Document Builder: Business Scenario Configuration Guide

59

SAP Solution Manager

06.06.2011

2. Under SOAP Application for RFC-Compliant FMs, check whether the Web service Old Proxy Method Used as Web Service (/IPRO/CALL_DOCB) is available. 3. Activate the service.

Defining Client Proxies


To set up the integration with an external system, you create a client proxy in the customer namespace in the system from which you want to call the web service. This proxy is based on the XML message created using the WSDL report (/IPRO/OUTPUT_WSDL) and containing a variable structure.

Procedure
To define client proxies, proceed as follows: 1. Upload the XML message. 2. Run transaction Object Navigator. 3. Select a package. 4. Right-click to open the context menu and choose Create Service Proxy Object. 5. Select Local File and upload the XML message. 6. Specify the package. 7. Save the proxy as a local object and activate it. Once activated, the data types defined in Customizing are automatically generated and mapping is available. Enterprise Service / Web

Result
The external system is connected to the SAP Document Builder system.

Defining Logical Ports


You use this to configure the logical port in the SAP Supplier Relationship Management (SAP SRM), Procurement for Public Sector (PPS) system for the Web service Old Proxy Method Used as Web Service (/IPRO/CALL_DOCB).

Procedure
To define logical ports, proceed as follows: 1. Run transaction Maintain Logical Ports. 2. Specify the client proxy CO_IPRO_CALL_DOCB. 3. Set the Default Port checkbox. The port must be the same as the one defined in Customizing under SRM Server Cross-Industry Functions Integration with SAP Document Builder Set Up Integration with SAP Document Builder.

SAP Document Builder: Business Scenario Configuration Guide

60

SAP Solution Manager

06.06.2011

Integration with SAP NetWeaver Exchange Infrastructure


The SAP NetWeaver Exchange Infrastructure (SAP NetWeaver XI) is middleware that enables you to do the following: Connect both SAP and non-SAP systems to each other in a heterogeneous system landscape Transform message content between sender and receiver systems;, systems are connected to SAP NetWeaver XI by special classes called proxies

Exchanging XML Messages


The core of the SAP NetWeaver XI infrastructure is a message-oriented communication based on HTTP. Business content is transferred in the form of XML messages. The structure of a message is determined by the interface data structure that is used.

Prerequisites
You have done the following to exchange XML messages: Defined the required variables for your content in Customizing under Basic Functions Variables Define Variables Generated the WSDL file in Customizing under Basic Functions Information Systems Display Output as WSDL Variables

Inbound and Outbound Interfaces


Currently, SAP SRM provides interfaces for the following: Contracts Purchase orders RFx To access the interface data structures, proceed as follows: 1. Log on to your SAP NetWeaver XI system and run transaction Integration Builder. 2. To check the interface data structures delivered for SAP SRM Server 6.0, choose Integration Builder: Design Integration Repository and expand the SAP SRM Server 6.0 node and the following subordinate nodes on the Objects tab page: Procurement Global > Interface Objects > Message Interfaces PurchaseOrderLegalDocumentRequest_Out (outbound) PurchaseOrderLegalDocumentRequest_Notification (inbound) Sourcing Global > Interface Objects > Message Interfaces Message InterfacesRFQLegalDocumentRequest_Out (outbound) RFQLegalDocumentRequest_Notification (inbound) Contract Management Global > Interface Objects > Message Interfaces PurchasingContractLegalDocumentRequest_Out (outbound) PurchasingContractDocumentRequest_Notification (inbound) 3. To change the interface data structures according to your needs, choose Integration Builder: Design Integration Directory.

SAP Document Builder: Business Scenario Configuration Guide

61

SAP Solution Manager

06.06.2011

Mapping
To transform message content, mapping is required. Mapping consists of assigning SAP Document Builder fields to fields from an external SAP NetWeaver XI message. The data exchange is performed from SAP Document Builder to the external application using SAP NetWeaver XI. Prior to mapping, which should be performed by SAP NetWeaver consultants only, you must have done the following:
...

1. Generated the corresponding variable tree by means of the WSDL generator in Customizing for Document Builder Content Management under Basic Functions Variables Information Systems Display Output as WSDL. 2. Saved the file to your local PC or server. 3. Exported the file to SAP NetWeaver XI. By doing so, you generate the required mapping fields automatically instead of building up the tree manually. The following graphic illustrates a typical mapping process:

Procurement for Public Sector (PPS)

SAP NetWeaver XI

SAP Document Builder

Business Function

Outbound Interface

Technical Mapping

Inbound Interface

Processing*

Inbound Interface

Technical Mapping

Outbound Interface

*Create documents and attachments.

Process Flow
1. The SAP SRM outbound interfaces are mapped to the corresponding data type in SAP NetWeaver XI. 2. An XML file containing the business information you have entered in SAP SRM is created and sent to the SAP Document Builder inbound interface. 3. The SAP Document Builder outbound interface is mapped to the SAP SRM inbound interfaces. The interface here is determined by the one used in the inbound process.

Monitoring XML Messages


Transaction Integration Engine - Monitoring enables system administrators to do the following:

SAP Document Builder: Business Scenario Configuration Guide

62

SAP Solution Manager

06.06.2011

Monitor the message flow between the sender and receiver systems in SAP NetWeaver XI Track errors and statuses This transaction is available in both sender and receiver systems, as well as in the SAP NetWeaver XI system.

More Information
See the following documents in SAP Library for SAP NetWeaver at http://help.sap.com: SAP NetWeaver 7.0 SAP NetWeaver by Key Capability Capability SAP NetWeaver Exchange Infrastructure SAP NetWeaver 7.0 SAP NetWeaver at a Glance Enabling Enterprise Services Process Integration by Key

IT Scenarios at a Glance

Document Archiving
This section describes how to delete obsolete SAP Document Builder documents from your system. A system administrator uses one of the following: Extract Document Builder Documents (/IPRO/DOCB_WRI) Delete Document Builder Documents (/IPRO/DOCB_DEL) Notify Processor Prior to Document Expiration (/IPRO/DOC_EXPIRE)

Extract SAP Document Builder Documents


This report enables you to create an archiving object for the SAP Document Builder documents to be deleted from your system.

Prerequisites
SAP Document Builder documents are available in the system.

Activities
Run Extract Document Builder Documents in test mode, then in productive mode. The report generates a file containing all the SAP Document Builder documents to be deleted.

Delete SAP Document Builder Documents


This report enables you to delete archived SAP Document Builder documents.

Prerequisites
You have run Extract Document Builder Documents (/IPRO/DOCB_WRI).

Activities
Run Delete Document Builder Documents in test mode, then in production mode.

SAP Document Builder: Business Scenario Configuration Guide

63

SAP Solution Manager

06.06.2011

Notify Processor Prior to Document Expiration


This report enables you to retrieve all released contracts that are due to expire and notify the responsible agents using e-mail.

Prerequisites
You have started the document approval process for the relevant contracts.

Activities
Perform the activity in Customizing under Document Management Notify Agent Prior to Document Expiration. By default, the threshold value is set to 3. Document Expiration

SAP Document Builder: Business Scenario Configuration Guide

64