This action might not be possible to undo. Are you sure you want to continue?
SAP Online Help
SAP Online Help
Icon Meaning Caution Example Note Recommendation Syntax
Type Style Example text Description Words or characters that appear on the screen. These include field names, screen titles, pushbuttons as well as menu names, paths and options. Cross-references to other documentation. Example text EXAMPLE TEXT Emphasized words or phrases in body text, titles of graphics and tables. Names of elements in the system. These include report names, program names, transaction codes, table names, and individual key words of a programming language, when surrounded by body text, for example, SELECT and INCLUDE. Screen output. This includes file and directory names and their paths, messages, source code, names of variables and parameters as well as names of installation, upgrade and database tools. Keys on the keyboard, for example, function keys (such as F2) or the ENTER key. Exact user entry. These are words or characters that you enter in the system exactly as they appear in the documentation. Variable user entry. Pointed brackets indicate that you replace these words and characters with appropriate entries.
EXAMPLE TEXT Example text <Example text>
SAP Online Help
Print Workbench Form class Properties and Attributes Form Class Library Smart Form Indicator Test Print Indicator Object Type (BOR) Document Type Status Package Assignment and Transport Documentation Hierarchy Form Levels 1:1 levels Structure Logic of the Hierarchy Source Text Display of the Form Class Hierarchy Form Class Library Automatically Generated Variable Declarations READ Subroutines GET Subroutines FILL Subprograms TOP Area for Own Variables Subroutine TEST_PRINT Subroutine SET_ARCHIVE_INDEX Subroutine PROCESS_AFTER_DOC Subroutine PROCESS_AFTER_FORM Controlled Terminations in Exception Situations Processing Form Classes Creating Form Classes Creating Form Levels Creating 1:1 Levels Enabling Test Prints Example: Flight Notification Application Forms Properties and Attributes Form Classes
7 8 9 9 9 10 10 10 10 11 12 12 13 14 14 16 16 17 18 18 19 20 21 22 23 23 24 25 25 26 27 27 28 28 29 29
01.2004 30 30 31 31 32 33 33 34 36 36 36 36 37 38 39 41 42 42 43 44 44 45 45 46 47 47 48 49 50 50 50 51 51 52 53 53 54 Print Workbench 620 5 .SAP Online Help Form Types SAPscript/Smart Forms User Includes Start/End Exit Generated Modules Languages Status The Hierarchy of an Application Form Form Levels 1:1 levels Texts (SAPscript Only) Flow Logic and Processing Definition of the Hierarchy Interaction of Application Forms with SAPscript/Smart Forms Access to Data Read Control Variable C Processing Application Forms Creating Application Forms Inserting Variables in Texts (SAPscript Only) Creating a Summation Reading Additional Data from the Database Dynamic Intervention in the Process Flow in User Exits Transferring Own Data to Smart Forms Optimizing Performance User Exits in Application Forms Declaration of Own Data Areas Exit Before loop Exit During Loop Exit After loop Text Exit (SAPscript only) Start/End Exit Triggering Controlled Terminations Utilities Test Print Breakpoints and Debugging Copying from Clients Uploading and Downloading Application Forms Creating References 16.
2004 55 55 56 56 57 57 58 59 60 60 63 63 64 65 66 67 70 71 72 73 74 74 76 78 79 79 80 81 81 82 83 83 84 Print Workbench 620 6 .SAP Online Help Finding Variables Form Information Administration and Transport Mass Processing Mass Activation Transporting Application Forms Using References Versioning and Archiving via Upload/Download Translating Application Forms Worklist Creating Worklists Processing Worklists Calling Form Printing in ABAP Programs Module EFG_PRINT Module EFG_PRINT_EXPANDED Print Parameter Structure EPRINTPARAMS Print Parameter Dialog (EFG_GET_PRINT_PARAMETERS) Initializing and Closing Print Transactions Open/Close Optimization Print Processes and Print Scenarios External Further Processing of R/3 Data Archiving/Archive Connection with ArchiveLink Sending as e-mail or Telefax via SAPconnect Dispatch Control Using the Print Workbench with the Correspondence Tool Using Print Action Records Print Action Records (Technical Background) Function Modules for Programming Customizing Individual Creation of Print Action Records Mass Creation of Print Action Records Reorganization Integrating Print Action Records in Application Forms 16.01.
In the Print Workbench you can use Smart Forms (BC-SRV-SSF) and SAPscript (BC-SRV-SCR) alternately. • You can call up the Print Workbench via the area menu PWB. The form classes are delivered with each application component that uses the Print Workbench. Based on the form classes you can create application forms in which you can access the data defined in the form classes. You can use user exists to adjust the application forms to your requirements.01. You can define several application forms for each form class. Integration The Print Workbench (CA-GTF-PWB) is a component of the Web Application Server (Release 6. the Print Workbench uses the SAP standard components for form layout – SAPscript or Smart Forms. dunning notices. for example.20) and can be used by every SAP application with no further prerequisites. different invoices for different business partner groups. Print Workbench Architecture Print Workbench 620 7 . The Print Workbench is divided into the following subobjects: • Form classes Form classes are defined by SAP applications and contain a modeling and access instructions for all data that belongs to an application or to an application process.SAP Online Help 16.2004 Print Workbench Purpose The Print Workbench is a central development environment for creating standardized outgoing correspondence. and account statements are examples of form classes. Invoices. Changes to form classes delivered have modification status. The form creation is simplified by numerous auxiliary functions. For the configuration and layout of correspondence forms. SAP delivers example forms that you can use as a reference for your own application forms. Application forms You create application forms based on the form classes delivered.
2004 Application Call at runtime (EFG_PRINT) with correspondence request delivers •Layout & Design SAPscript •Preparation •Data interfaces Generated Print program Data : . Print Workbench 620 8 . Call Smart Forms or SAPscript API Form type Application Form Hierarchical display of processing logic Form class Data hierarchy created Form class library (ABAP Report) SAP Data (hierarchy) Data structures Access coding (if necessary) • Event-oriented processing • User exits for all events • Texts (only SAPscript) • Form type controls whether procesing via Smart Forms or SAPscript SAP customer Form class Definition The form class is an application-specific object that contains both the underlying data hierarchy for the application and the database access required for data procurement in the form of ABAP/4 coding. Therefore. The related Form Class Library contains access instructions in the form of ABAP subroutines. In contrast to logical databases however.. Structure A form class consists of a hierarchy representing a logical view of the datamodel for each application or an application process... Integration Form classes are a fixed component of an application and cannot be changed or replaced.. correspondence. the form classes are comparable to logical databases. that is.SAP Online Help 16. they have the advantage that they can swap two equal levels and duplicate a level in application forms. Further controlling properties are defined in the Attributes of a form class. Select * from . When creating the data hierarchy. particular emphasis was given to a logical view of the data model. Form classes are usually independent of the use of the data.01. Use Form classes are used by application forms to create forms.
you cannot use the form class for Smart Forms. Smart Form Indicator Definition The Smart Form indicator shows whether a form class is designed for using Smart Forms. These reflect the hierarchy of the form class and are responsible for transporting data from the application form to the Smart Form. generated DDIC types are assigned to each form level by the Print Workbench. in application forms. It contains the access commands for the form levels and 1:1 levels declared in the hierarchy.2004 Properties and Attributes Definition The attributes of a form class contain controlling information that is important for further processing. Structure The attributes of a form class contain the following fields: • • • • • • • • Form Class Library [Seite 16] Smart Forms Indicator [Seite 9] Test Print Indicator [Seite 10] Object Type (BOR) [Seite 10] Document Type [Seite 10] Status [Seite 10] Assigned Package [Seite 11] Documentation [Seite 12] Form Class Library Definition For each form class you have to define a form class library [Seite 16]. Print Workbench 620 9 . From a technical view. for example. the form class library is an ABAP report.SAP Online Help 16. If the indicator is not set. If the indicator is set for a form class.01.
Object Type (BOR) Structure A <BOR object type> can be assigned to a form class. Print Workbench 620 10 .2004 Test Print Indicator Definition By setting the indicator Test Print. This specification is optional and creates a logical link between the data hierarchy and a BOR object type in the system. you can suppress the test print in the maintenance of an application form for an application. you should only suppress the test print in documented exception cases. Document Type Definition The specified document type is optional and provides information about which document type is used for archiving documents of the form class. since the test print is an important tool for developing forms and for error analysis. The following objects and object statuses are considered and checked: • • The relevant form class library exists and is syntactically correct with regard to ABAP. the FIND method of the object type entered is called. and usability of a form class with regard to use in application forms.SAP Online Help 16. For all form levels or 1:1 levels of the form class. It is used for information purposes and test printing. the obligatory READ and GET/FILL subroutines exist in the form class library. since when you determine the initial object key for the test print. If no BOR object type is specified. correctness. The object key thus determined is interpreted as hierarchy access and transferred for further processing as the first entry in the first ranges table of the module EFG_PRINT [Seite 65].01. Status Definition The status of a form class indicates the completeness. However. The BOR object type specified is used as link object in archiving with SAP ArchiveLink. or none is suitable. the dialog for the test print can also be carried out via a form routine in the form class library by the application.
the package controls the assignment and the transport. the form class concerned cannot be transported. For each change to a form class. Prerequisites To transport a form class it must be assigned to a transportable package. You can change the object catalog entry that arises for the form class later. the system also checks whether all generated DDIC types specified in the form levels exist and have the structure derived from the form class. Print Workbench 620 11 . you can see the details of the status for the form class check. If a form class was created locally.2004 If the indicator Smart Forms is set in the form class. The system checks whether all referenced subobjects of a form class belong to the same package as the form class itself. you have to change the package assignment of the form class before the transport. Package Assignment and Transport Use During creation you have to assign a form class. such as an ABAP program. If this condition is not fulfilled.SAP Online Help • • The DDIC structures assigned to a form level or 1:1 level are active. Use The status of a form class is relevant for: • • Processing and activating application forms for a form class Transporting form classes The actions are terminated if the form class does not have the status Active.01. that is. to a package. in package $TMP. The referenced subobjects of a form class (form class library. a transport request is queried or the system checks whether there is an entry for the form class in an open transport request. Integration Form classes are transported in the correction and transport system using the transport object EFCL. The possible statuses are: Inactive Incorrect Active In the message log. generated DDIC types) are transported via separate transport objects and each have separate package assignments. 16.
Each form level and 1:1 level represent a data structure that is dependent on data that is higher in the hierarchy in accordance with its hierarchical position. The fixed assignment of the form class in an application form means that the hierarchy defined in the form class is always the template for the hierarchy in the application form and is always compared to it. PWB_FLIGHT_NOTIFICATION.SAP Online Help 16. Use You transfer the hierarchy of a form class to the application forms. Integration The hierarchy is a major component of a form class. Structure The hierarchy consists of two node elements: The form levels and the 1:1 levels. Example The following figure shows the hierarchy of a form class using the standard example delivered. Using defined data areas. that is. Print Workbench 620 12 . Integration The documentation of the form class is defined as General Text in the system and you can access it via the form class. all nodes of the hierarchy.2004 Documentation Use In the documentation of a form class you can define information about the data hierarchy and other special features of the form class.01. The individual fields of a form level or 1:1 level are defined by an assigned DDIC structure. reflects the maximum quantity of data that an application supports for use in forms as standard. All of the form levels together. There you can configure the form as required. For each level there are subroutines (ABAP form routines) in the form class library that carry out encapsulated data selections in the relevant tables of the database. Hierarchy Definition You use the hierarchy of a form class to display and model the data of an application or process. you can transfer the data declared in the form class to a form.
Since form levels represent a 1:n relationship between data. Structure The attributes of a form level contain the following information: • • • • Name of the form level Assigned DDIC output structure or DDIC table Short name Name of the DDIC structure or table type generated if Smart Forms are active in the form class For each form level there are exactly two ABAP subprograms in the form class library: READ subprogram The READ subprogram procures the initial data and is called up once at the start of form processing. This GET subprogram procures the n Print Workbench 620 13 . This means that for each entry belonging to a particular form level. A form level represents an entity in the data model of the respective application. the data is temporarily stored in these areas. GET subprogram There is a one GET subprogram for each form level. account or business partner.2004 PWB_FLIGHT_NOTIFICATION Flight confirmation to customer 5 CUSTOMER R Customer Form level 5 BOOKING R G Booking FLIGHT R G Flight 1:1 level Form Levels Definition The form levels make up the main part of a form class.01. there are n entries in the form level below it in the hierarchy. The form levels define the basic framework of a form class and data is added using the 1:1 levels. for example. Global data areas are derived from the name of the form level (WA_<name of form level>). The form levels are related to each other in a 1:n relationship. Use In application forms. in texts. the execution of a data loop is always connected to a form level.SAP Online Help 16. form levels are used to select the data belonging to the form level. The data selected is placed in global data areas and can be accessed in application forms. The READ subprograms of a form class are called up in the application form in the order in which the related form levels exist in the hierarchy. for example.
The GET subprogram extracts the n data records required for the current run from the global table. insert additional events (for example. Form levels and 1:1 levels represent a logical or business entity. The hierarchically subordinate form levels are processed. you can. The complex data type is filled for Smart Forms. 1:1 levels Definition The 1:1 levels are directly assigned to the form levels.01. Structure Logic of the Hierarchy Use The hierarchy of the form class is the tool used to model the dependencies of the data areas and the structure logic for the print transaction.2004 data records of the relevant form level dependent on the current data record of the next highest form level so that this can also be processed.SAP Online Help 16.. There must always be an application form for this. this means that data buffering is strongly recommended. The structure logic cannot be used in the form class itself. for example. Using this process definition. Typical examples for 1:1 levels are the long texts (explanatory texts) for each of the entities. Data from the appropriate 1:1 levels is imported 3. The name of a 1:1 level and the DDIC structure below it is defined in the corresponding form class and cannot be changed. you should make sure that GET subprograms can be called up more than once in an application form. The current form level entry is imported 2. you can choose between the following strategies: All the data for a form level is procured in the relevant READ subprogram and defined in the global table. When you are developing a form class. In the GET subprogram you procure the current data for the form level from the database directly or from other filled data buffers. Features In this way. The affiliated READ subroutine is empty. In the application form. With regard to performance. 4. A 1:1 level is dependent on the form levels to which it is assigned since the selection criteria for access to the database are in the data already imported for the superordinate form level. printing a text or Print Workbench 620 14 . you have to decide which strategy to use based on the data constellation and program design. a form level is always processed according to the same principle. the hierarchy tree is processed recursively from top to bottom. 1. When you use the subprogram types.. . They have a unique and direct relationship (1:1) to their affiliated form level.
Processing of the form level BOOKING begins. PWB_FLIGHT_NOTIFICATION Flight confirmation from customer 5 CUSTOMER R Customer 5 BOOKING R G Booking FLIGHT R G Flight The customer (CUSTOMER. Print Workbench 620 15 . 2. This hierarchy is processed as follows: . 4. Since the form level CUSTOMER has no 1:1 levels.. these can then be accessed in texts or user exists in the application forms. Since the form level has no further dependent form levels or 1:1 levels. the relevant data for the levels is placed in the global work areas (WA_<name of form level>) of the form class.01. table SPFLI) for a posting that contains additional information about the unique flight of the posting. 3. each entry for this level equates to a document. Example The process logic is described in more detail using the example PWB_FLIGHT_NOTIFICATION. At the same time. The flight belonging to the current flight booking is read and placed in the work area WA_FLIGHT. the processing of the next posting continues. the processing of the relevant form levels continues. The number of entries in this table is identical to the number of documents created later..SAP Online Help 16. All customers fulfilling the initial selection criteria are imported and placed in an internal table (T_CUSTOMER). In each run. a new document is opened.2004 calling a user exit) between events 2) and 3) and between 3) and 4). table SBOOK) represent two form levels. 5. All bookings for the current customer are imported and placed in an internal table. They have a 1:n relationship since one customer can have several postings. A customer is read from the internal table and archived in the global work area of the form level (WA_CUSTOMER). The highest form level (also called document level) is very important. table SCUSTOM) and his postings (BOOKING. There is a 1:1 level posting (FLIGHT. 1.
In particular.SAP Online Help 16. Form Class Library Definition The form class library is an ABAP/4 program. if you want to access the same data in different sections of the form. printing a text or calling a user exit) are added to this hierarchy. You can also process the same form levels several times running in application forms. for example. If all postings have been processed for the current customer. the dependencies of the different levels and call events of the subprograms are visible. Source Text Display of the Form Class Hierarchy Definition The source text display enables you to display the processing in a hierarchy in the way it appears later in the generated print program of an application form. This flow logic can be expanded to any number of form levels. Use This tool enables you to understand the print processes and you can use it for developing form classes and for implementing application forms. This is necessary. Structure All of the parts of a generated print program are displayed schematically: • • • • Global data declarations READ subprogram call Start/end of document The calls of the GET subprograms recursively integrated in the data loops Integration In the list you can doubleclick in the displayed subprograms and variables to navigate from the form class library. Structure A form class library has the following content: • READ and GET subroutines for the form levels Print Workbench 620 16 . Each form class has its own library. This means the same form levels can appear several times running in the hierarchy. The name of the program is defined in the attributes of the form class. The document is completed and the processing returns to processing step 2.2004 6. In application forms.01. the processing of the form level BOOKING for the current customer is completed. further events (for example.
for example.2004 For technical reasons .for example in order to be able to ensure a correct syntax check . Automatically Generated Variable Declarations Use With each form level or 1:1 level. For the subsequent print process. The applications are responsible for initializing the generated data areas. particularly for multiple calls. 1:1 levels are at the same hierarchical level as the related form level. NEVER CHANGE IT MANUALLY********** **DATA ONLY FOR SYNTAX-CHECK. data is retained. The total of all global work areas represents the maximum data list for an application form. The generated data declaration area is not transferred. a global work area and a global internal ABAP/4 table are defined. Example Source text of the form class PWB_FLIGHT_NOTIFICATION *§********************************************************************** *****THE FOLLOWING CODE IS GENERATED. DATA: T_BOOKING TYPE TABLE OF SBOOK WITH HEADER LINE. the work areas are particularly important. When you generate a print program. WILL NOT BE TRANSFERED TO PRINT PROGRAMS** ************************************************************************ … *******************global table declarations**************************** DATA: T_CUSTOMER TYPE TABLE OF SCUSTOM WITH HEADER LINE. They represent relevant data interfaces used. the internal table T_<level name>. In application forms. In addition. Integration The data declarations are generated by the Print Workbench automatically in a data area defined for this purpose. However. Both have the DDIC table structure that is defined in the attributes for the level.the form class library has the status of an ABAP/4 (Online) program.01. you can use global data areas (WA_*) that are at the same hierarchical level or higher. Print Workbench 620 17 . in SAPscript texts for a user. Since the generated print programs consist of function groups. it is regenerated in the print program. the form class library copies all subprograms into the print program. the program does not contain any functions that you can run. The naming of the global work area follows the convention WA_<level name>. the area with its own global data declarations is also copied. They are update with every change in the form class hierarchy.SAP Online Help • • • • READ and FILL subroutines for the 1:1 levels Other subroutines Area for own data declarations to be transferred to print program Generated data declaration area (cannot be changed) 16.
*******************global workarea declarations************************* DATA: WA_CUSTOMER DATA: WA_BOOKING DATA: WA_FLIGHT TYPE SCUSTOM TYPE SBOOK TYPE SPFLI . the calls of the GET subroutines are dependent on the hierarchy in the application form. It is executed just once at the beginning of the print program. the name of the next highest form level. GET Subroutines Definition With the exception of the document level. In addition to the READ subroutine. This READ subroutine is used for reading the data from the database. the GET subroutine then extracts the data records from the table that belong to the current entry of the next highest form level. the GET/FILL subroutines can also be used for reading data from the database. The affiliated READ subroutine is empty.2004 *§*end*******END-OF-GENERATED-CODE************************************** READ Subroutines Use A READ subroutine exists for each hierarchy level of a form class. 16. • All the data for a form level is obtained in the relevant READ subroutine and defined in the global table. • When you are developing a form class. You can follow two strategies. During the call. and the name of the form level itself. exactly one GET subroutine belongs to each form level. .SAP Online Help DATA: T_FLIGHT TYPE TABLE OF SPFLI WITH HEADER LINE.01. Print Workbench 620 18 . and called up once only. In the GET subroutine you procure the current data for the form level from the database directly or from other application-defined data buffers. The name of the GET subroutine is composed of the prefix GET. you have to decide which strategy to use based on the data constellation and program design. The n data records determined are processed sequentially in the generated print program. Use GET subroutines are used to procure the n data records for a form level dependent on the data of the next highest form level. . READ subroutines are at the start of a print program.
you only have to extract data from the internal global table T_BOOKING. Within the READ subroutine however. READ subprograms are at the start of a print program. Print Workbench 620 19 . APPEND t_booking TO yt_booking. you can also follow both of the strategies described above for the data procurement for FILL subprograms. ENDFORM. Example The source text of the GET subroutine of the form level FLIGHT is as follows. The data records received are then processed sequentially. "GET_CUSTOMER_BOOKING TYPE scustom.SAP Online Help 16. This FILL subprogram provides the relevant 1:1 level data for the current data record of the relevant form level. There is no GET subroutine for the document level as loop of the hierarchy. and the name of the 1:1 level. ENDLOOP. you can use all global data areas (<T_*> or <WA_*>) of the same form level or all form levels higher in the hierarchy. *&---------------------------------------------------------------------* *& Form get_form GET_CUSTOMER_BOOKING *&---------------------------------------------------------------------* FORM get_customer_booking TABLES yt_booking USING x_customer REFRESH yt_booking. LOOP AT t_booking WHERE customid = x_customer-id. Just as with the GET subprograms. and called up once only. The name of the FILL subprogram is composed of the prefix FILL.01.2004 Structure The interface of a GET subroutine contains the variables that are set as prerequisite or result for the call in by the Print Workbench in accordance with their hierarchical position. STRUCTURE sbook FILL Subprograms Definition There is exactly one FILL subroutine for each 1:1 level. the name of the relevant form level. the calls of the FILL subprograms are dependent on the hierarchy in the application form. Use There is exactly one FILL subroutine for each 1:1 level. Integration The GET subroutines are then called in the generated print program of an application form if a form level is to be processed according to the hierarchy of an application form. Since the posting data is read from the database in the READ subroutine. The GET subprograms are copied to the print program when you activate an application form.
TOP Area for Own Variables Definition If an application requires its own global instructions (for example.SAP Online Help 16. type pools). The FILL subprograms return the data record of the 1:1 level belonging to the current run.01. READ TABLE t_flight INTO y_flight WITH KEY carrid = x_booking-carrid connid = x_booking-connid. If 1:1 levels are beneath one another hierarchically. you have to define the corresponding instructions in a specific area of the form class library.2004 Structure The interface of a FILL subprogram contains the variables that are set as prerequisite or result for the call in by the Print workbench accordance with their hierarchical position. The area has unique limit characters and relevant comments. Integration The FILL subprograms are then called in the generated print program of an application form if the related form level is processed. Use The instructions defined in the TOP area are copied to the corresponding TOP include of the function group when the print program is generated for an application form. you only have to extract data from the internal global table T_FLIGHT. Within the READ subprogram however. you can also use the global variables of the 1:1 level higher in the hierarchy. you can use all global data areas (<T_*> or <WA_*>) of the same form level or all form levels higher in the hierarchy. The comments are generated by the Print Workbench during creation of the form classes. ENDFORM. Example The source text of the FILL subprogram of the 1:1 level FLIGHT is as follows. " FILL_BOOKING_FLIGHT TYPE sbook TYPE spfli . data. Print Workbench 620 20 . include. if the data records belonging to the form level are processed sequentially. that is. The FILL subprograms are copied to the print program when you activate an application form. *&---------------------------------------------------------------------* *& Form fill_form FILL_BOOKING_FLIGHT *&---------------------------------------------------------------------* FORM fill_booking_flight USING x_booking y_flight CLEAR y_flight. Since the posting data is read from the database in the READ subprogram. This means that the instructions are valid for all subroutines.
. set the indicator y_cancelled to ‘X’.2004 Structure The TOP area is restricted by the following comment lines in the form class library: *&********************************************************************** ***The following code WILL be transported to print programs************* *************PUT HERE YOUR OWN GLOBAL DATA****************************** *type-pools . Example *&---------------------------------------------------------------------* *& Form Testprint (Optional) * *&---------------------------------------------------------------------* FORM test_print TABLES Print Workbench 620 21 . When you have implemented the subroutine. via own value queries). you cannot change the frame generated. however.01.. If the user terminates. • Integration The subroutine TEST_PRINT is called up from an application form for a test print.. Subroutine TEST_PRINT Use You can use the test print with real data for checks during form development and maintenance and for the analysis of errors during data procurement of the form class.SAP Online Help 16. Activities Implement a dialog to determine an object key and place this in the ranges tables transferred such that you can use this information for the selection of relevant data in the READ subroutine of the document level. This means if: • A BOR object type is specified in the form class and the object key of this BOR object type is queried via the FIND method and then inserted in to the first line of the ranges table of the module EFG_PRINT. The application implements the subroutine TEST_PRINT and specifies the input parameter for the module EFG_PRINT in the subroutine (for example.. *data: . The test print is only possible if the form class supports it.. The implementation of the subroutine is optional. set the export parameter y_found to ‘X’. The READ subroutine of the document level must be able to process this information.. " own type-pools " own global data *&*end******END-OF-OWN-GLOBAL-DATA************************************** Do not change the restricting comment lines generated for the TOP area of the form class library.
Example *&---------------------------------------------------------------------* *& Form set_archive_index (OPTIONAL. The global data areas (WA_*) of the document level are filled in this event. This has the same importance as the object key of the BOR object type used for archiving. you can specify the complete archive parameters when you call up the module EFG_PRINT. ***always set this ! y_found = 'X' . REFRESH yt_ranges .2004 yt_ranges1 STRUCTURE efg_ranges yt_ranges2 STRUCTURE efg_ranges yt_ranges3 STRUCTURE efg_ranges yt_ranges4 STRUCTURE efg_ranges yt_ranges5 STRUCTURE efg_ranges yt_ranges6 STRUCTURE efg_ranges yt_ranges7 STRUCTURE efg_ranges yt_ranges8 STRUCTURE efg_ranges yt_ranges9 STRUCTURE efg_ranges USING y_found LIKE rfgen-kennzx y_cancelled LIKE rfgen-kennzx. ENDFORM. *** c-archive_index-object_id = wa_.SAP Online Help yt_ranges STRUCTURE efg_ranges 16. CLEAR y_cancelled . ***dialog for completion of ranges tables ENDFORM. set the archive index to the value of the object key of the BOR object.01.. The implementation of the subroutine is optional. If you always call up the Print Workbench once for each document. The subroutine is called up in the generated module of an application form just before the processing of a document.. "SET_ARCHIVE_INDEX Print Workbench 620 22 . you cannot change the frame generated. leave frame untouched !!!) * *&---------------------------------------------------------------------* FORM set_archive_index . Activities In the global variable c-archive_index-object_id. however. Subroutine SET_ARCHIVE_INDEX Use The subroutine SET_ARCHIVE_INDEX sets the ID relevant for the archiving system..
"PROCESS_AFTER_FORM Print Workbench 620 23 . The subroutine is called up in the generated module of an application form just after the processing of an individual document.01.SAP Online Help 16. Activities Implement the application-specific activities for the event specified above. Example *&---------------------------------------------------------------------* *& Form process_after_form (OPTIONAL. *do something ENDFORM. At the time of the call.2004 Subroutine PROCESS_AFTER_DOC Use The subroutine PROCESS_AFTER_DOC is designed for carrying out an application-specific activity after a single document has been processed. you cannot change the frame generated. The implementation of the subroutine is optional. you cannot change the frame generated. all data and form levels of the application form have been processed. It is called in the generated print program for the application form. Example *&---------------------------------------------------------------------* *& Form process_after_doc (OPTIONAL. * do something ENDFORM. leave frame untouched !!!) * *&---------------------------------------------------------------------* FORM process_after_form. "PROCESS_AFTER_DOC Subroutine PROCESS_AFTER_FORM Use The subroutine PROCESS_AFTER_FORM is designed for carrying out an application-specific activity after the application form has been processed. leave frame untouched !!!) * *&---------------------------------------------------------------------* FORM process_after_doc. The implementation of the subroutine is optional. however. Activities Implement the application-specific activities for the event specified above. however.
the open form process is closed so that the next document can be printed in the mass run. All other message activities could disrupt the global print process.’ABCDE’ EXPORTING … IMPORTING … EXCEPTIONS NOT_FOUND OTHERS IF SY-SUBRC NE 0. MAC_MSG_PRINT_CANCEL ‘E’ SY-MSGNO SY-MSGID SY-MSGID SY-MSGV1 SY-MSGV2 SY-MSGV3 SY-MSGV4. Print Workbench 620 24 .SAP Online Help 16. you can forward the corresponding message with the macro MAC_PRINT_CANCEL_REPEAT. but do not delete the texts printed in the form up to this point in the spool. Example CALL FUNCTION . Procedure If you want to terminate the print transaction of an (application) form. unexpected data inconsistencies). = 1 = 2. EZ) &4 to &7 – Message parameters 1 to 4 MAC_PRINT_CANCEL_REPEAT If a module called has triggered an exception in a subroutine with the macro MAC_MSG_PUTX. E ) &2 – Message number (for example. Prerequisites To terminate the print transaction.. Controlled means that before leaving the print module. call one of the following macros: • MAC_PRINT_CANCEL In MAC_PRINT_CANCEL the error parameters are transferred in the macro parameters 1 to 7: &1 – Message type (for example. ENDIF. The only parameter is the message type. Terminations within GET or FILL subroutines end with the printing of the current form. 100) &3 – Message class (for example. where the printing of a form must be subject to a controlled termination.01.2004 Controlled Terminations in Exception Situations Use In the subroutines of the form class library exception situations may occur (for example. use only one of the two macros.
SAP Online Help 16. 3. In the subsequent dialog box. Result If a form class has the status Active. Creating Form Classes Use You create a form class if you want to create standardized correspondence for an application or a process. you can use it for developing application forms. you can also select the package $TMP (= local object) and reassign the form class later if necessary.. If you want to use a transportable package. Since form classes represent interfaces. 2. In the menu choose Print Workbench → Form Class → Process (EFCS). Procedure . enter a transport request in the dialog box.2004 Processing Form Classes Purpose Creating and processing form classes Prerequisites To process a form class you have to • • • • Know the processes of the Print Workbench Have good ABAP programming knowledge Know the data model of the underlying application Have reconciled the data mode to the requirements of a document Process Flow Due to constant further development of the related application.01. Choose Continue. Specify a name for the new form class and choose Form Class → Create. you should avoid changes to the form class hierarchy or the assigned structures. You can output the remaining fields later if required. it should be applied and tested using your application forms. 1. In the following dialog box. form classes are themselves constantly developing. specify the name of the new form class library (ABAP program) and a short text). Print Workbench 620 25 . or at least check them precisely since incompatible change could invalidate productive application forms. 4. If you initially do not want to transport the form class. Once a form class has been created. choose a package for the form class.. If you also want to define the form class for using Smart Forms (recommended) set the indicator Smart Forms.
In the READ subprogram you can first read all the relevant data and can only fill the relevant subareas in the required internal table in the GET subprogram. Since the generated programs are function groups. 3.01. 4. Alternatively. place the cursor on an existing form level. it does not have any form levels or a form class library. Result You have created a form level and implemented the relevant data procurement in the relevant subprograms of the form class library. implement the coding for procuring the relevant data for the form level. This means that for n=1. Call up the form class processing. 1:1 levels. Creating Form Levels Use You create form levels to add structures to the dataset of a form class. 2. In the READ or GET form routines. If form levels exist. 1. Choose Edit → Create → Lower Level or Edit → Create → Same Level depending on the hierarchical relationship of the new form level. and the related subprograms together with the form class library. You can now include the form level in an application form and test that the subprograms work correctly. also enter the name of the generated structure and the generated table type. The name of the form level is binding and unique within a form class and should be fitting. the program is created automatically by the Print Workbench.. Prerequisites Form levels are in a 1:n relationship to another. Procedure . Print Workbench 620 26 . If the form class library has not been created yet.2004 Result The form class has been created. you can procure all the relevant data in the GET subprogram. Choose Continue. If the indicator Smart Forms is set in the attributes of the form class.SAP Online Help 16. Note that you can call the GET subprograms several times. you should use 1:1 levels. choose the node type Form Level. The new form level is inserted into the hierarchy. You should therefore buffer to reduce the effect on performance. You now have to create form levels. You can create additional form levels or 1:1 levels for the form level. 5. This relationship should always agree with the actual relationship in the data model – otherwise the hierarchy has a design error that has a negative effect on the use in application forms and the enhancement of the form class. these structures are in a 1:n relationship to existing form levels. Enter a short text and the output structure. However. the values in the global data areas are retained if you call a form or form routine again.. You are responsible for initializing the global data area <WA_*>. enter a maximum ten character name for the form level and if necessary. Create the related READ and GET subprograms by selecting the symbols R and G in the hierarchy. In the following dialog box.
2004 Creating 1:1 Levels Use You create 1:1 levels to add to the data list for a form level. The output structure must be a DDIC table or structure. Print Workbench 620 27 .01. Specify a name for the 1:1 level. Procedure . you have the following options: . implement the coding for procuring the relevant data for the 1:1 level. Procedure To enable the test print. If the form class library has not been created yet. Alternatively. the Print Workbench creates the program automatically. Prerequisites The data must be in a 1:1 relationship to the data of the relevant form level. 2.. Enabling Test Prints Use You can use the test print in the application form for development and later for the error analyses in the application form or the form class.. Create the related READ and FILL subprograms by selecting the symbols R and F in the hierarchy.. The name of the form level is binding and unique within a form class and should be fitting. you can procure all the relevant data in the FILL subprogram. The new 1:1 level is inserted into the hierarchy at the relevant point. 1.. In the READ subprogram you can first read all the relevant data and can only fill the relevant subareas in the required internal table in the FILL subprogram. Choose Continue. Note that you can call the FILL subprograms more than once and should therefore buffer so that you do not affect performance. Choose 1:1 level as node type and specify the output structure. You should therefore configure each form class accordingly. choose Edit → Create → Lower Level or Edit → Create → Same Level. Assign a new maximum ten character name for the new 1:1 level. you can specifically use actual data from the system without having to create a time-consuming test case with integration in an application process. In the READ or FILL subprograms. To do this. You can now include the 1:1 level in an application form and test that the subprograms work correctly. Place the cursor on a form level or a 1:1 level if the new 1:1 level is dependent on another 1:1 level. 3. Result You have created a 1:1 level and implemented the relevant data procurement in the relevant subprograms of the form class library.SAP Online Help 16. In particular.
As return parameter the Print Workbench expects the RANGES tables transferred to the application form. Use If a standardized correspondence is to be created from an application process. 2. Form class: flight notification PWB _F LI GH T_ NO TI FI CA TIO N Bes tä ti gu ng f ür F lu gbu ch un ge This particular form class is attached to the CUSTOMER form level. All 1:1 levels are placed in the hierarchy beneath the associated form levels and can be displayed or hidden by clicking on them. You can then no longer change the form class.2004 1. Print Workbench 620 28 . The form class assigned to an application form determines the structure of data using the data list provided by SAP. the form logic that you have determined. If the application uses the Print Workbench as the configuration tool. Result You can carry out a test print of application forms for a form class. you must configure application forms. it provides a form class that has to be set as attribute in the application form. Application Forms Definition Application forms are configuration objects. Form classes are also frequently attached to a document (for example. invoice document). They integrate the data structure defined in the relevant form class. this form level is below the level CUSTOMER in the hierarchy. In the attributes of a form class. The CUSTOMER and BOOKING form levels are in a 1:n relationship to one another. All flight bookings for one customer are shown on the BOOKING form level. Implement the subroutine TEST_PRINT [Seite 51] in the form class library such that it corresponds to the dialog for determining the initial object of the form class.SAP Online Help 16. you have to specify the form class. specify a BOR object type. Since a customer can have several bookings. The form class (or the data procurement in its library) must be able to process this. You are free to determine the form and scope of the data procurement and you can add your own data using user exits. Example: Flight Notification This is an example of the structure of a typical form class using the example of the form class Flight Notification. the Print Workbench uses the FIND method of the object type to determine an object key that is inserted in the first line of the RANGES table transferred to the application form. You can also choose between the basic tools for creating form layouts – Smart Form and SAPscript. When you create an application form.01. Additional flight details are stored in the flight that is assigned to a flight booking. and the form layout. The flight assigned to a flight booking is represented by the 1:1 FLIGHT level. At the time of the test print. the data procurement.
you can define additional activities. In the context of application forms.01. they are independent of the hierarchy and form levels. that is.2004 Structure The application form consists of: • • • • • • • Properties/attributes Hierarchy SAPscript or Smart Form form SAPscript text User exit includes User top includes Generated print program The core of an application form is the hierarchy. such as calling a user exit. form levels represent events in the process logic of the form. The status of an application form tells you whether the generated print program is up to date with regard to the application form and its subcomponents.SAP Online Help 16. The form classes are delivered by the applications. or for SAPscript. calling a text. The generated print program integrates: The SAP application Customer-defined configurations and user exit implementations SAPscript and Smart Form components and their calls in ABAP Application forms are generally defined in Customizing tables or master data. Form Classes Definition The form class of an application form contains the data hierarchy and the relevant access coding that belongs to an application for creating a form. Integration An application form is closely linked with the related form class and thus integrates an application form in the data model of the application. static settings. Print Workbench 620 29 . It has a similar function to the form class. In the events. The assigned and configured SAPscript forms and texts and Smart Forms integrate application forms in the design of the form layout. Properties and Attributes Definition The attributes of an application form contain all the relevant. Application forms are printed by calling the module EFG_PRINT. but is extended. which calls the generated module for an application form.
see the SAP library under Basis → Basis Services/Communication Interface (BC-SRV) → SAPscript (BC-SRV-SCR) or SAP Smart Forms (BC-SRV-SCR).2004 Use Form classes are used in application forms. either a Smart Form or a SAPscript form is defined in the attributes of an application form. pages. In the case of SAPscript. paragraph formats) for preparation of the form to be printed. In both cases the form contains all relevant layout information (for example. The application form controls the print transaction. windows. The interfaces between the application form and the form used depend on the type of form and must be reconciled with one another. different functions and options are offered for the form processing and form printing. Use Depending on the form type. In the case of Smart Forms. data is placed in the generated data structures and transferred to the Smart Form assigned. depending on their position in the hierarchy they can be processed or printed. texts are assigned to the hierarchy of an application form.and type-justified interface parameters for transferring the selected data: PWB_DATA or the name of the generated DDIC type at document level Data declarations in user top includes For detailed information about SAPscript and Smart Forms.01. the data is read and the program interfaces are called in the events defined for the SAPscript or Smart Form. that is.SAP Online Help 16. This setting is obligatory and cannot be changed once you have created the application form. • SAPscript Window (used in the attributes for text nodes) Form level symbols (WA_*) used in texts • Smart Forms Name. SAPscript/Smart Forms Definition Depending on the form type. Form Types Definition The form type of an application form controls whether a form is to be configured and output with Smart Forms or SAPscript. Print Workbench 620 30 . Use The application form and the related SAPscript or Smart Form are reconciled with one another during the print transaction.
User Includes Definition Using ABAP programming. which means that navigation. The name of the subroutine is composed of the prefix USER_EXIT and the name specified in the attributes of the application form. Integration The user includes are included in the TOP included in the generated function groups of an application form. before. Both subroutines have no interface parameters. DATA: TOTAL TYPE) are implemented in the USER-TOPINCLUDE. to all data areas generated by the Print Workbench or own data defined in the user top include. Since user includes are client-independent as ABAP program objects.01. Structure The start/end exist is an ABAP subroutine. You can use the exits to carry out initial or closing processing. as in all user exits. They can refer. the user exit subroutines are defined in the USER-EXIT-INCLUDE.2004 Integration SAPscript forms and Smart Forms are integrated in the configuration of the application form. You can also define and call other user-defined form routines. and consistency check take place in the processing of the application form. different application forms can reference to the same user include from different clients. you can define a start/end exit in addition to the user exits of the form levels and the text nodes. Use The use of these exits is optional. Start/End Exit Definition To carry out initial and closing activities pre document. The user exits defined in the user exit include are called in the defined events for the form levels (for example. deletion. you can enhance the function and dynamics of an application form as required.SAP Online Help 16. Use Data instructions (for example. The names of both ABAP includes are defined in the attributes of an application form. Print Workbench 620 31 . The ABAP implementations required are stored in the USER-EXIT-INCLUDE and the USER-TOP-INCLUDE. that a user include or referenced application forms can be invalidated by unintentional changes as part of maintenance of other application forms. during. under certain circumstances. Note therefore. creation. after loop).
user includes). for example.SAP Online Help 16. This function group contains all of the settings defined in the application form in the form of coding. The generated print program contains all ABAP commands and function calls of the form processing (SAPscript. GET. globally defined Print Workbench variables (C-*) and print parameters have been set. Here all of the activities that affect the form have been completed. Integration The generated module is called up dynamically in the module EFG_PRINT exclusively. you cannot carry out any form activities (for example. Here all static. Every other (for example. since this can lead to errors in the internal form control. which is different for each application form. The function group and the module are always defined locally ($TMP). This takes place in module EFG_PRINT. place the form in the R/3 spool. Use The module is called if the application form is to be printed. They have the same name.01. If the OPEN/CLOSE optimization is active in the print parameters. a function group with exactly one function module is generated. form class. The end exit is called at the end of the form processing. call of OPEN/CLOSE_FORM modules) in the user exits.2004 Integration The subroutine for the start-exit is called up in the generated print program at the start of form processing before each activity that affects a form. direct) call of the module is not supported by SAP. You have to regenerate the module for each change to the application form or one of the referenced objects (for example. which is called in the print event of an application. Generated Modules Definition When you activate an application form. Print Workbench 620 32 . FILL subroutines) Call of SAPscript or Smart Form program interfaces Call of user exit from user include The name of the generated module is composed of the naming convention prefix of the Print Workbench /1PWB/ and a number composed of the date and time of the first generation. Structure The generated module integrates the following parts of an application form: • • • • The flow logic of the application form according to the hierarchy Data procurement from the form class (call of READ. Smart Forms) that are responsible for the data procurement and processing and.
you have to define languages within application forms. Integration The languages defined are an integral part of the application form and are transported between systems. If you also want to print the form in other languages. Integration The following (sub)objects determine the status of an application form: • Application form (attribute. make sure that you have maintained all language-dependent components of the application form (texts. select the relevant language under Extras → Language → Select. If a language is used in which texts or the SAPscript form are missing. choose Extras → Language → Create. you first have to add the language to the language pool. the language in which you log on to the R/3 System is always set in the pool. If you wish to change the language interactively for each application form. However. Activities To translate application forms. Status Use The status of an application form is defined by different system conditions and different statuses of the application form objects involved. you have to set the internal language variable c-langu in the start exit. you use the translation tools of the Print Workbench. To do this. It shows whether the generated print program is up to date with regard to the application form and the relevant subobjects. printing is immediately terminated. standard texts). form levels) Print Workbench 620 33 . SAPscript form) for all languages used. In order to maintain the SAPscript form and the texts in languages other than your logon language. You can only print print programs with status Active. You have the following options for printing in different languages: • • The language is set at the start of the print process by the application in question and then retained. hierarchy. The definition of an application is not language-dependent. In the translation transaction the languages are created automatically. The language only refers to the language-dependent components (for example. or the language is not defined in the list for the application form.SAP Online Help 16.01. for each application form you can define a list of languages (except the maintenance language) for which the document can be printed. Features When you create an application form. To ensure that the print transaction works without any errors.2004 Languages Use To create outgoing correspondence in different form languages.
user exit include) 16. Structure The hierarchy consists of: • • • • • • Root level (= attribute of the application form) Form levels Document level (= first form level) 1:1 levels Placeholder for user exits (for example. attribute. The Hierarchy of an Application Form Definition The hierarchy of an application form covers all of the information about the relationships of the data belonging to the form levels.2004 When the module is generated. the form has the status New.SAP Online Help • • Form class (hierarchy. Use The hierarchy describes the flow logic of an application form.01. A. The hierarchy also defines a flow logic that is used to process all form levels and 1:1 levels and the data linked to these from top to bottom in the generated print program. If one of the above-mentioned subobjects is changed. the status is set to Inactive. B‚ D. or T) Texts for form type SAPscript (SAPscript standard texts) The following figure contains the schematic display of the hierarchy: The Hierarchy of an Application Form Print Workbench 620 34 . the current version information of this subobject is written into a local table and then used for determining the status. The print program that is called dynamically at runtime by the module EFG_PRINT is generated from the structure of the hierarchy. If no module has been generated from an application form. form class library) User includes (user top include. form levels.
The name of the work area is formed from the prefix WA_ and the name of the form level or 1:1 level (for example. If you use SAPscript. The hierarchy of an application form is always created following the structure of the underlying form class.SAP Online Help 16. If the system determines inconsistencies between the hierarchy and form classes. the number of entries for this form level corresponds to the number of forms created. For each form level and 1:1 level there is a global variable (work area) that you can access both in texts and also in user exits. the hierarchically dependent form levels and the affiliated 1:1 levels are also deleted or inactivated. it still appears in the hierarchy but is no longer considered for printing. If a form level is deactivated. if. Please note that when deleting or inactivating a form level. The root level contains logical data (attributes) for the application form. you can also assign additional SAPscript texts to the hierarchy. In contrast to other form levels however. you have to correct this before you can activate and print the application form. Print Workbench 620 35 . this document level must not be placed equal to another level. You cannot select or add form levels that are not defined in the form class. Integration The hierarchy of an application form is the basic configuration for the generation of the print program. For this reason. The document level is the first form level in the hierarchy and has almost the same attributes as any other form level. for example. a form level was deleted.01.2004 PWB_FLIGHT_NOTIFICATION 5 CUSTOMER Flight confirmation to customer Root level/Attribute Document level Customer PWB_FLIGHT_HEADER_INFO Information for customer PWB_FLIGHT_FOOTER Footer (Number of pages) PWB_FLIGHT_ADDRESS Address Letter for customer Heading for posting items (MAIN) Heading for posting items (TOP) PWB_FLIGHT_INTRODUCTION PWB_FLIGHT_ITEM_HEADER PWB_FLIGHT_ITEM_HEADER 5 BOOKING FLIGHT Bookings SAPscript-texts (SAPscript only) B D Form level User-Exits 1:1-leveö Flight PWB_FLIGHT_BOOKINGS Posting items By selecting and activating form levels or 1:1 levels you can define which data is to be read. WA_CUSTOMER). The document level is of particular significance to the form levels. you can delete it or deactivate it. form class and name of the user exit include and the user top include. these are printed according to their position. If a form level or 1:1 level is not required for printing. for example.
You can insert texts in the required position of the hierarchy.01. A 1:1 level is dependent on the form levels to which it is assigned since the selection criteria for access to the database are in the data already imported for the superordinate form level. together with the application form’s general process logic. They have a unique and direct relationship (1:1) to their affiliated form level. you can use the same form level more than once in the hierarchy (duplication). form levels at the same level have no hierarchical relationship to one another. In the texts.SAP Online Help 16. However. you can access all work areas (WA _<level name>) and your own variables that you define in the user top include. If you want to output a text for a form level. Here too the principle applies that siblings (levels at the same hierarchy level) are independent of one another.2004 Form Levels Definition Form levels form the basic framework of the hierarchy of an application form. The hierarchical relationships of the levels are defined in the form class and cannot be changed. Form levels and 1:1 levels represent a logical or business entity. Form levels that are hierarchically dependent on one another (parent-child dependency) have a 1:n relationship with one another. This situation is described in more detail in the next section. However. The name of a form level and the DDIC structure below it is defined in the corresponding form class and cannot be changed. 1:1 levels Definition The 1:1 levels are directly assigned to the form levels. The texts contain the actual contents of the printed form. Flow Logic and Processing Definition of the Print Workbench 620 36 . This means that for each entry in a form level there are several related entries for the form level below (for example. you have to enter this text in the hierarchy as a lower level of the form level. The name of a 1:1 level and the DDIC structure below it is defined in the corresponding form class and cannot be changed. Texts (SAPscript Only) Definition Texts are a further node type in the hierarchy of an application form of the type SAPscript. Typical examples for 1:1 levels are the long texts (explanatory texts) for each of the entities. customer and his flight bookings).
SAP Online Help
The application form is a configuration object that is translated in the generated print program in a processing and flow logic at runtime.
The flow logic of an application form is defined recursively, that is, a flow rule is defined for a form level; it contains the processing of other dependent form levels. For each form level in the application form, the following steps are executed in sequence:
1. The n entries for the current form level are determined for the current entry of the superordinate form level and place in an internal table. 2. The exit before loop is called – if it exists. The table determined is transferred to the user exit. There you can evaluate and modify the table. You can use the global data areas of the superordinate form levels and the related 1:1 levels. 3. The data loop over the entries of the internal table begins. At the same time, the global data area (WA_<form level>) is filled with the current line. 4. In the loop, all global data areas of the related active 1:1 levels are filled in sequence. 5. The exit during loop is called – if it exists. In this user exit you can use and modify all global data areas of the form level and the related 1:1 levels. You can also use the global data areas of the superordinate form levels and the related 1:1 levels. 6. The hierarchically subordinate nodes of the form level are processed. If it is a text (form type SAPscript), the text is printed; if it is a form level, the form level is processed in the same way. 7. The next entry in the loop is processed. If the last entry for the current form level is reached, the loop is left. 8. The exit after loop is called – if it exists. At document level, additional form control orders are given to SAPscript or Smart Forms, such as that a document is completed or a new document is starting.
Interaction of Application Forms with SAPscript/Smart Forms
In the Print Workbench, you can use the form classes delivered in different ways. As standard, SAPscript is used for print preparation. Alternatively, you can use Smart Forms for the print output. Since both components are very different, the integration in the Print Workbench is also different.
To use Smart Forms in an application form, you have to activate the relevant form class for using Smart Forms (see documentation for the indicator Smart Forms in the attributes of the form class).
SAP Online Help
In the SAPscript scenario, the Print Workbench provides the global data areas of the form levels and 1:1 levels defined in the form classes by the application; these can be accessed in texts with the usual symbol logic for SAPscript. The texts are inserted in the hierarchy of the application form and are called up at runtime in accordance with their position in the hierarchy. The SAPscript form assigned to the application form contains settings for the layout such as pages, window, font, paragraph formats. In the generated print program the print transaction consists of alternative calls for data procurement and calls of the SAPscript form processor (for example, OPEN_FORM, START_FORM, WRITE_FORM_LINES). This means that the form is created interactively between the Print Workbench and SAPscript. In Smart Forms, the data is read from the database and placed in the global data areas in accordance with the form class definition as for SAPscript, but the data is no longer valuated for immediate output in the form. It is firstly saved in a complex data structure also provided by the form class. The data is transferred from the global data areas to the complex data structure when the text is output for SAPscript. The complex data type of the form class agrees with the hierarchy of the form class. The nesting of the data is reflected implicitly by a complex data structure for each form level. The data written in the complex type is controlled by selecting or deactivating form levels and 1:1 levels. The name of the complex data type for the data transfer to the Smart Form corresponds to the assigned complex data type of the document level. The name of the parameter in the Smart Form must agree with the name of the parameter or be PWB_DATA. The system can create the Smart form for an application form of type Smart Form automatically. The interface is created appropriate to the application form or the form class. You can also adjust the interface of the Smart Form automatically later using a corresponding help function in the application form.
Access to Data Read
During the processing of the hierarchy, data is stored in the global work areas. These work areas are the central interface of the hierarchy to the read data in the application form.
In the print program, there is one work area for each form level and each 1:1 level and this has the name WA_<Level name>. You have several options for inserting symbols into a text: • In the SAPscript text editor, choose Insert → Symbols → Program Symbols and select the required symbols. All of the application form symbols that you can use based on the position of the text in the application form hierarchy appear. Place the cursor on the text, or on a form level or 1:1 level, and choose Extras → Display Symbols. Select the symbol you require from the list and choose Enter. The selected symbol is placed in the buffer and can be inserted again at any point. Alternatively, you can copy the symbol into the buffer by double-clicking on it in the list. Choose Utilities → Display Hierarchy. A new amodal window containing the form class hierarchy appears. By double-clicking on one of the levels you can display the appropriate symbol, as described in point 1. Choose
SAP Online Help
the symbol you want to transfer and choose Enter. Unlike in point 2, the selected symbols are not copied directly to the buffer unless you choose Copy to Buffer. You can also carry out a cross-level search. To do this, place the cursor on a form level and choose Find Variable. All the variables found are listed. The search includes both the names of the variables and their short text. The global data area that you can access in a text or a user exit depends on the position in the hierarchy. See also Flow Logic of the Hierarchy [Seite 14].
In the example above, the work areas are: • • • WA_CUSTOMER WA_BOOKING WA_FLIGHT
In these work areas you can access the texts and the user exits. A table or structure from the ABAP Dictionary is hidden behind each work area. You can ascertain the dictionary structure concerned in the attributes for the relevant form levels or 1:1 levels. In our example, the customer’s number is to be printed in the text PWB_FLIGHT_BOOKINGS. You can see from the attributes of the form level that the table SCUSTOM is masked by CUSTOMER. When you double-click on the table, you can see that there is a field ID that contains the customer number. To output the customer number of the current business partner, you must include the symbol &WA_CUSTOMER-ID& in the text. The character & at the beginning and at the end of the instruction distinguishes SAPscript symbols (variables) from normal text. The variable is replaced with the current content in the print program at the time of printing.
Control Variable C
The control variable C is a global variable that exists in each application form. It contains technical data for the application form or the print environment that is relevant for the current print transaction. The variable has a fixed structure and is defined globally which means that it can be queried at any time in texts or user exits.
The variable C enables you to request global information for the application form or the print environment so that you can interpret and process this information either locally in the form or externally.
The variable C consists of two parts. The first part is transferred to the Smart Form. This corresponds to the DDIC structure EFG_STRN_PRINTDATA: Field LANGU DEVICE Name Current language for the form Current output type (PRINTER, TELEFAX))
SAP Online Help
RDI FORMKEY FORMCLASS ITCPO ARCHIVE_INDEX COMM_TYPE SENDTYPE SENDTYPE_EXT COPYFLAG TESTMODE ITCPP XSF
SAPscript indicator for RDI Current application form Current form class Input print parameter for SAPscript as ITCPO structure Parameters for archiving (BOR object type, BOR object ID, archive object type) BCI send type (INT, FAX, RML) send type External send type Document is a copy Test print Print parameter returned by SAPscript as ITCPP structure XSF indicator for print using Smart Forms:
The second part of the variable contains further fields: Field TABIX LINES FORMTYPE NO_ENTRY PA_PRINT PA_UPDATE FORM_LEVEL LEVEL_NUMBER RDI_RESULT SAP_FORM SMARTFORM T_LANGU REC_STRING SEND_STRING MANDT RDI Name Count variable for the current loop Number of entries in the current loop Form type (Smart Form of SAPscript) Last form level has no entry Print action records should automatically be printed. Print action records to be updated Current form level Number of form level if multiple selection in the hierarchy SAPscript return structure if RDI has been used Name of SAPscript form Name of Smart Form Table of valid languages Recipient for send type (e-mail address, fax number, user name) Sender for send type (e-mail address, fax number, user name) Client of form RDI indicator
you first have to create the required application form. for example. SAPscript form or Smart Form. for example. proceed as follows: . Insert a text. 2. a print program is generated in the form of an ABAP function group and a function module.SAP Online Help 16. The variable is also defined in the form class library and can be used there. however. Maintain the SAPscript form or Smart Form. user include). Processing Application Forms Purpose To create an outgoing correspondence. Insert the text nodes in the hierarchy and maintain the texts (only for SAPscript). Via Extras → Display Control Variable. It is filled by the print program and interpreted later for further processing. 1. this generated function module is processed. the print parameters in C-ITCPO. Create an application form and name the subobjects (form class. Process Flow To create an application form.2004 SMARTPRINT SMARTFILL SF_RESULT SF_OUTPUT_OPTIONS SF_CONTROL_PARAMETERS Indicator whether Smart Form is to be called Indicator whether the data is to be filled in the complex data types (default ‘X’) Return result of Smart Form call (structure SSFCRESCL) Output options for Smart Forms (structure SSFCOMPOP) Smart Forms: Control structure (structure SSFCTRLOP) You can use the variable C at any time in texts (for example. this is only recommended in a few cases. 4. 3. Result When you activate the application form. you can display the available fields of variable C. 5. You can also change the variable. to query the form type. Implement user exits. Print Workbench 620 41 ..01. &C-TABIX&) or in user exits. If the application form is called via the function module EFG_PRINT in a print process of the application.. Integration The variable C is globally defined in the generated print program. The application form is then only available for printing once it has been activated.
Choose Print Workbench → Application Form → Process. Result You can now print the application form. Process the required SAPscript text. In this case. 2. Depending on the form type. Again. specify the names for the relevant user includes. Prerequisites The SAPscript form for the application form is active. If you want to work with user exits. If you have specified user includes. You can continue to develop it and adjust it to your requirements using the tools of the Print Workbench (for example. If the automatic recording of changes is active in the current client. If you are using SAPscript. you assign the application form to an application. you have to integrate the data delivered by SAP in the text. . 5. 1. Activate the application form.. see naming conventions. Inserting Variables in Texts (SAPscript Only) Use In addition to standardized formulations and headings.2004 Creating Application Forms Procedure .. insert text nodes in the hierarchy.. Pay particular attention to the hierarchical position of the text. Now select the affiliated form class. You cannot change this assignment later. Choose the form type (SAPscript or Smart Form). Place the cursor on the point where you want to insert the symbols. specify the name for the relevant SAPscript form or Smart Form. 4. Edit the texts. Procedure . create the includes by doubleclicking on the objects in the attributes of the application form. You can now start adjusting the hierarchy to meet your requirements (for example. Choose Continue. The application form is created.. 2. The complete hierarchy of the form class is inserted in the new application form.SAP Online Help 16. the text module of a form contains data from the business process that triggered the printing of a correspondence. Enter the name of the new application form and select Application Form → Create 3. Process the relevant SAPscript form or Smart Form and activate it. test print). 3. When naming the new objects you should also take into account the name ranges.. Print Workbench 620 42 . 4. you have to specify a Customizing transport request. for example..01. 1. 6. You have inserted one or more text nodes in the hierarchy of the application form. delete or deactivate form levels or 1:1 levels not used). By doing this. 2. 1.
Print Workbench 620 43 . 6. Navigate back to the application form. PERFORM_SUM). Choose Goto → User top include → Display/Process to navigate to the user top include. 9. Result The selected symbols are inserted in the cursor position. Enter the summation command. Activate the application form. such as DATA SUM LIKE WA_CUSTOMER-FORCURAM >. 1. 8. INIT_SUM) and the exit during loop (for example. the two symbols B and D (for “before” and “during”) now appear on the level on which the cursor is still placed.SAP Online Help 16. Place the cursor on the form level from which you wish to run the summation. The fields are displayed as symbols – they have a restricting & at the beginning and end. 5. 6. 3. Creating a Summation Prerequisites A user exit include and a user top include have been defined in the application form attributes..01. Define a summation variable. Choose D to navigate to the exit during loop. Choose Select. Choose one or more fields from the list. 10. Choose Continue. Specify a name for the exit before loop (for example. same level) in a text. Choose Integrate → Symbols → Program Symbols. Navigate back to the application form. Output the total in the form by placing the symbol &SUM& after the form level (for example. 2.2004 3. Procedure . 4. In the hierarchy display. A list of all fields relevant for the text node appears. for example. 4. Choose Continue. The fields include: Fields of all global data areas (WA_*) Fields of the control variable C Variables defined in the user top include 5. First choose B to navigate to the exit before loop. such as ADD WA_DOC_ITEM-NETTOBTR TO SUM. Navigate back to the application form. WA_CUSTOMERFORCURAM.. 7. Specify the global data field the total is to be based on. Trigger the summation with the ABAP order CLEAR SUM. Result The summation is now executed during the print and output in the text.
The text must come below the form level described above in the hierarchy. if you want to make the layout of the form dependent on the total. Procedure In the Print Workbench. 6. As standard. the Print Workbench concept is aimed at providing all data for an application or a process in the form class. SAP provides the following ABAP macros that you can call up in the user exits: Print Workbench 620 44 . you have to read the missing data from the database. 5. 3. 1. such as SELECT * FROM <DDIC-TABELLE> WHERE. You can then output the text using a second form level with the same name. To do so. Dynamic Intervention in the Process Flow in User Exits Use In user exists. in other words it must be a dependent node. You can use all work areas (including 1:1 levels) that belong to the form level or are higher up in the hierarchy as selection criteria. 4.. such as READ_DATA. Enter a name for the exit during loop. you determine that the dataset provided by the form class is insufficient. SAP recommends that you first execute the summation in the form without text nodes. Choose Goto → User top include → Display/Process to navigate to the user top include. Choose the symbol D in the hierarchy display to navigate to the user exit.01. Enter the command that reads the data from the database. for example. This is also applicable if you use the data in another user exit. you can make the process logic of an application form dependent. Reading Additional Data from the Database Procedure If. for example.SAP Online Help 16. Choose Continue.2004 If you need the summation before a text is printed. Determine the DDIC table containing the required data. 2. Only use this procedure if you need data for form printing that the form class does not provide. when you are processing an application form. on data or data constellations.. proceed as follows: . Result You can use the additional read data as a symbol in a text. Place the cursor on the form level for which you wish to read additional data and choose Select.
In order to be able to activate a form level. Result You can use your own global data of an application in a Smart Form in the same way as the standard data transferred. When you call this macro. for example. The data definitions must have the same data type as the user top include. you can also generate the data definitions in a user top include automatically in the Smart Form.2004 mac_next If you are in the program loop of a form level. the form level <Name> is no longer processed. the level must be defined as active in the application form hierarchy. regardless of where the macro is called. you can define the command mac_exit in the user exit. In addition to manual maintenance. This macro is not suitable for the exit after loop.SAP Online Help • 16. and do not want to (or no longer want to) process the subordinate nodes in the current run. You cannot activate levels that are not named or are not active in the hierarchy. it is no longer required due to a specific data constellation. • • • Transferring Own Data to Smart Forms Use If the data defined in the form class is insufficient and you have defined own data areas in the user top include and fill them in user exits. you can also make this data available in the related Smart Form. you can make the program branch to the next run by using the ABAP macro mac_next. Optimizing Performance Use For mass printing. in programming. note the following rules: Print Workbench 620 45 . mac_activate You can dynamically reactivate a form level (or 1:1 level) if it was deactivated by the macro mac_deactivate in a user exit. mac_deactivate <Name> You can dynamically deactivate a form level (or 1:1 level) defined in an application form in a user exit if. since otherwise runtime errors could occur when you call up the Smart Form from the generated print program of the application form. It has no effect there. Procedure Include the global data on the interface of the Smart Form using the same name. To do this choose Edit → Smart Form → Compare. This deactivation applies for all levels of the same name in the entire form. mac_exit If you want to terminate processing for the current node. You should only define this macro in the exit during loop and text exit.01. Therefore. optimal performance in application forms during data processing is very important.
The exit is called in the loop of entries of a form level. (Default = Yes) The exit is called at the start of processing for a form level. This is the last activity before the next same level or entry of the next higher form level is processed. such as summation. The global data areas of the form level and the related 1:1 levels are filled with data in this event. The reasons for low performance of processes are usually there. you can use the existing user exit infrastructure of the Print Workbench in the application form. The exit is called directly before a SAPscript text is printed. If you read data in user exits from the database. SAPscript is a meta language whose processing is low performance. in global data in the user top include). The interface of the subroutine contains an indicator (Y_PRINT_TEXT) that shows whether the text is to be printed or not. Exit During Loop Form level Exit-After loop Form level Text exit (SAPscript only) Text nodes Start exit End exit Application Form Application Form Print Workbench 620 46 . interactively. In user exits you can adjust application forms to your requirements and enhance your functions. These subroutines are called up in the generated print program according to their position in the hierarchy. The entries of the following loop are transferred to the interface of the subroutine.01. With database and ABAP traces. store these in ABAP variables (for example. use user exits instead of ABAP similar control commands. Features The following user exit types are available: Name of user exit Exit before loop Reference Form level Call/function The exit is called directly before processing of the entries for a form level.SAP Online Help • • • • • 16.2004 Deactivate or delete the form levels and 1:1 levels in an application form if you do not need them for form processing. The exit is called after the loop over entries of a form level. Integration User exits are defined in the form of ABAP subroutines in the user exit include of an application form. The exit is called at the end of processing for a form level. User Exits in Application Forms Use If you want to access form processing and data procurement and realize other requirements. Avoid duplicate naming of form levels in application forms. concentrate on the user exits that you have implemented. In SAPscript texts.
. SAP recommends that you also specify the user top include since there you have to define global data that is used.SAP Online Help 16.2004 Activities Before you create one of the above-mentioned user exits. The user exit then appears as a symbol in the hierarchy of the application form. the system issues corresponding warnings. 1. form level). you have to specify the user exit include in the attributes of the application form. The name must be alphanumeric and unique within the application form. in user exits. Declaration of Own Data Areas Use To design a flexible and dynamic application form. in addition to user exits you also need own data areas that you can fill and read when you process forms. 2. Specify a ten character (maximum) name. for example. Navigate to the object for which you want to create a user exit (for example. You can use the user exit includes assigned in several application forms. Print Workbench 620 47 . B for an exit before loop D for an exit during loop A for an exit after loop T for a text exit S for the start exit E for the end exit Select a symbol to go to the user exit maintenance. You have to declare these data areas as ABAP variables in the user top include. The ABAP variables defined there are therefore available in all user exits. Integration The user top included is included in the generated print program of an application form. If you use Smart Forms. Example The exits SUM_INIT (before) and SUM_PERFORM (during) exist for the form level BOOKING.01.. the variables defined in the user top includes are transferred to the generated module of the Smart Form in addition to the complex data type. . If you use the exit more than once (also cross-client). Exit Before loop Use The exit before loop is called up before the data lines for a form level is processed. it enables you to carry out initializing activities with regard to the form level.
01. to the corresponding 1:1 levels. Use this user exit to: • • • Perform summations Read additional data from the database Modify global data areas Example *&---------------------------------------------------------------------* *& USER_EXIT_SUM_PERFORM *&---------------------------------------------------------------------* Print Workbench 620 48 .SAP Online Help 16. You use the exit before loop to: • • • • • Read additional data from the database Initialize summation variables Sort the table entries to be processed Process SAPscript control commands (for example. ENDFORM. you can reassign entries or change values for individual fields. CLEAR sum. The internal table is always transferred to the subprogram that is processed next. You can modify the table and its entries in the user exit. In this user exit you can use the work areas belonging to the relevant form level.immediately after data is transported to the respective work areas. and to all form levels higher in the hierarchy.2004 Features The interface of the subprogram for the user exit is generated by the Print Workbench during creation of the exit and must not be changed. NEW-PAGE orPROTECT) Process SAPscript protect commands Example *&---------------------------------------------------------------------* *& Form USER_EXIT_SUM_INIT *&---------------------------------------------------------------------* FORM user_exit_sum_init TABLES xyt_booking STRUCTURE sbook . For example. Features The exit during loop runs while the form level is being processed . " USER_EXIT_SUM_INIT Exit During Loop Use The exit during loop is called up during the processing of a form level and enables you to carry out activities that have to be performed for each line of the form level. “defined in user-top-include SORT xyt_booking BY fldate ASCENDING forcurkey ASCENDING.
Features The exit after loop runs after the form level has been processed.2004 DATA: local_amount LIKE x_booking-forcuram. " USER_EXIT_SUM_PERFORM Exit After loop Use The exit after loop runs after the form level is processed and therefore. you can prepare a total for output or insert a manual page break.SAP Online Help FORM user_exit_sum_perform USING x_booking type sbook value(x_index) type sy-tabix. after all the form levels lower in the hierarchy have been processed. CALL FUNCTION 'CONVERT_TO_LOCAL_CURRENCY' EXPORTING date foreign_amount foreign_currency local_currency * * RATE TYPE_OF_RATE IMPORTING * * exchange_rate foreign_factor local_amount * * * * local_factor exchange_ratex FIXED_RATE = = fremdkurs = local_amount = = faktorsum = = sy-datum = x_booking-forcuram = x_booking-forcurkey = local_currency = 0 = 'M' DERIVED_RATE_TYPE = EXCEPTIONS no_rate_found overflow no_factors_found no_spread_found derived_2_times OTHERS = 1 = 2 = 3 = 4 = 5 = 6. implicitly. ADD local_amount TO sum. after all the levels/texts lower in the hierarchy are processed.01. You use the exit after loop to: • Analyze the summation Print Workbench 620 49 . 16. therefore. In this user exit you can process closing instructions. It is used for closing activities per form level. “execute summation ENDFORM . for example.
no data has been read and no SAPscript function modules have been called. For performance reasons however. ENDPROTECT) Initialize totals fields Text Exit (SAPscript only) Use The text exit is called before a SAPscript text is printed for each data line of a form level and can be used for different activities during processing of a form level. At this point. This enables you to dynamically control whether the text is to be printed and to carry out additional activities (for example.2004 Process control commands for SAPscript (for example. irrespective of the hierarchy. End exit This exit is processed last when you process the form. the whole form has been processed and the SAPscript module CLOSE_FORM has been called. data selection).01. it controls whether the text of the text exit is to be printed. exception situations can occur where the system is to react with a controlled termination. Start/End Exit Use Exit events are the external parentheses around an application form.SAP Online Help • • 16. • Triggering Controlled Terminations Use In user exits and the form routines of a form class. at the beginning and at the end of the form. In exit events you can carry out initial and final activities per application form. only the Print Workbench 620 50 . you can use IF instructions in SAPscript texts to decide which text parts are to be printed. At this point. NEW-PAGE. since IF instructions in SAPscript texts require a time-consuming interpretations (see also Optimizing Performance [Seite 45]). you should implement these instructions using text exits. Features The indicator y_print_text is transferred in the interface of the text exit. If there are alternative text parts. • Start exit This exit is processed first when you process the form. Features Selecting from these symbols will bring you to the user exit maintenance. The print process is not to be terminated. There are also two user exits that can be used.
Activities You are in the processing or display of an active application form.SAP Online Help 16. the application of the form class must provide an alternative. Prerequisites The form class of the application form must support test prints.. or during the analysis of errors during data procurement (form class) without the related application process. Choose Continue. form maintenance. Use the test print if you want to test the form without integrating it in the print process. If a test print is not possible. You can only print active application forms for test purposes.2004 printing of the current document. In a selection dialog of the application. the printer. Choose Application Form → Test Print → Execute. 1. and the output format for the test print and choose Continue. Test Print Use A test print enables you to output a form during form development.. Utilities Use To make the development and administration in the Print Workbench more efficient. or an individual dialog takes place to select an initial object. Integration How the test print is initiated depends on the form class of the application form. Procedure Always use the ABAP macro MAC_PRINT_CANCEL in all user exits (see Controlled Terminations in Exception Situations [Seite 24]). Either the user determines an initial object via the FIND method of the BOR object type assigned. choose the initial object for the test print. To make sure that terminations that disrupt the print process of the Print Workbench do not occur. Print Workbench 620 51 . you can use various tools and functions that are described in more detail below. 2. For some form classes you cannot carry out a test print. .01. Specify the send type. you can use the ABAP macro MAC_PRINT_CANCEL to define how the termination is to take place. You can set and vary the print data and the print parameters.
SAP Online Help 16. Prerequisite You have the relevant authorization. Via Extras → Set/Remove Breakpoints. If you repeat the test print. • Carry out a test print for the application form. In the subsequent dialog box. • Place the cursor on the places in the hierarchy where you want to carry out an analysis. insert breakpoints into the hierarchy of the application form.01.2004 3. SAP recommends that you process the application form and the Smart Form in two separate sessions and carry out changes to the Smart Form and start the test print from the application form simultaneously. Print Workbench 620 52 . In the second case. Activities In the display or processing of an active application form that can be tested. If you use an application form of the type Smart Form. If you want to enter new parameters for the test print. if you want to find out why data was not output in a form or output incorrectly.. The generated print program contains numerous breakpoint instructions that you can use if necessary. depending on whether you want to output the result of the test print on the printer or only display it on the screen. You cannot restart the transaction. You can process the Smart Form in a new session from the processing of the application form via Goto → Smart Form → Display in New Session. Navigate to the generated print program via Goto → Generated Module → Display or via Goto → Generated Module → Subprograms and set a breakpoint in the editor.. specify the additional print parameters and then choose either Print or Print Preview. you can analyze the generated print program in a runtime environment during the test print. the ABAP processor goes to your breakpoints in the debug session. READ/GET/FILL subprograms. choose Application Form → Test Print → New Object. text output). the ABAP process goes to the ABAP debugger in all relevant subprograms for the respective hierarchy nodes (for example. In the first case. Breakpoints and Debugging Use For example. the specifications that you are made are used again. you have the following options: .
Uploading and Downloading Application Forms Use You can upload or download application forms if there is no direct transport connection to R/3 systems. Features When an application form is downloaded. In the following dialog you are requested to name the referenced subobjects (new). Therefore. In mass processing you can also carry out a mass download.. Choose Print Workbench → Application Form → Tools → Copy from Client. these components also have to be copied during the transaction. check precisely before you overwrite them. Print Workbench 620 53 . The referenced subobjects of an application form can be used by other application forms. Integration All (sub)components of an application form are transported when you upload or download. and if necessary. Choose the source clients and an application form. Features The hierarchs and the attributes of the application form are copied. Since an application form consists of different (sub)components. all its components are saved in a local file: • • • • hierarchy/attribute of the application form SAPscript form/Smart Form. both user includes.. depending on the form type SAPscript texts (only for SAPscript) user includes When you upload. You can also suppress the copying of individual objects or reference to existing objects. You can also overwrite explicit specifications. The Print Workbench shows multiple use of objects as a warning. 3. Activities . along with the SAPscript form or Smart Form depending on the form type.01. you can change all the names of the subcomponents before you save these in the R/3 System (see also Copying from Clients [Seite 53]). 1. You can save an application form and its components in a local file of your front-end and then load them to any version-compatible R/3 System. Pay attention to the usual naming conventions.SAP Online Help 16.2004 Copying from Clients Use You can copy application forms from other clients to the current client. 2.
you can create links to an application form in other clients so that it does not have to be transported or replicated.. pay attention to the naming conventions and the existing uses. Specify the (source) clients and the names of the referenced application form and choose Continue. choose Print Workbench → Application Form → Application Form → Download. Procedure .01.. from other clients). Download 1. Specify the absolute name of the file to be written. . Prerequisites The target client must not contain an application form with the same name. Activities .2004 The internal data format of the files has changed considerably with R/3 Basis Release 6. To upload an application form from a local file.. To download an application form to a local file. 1. Choose Print Workbench → Application Form → Tools → Mass Processing.. only the runtime components from another client are used during printing. The subsequent dialog box is identical to the one for copying or copying from a client.. choose Reference. Files created in an earlier release can no longer be read. Choose Print Workbench → Application Form → Tools → Create Reference in Other Client. 2.. To create several references in one step. 2. The data is then read from the system and downloaded to the specified file. 3. The application forms selected from other clients must not exist in the current clients..SAP Online Help 16.. If the file contains several application forms. and with the right mouse button. 1. For a reference. a corresponding list appears for you to select from.. Upload . Specify the clients and the application forms in the selection criteria and choose Program → Execute. Print Workbench 620 54 . choose Print Workbench → Application Form → Utilities → Upload.. Select the application forms that you want to reference to. When you name the new subobjects. Choose an application form from the list. 2. To download several application forms (for example. select these in the mass processing of application forms and then choose Download with the right mouse button. ...20. proceed as follows: . Creating References Use If you want to use the same application form in several clients.
If you want to create real copies of the application forms. You are in the processing/display of an application form. SAP therefore recommends you use the following procedures. Form Information Use With the function Form Information. For information about integrating variables in a text. The printed list can also be used to find symbols used in SAPscript texts and user includes. In the following dialog box. the application forms are created as references to the source clients. For Smart Forms.2004 After a client copy. you can transport them from one client to another. you can display the available variables in text processing. specify the search term and the search area. To search for a field in the dataset of the form class hierarchy. Print Workbench 620 55 . see Inserting Variables in Texts (SAPscript only) [Seite 42]. you can display the variables in the hierarchical display of the complex data structure (ABAP Dictionary).. under certain circumstances. Finding Variables Use Depending on the form class. Choose Extras → Hierarchy Display.SAP Online Help 16. they may be difficult to find. 1. the dataset contains a number of fields that are in different levels and different DDIC structures. On the subsequent processing screen. open the data overview of the form class in question via Extras → Display Form Class Hierarchy. In Smart Forms. you can get a global overview of the complete content of an application form. Activities . The variables found are displayed. In SAPscript. you can find additional fields in the ABAP Dictionary. 2. Features The Print Workbench provides you with various options for finding variables in the data hierarchy of the form classes: • • • You can display the fields of any node in the hierarchy of an application form and search there.01. place the cursor on the form level for which you want to display the related data and choose Edit → Display Symbols.
is difficult to administrate without special tools.01. Administration and Transport Purpose From an external point of view.. the hierarchy in flat presentation and the contents of the user exit include and user top include texts are displayed. Mass Processing Use You use the mass processing of application forms to manage application forms efficiently in a client. Integration All subobjects of an application form are used in mass processing. Select Utilities → Form Information. The contents of the SAPscript form can be printed using a corresponding function for SAPscript forms. due to the heterogeneity of the objects used. the application forms in their entirety represent a large object structure the. Features You can use the following functions: • Cross-client overview of application forms with the following subfields: Status Form class Form Types Name/package of SAPscript or Smart Form and user include Reference client for references Form name • • • Mass activation Mass check Mass Transport Print Workbench 620 56 .. Activities .SAP Online Help 16. 2. The Print Workbench provides you with functions and tools for managing the objects of the Print Workbench and the referenced objects. Choose Print Workbench → Application Form and specify an application form.2004 Features The attributes. 1.
If you do not want to activate the application forms that have already been activated again. for example. Specify the client and the selection criteria for the application forms to be activated.2004 The individual functions are dependent on the selected entries. In the log you can see whether all activations were successful. transportable (sub)objects..01. 1. Transporting Application Forms Use An application form consists of different. independent. set the indicator Only if Active. Activities Select the required application forms for which you want to execute a function and then choose the required function with the right mouse button. Mass Activation Use You can use Mass Generation. if you want to activate all or certain application forms in the background with no further dialog.. If you start the program in batch mode. Features The mass activation program activates any number of application forms in any number of clients and delivers a results log. The individual objects each have a different transport behavior. the result log is made persistent and you can evaluate it with transaction SLG1. Choose Print Workbench → Application Form → Tools → Mass Activation. 3. Activities . Transport Behavior of the Objects Object Type Transport Object (R3TR) Client-Independent Object Catalog Entry (TADIR) Print Workbench 620 57 .SAP Online Help • • • Mass download Individual copy (same or other client) Individual deletion (only same client) 16. 2. Prerequisites The application forms to be activated must not contain errors. Start the program.
c. If an application form cannot be activated. but has a cross-client object catalog entry. proceed as follows: . You can analyze the corresponding messages in the transport log for the request. Using References Use You can set references if you want to develop and manage application forms in a system in a central client. a corresponding error entry is updated in the transport log of the request.2004 Application forms SAPscript forms Smart Form SAPscript text User includes Generic function group EFOM FORM SSFO TEXT PROG (FUGR) NO NO YES NO YES (NO) NO YES YES NO YES $TMP (LOCAL) An application form has only been correctly transported if all subcomponents have also been transported.. This has the following advantages: • You can encapsulate the original versions of the application form in a client defined for this purpose and it can then. The application forms placed in the request are checked and reactivated if necessary when you release the transport request. The option you choose depends on the system setting of the client in which the application form is developed or maintained. Choose Print Workbench → Application Form → Transport. In the subsequent dialog box. the transported application forms are also activated. b. If errors are determined. including subcomponents. • Automatic transport If the setting Recording of Client-Independent Customizing is active. select the subobjects to be transported. only be used by certain users in the system.. Features You have two options for transporting application forms. Manual transport You carry out a manual transport in the following cases if the recording of client-specific Customizing is not active in the client in which you are developing the application form. and/or you want to place the application form. Exception: The SAPscript is client-dependent. an entry is created in a Print Workbench transport request for the object concerned. During the import into the target system. Print Workbench 620 58 . The client-independent objects are entered in transport requests as standard provided you have assigned them to transportable packages. Specify a transport request and choose ENTER.SAP Online Help 16. the release must be terminated.01. for example. in a transport request. The system requests this entry before the change. application form or SAPscript text). a. To do so. each time you change a client-independent object (for example.
for example. Versioning and Archiving via Upload/Download Use You can use uploads and downloads for transporting into different systems. You can also use uploads and downloads to make the status of individual or all application forms persistent outside the system and thereby carry out versioning or archiving. The changes are visible and valid in other clients immediately. Create multiple references .SAP Online Help • • 16. Integration The upload and download of application forms contains all components of an application form... With the right mouse button choose Create References.. You can quickly access forms of another client.. The client-specific objects used for the runtime are read from the referenced client and not the current one. There must be no application forms with the same name in the current client. 2.01. 2. you can select the components to be loaded.2004 You no longer need to transport or copy within a system. Select the application forms that you want to reference to from other clients. Activities Create a reference . Choose the client and the name of the application form. use mass processing. An integrated versioning of application forms within the R/3 system is not supported. Integration References to other clients are a proprietary function of the Print Workbench. Choose Print Workbench → Application Form → Tools → Create Reference in Other Client. but are visible and you can use them for printing. To display the application forms of another client. 3. Features You create references from one client to application forms of another client and can then use them as if they were in the current client. Activities Save the selected or all application forms of a client with the download function. 1. Print Workbench 620 59 . In an upload. in mass processing. The referenced application forms do not exist physically in the current client. 1. There must be no application form with the same name in the current client.
2004 Translating Application Forms Use You cannot translate the Print Workbench application forms and SAPscript texts with the standard R/3 translation function. The worklist groups the individual entries and manages the list of objects to be processed. proceed as follows: • • Creating Worklists Processing Worklists In addition. After translation. Mass processing of worklists If there are several worklists in the system.01. Print Workbench 620 60 . • Translation of SAPscript forms not used in the Print Workbench If you use SAPscript forms that do not belong to the Print Workbench. Hierarchy The following figure shows the first level of a worklist with the individual application forms to be translated. In particular. you can manage them using this function. that is. you can delete worklists and update their status. Structure The worklist consists of three hierarchy levels and is subject to status management. Worklist Definition Lists of objects that are to be processed once only within a certain time frame for each language. Activities To translate application forms. You therefore have to follow a different translation procedure: • • • You have to create separate worklists for translating application forms. From the worklist status.SAP Online Help 16. a new transport to the target system must be carried out. forms that are not used by an application form. you can use further administrative tools that you access via Print Workbench → Application Forms → Environment → Translation → Administration. you can assess the general processing status. Translation should take place in a special client so that a separate transport can be carried out. you can list these with this function and check their translation status. A statistic gives information about the status of translation activities. including their status and the tasks to be carried out for the objects.
Here.2004 Worklist ET 12.01.08. By expanding the second level you reach the third level (see figure).SAP Online Help 16. the worklist is subdivided into the following object groups: • • • Table short text SAPscript forms SAPscript text The individual objects to be translated are under these object groups. Print Workbench 620 61 .98 Test list 4 Application form Application form Application form Application form Application form Application form Application form Application form Application form Application form FI_CA_INSTALL_SAMPLE FI_CA_PAYMENT_SAMPLE FI_CA_RETURN_SAMPLE FI_CA_DUNNING_SAMPLE FI_CA_ACCTSTMT_SAMPLE IS_U_CA_CASHPAYMENT_RECEIPT01 FI_CA_ACCTBALA_SAMPLE IS_U_SECURITY_REQUEST ZZ_CHHE_ACCT_STMT FI_CA_ACCTINFO_SAMPLE 4 4 4 4 4 4 4 4 4 By expanding this level you reach the second one.
SAP Online Help 16.09.01.1998 Test list 5 5 Application form Table short texts EFRMTE EFRMSTRTE 5 IS_U_BILL SAPscriptFormular IS_U_BI_BILL 5 SAPscriptTexte IS_U_BILL_ADDRESS IS_U_BILL_HEADER IS_U_BILL_ITEM_CONSUMPTION_HEA IS_U_DOC_ITEM_CONSUMPTION IS_U_BILL_DISCOUNT IS_U_DOC_ITEM_AMOUNT_HEADER Doubleclick on the individual objects to translate them. Print Workbench 620 62 .2004 Worklist TSAN 10.
your initials) Date (for example. 2. 4. To create a worklist from this list. You now see all the objects for translation in the application form you have selected.. the current date) Short text 5.. Choose Program → Execute. Result The worklist has been created. Log on to the relevant client in the system in which you translate the form.SAP Online Help 16.2004 Creating Worklists Prerequisites . See also Creating Worklists [Seite 63]. Enter the name and form class of the application form to be translated and the original and target language. enter the following: ID (for example. If there are red lines in the list. In the menu.. see Worklists [Seite 60]. Once you have generated the worklist. Procedure Preparation . For more information about the different hierarchy levels. 1. In the dialog box Indicator for Worklist.. and choose Print Workbench → Application Forms → Environment → Translation → Create Worklist.01. 3. choose Edit → Expand Subtree. 2. Red lines signify errors that must be eliminated. you can process [Seite 63] it. Choose Continue. Processing Worklists Prerequisites To process a worklist you must first make sure that a worklist exists. 1. Execution Translating table short texts Print Workbench 620 63 . You obtain a list of the objects to be translated in the application forms. enter your indicator and the date on which the worklist is to be generated and choose Continue. The technical key of the worklist is made up of the ID that you entered and the date. In the dialog box Indicator for Worklist. The required worklist is displayed. Place the cursor on an application form and in the menu. choose Print Workbench → Application Form → Environment → Translation → Worklist → Process. notify your system administrator. choose Translation List → Save/Send → Create Worklist.
Calling Form Printing in ABAP Programs Use An application form is a configuration object from which a runtime object in the form of a function module is generated. here you can translate the short text. 2. If you ignore the warning. here you can translate the SAPscript form. If the system determines any differences. The total number of lines does not have to match the original. however.. This provides you with information about which lines have changed in the current version. paragraph format :/) Symbols (for example. SAPscript texts consist of: Text Control characters (for example. tabulator.SAP Online Help 16. control lines. If there is a text version in the Print Workbench buffer. or ignore the warning. the symbol appears next to the text.. and symbols. this version is saved in a Print Workbench buffer.01. Result Once all items have been edited and translated. The screen Translation of Tables with Master and Transaction Data appears. Choose the SAPscript text by doubleclicking on it. Translating SAPscript texts . Place the cursor on a SAPscript text and choose Edit → SAPscript Text → Display Original. The worklist is considered completed once all application forms have the status Translated. double-click on the symbol . This action starts the comparison editor. position the cursor on the edited text and choose Edit → SAPscript Text → Release.. Enter the required target language and choose Translation → Create/Change.) Control lines (for example. Select the required SAPscript form by doubleclicking it. 3. To carry out a version comparison. Print Workbench 620 64 .2004 Select the required table short text by doubleclicking it. The SAPscript Translation screen appears. it issues a warning. The screen Change General Standard Text appears. 2. 1. Save your translation and then release the translated text. A new session is opened and here you can see the original text as translation reference. you can compare the old version with the current version. enter the form to be translated. Translating SAPscript forms . the translation is automatically released. The following is a description of how the runtime object is called from an ABAP program to print an application form.. When you release a translation. The screen Meaning appears. If this text is then changed. match the original. The number and sequence of the paragraphs must. To do this. In the field Form. You can navigate within the text to check the cause of the warning. the system automatically compares the number and sequence of the paragraphs in the translated text with the original. the system changes the status of the application form automatically.. If a standard text has already been translated and released. &DATE&) Note that you do not have to translate control characters. 1.
ITCPO) Information for the data procurement of the form class (ranges tables) The call of the module is independent of the form. The parameters of the module contain • • • All controlling information for the Print Workbench (for example.SAP Online Help 16. Structure The interface of the module consists of the following parameters: Import parameters X_PRINTPARAMS X_ARCHIVE_INDEX X_ARCHIVE_PARAMS X_DIALOG EPRINTPARAMS TOA_DARA ARC_PARAMS (Indicator) Structure of the print parameters Archive information per document (optional) General archive information (optional) Execute dialog for print parameters (optional. form class) Control information for the print process (for example. Use module EFG_PRINT in individual print processes and EFG_PRINT_EXPANDED in mass printing. The difference is in the use of send control.01.2004 Integration Form printing is called exclusively via central interfaces of the Print Workbench. default: SPACE) Object handle for recipient (optional) Object handle for sender (optional) Print Workbench result structure Result of RDI print X_RECIPIENT X_SENDER Export parameters Y_PRINTPARAMS Y_RDI_RESULT SWOTOBJID SWOTOBJID EPRINTPARAMS RDIRESULT Print Workbench 620 65 . Module EFG_PRINT Definition The module EFG_PRINT reflects the central interface for printing an application form. and the form format (SAPscript or Smart Form). application form. which is triggered in the module EFG_PRINT_EXPANDED. output formats. Activities The modules EFG_PRINT and EFG_PRINT_EXPANDED are available. the form class.
BOR object type. while the module EFG_PRINT should be called for individual printing or online printing. The user can also set or modify these by calling the module EFG_GET_PRINT_PARAMETERS. document type. Both object reference IDs X_RECIPIENT and X_SENDER are of the type RECIPIENT and must be created with the BOR methods first. If the status is not Active. If the module EFG_PRINT is called. In comparison to the module EFG_PRINT. Module EFG_PRINT_EXPANDED Definition The module EFG_PRINT_EXPANDED is an extended variant for calling form printing in the Print Workbench. You can only print application forms that have the status Active. You can also use module EFG_GET_ARCHIVE_PARAMS to fill these structures. The archiving data that belongs to the application (for example. as letter and as e-mail). optical archiving of correspondence is not possible. first the status of the form is checked. BOR object ID) is transferred in both import structures X_ARCHIVE_INDEX and X_ARCHIVE_PARAMS. without this data. application form.01. the module is designed for mass printing. Structure The interface of the module consists of the following parameters: Import parameters X_PRINTPARAMS X_ARCHIVE_INDEX X_ARCHIVE_PARAMS EPRINTPARAMS TOA_DARA ARC_PARAMS Structure of the print parameters Archive information per document (optional) General archive information (optional) Print Workbench 620 66 . you can use the module EFG_PRINT_EXPANDED to change the print parameters with the send control or send the outgoing correspondence in different ways (for example. an activation of the form and generation of the related print program are triggered. printer). Above all.SAP Online Help EPRINTPARAMS SSFCRESCL 16.2004 Y_PRINTPARAMS Y_SF_RESULT Table parameters XT_RANGES<number> (10) YT_OTF_DATA Print Workbench result structure Result of printing by Smart Form EFG_RANGES ITCOO Ranges table for interpretation of data selection in form class OTF data returned (if required by application) The most important control information for printing is in the import structure X_PRINTPARAMS (for example.
Print Parameter Structure EPRINTPARAMS Definition In all programming interfaces of the print workbench a structure of the type EPRINTPARAMS is used.2004 X_SENDCONTROL X_RECIPIENT SENDCONTROL SWOTOBJID Send control (optional) Object handle for recipient (alternative to X_REC_ADDR and X_REC_PERSNUMBER) (OPTIONAL) Address number of recipient from central address management (optional) Person number from central address management (optional) X_REC_ADDR AD_ADDRNUM X_REC_PERSNUMBER AD_PERSNUM Export parameters Y_PRINTPARAMS Table parameters XT_RANGES<number> (10) EFG_RANGES Ranges table for interpretation of data selection in form class EPRINTPARAMS Print Workbench result structure You define the send control in Customizing for the Print Workbench. It enables you to change the technical print parameters transferred according to the settings in the send control. Structure The structure EPRINTPARAMS consists of two parts: • • Structure EFG_PRINTPARAMS of the Print Workbench The structure ITCPO from the known SAPscript interfaces (for example OPEN_FORM) relevant for SAPscript Structure of EFG_PRINTPARAMS DEVICE • • Device type for SAPscript/Smart Forms PRINTER for normal print output (default) MAIL for other send types (e-mail. fax) Print Workbench 620 67 . It contains all relevant control fields that are relevant for the Print Workbench itself or for SAPscript or Smart Forms.01.SAP Online Help 16. This enables you to send the same correspondence several times using different send types.
01.SAP Online Help 16. no direct print Language of form Indicator: Test mode Indicator: Debugging mode when calling the generated module Send type: • • • • PRINTER = Correspondence as printed letter EMAIL TELEFAX RMAIL = R/3 internal mail REC_ADDR REC_STRING SEND_ADDR COPYFLAG REC_PERSNUMBER LAST_DOC LAST_DOC_ACT OCL_ACTIVE SENDTYPE_EXT NO_ACTIVATION (Internal use: ID of addressee from central address management) (Internal use: Address as string) (Internal use: Sender address as string) Indicator: Is a copy (Internal use: ID of person number from central address management) Last document in mass case (obsolete.2004 RDI • • • • • FORMKEY FORMKEY_RDI DELAYED_PRINT LANGU TEST_MODE DEBUG SENDTYPE RDI indicator for output via SAPscript <space> = Normal output (OTF) X = Output al RDI (via spool) X = Output as simple RDI (via spool) I = output as RDI-IDoc * = Specification in SAPscript form applies Name of application form (Used externally: Name of application form for RDI) Indicator: Creation of print request. should no longer be used) Output of spool request at the end of the print process Open/close control is active External send type Indicator: Suppress activation Print Workbench 620 68 .
Instead. Is obsolete and should no longer be used. such that. for example. An output request is only added if: § § § § The parameters TDDEST. The most important ITCPO print parameters for the Print Workbench print processes TDDEST TDNEWID TDIMMED TDFINAL TDTITLE TDSUFFIX1 TDSUFFIX2 Output device (printer) Force new output request Output output request Close output request Name of output request ID 1 ID 2 These print parameters are modified. the individual documents are inserted sequentially in one or a few output requests and output in a closing event (EFG_PRINT_CLOSE). in particular for mass printing. TDSUFFIX2 agree The output request to be added has not been output or closed The parameter TDNEWID is not set The user creating the output request is the same If one of the conditions listed above is not fulfilled.SAP Online Help 16. TDTITLE. If the parameter LAST_DOC_ACT (Output after Last Document) is set.01. there is only one output request per run or per defined subunit of run. Whether an existing output request is added or a new request opened depends on the different parameters. this prevents output requests that arise during a run being closed or printed (TDIMMED = TDFINAL = <space>).2004 XSF XSF indicator for output via Smart Forms: • • • • <space> = Normal output (OTF) X = Output in XSF format D = Output in XDF format * = Specification in Smart Form applies GET_XSF NO_OPEN_FORM NO_CLOSE_FORM Indicator: Return XSF/XDF data to calling application Is obsolete and should no longer be used. Print Workbench 620 69 . the system creates a new output request. TDSUFFIX1.
printer Choose between immediate print or creation of a print request Apart from the printer.01.SAP Online Help 16.2004 Print Parameter Dialog (EFG_GET_PRINT_PARAMETERS) Definition The module EFG_GET_PRINT_PARAMETERS is a dialog that can be configured by the application. It enables you to enter the user-relevant print parameters for the Print Workbench and for SAPscript/Smart Forms. all print parameters are optional. The module has the following parameters: Import parameters X_PRINTPARAMS X_ARCHIVE_BOR_OBJECT X_ARCHIVE_ARC_OBJECT X_ARCHIVE_OBJECT_ID X_NO_DELAYED_PRINT X_NO_FORMKEY X_NO_ARCHIVE X_CHECK_ARCHIVE X_FORCE_SAPSCRIPT EPRINTPARAMS SAEANWDID SAEOBJART SAEOBJID (Indicator) (Indicator) (Indicator) (Indicator) (Indicator) Input structure of print parameters BOR object type for archiving (optional) Document type (archive) (optional) ID of BOR object (optional) No option for print requests visible (optional. default ‘X’) No form input (optional) No archiving field (optional) Check archiving parameters (optional) Force SAPscript print parameters dialog box (optional) No print view possible (optional) Only show printer as input field (optional) X_NO_PREVIEW X_ONLY_PRINTER (Indicator) (Indicator) Print Workbench 620 70 . for example. Structure You can set the following print parameters: • • • • • • • Form (form class required) Output format SAPscript Output format Smart Form Indicator Output after Last Document Indicator Deactivate Open/Close Control All print parameters from SAPscript (ITCPO).
If errors occur. SAP recommends that you initialize and complete the print process both before and after the operational calls of the modules EFG_PRINT or EFG_PRINT_EXPANDED.01. the incorrect application forms are reported to the calling application as not capable of being activated.SAP Online Help 16.2004 X_NO_LAST_DOC X_NO_DIALOG X_ONLY_SENDTYPE_PRINTER X_NO_OCL_ACTIVE (Indicator) (Indicator) (Indicator) (Indicator) Output after last document (optional) Suppress dialog (only provide user defaults) (optional) Only offer send type Print (optional) Suppress open/close optimization active option (optional. Features The module EFG_PRINT_INIT has the following structure: Import parameters X_ITCPO X_TAB_FORMKEY X_FORMKEY X_FORMCLASS X_TAB_FORMCLASS Export parameters Y_TAB_ERRORFORMS EFG_TAB_ERRORFORM Table with incorrect application forms ITCPO EFG_TAB_FORMKEY FORMKEY FORMCLASS EFG_TAB_FORMCLASS Print Parameters Table of application forms (optional) Application form (optional) Form class (optional) Table with form classes (optional) Print Workbench 620 71 . The module EFG_PRINT_CLOSE postprocesses the output requests that have expired during the print process (for example. default ‘X’) Export parameters Y_PRINTPARAMS Y_ARCHIVE_INDEX Y_ARCHIVE_PARAMS EPRINTPARAMS TOA_DARA ARC_PARAMS Print Workbench result structure Archive information (1) Archive information (2) Initializing and Closing Print Transactions Use In mass printing. The module EFG_PRINT_INIT initializes the print process and makes sure that the application form used and transferred are activated if necessary. outputs them) and initializes the internal data buffer in the Print Workbench.
. SAP recommends that you activate this function. Features If the calling application has set the indicator OCL_ACTIVE in the print parameter structure when calling the print modules EFG_PRINT or EFG_PRINT_EXPANDED. since the change to the control logic can lead to undesired side effects under some circumstances. the output request used is not noted and for the subsequent OPEN_FORM. the Print Workbench provides you with a separate field in the print parameter dialog Print Workbench 620 72 . the Print Workbench executes the open/close optimization internally..SAP Online Help The module EFG_PRINT_INIT has the following structure: Import parameters X_FLG_OUTPUT X_FLG_FINALIZE X_FLG_CLEAR_SPOOLIDS Export parameters Y_TAB_SPOOLIDS TSFSPOOLID (Indicator) (Indicator) (Indicator) 16. the calls of OPEN/CLOSE_FORM can be suppressed. However. <Texte> END_FORM CLOSE_FORM If you work with the same print parameters and want to output the individual documents in the same output request. In the case of SAPscript. this takes place as follows: OPEN_FORM START_FORM . Due to the considerable improvement in performance described above. The performance benefit depends is between 10% and 30% depending on the number of output requests in the system. you do not need to call the OPEN/CLOSE_FORM modules. In individual printing.. creating a document means calling the complete SAPscript and Smart Form modules. the system has to determine from all of the existing output requests on the database. The Print Workbench is set up so that if the calling application so requires. The calls have such a negative affect on performance that for each CLOSE_FORM.01.2004 Triggers output of spool requests Close output requests Delete spool IDs from main memory Table of expired output requests in main memory Open/Close Optimization Use One of the main requirements of the Print Workbench and the print processes defined by the applications is performance. you must be able to parameterize the function. To do this.
such as optimizing postage or controlling print streams. the Print Workbench is a standardized infrastructure for processes that take place in a print event triggered by an application and can be configured accordingly. From this point of view. and can be processed by special software according to the local requirements. The application has to make it visible and make a default entry. since the R/3 System doe not have a control for external print logistics. the data is transferred from the R/3 System via the RDI interface in SAPscript or via XSF or XDF in Smart Forms. Print Processes and Output Formats created Generated Print Program Form type = Smart Forms Form type = SAPscript XSF/RDI: • Control data • sort data • Variables. Print Processes and Print Scenarios Purpose The Print Workbench is not a tool for processing forms.01. outside of the R/3 System forms and other data is multiplied or the different correspondence types are sorted and mixed. Print Workbench 620 73 . In many cases. symbol names. The application data can be prepared in a form in the R/3 System using the Print Workbench functions either with SAPscript or Smart Forms. or can be processed further externally. It regulates and standardizes the processes for determining the application data in the tool selected by the user for processing forms. windows • Certifiable R/3 Standard Application form Form type: Smart Form or SAPscript Smart Forms form SAPscript form XSF Parameter XSF/XDF (File) RDI Parameter RDI (File/IDOC) Output formats OTF (R/3 Spool) External Further processing Output Management System (OMS) • Printing large quantities • Postprocessing (use of line codes OMR) • Postage determination/use of franking machine • Information about reducing postage • Integration of document management and archiving systems • Editors for creating layout External Further processing SAP recommends external processing via an output management system where large volumes of data are concerned. With external further processing.2004 EFG_GET_PRINT_PARAMETERS. and values • Texts Pages.SAP Online Help 16. Process Flow From the view of the application. the type of use of the data is neither known nor relevant.
so that communication with the SAP ArchiveLink takes place exclusively via this interface. Features If you use SAPscript. you can use the following formats for external further processing: • • • • • ‘X’ = RDI (spool. Integration The data interfaces RDI and XSF/XDF are integrated components of SAPscript and Smart Forms and are accessed from the Print Workbench via corresponding runtime parameters. Documents are archived in an external optical archive system and connected to the R/3 system through SAP ArchiveLink. the Print Workbench uses the standard interface of SAPscript or Smart Forms. Prerequisites To process data externally. You can define logical output devices in the spool administration and define additional instructions. such as target directories or processing commands for the file. you can use the following formats: The supplement Spool defines that the data output is controlled by R/3 spooling and the logical output devices. certifiable) If you use Smart Forms. these forward the files that result to an external address.SAP Online Help 16. SAP ArchiveLink contains all the settings that classify a document and make it accessible for an application. certifiable) ‘S’ = Simple RDI (spool.01. you frequently have to archive a copy of the document. It is processed outside of the system using external software. For archiving. the data is not actually processed within the R/3 System. Print Workbench 620 74 .2004 External Further Processing of R/3 Data Use In mass processes. Activities To select one of the data formats supported. certifiable) ‘D’ = XDF (spool. you have to configure logical output devices in the central R/3 printer management (except in RDI IDoc mode). specify the relevant field (one for each SAPscript and Smart Form) for the output format in the print options of the Print Workbench. Archiving/Archive Connection with ArchiveLink Use If a document is sent. not certifiable) ‘I’ = RDI IDoc (not certifiable) ‘X’ = XSF (spool.
via RFC or BAPI. Prerequisites SAP ArchiveLink must contain all the required settings.01. links between document types. Archiving during form output in R/3 System Print Workbench 620 75 . The formatted document is sent via SAP ArchiveLink to an external archive and archived there.SAP Online Help 16. and are generally defined in the attributes. This link entry creates the logical link between a business R/3 object (such as an invoice document or a contract account) and the technical object in the archive. the archive generates a 40 character ID and in the R/3 System creates a link entry. and BOR object types and archives. During the print process.2004 Integration SAP ArchiveLink is called directly from SAPscript or Smart Forms during the print process provided you have made the required system settings for SAP ArchiveLink (document types. The document types used usually correspond to form classes of the Print Workbench. PDF) and the following data for the logical link: • • • • • Client BOR object type BOR object ID Archive system ID Document type If archiving is completed. archive connection). optical archiving of documents during printing. links. with the data received. the R/3 System sends an archiving command to the archive system containing both the document to be archived in a particular format (for example. Features The following different scenarios exist: Preparation in R/3 System with no external processing of data SAPscript and Smart Forms both support parallel (asynchronous). such as document types.
you can use the variable c-archive_index (DDIC-structure TOA_DARA) in the application forms. Activities Activate the archiving by setting the archiving parameter Print and Archive (3) or Only Archive (2) in the dialog box Print Parameters. You can use the interface to SAPconnect [Extern] provided by SAPscript to use the send types TELEFAX. and one of the data formats for external further processing is used. The prerequisite for correct display of a document from the archive is the complete installation of the component SAP ArchiveLink in the SAP GUI of the relevant presentation server.01. If you use this variable as symbol.2004 R/3 Smart Forms SAPscript Archive Link Formatted document. and Print Workbench 620 76 . for example. To do this. Sending as e-mail or Telefax via SAPconnect Use You can send documents using various different send types. using the button Archived Documents in the respective application. The external system must provide the archive with the required parameters so that the archive can create the link entry. you can add this to the RDI flow in a SAPscript text. you can access archived documents. EMAIL. for example. Following a successful report form the archive.SAP Online Help 16. Since the RDI flow does not contain any archive information. PDF BOR object Archive BOR ID Document type Archive ID ASYNCHRONOUS BOR object BOR ID Document type Archive ID + Archive document ID Formatting by external system (RDI) If the document is not prepared in the R/3 System. in this case you have to transfer the archive parameters to the RDI flow explicitly. This means that the external system must execute the functions described above. the document from the R/3 System is not archived and the external system must also control the archiving as well as the preparation of the document. and of a corresponding viewer (such as Acrobat Reader for PDF documents).
e-mail. • • • Features Aside from the standard send type PRINTER. Because SAPscript also enables you to use the raw data interface to format documents in external systems. SAPconnect is a standard application in the R/3 system and is included automatically. or internal r-mail. the document formatted by SAPscript is transferred to SAPconnect along with information. a document can also be sent via SAPconnect as a fax. needed for sending it. which route a document sent to SAPconnect should take. or r-mail. These define. Print Workbench 620 77 . Maintain the address data in the master data of the business partner for the communication types. EMAIL for Internet e-mail (SMTP). there was no sending information for sending as fax. RMAIL) c-comm_type :SAPconnect communication type (FAX. Prerequisites To ensure that the different send types function correctly. EMAIL.SAP Online Help 16. SAPconnect places the document in a send queue which is released for processing by an administrator or a program that runs periodically. Maintain the user data for each communication type in the system. OFF) c-rec_address: recipient address as character string (fax number. e-mail. The document created is placed in the SAPconnect send queue and is transferred later to an external fax or e-mail server to be sent. For this purpose. If you choose a send type other than PRINTER. INT. such as fax number and e-mail address. Prior to SAP Release 4. To do this choose Tools → Administration → Management → Transaction Method → Communication → SAPconnect → Goto → Customizing → Communication Types. e-mail address) c-send_address: sender address as character string (fax number. Integration All send types require a document created by SAPscript. In this case.6B. you must differentiate between the following scenarios: Formatting by SAPscript (no RDI) Processing takes place automatically according to the standard procedure in SAPconnect. Create SCOT communication nodes in the transaction Communication Types. TELEFAX stands for faxes. an external system must also take over sending the document. these fields must appear as symbols in SAPscript texts. To do this choose Tools → Administration → Management → Transaction Method → Office → General Office Settings. Set the communication methods to SAPconnect.2004 RMAIL. e-mail address) To appear in the RDI data flow. you have to make the following system settings: • • Activate the communication types. RML. an RDI flow is created instead of starting SAPconnect.01. the Print Workbench provides the following fields in the c global variables in the application forms: • • • • c-sendtype : print workbench send type (PRINTER. Formatting by external system (RDI) If the RDI indicator is set in the printing parameters. TELEFAX. and RMAIL for documents sent within R/3. The data contained in the RDI flow is used for this purpose.
The settings for a send control line overwrite by field. *. this setting is evaluated and used. Prerequisites If you use archive mode 2 or 3. TELEFAX. Integration You have processed the different send controls in Customizing for the Print Workbench. During the print process. this means that if a setting has been set for a field. The application links a transaction with a send control logically in Customizing or in the master data. this address is defaulted in the parameters. Dispatch Control Use You can use this function to send an application form several times and in any of several different ways. I. such as a letter. specify each address according to send type. Features Dispatch control consists of control lines that each contain the following fields: • • • • • • • Send type (PRINTER. the standard setting for the print transaction is used. D) Number of copies (number) Archive mode (1. In the dialog box that follows. If the send type is not PRINTER. RMAIL) Output format SAPscript (<BLANK>. the send control is transferred to the Print Workbench via module EFG_PRINT_EXPANDED and evaluated. In the send control you only make the technical settings for sending the documents. Print Workbench 620 78 . X) Output device The control lines taken together constitute send control. If the address type has been maintained in the master record of the business partner associated with a transaction. X. EMAIL. SAPconnect requires the correct setting. Specify the send type in the Send type field. fax or e-mail.2004 Activities You can define the send type in the dialog box Print Parameters.01.SAP Online Help 16. Activities The send control is entered in the applications.3) Copy indicator (<BLANK>. Each line in the send control triggers a new preparation and processing of the document. *. X.2. For empty fields. S) Output format Smart Forms (<BLANK>. you must have configured the connected archive via SAP ArchiveLink.
Features If the application supports the creation of print requests for correspondence. Using Print Action Records Use A print action record is a variable text or data supplement that is determined at the time of print processing and that can be integrated in form processing. Most applications that use the Print Workbench use the correspondence tool before the print modules of the Print Workbench are called. Integration The correspondence tool is not integrated in the Print Workbench. The correspondence tool is optimized for the standard sending of mass correspondence and provides the Print Workbench with a standard print process with numerous application and customer exits.01. A print action record is used if you also Print Workbench 620 79 . to carry out collective and parallel printing and to standardize the print process. the system creates a request for the correspondence type concerned in the form of a correspondence container. For each correspondence container the Print Workbench is called up once. Prerequisites You can only use the correspondence tool if the application/component has implemented a corresponding connection to the correspondence tool. it is only used by the Print Workbench. These correspondence containers can then be processed and marked as printed in special print runs.2004 Using the Print Workbench with the Correspondence Tool Use If you do not want to print correspondence immediately. see Correspondence [Extern]. as parallel background job).SAP Online Help 16. This function is provided by the correspondence tool outside of the Print Workbench. the Print Workbench offers the options Print Immediately and the option of creating print requests. you can create requests for print transactions to carry out the print in a central run (for example. The correspondence tool provides the application and customer with various events for determining the following objects: • • • • • • • Sender Recipient Language Dispatch control Application forms Address type Archiving ID For more information about correspondence. When you create print requests.
the print action record must be saved in a variable and then output as symbol. choose Print Workbench → Print Action Records → Create in the menu. or saved in a variable and then output as symbol. or you can integrate the search for print action records via the programming interface in the user exits of an application form. you have to create a report using the example of the report SAPRISU_PRINTACTION_GENERATE delivered by SAP. This is usually shown by a corresponding form level in the form class.01. If you want to create several print action records simultaneously (mass processing). Print Action Records (Technical Background) Features Print action records are defined in the application table EPRINTACT and have the following key fields: • • • FORMCLASS: OBJ_TYPE: OBJ_KEY: Form class BOR object type BOR object key During the print transaction.SAP Online Help 16. The form level must also be integrated and active in the application form in which it is used. Features A print action record consists of the following indicators and fields: • • • • • • • BOR object type (key field) BOR object key (key field) Form class From date To date Maximum number of processing times Frequency The search for related print action records must be integrated in the form class. In a print action record. or if you want to send additional information to the recipient in the form of a flyer. If a print action record is determined during the print transaction. user-defined text in a form. if you use SAPscript. the system searches for print action records with these keys. Print action records are integrated in an application form either via a form level that corresponds to the BOR object of the print action record. It also evaluates the following fields to process the print action records: • • • • TRIG_FROM: TRIG_TO: TRIG_COUNT: MODULO: From date for processing To date for processing Total number for processing Frequency (Example: 3 = every third time) Print Workbench 620 80 . To create individual print action records. you can define additional parameters. such as the validity period or the maximum number of processing steps.2004 want to print out a variable. In the case of Smart Forms. the content can be output immediately in the MAIN window.
In the same way as function module ISU_S_PRINTACT_SEARCH_UPDATE. The following fields concern the five standard texts: • • • TDNAME1 to TDNAME5 TDID1 to TDID5 TDSPRAS1 to TDSPRAS5 For the ten flyer IDs. This function module is called up using the above keys and processes all valid print action records for these keys. the texts which belong to them and raises the number of times they have been processed by 1. You can control the function of the module explicitly using its import parameters: X_PRINT Texts are printed (only recommended for SAPscript).2004 A print action record contains definitions such as which text is to be printed or which flyer ID is to be used. the function module ISU_S_PRINTACT_SEARCH_UPDATE can find and process a print action record. Function Modules for Programming Use • ISU_S_PRINTACT_SEARCH_UPDATE This module determines appropriate print action records for the keys described under DDIC. For this purpose. It also raises the number of times that print action record has been processed by 1. the underlying transactions in transaction SO10.SAP Online Help • • TRIG_DONE: LAST_DATE: Number of completed operations Date of last processing 16. The module returns a table with these print action records. it prints. The texts or flyers to be selected are defined in the Customizing table EPRINTACTF (Define Flyer/Standard Texts for Print Action Records). You maintain the entries in this table in the Implementation Guide. you can also control the explicit function externally. X_UPDATE Print action records are updated ISU_S_PRINTACTION_TEXT_PROVIDE This function module provides the text for a print action record. fields have been provided in each case for five standard texts and ten flyer IDs. the fields FLYERID1 to FLYERID10 are decisive. Print Workbench 620 81 . You can use this text for any further processing.01. During printing. Customizing Use You maintain the system settings for the print action records in the IMG under Print Workbench → Print Action Records. • ISU_S_PRINTACT_PRINT_UPDATE This module determines the relevant text for a print action record and prints it. In the EPRINTACTF table you can either define an ID for a flyer or the key fields for a SAPscript standard text. as a standard. If the module finds these print action records.
Choose Define Links between Object Types and Form Classes and define the supported combinations of form class and BOR object types for the print action records. If you want to incorporate print action records in an application form yourself. this Customizing table already contains the combinations found in the form classes delivered. it is also not displayed by the above-mentioned transactions and when you save the print action record. you have to make an entry for the combination BOR object/ form class here.. create an individual text. print action records can be created in different ways. Integration Print action records are created so that they can be determined and evaluated when application forms are printed. Features Several items of information can be stored in a print action record. Choose Define Flyer/Standard Texts for Print Action Records and maintain the standard texts and flyers that can be selected for the print action records. When delivered. Therefore. The standard texts that you define here must be maintained using transaction SO10 (standard text maintenance). If you need additional combinations. You can create print action records as follows: 1. You can also set texts or flyer indicators for further processing in print action records. With the Create Print Action Record function in an application 3.SAP Online Help 16. Activities Choose one of the options from the list above and specify the properties of the print action record. 2. this can lead to errors in maintaining the print action records. These text or flyer indicators are defined in Customizing for print action records. A print action record is created if a letter is to contain some additional item of information.2004 Activities . the correct search routines must already be in place in the application forms. you can enter these here. If required. If texts or flyers that you set in the creation reports in the print action records are not defined here. Print Workbench 620 82 . By calling the Create method for BOR object type BUS4402 (print action record). Individual Creation of Print Action Records Use The creation of a print action record is usually determined by a business transaction. The following criteria determine the validity of a print action record: • • • From date To date Frequency You can also assign a freely definable text to a print action record. you can only create an individual text if you have deleted the print action record. In order for the system to determine print action records. it is deleted from the record completely..01. However. If you use a text that has not been entered in this table in a print action record. In the menu under Print Workbench → Create Print Action Records.
If you delete directly. you should carry out a reorganization at regular intervals. This takes place with a report maintained by the user and designated for a specific purpose. Enter the parameters (selection restriction. you determine why the print action records are created and the entities to which they belong. The prerequisite for using the report is that the search function for print action records has been implemented in the application form. Print Workbench 620 83 . deletion. You can then use the print action records for selection.2004 Mass Creation of Print Action Records Use If an additional variable text is to appear on multiple forms. Activities Choose Print Workbench → Print Action Records → Selection List. you can use the indicator Dialog Indicator to control whether there is a security prompt before deletion. Features Using this transaction you can select print action records and either output them in a list or delete them immediately. and dialog indicator) and choose Program → Execute. Features By adjusting the report. Reorganization Use To keep the number of print action records to a minimum. Activities Once you have copied and adjusted the report.SAP Online Help 16.01. Prerequisites Copy the sample report SAPRISU_PRINTACTION_GENERATE and adjust it to meet your requirements. a print action record must be created for each form or each form level on which text is to be printed. run it.
set global parameter C-PA_PRINT to <blank> in the exit before loop of the form level. the form levels can be left in the hierarchy. In addition to mass processing. X_FORMCLASS with the current form class. 2. you can also create single print action records that have a generic Print Workbench 620 84 . from there. In table EPRINTACTT (transaction SM30). you have to perform the following steps: . call function module ISU_S_PRINTACT_SEARCH_UPDATE. maintain an entry with the following keys: AREA = ‘Z‘.. (for example. Decide for which form level of the form class hierarchy you want to find print action records. 5. If you do not want the text to be printed automatically. The parameters X_PRINT and X_UPDATE determine whether a print takes place or whether the print action records are updated.01. Create an EXIT DURING LOOP for the form level in question and.2004 Integrating Print Action Records in Application Forms Use Use a print action record if you want to print a variable text on all forms. Specify parameters X_OBJ_TYPE with the BOR object mentioned above. evaluate the table of the print action records received. Features If the print action records are integrated in an application form. The position corresponds to the form level. It is important that you search for an entity that has a corresponding object type in BOR. If you want to prevent the texts in a print action record from being printed automatically. LFDNR = <document number>. in which the print action records exist as a level in the application form. Variable means that the text changes over time (for example. printing begins automatically. OBJ_TYPE = <BOR object>. WA_CONTR_ACCTVKONT for a contract account) for the call. the printing of the related texts can be transferred immediately or you can decide how and which part of the print action records is to be printed. Application forms with print action records already included If the print action records have been implemented in the form of form levels in the form class. Integration Print action records are either integrated into the form class belonging to an application form with form levels or must be implemented using user exits. Specify the parameters above (form class. and FORMCLASS = <form class> 3. and X_OBJ_KEY with the entity key from the current form. BOR object. In mass processing you have to create the print action records with a report based on report SAPRISU_PRINTACTION_GENERATE. information or a note that is temporarily valid). In this case you have to print the text yourself. Determine the position of the call of the print action records in the application form.. 4. object key) in the appropriate position in the report.SAP Online Help 16. 1. The texts behind the print action records are printed automatically. Usually you should set both indicators. In the simplest variant. In the first case you have to leave the level in question in the hierarchy. Application forms without print action records To integrate print action records in an application form that have not been implemented in the form of a level in the form class.
manually create a print action record in transaction EPA1 and define a dummy object for OBJ_KEY.SAP Online Help 16. To do this. Print Workbench 620 85 .2004 effect on all combinations of form class and BOR object.01. Then enter this dummy value in parameter X_OBJ_KEY when you call the module ISU_S_PRINTACT_SEARCH_UPDATE in the above-mentioned exit.
This action might not be possible to undo. Are you sure you want to continue?
We've moved you to where you read on your other device.
Get the full title to continue reading from where you left off, or restart the preview.