Document Finder Customizing (OA_FIND)

T-codes:

OADOCSP = Register document areas

OADFFCUST = Create aggregated document areas

Register Document Areas

Before you can use the Document Finder, you need to register at least one document area in the
Document Finder. A search in the Document Finder always takes place within one document area. In
Customizing, you also have the option to group together more than one document area to form an
aggregated document area. Using this method, users can indirectly search in more than one document
area at the same time.

You can register document areas and create aggregated document areas in Customizing. In the IMG,
choose SAP Web Application Server → Basis Services → SAP ArchiveLink → Document Finder
Customizing → Register Document Areas and Create Aggregated Document Areas. For more
information, see the online help in the IMG. The following provides some important background
information.

To register a document area, you need to enter the following:

• Technical Name

A character string of your choice. Note: A document area in the Document Finder is a
different entity to a document area in terms of the Knowledge Provider.

• RFC destination (optional)

Determines the SAP system in which the search takes place. Note: An RFC destination
is only useful if you enter a query class that is RFC-compatible (see below).

• Description

A character string of your choice. This text should be as informative as possible,

because it will be displayed in the document area selection list in the Document Finder.

• Display class

Class of the SAP class library that determines the layout of the hit list, and the activities
that are available in the context menu for each hit.

Page | - 1 -
 SAP supplies the standard display class CL_ALINK_HITLIST_TREE. This displays the
hit list as a hierarchical tree structure. This is the default setting and is therefore used if
you do not make an entry. If you implement your own display class, this must implement
the interfaces IF_ALINK_HITLIST and IF_ALINK_HITLIST_CALLBACK.

• Query class

A class of the SAP class library that determines the index structure of the documents,
and hence which attributes are used for the search.

SAP already delivers some query classes (see below). You can also implement your
own query classes. This is recommended if you want to search using content-related
attributes as well as technical attributes. For indexing documents, you should consider
a solution that uses its own database tables. Every query class must implement the
interface IF_ALINK_QUERY. For implementing query classes, you are recommended
to use the template class CL_ALINK_QUERY_APP_TMPL as a template.

The query classes supplied by SAP are documented below.

Query classes for searching for ArchiveLink documents using

technical attributes
• CL_ALINK_QUERY_DOCLIST (document search in the local system)
• CL_ALINK_QUERY_DOCLIST_RFC (document search in remote systems)

Additional Customizing steps are required for displaying documents and

business objects from remote systems. For more information, see Additional
Steps for Displaying Documents from Remote Systems.

• CL_ALINK_QUERY_DOCLIST (print list search in the local system)

Document areas of these query classes (called technical document areas below) provide a technical
view of all documents administrated by ArchiveLink. They possess the attributes that ArchiveLink enters
and indexes in the link entry. The search corresponds to the ArchiveLink search that is called using
administration. You can create technical document classes for both documents and print lists.

Query class for searching for DMS documents

• CL_ALINK_QUERY_DVS (for document areas in the local system)
• CL_ALINK_QUERY_DVS_RFC (for document areas in remote systems)

Additional Customizing steps are required for displaying documents and

business objects from remote systems. For more information, see Additional
Steps for Displaying Documents from Remote Systems.

Document areas of these query classes (called DMS document areas below) include all documents
administrated within the Document Management System (DMS), including ArchiveLink print lists.

The documents in a DMS document area have the attributes that have been entered and indexed as
document attributes in the DMS. For more information on the DMS, see the SAP Library under Cross-
Application Components → Document Management.

Page | - 2 -
Query class for searching in external systems
• CL_ALINK_QUERY_2

Document areas of these query classes (called external document areas below) include all documents
in any external system, for example, a storage system.

The documents in an external document area have the attributes that have been entered and indexed
as document attributes in the external system. The query class requests the attributes of the external
system at runtime. Check with the storage system supplier whether these functions are supported.

Screenshots

Page | - 3 -
Create Aggregated Document Areas
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:

o Unique technical name

o 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.

o 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:

o Query class

Class that determines the search strategy. You can use the following query classes
supplied by ArchiveLink:
CL_ALINK_QUERY_DOCLIST

Page | - 4 -
 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).

o 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.

o 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.

o 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:

4. 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.
5. Enter the required data and choose CONTINUE to confirm.
The "Change Document Area" dialog box is displayed.
6. Enter data as required (optional).

o 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.

o 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.

7. Enter a Workbench request.
The aggregated document area is displayed in the list of aggregated document areas (right screen
area).
8. Position the cursor on the new aggregated document area and choose New Attribute from the
context menu.
The "Attribute Definition" dialog box is displayed.
9. 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.
10. Enter the required data:

Page | - 5 -
 o 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.

o 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.
11. 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.
12. 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.

Target: 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

Screenshots

Create aggregated document area:

Page | - 6 -
Create attributes as described below by right click on the new created aggregated document area

Once an attribute has been created, drag and drop the corresponding field from the basic
document area (on the left side of the screen)

Result:

Page | - 7 -