SAP ABAP IMG Activity /IPRO/DETERMINE_BR (Create By-Reference Text from Full-Text)
Hierarchy
SAP_BS_FND (Software Component) SAP Business Suite Foundation
   CA-GTF-DOB (Application Component) Document Builder
     /IPRO/BASIS (Package) Tables, Structures, general Infrastruktur
IMG Activity
ID /IPRO/DETERMINE_BR Create By-Reference Text from Full-Text  
Transaction Code /IPRO/67000046   (empty) 
Created on 20041130    
Customizing Attributes /IPRO/DETERMINE_BR   Create By-Reference Text from Full-Text 
Customizing Activity /IPRO/DETERMINE_BR   Create By-Reference Text from Full-Text 
Document
Document Class SIMG   Hypertext: Object Class - Class to which a document belongs.
Document Name /IPRO/DETERMINE_BR    

Use

Implement this Business Add-In to build the by-reference text for an element from the full-text of the element.

The Business Add-In consists of the method described below. This mehtod can be used instead of the standard algorithm, which displays the by-reference text that has been configured in the Implementation Guide.

CREATE_BY_REF_TEXT

The following import parameters are provided:

IO_ELEMENT
Reference to the interface /IPRO/IF_DOCB_ELEMENT, which contains methods that allows you to retrieve all the attributes that belong to an element. The GET_FULL_TXT method of this interface returns a reference to the class /IPRO/CL_DOCB_TEXT containing methods for retrieving the title and the element's full-text.

The following return parameter is provided:

  • RO_BY_REF_TXT
    Reference to the class /IPRO/CL_DOCB_TEXT. This class is used to instantiate SAP Document Builder text objects (full-text, prescription and guidance). This class provides all the methods necessary to build the by-reference text object. Once you have retrieved the reference to the full-text object by means of the GET_FULL_TXT method of the /IPRO/IF_DOCB_ELEMENT interface, you can use the methods of the full-text object to get the data necessary to build the by-reference text object from the full-text object.

Recommendation

You can use the methods GET_TITLE, GET_RAWDATA and GET_HTMLSTRING of the full-text object reference and then use the values returned from these methods to build a by-reference text object.

Activities

After calling up the IMG activity, a dialog box appears, in which you can enter a name for the implementation.

If you have already made other implementations for this BAdI, another dialog box appears, in which the existing implementations are displayed. In this case, choose Create, and proceed as follows:

1. In the dialog box, enter a name for the BAdI implementation in the Implementation field, and choose Create.

The screen for creating BAdI implementations is now displayed.

2. Enter a short text for the implementation in the Short text for implementation field.

3. From the tab index, choose Interface.

The Name of implemented class field is already filled on the tab page, as a class name was automatically assigned to the implementation when you named it.

4. Save your entries, and assign the implementation to a development class.

5. Place the cursor on the method, and double-click to enter method processing.

6. Enter the coding for the implementation between the statements method <Interface name> ~ <Name of method> and endmethod.

7. Save and implement your coding. Return to the Edit Implementation screen.

8. Save the entries on the Edit Implementation screen.

Note: You can also create an implementation, and then activate it at a later time. In such a case, end the processing stage at this point.

9. Choose Activate.

The coding you stored in the methods will be run when the application program is executed.

Example

The by-reference text should be created from the full-text of the element so that you must not maintain the by-reference text in the Implementation Guide.

Additional Hints

For more information on using Business Add-Ins, see the SAP Library under Basis Components -> ABAP Workbench (BC-DWB) -> Changing the SAP Standard (BC) -> Business Add-Ins.

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 /IPRO/DETERMINE_BR 0 HLB0009110 Cross-Application Components 
Maintenance Objects
Maintenance object type E   Business Add-In - Definition 
History
Last changed by/on SAP  20050119 
SAP Release Created in 100