Archiving can be triggered by doing the following steps:
Archiving can be triggered by doing the following steps:
- go to an experiment/collection or an object.
- go to an experiment/collection or an object.
- switch to the tab "Data Sets". There will be in ther lower right
- switch to the tab "Data Sets". There will be in ther lower right corner the button 'Archiving'.
corner the button 'Archiving'.
- click on the button and choose either 'Copy to Archive' or 'Move to Archive'.
- click on the button and choose either 'Copy to Archive' or 'Move to
- if you did not select any data set all data sets will be archived. If you have selected some data sets you can choose if you want to archive only them or all the data sets accessible in the table.
Archive'.
- if you did not select any data set all data sets will be archived.
Because archiving does not happens immediately the status (called 'Archiving Status' in data set tables) of the data sets will be changed to BACKUP\_PENDING or ARCHIVE\_PENDING.
If you have selected some data sets you can choose if you want to
archive only them or all the data sets accessible in the table.
To make archived data sets available again repeat the steps, but choose 'Unarchive'.
Because archiving does not happens immediately the status (called
If you want to disallow archiving, choose 'Lock'. Remember that you can do this only for available data sets. The 'Archiving Status' will change to 'AVAILABLE (LOCKED)'. To make archiving possible again, choose 'Unlock'.
'Archiving Status' in data set tables) of the data sets will be changed
to BACKUP\_PENDING or ARCHIVE\_PENDING.
To make archived data sets available again repeat the steps, but choose
'Unarchive'.
If you want to disallow archiving, choose 'Lock'. Remember that you can
do this only for available data sets. The 'Archiving Status' will change
to 'AVAILABLE (LOCKED)'. To make archiving possible again, choose
'Unlock'.
### ELN-LIMS
### ELN-LIMS
Instead of triggering archiving only requesting archiving is possible.
Instead of triggering archiving only requesting archiving is possible.
The maintenance task
The maintenance task [ArchivingByRequestTask](https://openbis.readthedocs.io/en/latest/system-admin-documentation/advanced-features/maintenance-tasks.html#archivingbyrequesttask) is required. It triggers the actual archiving.
Archiving can be automated by the Auto Archiver. This is a [maintenance
Archiving can be automated by the Auto Archiver. This is a [maintenance task](https://openbis.readthedocs.io/en/latest/system-admin-documentation/advanced-features/maintenance-tasks.html) which triggers archiving of data sets fullfulling some conditions (e.g. not accessed since a while). Note that the auto archiver doesn't archives itself. It just automates the selection of data sets to be archived. For all configuration parameters see [AutoArchiverTask](https://openbis.readthedocs.io/en/latest/system-admin-documentation/advanced-features/maintenance-tasks.html#autoarchivertask).
task](/display/openBISDoc2010/Maintenance+Tasks) which triggers
archiving of data sets fullfulling some conditions (e.g. not accessed
since a while). Note that the auto archiver doesn't archives itself. It
just automates the selection of data sets to be archived. For all
An archiving policy selects from the unarchived data sets candidates
An archiving policy selects from the unarchived data sets candidates (which are either data sets not accessed since some days or data sets marked by a tag) the data sets to be archived. If not specified all candidates will be archived.
(which are either data sets not accessed since some days or data sets
marked by a tag) the data sets to be archived. If not specified all
candidates will be archived.
The policy can be specified by `policy.class` property. It has to be the
The policy can be specified by `policy.class` property. It has to be the fully-qualified name of a Java class implementing` ch.systemsx.cisd.etlserver.IAutoArchiverPolicy`. All properties starting with `policy.` specifying the policy further.
fully-qualified name of a Java class
implementing` ch.systemsx.cisd.etlserver.IAutoArchiverPolicy`. All
properties starting with `policy.` specifying the policy further.
**Description**: Policy which tries to find a group of data sets with a
**Description**: Policy which tries to find a group of data sets with a total size from a specified interval. This is important in case of [Multi Data Set Archiving](/display/openBISDoc2010/Multi+data+set+archiving). Grouping can be defined by space, project, experiment, sample, data set type or a combination of those. Groups can be merged if they are too small. Several grouping keys can be specified.
total size from a specified interval. This is important in case of
can be defined by space, project, experiment, sample, data set type or a
combination of those. Groups can be merged if they are too small.
Several grouping keys can be specified.
Searching for an appropriate group of data sets for auto archiving is
Searching for an appropriate group of data sets for auto archiving is logged. If no group could be found an admin is notified via email (email address specified in `log.xml`). The email contains the searching log.
logged. If no group could be found an admin is notified via email (email
address specified in `log.xml`). The email contains the searching log.
**Configuration**:
**Configuration**:
...
@@ -84,14 +52,17 @@ address specified in `log.xml`). The email contains the searching log.
...
@@ -84,14 +52,17 @@ address specified in `log.xml`). The email contains the searching log.
**plugin.properties**
**plugin.properties**
class = ch.systemsx.cisd.etlserver.plugins.AutoArchiverTask
```
interval = 10 days
class = ch.systemsx.cisd.etlserver.plugins.AutoArchiverTask
