Difference between revisions of "System Properties"

From Fusion Registry Wiki
Jump to navigation Jump to search
(Properties which may be Dynamically changed)
(Properties which may be Dynamically changed)
 
(16 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
[[Category:How_To]]
 
[[Category:How_To]]
 
+
[[Category:Fusion Registry Install]]
 
= Overview =  
 
= Overview =  
  
Line 45: Line 45:
 
}
 
}
 
</pre>
 
</pre>
 +
 +
'''IMPORTANT NOTE:''' Values set by using the Web Service will '''not''' be preserved on a Registry reboot.  It is recommended to supply the System properties as part of the Java Server startup process (for example by the use of [[Tomcat_setenv_file | setenv]] in Apache Tomcat).
  
 
= Properties which may be Dynamically changed =
 
= Properties which may be Dynamically changed =
Line 61: Line 63:
 
| edi.forceTimeFormatSeriesAttr.enabled || false || [[Edi_Create_Time_Format|Sets whether a series attribute of TIME_FORMAT should be created]]
 
| edi.forceTimeFormatSeriesAttr.enabled || false || [[Edi_Create_Time_Format|Sets whether a series attribute of TIME_FORMAT should be created]]
 
|-
 
|-
| edi.skipagencycheck.enabled || false || When writing an EDI data file, does not check that the Agencies of the Dataflow and DSD match. When writing an EDI structure file, does not check that cross-referenced components are of the same aganecy as the DSD. This feature is part of EDI Leniency mode.
+
| edi.skipagencycheck.enabled || false || When writing an EDI data file, does not check that the Agencies of the Dataflow and DSD match. When writing an EDI structure file, does not check that cross-referenced components are of the same agency as the DSD. This feature is part of EDI Leniency mode. <p>[[EDI_skipagencycheck_enabled|Ignores the Agency check when evaluating the DSI file]]
 +
|-
 +
| edi.dsi.dataflow.enabled || false || When reading an EDI file, determines whether the DSI segment should be used to refer to a Dataflow<p>[[EDI_dsi.dataflow_enabled|Switches the DSI from refering to the Datafllow]]
 
|-
 
|-
| edi.dsi.dataflow.enabled || false || When reading an EDI file, determines whether the DSI segment should be used to refer to a Dataflow
+
|edi.datagroup.identifier || unset || [[Edi_DataGroup_Identifier|Sets how the Registry sets the Group name when reading an EDI data file]]
 
|-
 
|-
 
| ENFORCE_STRICT_SDMX_2.1 || false || Puts the Registry into Enforcing Strict values for SDMX 2.1
 
| ENFORCE_STRICT_SDMX_2.1 || false || Puts the Registry into Enforcing Strict values for SDMX 2.1
Line 69: Line 73:
 
<br/> Monthly data is of the format: YYYY-Mmm  
 
<br/> Monthly data is of the format: YYYY-Mmm  
 
<br/> Half-Yearly data is of the format: YYYY-S[1-2]
 
<br/> Half-Yearly data is of the format: YYYY-S[1-2]
|-
 
|edi.datagroup.identifier || unset || [[Edi_DataGroup_Identifier|Sets how the Registry sets the Group name when reading an EDI data file]]
 
 
|-
 
|-
 
| server.secondary || false || [[Secondary_Server|Sets the Registry into secondary server mode]]
 
| server.secondary || false || [[Secondary_Server|Sets the Registry into secondary server mode]]
 
|-
 
|-
| TF_ALTERNATE_HALF_YEAR  || true || [[EDI_Alternate_Half_Year|Sets the Registry into Alternate Half Year mode]]
+
| TF_ALTERNATE_HALF_YEAR  || false || [[Time_Format_Alternate_Half_Year|Sets the Registry into Alternate Half Year mode]]
|-
 
| ENFORCE_STRICT_SDMX_2.1 || true || [[EDI_Enforce_Strict_SDMX_2.1|Enforces Strict mode]]
 
 
|-
 
