Newer
Older
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
codes of new data sets are lexicographically smaller than the codes of
the old datasets. Deleting the file is also needed when pathinfo
database entries are added after a data set has been already processed
by the maintenance task.
**Configuration**:
| Property Key | Description |
|-----------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| last-seen-data-set-file | Path to a file that will store a code of the last handled data set. Default value: "fillUnknownDataSetSizeTaskLastSeen" |
| delete-last-seen-data-set-file-interval | A time interval (in seconds) which defines how often the "last-seen-data-set-file" file should be deleted. The parameter can be specified with one of the following time units: ms, msec, s, sec, m, min, h, hours, d, days . Default time unit is sec . Default value: 7 days. |
| data-set-chunk-size | Number of data sets requested from AS in one chunk. Default: 100 |
| time-limit | Limit of execution time of this task. The task is stopped before reading next chunk if the time has been used up. This parameter can be specified with one of the following time units: ms, msec, s, sec, m, min, h, hours, d, days. Default time unit is sec. |
**Example:**
**plugin.properties**
<task id>.class = ch.systemsx.cisd.etlserver.plugins.FillUnknownDataSetSizeInOpenbisDBFromPathInfoDBMaintenanceTask
<task id>.interval = 86400
<task id>.data-set-chunk-size = 1000
<task id>.time-limit = 1h
**NOTE**: Useful in scenarios where the path info feeding sub task of
post registration task fails.
### PathInfoDatabaseChecksumCalculationTask
**Environment**: DSS
**Relevancy:** Rare, often the CRC32 is calculated during the post
registration.
**Description**: Calculates the CRC32 checksum (and optionally a
checksum of specified type) of all files in the pathinfo database with
unknown checksum. This task is needed to run only once. It assumes a
data source for key 'path-info-db'.
**Configuration**:
| Property Key | Description |
|---------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| checksum-type | Optional checksum type. If specified two checksums are calculated: CRC32 checksum and the checksum of specified type. The type and the checksum are stored in the pathinfo database. An allowed type has to be supported by MessageDigest.getInstance(<checksum type>). For more details see http://docs.oracle.com/javase/8/docs/api/java/security/MessageDigest.html#getInstance-java.lang.String-. |
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
**Example**:
**plugin.properties**
class = ch.systemsx.cisd.etlserver.path.PathInfoDatabaseChecksumCalculationTask
execute-only-once = true
checksum-type = SHA-256
### PathInfoDatabaseRefreshingTask
**Environment**: DSS
**Relevancy:** Rare
**Description**: Refreshes the pathinfo database with file metadata of
physical and available data sets in the store. This task assumes a data
source with for 'path-info-db'.
The data sets are processed in the inverse order they are registered.
Only a maximum number of data sets are processed in one run. This is
specified by `chunk-size`.
> :warning:
> **Under normal circumstances this maintenance task is never needed, because the content of a physical data set is **never** changed by openBIS itself.<br /><br />Only in the rare cases that the content of physical data sets have to be changed this maintenance task allows to refresh the file meta data in the pathinfo database.**
**Configuration**:
| Property Key | Description |
|---------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| time-stamp-of-youngest-data-set | Time stamp of the youngest data set to be considered. The format has to be <4 digit year>-<month>-<day> <hour>:<minute>:<second>. |
| compute-checksum | If true the CRC32 checksum (and optionally a checksum of the type specified by checksum-type) of all files will be calculated and stored in pathinfo database. Default value: true |
| checksum-type | Optional checksum type. If specified and compute-checksum = true two checksums are calculated: CRC32 checksum and the checksum of specified type. The type and the checksum are stored in the pathinfo database. An allowed type has to be supported by MessageDigest.getInstance(<checksum type>). For more details see http://docs.oracle.com/javase/8/docs/api/java/security/MessageDigest.html#getInstance-java.lang.String-. |
| chunk-size | Number of data sets requested from AS in one chunk. Default: 1000 |
| data-set-type | Optional data set type. If specified, only data sets of the specified type are considered. Default: All data set types. |
| state-file | File to store registration time stamp and code of last considered data set. Default: <store root>/PathInfoDatabaseRefreshingTask-state.txt |
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
**Example**:
**plugin.properties**
class = ch.systemsx.cisd.etlserver.path.PathInfoDatabaseRefreshingTask
interval = 30 min
time-stamp-of-youngest-data-set = 2014-01-01 00:00:00
data-set-type = HCS_IMAGE
### RemoveUnusedUnofficialTermsMaintenanceTask
**Environment**: AS
**Relevancy:** Rare
**Description**: Removes unofficial unused vocabulary terms. For more
details about unofficial vocabulary terms see [Ad Hoc Vocabulary
Terms](/pages/viewpage.action?pageId=80699498).
**Configuration:**
| Property Key | Description |
|-----------------|-----------------------------------------------------------------------------------------------------------------------------|
| older-than-days | Unofficial terms are only deleted if they have been registered more than the specified number of days ago. Default: 7 days. |
**Example**:
**service.properties of AS**
<task id>.class = ch.systemsx.cisd.openbis.generic.server.task.RemoveUnusedUnofficialTermsMaintenanceTask
<task id>.interval = 86400
<task id>.older-than-days = 30
### ResetArchivePendingTask
**Environment**: DSS
**Relevancy:** Rare
**Description**: For each data set not present in archive and status
ARCHIVE\_PENDING the status will be set to AVAILABLE if there is no
command in the DSS data set command queues referring to it.
**Configuration**:
**plugin.properties**
class = ch.systemsx.cisd.etlserver.plugins.ResetArchivePendingTask
interval = 60 s
### SessionWorkspaceCleanUpMaintenanceTask
**Environment**: AS
**Relevancy:** Default
**Description**: Cleans up session workspace folders of no longer active
sessions. This maintenance plugin is automatically added by default with
a default interval of 1 hour. If a manually configured version of the
plugin is detected then the automatic configuration is skipped.
**Example**:
**plugin.properties**
class = ch.systemsx.cisd.openbis.generic.server.task.SessionWorkspaceCleanUpMaintenanceTask
interval = 1 day
### MaterialsMigration
**Environment**: AS
**Relevancy:** Relevant
**Description**: Migrates the Materials entities and types to use a
Sample based model using Sample Properties. It automatically creates and
assigns sample types, properties and entities.
It allows to execute the migration and to delete of the old Materials
model in separate steps.
Deleting Materials and material types requires the migration to have
been a success, before the deletion a validation check is run.
**Example**:
This maintenance task can be directly configured on the AS
service.properties
**service.properties**
maintenance-plugins = materials-migration
materials-migration.class = ch.systemsx.cisd.openbis.generic.server.task.MaterialsMigration
materials-migration.execute-only-once = true
materials-migration.doMaterialsMigrationInsertNew = true
materials-migration.doMaterialsMigrationDeleteOld = true
## Microscopy Maintenance Tasks
### MicroscopyThumbnailsCreationTask
**Environment**: DSS
**Relevancy:** Relevant
**Description**: Creates thumbnails for already registered microscopy
data sets.
**Configuration:**
| Property Key | Description |
|-------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| data-set-container-type | Type of the data set container. Default: MICROSCOPY_IMG_CONTAINER |
| data-set-thumbnail-type-regex | Regular expression for the type of data sets which have thumbnails. This is used to test whether there are already thumbnails or not. Default: MICROSCOPY_IMG_THUMBNAIL |
| main-data-set-type-regex | Regular expression for the type of data sets which have actual images. Default: MICROSCOPY_IMG |
| max-number-of-data-sets | The maximum number of data sets to be handle in a run of this task. If zero or less than zero all data sets will be handled. Default: 1000 |
| state-file | Name of the file which stores the registration time stamp of the last successfully handled data set. Default: MicroscopyThumbnailsCreationTask-state.txt |
| maximum-number-of-workers | If specified the creation will be parallelized among several workers. The actual number of workers depends on the number CPUs. There will be not more than 50% of CPUs used. |
| script-path | Path to the jython script which specifies the thumbnails to be generated. The script should have defined the method process(transaction, parameters, tablebuilder) as for JythonIngestionService (see Jython-based Reporting and Processing Plugins). Note, that tablebuilder will be ignored. In addition the global variables image_config and image_data_set_structure are defined:
image_data_set_structure: It is an object of the class ImageDataSetStructure. Information about channels, series numbers etc. can be requested.
image_config: It is an object of the class SimpleImageContainerDataConfig. It should be used to specify the thumbnails to be created. Currently only setImageGenerationAlgorithm() is supported.
|
**Example**:
**plugin.properties**
class = ch.systemsx.cisd.openbis.dss.etl.MicroscopyThumbnailsCreationTask
interval = 1 h
script-path = specify_thumbnail_generation.py
with
**specify\_thumbnail\_generation.py**
from ch.systemsx.cisd.openbis.dss.etl.dto.api.impl import MaximumIntensityProjectionGenerationAlgorithm
from sets import Set
def _get_series_num():
series_numbers = Set()
for image_info in image_data_set_structure.getImages():
series_numbers.add(image_info.tryGetSeriesNumber())
return series_numbers.pop()
def process(transaction, parameters, tableBuilder):
seriesNum = _get_series_num()
if int(seriesNum) % 2 == 0:
image_config.setImageGenerationAlgorithm(
MaximumIntensityProjectionGenerationAlgorithm(
"MICROSCOPY_IMG_THUMBNAIL", 256, 128, "thumbnail.png"))
### DeleteFromImagingDBMaintenanceTask
**Environment**: DSS
**Relevancy:** Relevant
**Description**: Deletes database entries from the imaging database.
This is special variant of
[DeleteFromExternalDBMaintenanceTask](#MaintenanceTasks-DeleteFromExternalDBMaintenanceTask)
with the same configuration parameters.
**Configuration**: See
[DeleteFromExternalDBMaintenanceTask](#MaintenanceTasks-DeleteFromExternalDBMaintenanceTask)
**Example**:
**plugin.properties**
class = ch.systemsx.cisd.openbis.dss.etl.DeleteFromImagingDBMaintenanceTask
data-source = imaging-db