Project

General

Profile

1 43872 alessia.ba
<head>
2
<!-- Start Styles. Move the 'style' tags and everything between them to between the 'head' tags -->
3
<style type="text/css">
4
.myTable { background-color:#eee;border-collapse:collapse; }
5
.myTable th { background-color:#000;color:white; }
6
.myTable td, .myTable th { padding:5px;border:1px solid #000; }
7
</style>
8
9
</head>
10
# Properties
11
12
This file contains the list of properties that can be set to configure a D-Net instance.
13
14
To get the list of currently used properties please go to the Admin UI of your running instance and select Configuration > Container Properties
15
16
## D-Net webapp properties
17
<table class="myTable">
18
<tr>
19
<th>Property name</th>
20
<th>Default value</th>
21
<th>Value type</th>
22
<th>Description</th>
23
</tr>
24
    <tr>
25
        <td>container.hostname</td>  <td>localhost</td> <td>String</td> <td>the host name where the web app will be running</td>
26
    </tr>
27
    <tr>
28
        <td>container.port</td>  <td>8280</td>  <td>int</td> <td>the port where the web app will be running</td>
29
    </tr>
30
    <tr>
31
        <td>container.context</td>  <td>app</td>  <td>String</td> <td>name of the web app</td>
32
    </tr>
33
    <tr>
34
        <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>
35
    </tr>
36
</table>
37
38
## D-Net properties for enabling services
39
40
### ResultSet Service
41
<table class="myTable">
42
<tr>
43
<th>Property name</th>
44
<th>Default value</th>
45
<th>Value type</th>
46
<th>Description</th>
47
</tr>
48
    <tr>
49
        <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>
50
    </tr>
51
     <tr>
52
        <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>
53
    </tr>
54
     <tr>
55
        <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>
56
    </tr>
57
    <tr>
58
        <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>
59
    </tr>
60
     <tr>
61
        <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>
62
    </tr>
63
     <tr>
64
        <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>
65
    </tr>
66
     <tr>
67
        <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>
68
    </tr>
69
</table>
70
71
### IS Store Service
72
<table class="myTable">
73
<tr>
74
<th>Property name</th>
75
<th>Default value</th>
76
<th>Value type/ Allowed values</th>
77
<th>Description</th>
78
</tr>
79
    <tr>
80
        <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>
81
    </tr>
82
    <tr>
83
        <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>
84
      <tr>
85
        <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>
86
    </tr>
87
</table>
88
89
### Resource Registration
90
<table class="myTable">
91
<tr>
92
<th>Property name</th>
93
<th>Default value</th>
94
<th>Value type/ Allowed values</th>
95
<th>Description</th>
96
</tr>
97
    <tr>
98
        <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>
99
    </tr>
100
    <tr>
101
        <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>
102
      <tr>
103
        <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>
104
    </tr>
105
106
</table>
107
108
109
# D-Net properties for metadata collection
110
<table class="myTable">
111
<tr>
112
<th>Property name</th>
113
<th>Default value</th>
114
<th>Value type</th>
115
<th>Description</th>
116
</tr>
117
    <tr>
118
        <td>collector.oai.http.defaultDelay</td>  <td>120</td> <td>seconds</td> <td>Seconds to wait between two subsequent OAI-PMH ListRecord requests</td>
119
    </tr>
120
    <tr>
121
        <td>collector.oai.http.readTimeOut</td>  <td>120</td>  <td>int</td> <td>Seconds to wait for an OAI-PMH publisher response.</td>
122
    </tr>
123
    <tr>
124
        <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>
125
    </tr>
126
     <tr>
127
        <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>
128
    </tr>
129
      <tr>
130
        <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>
131
    </tr>
132
     <tr>
133
        <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>
134
    </tr>
135
    <tr>
136
        <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>
137
    </tr>
138
     <tr>
139
        <td>services.aggregator.country</td>  <td>EU</td>  <td>String</td> <td>your country code</td>
140
    </tr>
141
     <tr>
142
        <td>services.aggregator.name</td>  <td>D-NET</td>  <td>String</td> <td>the name of your aggregator</td>
143
    </tr>
144
145
</table>
146
147
148
#D-Net properties for metadata transformation and harmonisation
149
<table class="myTable">
150
<tr>
151
<th>Property name</th>
152
<th>Default value</th>
153
<th>Value type/ Allowed values</th>
154
<th>Description</th>
155
</tr>
156
    <tr>
157
        <td>dnet.modular.ui.vocabulary.dao</td>  <td>registryServiceVocabularyDAO</td> <td>bean name</td> <td>name of the bean that manages vocabulary resources</td>
158
    </tr>
159
    <tr>
160
        <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>
161
    </tr>
162
    <tr>
163
        <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>
164
    </tr>
165
    <tr>
166
        <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>
167
    </tr>
168
</table>
169
170
#D-Net properties for Metadata Store Service (MDStore)
171
<table class="myTable">
172
<tr>
173
<th>Property name</th>
174
<th>Default value</th>
175
<th>Value type</th>
176
<th>Description</th>
177
</tr>
178
    <tr>
179
        <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>
180
    </tr>
181
    <tr>
182
        <td>services.mdstore.discardrecords</td>  <td>true</td>  <td>boolean</td> <td>True to save non well-formed records in a discarded store.</td>
183
    </tr>
184
    <tr>
185
        <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>
186
    </tr>
187
        <tr>
188
        <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>
189
    </tr>
190
      <tr>
191
        <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>
192
    </tr>
193
      <tr>
194
        <td>services.mdstore.mongodb.ensureindex.enable</td>  <td>false</td>  <td>boolean</td> <td>Enables the automatic re-indexing of mdstores.</td>
195
    </tr>
196
     <tr>
197
        <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>
198
    </tr>
199
    <tr>
200
        <td>services.mdstore.mongodb.port</td>  <td>27017</td> <td>int</td> <td>port of the mongodbserver to use for metadata storage</td>
201
    </tr>
202
    <tr>
203
        <td>services.mdstore.mongodb.db</td>  <td>mdstore_minimal</td> <td>String</td> <td>mongodb database to use for metadata storage</td>
204
    </tr>
205
     <tr>
206
        <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>
207
    </tr>
208
</table>
209
210
#D-Net properties for workflows
211
<table class="myTable">
212
<tr>
213
<th>Property name</th>
214
<th>Default value</th>
215
<th>Value type</th>
216
<th>Description</th>
217
</tr>
218
    <tr>
219
        <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>
220
    </tr>
221
    <tr>
222
        <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>
223
    </tr>
224
    <tr>
225
        <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>
226
    </tr>
227
</table>
228
229
230
#D-Net properties for mail notifications
231
<table class="myTable">
232
<tr>
233
<th>Property name</th>
234
<th>Default value</th>
235
<th>Value type</th>
236
<th>Description</th>
237
</tr>
238
    <tr>
239
        <td>infrastructure.name</td>  <td>development</td> <td>String</td> <td>Name of the infrastructure to appear in the mail subject</td>
240
    </tr>
241
    <tr>
242
        <td>msro.wf.mail.smtp.host</td>  <td>localhost</td> <td>String</td> <td>SMTP server host</td>
243
    </tr>
244
    <tr>
245
        <td>msro.wf.mail.smtp.port</td>  <td>587</td> <td>String</td> <td>SMTP server port</td>
246
    </tr>
247
     <tr>
248
        <td>msro.wf.mail.smtp.user</td>  <td></td> <td>String</td> <td>SMTP server user</td>
249
    </tr>
250
     <tr>
251
        <td>msro.wf.mail.smtp.password</td>  <td></td> <td>String</td> <td>SMTP server user password</td>
252
    </tr>
253
    <tr>
254
        <td>msro.wf.mail.from</td>  <td>dnet-noreply@research-infrastructures.eu</td> <td>e-mail</td> <td>Mail sender</td>
255
    </tr>
256
    <tr>
257
        <td>msro.wf.mail.fromName</td>  <td>D-NET Workflow Manager</td> <td>String</td> <td>Name of the e-mail sender</td>
258
    </tr>
259
    <tr>
260
        <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>
261
    </tr>
262
    <tr>
263
        <td>dnet.guest.password</td>  <td>084e0343a0486ff05530df6c705c8bb4</td>  <td>md5(password)</td> <td>MD5 of the password for the user guest</td>
264
    </tr>
265
</table>
266
267
268
#D-Net properties for D-Net OAI-PMH Publisher
269
<table class="myTable">
270
<tr>
271
<th>Property name</th>
272
<th>Default value</th>
273
<th>Value type/ Allowed values</th>
274
<th>Description</th>
275
</tr>
276
    <tr>
277
        <td>services.oai.publisher.db.xquery</td>  <td>//RESOURCE_PROFILE[.//RESOURCE_TYPE/@value = 'OAIPublisherConfigurationDSResourceType']//CONFIGURATION/CURRENTDB/string() applicationContext-dnet-oai-utils.properties
278
</td> <td>xquery string</td> <td>xquery to fetch the OAI configuration</td>
279
    </tr>
280
    <tr>
281
        <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>
282
    <tr>
283
        <td>services.oai.publisher.dnet.pagesize</td>  <td>100</td> <td>int</td> <td>Number of OAI records in a a page</td>
284
    </tr>
285
    <tr>
286
        <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>
287
    <tr>
288
        <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>
289
    </tr>
290
    <tr>
291
        <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>
292
    </tr>
293
    <tr>
294
        <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>
295
    </tr>
296
     <tr>
297
        <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>
298
    </tr>
299
     <tr>
300
        <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>
301
        </tr>
302
 	<tr>
303
        <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>
304
    </tr>
305
306
</table>
307
308
#D-Net properties for D-Net Index Service over Solr
309
<table class="myTable">
310
<tr>
311
<th>Property name</th>
312
<th>Default value</th>
313
<th>Value type</th>
314
<th>Description</th>
315
</tr>
316
    <tr>
317
        <td>service.solr.index.jsonConfiguration</td>  <td>
318
        <code>{
319
        "id":"solr", "address":"localhost:9983","port":"8983",
320
        "host":"localhost", "webContext":"solr",
321
        "numShards":"1","replicationFactor":"1",
322
        "feedingShutdownTolerance":"30000", "feedingBufferFlushThreshold":"1000","feedingSimulationMode":"false",
323
        "luceneMatchVersion":"4.9", "serverLibPath":"../../../../contrib/extraction/lib",
324
        "filterCacheSize":"512", "filterCacheInitialSize":"512",
325
        "queryCacheSize":"512","queryCacheInitialSize":"512",
326
        "documentCacheSize":"512","documentCacheInitialSize":"512",
327
        "ramBufferSizeMB":"960",
328
        "mergeFactor":"40",
329
        "autosoftcommit":"-1","autocommit":"15000",
330
        "termIndexInterval":"1024","maxIndexingThreads":"8",
331
        "queryResultWindowSize":"20", "queryResultMaxDocCached":"200"}
332
         </code>
333
</td> <td>json map</td> <td>information about the Solr instance to be used. See Solr documentation for details</td>
334
    </tr>
335
</table>