10320/LOC: XML Attributes

<< Click to Display Table of Contents >>

Navigation:  Appendix > 10320/LOC Element >

10320/LOC: XML Attributes

The 10320/LOC type is used in a DOI record to describe complex location selection rules in XML format. The following table lists the XML attributes supported in these rules.

 

Attribute

Description

Mandatory

chooseby

Identifies a comma-delimited list of location selection methods: the DOI resolver will iterate over the selection methods in the specified order. For each applied selection method:

If one and only one location is selected then the DOI resolver will redirect to this location.

Otherwise, the DOI resolver will apply the next selection method. If no selection method is left then the DOI resolver will apply the weighted method which guarantees to return a single location.

If no chooseby attribute is specified then the default ("locatt,country,weighted") is assumed.

Possible location selection methods:

locatt: Only locations from an attribute passed in the Proxy/DOI name-URL link are selected.
Example: With doi:10.123/456?locatt=id:1, the resolver will return the locations that have an "id" attribute of 1.

country: Only locations that have a country attribute matching the country of the requester are selected. If no matching locations are found then locations that have no country attribute are selected.
Note: The https://hdl.handle.net and https://doi.org Proxies determine the country of the requester using a GeoIP lookup.

weighted: A single location is selected based on the weight assigned to each location:

oA location with no weight attribute is assumed to have weight one.

oA higher weight is selected first.

oIf several locations have the same weight then a random choice is performed.

oIf the weighted selection method is applied to locations that all have non-positive weights, then this method selects one of the remaining locations randomly while disregarding location weights.

Note: The weighting allows for a very basic load balancing, but is also a way to ensure that some locations can only be addressed directly (for example, by country or locatt/attributes).

No

href

The URL for the location.

Yes

weight

The weight (a floating point between zero and one) that should apply to this location when performing a weighted selection.

No

country

Country of the requester. Possible values: two-letter country codes according to ISO 3166-1.

No