Show TOC

Background documentationCustomizing for the Document Finder Locate this document in the navigation structure

 

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 online help in the IMG activity. 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 short description of your choice. This text should be as informative as possible, because it will be displayed in document area selection list in the Document Finder.

  • Display 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 standard display class CL_ALINK_HITLIST_TREE. This displays the hit list as a hierarchical tree structure. This is the default setting, which means it is 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 add 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)

    Note Note

    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.

    End of the note.

  • CL_ALINK_QUERY_PRILIST (Print list search in the local system)

Document areas of these query classes (called technical document areas in the following) give a technical view of all documents managed by ArchiveLink. They have the attributes that ArchiveLink has and indexes in the link entry. The suche corresponds to the ArchiveLink search that can be called using administration. You can implement technical document areas 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)

    Note Note

    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.

    End of the note.

Document areas of these query classes (called external document areas in the following) include all documents in any external system, for example, a storage system. ArchiveLink print lists can also belong to this.

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

Query class for searching in external systems

  • CL_ALINK_QUERY_2

Document areas of these query classes (called external document areas in the following) 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 DMS. The query class requests the attributes of the external system at runtime. Check with the storage system supplier whether these functions are supported.