Difference between revisions of "IndexConverter"
(→How to run this tool) |
(→Memory Issue) |
||
| (12 intermediate revisions by 2 users not shown) | |||
| Line 4: | Line 4: | ||
This new release will use a different full-text index format. | This new release will use a different full-text index format. | ||
Indexes created by LogicalDOC before release 8.3.2 will not work anymore with | Indexes created by LogicalDOC before release 8.3.2 will not work anymore with | ||
| − | LogicalDOC 8.5 and therefore must to be converted to the new format.<br /> | + | LogicalDOC 8.5 and therefore must to be converted to the new format <b>before upgrading to 8.5</b>.<br /> |
<pre style="color: red"> | <pre style="color: red"> | ||
We strongly recommend to do this conversion as soon as possible so there will be | We strongly recommend to do this conversion as soon as possible so there will be | ||
no problems when you will upgrade your installation to the 8.5. | no problems when you will upgrade your installation to the 8.5. | ||
</pre> | </pre> | ||
| − | |||
| − | |||
== What this tool does == | == What this tool does == | ||
| Line 17: | Line 15: | ||
After this conversion you can continue to use your actual version of LogicalDOC, | After this conversion you can continue to use your actual version of LogicalDOC, | ||
<u>but you will be ready to upgrade to 8.5 when it will be available</u>. | <u>but you will be ready to upgrade to 8.5 when it will be available</u>. | ||
| − | |||
== Who must run this tool and who must not == | == Who must run this tool and who must not == | ||
If you started using LogicalDOC since version 8.3.2 you must not run this tool. | If you started using LogicalDOC since version 8.3.2 you must not run this tool. | ||
If you started using LogicalDOC before version 8.3.2 you must run this tool. | If you started using LogicalDOC before version 8.3.2 you must run this tool. | ||
| − | |||
== Prerequisites == | == Prerequisites == | ||
| Line 28: | Line 24: | ||
It will not run in case you have a version older than 8.3.1, <u>so in this case | It will not run in case you have a version older than 8.3.1, <u>so in this case | ||
update your installation to the 8.3.2 first</u>. | update your installation to the 8.3.2 first</u>. | ||
| − | |||
== How to run this tool == | == How to run this tool == | ||
| − | + | Download the [http://repo.logicaldoc.com:1000/maven1/com/logicaldoc/logicaldoc-indexconverter/8.3.2/logicaldoc-indexconverter-8.3.2-tool.zip IndexConverter] and unpack the .zip file into your LogicalDOC's home dir(let's call it <b><LDOC_HOME></b>), this will create the folder <b><LDOC_HOME>/indexconverter</b><br/> | |
| − | folder <b><LDOC_HOME>/indexconverter</b><br/> | ||
If you are in Linux or Nas, open a shell and execute the following commands: | If you are in Linux or Nas, open a shell and execute the following commands: | ||
| Line 41: | Line 35: | ||
If you are in Windows, open an elevated console and execute the following | If you are in Windows, open an elevated console and execute the following | ||
commands: | commands: | ||
| − | + | > cd <LDOC_HOME>\indexconverter | |
| − | + | > convert.bat | |
Once the tool is launched you can follow how it is doing by looking at the log | Once the tool is launched you can follow how it is doing by looking at the log | ||
| Line 48: | Line 42: | ||
== How long it takes to convert == | == How long it takes to convert == | ||
| − | Unfortunately the conversion is not a quick task, the time depends on how many | + | Unfortunately the conversion is not a quick task, the time depends on how many documents you have, and on the CPU performances.<br/> |
| − | documents you have, and on the CPU performances. | + | If you are on a Xeon QuadCore with SSD disk, you can expect 500 documents processed per minute.<br /> |
| − | If you are on a Xeon QuadCore with SSD disk, you can expect 500 documents | + | You can interrupt the conversion at any time and start it again, you will not loose the already done conversion.<br /> |
| − | processed per minute. | + | There is no need to stop LogicalDOC, but if you stop it the conversion process will be quicker. |
| − | You can interrupt the conversion at any time and start it again, you will not | ||
| − | loose the already done conversion. | ||
| − | There is no need to stop LogicalDOC, but if you stop it the conversion process | ||
| − | will be quicker. | ||
| − | + | == Memory Issues == | |
| + | It could happen that the process encounters memory problems, perhaps because there are documents too large to index or the process does not effectively clear the memory. | ||
| + | However, it is possible to solve these problems by increasing the memory allocated to the converter. | ||
| + | Just open the build.xml file and modify the maxmem property value (default 2000) | ||
| + | Example | ||
| + | <pre> | ||
| + | <property name="maxmem" value="5000" /> | ||
| + | </pre> | ||
Latest revision as of 09:58, 10 February 2021
Contents
Index Conversion Tool
At beginning of year 2020 the new release 8.5 will be made available.
This new release will use a different full-text index format.
Indexes created by LogicalDOC before release 8.3.2 will not work anymore with
LogicalDOC 8.5 and therefore must to be converted to the new format before upgrading to 8.5.
We strongly recommend to do this conversion as soon as possible so there will be no problems when you will upgrade your installation to the 8.5.
What this tool does
This tool is designed to process your actual index and convert it in a format compatible with LogicalDOC 8.5. After this conversion you can continue to use your actual version of LogicalDOC, but you will be ready to upgrade to 8.5 when it will be available.
Who must run this tool and who must not
If you started using LogicalDOC since version 8.3.2 you must not run this tool. If you started using LogicalDOC before version 8.3.2 you must run this tool.
Prerequisites
This tool can by ran on versions from 8.3.2 to 8.4.x. It will not run in case you have a version older than 8.3.1, so in this case update your installation to the 8.3.2 first.
How to run this tool
Download the IndexConverter and unpack the .zip file into your LogicalDOC's home dir(let's call it <LDOC_HOME>), this will create the folder <LDOC_HOME>/indexconverter
If you are in Linux or Nas, open a shell and execute the following commands:
$ cd <LDOC_HOME>/indexconverter $ chmod a+x convert.sh $ ./convert.sh
If you are in Windows, open an elevated console and execute the following commands:
> cd <LDOC_HOME>\indexconverter > convert.bat
Once the tool is launched you can follow how it is doing by looking at the log file converter.log
How long it takes to convert
Unfortunately the conversion is not a quick task, the time depends on how many documents you have, and on the CPU performances.
If you are on a Xeon QuadCore with SSD disk, you can expect 500 documents processed per minute.
You can interrupt the conversion at any time and start it again, you will not loose the already done conversion.
There is no need to stop LogicalDOC, but if you stop it the conversion process will be quicker.
Memory Issues
It could happen that the process encounters memory problems, perhaps because there are documents too large to index or the process does not effectively clear the memory. However, it is possible to solve these problems by increasing the memory allocated to the converter. Just open the build.xml file and modify the maxmem property value (default 2000) Example
<property name="maxmem" value="5000" />
