configuration.properties
Location | <tomcat_home>\webapps\webapi\WEB-INF\classes\configuration.properties |
---|
SuperWEB2 and the Open Data API each have their own configuration.properties file that contain the same settings. You need to update both files if you also want to apply the same property settings to the Open Data API.
The following properties are available in this configuration file.
SuperWEB2 Settings
Global Settings
Property | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|
global.enableUserRegistration | Whether to enable the built in user registration system:
The user registration system is disabled by default and will not appear as an option on the login page. Enabling it through this configuration activates the registration option, but the feature will not work without additional configuration (for example you need to configure the email server for sending registration messages). More information: User Registration | ||||||||
global.enableMapView | Whether to display the Map View tab:
| ||||||||
global.enableGuidedTutorial | Whether to enable the guided tour:
More information: Customise the Interactive Tour | ||||||||
global.enableNewFeatureTutorial | Whether to enable the new features popup. This can be used to display information about new data or new features that have been added to SuperWEB2.
| ||||||||
global.enableGuestAccess | Whether to allow guest access to SuperWEB2:
More information: Configure Guest Access | ||||||||
global.enableRecordView | Whether to enable or disable the Record View feature:
If you choose to disable Record View using this property it will be disabled for all users, regardless of any SuperADMIN user settings. This setting hides the RecordVIEW button from the SuperWEB2 interface. If you are blocking access to Record View for security reasons, you may also wish to disable Record View at the SuperSERVER level. See Configure Record View Permissions for more details. In earlier versions this property was set in web.xml More information: Enable or Disable Record View | ||||||||
global.enableGraphView | Whether to display the Graph View tab:
| ||||||||
global.labelSortType | The algorithm used when sorting labels in SuperWEB2:
| ||||||||
global.sessionPollTime | The session poll time used to keep the session active, in milliseconds. Both Table View and Map View have REST endpoints that fail if the session times out. To keep the session active, the server is polled at regular intervals. As a general rule you should set the interval to 60000ms (1 minute) less than the configured session timeout. Set this to 0 to disable polling. The default is 540000 (9 minutes). | ||||||||
global.auth. urlParameter.enabled | The ability to use an external login form with direct URLs relies on HTTP Basic Authentication, and has been disabled by default for security reasons. If you wish to continue using this feature, it can be enabled by adding the property See Use Direct URLs to Open a Specific Dataset or Table for more details. |
SuperADMIN Settings
Property | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|
superAdmin.zmq.address | The address for connecting to SuperADMIN. This should typically be left blank, in which case it will use the value from the AdministrationServerCatalog.xml file. | ||||||||
superAdmin.zmq.subscriptionPort | The subscription port for connecting to SuperADMIN. The default is 9002. | ||||||||
superAdmin.zmq.messagePort | The message port for connecting to SuperADMIN. The default is 9003. | ||||||||
superAdmin.zmq.reconnectionInterval | The time between subsequent attempts to reconnect to SuperADMIN if the connection is broken and the initial, immediate reconnection attempt fails. Specify the value as an integer, followed by one of the following units:
The default is | ||||||||
superAdmin.zmq.socketTimeout | The time to wait without receiving a heartbeat (or any other message) from SuperADMIN before resetting the underlying Specify the value as an integer, followed by one of the following units:
The default is | ||||||||
superAdmin.zmq.synchronisedStateTimeout | The time to wait without receiving a heartbeat (or any other message) from SuperADMIN before considering any cached state (such as the contents of the Open Data API cache) to be out of date. This value should be the maximum time you are willing to allow that state to possibly be out of sync with SuperADMIN when experiencing communication issues (for example for a permission change or deleted dataset to take effect). It should also be greater than the value of Specify the value as an integer, followed by one of the following units:
The default is |
File and Confidentiality Settings
Property | Description | ||||
---|---|---|---|---|---|
file.defaultTxdEncoding | The codepage to use when loading saved system tables (TXD files that have been saved to <tomcat_home>\webapps\webapi\WEB-INF\resources\txd) and loading TXDs files through the SuperWEB2 interface. The default value is This setting is useful when loading TXDs that were created with versions of SuperCROSS prior to 9.0:
TXDEncodingType ). It moved to configuration.properties in version 9.9.8. | ||||
cube.showNaNAsZero | Whether to display 0 or a custom string if there are cells with no records contributing to the result:
See Configure Settings for Concealment and Cells with No Contributors for more information. | ||||
confidentiality. | Whether to prevent the release of datasets that do not have confidentiality modules applied to them.
| ||||
confidentiality. | Whether to prevent the release of datasets that do not have a specific Data Control API module applied to them. If any modules are specified, then users will only be able to access datasets that have at least one of those modules applied (the user must also have standard permission to access the dataset). This property accepts a comma separated list of modules. For example, the following prevents access to datasets that do not have either perturbation or the confidentiality rule modules applied to them:
CODE
|
Catalogue Settings
Property | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|
catalogue.sortDatabases | Whether to sort the list of Datasets shown in the catalogue screen:
More information: Change the Sort Order of Tables and Datasets | ||||||||
catalogue.folderExpansionDepth catalogue.databaseFolderExpansionDepth | How many levels of folders should initially be expanded when a user opens the Catalogue page in SuperWEB2.
If
| ||||||||
catalogue.infoPanel. | Whether to read the text for the catalogue page from the metadata database. This setting only applies when metadata server has been set up and is only used for datasets that have been set to
More information: Use the Metadata Server to Store the Data Catalogue Information Pages - SuperWEB2 | ||||||||
catalogue.openDatasetBehaviour | Whether to load the default table, if configured, when opening a dataset other than by clicking New Table (for example when double-clicking, via search or through a direct URL):
More information: Getting Started | ||||||||
catalogue.hiddenSystemTxdPrefix | Whether to hide system tables that start with a specified case-sensitive prefix. This allows for hiding system tables in the Table section of the Datasets page and in search results. These items can still be opened via direct URLs, but they will not be visible to users in the catalogue. Leave blank to hide none (default). | ||||||||
catalogue.searchResultLimit | The maximum number of results to return for a catalogue search. This setting applies independently to each of the non-dataset and non-table result types (fields, values, synonyms and metadata). The default is 2000. If a user runs a search that exceeds the limit, a message will be displayed indicating that the search results have been capped and advising the user to perform a more specific search to see the full set of search results. More information: Search |
Schema Tree Settings
Property | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|
schemaTree.expandOnSelection | Whether to automatically expand a field in the tree when a user selects the Select all at level drop-down list. This property takes the following values:
More information: Automatically Expand the Fields when Selecting All | ||||||||
schemaTree.hierarchicalFieldDepthLimit | The maximum number of levels of hierarchy to show in the Select all at level drop-down list. Set this to a negative value if you do not want to limit the levels of hierarchy. The default setting is -1. | ||||||||
schemaTree.showSummationOptions | Whether to show the summation options in the customise table panel in Table View.
| ||||||||
schemaTree.selectAtLevelShowsValuesetName | Which labels to show in the Select all at level drop-down:
More information: Configure Field Drop-down Labels | ||||||||
schemaTree.schemaFolderExpansionDepth | How many levels of folders (field groups) to expand automatically when opening a dataset:
| ||||||||
schemaTree.suppressSum | This setting was previously defined in the web.xml configuration file. Whether to prevent users adding the SUM measure to a table.
|
Table Settings
Property | Description | ||||||
---|---|---|---|---|---|---|---|
table. | Whether to show the name of the currently open table in Table View (when opening a saved table):
| ||||||
table. | When you have recodes (custom groups) in your table, a footnote automatically appears at the bottom of the table indicating which individual items make up the recode. You can use this setting to control whether this recode footnote is truncated. This setting specifies the maximum length of recode footnotes in a table prior to truncation. The default is 120. | ||||||
table. | Whether to display annotations beneath the table. This property takes the following values:
More information: Configure Display of Annotations | ||||||
table. | Whether to display a list of saved tables for the current dataset in a tab Table View:
More information: Save and Reload Tables | ||||||
table. | Whether to automatically expand annotations. This property takes the following values:
More information: Configure Display of Annotations | ||||||
table. | The default display mode for tables with Relative Standard Error values. This property takes the following values:
More information: Configure Relative Standard Error | ||||||
table. | Whether to retrieve data in Table View automatically by default:
This property sets the default/initial behaviour. Users can still turn automatic data retrieval on or off if they prefer, regardless of whether this property is set to | ||||||
table. | Whether to allow users to concatenate fields in tables:
More information: Disable Concatenation | ||||||
table. | Whether to allow users to create user defined fields, such as ranges and quantiles. Setting this option to
While setting this option to More information: Remove the Range Option | ||||||
table. | Whether to display the Print Table button in Table View:
| ||||||
table. | Whether to allow users to add fields to wafers in Table View:
| ||||||
table. | Whether to show totals by default when adding fields to the table. This setting does not apply when loading a saved table (which will load the totals state from the saved table).
More information: Disable Automatic Totals | ||||||
table. | Whether to allow users to drill up and down (navigate) through hierarchical fields in tables.
| ||||||
table. | Whether to use the saved table language when opening a saved system table (a TXD saved from SuperCROSS and stored in the txd directory on the SuperWEB2 server).
| ||||||
table. | Whether to display metadata as annotations at the bottom of the table. This setting only applies to multilingual datasets that have been configured to use metadata server for descriptive metadata.
More information: Display Metadata as Annotations Below the Table | ||||||
table. | Whether to allow users to create derivations in tables:
More information: Derivations | ||||||
table. | Whether to accept commas as the decimal separator when creating and editing derivations in Table View.
More information: Derivations | ||||||
table. | Whether to allow administrators to open TXD files in SuperWEB2.
Use of HTML in TXD-file table headings represents a potential security vulnerability. This vulnerability is partially mitigated by the fact that generally only Administrator users have access to create and upload TXD files that include HTML. However, to further mitigate against this vulnerability, the | ||||||
table. | Whether to completely remove totals or just hide them when a user toggles off totals in SuperWEB2:
The appropriate setting for your system will depend on the types of tables your users create. For non-additive tables, each total that is present will double the tabulation time. If your users create a lot of non-additive tables then you are recommended to set this property to For additive tables the performance benefit is negligible. If your users mostly create additive tables then you are recommended to leave this property set to | ||||||
table. | Whether to escape HTML in the table heading (supplied in a TXD file).
This setting mitigates a potential security threat by preventing HTML within the table heading of TXD files being rendered as HTML when the file is opened in SuperWEB2. | ||||||
table. | The priority calculation to use when table queries are submitted to SuperSERVER for tabulation. By default, all jobs are submitted with a priority of 0. The following example configures it to use the cell count based calculation:
CODE
| ||||||
table. | A configuration string to be passed to the priority calculation class set in
CODE
| ||||||
table. | The number of row and column cells to show in the table preview when SuperWEB2 enter large table mode. You can set this property to any positive integer value. If you do not give the property a value, it will use the default (3). More information: Configure Settings for Large Tables | ||||||
table. | The total cell threshold including wafers for entering large table mode. If the entire table (rows, columns and wafers) has more than this number of cells, SuperWEB2 will enter large table mode. This is primarily used to assist with tabulation performance and download size on the server side. For client rendering performance, You can set this property to any positive integer value. If you do not give the property a value, it will use the default (1000000). To disable this option, set the value to -1. More information: Configure Settings for Large Tables | ||||||
table. | The total cell threshold excluding wafers for entering large table mode. If the visible part of the table (rows and columns, excluding wafers) has more than this number of cells, SuperWEB2 will enter large table mode. This is used primarily for rendering performance on the client side. To assist with tabulation performance and download size on the server side, You can set this property to any positive integer value. If you do not give the property a value, it will use the default (100000). To disable this option, set the value to -1. More information: Configure Settings for Large Tables | ||||||
table. | The row threshold for entering large table mode. If the table has more than this number of rows, SuperWEB2 will enter large table mode. You can set this property to any positive integer value. If you do not give the property a value, it will use the default (8000). To disable this option, set the value to -1. More information: Configure Settings for Large Tables | ||||||
table. | The column threshold for entering large table mode. If the table has more than this number of columns, SuperWEB2 will enter large table mode. You can set this property to any positive integer value. If you do not give the property a value, it will use the default (1000). To disable this option, set the value to -1. More information: Configure Settings for Large Tables |
Custom Data Settings
Property | Description | ||||
---|---|---|---|---|---|
customData. | Whether to allow custom data group recodes for fields that are not Totals Appropriate enabled.
Open Data API Behaviour When Error example
CODE
| ||||
recordview.maxCells | The maximum number of cells of data that a user can download at a time from Record View. You can set this property to any integer value. If you do not give the property a value, it will use the default (100,000). More information: Enable or Disable Record View | ||||
graphView.maxCells | The maximum size of a table that can be visualised in Graph View. By default, there is a limit of 1,000 cells; if users create tables with more than this number of cells then they will not be able to access Graph View. If necessary, you can increase the cell limit to a higher amount. The limit only applies to the number of cells in the currently selected wafer, not the number of cells in the table as a whole. Set this to | ||||
graphView.maxFields | The maximum number of fields that the user can graph. As wafers and filters do not appear in the graph directly, only rows and columns count towards the limit. Set this to More information: Graph View |
Download Settings
Property | Description | ||||||
---|---|---|---|---|---|---|---|
download.enableQueueManager | Whether to enable the Job Queue Manager. This property takes the following values:
More information: Configure JQM | ||||||
download. | Whether to allow duplicate table names in the job queue:
More information: Configure JQM | ||||||
download.formatNumbers | Whether to format cell data in downloads. This setting is intended to be used if your users are working with extremely large tables (millions of cells), as it can provide a performance boost that dramatically reduces the time taken to download a table.
More information: Set Precision for Summation Options | ||||||
download.enableExcel2003 | Whether the option to download tables in Excel 2003 format should be available.
| ||||||
download.enableExcel2007 | Whether the option to download tables in Excel 2007 format should be available.
| ||||||
download.enableOpenDataApiQuery | Whether to allow users to download a table as an Open Data API query.
More information: Use SuperWEB2 to Build API Queries | ||||||
download.enableTxd | Whether to allow users to download queries in TXD format (via the Download Table drop-down in Table View):
More information: Download Tables |
Configuration Server Settings
Property | Description | ||||
---|---|---|---|---|---|
configServer.failOnUnknownProperties | What to do if any invalid or unknown SuperWEB2 configuration properties have been set using the SuperADMIN
More information: SuperADMIN |
Help and Metadata Settings
Property | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|
| These parameters define the URLs for the online help. You should not need to change these settings unless you want to replace the supplied user guide with your own customised version. These properties can be localised to enable you to provide different help files translated for different languages. If you have online help in multiple languages, you can create a new file called configuration_<locale>.properties (where <locale> is the relevant 2 character lower case ISO 639 language code) and include the relevant localised versions of these settings in it. In addition, the property names were renamed to better reflect where they appear. For backwards compatibility reasons, both the old and new names of the properties can continue to be used. More information: Customise the Online Help | ||||||||
metadata. | Whether to scan for metadata in the metadata database:
More information: Display Metadata Icons | ||||||||
metadata.tableIcons | Whether to display metadata in Table View, Graph View and Map View. For Table View, this setting only applies to the table itself. The
More information: Display Metadata Icons | ||||||||
metadata. | The cache settings for metadata in SuperWEB2. By default, SuperWEB2 is configured to cache data from the Metadata Server for 1 day. You can change this by editing this setting. There are a number of options you can set (see http://docs.guava-libraries.googlecode.com/git/javadoc/com/google/common/cache/CacheBuilderSpec.html for full details of the syntax), but the main change you are likely to want to make is to change how often SuperWEB2 automatically refreshes its cache. To do this, use the following setting:
CODE
Replace <duration> with the time between cache refreshes. Use the values For example, the following setting configures SuperWEB2 to refresh its cache every 10 minutes:
CODE
More information: Clear Metadata Cache | ||||||||
externalLink. | The URL to link to from the data confidentiality footnote in Table View. This property can be localised for different languages. To do this, create a new file called configuration_<locale>.properties (where <locale> is the relevant 2 character lower case ISO 639 language code) and include the localised version of this setting in it. | ||||||||
externalLink. | The base URL to link to for SuperWEB2 metadata. This property can be localised for different languages. To do this, create a new file called configuration_<locale>.properties (where <locale> is the relevant 2 character lower case ISO 639 language code) and include the localised version of this setting in it. More information: Metadata |
Login Settings
Property | Description | ||||
---|---|---|---|---|---|
login. | Whether to show a terms and conditions screen during login. The user must accept the terms in order to log in.
More information: Add a Terms and Conditions Screen | ||||
login. | The current version of the terms and conditions. Normally, users only need to accept the terms and conditions once. However, if your terms change then you can change this value to force all users to accept the new terms on their next login. More information: Add a Terms and Conditions Screen | ||||
login. | The username for the account to use for guest access. More information: Configure Guest Access | ||||
login. | The password to use for guest access. More information: Configure Guest Access | ||||
login. | The username for the account to use for guest access when a direct URL is used. If not specified, this will fall back to the value of More information: Configure Guest Access | ||||
login. | The password to use for guest access when a direct URL is used. If not specified, this will fall back to the value of More information: Configure Guest Access | ||||
externalLink. | The URL of the SuperWEB2 login page. This property can be localised for different languages. To do this, create a new file called configuration_<locale>.properties (where <locale> is the relevant 2 character lower case ISO 639 language code) and include the localised version of this setting in it. | ||||
externalLink. | A link used in the standard footer section at the bottom of SuperWEB2. This property can be localised for different languages. To do this, create a new file called configuration_<locale>.properties (where <locale> is the relevant 2 character lower case ISO 639 language code) and include the localised version of this setting in it. More information: Customise Header, Footer and Logo | ||||
link. | The destination the user will be redirected to when using the If you want to change this, you can either specify
More information: Use Direct URLs to Open a Specific Dataset or Table |
Map and Graph View Download Settings
Property | Description |
---|---|
pdfTemplateFonts | A list of fonts to embed in the downloaded PDF, separated by commas. You may need to configure font embedding if your PDF template uses a font that is not one of the default Adobe fonts. If you use a non standard font, then you can embed this in the PDF to ensure that it will display correctly regardless of whether users have that font installed on their computer. Specify the full path to the font file. If you want to embed multiple fonts, use commas to separate them. For example:
CODE
This property has been renamed from This property can be localised for different languages. To do this, create a new file called configuration_<locale>.properties (where <locale> is the relevant 2 character lower case ISO 639 language code) and include the localised version of this setting in it. More information: Branding PDF Downloads |
graph.graphPdfTemplate | The name and location of the template for graph view downloads. This can either be a relative path, in which case it will be relative to the context directory (by default this is <tomcat_home>\webapps\webapi) or an absolute path for the file system (for example The filename must include the You must escape any backslashes in the file path with an additional slash. For example: This property can be localised for different languages. To do this, create a new file called configuration_<locale>.properties (where <locale> is the relevant 2 character lower case ISO 639 language code) and include the localised version of this setting in it. More information: Branding PDF Downloads |
map.mapPdfTemplate | The name and location of the template for map view downloads. This can either be a relative path, in which case it will be relative to the context directory (by default this is <tomcat_home>\webapps\webapi ) or an absolute path for the file system (for example The filename must include the You must escape any backslashes in the file path with an additional slash. For example: This property can be localised for different languages. To do this, create a new file called configuration_<locale>.properties (where <locale> is the relevant 2 character lower case ISO 639 language code) and include the localised version of this setting in it. More information: Branding PDF Downloads |
map. | The value to set for the Author document property in PDF map downloads. This property can be localised for different languages. To do this, create a new file called configuration_<locale>.properties (where <locale> is the relevant 2 character lower case ISO 639 language code) and include the localised version of this setting in it. More information: Branding PDF Downloads |
map. | The Keywords to set in the document properties in PDF map downloads. This property can be localised for different languages. To do this, create a new file called configuration_<locale>.properties (where <locale> is the relevant 2 character lower case ISO 639 language code) and include the localised version of this setting in it. More information: Branding PDF Downloads |
map. | The value to set for the Application document property in PDF map downloads. This property can be localised for different languages. To do this, create a new file called configuration_<locale>.properties (where <locale> is the relevant 2 character lower case ISO 639 language code) and include the localised version of this setting in it. More information: Branding PDF Downloads |
kmz.author | The author name that will be embedded in KMZ files downloaded from Map View. More information: Branding KMZ Downloads |
kmz.atomLink | A web link that will be embedded in the extended parameters field in KMZ files downloaded from Map View. More information: Branding KMZ Downloads |
kmz.copyright | A copyright statement that will be embedded in KMZ files downloaded from Map View. More information: Branding KMZ Downloads |
kmz.logoOverlayPath | The full path to the location of a logo image on the server. This will be embedded in KMZ files downloaded from Map View. More information: Branding KMZ Downloads |
map.mapPdfMaxCacheItemSize | The number of PDFs to cache on the server after generating them. More information: Branding PDF Downloads |
map.mapArcGISEndpointPattern | The pattern to use when setting the ArcGIS endpoint URI. This is used to extract the service name and layer index for caching. The default value is More information: Caching Map Data |
map.mapCacheLocation | The location of the directory to store cache information for mapping. Make sure that the directory exists and that the user running Tomcat has permission to write to it. You must escape any backslashes in the file path with an additional slash. For example:
CODE
Forward slashes do not need to be escaped. For example:
CODE
If no directory is specified, then SuperWEB2 will use the default location: <tomcat_home>\work\Catalina\localhost\webapi More information: Caching Map Data |
map.mapCacheSize | The maximum size of the in memory map data cache. This does not affect the size of the disk cache, which is not capped. The default value is
CODE
More information: Caching Map Data |
map.mapCacheExpiryTime | The expiry time for in memory cache entries. This does not affect the disk cache which can be manually expired by deleting the files. The default value is More information: Caching Map Data |
map.useCacheForFeatureQueries | This property can be used to disable the use of the cache for feature queries. It is not present in configuration.properties by default, but if required the following property can be added to disable the cache:
CODE
More information: Caching Map Data |
User Preferences Settings
Property | Description | ||||
---|---|---|---|---|---|
preferences.usersCanEditPreferences | Whether users can access the Account page options in SuperWEB2.
More information: Change the Sort Order of Tables and Datasets | ||||
preferences.usersCanChangePassword | Whether users can change their password in SuperWEB2 (via the Account page).
| ||||
preferences.usersCanDeleteAccount | Whether users can delete their account in SuperWEB2 (via the Account page).
| ||||
preferences. | Whether users can opt in or out of email updates from the Account page.
More information: Regulatory and Privacy Compliance | ||||
preferences.allowContactDefault | Whether the default setting for the user contact preference is opt in or opt out:
More information: Regulatory and Privacy Compliance |
CSV Download Settings
Property | Description | ||||
---|---|---|---|---|---|
csv. | The output encoding to use for CSV files downloaded from SuperWEB2. By default, CSV files will be downloaded in UTF-8 encoding. You may need to change this to use a specific Windows codepage in some cases. For example, some versions of Microsoft Excel (including Excel 2003) have a bug that causes them not to support UTF-8 encoding when CSV files are opened either by double clicking the file or selecting Open from the download option in a web browser. If your users are experiencing problems opening downloaded CSV files in Excel, you may need to set SuperWEB2 to use a specific Windows codepage. See this page for a list of available codepages. When configuring SuperWEB2, you need to use the value from the Name column. For example, to use the Windows CP-1252 codepage, you would configure SuperWEB2 using one of the following values:
CODE
Or:
CODE
| ||||
csv. | The input encoding to use when uploading user recode files. If this is not set it will fall back to the value of | ||||
numberFormat. | Whether to use custom number formatting for values in range and quantile labels.
More information: Configure Quantiles and Ranges | ||||
numberFormat. | The number formatting to use for values in range and quantile labels. See http://docs.oracle.com/javase/7/docs/api/java/text/DecimalFormat.html for details of how to specify the number formatting. Note that:
More information: Configure Quantiles and Ranges | ||||
udr. | The size of chunks to use when connecting to the user data repository. Some relational databases have a limit on the number of parameters that can be used in the WHERE clause of a SELECT query. Queries that are likely to overrun this limit are broken up into chunks and run in parts to avoid errors. The default setting for this value is 1000, which should work for all supported databases. | ||||
udr. | The ability to upload saved tables to the catalogue in the SuperADMIN console using the If you wish to continue using this feature, it can be enabled by adding the property The communication between SuperADMIN and SuperWEB2 involved in the process of uploading tables uses a specific header in all requests, More information: cat and Configure Folders and Shared Tables |
Open Data API Settings
The following settings apply to the Open Data API only. While they appear in the standard version of configuration.properties supplied with SuperWEB2, changing them in that version of the file will have no effect. The Open Data API has its own copy of the configuration.properties file (located in <tomcat_home>\webapps\webapi#rest#v1\WEB-INF\classes). If you want to configure the Open Data API then you must make the changes in the API's copy of the configuration file.
Property | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|
openDataApi.schema.pageSize | If a query to the Open Data API returns a large number of results then it will be paginated. By default, this occurs when there are more than 100 objects in the result set. You can use this setting to increase of decrease the limit for pagination. More information: Configure API Performance Settings | ||||||||
openDataApi.schema. | The number of requests that any given API key can make within a one hour period. This property has been deprecated. It can still be used, but you are strongly recommended to remove this from your configuration and use the new More information: Configure API Performance Settings | ||||||||
openDataApi.table. | The maximum number of cells that can be returned to a client via the More information: Configure API Performance Settings | ||||||||
openDataApi.table. | The maximum number of field items that a user can query via the More information: Configure API Performance Settings | ||||||||
openDataApi.table. | Whether to allow the use of Single UDFs in queries. This setting is provided as a security measure.
| ||||||||
openDataApi. | The number of requests that any given API key can make within a one hour period. If you do not want to impose any limits, set this to More information: Configure API Performance Settings | ||||||||
openDataApi. | The number of requests to the If you have also set a limit using the More information: Configure API Performance Settings | ||||||||
openDataApi. | The number of requests to the If you have also set a limit using the More information: Configure API Performance Settings | ||||||||
openDataApi. | The maximum number of entries stored in the authentication cache. This cache is designed to speed up authentication in situations where the authentication process is slow (for example because the Open Data API and the authentication server are separated by a slow network connection). If the authentication process is fast, then you are recommended to disable the authentication cache by setting this value to The default is More information: Configure the Cache | ||||||||
openDataApi. | How quickly an authentication entry will expire from the cache. Specify the value as an integer, followed by one of the following units:
For example, The default is More information: Configure the Cache | ||||||||
openDataApi. | The units to use when setting the size of the table cache. This setting applies to the value specified for the
More information: Configure the Cache | ||||||||
openDataApi. | The size of the cache in either megabytes, gigabytes or total entries (depending on the value of To disable the table cache entirely, set this to The default is More information: Configure the Cache | ||||||||
openDataApi. | Whether the cache expiry time is reset when a result is accessed from the cache:
More information: Configure the Cache | ||||||||
openDataApi. | How quickly a table result will expire from the cache. Specify the value as an integer, followed by one of the following units:
For example, The default is More information: Configure the Cache | ||||||||
openDataApi. | Whether the table cache should use soft or hard memory references to hold its contents:
More information: Configure the Cache | ||||||||
openDataApi. | The units to use when setting the size of the schema cache. This setting applies to the value specified for the
More information: Configure the Cache | ||||||||
openDataApi. | The size of the cache in either megabytes, gigabytes or total entries (depending on the value of To disable the schema cache entirely, set this to The default is More information: Configure the Cache | ||||||||
openDataApi. | Whether the cache expiry time is reset when a query is accessed from the cache:
More information: Configure the Cache | ||||||||
openDataApi. | How quickly a schema result will expire from the cache. Specify the value as an integer, followed by one of the following units:
For example, The default is More information: Configure the Cache | ||||||||
openDataApi. | Whether the schema cache should use soft or hard memory references to hold its contents:
More information: Configure the Cache |