Hierarchy
SAP_ABA (Software Component) Cross-Application Component⤷
AP-MD-BF-TFW (Application Component) Templates⤷
BTFW (Package) Template Framework
IMG Activity
| ID | TFW_TEMPLATE | Template Framework Template Usages |
| Transaction Code | S_PAB_09000024 | (empty) |
| Created on | 20050225 | |
| Customizing Attributes | TFW_TEMPLATE | Template Framework Template Usages |
| Customizing Activity | TFW_TEMPLATE | Template Framework Template Usages |
Document
| Document Class | SIMG | Hypertext: Object Class - Class to which a document belongs. |
| Document Name | TFW_TEMPLATE |
Use
This Business Add-In (BAdI) is used in the component Template Framework (AP-MD-BF-TFW) and is used to determine which application objects use a template. This is the case:
- If you want to change a mini-template or delete a template in Customizing of the template framework.
- If the mini-template type of the mini-template being changed has the category reference.
- If the template type of the template being deleted has the template category only reference possible.
- If the changes affect the users of the mini-template or template. In the following situations the methods would not be called up:
- If the description of a template is changed
- If a template is added
The deletion of a template affects all the application objects that reference the template. As soon as an attempt is made to delete a template in the template framework Customizing, the application objects to which the template is assigned are determined, using the method WHERE_USED_TP. The system rejects a deletion, as long as such application objects still exist.
Changes made to a template do not affect the application objects that reference the template. This is the case because only mini-templates can be assigned to a template, and the instance data is accessed using these mini-templates.
Changes made to a mini-template in the template framework Customizing affect not only the application objects to which the mini-template is directly assigned, but also the application objects to which the mini-template is assigned via a template. Therefore, in this situation not only the method WHERE_USED_MINITP of the BAdI TFW_MINITP is called up, but also the method WHERE_USED_TP of the BAdI TFW_TEMPLATE. As it is possible that the application objects determined in this way are using other data (for example, their own data) rather than the mini-template data assigned via the template, the method NOT_USED_MINITP of the BAdIs TFW_MINITP is then also called. (For more information, see the documentation of the BAdI TFW_MINITP).
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
- 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:
- 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. - On this screen, enter a short description for your implementation in the Implementation Short Text field.
- 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.
- Save your entries and assign the Add-In to a package.
- To edit a method, double-click its name.
- Enter your implementation code between the
method <Interface Name>~<Name of Method>.andendmethod.statements. - 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: - 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, and the read method for which you implement the methods.
Example
See also
Methods
Business Attributes
| ASAP Roadmap ID | 257 | Create User Exits |
| Mandatory / Optional | 3 | Nonrequired 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_TEMPLATE | 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 |
