Newer
Older
|`WRITE_DATASET` | |`SPACE_POWER_USER` | |
|`WRITE_DATASET_PROPERTIES` | |`SPACE_USER` | |
|`DELETE_DATASET` | |`SPACE_POWER_USER` | |
|`WRITE_EXPERIMENT_SAMPLE` | |`SPACE_USER` | |
|`WRITE_EXPERIMENT_ATTACHMENT` | |`SPACE_USER` | |
|`WRITE_EXPERIMENT_PROPERTIES` | |`SPACE_USER` | |
|`DELETE_EXPERIMENT` | |`SPACE_POWER_USER` | |
|`WRITE_SAMPLE` | |`SPACE_USER` | |
|`WRITE_SAMPLE_ATTACHMENT` | |`SPACE_USER` | |
|`WRITE_SAMPLE_PROPERTIES` | |`SPACE_USER` | |
|`DELETE_SAMPLE` | |`SPACE_POWER_USER` | |
|`DELETE_SAMPLE_ATTACHMENT` | |`SPACE_POWER_USER` | |
|`WRITE_DATASET` | |`SPACE_POWER_USER` | |
|`WRITE_DATASET_PROPERTIES` | |`SPACE_USER` | |
|`DELETE_DATASET` | |`SPACE_POWER_USER` |Delete datasets (this capability IS NOT enough to delete datasets with deletion_disallow flag set to true in their type - see `FORCE_DELETE_DATASET`) |
|`FORCE_DELETE_DATASET` | |`INSTANCE_DISABLED` |Delete datasets (this capability IS enough to delete datasets with deletion_disallow flag set to true in their type - see `DELETE_DATASET`) |
|`ARCHIVE_DATASET` | |`SPACE_POWER_USER` |Move dataset from data store into archive |
|`UNARCHIVE_DATASET` | |`SPACE_USER` |Copy back dataset from archive to data store |
|`LOCK_DATA_SETS` | |`SPACE_ADMIN` |Prevent data sets from being archived |
|`UNLOCK_DATA_SETS` | |`SPACE_ADMIN` |Release locked data sets |
|`WRITE_EXPERIMENT_SAMPLE_MATERIAL`| |`INSTANCE_ADMIN` |Registration / update of experiments, samples and materials in one go |
|`REGISTER_SPACE` | |`SPACE_ADMIN` |The user will become space admin of the freshly created space |
|`DELETE_SPACE` | |`SPACE_ADMIN` | |
|`UPDATE_SPACE` | |`SPACE_ADMIN` | |
|`REGISTER_PROJECT` | |`SPACE_POWER_USER` | |
|`WRITE_PROJECT` | |`SPACE_POWER_USER` | |
|`WRITE_SAMPLE_ATTACHMENT` | |`SPACE_POWER_USER` | |
|`DELETE_PROJECT` | |`SPACE_POWER_USER` | |
|`WRITE_PROJECT_ATTACHMENT` | |`SPACE_POWER_USER` | |
|`REGISTER_VOCABULARY` | |`INSTANCE_ADMIN` | |
|`WRITE_VOCABULARY` | |`INSTANCE_ADMIN` | |
|`DELETE_VOCABULARY` | |`INSTANCE_ADMIN` | |
|`WRITE_VOCABULARY_TERM` | |`SPACE_POWER_USER` | |
|`WRITE_UNOFFICIAL_VOCABULARY_TERM`| |`SPACE_USER` | |
|`PURGE` | |`SPACE_ADMIN` |Permanently delete experiments, samples and datasets in the trashcan (this capability IS NOT enough to delete datasets with deletion_disallow flag set to true in their type - see `FORCE_PURGE`)|
|`FORCE_PURGE` | |`INSTANCE_DISABLED` |Permanently delete experiments, samples and datasets in the trashcan (this capability IS enough to delete datasets with deletion_disallow flag set to true in their type - see `PURGE`) |
|`RESTORE` | |`SPACE_USER` |Get back experiments, samples and datasets from the trashcan |
|`ASSIGN_EXPERIMENT_TO_PROJECT` | |`SPACE_POWER_USER`, `SPACE_ETL_SERVER` | |
|`ASSIGN_PROJECT_TO_SPACE` | |`SPACE_POWER_USER`, `SPACE_ETL_SERVER` | |
|`ASSIGN_SAMPLE_TO_EXPERIMENT` | |`SPACE_POWER_USER`, `SPACE_ETL_SERVER`|Re-assign a sample to a new experiment (called in 'register experiment', 'update experiment', 'update sample'') |
|`UNASSIGN_SAMPLE_FROM_EXPERIMENT` | |`SPACE_POWER_USER`, `SPACE_ETL_SERVER`| |
|`ASSIGN_SAMPLE_TO_SPACE` | |`SPACE_POWER_USER`, `SPACE_ETL_SERVER` |Re-assign a sample to a new space (called in 'update sample') |
|`ASSIGN_DATASET_TO_EXPERIMENT` | |`SPACE_POWER_USER`, `SPACE_ETL_SERVER` | |
|`ASSIGN_DATASET_TO_SAMPLE` | |`SPACE_POWER_USER`, `SPACE_ETL_SERVER` | |
|`SHARE_SAMPLE` | |`INSTANCE_ADMIN`, `INSTANCE_ETL_SERVER`| |
|`UNSHARE_SAMPLE` | |`INSTANCE_ADMIN`, `INSTANCE_ETL_SERVER`| |
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
|`ADD_PARENT_TO_SAMPLE` | |`SPACE_USER`, `SPACE_ETL_SERVER` | |
|`ADD_PARENT_TO_SAMPLE` |SAMPLE |`SPACE_USER`, `SPACE_ETL_SERVER` | |
|`ADD_PARENT_TO_SAMPLE` |PARENT |`SPACE_USER`, `SPACE_ETL_SERVER` | |
|`REMOVE_PARENT_FROM_SAMPLE` | |`SPACE_POWER_USER`, `SPACE_ETL_SERVER` | |
|`REMOVE_PARENT_FROM_SAMPLE` |SAMPLE |`SPACE_POWER_USER`, `SPACE_ETL_SERVER` | |
|`REMOVE_PARENT_FROM_SAMPLE` |PARENT |`SPACE_USER`, `SPACE_ETL_SERVER` | |
|`ADD_CONTAINER_TO_SAMPLE` | |`SPACE_POWER_USER`, `SPACE_ETL_SERVER` | |
|`REMOVE_CONTAINER_FROM_SAMPLE` | |`SPACE_POWER_USER`, `SPACE_ETL_SERVER` | |
|`ADD_PARENT_TO_DATASET` | |`SPACE_POWER_USER`, `SPACE_ETL_SERVER` | |
|`REMOVE_PARENT_FROM_DATASET` | |`SPACE_POWER_USER`, `SPACE_ETL_SERVER` | |
|`ADD_CONTAINER_TO_DATASET` | |`SPACE_POWER_USER`, `SPACE_ETL_SERVER` | |
|`REMOVE_CONTAINER_FROM_DATASET` | |`SPACE_POWER_USER`, `SPACE_ETL_SERVER` | |
|`ASSIGN_ROLE_TO_SPACE_VIA_DSS` | |`SPACE_ADMIN, `INSTANCE_ETL_SERVER` | |
|`CREATE_SPACES_VIA_DSS` | |`SPACE_ADMIN, `INSTANCE_ETL_SERVER` | |
|`CREATE_PROJECTS_VIA_DSS` | |`SPACE_POWER_USER`, `SPACE_ETL_SERVER` | |
|`UPDATE_PROJECTS_VIA_DSS` | |`SPACE_POWER_USER`, `SPACE_ETL_SERVER` | |
|`CREATE_EXPERIMENTS_VIA_DSS` | |`SPACE_USER`, `SPACE_ETL_SERVER` | |
|`UPDATE_EXPERIMENTS_VIA_DSS` | |`SPACE_USER`, `SPACE_ETL_SERVER` | |
|`CREATE_SPACE_SAMPLES_VIA_DSS` | |`SPACE_USER`, `SPACE_ETL_SERVER` | |
|`UPDATE_SPACE_SAMPLES_VIA_DSS` | |`SPACE_USER`, `SPACE_ETL_SERVER` | |
|`CREATE_INSTANCE_SAMPLES_VIA_DSS` | |`INSTANCE_ETL_SERVER` | |
|`UPDATE_INSTANCE_SAMPLES_VIA_DSS` | |`INSTANCE_ETL_SERVER` | |
|`CREATE_MATERIALS_VIA_DSS` | |`INSTANCE_ETL_SERVER` | |
|`UPDATE_MATERIALS_VIA_DSS` | |`INSTANCE_ETL_SERVER` | |
|`CREATE_DATA_SETS_VIA_DSS` | |`SPACE_USER`, `SPACE_ETL_SERVER` | |
|`UPDATE_DATA_SETS_VIA_DSS` | |`SPACE_POWER_USER`, `SPACE_ETL_SERVER` | |
|`SEARCH_ON_BEHALF_OF_USER` | |`INSTANCE_OBSERVER` |All search or list operations being performed on behalf of another user. Supposed to be used by a service user for server-to-server communication tasks. |
1075
1076
1077
1078
1079
1080
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
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
Older versions of openBIS used to allow changing entity relationships to
regular `SPACE_USER`. If you want to get this behavior back, put these
lines into `etc/capabilities`:
ASSIGN_EXPERIMENT_TO_PROJECT: SPACE_USER
ASSIGN_EXPERIMENT_TO_PROJECT: SPACE_ETL_SERVER
ASSIGN_SAMPLE_TO_EXPERIMENT: SPACE_USER
ASSIGN_SAMPLE_TO_EXPERIMENT: SPACE_ETL_SERVER
UNASSIGN_SAMPLE_FROM_EXPERIMENT: SPACE_USER
UNASSIGN_SAMPLE_FROM_EXPERIMENT: SPACE_ETL_SERVER
ASSIGN_SAMPLE_TO_SPACE: SPACE_USER
ASSIGN_SAMPLE_TO_SPACE: SPACE_ETL_SERVER
ASSIGN_DATASET_TO_EXPERIMENT: SPACE_USER
ASSIGN_DATASET_TO_EXPERIMENT: SPACE_ETL_SERVER
ASSIGN_DATASET_TO_SAMPLE: SPACE_USER
ASSIGN_DATASET_TO_SAMPLE: SPACE_ETL_SERVER
ADD_PARENT_TO_SAMPLE: SPACE_USER
ADD_PARENT_TO_SAMPLE: SPACE_ETL_SERVER
REMOVE_PARENT_FROM_SAMPLE: SPACE_USER
REMOVE_PARENT_FROM_SAMPLE: SPACE_ETL_SERVER
ADD_CONTAINER_TO_SAMPLE: SPACE_USER
ADD_CONTAINER_TO_SAMPLE: SPACE_ETL_SERVER
REMOVE_CONTAINER_FROM_SAMPLE: SPACE_USER
REMOVE_CONTAINER_FROM_SAMPLE: SPACE_ETL_SERVER
ADD_PARENT_TO_DATASET: SPACE_USER
ADD_PARENT_TO_DATASET: SPACE_ETL_SERVER
REMOVE_PARENT_FROM_DATASET: SPACE_USER
REMOVE_PARENT_FROM_DATASET: SPACE_ETL_SERVER
ADD_CONTAINER_TO_DATASET: SPACE_USER
ADD_CONTAINER_TO_DATASET: SPACE_ETL_SERVER
REMOVE_CONTAINER_FROM_DATASET: SPACE_USER
REMOVE_CONTAINER_FROM_DATASET: SPACE_ETL_SERVER
#### Capability Role Map for V3 API
| Method of IApplicationServerApi | Default Roles | Capability |
|------------------------------------------|---------------------------------------------------|-----------------------------------|
| archiveDataSets | PROJECT_POWER_USER, SPACE_ETL_SERVER | ARCHIVE_DATASET |
| confirmDeletions, forceDeletion == false | PROJECT_ADMIN, SPACE_ETL_SERVER | CONFIRM_DELETION |
| confirmDeletions, forceDeletion == true | disabled | CONFIRM_DELETION_FORCED |
| createAuthorizationGroups | INSTANCE_ADMIN | CREATE_AUTHORIZATION_GROUP |
| createCodes | PROJECT_USER, SPACE_ETL_SERVER | CREATE_CODES |
| createDataSetTypes | INSTANCE_ADMIN, INSTANCE_ETL_SERVER | CREATE_DATASET_TYPE |
| createDataSets | PROJECT_USER, SPACE_ETL_SERVER | CREATE_DATASET |
| createExperimentTypes | INSTANCE_ADMIN, INSTANCE_ETL_SERVER | CREATE_EXPERIMENT_TYPE |
| createExperiments | PROJECT_USER, SPACE_ETL_SERVER | CREATE_EXPERIMENT |
| createExternalDataManagementSystems | INSTANCE_ADMIN | CREATE_EXTERNAL_DMS |
| createMaterialTypes | INSTANCE_ADMIN, INSTANCE_ETL_SERVER | CREATE_MATERIAL_TYPE |
| createMaterials | INSTANCE_ADMIN, INSTANCE_ETL_SERVER | CREATE_MATERIAL |
| createPermIdStrings | PROJECT_USER, SPACE_ETL_SERVER | CREATE_PERM_IDS |
| createPersons | INSTANCE_ADMIN | CREATE_PERSON |
| createPlugins | INSTANCE_ADMIN | CREATE_PLUGIN |
| createProjects | SPACE_POWER_USER, SPACE_ETL_SERVER | CREATE_PROJECT |
| createPropertyTypes | INSTANCE_ADMIN | CREATE_PROPERTY_TYPE |
| createQueries | PROJECT_OBSERVER, SPACE_ETL_SERVER | CREATE_QUERY |
| createRoleAssignments, instance role | INSTANCE_ADMIN | CREATE_INSTANCE_ROLE |
| createRoleAssignments, space role | SPACE_ADMIN | CREATE_SPACE_ROLE |
| createRoleAssignments, project role | PROJECT_ADMIN | CREATE_PROJECT_ROLE |
| createSampleTypes | INSTANCE_ADMIN, INSTANCE_ETL_SERVER | CREATE_SAMPLE_TYPE |
| createSamples | PROJECT_USER, SPACE_ETL_SERVER | CREATE_SAMPLE |
| createSemanticAnnotations | INSTANCE_ADMIN, INSTANCE_ETL_SERVER | CREATE_SEMANTIC_ANNOTATION |
| createSpaces | SPACE_ADMIN, SPACE_ETL_SERVER | CREATE_SPACE |
| createTags | PROJECT_OBSERVER, SPACE_ETL_SERVER | CREATE_TAG |
| createVocabularies | INSTANCE_ADMIN | CREATE_VOCABULARY |
| createVocabularyTerms, official terms | PROJECT_POWER_USER, SPACE_ETL_SERVER | CREATE_OFFICIAL_VOCABULARY_TERM |
| createVocabularyTerms, unofficial terms | PROJECT_USER, SPACE_ETL_SERVER | CREATE_UNOFFICIAL_VOCABULARY_TERM |
| deleteAuthorizationGroups | INSTANCE_ADMIN | DELETE_AUTHORIZATION_GROUP |
| deleteDataSetTypes | INSTANCE_ADMIN | DELETE_DATASET_TYPE |
| deleteDataSets | PROJECT_POWER_USER, SPACE_ETL_SERVER | DELETE_DATASET |
| deleteExperimentTypes | INSTANCE_ADMIN | DELETE_EXPERIMENT_TYPE |
| deleteExperiments | PROJECT_POWER_USER, SPACE_ETL_SERVER | DELETE_EXPERIMENT |
| deleteExternalDataManagementSystems | INSTANCE_ADMIN | DELETE_EXTERNAL_DMS |
| deleteMaterialTypes | INSTANCE_ADMIN | DELETE_MATERIAL_TYPE |
| deleteMaterials | INSTANCE_ADMIN, INSTANCE_ETL_SERVER | DELETE_MATERIAL |
| deleteOperationExecutions | PROJECT_USER, SPACE_ETL_SERVER | DELETE_OPERATION_EXECUTION |
| deletePlugins | INSTANCE_ADMIN | DELETE_PLUGIN |
| deleteProjects | SPACE_POWER_USER, PROJECT_ADMIN, SPACE_ETL_SERVER | DELETE_PROJECT |
| deletePropertyTypes | INSTANCE_ADMIN | DELETE_PROPERTY_TYPE |
| deleteQueries | PROJECT_OBSERVER, SPACE_ETL_SERVER | DELETE_QUERY |
| deleteRoleAssignments, instance role | INSTANCE_ADMIN | DELETE_INSTANCE_ROLE |
| deleteRoleAssignments, space role | SPACE_ADMIN | DELETE_SPACE_ROLE |
| deleteRoleAssignments, project role | PROJECT_ADMIN | DELETE_PROJECT_ROLE |
| deleteSampleTypes | INSTANCE_ADMIN | DELETE_SAMPLE_TYPE |
| deleteSamples | PROJECT_POWER_USER, SPACE_ETL_SERVER | DELETE_SAMPLE |
| deleteSemanticAnnotations | INSTANCE_ADMIN, INSTANCE_ETL_SERVER | DELETE_SEMANTIC_ANNOTATION |
| deleteSpaces | SPACE_ADMIN, SPACE_ETL_SERVER | DELETE_SPACE |
| deleteTags | PROJECT_OBSERVER, SPACE_ETL_SERVER | DELETE_TAG |
| deleteVocabularies | INSTANCE_ADMIN | DELETE_VOCABULARY |
| deleteVocabularyTerms | PROJECT_POWER_USER, SPACE_ETL_SERVER | DELETE_VOCABULARY_TERM |
| executeAggregationService | PROJECT_OBSERVER | EXECUTE_AGGREGATION_SERVICES |
| executeCustomASService | PROJECT_OBSERVER, SPACE_ETL_SERVER | EXECUTE_CUSTOM_AS_SERVICE |
| executeProcessingService | PROJECT_USER | EXECUTE_PROCESSING_SERVICES |
| executeQuery | PROJECT_OBSERVER, SPACE_ETL_SERVER | EXECUTE_QUERY |
| executeReportingService | PROJECT_OBSERVER | EXECUTE_REPORTING_SERVICES |
| executeSearchDomainService | PROJECT_OBSERVER | EXECUTE_SEARCH_DOMAIN_SERVICES |
| executeSql | PROJECT_OBSERVER, SPACE_ETL_SERVER | EXECUTE_QUERY |
| getAuthorizationGroups | PROJECT_ADMIN | GET_AUTHORIZATION_GROUP |
| getDataSetTypes | PROJECT_OBSERVER, SPACE_ETL_SERVER | GET_DATASET_TYPE |
| getDataSets | PROJECT_OBSERVER, SPACE_ETL_SERVER | GET_DATASET |
| getExperimentTypes | PROJECT_OBSERVER, SPACE_ETL_SERVER | GET_EXPERIMENT_TYPE |
| getExperiments | PROJECT_OBSERVER, SPACE_ETL_SERVER | GET_EXPERIMENT |
| getExternalDataManagementSystems | PROJECT_OBSERVER, SPACE_ETL_SERVER | GET_EXTERNAL_DMS |
| getMaterialTypes | PROJECT_OBSERVER, SPACE_ETL_SERVER | GET_MATERIAL_TYPE |
| getMaterials | PROJECT_OBSERVER, SPACE_ETL_SERVER | GET_MATERIAL |
| getOperationExecutions | PROJECT_USER, SPACE_ETL_SERVER | GET_OPERATION_EXECUTION |
| getPersons | PROJECT_OBSERVER, SPACE_ETL_SERVER | GET_PERSON |
| getPlugins | PROJECT_OBSERVER, SPACE_ETL_SERVER | GET_PLUGIN |
| getProjects | PROJECT_OBSERVER, SPACE_ETL_SERVER | GET_PROJECT |
| getPropertyTypes | PROJECT_OBSERVER, SPACE_ETL_SERVER | GET_PROPERTY_TYPE |
| getQueries | PROJECT_OBSERVER, SPACE_ETL_SERVER | GET_QUERY |
| getRoleAssignments | PROJECT_ADMIN | GET_ROLE_ASSIGNMENT |
| getSampleTypes | PROJECT_OBSERVER, SPACE_ETL_SERVER | GET_SAMPLE_TYPE |
| getSamples | PROJECT_OBSERVER, SPACE_ETL_SERVER | GET_SAMPLE |
| getSemanticAnnotations | PROJECT_OBSERVER, SPACE_ETL_SERVER | GET_SEMANTIC_ANNOTATION |
| getSessionInformation | PROJECT_OBSERVER, SPACE_ETL_SERVER | GET_SESSION |
| getSpaces | PROJECT_OBSERVER, SPACE_ETL_SERVER | GET_SPACE |
| getTags | PROJECT_OBSERVER, SPACE_ETL_SERVER | GET_TAG |
| getVocabularies | PROJECT_OBSERVER, SPACE_ETL_SERVER | GET_VOCABULARY |
| getVocabularyTerms | PROJECT_OBSERVER, SPACE_ETL_SERVER | GET_VOCABULARY_TERM |
| lockDataSets | PROJECT_ADMIN | LOCK_DATASET |
| revertDeletions | PROJECT_USER, SPACE_ETL_SERVER | REVERT_DELETION |
| searchAggregationServices | PROJECT_OBSERVER | SEARCH_AGGREGATION_SERVICES |
| searchAuthorizationGroups | PROJECT_ADMIN | SEARCH_AUTHORIZATION_GROUP |
| searchCustomASServices | PROJECT_OBSERVER, SPACE_ETL_SERVER | SEARCH_CUSTOM_AS_SERVICES |
| searchDataSetTypes | PROJECT_OBSERVER, SPACE_ETL_SERVER | SEARCH_DATASET_TYPE |
| searchDataSets | PROJECT_OBSERVER, SPACE_ETL_SERVER | SEARCH_DATASET |
| searchDataStores | PROJECT_OBSERVER, SPACE_ETL_SERVER | SEARCH_DATASTORE |
| searchDeletions | PROJECT_USER, SPACE_ETL_SERVER | SEARCH_DELETION |
| searchExperimentTypes | PROJECT_OBSERVER, SPACE_ETL_SERVER | SEARCH_EXPERIMENT_TYPE |
| searchExperiments | PROJECT_OBSERVER, SPACE_ETL_SERVER | SEARCH_EXPERIMENT |
| searchExternalDataManagementSystems | PROJECT_OBSERVER, SPACE_ETL_SERVER | SEARCH_EXTERNAL_DMS |
| searchGlobally | PROJECT_OBSERVER, SPACE_ETL_SERVER | SEARCH_GLOBALLY |
| searchMaterialTypes | PROJECT_OBSERVER, SPACE_ETL_SERVER | SEARCH_MATERIAL_TYPE |
| searchMaterials | PROJECT_OBSERVER, SPACE_ETL_SERVER | SEARCH_MATERIAL |
| searchObjectKindModifications | PROJECT_OBSERVER, SPACE_ETL_SERVER | SEARCH_OBJECT_KIND_MODIFICATION |
| searchOperationExecutions | PROJECT_USER, SPACE_ETL_SERVER | GET_OPERATION_EXECUTION |
| searchPersons | PROJECT_OBSERVER, SPACE_ETL_SERVER | GET_PERSON |
| searchPlugins | PROJECT_OBSERVER, SPACE_ETL_SERVER | SEARCH_PLUGIN |
| searchProcessingServices | PROJECT_OBSERVER | SEARCH_PROCESSING_SERVICES |
| searchProjects | PROJECT_OBSERVER, SPACE_ETL_SERVER | SEARCH_PROJECT |
| searchPropertyTypes | PROJECT_OBSERVER, SPACE_ETL_SERVER | SEARCH_PROPERTY_TYPE |
| searchQueries | PROJECT_OBSERVER, SPACE_ETL_SERVER | SEARCH_QUERY |
| searchReportingServices | PROJECT_OBSERVER | SEARCH_REPORTING_SERVICES |
| searchRoleAssignments | PROJECT_ADMIN | SEARCH_ROLE_ASSIGNMENT |
| searchSampleTypes | PROJECT_OBSERVER, SPACE_ETL_SERVER | SEARCH_SAMPLE_TYPE |
| searchSamples | PROJECT_OBSERVER, SPACE_ETL_SERVER | SEARCH_SAMPLE |
| searchSearchDomainServices | PROJECT_OBSERVER | SEARCH_SEARCH_DOMAIN_SERVICES |
| searchSemanticAnnotations | PROJECT_OBSERVER, SPACE_ETL_SERVER | SEARCH_SEMANTIC_ANNOTATION |
| searchSpaces | PROJECT_OBSERVER, SPACE_ETL_SERVER | SEARCH_SPACE |
| searchTags | PROJECT_OBSERVER, SPACE_ETL_SERVER | SEARCH_TAG |
| searchVocabularies | PROJECT_OBSERVER, SPACE_ETL_SERVER | SEARCH_VOCABULARY |
| searchVocabularyTerms | PROJECT_OBSERVER, SPACE_ETL_SERVER | SEARCH_VOCABULARY_TERM |
| unarchiveDataSets | PROJECT_USER, SPACE_ETL_SERVER | UNARCHIVE_DATASET |
| unlockDataSets | PROJECT_ADMIN | UNLOCK_DATASET |
| updateAuthorizationGroups | INSTANCE_ADMIN | UPDATE_AUTHORIZATION_GROUP |
| updateDataSetTypes | INSTANCE_ADMIN | UPDATE_DATASET_TYPE |
| updateDataSets | PROJECT_POWER_USER, SPACE_ETL_SERVER | UPDATE_DATASET |
| updateDataSets, properties | PROJECT_POWER_USER, SPACE_ETL_SERVER | UPDATE_DATASET_PROPERTY |
| updateExperimentTypes | INSTANCE_ADMIN | UPDATE_EXPERIMENT_TYPE |
| updateExperiments | PROJECT_USER, SPACE_ETL_SERVER | UPDATE_EXPERIMENT |
| updateExperiments, attachments | PROJECT_USER, SPACE_ETL_SERVER | UPDATE_EXPERIMENT_ATTACHMENT |
| updateExperiments, properties | PROJECT_USER, SPACE_ETL_SERVER | UPDATE_EXPERIMENT_PROPERTY |
| updateExternalDataManagementSystems | INSTANCE_ADMIN | UPDATE_EXTERNAL_DMS |
| updateMaterialTypes | INSTANCE_ADMIN | UPDATE_MATERIAL_TYPE |
| updateMaterials | INSTANCE_ADMIN, INSTANCE_ETL_SERVER | UPDATE_MATERIAL |
| updateMaterials, properties | INSTANCE_ADMIN, INSTANCE_ETL_SERVER | UPDATE_MATERIAL_PROPERTY |
| updateOperationExecutions | PROJECT_USER, SPACE_ETL_SERVER | UPDATE_OPERATION_EXECUTION |
| updatePersons, activate | INSTANCE_ADMIN | ACTIVATE_PERSON |
| updatePersons, deactivate | INSTANCE_ADMIN | DEACTIVATE_PERSON |
| updatePersons, set home space | SPACE_ADMIN | UPDATE_HOME_SPACE |
| updatePlugins | INSTANCE_ADMIN | UPDATE_PLUGIN |
| updateProjects | SPACE_POWER_USER, PROJECT_ADMIN, SPACE_ETL_SERVER | UPDATE_PROJECT |
| updateProjects, attachments | SPACE_POWER_USER, PROJECT_ADMIN, SPACE_ETL_SERVER | UPDATE_PROJECT_ATTACHMENT |
| updatePropertyTypes | INSTANCE_ADMIN | UPDATE_PROPERTY_TYPE |
| updateQueries | PROJECT_OBSERVER, SPACE_ETL_SERVER | UPDATE_QUERY |
| updateSampleTypes | INSTANCE_ADMIN | UPDATE_SAMPLE_TYPE |
| updateSamples | PROJECT_USER, SPACE_ETL_SERVER | UPDATE_SAMPLE |
| updateSamples, attachments | PROJECT_USER, SPACE_ETL_SERVER | UPDATE_SAMPLE_ATTACHMENT |
| updateSamples, properties | PROJECT_USER, SPACE_ETL_SERVER | UPDATE_SAMPLE_PROPERTY |
| updateSemanticAnnotations | INSTANCE_ADMIN, INSTANCE_ETL_SERVER | UPDATE_SEMANTIC_ANNOTATION |
| updateSpaces | SPACE_ADMIN, SPACE_ETL_SERVER | UPDATE_SPACE |
| updateTags | PROJECT_OBSERVER, SPACE_ETL_SERVER | UPDATE_TAG |
| updateVocabularies | INSTANCE_ADMIN | UPDATE_VOCABULARY |
| updateVocabularyTerms, official terms | PROJECT_POWER_USER, SPACE_ETL_SERVER | UPDATE_OFFICIAL_VOCABULARY_TERM |
| updateVocabularyTerms, unofficial terms | PROJECT_USER, SPACE_ETL_SERVER | UPDATE_UNOFFICIAL_VOCABULARY_TERM |
### Querying Project Database
In some customized versions of openBIS an additional project-specific
database is storing data from registered data sets. This database can be
queried via SQL Select statements in openBIS Web application. In order
to protect modification of this database by malicious SQL code openBIS
application server should access this database as a user which is member
of a read-only group. The name of this read-only group is project
specific.
```{note}
It is possible to configure openBIS to query multiple project-specific databases.
```
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
#### Create Read-Only User in PostgreSQL
A new user (aka role) is created by
CREATE ROLE <read-only user> LOGIN NOSUPERUSER INHERIT NOCREATEDB NOCREATEROLE;
This new user is added to the read-only group by the following command:
GRANT <read-only group> TO <read-only user>;
The name of the read-only group can be obtained by having a look into
the list of all groups:
SELECT * from PG_GROUP;
*Note that by default openBIS creates a user* ` openbis_readonly `
*which has read-only permissions to all database objects. You can use
this user to access the openBIS meta database through the openBIS query
interface.*
#### Enable Querying
To enable querying functionality for additional databases in openBIS Web
application a [core plugin](/display/openBISDoc2010/Core+Plugins) of
type query-databases has to be created. The following
`plugin.properties` have to be specified:
| Property | Description |
|-------------------|---------------------------------------------------------------------------------------------------------------------------|
| label | Label of the database. It will be used in the Web application in drop down lists for adding / editing customized queries. |
| database-driver | JDBC Driver of the database, e.g. org.postgresql.Driver for postgresql. |
| database-url | JDBC URL to the database containing full database name, e.g. jdbc:postgresql://localhost/database_name for postgresql |
| database-username | Above-mentioned defined read-only user. |
| database-password | Password of the read-only user. |
#### Configure Authorization
In order to configure authorization two additional properties can be
configured:
| Property | Description |
|---------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| <database>.data-space | To which data-space this database belongs to (optional, i.e. a query database can be configured not to belong to one data space by leaving this configuration value empty). |
| <database>.creator-minimal-role | What role is required to be allowed to create / edit queries on this database (optional, default: INSTANCE_OBSERVER if data-space is not set, POWER_USER otherwise). |
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
The given parameters data-space and creator-minimal-role are used by
openBIS to enforce proper authorization.
For example, if
data-space = CISD
creator-minimal-role = SPACE_ADMIN
is configured, then for the query database configured with key `db1`:
- only a `SPACE_ADMIN` on data space `CISD` and an `INSTANCE_ADMIN`
are allowed to create / edit queries,
- only a user who has the `OBSERVER` role in data space `CISD` is
allowed to execute a query.
For query databases that do not belong to a space but that have a column
with any of the [magic column
names](/display/openBISDoc2010/Custom+Database+Queries#CustomDatabaseQueries-Hyperlinks),
the query result is filtered on a per-row basis according to what the
user executing the query is allowed to see. In detail this means: if the
user executing the query is not an instance admin, filter out all rows
which belong to a data space where the user doesn't have a least the
observer role. The relationship between a row and a data space is
established by means of the experiment / sample / data set whose
`permId` is given by one of the magical column names.
For sensitive data where authorization needs to be enforced, there are
two setups possible:
1. Configure a query database that **does not** belong to a data space
and set the creator-minimal-role to `INSTANCE_ADMIN`. Any instance
admin can be trusted to understand authorization issues and ensure
that only queries are added for this query database that contain a
proper reference to an experiment / sample / data set. This way, it
can be ensured that only properly filtered query results are
returned to the user running the query.
2. Configure a query database that **does** belong to a specific data
space and set the creator-minimal-role to `POWER_USER`. The
datastore server (or whatever server maintains the query database)
ensures that only information related to the configured data space
is added to the query database. Thus whatever query the power user
writes for this database, it will only reveal information from this
data space. As only users with `OBSERVER` role on this data space
are allowed to execute the query, authorization is enforced properly
without the need of filtering query results.
### Master data import/export
The master data of openBIS comprises all entity/property types, property
assignments, vocabularies etc. needed for your customized installation
to work. The system offers a way to export/import master data via Jython
scripts. More information on how to do create such scripts and run them
manually see the advanced guide [Jython Master Data
Scripts](/display/openBISDoc2010/Jython+Master+Data+Scripts#JythonMasterDataScripts-Commandlinetools).
A master data script can be run automatically by start up of the AS if
it is defined in an AS core plugin. The script path should be
`<installation directory>/servers/core-plugins/<module name>/<version number>/as/initialize-master-data.py`.
For more details about the folder structure of core plugins see [Core
Plugins](/display/openBISDoc2010/Core+Plugins). If there are several
core plugins with master data scripts the scripts will be executed in
alphabetical order of the module names. For example, the master data
script of module `screening-optional` will be executed after the master
data script of module `screening` has been executed.
Execution of master data script can be suppressed by
disabling `initialize-master-data` core plugin. For more details see
[Core Plugins](/display/openBISDoc2010/Core+Plugins).
### Limit of open files
When putting a lot of files in a drop box you might run into the problem
of '`too many open files error`'. Please consider changing the ulimit
value (for RHEL6 edit `/etc/security/limits.conf` ) to a higher value.
### Runtime changes to logging
The
script `<installation directory>/servers/openBIS-server/jetty/bin/configure.sh `can
be used to change the logging behavior of openBIS application server
while the server is running.
The script is used like this: configure.sh \[command\] \[argument\]
The table below describes the possible commands and their arguments.
| Command | Argument(s) | Default Value | Description |
|--------------------------------------|--------------------------------------------------------|---------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| log-service-calls | 'on', 'off' | 'off' | Turns on / off detailed service call logging.
When this feature is enabled, openBIS will log about start and end of every service call it executes to file <installation directory>/servers/openBIS-server/jetty/log/openbis_service_calls.txt |
| log-long-running-invocations | 'on', 'off' | 'on' | Turns on / off logging of long running invocations.
When this feature is enabled, openBIS will periodically create a report of all service calls that have been in execution more than 15 seconds to file <installation directory>/servers/openBIS-server/jetty/log/openbis_long_running_threads.txt. |
| debug-db-connections | 'on', 'off' | 'off' | Turns on / off logging about database connection pool activity.
When this feature is enabled, information about every borrow and return to database connection pool is logged to openBIS main log in file <installation directory>/servers/openBIS-server/jetty/log/openbis_log.txt |
| log-db-connections | no argument / minimum connection age (in milliseconds) | 5000 | When this command is executed without an argument, information about every database connection that has been borrowed from the connection pool is written into openBIS main log in file <installation directory>/servers/openBIS-server/jetty/log/openbis_log.txt
If the "minimum connection age" argument is specified, only connections that have been out of the pool longer than the specified time are logged. The minimum connection age value is given in milliseconds. |
| record-stacktrace-db-connections | 'on', 'off' | 'off' | Turns on / off logging of stacktraces.
When this feature is enabled AND debug-db-connections is enabled, the full stack trace of the borrowing thread will be recorded with the connection pool activity logs. |
| log-db-connections-separate-log-file | 'on', 'off' | 'off' | Turns on / off database connection pool logging to separate file.
When this feature is disabled, the database connection pool activity logging is done only to openBIS main log. When this feature is enabled, the activity logging is done ALSO to file <installation directory>/servers/openBIS-server/jetty/log/openbis_db_connections.txt. |
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
### Deleted Entity History
Logging the history of deleted entities can be enabled / disabled in
service.properties using setting
entity-history.enabled = \[true | false\]
Since 20.10.1 the default value is true (meaning, entity history is
enabled). Before 20.10.1 the default value was false.
Deleted entity history can be queried with script show-history.sh, which
is located in $OPENBIS\_INSTALL\_DIR/bin
## Troubleshooting Problems
### Samples with datasets and no experiments
In the openBIS UI users could detach samples with container data sets
from the experiment. This bug was fix on version S176 released on 14 of
march of 2014.
The following SQL script lists all samples with data sets but no
experiments:
##
## SELECT SAMPLES WITH DATASETS AND NO EXPERIMENTS
##
SELECT s.id, d.expe_id from samples_all s join data_all d on (d.samp_id=s.id) where s.expe_id is null ORDER by s.id
If the last query shows no output the system is fine, if not, it can be
repaired with the following update query.
##
## FIX SAMPLES WITH DATASETS AND NO EXPERIMENTS ASSIGNING EXPERIMENT FROM DATASET
##
UPDATE samples_all
SET expe_id = subquery.expe_id
FROM (
SELECT s.id as samp_id, d.expe_id as expe_id from samples_all s join data_all d on (d.samp_id=s.id) where s.expe_id is null
) as subquery
where id = subquery.samp_id