OAG1 Transaction settings effects

[fjhernanz]

OAG1 Transaction settings effects 

This is an explanation, with graphical examples, of the effects derived from the OAG1 transaction settings. The blog follows the same structure as the transaction itself, that is:

1 ‘Hit List Settings’ section

• 1.1 Display docs. Directly
• 1.2 Simple Hit List
• 1.3 Structured Hit list
• 1.4 Technical Hit List
• 1.5 Maximum Number of Document in Hits List

2 ‘Display Settings’ section

• 2.1 Windows Viewer Settings
  • 2.1.1 Include ECL Control
  • 2.1.2 Use HTML Control
  • 2.1.3 Call Internet browser
• 2.2 Viewer Settings WEBGUI
  • 2.2.1 Use HTML Control
  • 2.2.2 Call Internet browser
• 2.3 Other Options
  • 2.3.1 Deactivate Generic Services in ECL Viewer
  • 2.3.2 Doc. Display as Dialog Box
  • 2.3.3 Deactivate Data Provider Cache
  • 2.3.4 Reserve Fields for Global Customizing

3 ‘Storage Settings’ section

• 3.1 Copy document class from document type
• 3.2 Flag for Multiple Assignment of Documents to Store
• 3.3 SAP ArchiveLink Number of Documents

1. ‘Hit List Settings’ section

1.1 Display docs. Directly.

All the linked documents are displayed immediately, without an intermediate hitlist in which we can decide which one to choose

1.2 Simple Hit List.

If this variant is active, the hit list from generic object services is prepared when a direct call to display stored documents from the application is made. This hit list contains all notes, attachments and documents stored using SAP ArchiveLink.

In addition, the object instance is published and the generic services are available in the menu line of the hit list.

1.3 Structured Hit list.

If this variant is active, the Document Finder is called when a direct call to display stored documents from the application is made. The Document Finder displays the list of linked documents, sorted according to evaluation groups (usually document type), in a tree structure on the left side of the window.  Detailed information on the selected document can be displayed below this. Individual documents can be displayed either in-place on the right side of the window or out-place in a separate window, depending on the document class.

1.4 Technical Hit List.

If this variant is active, the ABAP List Viewer is called when a direct call to display stored documents from the application is made. The Viewer displays the list of linked documents with some technical background information. From here, you can display an individual document directly or request further technical details on the document.

In addition, all ABAP List Viewer functions are available, as well as other SAP ArchiveLink functions.

1.5 Maximum Number of Document in Hits List

Sets the maximum number of hits displayed when you search for documents (a zero value means the number of hits is not limited).

Once this value is saved on OAG1 its automatically visible on the Maximum number of hits on OAAD transaction. Its important to notice that this option does not limit the maximum number of hits on the lists obtained on the previous features (‘Direct document display’, ‘Simple hit List’ and ‘Structured hit list’)

2. ‘Display Settings’ section

2.1 Windows Viewer Settings

Its important to mention that these settings can be overridden in the SAPGUI for Windows by SAPArchiveLink protocol settings.

2.1.1 Include ECL Control

ECL control is supplied by SAP. It displays many different graphic formats (for example, TIF, JPG, BMP, GIF) inplace in the SAPGUI. The file types that can be displayed when including the ECL Control are specified in:

Viewer > Loader Preferences > File Extensions

And also in http://help.sap.com/erp2005_ehp_05/helpdata/EN/74/0051ff5804e3459d8fc6d8d4d9ad7e/frameset.htm

To use ECL control for document classes, the application EAIWEB.WEBVIEWER2D must be entered in ArchiveLink document type maintenance.

ECL control is only available for the GUI on Windows platforms. It is not available for the SAPGUI that runs in the Internet browser directly.

2.1.2 Use HTML Control: Call HTML - Control (only for HTTP Content Server)

When an HTTP content server is used, documents can be displayed in HTML control directly

2.1.3 Call Internet browser: Direct Internet Call - Browsers (only for HTTP Storage)

When an HTTP content server is used, documents can be displayed by calling the Internet browser.

2.2 Viewer Settings WEBGUI

2.2.1 Use HTML Control: Call HTML - Control (only for HTTP Content Server)

When an HTTP content server is used, documents can be displayed in HTML control directly. As in the previous settings, this one can be overridden in the SAPGUI for Windows by SAP ArchiveLink protocol settings.

2.2.2 Call Internet browser. Display in Separate Browser Window (only for HTTP Storage)

When an HTTP content server is used, documents can be displayed in a separate browser window when the WebGUI is used.

2.3 Other Options:

2.3.1 Deactivate Generic Services in ECL Viewer

This flag setting controls the availability of the generic object services in the ECL Viewer. If the flag is set, the Viewer functions are NOT available for the displayed document. This means that the icons are not available for selection.

2.3.2 Doc. Display as Dialog Box: Document Display Connected to SAPGUI (Dialog Box Container)

You can use this setting to determine whether documents are displayed in a dialog box container (switch active).

If documents are displayed in the dialog box container, the viewer is automatically closed when the calling transaction is completed.

If documents are not displayed in the dialog box container, they are displayed in a window independently of the calling transaction.

To override this setting for individual users, use the Set/Get Parameter 'ARCHIVELINKDIALOG'. Possible values:

     VIEWER: Display in separate independent Viewer window

     DIALOGBOX: Display in dialog box container

2.3.3 Deactivate Data Provider Cache: Access Without Data Provider

Indicator that controls whether the URL for a displayed document is temporarily stored in the cache on the SAP application server.

     Indicator not set (standard setting): The URL is stored in the cache.

     Indicator set: The URL is not stored in the cache.

The recommendation is to set it (that is, deactivate the DP cache). I've found many problems when the DP cache its used, i.e the DP_ERROR_GENERAL is definetively related with the DP Cache and most of the times simply checking this flag solves the issue (as explained in SAP note 1503002). On the past, it was more difficult to clean the cache since that option did not exist on OAG1 and it has to be cleaned with the help from note 629139

2.3.4 Reserve Fields for Global Customizing (Reserve1 and Reserve2)

These  fields are reserved for future developments and is not currently used. In example, as shown in the figure ‘Reserve1’ field is replaced by ‘Save the file attributes’ once note 1451769 has been applied

3. ‘Storage Settings’ SECTION

3.1 Copy document class from document type

The administrator can use the transaction OAC2 to assign the technical type for documents of a particular document type. If a document with a different technical type is used for storing, you have two options for entering technical attributes in the link table:

1. Transfer the customizing entry from transaction OAC2

2. Enter the real type of the document

Conventional processing is by using the customizing setting in transaction OAC2. If you use a different technical type for storing, this can cause errors when displaying documents, because the viewer for displaying documents is chosen on the basis of the technical type. The document type in the link table is used for displaying a document.

If this switch is set, then the system follows the normal procedure and the value entered in the link table is the default value for the document type. Caution: If document class is ‘*’ the document will be saved as 'If this switch is not set, the document class is determined from the file name and the result is entered in the link table.

Caution: This procedure is used only when documents are stored manually (file upload). It is not active for instance in the bar code scenario when documents are verified by the content server.

3.2 Flag for Multiple Assignment of Documents to Store

The setting "multiple assignment in storage scenarios" enables you to use the stored document for further scenarios. It controls the availablity of the function "Assign" in the window for entry scenarios. To call this window, use the transaction OAWD or the user function "Store document". The function "Display last document" is also activated, which allows you to re-display the document you have just stored.

3.3 SAP ArchiveLink Number of Documents

This number is used when entering documents using Drag&Drop. If the number of files selected using this method exceeds the value specified here, a warning appears.