SAP ABAP IMG Activity TFW_READ (Read Access via the Template Framework)
Hierarchy
☛ SAP_ABA (Software Component) Cross-Application Component
   ⤷ AP-MD-BF-TFW (Application Component) Templates
     ⤷ BTFW (Package) Template Framework
IMG Activity
ID TFW_READ Read Access via the Template Framework  
Transaction Code S_PAB_09000022   (empty) 
Created on 20050225    
Customizing Attributes TFW_READ   Read Access via the Template Framework 
Customizing Activity TFW_READ   Read Access via the Template Framework 
Document
Document Class SIMG   Hypertext: Object Class - Class to which a document belongs.
Document Name TFW_READ    

Use

This Business Add-In (BAdI) is used in the component Template Framework (AP-MD-BF-TFW). The currently valid data of the application object can be determined using the method READ of the BAdI TFW_READ. Since the data to be determined can differ according to the mini-template type and read method, they make up the filter criterion, together with the application object.

The BAdIs TFW_READ, TFW_DISTRIBUTE, TFW_MINITP, TFW_MINITP_DEL_CHECK, TFW_SHOW_WHERE_USED, TFW_TEMPLATE, TFW_TEMPLATE_UPDATE and TFW_TP01_DEL_CHECK are available to the application objects of the template framework that facilitate the usage of template and/or mini-templates.

The BAdIs TFW_MINITP, TFW_MINITP_DEL_CHECK, TFW_TEMPLATE, TFW_TEMPLATE_UPDATE, TFW_TP01_DEL_CHECK and TFW_SHOW_WHERE_USED should be implemented because they are used during the maintenance of templates and mini-templates in the template framework.

The BAdIs TFW_READ and TFW_DISTRIBUTE do not necessarily have to be implemented. Their methods are not called from out of the template framework. However they are useful if you need to determine the currently valid data (BAdI TFW_READ) for an application object to which a template or mini-template is assigned; or if you want to distribute the changes that result from changes to templates or mini-templates on the application objects, to connected systems (BAdI TFW_DISTRIBUTE).

Requirements

Standard settings

The BAdI is filter-dependent. The filter criterion is made up of:

  • Template framework application object
  • Mini-template type
  • Read method

Activities

After you call the IMG activity, the system displays a dialog box where you enter a name for the implementation.

If implementations of this Business Add-In have already been created, the system displays them in a dialog box. You then choose one of them by choosing Create, and continue as follows:

  1. In the dialog box, enter a name for the implementation of the Add-In and choose Create.
    The system displays the initial screen for creating Business Add-In implementations.
  2. On this screen, enter a short description for your implementation in the Implementation Short Text field.
  3. If you choose the Interface tab, you will notice that the system has populated the Name of the Implementing Class field automatically, by assigning a class name based on the name of your implementation.
  4. Save your entries and assign the Add-In to a package.
  5. To edit a method, double-click its name.
  6. Enter your implementation code between the method <Interface Name>~<Name of Method>. and endmethod. statements.
  7. Save and activate your code. Navigate back to the Change Implementation screen.
    Note: You can also create an implementation for an Add-In and not activate it until later. If you want to do this, do not perform the following step:
  8. Choose Activate.
    When the application program is executed, the code you created is run through.

Because the BAdI is filter-dependent, you must enter a filter value for your implementation. Choose as your filter value the application object, the mini-template type and the read method for which you implement the methods.

Example

See also

Methods

Read Data by Mini-Template Type and Read Method

Business Attributes
ASAP Roadmap ID 257   Create User Exits 
Mandatory / Optional 2   Optional activity 
Critical / Non-Critical 2   Non-critical 
Country-Dependency A   Valid for all countries 
Assigned Application Components
Documentation Object Class Documentation Object Name Current line number Application Component Application Component Name
SIMG TFW_READ 0 PAB0000027 Templates 
Maintenance Objects
Maintenance object type E   Business Add-In - Definition 
History
Last changed by/on SAP  20050225 
SAP Release Created in 700