Difference between revisions of "Archived Documents"

From ADempiere
Jump to: navigation, search
This Wiki is read-only for reference purposes to avoid broken links.
m (Archiving a Document or Report)
m
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
 
{{Breadcrumb|Table of Contents|Functionality|next=Asset Info}}
 
{{Breadcrumb|Table of Contents|Functionality|next=Asset Info}}
[[Category:Functionality]]
 
 
[[Category:User documentation]]
 
[[Category:User documentation]]
 +
[[Category:Functionality]]
 +
[[Category:Documentation]]
 +
[[Category:Table of Contents]]
  
 
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.
 
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.
Line 72: Line 74:
 
** org.compiere.apps.form.Archive.java
 
** org.compiere.apps.form.Archive.java
 
** org.compiere.apps.form.ArchiveViewer.java
 
** org.compiere.apps.form.ArchiveViewer.java
 +
** org.compiere.print.Viewer.java
 +
 +
* base/src
 +
** org.compiere.model.MArchive.java

Latest revision as of 22:28, 21 December 2010

Table of Contents{{#if: Functionality| | Functionality }}{{#if: | | [[{{{3}}}]] }}{{#if: | | [[{{{4}}}]] }}{{#if: | | [[{{{5}}}]] }} | Archived Documents{{#if: Asset Info| | 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.

Access

Icon: Icon Archive24.png
Menu: →Archive Documents/Reports }}{{#if: | → }}{{#if: | → }}
Short Cut: (none)
Menu Tree:  » General Rules }}{{#if: Security |  » Security }}{{#if: Archive Viewer |  » Archive Viewer }}{{#if: |  »  }}
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 {{#if: |{{{2}}}|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 {{#if: |{{{2}}}|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 Report24.png or document Icon PrintPreview24.png. In the preview window, click on the Archive icon Icon Archive24.png.

Viewing Archived Documents

To open the Archive Viewer, select System Admin{{#if: General Rules |  » General Rules }}{{#if: Security |  » Security }}{{#if: Archive Viewer |  » Archive Viewer }}{{#if: |  »  }} 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.

 

ManPageX ArchiveViewer.png

 

When viewing a record, you can use the toolbar button Icon Archive24.png or the application menu Go{{#if: Archive Documents/Reports | →Archive Documents/Reports }}{{#if: | → }}{{#if: | → }} 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.

Archive Popup.png

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

 

Archive View.png

 

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 {{#if: |{{{2}}}|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