By a customer plugin we mean a customizable component used for processing of documents and their attachments that have been archived by Archive Manager. 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.
Manage, Migrate, Archive, Store, Protect
www.metalogix.com/Support [email protected] Metalogix Software 84 / 102 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 \ Common Files \ Pam \ Services \ PamPostProcessing \ Plugins.
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.
Manage, Migrate, Archive, Store, Protect
www.metalogix.com/Support [email protected] Metalogix Software 85 / 102 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 documents 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.
Manage, Migrate, Archive, Store, Protect
www.metalogix.com/Support [email protected] Metalogix Software 86 / 102
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.
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
Manage, Migrate, Archive, Store, Protect
www.metalogix.com/Support [email protected] Metalogix Software 87 / 102 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 Start configuration wizard button.
Manage, Migrate, Archive, Store, Protect
www.metalogix.com/Support [email protected] Metalogix Software 88 / 102 Doc. reading proc – procedure which reads documents to be processed
Manage, Migrate, Archive, Store, Protect
www.metalogix.com/Support [email protected] Metalogix Software 89 / 102
Statistics tab
This tab was designed to give the administrator fast, reliable and comprehensive information about archived and restored documents. The number of documents, their size as well as space saved on the disc at archiving – all these essential data can be sorted by folder, user and time period. Exporting the statistics to chosen folder is also possible.
As a first step, in the Type down-drop box choose whether you want to generate statistics for Archived or Restored documents.
Then select the statistics specification in the Statistics down-drop box:
● All - returns data on saved space and number and size of all archived documents
● Yearly statistics - returns data on saved space and number and size of archived documents for the chosen sequence of years
● Monthly statistics - returns data on saved space and number and size of archived documents for the chosen sequence of months
● Daily statistics - returns data on saved space and number and size of archived documents for the chosen sequence of days
Manage, Migrate, Archive, Store, Protect
www.metalogix.com/Support [email protected] Metalogix Software 90 / 102 of archived documents for the chosen sequence of hours
Additional statistics are available for Archived documents (“Archived” is selected in the Type down-drop box):
● User based statistics
- returns data on saved space and number and size of documents archive by the selected user or all users (including jobs)
● Folder based statistics
- returns data on saved space and number and size of documents archived in the selected folder
NOTE: All the above mentioned statistics types DO NOT take into consideration versions of archived documents. Only data for the current versions of the archived documents are collected. In case of archived documents it is possible to get statistics also for their versions. To generate the statistics for versions (not including the actual version) select Archived yearly statistics – versions, Archived Monthly statistics – versions etc.
After specifying your desired statistics click the Generate button ( ). Depending on the chosen type of statistics you will be asked to specify the time span for the statistics, user or folder.
Example: To set the period for which you want to generate the statistics use the down arrows to open the calendar. Then select the date. You can also simply rewrite the values. Then click OK.
Manage, Migrate, Archive, Store, Protect
www.metalogix.com/Support [email protected] Metalogix Software 91 / 102 Click Export ( ) should you wish to export the statistics as an .rpt, .html, PDF or .xls to your desired location.
Manage, Migrate, Archive, Store, Protect
www.metalogix.com/Support [email protected] Metalogix Software 92 / 102