Chat now with support
Chat with Support

Metalogix Archive Manager for Files 8.1.1 - Administration Guide

About the documentation Enterprise Manager – Common Part
How to manage more Archive Manager servers Restrictions tab Settings tab Scheduler tab Archive tab Post Processing tab Statistics tab System context menu
Other functionality Addendum

Search & Export

 

The Search & Export tab allows you to search in the archive, even in the files which are marked for deletion. In the search query various search criteria can be specified – you can search for files with specific file size, archived at particular time interval or by a specific user etc. The defined search criteria can be saved as a template to be used later in the future. Search results can be exported to a local folder. Exporting of the search results list and saving it in different formats is also possible.

 

NOTE: Since v6.1 Archive Manager implements also OCR search, i.e. indexing of a graphic files (tiff, pdf containing scanned content etc.), so the text in pictures is also searchable. However, this technology may have some limitations, e.g. too small characters may not be correctly recognized.

 

To search in archived files follow the next steps:

 

1.On the Archive tab click Search & Export.

2.In the left pane you can specify various search criteria:

 

Search for section

In the text box enter the name of the file or folder which you want to look for. As default the Archive Manager will look for any files/folders containing the defined string. The name can include special characters, for instance question mark: “?” (wildcard for any character), asterisk: “*” (wildcard for any number of characters).

Check the File name check box to look for files the name of which contains the defined string.

Check the File path check box to apply the search also to file path.

Check Match the whole word to search just for files/folders matching exactly the defined string.

Check Include deleted docs to search also in documents marked for deletion.

In the Max result count you can restrict the number of found results. Only the defined number of results will be displayed. To look for and display all archived files/folders matching the defined criteria enter “-1”.

 

c-search

 

Further you can specify additional search criteria:

-Date and time of archiving (When was it archived section)

-Size of the file/folder (What size it is section); “-1” in the From / to text box stands for any size

-Who archived the file (user or job)

-Who created the file

 

3.After you have specified the search criteria, click Search. Search results will be listed in the right pane. The data grid containing the search results can be modified. To do so, right-click inside the list view and in the Show menu select the columns you want to display.

 

d-search context menu

 

4.Each file found in the search can be restored to a local folder with all its versions. Just right-click the desired file in the list. From the context menu select Get Version(s) to and in the pop-up dialog specify the folder where you want to restore the file(s).

 

e-export

 

5.The Templates button allows you to save the search criteria so that you can execute the same search later. After clicking the button, Template list pops up. Click Save current to enter the name for the template and save it. Templates are stored on the server side, so they can be managed from each Enterprise Manager connected to the server.

 

NOTE: To execute search with the already saved template click Templates button. In the pop-up Template list select the desired template and click Load.

 

f-template

 

6.The search results list can be exported and saved. Click Export. In the pop-up select the fields which you want to include in the report document. Then click Next and save the report. Archive Manager allows you to save the report in several formats (XLS, PDF, XML, RPT, HTML)

 

g-fields

 

Post Processing tab

 

Post Processing allows running customer specific tasks over archived files. This feature was primarily developed to meet additional clients’ requirements. Clients using other software programs who wish to process archived files within those software programs may do so via the Post Processing.

 

IMPORTANT: If you have installed Archive Manager Search as a fulltext engine, you need to upload and enable the appropriate post-processing plugin. With this plugin configured, you will be able to fulltext search in the file archive. The plugin is called PFPostProcessLuceneIndexPlugin and can be found in C:\Program Files (x86)\ Common Files \ Pam \ Services \ PamPostProcessingSv \ Plugins. After connecting to Post Processing server on the Post Processing tab, click Add. Plugin will be added to the list in the Installed plugins section.

 

NOTE: Do not start post processing service on multiple servers for the same database. Starting the post processing service on multiple servers is not recommended, since that can cause conflicts in bookmarking. The same database should not be indexed by more than one post processing service.

 

How to apply a post processing plugin

 

By a customer plugin we mean a customizable component used for processing of documents and their attachments that have been archived by Archive Manager for Files. It is a code which is a section of an assembly that is developed specifically to customer requirements.

Upon receiving a plugin, take the following steps:

1.Make sure that the post processing service (MamPostProcessingSv) is started.

2.In the Enterprise Manager click on the Post processing tab.

a-tab

 

