Project

General

Profile

1 37584 alessia.ba
2
<head>
3
<!-- Start Styles. Move the 'style' tags and everything between them to between the 'head' tags -->
4
<style type="text/css">
5
.myTable { background-color:#eee;border-collapse:collapse; }
6
.myTable th { background-color:#000;color:white; }
7
.myTable td, .myTable th { padding:5px;border:1px solid #000; }
8
</style>
9
10
</head>
11 36918 alessia.ba
# Properties
12
13
This file contains the list of properties that can be set to configure a D-Net instance.
14
15
To get the list of currently used properties please go to the Admin UI of your running instance and select Configuration > Container Properties
16
17 37584 alessia.ba
## D-Net webapp properties
18
<table class="myTable">
19
<tr>
20
<th>Property name</th>
21
<th>Default value</th>
22
<th>Value type</th>
23
<th>Description</th>
24
</tr>
25
    <tr>
26
        <td>container.hostname</td>  <td>localhost</td> <td>String</td> <td>the host name where the web app will be running</td>
27
    </tr>
28
    <tr>
29
        <td>container.port</td>  <td>8280</td>  <td>int</td> <td>the port where the web app will be running</td>
30
    </tr>
31
    <tr>
32
        <td>container.context</td>  <td>app</td>  <td>String</td> <td>name of the web app</td>
33
    </tr>
34
    <tr>
35
        <td>dnet.data.path</td>  <td>/tmp/dnet</td>  <td>String</td> <td>path to the directory where all D-Net related resources will be saved.  An embedded existDB will be automatically installed in this directory during the first start-up. The directory must be writable by the user running tomcat.</td>
36
    </tr>
37
</table>
38 36918 alessia.ba
39 37584 alessia.ba
## D-Net properties for enabling services
40
41
### ResultSet Service
42
<table class="myTable">
43 36918 alessia.ba
<tr>
44
<th>Property name</th>
45
<th>Default value</th>
46 37584 alessia.ba
<th>Value type</th>
47 36918 alessia.ba
<th>Description</th>
48
</tr>
49
    <tr>
50 37584 alessia.ba
        <td>services.is.resultset.client.pagesize</td>  <td>10</td> <td>int</td> <td>Default number of records in each page of  result set</td>
51 36918 alessia.ba
    </tr>
52 37584 alessia.ba
     <tr>
53
        <td>services.is.resultset.push.maxElementsInMemory</td>  <td>500</td> <td>int</td> <td>Push resultset stores records temporary on a cache. This is the max number of records in memory. After this number they will be stored on disk</td>
54
    </tr>
55
     <tr>
56
        <td>services.is.resultset.push.maxElementsOnDisk</td>  <td>5000000</td> <td>int</td> <td>Push resultset stores records temporary on a cache. This is the max number of records in memory. After this number new records will override older records (those will be lost if not yet read)</td>
57
    </tr>
58
    <tr>
59
        <td>services.resultset.data.path</td>  <td>${dnet.data.path}/resultset</td> <td>String</td> <td>Path of the ResultSet cache (for Push ResultSet)</td>
60
    </tr>
61
     <tr>
62
        <td>services.is.resultset.push.timeToIdle</td>  <td>36000</td> <td>int</td> <td>Seconds before a push result set expires if no read/write operations are performed on it.</td>
63
    </tr>
64
     <tr>
65
        <td>services.is.resultset.resultSetRegistryCache.timeToIdle</td>  <td>240</td> <td>int</td> <td>Seconds before a result set expires if no read/write operations are performed on it.</td>
66
    </tr>
67
     <tr>
68
        <td>services.is.resultset.resultSetRegistryMaxIdleTimeCache.timeToIdle</td>  <td>240</td> <td>int</td> <td>Seconds before a result set expires if no read/write operations are performed on it.</td>
69
    </tr>
70 36918 alessia.ba
</table>
71
72 37584 alessia.ba
### IS Store Service
73
<table class="myTable">
74
<tr>
75
<th>Property name</th>
76
<th>Default value</th>
77
<th>Value type/ Allowed values</th>
78
<th>Description</th>
79
</tr>
80
    <tr>
81
        <td>services.is.store.database.bean</td>  <td>temporaryExistDatabase</td> <td>temporaryExistDatabase, persistentExistDatabase</td> <td>The D-Net Information Service manages the resources of the infrastructure that are described by XML profiles. Those profiles are stored in an embedded existdb. In dev mode you may want to use a non persistent store, while in prod mode you have to set this to 'persistentExistDatabase'</td>
82
    </tr>
83
    <tr>
84
        <td>services.is.store.bulk.validation</td>  <td>true</td> <td>boolean</td> <td>True to activate automatic XML validation of resource profiles upon registration</td>   </tr>
85
      <tr>
86
        <td>default.service.comparator</td>  <td>preferLocalRunningInstanceComparator</td>  <td>preferLocalRunningInstanceComparator</td> <td>Bean that selects a service instance among a set of services of the same type. Currently the only option is 'preferLocalRunningInstanceComparator', which prefers a service instance running on localhost.</td>
87
    </tr>
88
</table>
89 36918 alessia.ba
90 37584 alessia.ba
### Resource Registration
91
<table class="myTable">
92
<tr>
93
<th>Property name</th>
94
<th>Default value</th>
95
<th>Value type/ Allowed values</th>
96
<th>Description</th>
97
</tr>
98
    <tr>
99
        <td>services.schemas</td>  <td>classpath*:/eu/dnetlib/test/schemas/**/*.xsd</td> <td>String</td> <td>Classpath containing the XSD schemata of the resource profiles</td>
100
    </tr>
101
    <tr>
102
        <td>services.registration.disabled</td>  <td>false</td> <td>boolean</td> <td>True to prevent the registration of new services to the IS</td>   </tr>
103
      <tr>
104
        <td>default.service.comparator</td>  <td>preferLocalRunningInstanceComparator</td>  <td>preferLocalRunningInstanceComparator</td> <td>Bean that selects a service instance among a set of services of the same type. Currently the only option is 'preferLocalRunningInstanceComparator', which prefers a service instance running on localhost.</td>
105
    </tr>
106
107
</table>
108 36918 alessia.ba
109
110 37584 alessia.ba
# D-Net properties for access control
111
<table class="myTable">
112
<tr>
113
<th>Property name</th>
114
<th>Default value</th>
115
<th>Value type/ Allowed values</th>
116
<th>Description</th>
117
</tr>
118
    <tr>
119
        <td>dnet.modular.ui.authorization.default.superAdmin</td>  <td>admin</td>  <td>string</td> <td>Name of the admin user that can perform every operation via the D-Net admin UI</td>
120
    </tr>
121
    <tr>
122 38260 alessia.ba
        <td>dnet.admin.password</td>  <td>f98c5d6f0e68b251f78bffac722fd0b9 (dnet-minimal)</td> <td>md5(password)</td> <td>MD5 of the password for the user admin</td>
123 37584 alessia.ba
    </tr>
124
    <tr>
125
        <td>dnet.modular.ui.authorization.manager</td>  <td>simpleAuthenticationManager</td>  <td>simpleAuthenticationManager,mockUserAuthenticationManager</td> <td>Authorization Manager used by the D-Net admin UI</td>
126
    </tr>
127
    <tr>
128
        <td>dnet.modular.ui.authorization.dao</td>  <td>mongoAuthorizationDao</td>  <td>mongoAuthorizationDao</td> <td>name of the bean in charge of the authorization mechanism. mongoAuthorizationDao keeps authorization info about users in a mongodb server.</td>
129
    </tr>
130
    <tr>
131
        <td>dnet.modular.ui.authorization.mongo.host</td>  <td>localhost</td> <td>String</td> <td>host that runs a mongodb to be used for user authorization management</td>
132
    </tr>
133
    <tr>
134
        <td>dnet.modular.ui.authorization.mongo.port</td>  <td>27017</td> <td>int</td> <td>port of the mongodb server to be used for user authorization management</td>
135
    </tr>
136
    <tr>
137
        <td>dnet.modular.ui.authorization.mongo.db</td>  <td>dnet_auth</td> <td>String</td> <td>mongodb database to be used for user authorization management</td>
138
    </tr>
139
</table>
140
141
142
# D-Net properties for metadata collection
143
<table class="myTable">
144
<tr>
145
<th>Property name</th>
146
<th>Default value</th>
147
<th>Value type</th>
148
<th>Description</th>
149
</tr>
150
    <tr>
151
        <td>collector.oai.http.defaultDelay</td>  <td>120</td> <td>seconds</td> <td>Seconds to wait between two subsequent OAI-PMH ListRecord requests</td>
152
    </tr>
153
    <tr>
154
        <td>collector.oai.http.readTimeOut</td>  <td>120</td>  <td>int</td> <td>Seconds to wait for an OAI-PMH publisher response.</td>
155
    </tr>
156
    <tr>
157
        <td>collector.oai.http.maxNumberOfRetry</td>  <td>6</td>  <td>int</td> <td>Number of times to retry in case of an OAI-PMH request timeout.</td>
158
    </tr>
159
     <tr>
160
        <td>repo.ui.compatibilityLevels.vocabulary</td>  <td>dnet:compatibilityLevel</td>  <td>Vocabulary code</td> <td>Code of a D-Net vocabulary containing the terms about datasource compatibility (or compliance)</td>
161
    </tr>
162
      <tr>
163
        <td>repo.ui.contentDescriptions.vocabulary</td>  <td>dnet:content_description_typologies</td>  <td>Vocabulary code</td> <td>Code of a D-Net vocabulary containing the terms about the typologies of collectable items</td>
164
    </tr>
165
     <tr>
166
        <td>repo.ui.datasourceTypes.vocabulary</td>  <td>dnet:typologies</td>  <td>Vocabulary code</td> <td>Code of a D-Net vocabulary containing the terms about the typologies of datasources</td>
167
    </tr>
168
    <tr>
169
        <td>repo.ui.protocols.vocabulary</td>  <td>dnet:protocols</td>  <td>Vocabulary code</td> <td>Code of a D-Net vocabulary containing the terms about the supported protocols for collection</td>
170
    </tr>
171
     <tr>
172
        <td>services.aggregator.country</td>  <td>EU</td>  <td>String</td> <td>your country code</td>
173
    </tr>
174
     <tr>
175
        <td>services.aggregator.name</td>  <td>D-NET</td>  <td>String</td> <td>the name of your aggregator</td>
176
    </tr>
177
178
</table>
179
180
181
#D-Net properties for metadata transformation and harmonisation
182
<table class="myTable">
183
<tr>
184
<th>Property name</th>
185
<th>Default value</th>
186
<th>Value type/ Allowed values</th>
187
<th>Description</th>
188
</tr>
189
    <tr>
190
        <td>dnet.modular.ui.vocabulary.dao</td>  <td>registryServiceVocabularyDAO</td> <td>bean name</td> <td>name of the bean that manages vocabulary resources</td>
191
    </tr>
192
    <tr>
193
        <td>services.transformation.defaultschema</td>  <td>/eu/dnetlib/data/collective/transformation/schema/DMFSchema_vTransformator.xsd</td>  <td>/eu/dnetlib/data/collective/transformation/schema/DMFSchema_vTransformator.xsd, /eu/dnetlib/data/collective/transformation/schema/OAFSchema_vTransformator.xsd</td> <td>Path to the Transformator Service schema. Two options are available: one for DMF, one for OAF. The template property below must be set accordingly.</td>
194
    </tr>
195
    <tr>
196
        <td>services.transformation.defaulttemplate</td>  <td>/eu/dnetlib/data/collective/transformation/engine/template.xsl</td>  <td>/eu/dnetlib/data/collective/transformation/engine/template.xsl,/eu/dnetlib/data/collective/transformation/engine/oaftemplate.xsl</td> <td>Template for the Transformator Service.  Two options are available: one for DMF, one for OAF. The schema property above must be set accordingly.</td>
197
    </tr>
198
    <tr>
199 39177 claudio.at
        <td>services.transformation.vocabularyproperties.json </td>  <td>{"map":{"AccessRights":{"name":"dnet:rights", "caseSensitive":"false", "delimiter":"/"}, "Languages":{"name":"dnet:languages", "caseSensitive":"false", "delimiter":"/"}, "TextTypologies":{"name":"dnet:texttypologies", "caseSensitive":"false", "delimiter":"/"}}}</td>  <td>json map</td> <td>Instructs the Transformator Service about the D-Net vocabularies to apply for specific fields</td>
200 37584 alessia.ba
    </tr>
201
</table>
202
203
#D-Net properties for Metadata Store Service (MDStore)
204
<table class="myTable">
205
<tr>
206
<th>Property name</th>
207
<th>Default value</th>
208
<th>Value type</th>
209
<th>Description</th>
210
</tr>
211
    <tr>
212
        <td>services.mdstore.dao</td>  <td>mongodbMDStoreDao</td> <td>bean name</td> <td>name of the bean that manages mdstore. Currently there is only one option to work with a mongodb server.</td>
213
    </tr>
214
    <tr>
215
        <td>services.mdstore.discardrecords</td>  <td>true</td>  <td>boolean</td> <td>True to save non well-formed records in a discarded store.</td>
216
    </tr>
217
    <tr>
218
        <td>services.mdstore.mongodb.checkmetadata.onstart</td>  <td>true</td>  <td>boolean</td> <td>True to perform automatic checks on existing mdstore at startup.</td>
219
    </tr>
220
        <tr>
221
        <td>services.mdstore.mongodb.checkmetadata.startdelay</td>  <td>30000</td>  <td>millisecond</td> <td>Millisecond to wait after a webapp restart before running the metadata check. Only valid if 'services.mdstore.mongodb.checkmetadata.onstart' is true.</td>
222
    </tr>
223
      <tr>
224
        <td>services.mdstore.mongodb.ensureindex.cron</td>  <td>0 0 23 * * ?</td>  <td>Cron expression</td> <td>When to run a re-indexing on the mdstores. Only valid if 'services.mdstore.mongodb.ensureindex.enable' is true.</td>
225
    </tr>
226
      <tr>
227
        <td>services.mdstore.mongodb.ensureindex.enable</td>  <td>false</td>  <td>boolean</td> <td>Enables the automatic re-indexing of mdstores.</td>
228
    </tr>
229
     <tr>
230
        <td>services.mdstore.mongodb.host</td>  <td>localhost</td> <td>String</td> <td>host that runs a mongodb to be used for metadata storage</td>
231
    </tr>
232
    <tr>
233
        <td>services.mdstore.mongodb.port</td>  <td>27017</td> <td>int</td> <td>port of the mongodbserver to use for metadata storage</td>
234
    </tr>
235
    <tr>
236
        <td>services.mdstore.mongodb.db</td>  <td>mdstore_minimal</td> <td>String</td> <td>mongodb database to use for metadata storage</td>
237
    </tr>
238
     <tr>
239
        <td>services.mdstore.mongodb.connectionsPerHost</td>  <td>20</td> <td>int</td> <td>max number of connections per host allowed for the mdstore db used for metadata storage</td>
240
    </tr>
241
</table>
242
243
#D-Net properties for workflows
244
<table class="myTable">
245
<tr>
246
<th>Property name</th>
247
<th>Default value</th>
248
<th>Value type</th>
249
<th>Description</th>
250
</tr>
251
    <tr>
252
        <td>dnet.logger.mongo.host</td>  <td>localhost</td> <td>String</td> <td>host that runs a mongodb to be used for D-Net workflow history management</td>
253
    </tr>
254
    <tr>
255
        <td>dnet.logger.mongo.port</td>  <td>27017</td> <td>int</td> <td>port of the mongodbserver to use for D-Net workflow history management</td>
256
    </tr>
257
    <tr>
258
        <td>dnet.logger.mongo.db</td>  <td>dnet_logs_minimal</td> <td>String</td> <td>mongodb database to use for D-Net workflow history management</td>
259
    </tr>
260
</table>
261
262
263
#D-Net properties for mail notifications
264
<table class="myTable">
265
<tr>
266
<th>Property name</th>
267
<th>Default value</th>
268
<th>Value type</th>
269
<th>Description</th>
270
</tr>
271
    <tr>
272
        <td>infrastructure.name</td>  <td>development</td> <td>String</td> <td>Name of the infrastructure to appear in the mail subject</td>
273
    </tr>
274
    <tr>
275
        <td>msro.wf.mail.smtp.host</td>  <td>localhost</td> <td>String</td> <td>SMTP server host</td>
276
    </tr>
277
    <tr>
278
        <td>msro.wf.mail.smtp.port</td>  <td>587</td> <td>String</td> <td>SMTP server port</td>
279
    </tr>
280
     <tr>
281
        <td>msro.wf.mail.smtp.user</td>  <td></td> <td>String</td> <td>SMTP server user</td>
282
    </tr>
283
     <tr>
284
        <td>msro.wf.mail.smtp.password</td>  <td></td> <td>String</td> <td>SMTP server user password</td>
285
    </tr>
286
    <tr>
287
        <td>msro.wf.mail.from</td>  <td>dnet-noreply@research-infrastructures.eu</td> <td>e-mail</td> <td>Mail sender</td>
288
    </tr>
289
    <tr>
290
        <td>msro.wf.mail.fromName</td>  <td>D-NET Workflow Manager</td> <td>String</td> <td>Name of the e-mail sender</td>
291
    </tr>
292
    <tr>
293
        <td>msro.wf.mail.cc</td>  <td></td>  <td>comma separated list of e-mails</td> <td>e-mail addresses that will always receive each mail in cc</td>
294
    </tr>
295
    <tr>
296
        <td>dnet.guest.password</td>  <td>084e0343a0486ff05530df6c705c8bb4</td>  <td>md5(password)</td> <td>MD5 of the password for the user guest</td>
297
    </tr>
298
</table>
299
300
301
#D-Net properties for D-Net OAI-PMH Publisher
302
<table class="myTable">
303
<tr>
304
<th>Property name</th>
305
<th>Default value</th>
306
<th>Value type/ Allowed values</th>
307
<th>Description</th>
308
</tr>
309
    <tr>
310
        <td>services.oai.publisher.db.xquery</td>  <td>//RESOURCE_PROFILE[.//RESOURCE_TYPE/@value = 'OAIPublisherConfigurationDSResourceType']//CONFIGURATION/CURRENTDB/string() applicationContext-dnet-oai-utils.properties
311
</td> <td>xquery string</td> <td>xquery to fetch the OAI configuration</td>
312
    </tr>
313
    <tr>
314
        <td>services.oai.publisher.deletedrecords</td>  <td>TRANSIENT</td> <td>TRANSIENT, YES, NO</td> <td>See OAI-PMH specifications about the Identify verb response</td></tr>
315
    <tr>
316
        <td>services.oai.publisher.dnet.pagesize</td>  <td>100</td> <td>int</td> <td>Number of OAI records in a a page</td>
317
    </tr>
318
    <tr>
319
        <td>services.oai.publisher.repo.earliestdatestamp</td>  <td>2013-10-03T15:53:06Z</td>  <td>Date</td> <td>See OAI-PMH specifications about the Identify verb response</td></tr>
320
    <tr>
321
        <td>services.oai.publisher.repo.email</td>  <td>dnet-admin@mock.it</td>  <td>e-mail</td> <td>See OAI-PMH specifications about the Identify verb response</td></tr>
322
    </tr>
323
    <tr>
324
        <td>services.oai.publisher.repo.granularity</td>  <td>YYYY-MM-DDThh:mm:ssZ</td>  <td>date pattern</td> <td>See OAI-PMH specifications about the Identify verb response</td></tr>
325
    </tr>
326
    <tr>
327
        <td>services.oai.publisher.repo.name</td>  <td>D-Net OAI-PMH Publisher</td>  <td>String</td> <td>See OAI-PMH specifications about the Identify verb response</td></tr>
328
    </tr>
329
     <tr>
330
        <td>services.oai.publisher.baseUrl</td>  <td></td>  <td>OAI-PMH Publisher base URL</td> <td>See OAI-PMH specifications about the Identify verb response</td></tr>
331
    </tr>
332
     <tr>
333
        <td>services.publisher.oai.host</td>  <td>localhost</td>  <td>host that runs a mongodb to be used to store records served by the OAI-PMH publisher</td>
334
        </tr>
335
 	<tr>
336
        <td>services.publisher.oai.port</td>  <td>27017</td>  <td>port of the mongodb to be used to store records served by the OAI-PMH publisher</td>
337
    </tr>
338
339
</table>
340
341
#D-Net properties for D-Net Index Service over Solr
342
<table class="myTable">
343
<tr>
344
<th>Property name</th>
345
<th>Default value</th>
346
<th>Value type</th>
347
<th>Description</th>
348
</tr>
349
    <tr>
350
        <td>service.solr.index.jsonConfiguration</td>  <td>
351
        <code>{
352
        "id":"solr", "address":"localhost:9983","port":"8983",
353
        "host":"localhost", "webContext":"solr",
354
        "numShards":"1","replicationFactor":"1",
355
        "feedingShutdownTolerance":"30000", "feedingBufferFlushThreshold":"1000","feedingSimulationMode":"false",
356
        "luceneMatchVersion":"4.9", "serverLibPath":"../../../../contrib/extraction/lib",
357
        "filterCacheSize":"512", "filterCacheInitialSize":"512",
358
        "queryCacheSize":"512","queryCacheInitialSize":"512",
359
        "documentCacheSize":"512","documentCacheInitialSize":"512",
360
        "ramBufferSizeMB":"960",
361
        "mergeFactor":"40",
362
        "autosoftcommit":"-1","autocommit":"15000",
363
        "termIndexInterval":"1024","maxIndexingThreads":"8",
364
        "queryResultWindowSize":"20", "queryResultMaxDocCached":"200"}
365
         </code>
366
</td> <td>json map</td> <td>information about the Solr instance to be used. See Solr documentation for details</td>
367
    </tr>
368 39177 claudio.at
</table>