====== EntityMessageArchiver ======

The EntityMessageArchiver copies the eBiss message structure and the contents of the messages and the attachments.
It copies the eBiss items:
  * messages,
  * attachments,
  * interchanges and
  * documents
into **one database** and the contents of the attachments into **one directory**. Where the database is located and into which directory the attachments will be copied 
is defined in the JobStep (see below).

Messages that have been archived and receive the archive flag and are not considered again during archiving and archived messages cannot be executed in eBiss by a job or changed on the interface.


All databases supported by eBiss are possible, see [[en:ueberblick:systemvoraussetzungen:start|]]. For the creation of the tables, scripts for MySQL and the MS SQL-Server are located in the 
installation directory under Tools in the files:
  * .\Tools\CreateMessageArchiveDB.MsSqlServer.sql   and
  * .\Tools\CreateMessageArchiveDB.MariaDB.sql.



^GENERATED src="eBiss.ClassLib.Resources.JobSteps.EntityMessageArchiver" changed=""^^
^Properties^^
^Name^Description^
|**Type**|Class name of the jobstep|
|**Name**|Name for the jobstep that will appears in the job designer|
|**Description**|Optional description for the jobstep|
|**Scope**|All messages of all nodes or only those of the local node.|
|**Days old news**|All messages older than x days|
|**SqlCommandTimeout**|
|**Batchsize**|The number of messages to be processed per pass. The default value is 500.|
|**Database connection**|The database connection for the target database, as it is entered for eBiss via the eBiss.Configurator in the eBiss.Service.exe.config ((The field can only be read and modified by administrators and is not output when exporting or copying)). If you put a $ in front of the value, e.g. $Archive.DbConnection, then the variable 'Archive.DbConnection' of the standard system partner is used in this case. With what over encrypted variables an encryption is possible.|
|**Database adapter**|The adapter for the target database as it is entered for eBiss via the eBiss.Configurator in the eBiss.Service.exe.config ((The field can only be read and modified by administrators and is not output when exporting or copying)). If you put a $ in front of the value, e.g. $Archive.DbAdapter, then the variable 'Archive.DbAdapter' of the standard system partner is used in this case. With what over encrypted variables an encryption is possible. |
|**Archive Path**|The path to which the message attachments should be copied.|
|**Wait between archive**|The wait time in milliseconds to wait between batch runs.|