|-
| edi.dsi.dataflow.enabled || true || [[EDI_dsi.dataflow_enabled|Switches the DSI from refering to the Datafllow]]
+
| aggregation.series.threshold  || 500000 || Sets the limit for aggregated series. Keep in mind that increasing this value can have an impact on performance during data load/hierarchy association or hierarchy change.
 
|-
 
|-
| edi.skipagencycheck.enabled || [[EDI_skipagencycheck_enabled|
+
| HCL_OUTPUT_PERMIT_ALIAS_REF || false || Determine how Hierarchical Codelists should be output.<p>Fusion Registry version 10 only and since version 10.9.4.<p>[[Hierarchical_Codelists_Output_Format| Hierarchical Codelist Output]]
 
|}
 
|}

Latest revision as of 05:21, 13 May 2024

Overview

System Properties are generally set when the Java virual machine that is running Fusion Registry is launched. However the Registry provides a way to list all of the System properties and also provides the ability to set their values. Note that setting some of the system properties will have no effect on the running Registry as these must be supplied at startup time . The properties that can be changed and for the change to have an effect are listed below.

Obtaining System Properties

A root or an admin user of Fusion Registry can access the System Properites, returned in JSON form, by performing a GET request to the url:

http://[server]:[port]/FusionRegistry/ws/secure/settings/getSystemProperties

As this is a secure Web Service the user must be logged on, or supply correct credentials. The result is an array of JSON objects, where each object has a Key and a Value For example:

{
  Key: "edi.lenient.enabled",
  Value: "true"
}

Setting System Properties

A root or an admin user of Fusion Registry can set a System Properites by performing a POST request to the url:

http://[server]:[port]/FusionRegistry/ws/secure/settings/setSystemProperty

Appropriate credential must be supplied. The input format is JSON of the form

{
    "Key": "edi.lenient.enabled",
    "Value": "false"
}

If the "value" specified is blank this will have the effect of removing the property. For example the following will remove the property "ENFORCE_STRICT_SDMX_2.1":

{
    "Key": "ENFORCE_STRICT_SDMX_2.1",
    "Value": ""
}

IMPORTANT NOTE: Values set by using the Web Service will not be preserved on a Registry reboot. It is recommended to supply the System properties as part of the Java Server startup process (for example by the use of setenv in Apache Tomcat).

Properties which may be Dynamically changed

Changing a property whilst the Registry is running may not have any effect. The following properties can be changed and their effect will be immediate:


Property Default Value Effect
edi.lenient.enabled false Sets the EDI Leniency of the Registry
edi.enforce.primarymeasure.enabled false Sets whether a Primary Measure should be enforced in EDI
edi.forceTimeFormatSeriesAttr.enabled false Sets whether a series attribute of TIME_FORMAT should be created
edi.skipagencycheck.enabled false When writing an EDI data file, does not check that the Agencies of the Dataflow and DSD match. When writing an EDI structure file, does not check that cross-referenced components are of the same agency as the DSD. This feature is part of EDI Leniency mode.

Ignores the Agency check when evaluating the DSI file

edi.dsi.dataflow.enabled false When reading an EDI file, determines whether the DSI segment should be used to refer to a Dataflow

Switches the DSI from refering to the Datafllow

edi.datagroup.identifier unset Sets how the Registry sets the Group name when reading an EDI data file
ENFORCE_STRICT_SDMX_2.1 false Puts the Registry into Enforcing Strict values for SDMX 2.1


Week data is of the format: YYYY-Www
Monthly data is of the format: YYYY-Mmm
Half-Yearly data is of the format: YYYY-S[1-2]

server.secondary false Sets the Registry into secondary server mode
TF_ALTERNATE_HALF_YEAR false Sets the Registry into Alternate Half Year mode
aggregation.series.threshold 500000 Sets the limit for aggregated series. Keep in mind that increasing this value can have an impact on performance during data load/hierarchy association or hierarchy change.
HCL_OUTPUT_PERMIT_ALIAS_REF false Determine how Hierarchical Codelists should be output.

Fusion Registry version 10 only and since version 10.9.4.

Hierarchical Codelist Output