3.In the Post Processing server section specify connection settings for a Post Processing server, i.e. server where the post processing service is installed:

·In the Server name text box enter the name of the post processing server

·Specify the Port number and Protocol (select HTTP or TPC protocol by clicking on the button located at the right)

Click Apply, then Connect.

 

NOTE: More Post Processing server settings can be configured after clicking the Details button. For more information see the “Post processing server settings” section.

 

4.After connecting to Post Processing server, the Installed plugins section becomes available. Click Upload to upload a plugin from the local machine to the Post Processing server. The Upload Plugins dialog pops up. In the Source path text box enter the path to the desired plugin or use the Browse button to locate it. Then click Upload.

 

NOTE: Use Add button to look for plugins in the Post Processing server’s configured plugins directory. As the default it is C:\Program Files (x86) \ Common Files \ Pam \ Services \ PamPostProcessingSv \ Plugins.

b-upload

5.The plugin will be displayed in the list view. Its properties will be displayed in the right pane. Make sure that the plugin status is Enabled: True so that the plugin is allowed to operate.

c-properties

 

6.Each plugin is loaded by default with the initial Bookmark date. As the default it is 1/1/1900. It means that the plugin processes files having been archived after this initial bookmark date. If post processing should begin from some other bookmark date, then make sure to reset the initial bookmark date in the Bookmark date text box in the right pane.

d-bookmark

 

Post processing server settings

 

The administrator can configure advanced settings of Post Processing server after clicking the Details button on the Post Processing tab of the Enterprise Manager.

 

e-details

 

Settings available in the Post processing server settings pop-up window:

General settings

Max thread count

specifies the maximal number of threads which can be used by Posta processing

Database timeout

timeout for database in seconds

Max. count attempts

defines how many times the post processing will attempt to process one document

Check Interval

interval (milliseconds) in which post processing checks whether there are documents to be processed

Maximum thread per plugin

specifies the maximal number of threads to be used by one plugin

Document max runtime

defines how long a document can be processed (in milliseconds)

Thread abort time

specifies how long a batch of documents can be processed (in milliseconds)

Max. count doc. per round

specifies maximal number of documents in a batch

Debug

if checked, post processing is writing debug outputs

Debug plugins

if checked, stand alone plugins are writing debug outputs

Active

this check box is checked by default; if unchecked, post processing is deactivated

 

Some recommended values:

Check Interval

10000

Maximum thread per plugin

10

Document max runtime

300000

Thread abort time

310000

Max. count doc. per round

500

 

Øevery 10 seconds the post processing service checks the status – checkinterval

Øif the plugin is idle, it will load 500 documents (max. count doc. per round) to memory

Øthe processing of the 500 documents will be started in 10 threads (Maximum thread per plugin)

Øif there is a document which is taking longer to process, it will be aborted (and marked as error) after 310 seconds (Thread abort time)

ØNote: even if you reset the bookmark back to beginning (and you have already processed documents) then it will go through 500 docs every 10 seconds: 180 000 docs per hour. In this case you can set the checkinterval to even smaller value.

 

Common mistakes:

ØI will increase the “Maximum thread per plugin” to 30 or higher, so it will be faster. >> Wrong. Some plugins are quite limited. If you have more threads, you end up with a bunch of errors and you will not be able to index everything in time.

ØI will decrease the “Thread abort time” (“Document max runtime”) so it will recover faster. >> Wrong. If the plugin is calling a COM component or a web server/service, then aborting the thread does not return immediately, however a new thread is started. This can once again reach the limits described above.

ØI will use 3 plugins and the “Maximum thread per plugin” will be 20. >> Wrong. You will soon exhaust your server since each plugin has 20 threads -> 60 threads is more than enough. Plan carefully.

ØIf you have an older plugin in the Plugins folder, please move it OUTSIDE the Plugins folder! You are slowing EnterpriseManager down.

ØI will change the settings and all changes are applied immediately. >> Wrong. The changes are applied only after 1 minute. If you want a real refresh, restart the service.

 

Database settings

 

This section displays Archive Manager database connection parameters. Post processing is reading documents to be processed from this database. To configure the database, click the Configuration wizard button.

 

Plugin reading proc. – procedure which reads plugins

Doc. reading proc – procedure which reads documents to be processed

NOTE: One Post processing server can process documents from one archive database only.

Related Documents