SAP ABAP IMG Activity OADFFCUST (Register Document Areas and Create Aggregated Document Areas)
Hierarchy
☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SRV-ARL (Application Component) ArchiveLink
     ⤷ SAOP (Package) ArchiveLink general
IMG Activity
ID OADFFCUST Register Document Areas and Create Aggregated Document Areas  
Transaction Code S_B6A_52000002   (empty) 
Created on 20011212    
Customizing Attributes OADFFCUST   Create Aggregated Document Areas 
Customizing Activity OADFFCUST   Create Aggregated Document Areas 
Document
Document Class SIMG   Hypertext: Object Class - Class to which a document belongs.
Document Name OADFFCUST    

Use

You can use this IMG activity to register document areas and create aggregated document areas.

A document area is a search area that determines in which system and application the search takes place, and which attributes are used for the search. Before you can use the Document Finder, at least one document area must be registered.

An aggregated document area is composed of several other document areas, and contains all the attributes of the document areas. Attributes that have the same semantics and the same data type are grouped together under one name in the aggregated document area. They are displayed in the search template of the Document Finder as one attribute with one name. This means that the search template for an aggregated document area is no more complicated than that for a simple document area.

Requirements

Before you can register a document area, a query class must exist. A query class is a class in the class library that determines the search strategy, that is, in which application the search is to take place, and which attributes are to be used for the search. You can either use SAP-supplied query classes, (see below), or your own. If you use your own query class, this must implement the interface ALINK_QUERY. For more information, choose the following in the SAP Library: SAP Web Application Server -> Basis Services -> ArchiveLink -> Finding and Displaying Stored Documents -> Document Finder Customizing.

Standard settings

Activities

Registering a document area:

  1. Position the cursor on Document area, and choose Create Document Area from the context menu.

    The "Defining a Document Area" dialog box is displayed.

  2. Enter the following:
    • Unique technical name
    • RFC destination of the system in which you want to search for documents.
      • Note: An RFC destination is only required if the query class is RFC-compatible (see below). If you are searching for documents in the local system, leave this field empty.
    • Document area short description. This is displayed in the Document Finder in the selection field for document areas.

      The "Change Document Area" dialog box is displayed.

  3. Enter the details for the document area:
    • Query class
      • Class that determines the search strategy. You can use the following query classes supplied by ArchiveLink:
      CL_ALINK_QUERY_DOCLIST
      CL_ALINK_QUERY_DOCLIST_RFC
      CL_ALINK_QUERY_PRILIST
      CL_ALINK_QUERY_KPR
      CL_ALINK_QUERY_DVS
      CL_ALINK_QUERY_DVS_RFC
      CL_ALINK_QUERY
      For a description of these query classes, choose the following in the SAP Library: SAP Web Application Server -> Basis Services -> ArchiveLink -> Finding and Displaying Stored Documents -> Document Finder Customizing. You can also implement your own query classes (see below).
    • Display class
      • Class that realizes hit list display for a query. If you use your own display class, this must implement the interface IF_ALINK_HITLIST. If the field is empty, a hierarchical list is displayed in the Document Finder as a standard setting.
    • Max. No. of Hits
      • Maximum hits in the Document Finder hit list. If you do not enter a value, the maximum number of hits is unrestricted. SAP recommends that you permit a maximum of 1000 hits. This is the default value.
    • Full text search active
      • Indicator for determining whether full text search is active. To activate or deactivate the full text search, use the Activate Full Text Search option in the context menu of the document area. If full text search is active, a field for entering key words is displayed in the Document Finder. Prerequisite: The query class supports full text search.

      The new document area is displayed in the list of document areas. Expanding the list displays the attributes. (The attributes are determined when the query class is implemented.)

Creating aggregated document areas:

  1. Position the cursor on Aggregated Document Area, and choose Create Aggregated Document Area from the context menu.

    The dialog box for "Defining an Aggregated Document Area" is displayed.

  2. Enter the required data and choose CONTINUE to confirm.

    The "Change Document Area" dialog box is displayed.

  3. Enter data as required (optional).
    • If you enter a query class, the system searches in this class, as well as in the query classes of the simple document area that you want to create.
    • If you enter a display class, this class is used for displaying the hit list. If the field is empty, a hierarchical tree structure is displayed.

      The dialog box "Query workbench request" is displayed.

  4. Enter a Workbench request.

    The aggregated document area is displayed in the list of aggregated document areas (right screen area).

  5. Position the cursor on the new aggregated document area and choose New Attribute from the context menu.

    The "Attribute Definition" dialog box is displayed.

  6. Enter a name and a description for the new attribute. Choose an informative description. This will be displayed as the attribute description in the Document Finder search template for the aggregated document area.

    The "Change Document Attribute" dialog box is displayed.

  7. Enter the required data:
    • Table reference and field reference
      • Pointer for a data element. If input help is used for the data element, the user can use the same input help in the Document Finder.
    • Position
      • Number that specifies at which position the attribute is displayed in the Document Finder search template.

      The new attribute is entered one hierarchy level below the new aggregated document area.

  8. In the left screen area, expand the document areas that are to be used for the new aggregated document area.

    The attributes of the simple document areas are displayed.

  9. Use Drag&Drop to move the attributes from the simple document area in the left screen area, to the newly created attribute in the aggregated document area in the right screen area. These attributes should have the same semantic content and the same data type. The technical names do not have to be identical.

    The attributes are inserted one hierarchy level below the new attribute of the aggregated document area. The document areas, from which the elements inserted by Drag&Drop originate, are also displayed.

    You can create any number of attributes for the new aggregated document area. You then assign attributes from the simple document areas to the new aggregated area.

Result: A user can search in the aggregated document area in the Document Finder. The search template only contains the attributes that you have created for the aggregated document area. The values entered by a user for one attribute of the aggregated document area also apply to any other attributes assigned to this attribute.

Example

Business Attributes
ASAP Roadmap ID 899   not to be assigned 
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 OADFFCUST 0 HLB0009818 ArchiveLink 
Maintenance Objects
Maintenance object type C   Customizing Object 
Assigned objects
Customizing Object Object Type Transaction Code Sub-object Do not Summarize Skip Subset Dialog Box Description for multiple selections
OADFFCUST T - Individual transaction object OADFFCUST  
History
Last changed by/on SAP  20011212 
SAP Release Created in 630