SAP ABAP IMG Activity BADI_INDEX_ORIGINALS (BAdI: Indexing of Document Originals in Enterprise Search)
Hierarchy
☛ BBPCRM (Software Component) BBPCRM
   ⤷ CA-DMS (Application Component) Document Management System
     ⤷ CV (Package) Application Development: R/3 Document Management
IMG Activity
ID BADI_INDEX_ORIGINALS BAdI: Indexing of Document Originals in Enterprise Search  
Transaction Code S_EBS_44000452   (empty) 
Created on 20110505    
Customizing Attributes BADI_INDEX_ORIGINALS   BAdI: Indexing of Document Originals in Enterprise Search 
Customizing Activity BADI_INDEX_ORIGINALS   BAdI: Indexing of Document Originals in Enterprise Search 
Document
Document Class SIMG   Hypertext: Object Class - Class to which a document belongs.
Document Name CV_ESH_INDEX_ORIGINALS    

Use

This Business Add-In (BAdI) is used in the PLM Document Management (PLM-DMS) component.

You can use this BAdI to filter/restrict the indexing of document originals in TREX. This BAdI is called when indexing starts for document object (DOCUM_INFO_REC) in enterprise search.

This BAdI definition uses the standard interface IF_EX_DIR_INDX_ORIGINALS.

You can implement the method INDEX_ORIGINALS and set follwoing exporting parameter.

  • EV_INDEX_ORIGINALS

    This flag determines whether originals need to be indexed or not. Activate this flag if all originals need to be indexed, else unset it.

  • ET_APPL_TYPE

    This is a range table and it supplies valid application types. So the indexing of original will be based on supplied application types.

  • ET_STORAGE_CATEGORY

    This is a range table and it supplies valid storage locations. So the indexing of original will be based on supplied storage locations.

Requirements

Standard settings

For more information about the standard settings (filters, single use, or multiple use), see the Enh. Spot Element Definitions tab in the BAdI Builder (transaction SE18).

This BAdI is not active in the standard system.

This BAdI is designed for single use.

This BAdI is filter-independent.

If there is no active implementation in the system then all originals get indexed by default in TREX via enterprise search indexing mechanism.

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.

For information about implementing BAdIs as part of the Enhancement Concept, see SAP Library for SAP NetWeaver under BAdIs - Embedding in the Enhancement Framework.

See also

Example BAdI implementation class is CL_EX_IM_ESH_INDEX_ORIGINALS.

Reference SAP Note: 1511926 (To filter indexing of originals based on MIME type)

Example

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 
Maintenance Objects
Maintenance object type E   Business Add-In - Definition 
History
Last changed by/on SAP  20110505 
SAP Release Created in 606