Administration

The administration and configuration of the EBIS plug-in is mostly limited to the settings of the web server plug-in (protocol, address and port) and are performed via the administration client of the EASY Archive server.

Special settings are described below.

Lifetime of executed EBIS spooler jobs.

Available as of version: 1.8.18

In addition to a synchronous document import, EBIS also offers the use of a TransferTask (spooler job). Since this TransferTask is processed asynchronously, both data and information about this task are stored temporarily, which can be retrieved by the calling application (e.g. to check whether a spooler job has been completed in the EASY Archive server). Ideally, the calling application should delete this data automatically after processing by a corresponding call. If this does not happen, the data is automatically removed by the system after a configurable period of time.

Java-Pseudocode Transfer-Task
IClientService defaultClientService = new DefaultClientService( ... );
IInstance instance = defaultClientService.getInstance( ... );
ISession session = instance.login( ... );
IDocumentsTransfer transferTask = session.createDocumentsTransferTask( ... );
String transferTaskId = transferTask.getTaskID();
:
:
transferTask.submit( ... );
 
while ( task_not_completed ) {
:
:
}
 
// removing the task deletes corresponding data and meta data
defaultClientService.removeTask(transferTaskId);

Settings for automatic cleanup: In the JAR file of the EBIS plugin is the file

plugin-workspace\plugins\de.easy.ebis.hazelcast_x.x.x.jar

which contains the configuration file ebis-hazelcast.xml. Starting from line 211 the setting

<map name="ebis.taskinfo">

can be found, in which the lifetime of the TaskInfo can be specified. The parameter

<max-idle-seconds>

with the default value 172,800 (= 2 days) can be set to a lower value. The setting

<eviction-policy>

is to be set to LRU (Least recently used) or left as it is (it is already set in this way in the standard). The map named ebis.taskresults (starting from line 224) must be treated in the same way. Theoretically, a different value can be set here than for ebis.taskinfo, but this makes no sense in operation, since the data can then not be completely retrieved by the client. The configuration file can be edited and stored within the JAR file or it is extracted and stored and edited as hazelcast.xml (not ebis-hazelcast.xml) in the configuration directory for the plugin, for an EASY Archive 6 installation e.g. d:\eex\config\embedded-ebis\configuration. The hazelcast.xml in the configuration directory has priority over the ebis-hazelcast.xml in the JAR file. After changing the configuration, the plugin must be restarted.

Attention: The set time is a hard timeout, i.e. when the maximum lifetime is reached, the information is deleted, even if a spooler task may not have been processed by the EASY Archive server at all. Information about the status can then no longer be queried on the client. The timeout should therefore not be set too low. In any case, "synchronous" cleanup is recommended, as described in the code above.