Namespace: AppConfig

AppConfig

An object that contains the configuration for this MetacatUI application. These values are set directly on the AppModel when it is initialized and can be accessed from anywhere in the application through the AppModel. (e.g. `MetacatUI.appModel.get("attribute")`` )
Source:

Members

accessPolicyName :string

The user-facing name for editing the Access Policy. This is displayed as the header of the AccessPolicyView, for example
Type:
  • string
Since:
  • 2.9.0
Default Value:
  • "Sharing options"
Source:

accessRuleOptionNames :object

Type:
  • object
Properties:
Name Type Description
accessRuleOptionNames.read boolean The user-facing name of the "read" access in Access Rules
accessRuleOptionNames.write boolean The user-facing name of the "write" access in Access Rules
accessRuleOptionNames.changePermission boolean The user-facing name of the "changePermission" access in Access Rules
Since:
  • 2.9.0
Source:
Example
{
   read: "Can view",
   write: "Can edit",
   changePermission: "Is owner"
 }

accessRuleOptions :object

Type:
  • object
Properties:
Name Type Description
accessRuleOptions.read boolean If true, users will be able to give others read access to their DataONE objects
accessRuleOptions.write boolean If true, users will be able to give others write access to their DataONE objects
accessRuleOptions.changePermission boolean If true, users will be able to give others changePermission access to their DataONE objects
Since:
  • 2.9.0
Default Value:
  • { read: true, write: true, changePermission: true }
Source:
Example
{
  read: true,
  write: true,
  changePermission: false
}
// This example would enable users to edit the read and write access to files,
// but not change ownership, in the Access Policy View.

accountsMapsUrl :string

The URL for the DataONE mapIdentity() API This URL is constructed dynamically once the AppModel is initialized. (see https://releases.dataone.org/online/api-documentation-v2.0/apis/CN_APIs.html#CNIdentity.mapIdentity)
Type:
  • string
Source:

accountsUrl :string

The URL for the DataONE Identity API This URL is constructed dynamically once the AppModel is initialized. (see https://releases.dataone.org/online/api-documentation-v2.0/apis/CN_APIs.html#module-CNIdentity)
Type:
  • string
Source:

activeAlternateRepositoryId :string

The node identifier of the alternate repository that is used for fetching and saving DataONEObjects. this attribute is dynamically set by MetacatUI to keep track of the currently active alt repo. To specify a repository that should be active by default, set AppConfig#defaultAlternateRepositoryId
Type:
  • string
Since:
  • 2.14.0
Source:
Example
"urn:node:METACAT"

allowAccessPolicyChanges :boolean

If true, users can change the AccessPolicy for any of their objects. This is equivalent to setting AppConfig#allowAccessPolicyChangesPortals and AppConfig#allowAccessPolicyChangesDatasets to `true`.
Type:
  • boolean
Since:
  • 2.9.0
Default Value:
  • true
Source:

allowAccessPolicyChangesDatasets :boolean

If true, users can change the AccessPolicy for their datasets only.
Type:
  • boolean
Since:
  • 2.15.0
Default Value:
  • true
Source:

allowAccessPolicyChangesDatasetsForSubjects :boolean

Limit dataset Access policy editing to only a defined list of people or groups. To let everyone edit access policies for their own objects, keep this as an empty array and make sure AppConfig#allowAccessPolicyChangesDatasets is set to `true`
Type:
  • boolean
Since:
  • 2.15.0
Default Value:
  • true
Source:

allowAccessPolicyChangesPortals :boolean

If true, users can change the AccessPolicy for their portals only.
Type:
  • boolean
Since:
  • 2.15.0
Default Value:
  • true
Source:

allowAccessPolicyChangesPortalsForSubjects :boolean

Limit portal Access policy editing to only a defined list of people or groups. To let everyone edit access policies for their own objects, keep this as an empty array and make sure AppConfig#allowAccessPolicyChangesPortals is set to `true`
Type:
  • boolean
Since:
  • 2.15.0
Default Value:
  • []
Source:

allowChangeRightsHolder :boolean

If false, users will not be able to change the rightsHolder of a resource in the AccessPolicyView
Type:
  • boolean
Since:
  • 2.9.0
Default Value:
  • true
Source:

alternateRepositories :Array.<object>

A list of alternate repositories to use for fetching and saving DataONEObjects. In the AppConfig, this is an array of NodeModel#members attributes, in JSON form. These are the same attributes retireved from the Node Info document, via the d1/mn/v2/node API. The only required attributes are name, identifier, and baseURL.
Type:
  • Array.<object>
Since:
  • 2.14.0
Source:
Example
[{
   name: "Metacat MN",
   identifier: "urn:node:METACAT",
   baseURL: "https://my-metacat.org/metacat/d1/mn"
 }]

archivedContentIsIndexed :boolean

If true, then archived content is available in the search index. Set to false if this MetacatUI is using a Metacat version before 2.10.0
Type:
  • boolean
Default Value:
  • true
Source:

authServiceUrl :string

The URL for the DataONE isAuthorized() API. This URL is contructed dynamically when the AppModel is initialized. Only override this if you are an advanced user and have a reason to! (see https://releases.dataone.org/online/api-documentation-v2.0/apis/MN_APIs.html#MNAuthorization.isAuthorized)
Type:
  • string
Source:

baseUrl :string

The base URL for the repository. This only needs to be changed if the repository is hosted at a different origin than the MetacatUI origin. This URL is used to contruct all of the DataONE REST API URLs. If you are testing MetacatUI against a development repository at an external location, this is where you would set that external repository URL.
Type:
  • string
Default Value:
  • window.location.origin || (window.location.protocol + "//" + window.location.host)
Source:

bioportalAPIKey :string

Semantic annotation configuration Include your Bioportal api key to show ontology information for metadata annotations see: http://bioportal.bioontology.org/account
Type:
  • string
Source:

bioportalLookupCache :object

This attribute stores cache of ontology information that is looked up in Bioportal, so that duplicate REST calls don't need to be made.
Type:
  • object
Source:

bioportalSearchUrl :string

The Bioportal REST API URL, which is set dynamically only if a bioportalAPIKey is configured
Type:
  • string
Default Value:
  • "https://data.bioontology.org/search"
Source:

bookkeeperBaseUrl :string

The base URL for the DataONE Bookkeeper services, which manage the DataONE membership plans, such as Hosted Repositories and Plus. See https://github.com/DataONEorg/bookkeeper for more info on this service.
Type:
  • string
Since:
  • 2.14.0
Source:

bookkeeperCustomersUrl :string

The URL for the DataONE Bookkeeper Customers API, e.g. listCustomers(), getCustomer(), createCustomer(), etc. This full URL is contructed using AppModel#bookkeeperBaseUrl when the AppModel is initialized.
Type:
  • string
Since:
  • 2.14.0
Source:

bookkeeperQuotasUrl :string

The URL for the DataONE Bookkeeper Quota API, e.g. listQuotas(), getQuota(), createQuota(), etc. This full URL is contructed using AppModel#bookkeeperBaseUrl when the AppModel is initialized.
Type:
  • string
Since:
  • 2.14.0
Source:

bookkeeperSubscriptionsUrl :string

The URL for the DataONE Bookkeeper Subscriptions API, e.g. listSubscriptions(), fetchSubscription(), createSubscription(), etc. This full URL is contructed using AppModel#bookkeeperBaseUrl when the AppModel is initialized.
Type:
  • string
Since:
  • 2.14.0
Source:

bookkeeperUsagesUrl :string

The URL for the DataONE Bookkeeper Usages API, e.g. listUsages(), getUsage(), createUsage(), etc. This full URL is contructed using AppModel#bookkeeperBaseUrl when the AppModel is initialized.
Type:
  • string
Since:
  • 2.14.0
Source:

checkTokenUrl :string

The URL for the DataONE echoCredentials() API This URL is constructed dynamically once the AppModel is initialized. (see https://releases.dataone.org/online/api-documentation-v2.0/apis/CN_APIs.html#CNDiagnostic.echoCredentials)
Type:
  • string
Source:

collectionQueryExcludeFields :Array.<string>

The metadata fields to hide when a user is creating a collection definition using the query builder displayed in the portal builder on the data page, or anywhere else the EditCollectionView is displayed. Strings listed here should exactly match the 'name' for each field provided by the DataONE search index API (i.e. should match the Solr field).
Type:
  • Array.<string>
Source:
Example
["sem_annotated_by", "mediaType"]

collectionQuerySpecialFields :Array.<SpecialField>

A list of additional fields which are not retrieved from the query API (i.e. are not Solr fields), but which should be added to the list of options the user can select from when building a query in the EditCollectionView. This can be used to add abstracted fields which are a combination of multiple query fields, or to add a duplicate field that has a different label.
Type:
Since:
  • 2.15.0
Source:

context :string

The directory that metacat is installed in at the `baseUrl`. For example, if you have metacat installed in the tomcat webapps directory as `metacat`, then this should be set to "/metacat". Or if you renamed the metacat webapp to `catalog`, then it should be `/catalog`.
Type:
  • string
Default Value:
  • "/metacat"
Source:

d1CNBaseUrl :string

The base URL of the DataONE Coordinating Node (CN). CHange this if you are testing a deployment in a development environment.
Type:
  • string
Default Value:
  • "https://cn.dataone.org"
Source:
Example
"https://cn-stage.test.dataone.org"

d1CNService :string

The URL fragment for the DataONE Coordinating Node (CN) API.
Type:
  • string
Default Value:
  • '/cn/v2'
Source:

d1LogServiceUrl :string

The URL for the DataONE log service. This service has been replaced with the DataONE metrics service (which has not been publicly released), so this configuration will be deprecated in the future. This URL is constructed dynamically upon AppModel intialization.
Type:
  • string
Deprecated:
  • Yes
Source:

d1Service :string

The URL fragment for the DataONE Member Node (MN) API.
Type:
  • string
Default Value:
  • '/d1/mn/v2'
Source:

dashboardUrl :string

The Whole Tale endpoint
Type:
  • string
Default Value:
  • 'https://girder.wholetale.org/api/v1/integration/dataone'
Source:

dataoneCitationsUrl :string

DataONE Citation reporting endpoint url
Type:
  • string
Source:

dataonePlusName :string

The name of the DataONE Plus membership plan, which is used in messaging throughout the UI. This is only used if the enableBookkeeperServices setting is set to true.
Type:
  • string
Default Value:
  • "DataONE Plus"
Source:

dataoneSearchUrl :string

The URL for the DataONE Search MetacatUI. This only needs to be changed if you want to point to a development environment.
Type:
  • string
Since:
  • 2.13.0
Default Value:
  • "https://search.dataone.org"
Source:

datasetMapFillColor :string

The bounding box fill color to use in the Google Static Map images on the dataset landing pages. If you don't want to fill in the bounding boxes with a color, set this to null or undefined. Specify the color either as a 24-bit (example: color=0xFFFFCC) or 32-bit hexadecimal value (example: color=0xFFFFCCFF), or from the set: black, brown, green, purple, yellow, blue, gray, orange, red, white. For more information, see the Google Statis Maps API docs: https://developers.google.com/maps/documentation/maps-static/start#PathStyles
Type:
  • string
Since:
  • 2.13.0
Default Value:
  • "0xFFFF0033" (light yellow)
Source:

datasetMapPathColor :string

The bounding box path color to use in the Google Static Map images on the dataset landing pages. Specify the color either as a 24-bit (example: color=0xFFFFCC) or 32-bit hexadecimal value (example: color=0xFFFFCCFF), or from the set: black, brown, green, purple, yellow, blue, gray, orange, red, white. For more information, see the Google Statis Maps API docs: https://developers.google.com/maps/documentation/maps-static/start#PathStyles
Type:
  • string
Since:
  • 2.13.0
Default Value:
  • "0xDA4D3Aff" (red)
Source:

defaultAccessPolicy :Array.<object>

The default AccessPolicy set on new objects uploaded to the repository. Each literal object here gets set directly on an AccessRule model. See the AccessRule list of default attributes for options on what to set here.
Type:
  • Array.<object>
Since:
  • 2.9.0
Default Value:
  • [{ subject: "public", read: true }]
Source:
See:
Example
[{
  subject: "public",
  read: true
}]
// This example would assign public access to all new objects created in MetacatUI.

defaultAlternateRepositoryId :string

The node identifier of the alternate repository that should be used for fetching and saving DataONEObjects. Since there can be multiple alternate repositories configured, this attribute can be used to specify which one is actively in use.
Type:
  • string
Since:
  • 2.14.0
Source:
Example
"urn:node:METACAT"

defaultFilterGroups :Array.<object>

The default FilterGroups to use in the data catalog search (DataCatalogViewWithFilters) The DataCatalogViewWithFilters is only used in the EditCollectionView (when editing collections or portals), as of 2.9.0 To change the default filters in the main data search view (DataCatalogView), edit the `defaultSearchFilters` attribute here. This is an array of literal objects that will be converted into FilterGroup models
Type:
  • Array.<object>
Source:

defaultSearchFilters :Array.<string>

The search filters that will be displayed in the search views. Add or remove filter names from this array to show or hide them. See "example" to see all the filter options.
Type:
  • Array.<string>
Default Value:
  • ["all", "attribute", "documents", "creator", "dataYear", "pubYear", "id", "taxon", "spatial"]
Source:
Example
["all", "annotation", "attribute", "dataSource", "documents", "creator", "dataYear", "pubYear", "id", "taxon", "spatial"]

disableQueryPOSTs :boolean

If set to false, some parts of the app will send POST HTTP requests to the Solr search index via the `/query/solr` DataONE API. Set this configuration to true if using Metacat 2.10.2 or earlier
Type:
  • boolean
Source:

displayDatasetAnalyzeButton :boolean

If true, displays the WholeTale "Analyze" button on the dataset landing page
Type:
  • boolean
Default Value:
  • false
Source:

displayDatasetCitationMetric :boolean

If true, displays the dataset citation metrics on the dataset landing page Turn off all dataset metrics displays using the AppConfig#displayDatasetMetrics
Type:
  • boolean
Default Value:
  • true
Source:

displayDatasetControls :boolean

If true, displays various buttons on the dataset landing page for dataset owners
Type:
  • boolean
Default Value:
  • false
Source:

displayDatasetDownloadMetric :boolean

If true, displays the dataset download metrics on the dataset landing page Turn off all dataset metrics displays using the AppConfig#displayDatasetMetrics
Type:
  • boolean
Default Value:
  • true
Source:

displayDatasetEditButton :boolean

If true, displays the "Edit" button on the dataset landing page
Type:
  • boolean
Default Value:
  • true
Source:

displayDatasetMetrics :boolean

Metrics flag for the Dataset Landing Page Enable this flag to enable metrics display
Type:
  • boolean
Default Value:
  • true
Source:

displayDatasetMetricsTooltip :boolean

If true, displays the dataset metrics tooltips on the metrics buttons. Turn off all dataset metrics displays using the AppConfig#displayDatasetMetrics
Type:
  • boolean
Default Value:
  • true
Source:

displayDatasetQualityMetric :boolean

If true, displays the metadata assessment metrics on the dataset landing page
Type:
  • boolean
Default Value:
  • false
Source:

displayDatasetViewMetric :boolean

If true, displays the dataset view metrics on the dataset landing page Turn off all dataset metrics displays using the AppConfig#displayDatasetMetrics
Type:
  • boolean
Default Value:
  • true
Source:

displayDownloadButtonInSearchResults :boolean

Show or hide the Download button in the search result rows
Type:
  • boolean
Default Value:
  • false
Source:

displayMetricModals :boolean

If true, displays the datasets metric modal windows on the dataset landing page Turn off all dataset metrics displays using the AppConfig#displayDatasetMetrics
Type:
  • boolean
Default Value:
  • true
Source:

displayRegisterCitationTool :boolean

If true, displays the citation registration tool on the dataset landing page
Type:
  • boolean
Since:
  • 2.15.0
Default Value:
  • true
Source:

displayRepoLogosInSearchResults :boolean

Show or hide the source repository logo in the search result rows
Type:
  • boolean
Default Value:
  • false
Source:

displayRightsHolderInAccessPolicy :boolean

If false, the rightsHolder of a resource will not be displayed in the AccessPolicyView.
Type:
  • boolean
Since:
  • 2.9.0
Default Value:
  • true
Source:

editableFormats :Array.<string>

An array of science metadata format IDs that are editable in MetacatUI. Metadata documents with these format IDs will have an Edit button and will be editable in the Editor Views. This should only be changed if you have extended MetacatUI to edit a new format, or if you want to disable editing of a specific format ID.
Type:
  • Array.<string>
Default Value:
  • [ "eml://ecoinformatics.org/eml-2.1.1", "https://eml.ecoinformatics.org/eml-2.2.0" ]
Source:
Example
[
   "eml://ecoinformatics.org/eml-2.1.1",
   "https://eml.ecoinformatics.org/eml-2.2.0"
 ]

editorSaveButtonText :string

The text of the Save button in the dataset editor.
Type:
  • string
Since:
  • 2.13.3
Default Value:
  • "Save dataset"
Source:

editorSaveErrorMsg :string

This error message is displayed when the Editor encounters an error saving
Type:
  • string
Source:

editorSaveErrorMsgWithDraft :string

This error message is displayed when the Editor encounters an error saving, and a plain-text draft is saved instead
Type:
  • string
Source:

editorSchemaLocation :string

The XML schema location the dataset editor will use when creating new EML. This should correspond with AppConfig#editorSerializationFormat
Type:
  • string
Since:
  • 2.13.0
Default Value:
  • "https://eml.ecoinformatics.org/eml-2.2.0 https://eml.ecoinformatics.org/eml-2.2.0/eml.xsd"
Source:

editorSerializationFormat :string

The format ID the dataset editor serializes new EML as
Type:
  • string
Since:
  • 2.13.0
Default Value:
  • "https://eml.ecoinformatics.org/eml-2.2.0"
Source:

emailContact :string

The e-mail address that people should contact when they need help with submitting datasets, resolving error messages, etc.
Type:
  • string
Default Value:
  • knb-help@nceas.ucsb.edu
Source:

emlEditorRequiredFields :object

A list of all the required fields in the EML Editor. Any field set to `true` will prevent the user from saving the Editor until a value has been given Any EML field not supported in this list cannot be required.
Type:
  • object
Properties:
Name Type Description
abstract boolean Default: true
alternateIdentifier boolean Default: false
funding boolean Default: false
generalTaxonomicCoverage boolean Default: false
taxonCoverage boolean Default: false. If true, at least one taxonomic rank and value will be required.
geoCoverage boolean Default: false. If true, at least one geographic coverage description and point/bounding box will be required.
intellectualRights boolean Default: true
keywordSets boolean Default: false. If true, at least one keyword will be required.
methods boolean Default: false. If true, at least one method step will be required.
samplingDescription boolean Default: false
studyExtentDescription boolean Default: false
temporalCoverage boolean Default: false. If true, at least a beginDate will be required.
title boolean Default: true. EML documents always require a title. Only set this to false if you are extending MetacatUI to ensure a title another way.
Default Value:
  • { abstract: true, alternateIdentifier: false, funding: false, generalTaxonomicCoverage: false, taxonCoverage: false, geoCoverage: false, intellectualRights: true, keywordSets: false, methods: false, samplingDescription: false, studyExtentDescription: false, temporalCoverage: false, title: true }
Source:
Example
{
   abstract: true,
   alternateIdentifier: false,
   funding: false,
   generalTaxonomicCoverage: false,
   taxonCoverage: false,
   geoCoverage: false,
   intellectualRights: true,
   keywordSets: false,
   methods: false,
   samplingDescription: false,
   studyExtentDescription: false,
   temporalCoverage: false,
   title: true
 }

emlKeywordThesauri :Array.<object>

A list of keyword thesauri options for the user to choose from in the EML Editor. A "None" option will also always display.
Type:
  • Array.<object>
Properties:
Name Type Description
label string A readable and short label for the keyword thesaurus that is displayed in the UI
thesaurus string The exact keyword thesaurus name that will be saved in the EML
Since:
  • 2.10.0
Default Value:
  • [{ label: "GCMD", thesaurus: "NASA Global Change Master Directory (GCMD)" }]
Source:
Example
[{
   label: "GCMD",
   thesaurus: "NASA Global Change Master Directory (GCMD)"
 }]

enableBookkeeperServices :boolean

Enable or disable the DataONE Bookkeeper services. If enabled, Portal Views will use the DataONE Plus paid features for active subscriptions. If disabled, the Portal Views will assume all portals are in inactive/free, and will only render free features.
Type:
  • boolean
Since:
  • 2.14.0
Source:

enableCILogonSignIn :boolean

If true, users can sign in using CILogon as the identity provider. ORCID is the only recommended identity provider. CILogon may be deprecated in the future.
Type:
  • boolean
Default Value:
  • false
Source:

enableCreatePortals :boolean

Set to false to prevent ANYONE from creating a new portal.
Type:
  • boolean
Default Value:
  • true
Source:

enableLdapSignIn :boolean

Enable DataONE LDAP authentication. If true, users can sign in from an LDAP account that is in the DataONE CN LDAP directory. This is not recommended, as DataONE is moving towards supporting only ORCID logins for users. This LDAP authentication is separate from the File-based authentication for the Metacat Admin interface.
Type:
  • boolean
Since:
  • 2.11.0
Default Value:
  • false
Source:

enableMonitorStatus :boolean

If false, the /monitor/status (the service that returns the status of various DataONE services) will not be used.
Type:
  • boolean
Since:
  • 2.9.0
Default Value:
  • true
Source:

enablePublishDOI :boolean

If true, users can see a "Publish" button in the MetadataView, which makes the metadata document public and gives it a DOI identifier. If false, the button will be hidden completely.
Type:
  • boolean
Default Value:
  • true
Source:

enablePublishDOIForSubjects :Array.<string>

A list of users or groups who exclusively will be able to see and use the "Publish" button, which makes the metadata document public and gives it a DOI identifier. Anyone not in this list will not be able to see the Publish button. `enablePublishDOI` must be set to `true` for this to take effect.
Type:
  • Array.<string>
Source:

enableSolrJoins :boolean

If set to true, some parts of the app will use the Solr Join Query syntax when sending queries to the `/query/solr` DataONE API. If this is not enabled, then some parts of the UI may not work if a query has too many characters or has too many boolean clauses. This impacts the "Metrics" tabs of portals/collections, at least. The Solr Join Query Parser as added in Solr 4.0.0-ALPHA (I believe!): https://archive.apache.org/dist/lucene/solr/4.0.0/changes/Changes.html#4.0.0-alpha.new_features About the Solr Join Query Parser: https://lucene.apache.org/solr/guide/8_5/other-parsers.html#join-query-parser WARNING: At some point, MetacatUI will deprecate this configuration and will REQUIRE Solr Join Queries
Type:
  • boolean
Source:

enableUserProfiles :boolean

Enable or disable the user profiles. If enabled, users will see a "My profile" link and can view their datasets, metrics on those datasets, their groups, etc.
Type:
  • boolean
Default Value:
  • true
Source:

enableUserProfileSettings :boolean

Enable or disable the user settings view. If enabled, users will see a list of changeable settings - name, email, groups, portals, etc.
Type:
  • boolean
Default Value:
  • true
Source:

formatsServiceUrl :string

The URL for the DataONE Formats API. This URL is contructed dynamically when the AppModel is initialized. Only override this if you are an advanced user and have a reason to! (see https://releases.dataone.org/online/api-documentation-v2.0/apis/CN_APIs.html#CNCore.listFormats)
Type:
  • string
Source:

formatsUrl :string

The URL fragment for the DataONE Formats API. This is combined with the AppConfig#formatsServiceUrl
Type:
  • string
Default Value:
  • "/formats"
Source:

googleAnalyticsKey :string

Your Google Analytics API key, which is used to send page view and custom events to the Google Analytics service. This service is optional in MetacatUI. Sign up for Google Analytics services at https://analytics.google.com/analytics/web/
Type:
  • string
Default Value:
  • null
Source:
Example
"UA-74622301-1"

grantsUrl :string

The URL for the NSF Award API, which can be used by the LookupModel to look up award information for the dataset editor or other views
Type:
  • string
Default Value:
  • "https://api.nsf.gov/services/v1/awards.json"
Source:

groupsUrl :string

The URL for the DataONE Groups API This URL is constructed dynamically once the AppModel is initialized. (see https://releases.dataone.org/online/api-documentation-v2.0/apis/CN_APIs.html#CNIdentity.createGroup)
Type:
  • string
Source:

hiddenSubjectsInAccessPolicy :Array.<string>

A list of group subjects that will be hidden in the AccessPolicy view to everyone except those in the group. This is useful for preventing users from removing repository administrative groups from access policies.
Type:
  • Array.<string>
Since:
  • 2.9.0
Source:
Example
["CN=data-admin-group,DC=dataone,DC=org"]

hideIsPartOfFilter :boolean

The isPartOf filter is added to all new portals built in the Portal Builder automatically. It is required for dataset owners to include their dataset in a specific portal collection. By default, this filter is hidden. Set to false to make this filter visible.
Type:
  • boolean
Source:

hideMetricsWhen :object

Hide metrics display for SolrResult models that match the given properties. Properties can be functions, which are given the SolrResult model value as a parameter. Turn off all dataset metrics displays using the AppConfig#displayDatasetMetrics
Type:
  • object
Source:
Example
{
  formatId: "eml://ecoinformatics.org/eml-2.1.1",
  isPublic: true,
  dateUploaded: function(date){
    return new Date(date) < new Date('1995-12-17T03:24:00');
  }
}
// This example would hide metrics for any objects that are:
//  EML 2.1.1 OR public OR were uploaded before 12/17/1995.

hideReportCitationButton :boolean

Hide or show the report Citation button in the dataset landing page.
Type:
  • boolean
Default Value:
  • true
Source:

hideSummaryCitationsChart :boolean

Hide or show the aggregated citations chart in the StatsView. These charts are only available for DataONE Plus members or Hosted Repositories. (see https://dataone.org)
Type:
  • boolean
Since:
  • 2.9.0
Default Value:
  • true
Source:

hideSummaryDownloadsChart :boolean

Hide or show the aggregated downloads chart in the StatsView These charts are only available for DataONE Plus members or Hosted Repositories. (see https://dataone.org)
Type:
  • boolean
Since:
  • 2.9.0
Default Value:
  • true
Source:

hideSummaryMetadataAssessment :boolean

Hide or show the aggregated metadata assessment chart in the StatsView These charts are only available for DataONE Plus members or Hosted Repositories. (see https://dataone.org)
Type:
  • boolean
Since:
  • 2.9.0
Default Value:
  • true
Source:

hideSummaryViewsChart :boolean

Hide or show the aggregated views chart in the StatsView These charts are only available for DataONE Plus members or Hosted Repositories. (see https://dataone.org)
Type:
  • boolean
Since:
  • 2.9.0
Default Value:
  • true
Source:

inheritAccessPolicy :boolean

When new data objects are added to a DataPackage, they can either inherit the AccessPolicy from the parent metadata object, or default to the AppConfig#defaultAccessPolicy. To inherit the AccessPolicy from the parent metadata object, set this config to `true`.
Type:
  • boolean
Since:
  • 2.15.0
Default Value:
  • true
Source:

isCN :boolean

If true, this MetacatUI instance is pointing to a CN rather than a MN. This attribute is set during the AppModel initialization, based on the other configured attributes.
Type:
  • boolean
Source:

isJSONLDEnabled :boolean

If true, the dataset landing pages will generate Schema.org-compliant JSONLD and insert it into the page.
Type:
  • boolean
Default Value:
  • true
Source:

limitPortalsToSubjects :Array.<string>

Limits only the following people or groups to create new portals. If this is left as an empty array, then any logged-in user can create a portal.
Type:
  • Array.<string>
Source:

mapKey :string

Your Google Maps API key, which is used to diplay interactive maps on the search views and static maps on dataset landing pages. If a Google Maps API key is no specified, the maps will be omitted from the interface. Sign up for Google Maps services at https://console.developers.google.com/
Type:
  • string
Default Value:
  • null
Source:
Example
"AIzaSyCYyHnbIokUEpMx5M61ButwgNGX8fIHUs"

maxDownloadSize :number

The maximum dataset .zip file size, in bytes, that a user can download. Datasets whose total size are larger than this maximum will show a disabled "Download All" button, and users will be directed to download files individually. This is useful for preventing the Metacat package service from getting overloaded.
Type:
  • number
Default Value:
  • 3000000000
Source:

mdqAggregatedSuiteIds :Array.<string>

Metadata Assessment Suite IDs for the aggregated assessment charts
Type:
  • Array.<string>
Default Value:
  • ["FAIR-suite-0.3.1"]
Source:

mdqAggregatedSuiteLabels :Array.<string>

Metadata Assessment Suite labels for the aggregated assessment charts
Type:
  • Array.<string>
Default Value:
  • ["FAIR Suite v0.3.1"]
Source:

mdqBaseUrl :string

The URL for the DataONE metadata assessment service
Type:
  • string
Default Value:
  • "https://docker-ucsb-4.dataone.org:30443/quality"
Source:

mdqFormatIds :Array.<string>

The metadata formats for which to display metadata assessment reports
Type:
  • Array.<string>
Default Value:
  • ["eml*", "https://eml*", "*isotc211*"]
Source:

mdqSuiteIds :Array.<string>

Metadata Assessment Suite IDs for the dataset assessment reports.
Type:
  • Array.<string>
Default Value:
  • ["FAIR-suite-0.3.1"]
Source:

mdqSuiteLabels :Array.<string>

Metadata Assessment Suite labels for the dataset assessment reports
Type:
  • Array.<string>
Default Value:
  • ["FAIR Suite v0.3.1"]
Source:

metacatServiceUrl :string

The URL for the Metacat API. The Metacat API has been deprecated and is kept here for compatability with Metacat repositories that are using the old x509 certificate authentication mechanism. This is deprecated since authentication is now done via the DataONE Portal service using auth tokens. (Using the AppConfig#tokenUrl) This URL is contructed dynamically when the AppModel is initialized. Only override this if you are an advanced user and have a reason to!
Type:
  • string
Source:

metaServiceUrl :string

The URL for the DataONE system metadata API. This URL is contructed dynamically when the AppModel is initialized. Only override this if you are an advanced user and have a reason to! (see https://releases.dataone.org/online/api-documentation-v2.0/apis/MN_APIs.html#MNRead.getSystemMetadata and https://releases.dataone.org/online/api-documentation-v2.0/apis/MN_APIs.html#MNStorage.updateSystemMetadata)
Type:
  • string
Source:

metricsForwardCollectionQuery :boolean

Forwards collection Query to Metrics Service if enabled
Type:
  • boolean
Default Value:
  • true
Source:

metricsUrl :string

Metrics endpoint url
Type:
  • string
Source:

monitorStatusUrl :string

The URL for the service that returns the status of various DataONE services. The only supported status so far is the search index queue -- the number of objects that are waiting to be indexed in the Solr search index. This URL is contructed dynamically when the AppModel is initialized. Only override this if you are an advanced user and have a reason to!
Type:
  • string
Since:
  • 2.9.0
Source:

nodeId :string

The node identifier for this repository. This is set dynamically by retrieving the DataONE Coordinating Node document and finding this repository in the Node list. (see https://cn.dataone.org/cn/v2/node). If this repository is not registered with DataONE, then set this node id by copying the node id from your node info at https://your-repo-site.com/metacat/d1/mn/v2/node
Type:
  • string
Default Value:
  • null
Source:
Example
"urn:node:METACAT"

nodeServiceUrl :string

The URL for the DataONE listNodes() API. This URL is contructed dynamically when the AppModel is initialized. Only override this if you are an advanced user and have a reason to! (see https://releases.dataone.org/online/api-documentation-v2.0/apis/CN_APIs.html#CNCore.listNodes)
Type:
  • string
Source:

objectServiceUrl :string

The URL for the DataONE system metadata API. This URL is contructed dynamically when the AppModel is initialized. Only override this if you are an advanced user and have a reason to! (see https://releases.dataone.org/online/api-documentation-v2.0/apis/MN_APIs.html#MNRead.getSystemMetadata and https://releases.dataone.org/online/api-documentation-v2.0/apis/MN_APIs.html#MNStorage.updateSystemMetadata)
Type:
  • string
Source:

orcidBaseUrl :string

The base URL for the ORCID REST services
Type:
  • string
Default Value:
  • "https:/orcid.org"
Source:

orcidSearchUrl :string

The URL for the ORCID search API, which can be used to search for information about people using their ORCID, email, name, etc. This URL is constructed dynamically once the AppModel is initialized.
Type:
  • string
Source:

packageServiceUrl :string

The URL for the DataONE getPackage() API. This URL is contructed dynamically when the AppModel is initialized. Only override this if you are an advanced user and have a reason to! (see https://releases.dataone.org/online/api-documentation-v2.0/apis/MN_APIs.html#MNPackage.getPackage)
Type:
  • string
Source:

pendingMapsUrl :string

The URL for the DataONE Pending Maps API This URL is constructed dynamically once the AppModel is initialized. (see https://releases.dataone.org/online/api-documentation-v2.0/apis/CN_APIs.html#CNIdentity.getPendingMapIdentity)
Type:
  • string
Source:

portalDefaults :object

The default values to use in portals. Default sections are applied when a portal is new. Default images are used in new freeform pages in the portal builder. The default colors are used when colors haven't been saved to the portal document. Colors can be hex codes, rgb codes, or any other form supported by browsers in CSS
Type:
  • object
Properties:
Name Type Description
sections Array.<object> The default sections for a new portal. Each object within the section array can have a title property and a label property
label string The name of the section that will appear in the tab
title string A longer title for the section that will appear in the section header
newPortalActiveSectionLabel string When a user start the portal builder for a brand new portal, the label for the section that the builder should start on. Can be set to "Data", "Metrics", "Settings", or one of the labels from the default sections described above.
sectionImageIdentifiers Array.<string> A list of image pids to use as default images for new markdown sections
primaryColor string The color that is used most frequently in the portal view
secondaryColor string The color that is used second-most frequently in the portal view
accentColor string The color that is rarely used in portal views as an accent color
primaryColorTransparent string An rgba() version of the primaryColor that is semi-transparent
secondaryColorTransparent string An rgba() version of the secondaryColor that is semi-transparent
accentColorTransparent string An rgba() version of the accentColor that is semi-transparent
Since:
  • 2.14.0
Source:
Example
{
  sections: [
    { label: "About",
      title: "About our project"
    },
    { label: "Publications",
      title: "Selected publications by our lab group"
    }
  ],
  newPortalActiveSectionLabel: "About",
  sectionImageIdentifiers: ["urn:uuid:d2f31a83-debf-4d78-bef7-6abe20962581", "urn:uuid:6ad37acd-d0ac-4142-9f42-e5f05ff55564", "urn:uuid:0b6be09f-2e6f-4e7b-a83c-2823495f9608", "urn:uuid:5b4e0347-07ed-4580-b039-6c4df57ed801", "urn:uuid:0cf62da9-a099-440e-9c1e-595a55c0d60d"],
  primaryColor: "#16acc0",
  primaryColorTransparent: "rgba(22, 172, 192, .7)",
  secondaryColor: "#EED268",
  secondaryColorTransparent: "rgba(238, 210, 104, .7)",
  accentColor: "#0f5058",
  accentColorTransparent: "rgba(15, 80, 88, .7)"
 }

portalEditNoQuotaMessage :string

This message will display when a user tries to create a new portal when they have exceeded their DataONE portal quota
Type:
  • string
Source:

portalEditNotAuthCreateMessage :string

This message will display when a user tries to create a new Portal in the PortalEditor when they are not associated with a whitelisted subject in the `limitPortalsToSubjects` list
Type:
  • string
Source:

portalEditNotAuthEditMessage :string

This message will display when a user tries to access the Portal Editor for a portal for which they do not have write permission.
Type:
  • string
Source:

portalEditorRequiredFields :object

The list of fields that should be required in the portal editor. Set individual properties to `true` to require them in the portal editor.
Type:
  • object
Properties:
Name Type Description
label boolean Default: true
name boolean Default: true
description boolean Default: false
sectionTitle boolean Default: true
sectionIntroduction boolean Default: false
logo boolean Default: false
Source:

portalEditSaveErrorMsg :string

This message will display when there is any non-specific error during the save process of the PortalEditor.
Type:
  • string
Source:

portalInfoURL :string

A URL of a webpage for people to learn more about portals. If no URL is provided, links to more info about portals will be omitted.
Type:
  • string
Since:
  • 2.14.0
Default Value:
  • null
Source:
Example
"https://dataone.org/plus"

portalLabelBlockList :Array.<string>

A list of portals labels that no one should be able to create portals with
Type:
  • Array.<string>
Since:
  • 2.11.3
Source:

portalLimit :number

Limit users to a certain number of portals. This limit will be ignored if AppConfig#enableBookkeeperServices is set to true, because the limit will be enforced by Bookkeeper Quotas instead.
Type:
  • number
Since:
  • 2.14.0
Default Value:
  • 100
Source:

portalTermPlural :string

The user-facing term for portals in lower-case and in plural form. e.g. "portals". This allows for portal terms with irregular plurals.
Type:
  • string
Default Value:
  • "portals"
Source:

portalTermSingular :string

The user-facing term for portals in lower-case and in singular form. e.g. "portal"
Type:
  • string
Default Value:
  • "portal"
Source:

provenanceInfoURL :string

A URL of a webpage for people to learn more about provenance. If no URL is provided, links to more info about provenance will be omitted.
Type:
  • string
Since:
  • 2.16.0
Default Value:
  • https://www.dataone.org/webinars/provenance-and-dataone-facilitating-reproducible-science/
Source:
Example
https://mysite.org/provenance-help

publishServiceUrl :string

The URL for the Metacat Publish service. This URL is contructed dynamically when the AppModel is initialized. Only override this if you are an advanced user and have a reason to!
Type:
  • string
Source:

queryServiceUrl :string

The URL for the DataONE query API. This URL is contructed dynamically when the AppModel is initialized. Only override this if you are an advanced user and have a reason to! (see https://releases.dataone.org/online/api-documentation-v2.0/apis/MN_APIs.html#MNQuery.query)
Type:
  • string
Source:

randomLabelNumericLength :number

The length of random portal label generated during preview/trial mode of DataONE Plus
Type:
  • number
Since:
  • 2.14.0
Default Value:
  • 7
Source:

repositoryName :string

The name of this repository. This is used throughout the interface in different messages and page content.
Type:
  • string
Since:
  • 2.11.2
Default Value:
  • "Metacat Data Catalog"
Source:

reserveServiceUrl :string

The URL for the DataONE reserveIdentifier() API. This URL is contructed dynamically when the AppModel is initialized. Only override this if you are an advanced user and have a reason to! (see https://releases.dataone.org/online/api-documentation-v2.0/apis/CN_APIs.html#CNCore.reserveIdentifier)
Type:
  • string
Source:

searchMapTileHue :string

The hue/color of the tiles drawn on the map when searching for data. This should be a three-digit hue degree between 0 and 360. (Try https://hslpicker.com) This is set on the Map model when it is initialized.
Type:
  • string
Since:
  • 2.13.3
Default Value:
  • "192" (blue)
Source:

showAnnotationIndicator :boolean

Set this option to true to display the annotation icon in search result rows when a dataset has an annotation
Type:
  • boolean
Source:

showDatasetPublicToggle :boolean

If true, the public/private toggle will be displayed in the Sharing Options for datasets.
Type:
  • boolean
Since:
  • 2.9.0
Default Value:
  • true
Source:

showDatasetPublicToggleForSubjects :Array.<string>

The public/private toggle will be displayed in the Sharing Options for datasets for only the given users or groups. To display the public/private toggle for everyone, set `showDatasetPublicToggle` to true and keep this array empty.
Type:
  • Array.<string>
Since:
  • 2.15.0
Source:

showMyPortals :boolean

Set to false to hide the display of "My Portals", which shows the user's current portals
Type:
  • boolean
Default Value:
  • true
Source:

showPortalPublicToggle :boolean

If true, the public/private toggle will be displayed in the Sharing Options for portals.
Type:
  • boolean
Since:
  • 2.9.0
Default Value:
  • true
Source:

showPortalPublicToggleForSubjects :Array.<string>

The public/private toggle will be displayed in the Sharing Options for portals for only the given users or groups. To display the public/private toggle for everyone, set `showPortalPublicToggle` to true and keep this array empty.
Type:
  • Array.<string>
Since:
  • 2.9.0
Source:

showSignInHelp :boolean

If true, users will see a page with sign-in troubleshooting tips
Type:
  • boolean
Since:
  • 2.13.3
Default Value:
  • true
Source:

showWholeTaleFeatures :Boolean

Enable to show Whole Tale features
Type:
  • Boolean
Default Value:
  • false
Source:

signInUrl :string

The URL for the DataONE Sign In API using CILogon as the identity provider This URL is constructed dynamically once the AppModel is initialized.
Type:
  • string
Source:

signInUrlLdap :string

The URL for the DataONE Sign In API using LDAP as the identity provider This URL is constructed dynamically once the AppModel is initialized.
Type:
  • string
Source:

signInUrlOrcid :string

The URL for the DataONE Sign In API using ORCID as the identity provider This URL is constructed dynamically once the AppModel is initialized.
Type:
  • string
Source:

signOutUrl :string

The URL for the DataONE Sign Out API This URL is constructed dynamically once the AppModel is initialized.
Type:
  • string
Source:

taleEnvironments :Array.<string>

The WholeTale environments that are exposed on the dataset landing pages
Type:
  • Array.<string>
Default Value:
  • ["RStudio", "Jupyter Notebook"]
Source:

temporaryMessage :string

Add a message that will display during a certain time period. This is useful when displaying a warning message about planned outages/maintenance, or alert users to other important information. If this attribute is left blank, no message will display, even if there is a start and end time specified. If there are is no start or end time specified, this message will display until you remove it here.
Type:
  • string
Since:
  • 2.11.4
Default Value:
  • null
Source:

temporaryMessageClasses :string

Additional HTML classes to give the temporary message element. Use these to style the message.
Type:
  • string
Since:
  • 2.11.4
Default Value:
  • "warning"
Source:

temporaryMessageContainer :string

A jQuery selector for the element that the temporary message will be displayed in.
Type:
  • string
Since:
  • 2.11.4
Default Value:
  • "#Navbar"
Source:

temporaryMessageEndTime :Date

If there is a temporaryMessage specified, it will display before this end time. Remember that Dates are in GMT time!
Type:
  • Date
Since:
  • 2.11.4
Default Value:
  • null
Source:
Example
new Date(1594818000000)

temporaryMessageIncludeEmail :boolean

If true, the temporary message will include a "Need help? Email us at..." email link at the end of the message. The email address will be set to AppConfig#emailContact
Type:
  • boolean
Since:
  • 2.13.3
Default Value:
  • true
Source:

temporaryMessageStartTime :Date

If there is a temporaryMessage specified, it will display after this start time. Remember that Dates are in GMT time!
Type:
  • Date
Since:
  • 2.11.4
Default Value:
  • null
Source:
Example
new Date(1594818000000)

theme :string

The theme name to use
Type:
  • string
Default Value:
  • "default"
Source:

title :string

The default page title.
Type:
  • string
Source:

tokenUrl :string

The URL for the DataONE Token API using ORCID as the identity provider This URL is constructed dynamically once the AppModel is initialized.
Type:
  • string
Source:

unsupportedBrowsers :Array.<RegExp>

A list of unsupported User-Agent regular expressions for browsers that will not work well with MetacatUI. A warning message will display on the page for anyone using one of these browsers.
Type:
  • Array.<RegExp>
Since:
  • 2.10.0
Default Value:
  • [/(?:\b(MS)?IE\s+|\bTrident\/7\.0;.*\s+rv:)(\d+)/]
Source:
Example
[/(?:\b(MS)?IE\s+|\bTrident\/7\.0;.*\s+rv:)(\d+)/]

useNSFAwardAPI :boolean

If true, parts of the UI (most notably, "funding" field in the dataset editor) may look up NSF Award information
Type:
  • boolean
Default Value:
  • false
Source:

viewServiceUrl :string

The URL for the DataONE View API. This URL is contructed dynamically when the AppModel is initialized. Only override this if you are an advanced user and have a reason to! (see https://releases.dataone.org/online/api-documentation-v2.0/apis/MN_APIs.html#module-MNView)
Type:
  • string
Source: