Archived Documents

From ADempiere ERP Wiki

Jump to: navigation, search

Table of Contents | Functionality | Archived Documents | Asset Info

ADempiere has a function to archive documents and reports for historical purposes. This is a useful feature if you need to record the state of a record or report that changes over time.

Contents

Access

Icon: Image:Icon_Archive24.png
Menu: Go→Archive Documents/Reports
Short Cut: (none)
Menu Tree: System Admin » General Rules » Security » Archive Viewer
Image:Note.gif Note:

Depending on the Client Automatic Archive Level documents and reports are automatically saved and available for view. In the Report Viewer you can manually archive Documents or Reports.

Restrictions

Access to this function may be limited by ASP settings.

To see the archived documents or reports, your role must have Can Report checked in the Role Window.

You can only view archives if you have access to the original document.

Archiving a Document or Report

Archiving of reports and documents can be performed automatically or manually.

Automatic archiving is set in the Client Window. The level of archiving can be set as:

  • All (Reports and Documents)
  • Documents
  • External Documents
  • None

To manually archive a report or document, select the data record in a window/tab and preview the report Image:Report24.png or document Image:Icon_PrintPreview24.png. In the preview window, click on the Archive icon Image:Icon_Archive24.png.

Viewing Archived Documents

To open the Archive Viewer, select System Admin » General Rules » Security » Archive Viewer in the menu tree. This will open the Archive View showing the query tab. Enter any criteria here and click the green check mark to see the results.

 

 

When viewing a record, you can use the toolbar button Image:Icon_Archive24.png or the application menu Go→Archive Documents/Reports to access the Archives for that record. Initially, a popup will appear beside the Archive icon in the toolbar showing the number of reports and documents archived.

In the popup, click on the item of interest to open the Archive Viewer.

 

 

In the View tab, you can cycle between the documents, view, rotate, print or save them to disk as PDF files.

To search for other items, switch to the Query tab and enter different criteria.


For System Administrators

See the Client Window for settings that affect the Archive function. These include auto-archive level and the physical storage location of archived items.

ASP access to this feature is controlled at the System level. See the ASP page for more information.

For Developers

The software that controls this function can be found in

  • client/src
    • org.compiere.apps.AArchive.java
    • org.compiere.apps.form.Archive.java
    • org.compiere.apps.form.ArchiveViewer.java
    • org.compiere.print.Viewer.java
  • base/src
    • org.compiere.model.MArchive.java
Personal tools