cspace-config Instances

What is a Instance

Instances are used when creating authority records e.g. person, organization
An authority can have multiple instances. E.g. Person could have instances person-actors, person-actress, person-directors

Where are Instance

Instances are part of the record element of the cspace-config

Structure of Instances

<instances>
	<instance id="person-person">
		<web-url>person</web-url>
		<title-ref>person</title-ref>
		<title>Default Person Authority</title>
	</instance>
</instances>

instance

attributes: id

• string
• no default, required field
• used to reference this instance when used in fields e.g. autocomplete="{instance id}"

attributes: ui-type

• string
• default "plain"

web-url

• string
• default id
• url used by the UI to access this authority instance e.g. /chain/vocabularies/{web-url}
  • must be unique across all authority instances

title-ref

• string
• default id
• short identifier for this instance
  • must be unique across all authority instances

title

• string
• default id
• displayName of this instance in the service layer

options

See also

How to add a term to a dynamic term list