Diversity Agents
TABLES, VIEWS, FUNCTIONS, PROCEDURES, ROLES
The following objects are not included:
- Logging tables
- Enumeration tables
- System objects
- Objects marked as obsolete
- Previous versions of objects
TABLES
Table Agent
The main table with the data of the agent
Column | Data type | Description | Nullable | Relation |
---|---|---|---|---|
AgentID | int | Unique ID for the Agent (= Primary key) | NO | - |
AgentParentID | int | The AgentID of the superior agent if agents are organized within a hierarchy | YES | Refers to table Agent |
AgentName | nvarchar (200) | The whole name of the agent as shown e.g. for selection in an user interface. For persons this entry will be generated as follows: LastName, FirstNames, AgentTitleDefault value: '' | NO | - |
Version | smallint | The version of a agent record (revision number, internally filled by system)Default value: (1) | NO | - |
AgentTitle | nvarchar (50) | The title of the agent, e.g. Dr., Prof. | YES | Refers to table AgentTitle_Enum |
GivenName | nvarchar (255) | The first names of the agent (if a person) or the name of e.g. an institution | YES | - |
GivenNamePostfix | nvarchar (50) | Variable part of name, correctly placed at end of given names | YES | - |
InheritedNamePrefix | nvarchar (50) | Variable part of name, correctly placed at the beginning of the inherited names | YES | - |
InheritedName | nvarchar (255) | The last names of the agent (if a person) | YES | - |
InheritedNamePostfix | nvarchar (50) | Additions after inherited name, like generation (Jr., III.) or names of religious orders | YES | - |
Abbreviation | nvarchar (50) | Abbreviation of the agent | YES | - |
AgentType | nvarchar (50) | The type of the agent, e.g. person, companyDefault value: N’person' | YES | Refers to table AgentType_Enum |
AgentRole | nvarchar (255) | The role of an agent esp. a person within an organization. e.g. “Database Administrator” or “Curator” | YES | - |
AgentGender | nvarchar (50) | The gender of the agent | YES | Refers to table AgentGender_Enum |
Description | nvarchar (1000) | A description of the agent | YES | - |
OriginalSpelling | nvarchar (200) | Name as originally written in e.g. chinese or cyrillic letters | YES | - |
Notes | nvarchar (MAX) | Notes about the agent | YES | - |
ValidFromDate | datetime | The date of the begin of the exsistence of the agent, e.g. the birthday of a person or the founding of an institution, calculated from ValidFromDay, - Month and -Year | YES | - |
ValidFromDay | tinyint | The day of the begin of the exsistence of the agent | YES | - |
ValidFromMonth | tinyint | The month of the begin of the exsistence of the agent | YES | - |
ValidFromYear | smallint | The year of the begin of the exsistence of the agent | YES | - |
ValidUntilDate | datetime | The date of the end of the exsistence of the agent, e.g. death of a person or closing of an institute, calculated from ValidUntilDay, - Month and -Year | YES | - |
ValidUntilDay | tinyint | The day of the end of the exsistence of the agent | YES | - |
ValidUntilMonth | tinyint | The month of the end of the exsistence of the agent | YES | - |
ValidUntilYear | smallint | The year of the end of the exsistence of the agent | YES | - |
ValidDateSupplement | nvarchar (255) | Verbal or additional date information, e.g. ’end of summer 1985’, ‘first quarter’. The time of the valid date if necessary. | YES | - |
PlaceOfBirth | nvarchar (500) | The place (e.g. a city) where a person was born or an institution was founded | YES | - |
PlaceOfDeath | nvarchar (500) | The place (e.g.a city) where the person died | YES | - |
SynonymToAgentID | int | The AgentID of the agent which was selected as a replacement for the current agent, e.g. if to equal datasets were imported from different sources | YES | Refers to table Agent |
SynonymisationType | nvarchar (50) | The type of the synonymisation like “replaced with”, “synonym to” | YES | Refers to table AgentSynonymisationType_Enum |
RevisionLevel | nvarchar (50) | The level of the revision of the agent, e.g. ‘unchecked’, ‘final revision’Default value: N’unchecked’ | YES | Refers to table RevisionLevel_Enum |
DataWithholdingReason | nvarchar (255) | If the dataset is withhold, the reason for withholding the data, otherwise null | YES | - |
IgnoreButKeepForReference | bit | If true, the record is ignored for all purposes of evaluation (because contradicted). It is kept only to maintain the cited reference. If no reference is given, it may be deleted instead.Default value: (0) | YES | - |
LogUpdatedBy | nvarchar (50) | Name of user who last updated the data.Default value: suser_sname() | YES | - |
LogUpdatedWhen | smalldatetime | Date and time when the data were last updated.Default value: getdate() | YES | - |
ContentLanguage | nvarchar (50) | The language of the content | YES | Refers to table LanguageCode_Enum |
Depending on:
- AgentGender_Enum
- AgentSynonymisationType_Enum
- AgentTitle_Enum
- AgentType_Enum
- LanguageCode_Enum
- RevisionLevel_Enum
trgInsAgent
Setting the value of column AgentName according to standard derived from content of given values in columns InheritedNamePrefix, Inheritedname, GivenName, GivenNamePostfix, InheritedNamePostfix and AgentTitle
Table AgentContactInformation
The contact information resp. addresses of the agents
Column | Data type | Description | Nullable | Relation |
---|---|---|---|---|
AgentID | int | Refers to the ID of Agent (= Foreign key and part of primary key) | NO | Refers to table Agent |
DisplayOrder | tinyint | Display order of records in user interface. DisplayOrder 1 corresponds to the preferred address (= part of primary key) | NO | - |
AddressType | nvarchar (50) | Type of the adress, e.g. private | YES | Refers to table AddressType_Enum |
Country | nvarchar (255) | Country of the address | YES | - |
City | nvarchar (255) | City of the address | YES | - |
PostalCode | nvarchar (50) | ZIP or postcode of the address (usually output before or after the city) | YES | - |
Streetaddress | nvarchar (255) | Usually street name and number, but may also contain post office box | YES | - |
Address | nvarchar (255) | Free text postal address of the agent | YES | - |
Telephone | nvarchar (50) | Phone number, including area code | YES | - |
CellularPhone | nvarchar (50) | The number of a mobile telephone device of the agent | YES | - |
Telefax | nvarchar (50) | Fax number, including area code | YES | - |
nvarchar (255) | E-mail address of the agent | YES | - | |
URI | nvarchar (255) | URI pointing to a homepage containing further information | YES | - |
Notes | nvarchar (MAX) | Notes about this address | YES | - |
ValidFrom | datetime | The date when this address became valid as date according to ISO 8601 | YES | - |
ValidUntil | datetime | The date of the expiration of the validity of this address as date according to ISO 8601 | YES | - |
DataWithholdingReason | nvarchar (255) | If the dataset is withhold, the reason for withholding the data, otherwise nullDefault value: N’Withhold by default’ | YES | - |
LogUpdatedBy | nvarchar (50) | Name of user who last updated the data.Default value: suser_sname() | YES | - |
LogUpdatedWhen | smalldatetime | Date and time when the data were last updated.Default value: getdate() | YES | - |
Depending on:
- AddressType_Enum
- Agent
trgInsAgentContactInformation
Table AgentDescriptor
The Descriptors for the agents
Column | Data type | Description | Nullable | Relation |
---|---|---|---|---|
AgentID | int | Unique ID for the Agent (foreign key + part of primary key) | NO | Refers to table Agent |
DescriptorID | int | Unique ID for the descriptor, Part of PK | NO | - |
Descriptor | nvarchar (200) | The DescriptorDefault value: '’ | NO | - |
URL | varchar (500) | URL of the Descriptor. In case of a module related Descriptor, the link to the module entry resp. the related webserviceDefault value: '' | YES | - |
DescriptorType | nvarchar (50) | Type of the Descriptor as described in table AgentDescriptorType_EnumDefault value: N’Descriptor' | YES | Refers to table AgentDescriptorType_Enum |
LogInsertedBy | nvarchar (50) | Name of user who first entered (typed or imported) the data.Default value: suser_sname() | YES | - |
LogInsertedWhen | smalldatetime | Date and time when the data were first entered (typed or imported) into this database.Default value: getdate() | YES | - |
LogUpdatedBy | nvarchar (50) | Name of user who last updated the data.Default value: suser_sname() | YES | - |
LogUpdatedWhen | smalldatetime | Date and time when the data were last updated.Default value: getdate() | YES | - |
RowGUID | uniqueidentifier | -Default value: newsequentialid() | NO | - |
Depending on:
- Agent
- AgentDescriptorType_Enum
Table AgentExternalDatabase
The external databases from which data in the database may have been imported from
Column | Data type | Description | Nullable | Relation |
---|---|---|---|---|
ExternalDatabaseID | int | An ID to identify an external data collection of plant names (primary key, the ID has no meaning outside of the DiversityWorkbench system) | NO | - |
ExternalDatabaseName | nvarchar (100) | The name of the data collection that has been integrated or can be linked to for further analysis | YES | - |
ExternalDatabaseVersion | nvarchar (255) | The version of this data collection (either official version number, or dates when the collection was integrated) | YES | - |
Rights | nvarchar (500) | A description of copyright agreements or permission to use data from the external database | YES | - |
ExternalDatabaseAuthors | nvarchar (200) | The persons or institutions responsible for the external database | YES | - |
ExternalDatabaseURI | nvarchar (300) | The link to the database provider resp. the external database | YES | - |
ExternalDatabaseInstitution | nvarchar (300) | The institution responsible for the external database | YES | - |
InternalNotes | nvarchar (1500) | Additional notes concerning this data collection | YES | - |
ExternalAttribute_AgentID | nvarchar (255) | The table and field name in the external data collection to which PlantNameAnalysis.ExternalNameID refers | YES | - |
PreferredSequence | tinyint | For selection in e.g. picklists: of several equal names only the name from the source with the lowest preferred sequence will be provided. | YES | - |
Disabled | bit | If this source should be disabled for selection of names e.g. in picklists | YES | - |
LogInsertedBy | nvarchar (50) | Name of user who first entered (typed or imported) the data. | YES | - |
LogInsertedWhen | smalldatetime | Date and time when the data were first entered (typed or imported) into this database. | YES | - |
LogUpdatedBy | nvarchar (50) | Name of user who last updated the data. | YES | - |
LogUpdatedWhen | smalldatetime | Date and time when the data were last updated. | YES | - |
Table AgentExternalID
The ID’s of data that were imported from foreign souces
Column | Data type | Description | Nullable | Relation |
---|---|---|---|---|
AgentID | int | Unique ID for the Agent (foreign key + part of primary key) | NO | Refers to table Agent |
ExternalDatabaseID | int | The ID of an external taxonomic data collection as defined in AgentExternalDatabase (foreign key + part of primary key)Default value: '' | NO | Refers to table AgentExternalDatabase |
ExternalAgentURI | varchar (255) | The URI (e.g. LSID) of the external agent | YES | - |
LogInsertedBy | nvarchar (50) | Name of user who first entered (typed or imported) the data.Default value: suser_sname() | YES | - |
LogInsertedWhen | smalldatetime | Date and time when the data were first entered (typed or imported) into this database.Default value: getdate() | YES | - |
LogUpdatedBy | nvarchar (50) | Name of user who last updated the data.Default value: suser_sname() | YES | - |
LogUpdatedWhen | smalldatetime | Date and time when the data were last updated.Default value: getdate() | YES | - |
Depending on:
- Agent
- AgentExternalDatabase
Table AgentHierarchyOther
Other hierarchies of the agent
Column | Data type | Description | Nullable | Relation |
---|---|---|---|---|
AgentID | int | Refers to the ID of Agent (= Foreign key and part of primary key) | NO | Refers to table Agent |
HierarchyID | int | Identifier of the hierarchy, part of PK | NO | - |
AgentParentID | int | The AgentID of the superior agent if agents are organized within a hierarchy | NO | Refers to table Agent |
ValidFrom | datetime | The start time of the hierarchy, e.g. when a person was employed in an institution | YES | - |
ValidUntil | datetime | The end of a hierarchy, e.g. when an employment ended | YES | - |
Notes | nvarchar (MAX) | Notes about the other hierarchy | YES | - |
LogCreatedWhen | datetime | Point in time when this data set was createdDefault value: getdate() | YES | - |
LogCreatedBy | nvarchar (50) | Name of the creator of this data setDefault value: suser_sname() | YES | - |
LogUpdatedBy | nvarchar (50) | Name of user who last updated the data.Default value: suser_sname() | YES | - |
LogUpdatedWhen | smalldatetime | Date and time when the data were last updated.Default value: getdate() | YES | - |
RowGUID | uniqueidentifier | -Default value: newsequentialid() | NO | - |
Depending on:
- Agent
Table AgentIdentifier
Identifier for the agent
Column | Data type | Description | Nullable | Relation |
---|---|---|---|---|
AgentID | int | Refers to the ID of Agent (= Foreign key and part of primary key) | NO | Refers to table Agent |
Identifier | nvarchar (400) | Identifier for the agent, part of PK | NO | - |
IdentifierURI | varchar (500) | URI of Identifier | YES | - |
Type | nvarchar (50) | Type of the identifier as defined in table AgentIdentifierType_Enum | YES | Refers to table AgentIdentifierType_Enum |
Notes | nvarchar (MAX) | Notes about the identifier | YES | - |
LogCreatedWhen | datetime | Point in time when this data set was createdDefault value: getdate() | YES | - |
LogCreatedBy | nvarchar (50) | Name of the creator of this data setDefault value: suser_sname() | YES | - |
LogUpdatedWhen | smalldatetime | Date and time when the data were last updated.Default value: getdate() | YES | - |
LogUpdatedBy | nvarchar (50) | Name of user who last updated the data.Default value: suser_sname() | YES | - |
RowGUID | uniqueidentifier | -Default value: newsequentialid() | NO | - |
Depending on:
- Agent
- AgentIdentifierType_Enum
Table AgentImage
The images of the agents
Column | Data type | Description | Nullable | Relation |
---|---|---|---|---|
AgentID | int | Unique ID for the Agent (foreign key + part of primary key) | NO | Refers to table Agent |
URI | varchar (255) | The complete URI address of the image. This is only a cached value if ResourceID is available referring to the module DiversityResources | NO | - |
LogInsertedBy | nvarchar (50) | Name of user who first entered (typed or imported) the data.Default value: suser_sname() | YES | - |
LogInsertedWhen | smalldatetime | Date and time when the data were first entered (typed or imported) into this database.Default value: getdate() | YES | - |
LogUpdatedBy | nvarchar (50) | Name of user who last updated the data.Default value: suser_sname() | YES | - |
LogUpdatedWhen | smalldatetime | Date and time when the data were last updated.Default value: getdate() | YES | - |
Description | nvarchar (MAX) | Description of the resource | YES | - |
Type | nvarchar (50) | The type of the image | YES | Refers to table AgentImageType_Enum |
Sequence | int | The sequence of the imageDefault value: (1) | YES | - |
DataWithholdingReason | nvarchar (255) | If the dataset is withhold, the reason for withholding the data, otherwise nullDefault value: N’Withhold by default' | YES | - |
Depending on:
- Agent
- AgentImageType_Enum
trgInsAgentImage
Table AgentKeyword
The keywords for the agents
Column | Data type | Description | Nullable | Relation |
---|---|---|---|---|
AgentID | int | Unique ID for the Agent (foreign key + part of primary key) | NO | Refers to table Agent |
Keyword | nvarchar (200) | The keyword | NO | - |
LogInsertedBy | nvarchar (50) | Name of user who first entered (typed or imported) the data.Default value: suser_sname() | YES | - |
LogInsertedWhen | smalldatetime | Date and time when the data were first entered (typed or imported) into this database.Default value: getdate() | YES | - |
LogUpdatedBy | nvarchar (50) | Name of user who last updated the data.Default value: suser_sname() | YES | - |
LogUpdatedWhen | smalldatetime | Date and time when the data were last updated.Default value: getdate() | YES | - |
Depending on:
- Agent
trgInsAgentKeyword
Table AgentProject
The projects of the agents
Column | Data type | Description | Nullable | Relation |
---|---|---|---|---|
AgentID | int | Unique ID for the Agent (= Foreign key) | NO | Refers to table Agent |
ProjectID | int | The ID of the projectDefault value: (0) | NO | Refers to table ProjectProxy |
LogInsertedBy | nvarchar (50) | Name of user who first entered (typed or imported) the data.Default value: suser_sname() | YES | - |
LogInsertedWhen | smalldatetime | Date and time when the data were first entered (typed or imported) into this database.Default value: getdate() | YES | - |
LogUpdatedBy | nvarchar (50) | Name of user who last updated the data.Default value: suser_sname() | YES | - |
LogUpdatedWhen | smalldatetime | Date and time when the data were last updated.Default value: getdate() | YES | - |
Depending on:
- Agent
- ProjectProxy
Table AgentReference
References containing informations about the agent
Column | Data type | Description | Nullable | Relation |
---|---|---|---|---|
AgentID | int | Refers to the ID of Agent (= Foreign key and part of primary key) | NO | Refers to table Agent |
ReferenceTitle | nvarchar (255) | The title of the publication where information about the agent was published. Note this is only a cached value where ReferenceURI is present | NO | - |
ReferenceURI | varchar (255) | URI of reference where information about the agent, e.g. referring to the module DiversityReferences | YES | - |
ReferenceDetails | nvarchar (50) | Details within the reference, e.g. pages | YES | - |
ContainsImage | tinyint | If the reference contains an image of the agent | YES | - |
ContainsReferencelist | tinyint | If the reference contains a publication list of the agent | YES | - |
Notes | nvarchar (255) | Notes about the reference | YES | - |
LogUpdatedBy | nvarchar (50) | Name of user who last updated the data. | YES | - |
LogUpdatedWhen | smalldatetime | Date and time when the data were last updated. | YES | - |
Depending on:
- Agent
trgInsAgentReference
Table AgentRelation
Relations of the agent to other agents
Column | Data type | Description | Nullable | Relation |
---|---|---|---|---|
AgentID | int | Refers to the ID of Agent (= Foreign key and part of primary key) | NO | Refers to table Agent |
RelatedAgentID | int | The AgentID of the related agent | NO | - |
RelationType | nvarchar (50) | The type of the relation between the agents, e.g. “parent of”, “child of”, “married to” | YES | Refers to table AgentRelationType_Enum |
Notes | nvarchar (255) | Notes about the relation | YES | - |
DataWithholdingReason | nvarchar (255) | If the dataset is withhold, the reason for withholding the data, otherwise null | YES | - |
LogUpdatedBy | nvarchar (50) | Name of user who last updated the data. | YES | - |
LogUpdatedWhen | smalldatetime | Date and time when the data were last updated. | YES | - |
Depending on:
- Agent
- AgentRelationType_Enum
trgInsAgentRelation
VIEWS
View Agent_Core
Agents that are available for a user and are not ignored
Column | Data type | Description | Nullable |
---|---|---|---|
AgentID | int | Unique ID for the Agent (= Primary key) | NO |
AgentParentID | int | The AgentID of the superior agent if agents are organized within a hierarchy | YES |
AgentName | nvarchar (200) | The whole name of the agent as shown e.g. for selection in an user interface. For persons this entry will be generated as follows: LastName, FirstNames, AgentTitle | NO |
DisplayText | nvarchar (204) | The name of the agent including indentation for synonyms | NO |
Version | smallint | The version of a agent record (revision number, internally filled by system) | NO |
AgentTitle | nvarchar (50) | The title of the agent, e.g. Dr., Prof. | YES |
GivenName | nvarchar (255) | The first names of the agent (if a person) or the name of e.g. an institution | YES |
GivenNamePostfix | nvarchar (50) | Variable part of name, correctly placed at end of given names | YES |
InheritedNamePrefix | nvarchar (50) | Variable part of name, correctly placed at the beginning of the inherited names | YES |
InheritedName | nvarchar (255) | The last names of the agent (if a person) | YES |
InheritedNamePostfix | nvarchar (50) | Additions after inherited name, like generation (Jr., III.) or names of religious orders | YES |
Abbreviation | nvarchar (50) | Abbreviation of the agent | YES |
AgentType | nvarchar (50) | The type of the agent, e.g. person, company | YES |
AgentRole | nvarchar (255) | The role of an agent esp. a person within an organization. e.g. “Database Administrator” or “Curator” | YES |
AgentGender | nvarchar (50) | The gender of the agent | YES |
Description | nvarchar (1000) | A description of the agent | YES |
OriginalSpelling | nvarchar (200) | Name as originally written in e.g. chinese or cyrillic letters | YES |
Notes | nvarchar (MAX) | Notes about the agent | YES |
ValidFromDate | datetime | The date of the begin of the exsistence of the agent, e.g. the birthday of a person or the founding of an institution, calculated from ValidFromDay, - Month and -Year | YES |
ValidFromDay | tinyint | The day of the begin of the exsistence of the agent | YES |
ValidFromMonth | tinyint | The month of the begin of the exsistence of the agent | YES |
ValidFromYear | smallint | The year of the begin of the exsistence of the agent | YES |
ValidUntilDate | datetime | The date of the end of the exsistence of the agent, e.g. death of a person or closing of an institute, calculated from ValidUntilDay, - Month and -Year | YES |
ValidUntilDay | tinyint | The day of the end of the exsistence of the agent | YES |
ValidUntilMonth | tinyint | The month of the end of the exsistence of the agent | YES |
ValidUntilYear | smallint | The year of the end of the exsistence of the agent | YES |
ValidDateSupplement | nvarchar (255) | Verbal or additional date information, e.g. ’end of summer 1985’, ‘first quarter’. The time of the valid date if necessary. | YES |
PlaceOfBirth | nvarchar (500) | The place (e.g. a city) where a person was born or an institution was founded | YES |
PlaceOfDeath | nvarchar (500) | The place (e.g.a city) where the person died | YES |
SynonymToAgentID | int | The AgentID of the agent which was selected as a replacement for the current agent, e.g. if to equal datasets were imported from different sources | YES |
SynonymisationType | nvarchar (50) | The type of the synonymisation like “replaced with”, “synonym to” | YES |
RevisionLevel | nvarchar (50) | The level of the revision of the agent, e.g. ‘unchecked’, ‘final revision’ | YES |
DataWithholdingReason | nvarchar (255) | If the dataset is withhold, the reason for withholding the data, otherwise null | YES |
IgnoreButKeepForReference | bit | If true, the record is ignored for all purposes of evaluation (because contradicted). It is kept only to maintain the cited reference. If no reference is given, it may be deleted instead. | YES |
ValidFrom | varchar (92) | - | YES |
ValidUntil | varchar (92) | - | YES |
Depending on:
- Agent
- AgentID_UserAvailable
View AgentID_AvailableReadOnly
Available AgentIDs that are ReadOnly or Locked
Column | Data type | Description | Nullable |
---|---|---|---|
AgentID | int | Unique ID for the Agent (= Foreign key) | NO |
Depending on:
- AgentID_Locked
- AgentProject
- ProjectUser
View AgentID_FullAccess
ID of agents with full access (neither read only or locked)
Column | Data type | Description | Nullable |
---|---|---|---|
AgentID | int | Unique ID for the Agent (= Foreign key) | NO |
Depending on:
- AgentProject
- ProjectProxy
- ProjectUser
View AgentID_Locked
AgentIDs that are locked due to locking of the project
Column | Data type | Description | Nullable |
---|---|---|---|
AgentID | int | Unique ID for the Agent (= Foreign key) | NO |
Depending on:
- AgentProject
- ProjectProxy
View AgentID_ReadOnly
AgentIDs that are ReadOnly for a User or are locked due to locking of the project
Column | Data type | Description | Nullable |
---|---|---|---|
AgentID | int | Unique ID for the Agent (= Foreign key) | NO |
Depending on:
- AgentID_Locked
- AgentProject
- ProjectUser
View AgentID_UserAvailable
IDs of the agent available for a user
Column | Data type | Description | Nullable |
---|---|---|---|
AgentID | int | Unique ID for the Agent (= Primary key) | NO |
Depending on:
- Agent
- AgentProject
- ProjectUser
View ProjectList
Projects available for a user
Column | Data type | Description | Nullable |
---|---|---|---|
ProjectID | int | The ID of the project, Primary key | NO |
Project | nvarchar (50) | The name of the project as stored in the module DiversityProjects | NO |
ReadOnly | int | If the user has only read access to data of this project | YES |
IsLocked | bit | If the data within the project should not be changeed and the access for all users is restricted to read only | YES |
Depending on:
- ProjectProxy
- ProjectUser
View PublicAgent
Content of table Agent available for the public
Column | Data type | Description | Nullable |
---|---|---|---|
DisplayText | nvarchar (200) | Corresponds to content of column AgentName | NO |
URI | varchar (285) | Combines BaseURL of the database and AgentID to provide unique identifier of the dataset | YES |
AgentID | int | Unique ID for the Agent (= Primary key) | NO |
AgentParentID | int | The AgentID of the superior agent if agents are organized within a hierarchy | YES |
AgentName | nvarchar (200) | The whole name of the agent as shown e.g. for selection in an user interface. For persons this entry will be generated as follows: LastName, FirstNames, AgentTitle | NO |
Version | smallint | The version of a agent record (revision number, internally filled by system) | NO |
AgentTitle | nvarchar (50) | The title of the agent, e.g. Dr., Prof. | YES |
GivenName | nvarchar (255) | The first names of the agent (if a person) or the name of e.g. an institution | YES |
GivenNamePostfix | nvarchar (50) | Variable part of name, correctly placed at end of given names | YES |
InheritedNamePrefix | nvarchar (50) | Variable part of name, correctly placed at the beginning of the inherited names | YES |
InheritedName | nvarchar (255) | The last names of the agent (if a person) | YES |
InheritedNamePostfix | nvarchar (50) | Additions after inherited name, like generation (Jr., III.) or names of religious orders | YES |
Abbreviation | nvarchar (50) | Abbreviation of the agent | YES |
AgentType | nvarchar (50) | The type of the agent, e.g. person, company | YES |
AgentRole | nvarchar (255) | The role of an agent esp. a person within an organization. e.g. “Database Administrator” or “Curator” | YES |
AgentGender | nvarchar (50) | The gender of the agent | YES |
Description | nvarchar (1000) | A description of the agent | YES |
OriginalSpelling | nvarchar (200) | Name as originally written in e.g. chinese or cyrillic letters | YES |
Notes | nvarchar (MAX) | Notes about the agent | YES |
ValidFromDate | datetime | The date of the begin of the exsistence of the agent, e.g. the birthday of a person or the founding of an institution, calculated from ValidFromDay, - Month and -Year | YES |
ValidFromDay | tinyint | The day of the begin of the exsistence of the agent | YES |
ValidFromMonth | tinyint | The month of the begin of the exsistence of the agent | YES |
ValidFromYear | smallint | The year of the begin of the exsistence of the agent | YES |
ValidUntilDate | datetime | The date of the end of the exsistence of the agent, e.g. death of a person or closing of an institute, calculated from ValidUntilDay, - Month and -Year | YES |
ValidUntilDay | tinyint | The day of the end of the exsistence of the agent | YES |
ValidUntilMonth | tinyint | The month of the end of the exsistence of the agent | YES |
ValidUntilYear | smallint | The year of the end of the exsistence of the agent | YES |
ValidDateSupplement | nvarchar (255) | Verbal or additional date information, e.g. ’end of summer 1985’, ‘first quarter’. The time of the valid date if necessary. | YES |
PlaceOfBirth | nvarchar (500) | The place (e.g. a city) where a person was born or an institution was founded | YES |
PlaceOfDeath | nvarchar (500) | The place (e.g.a city) where the person died | YES |
SynonymToAgentID | int | The AgentID of the agent which was selected as a replacement for the current agent, e.g. if to equal datasets were imported from different sources | YES |
SynonymisationType | nvarchar (50) | The type of the synonymisation like “replaced with”, “synonym to” | YES |
RevisionLevel | nvarchar (50) | The level of the revision of the agent, e.g. ‘unchecked’, ‘final revision’ | YES |
LogUpdatedWhen | smalldatetime | Date and time when the data were last updated. | YES |
Depending on:
- Agent
- AgentNames
- BaseURL
- DefaultAgentNameDisplayType
View PublicContactInformation
Accumulated public address of an agent within a hierarchy of up to 4 levels
Column | Data type | Description | Nullable |
---|---|---|---|
AgentID | int | Unique ID for the Agent (= Primary key) | NO |
DisplayOrder | tinyint | Display order of records in user interface. DisplayOrder 1 corresponds to the preferred address (= part of primary key) | NO |
ParentName | nvarchar (200) | Name of the superior agent within the hierarchy | YES |
AddressType | nvarchar (50) | Type of the adress, e.g. private | YES |
Country | nvarchar (255) | Country of the address | YES |
City | nvarchar (255) | City of the address | YES |
PostalCode | nvarchar (50) | ZIP or postcode of the address (usually output before or after the city) | YES |
Streetaddress | nvarchar (255) | Usually street name and number, but may also contain post office box | YES |
Address | nvarchar (255) | Free text postal address of the agent | YES |
Telephone | nvarchar (50) | Phone number, including area code | YES |
CellularPhone | nvarchar (50) | The number of a mobile telephone device of the agent | YES |
Telefax | nvarchar (50) | Fax number, including area code | YES |
nvarchar (255) | E-mail address of the agent | YES | |
URI | nvarchar (255) | URI pointing to a homepage containing further information | YES |
Notes | nvarchar (MAX) | Notes about the agent | YES |
ValidFrom | datetime | The date when this address became valid as date according to ISO 8601 | YES |
ValidUntil | datetime | The date of the expiration of the validity of this address as date according to ISO 8601 | YES |
LogUpdatedWhen | smalldatetime | Date and time when the data were last updated. | YES |
Depending on:
- AgentContactInformation_Public
View PublicIdentifier
Content of table AgentIdentifier available for the public
Column | Data type | Description | Nullable |
---|---|---|---|
AgentID | int | Unique ID for the Agent (= Primary key) | NO |
Identifier | nvarchar (400) | Identifier for the agent, part of PK | NO |
IdentifierURI | varchar (500) | URI of Identifier | YES |
Type | nvarchar (50) | Type of the identifier as defined in table AgentIdentifierType_Enum | YES |
Notes | nvarchar (MAX) | Notes about the agent | YES |
LogUpdatedWhen | smalldatetime | Date and time when the data were last updated. | YES |
Depending on:
- Agent
- AgentIdentifier
View PublicImage
Content of table AgentImage available for the public
Column | Data type | Description | Nullable |
---|---|---|---|
AgentID | int | Unique ID for the Agent (= Primary key) | NO |
URI | varchar (255) | The complete URI address of the image. This is only a cached value if ResourceID is available referring to the module DiversityResources | NO |
Description | nvarchar (MAX) | A description of the agent | YES |
Type | nvarchar (50) | The type of the image | YES |
Sequence | int | The sequence of the image | YES |
LogUpdatedWhen | smalldatetime | Date and time when the data were last updated. | YES |
Depending on:
- Agent
- AgentImage
View PublicReference
Content of table AgentReference available for the public
Column | Data type | Description | Nullable |
---|---|---|---|
AgentID | int | Unique ID for the Agent (= Primary key) | NO |
ReferenceTitle | nvarchar (255) | The title of the publication where information about the agent was published. Note this is only a cached value where ReferenceURI is present | NO |
ReferenceURI | varchar (255) | URI of reference where information about the agent, e.g. referring to the module DiversityReferences | YES |
ReferenceDetails | nvarchar (50) | Details within the reference, e.g. pages | YES |
ContainsImage | tinyint | If the reference contains an image of the agent | YES |
ContainsReferencelist | tinyint | If the reference contains a publication list of the agent | YES |
Notes | nvarchar (255) | Notes about the agent | YES |
LogUpdatedWhen | smalldatetime | Date and time when the data were last updated. | YES |
Depending on:
- Agent
- AgentReference
View PublicRelation
Content of table AgentRelation available for the public
Column | Data type | Description | Nullable |
---|---|---|---|
AgentID | int | Unique ID for the Agent (= Primary key) | NO |
RelatedAgentID | int | The AgentID of the related agent | NO |
RelationType | nvarchar (50) | The type of the relation between the agents, e.g. “parent of”, “child of”, “married to” | YES |
Notes | nvarchar (255) | Notes about the agent | YES |
LogUpdatedWhen | smalldatetime | Date and time when the data were last updated. | YES |
Depending on:
- Agent
- AgentRelation
View UserInfo
Information about the user as stored in table UserProxy
Column | Data type | Description | Nullable |
---|---|---|---|
LoginName | nvarchar (50) | The login name of the user, Primary key | NO |
CombinedNameCache | nvarchar (50) | A combined name of the user, created on the base of an entry in the module DiversityUsers | YES |
UserURI | varchar (255) | Refers to UserInfo.UserID in database DiversityUsers | YES |
ProjectID | int | The ID of the default project of the user as stored in table ProjectProxy | YES |
Depending on:
- UserProxy
View ViewAgentAddress
Accumulated address of an agent within a hierarchy of up to 4 levels
Column | Data type | Description | Nullable |
---|---|---|---|
AgentID | int | Refers to the ID of Agent (= Foreign key and part of primary key) | YES |
DisplayOrder | tinyint | Display order of records in user interface. DisplayOrder 1 corresponds to the preferred address (= part of primary key) | YES |
ParentName | nvarchar (200) | Name of the superior agent within the hierarchy | YES |
AddressType | nvarchar (50) | Type of the adress, e.g. private | YES |
Country | nvarchar (255) | Country of the address | YES |
City | nvarchar (255) | City of the address | YES |
PostalCode | nvarchar (50) | ZIP or postcode of the address (usually output before or after the city) | YES |
Streetaddress | nvarchar (255) | Usually street name and number, but may also contain post office box | YES |
Address | nvarchar (255) | Free text postal address of the agent | YES |
Telephone | nvarchar (50) | Phone number, including area code | YES |
CellularPhone | nvarchar (50) | The number of a mobile telephone device of the agent | YES |
Telefax | nvarchar (50) | Fax number, including area code | YES |
nvarchar (255) | E-mail address of the agent | YES | |
URI | nvarchar (255) | URI pointing to a homepage containing further information | YES |
Notes | nvarchar (MAX) | Notes about this address | YES |
ValidFrom | datetime | The date when this address became valid as date according to ISO 8601 | YES |
ValidUntil | datetime | The date of the expiration of the validity of this address as date according to ISO 8601 | YES |
Depending on:
- ViewAgentAddress0
- ViewAgentAddress1
- ViewAgentAddress2
- ViewAgentAddress3
- ViewAgentAddress4
View ViewAgentNames
The names of the agents as retrieved for the default display type with function AgentNames
Column | Data type | Description | Nullable |
---|---|---|---|
AgentID | int | Unique ID for the Agent (= Primary key) | NO |
AgentName | nvarchar (200) | The whole name of the agent as shown e.g. for selection in an user interface. For persons this entry will be generated as follows: LastName, FirstNames, AgentTitle | NO |
Depending on:
- AgentNames
- DefaultAgentNameDisplayType
View ViewBaseURL
Provides the basic address for accessing the database as defined in function BaseURL
Column | Data type | Description | Nullable |
---|---|---|---|
BaseURL | varchar (255) | Basic address for accessing the database | YES |
Depending on:
- BaseURL
View ViewDefaultAgentNameDisplayType
The default display type as set for the default project as defined in function DefaultAgentNameDisplayType
Column | Data type | Description | Nullable |
---|---|---|---|
DefaultAgentNameDisplayType | nvarchar (50) | The default display type | YES |
Depending on:
- DefaultAgentNameDisplayType
View ViewDiversityWorkbenchModule
Provides the name of the DiversityWorkbench module as defined in function DiversityWorkbenchModule
Column | Data type | Description | Nullable |
---|---|---|---|
DiversityWorkbenchModule | nvarchar (50) | The name of the DiversityWorkbench module | YES |
Depending on:
- DiversityWorkbenchModule
FUNCTIONS
Function AgentAddress
The address of the agent as collected from the hierarchy
Parameter | DataType | Description |
---|---|---|
@AgentID | int | The ID of the Agent |
Column | DataType | Description |
---|---|---|
AgentID | int | Unique ID for the Agent (= Primary key) |
DisplayOrder | tinyint | Display order of records in user interface. DisplayOrder 1 corresponds to the preferred address (= part of primary key) |
ParentName | nvarchar (4000) | - |
AddressType | nvarchar (50) | Type of the adress, e.g. private |
Country | nvarchar (255) | Country of the address |
City | nvarchar (255) | City of the address |
PostalCode | nvarchar (50) | ZIP or postcode of the address (usually output before or after the city) |
Streetaddress | nvarchar (255) | Usually street name and number, but may also contain post office box |
Address | nvarchar (255) | Free text postal address of the agent |
Telephone | nvarchar (50) | Phone number, including area code |
CellularPhone | nvarchar (50) | The number of a mobile telephone device of the agent |
Telefax | nvarchar (50) | Fax number, including area code |
nvarchar (255) | E-mail address of the agent | |
URI | nvarchar (255) | URI pointing to a homepage containing further information |
Notes | nvarchar (MAX) | Notes about the agent |
ValidFrom | datetime | The date when this address became valid as date according to ISO 8601 |
ValidUntil | datetime | The date of the expiration of the validity of this address as date according to ISO 8601 |
Depending on:
- Agent
- AgentContactInformation
Function AgentChildNodes
Returns the list of agents within the hierarchy underneath the agent with the given ID (=AgentID)
Parameter | DataType | Description |
---|---|---|
@ID | int | The AgentID of the agent for which the hierarchy should be retrieved |
Column | DataType | Description |
---|---|---|
AgentID | int | Unique ID for the Agent (= Primary key) |
AgentParentID | int | The AgentID of the superior agent if agents are organized within a hierarchy |
AgentName | nvarchar (200) | The whole name of the agent as shown e.g. for selection in an user interface. For persons this entry will be generated as follows: LastName, FirstNames, AgentTitle |
Version | smallint | The version of a agent record (revision number, internally filled by system) |
AgentTitle | nvarchar (50) | The title of the agent, e.g. Dr., Prof. |
GivenName | nvarchar (255) | The first names of the agent (if a person) or the name of e.g. an institution |
InheritedName | nvarchar (255) | The last names of the agent (if a person) |
Abbreviation | nvarchar (50) | Abbreviation of the agent |
AgentType | nvarchar (50) | The type of the agent, e.g. person, company |
AgentRole | nvarchar (255) | The role of an agent esp. a person within an organization. e.g. “Database Administrator” or “Curator” |
Description | nvarchar (1000) | A description of the agent |
Notes | nvarchar (500) | Notes about the agent |
ValidFromDate | datetime | The date of the begin of the exsistence of the agent, e.g. the birthday of a person or the founding of an institution, calculated from ValidFromDay, - Month and -Year |
ValidFromDay | tinyint | The day of the begin of the exsistence of the agent |
ValidFromMonth | tinyint | The month of the begin of the exsistence of the agent |
ValidFromYear | smallint | The year of the begin of the exsistence of the agent |
ValidUntilDate | datetime | The date of the end of the exsistence of the agent, e.g. death of a person or closing of an institute, calculated from ValidUntilDay, - Month and -Year |
ValidUntilDay | tinyint | The day of the end of the exsistence of the agent |
ValidUntilMonth | tinyint | The month of the end of the exsistence of the agent |
ValidUntilYear | smallint | The year of the end of the exsistence of the agent |
ValidDateSupplement | nvarchar (255) | Verbal or additional date information, e.g. ’end of summer 1985’, ‘first quarter’. The time of the valid date if necessary. |
SynonymToAgentID | int | The AgentID of the agent which was selected as a replacement for the current agent, e.g. if to equal datasets were imported from different sources |
SynonymisationType | nvarchar (50) | The type of the synonymisation like “replaced with”, “synonym to” |
RevisionLevel | nvarchar (50) | The level of the revision of the agent, e.g. ‘unchecked’, ‘final revision’ |
PlaceOfBirth | nvarchar (500) | The place (e.g. a city) where a person was born or an institution was founded |
PlaceOfDeath | nvarchar (500) | The place (e.g.a city) where the person died |
DataWithholdingReason | nvarchar (255) | If the dataset is withhold, the reason for withholding the data, otherwise null |
ContentLanguage | nvarchar (50) | The language of the content |
Depending on:
- Agent
Function AgentContactInformation_Public
Provides the first contact information that is not withheld and valid including contact information of parent agents
Column | DataType | Description |
---|---|---|
AgentID | int | Unique ID for the Agent (= Primary key) |
DisplayOrder | tinyint | Display order of records in user interface. DisplayOrder 1 corresponds to the preferred address (= part of primary key) |
ParentName | nvarchar (200) | - |
AddressType | nvarchar (50) | Type of the adress, e.g. private |
Country | nvarchar (255) | Country of the address |
City | nvarchar (255) | City of the address |
PostalCode | nvarchar (50) | ZIP or postcode of the address (usually output before or after the city) |
Streetaddress | nvarchar (255) | Usually street name and number, but may also contain post office box |
Address | nvarchar (255) | Free text postal address of the agent |
Telephone | nvarchar (50) | Phone number, including area code |
CellularPhone | nvarchar (50) | The number of a mobile telephone device of the agent |
Telefax | nvarchar (50) | Fax number, including area code |
nvarchar (255) | E-mail address of the agent | |
URI | nvarchar (255) | URI pointing to a homepage containing further information |
Notes | nvarchar (MAX) | Notes about the agent |
ValidFrom | datetime | The date when this address became valid as date according to ISO 8601 |
ValidUntil | datetime | The date of the expiration of the validity of this address as date according to ISO 8601 |
LogUpdatedWhen | smalldatetime | Date and time when the data were last updated. |
Depending on:
- Agent
- AgentContactInformation
Function AgentHierarchy
Returns the list of agents within the hierarchy starting at the topmost agent related to the agent with the given AgentID
Parameter | DataType | Description |
---|---|---|
@AgentID | int | The AgentID of the agent for which the hierarchy should be retrieved |
Column | DataType | Description |
---|---|---|
AgentID | int | Unique ID for the Agent (= Primary key) |
AgentParentID | int | The AgentID of the superior agent if agents are organized within a hierarchy |
AgentName | nvarchar (200) | The whole name of the agent as shown e.g. for selection in an user interface. For persons this entry will be generated as follows: LastName, FirstNames, AgentTitle |
Version | smallint | The version of a agent record (revision number, internally filled by system) |
AgentTitle | nvarchar (50) | The title of the agent, e.g. Dr., Prof. |
GivenName | nvarchar (255) | The first names of the agent (if a person) or the name of e.g. an institution |
InheritedName | nvarchar (255) | The last names of the agent (if a person) |
Abbreviation | nvarchar (50) | Abbreviation of the agent |
AgentType | nvarchar (50) | The type of the agent, e.g. person, company |
AgentRole | nvarchar (255) | The role of an agent esp. a person within an organization. e.g. “Database Administrator” or “Curator” |
Description | nvarchar (1000) | A description of the agent |
Notes | nvarchar (500) | Notes about the agent |
ValidFromDate | datetime | The date of the begin of the exsistence of the agent, e.g. the birthday of a person or the founding of an institution, calculated from ValidFromDay, - Month and -Year |
ValidFromDay | tinyint | The day of the begin of the exsistence of the agent |
ValidFromMonth | tinyint | The month of the begin of the exsistence of the agent |
ValidFromYear | smallint | The year of the begin of the exsistence of the agent |
ValidUntilDate | datetime | The date of the end of the exsistence of the agent, e.g. death of a person or closing of an institute, calculated from ValidUntilDay, - Month and -Year |
ValidUntilDay | tinyint | The day of the end of the exsistence of the agent |
ValidUntilMonth | tinyint | The month of the end of the exsistence of the agent |
ValidUntilYear | smallint | The year of the end of the exsistence of the agent |
ValidDateSupplement | nvarchar (255) | Verbal or additional date information, e.g. ’end of summer 1985’, ‘first quarter’. The time of the valid date if necessary. |
SynonymToAgentID | int | The AgentID of the agent which was selected as a replacement for the current agent, e.g. if to equal datasets were imported from different sources |
SynonymisationType | nvarchar (50) | The type of the synonymisation like “replaced with”, “synonym to” |
RevisionLevel | nvarchar (50) | The level of the revision of the agent, e.g. ‘unchecked’, ‘final revision’ |
PlaceOfBirth | nvarchar (500) | The place (e.g. a city) where a person was born or an institution was founded |
PlaceOfDeath | nvarchar (500) | The place (e.g.a city) where the person died |
DataWithholdingReason | nvarchar (255) | If the dataset is withhold, the reason for withholding the data, otherwise null |
ContentLanguage | nvarchar (50) | The language of the content |
Depending on:
- Agent
- AgentChildNodes
- AgentTopID
Function AgentHierarchyAllSuperior
Returns the list of all superior agents within the hierarchy and other hierarchies related to the agent with the given AgentID
Parameter | DataType | Description |
---|---|---|
@AgentID | int | The ID of the Agent |
Column | DataType | Description |
---|---|---|
AgentID | int | Unique ID for the Agent (= Primary key) |
AgentParentID | int | The AgentID of the superior agent if agents are organized within a hierarchy |
AgentName | nvarchar (200) | The whole name of the agent as shown e.g. for selection in an user interface. For persons this entry will be generated as follows: LastName, FirstNames, AgentTitle |
Depending on:
- Agent
- AgentHierarchyOther
- AgentSuperiorList
Function AgentNames
Returns a table that lists all the agents with their names according to the selected display type
Parameter | DataType | Description |
---|---|---|
@DisplayType | nvarchar (50) | The type of the display as documented in the table dbo.AgentNameDisplayType_Enum |
Column | DataType | Description |
---|---|---|
AgentID | int | Unique ID for the Agent (= Primary key) |
AgentName | nvarchar (200) | The whole name of the agent as shown e.g. for selection in an user interface. For persons this entry will be generated as follows: LastName, FirstNames, AgentTitle |
Depending on:
- Agent
Function AgentSuperiorList
Returns the list of superior agents as retrieved from the hierarchy
Parameter | DataType | Description |
---|---|---|
@AgentID | int | Unique ID for the Agent (= Primary key) |
Column | DataType | Description |
---|---|---|
AgentID | int | Unique ID for the Agent (= Primary key) |
AgentParentID | int | The AgentID of the superior agent if agents are organized within a hierarchy |
AgentName | nvarchar (200) | The whole name of the agent as shown e.g. for selection in an user interface. For persons this entry will be generated as follows: LastName, FirstNames, AgentTitle |
Version | smallint | The version of a agent record (revision number, internally filled by system) |
AgentTitle | nvarchar (50) | The title of the agent, e.g. Dr., Prof. |
GivenName | nvarchar (255) | The first names of the agent (if a person) or the name of e.g. an institution |
InheritedName | nvarchar (255) | The last names of the agent (if a person) |
Abbreviation | nvarchar (50) | Abbreviation of the agent |
AgentType | nvarchar (50) | The type of the agent, e.g. person, company |
AgentRole | nvarchar (255) | The role of an agent esp. a person within an organization. e.g. “Database Administrator” or “Curator” |
Description | nvarchar (1000) | A description of the agent |
Notes | nvarchar (500) | Notes about the agent |
ValidFromDate | datetime | The date of the begin of the exsistence of the agent, e.g. the birthday of a person or the founding of an institution, calculated from ValidFromDay, - Month and -Year |
ValidFromDay | tinyint | The day of the begin of the exsistence of the agent |
ValidFromMonth | tinyint | The month of the begin of the exsistence of the agent |
ValidFromYear | smallint | The year of the begin of the exsistence of the agent |
ValidUntilDate | datetime | The date of the end of the exsistence of the agent, e.g. death of a person or closing of an institute, calculated from ValidUntilDay, - Month and -Year |
ValidUntilDay | tinyint | The day of the end of the exsistence of the agent |
ValidUntilMonth | tinyint | The month of the end of the exsistence of the agent |
ValidUntilYear | smallint | The year of the end of the exsistence of the agent |
ValidDateSupplement | nvarchar (255) | Verbal or additional date information, e.g. ’end of summer 1985’, ‘first quarter’. The time of the valid date if necessary. |
SynonymToAgentID | int | The AgentID of the agent which was selected as a replacement for the current agent, e.g. if to equal datasets were imported from different sources |
SynonymisationType | nvarchar (50) | The type of the synonymisation like “replaced with”, “synonym to” |
RevisionLevel | nvarchar (50) | The level of the revision of the agent, e.g. ‘unchecked’, ‘final revision’ |
PlaceOfBirth | nvarchar (500) | The place (e.g. a city) where a person was born or an institution was founded |
PlaceOfDeath | nvarchar (500) | The place (e.g.a city) where the person died |
DataWithholdingReason | nvarchar (255) | If the dataset is withhold, the reason for withholding the data, otherwise null |
ContentLanguage | nvarchar (50) | The language of the content |
DisplayOrder | int | Display order according to the hierarchy with 1 for the current dataset und increasing values for higher levels in the hierarchy |
Depending on:
- Agent
Function AgentSynonymTopID
Returns the top AgentID within the synyonym hierarchy for a given AgentID
DataType: int
Parameter | DataType | Description |
---|---|---|
@AgentID | int | Unique ID for the Agent (= Primary key) |
Depending on:
- Agent
Function AgentSynonymy
Returns all agents within the synonymy of the given agent
Parameter | DataType | Description |
---|---|---|
@AgentID | int | Unique ID for the Agent (= Primary key) |
Column | DataType | Description |
---|---|---|
AgentID | int | Unique ID for the Agent (= Primary key) |
AgentParentID | int | The AgentID of the superior agent if agents are organized within a hierarchy |
AgentName | nvarchar (200) | The whole name of the agent as shown e.g. for selection in an user interface. For persons this entry will be generated as follows: LastName, FirstNames, AgentTitle |
Version | smallint | The version of a agent record (revision number, internally filled by system) |
AgentTitle | nvarchar (50) | The title of the agent, e.g. Dr., Prof. |
GivenName | nvarchar (255) | The first names of the agent (if a person) or the name of e.g. an institution |
InheritedName | nvarchar (255) | The last names of the agent (if a person) |
Abbreviation | nvarchar (50) | Abbreviation of the agent |
AgentType | nvarchar (50) | The type of the agent, e.g. person, company |
AgentRole | nvarchar (255) | The role of an agent esp. a person within an organization. e.g. “Database Administrator” or “Curator” |
Description | nvarchar (1000) | A description of the agent |
Notes | nvarchar (500) | Notes about the agent |
ValidFromDate | datetime | The date of the begin of the exsistence of the agent, e.g. the birthday of a person or the founding of an institution, calculated from ValidFromDay, - Month and -Year |
ValidFromDay | tinyint | The day of the begin of the exsistence of the agent |
ValidFromMonth | tinyint | The month of the begin of the exsistence of the agent |
ValidFromYear | smallint | The year of the begin of the exsistence of the agent |
ValidUntilDate | datetime | The date of the end of the exsistence of the agent, e.g. death of a person or closing of an institute, calculated from ValidUntilDay, - Month and -Year |
ValidUntilDay | tinyint | The day of the end of the exsistence of the agent |
ValidUntilMonth | tinyint | The month of the end of the exsistence of the agent |
ValidUntilYear | smallint | The year of the end of the exsistence of the agent |
ValidDateSupplement | nvarchar (255) | Verbal or additional date information, e.g. ’end of summer 1985’, ‘first quarter’. The time of the valid date if necessary. |
SynonymToAgentID | int | The AgentID of the agent which was selected as a replacement for the current agent, e.g. if to equal datasets were imported from different sources |
SynonymisationType | nvarchar (50) | The type of the synonymisation like “replaced with”, “synonym to” |
RevisionLevel | nvarchar (50) | The level of the revision of the agent, e.g. ‘unchecked’, ‘final revision’ |
PlaceOfBirth | nvarchar (500) | The place (e.g. a city) where a person was born or an institution was founded |
PlaceOfDeath | nvarchar (500) | The place (e.g.a city) where the person died |
DataWithholdingReason | nvarchar (255) | If the dataset is withhold, the reason for withholding the data, otherwise null |
ContentLanguage | nvarchar (50) | The language of the content |
Depending on:
- Agent
- AgentSynonymTopID
- AgentSynonymyChildNodes
Function AgentSynonymyChildNodes
The depending synonymys of a given agent
Parameter | DataType | Description |
---|---|---|
@ID | int | The AgentID of the agent for which the depending synonymys should be retrieved |
Column | DataType | Description |
---|---|---|
AgentID | int | Unique ID for the Agent (= Primary key) |
AgentParentID | int | The AgentID of the superior agent if agents are organized within a hierarchy |
AgentName | nvarchar (200) | The whole name of the agent as shown e.g. for selection in an user interface. For persons this entry will be generated as follows: LastName, FirstNames, AgentTitle |
Version | smallint | The version of a agent record (revision number, internally filled by system) |
AgentTitle | nvarchar (50) | The title of the agent, e.g. Dr., Prof. |
GivenName | nvarchar (255) | The first names of the agent (if a person) or the name of e.g. an institution |
InheritedName | nvarchar (255) | The last names of the agent (if a person) |
Abbreviation | nvarchar (50) | Abbreviation of the agent |
AgentType | nvarchar (50) | The type of the agent, e.g. person, company |
AgentRole | nvarchar (255) | The role of an agent esp. a person within an organization. e.g. “Database Administrator” or “Curator” |
Description | nvarchar (1000) | A description of the agent |
Notes | nvarchar (500) | Notes about the agent |
ValidFromDate | datetime | The date of the begin of the exsistence of the agent, e.g. the birthday of a person or the founding of an institution, calculated from ValidFromDay, - Month and -Year |
ValidFromDay | tinyint | The day of the begin of the exsistence of the agent |
ValidFromMonth | tinyint | The month of the begin of the exsistence of the agent |
ValidFromYear | smallint | The year of the begin of the exsistence of the agent |
ValidUntilDate | datetime | The date of the end of the exsistence of the agent, e.g. death of a person or closing of an institute, calculated from ValidUntilDay, - Month and -Year |
ValidUntilDay | tinyint | The day of the end of the exsistence of the agent |
ValidUntilMonth | tinyint | The month of the end of the exsistence of the agent |
ValidUntilYear | smallint | The year of the end of the exsistence of the agent |
ValidDateSupplement | nvarchar (255) | Verbal or additional date information, e.g. ’end of summer 1985’, ‘first quarter’. The time of the valid date if necessary. |
SynonymToAgentID | int | The AgentID of the agent which was selected as a replacement for the current agent, e.g. if to equal datasets were imported from different sources |
SynonymisationType | nvarchar (50) | The type of the synonymisation like “replaced with”, “synonym to” |
RevisionLevel | nvarchar (50) | The level of the revision of the agent, e.g. ‘unchecked’, ‘final revision’ |
PlaceOfBirth | nvarchar (500) | The place (e.g. a city) where a person was born or an institution was founded |
PlaceOfDeath | nvarchar (500) | The place (e.g.a city) where the person died |
DataWithholdingReason | nvarchar (255) | If the dataset is withhold, the reason for withholding the data, otherwise null |
ContentLanguage | nvarchar (50) | The language of the content |
Depending on:
- Agent
Function AgentTopID
Returns the top ID within the hierarchy for a given AgentID from the table Agent.
DataType: int
Parameter | DataType | Description |
---|---|---|
@AgentID | int | The AgentID of the agent for which the top ID should be retrieved |
Depending on:
- Agent
Function BaseURL
Provides the basic address for accessing the database
DataType: varchar (255)
Function DefaultAgentNameDisplayType
The default display type as set for the default project
DataType: nvarchar (50)
Depending on:
- DefaultProjectID
- ProjectProxy
Function DefaultProjectID
Returns the default ProjectID for a user as set in table UserProxy
DataType: int
Depending on:
- ProjectUser
- UserProxy
Function DiversityWorkbenchModule
The name of the DiversityWorkbench module
DataType: nvarchar (50)
Function UserID
ID of the User as stored in table UserProxy
DataType: int
Depending on:
- UserProxy
Function Version
The version of the database
DataType: nvarchar (8)
Function VersionClient
Version of the client software compatible with the version of the database
DataType: nvarchar (11)
PROCEDURES
Procedure procInsertAgentCopy
Creates a copy of a given agent and returns the AgentID of the new agent
Parameter | DataType | Description |
---|---|---|
@AgentID | int | The AgentID of the created agent |
@CopyID | int | The AgentID of the agent that should be copied |
@AgentName | nvarchar (200) | A temporary display text for the created agent |
Depending on:
- Agent
- AgentContactInformation
- AgentExternalID
- AgentImage
- AgentKeyword
- AgentProject
- AgentReference
- AgentRelation
Procedure procSetVersionAgent
Setting the version of a dataset
Parameter | DataType | Description |
---|---|---|
@ID | int | The AgentID of the agent |
Depending on:
- Agent
Procedure SetUserProjects
Create database user and assign training projects
Parameter | DataType | Description |
---|---|---|
@User | varchar (50) | LoginName of the User |
Depending on:
- UserProxy
ROLES
Content of cell | Permission |
---|---|
Not granted | |
Name of other role | Inherited from other role |
• | Granted |
Role DiversityWorkbenchAdministrator
Role for the adminstration of the database
Permissions | SELECT | INSERT | UPDATE | DELETE | EXECUTE | Type |
---|---|---|---|---|---|---|
AddressType_Enum | Diversity Workbench User | TABLE | ||||
Agent | Diversity Workbench User | Diversity Workbench Editor | Diversity Workbench Editor | • | TABLE | |
Agent_log | Diversity Workbench Editor | Diversity Workbench Editor | TABLE | |||
AgentContactInformation | Diversity Workbench User | Diversity Workbench Editor | Diversity Workbench Editor | • | TABLE | |
AgentContactInformation_log | Diversity Workbench Editor | Diversity Workbench Editor | TABLE | |||
AgentDescriptor | Diversity Workbench User | Diversity Workbench Editor | Diversity Workbench Editor | Diversity Workbench Editor | TABLE | |
AgentDescriptor_log | Diversity Workbench User | Diversity Workbench Editor | TABLE | |||
AgentDescriptorType_Enum | Diversity Workbench User | • | • | • | TABLE | |
AgentExternalDatabase | Diversity Workbench User | TABLE | ||||
AgentExternalDatabase_log | TABLE | |||||
AgentExternalID | Diversity Workbench User | Diversity Workbench Editor | Diversity Workbench Editor | • | TABLE | |
AgentExternalID_log | TABLE | |||||
AgentGender_Enum | Diversity Workbench User | TABLE | ||||
AgentHierarchyOther | Diversity Workbench User | Diversity Workbench Editor | Diversity Workbench Editor | Diversity Workbench Editor | TABLE | |
AgentHierarchyOther_log | Diversity Workbench Editor | Diversity Workbench Editor | TABLE | |||
AgentIdentifier | Diversity Workbench User | Diversity Workbench Editor | Diversity Workbench Editor | Diversity Workbench Editor | TABLE | |
AgentIdentifier_log | Diversity Workbench Editor | Diversity Workbench Editor | TABLE | |||
AgentIdentifierType_Enum | Diversity Workbench User | • | • | • | TABLE | |
AgentImage | Diversity Workbench User | Diversity Workbench Editor | Diversity Workbench Editor | Diversity Workbench Editor | TABLE | |
AgentImage_log | Diversity Workbench Editor | Diversity Workbench Editor | TABLE | |||
AgentImageType_Enum | Diversity Workbench User | • | • | • | TABLE | |
AgentKeyword | Diversity Workbench User | Diversity Workbench Editor | Diversity Workbench Editor | Diversity Workbench Editor | TABLE | |
AgentKeyword_log | Diversity Workbench Editor | Diversity Workbench Editor | TABLE | |||
AgentNameDisplayType_Enum | Diversity Workbench User | TABLE | ||||
AgentProject | Diversity Workbench User | Diversity Workbench Editor | • | TABLE | ||
AgentProject_log | Diversity Workbench Editor | Diversity Workbench Editor | TABLE | |||
AgentReference | Diversity Workbench User | Diversity Workbench Editor | Diversity Workbench Editor | Diversity Workbench Editor | TABLE | |
AgentReference_log | Diversity Workbench Editor | Diversity Workbench Editor | TABLE | |||
AgentRelation | Diversity Workbench User | Diversity Workbench Editor | Diversity Workbench Editor | Diversity Workbench Editor | TABLE | |
AgentRelation_log | Diversity Workbench Editor | Diversity Workbench Editor | TABLE | |||
AgentRelationType_Enum | Diversity Workbench User | TABLE | ||||
AgentSynonymisationType_Enum | Diversity Workbench User | TABLE | ||||
AgentTitle_Enum | Diversity Workbench User | TABLE | ||||
AgentType_Enum | Diversity Workbench User | TABLE | ||||
LanguageCode_Enum | Diversity Workbench User | • | • | • | TABLE | |
RevisionLevel_Enum | Diversity Workbench User | TABLE | ||||
Agent_Core | Diversity Workbench User | VIEW | ||||
AgentID_AvailableReadOnly | Diversity Workbench User | VIEW | ||||
AgentID_FullAccess | Diversity Workbench User | VIEW | ||||
AgentID_Locked | Diversity Workbench User | VIEW | ||||
AgentID_ReadOnly | Diversity Workbench User | VIEW | ||||
AgentID_UserAvailable | Diversity Workbench User | VIEW | ||||
ProjectList | Diversity Workbench User | VIEW | ||||
PublicAgent | Diversity Workbench User | VIEW | ||||
PublicContactInformation | Diversity Workbench User | VIEW | ||||
PublicIdentifier | Diversity Workbench User | VIEW | ||||
PublicImage | Diversity Workbench User | VIEW | ||||
PublicReference | Diversity Workbench User | VIEW | ||||
PublicRelation | Diversity Workbench User | VIEW | ||||
UserInfo | Diversity Workbench Editor | Diversity Workbench Editor | VIEW | |||
ViewAgentAddress | Diversity Workbench User | VIEW | ||||
ViewAgentNames | Diversity Workbench User | VIEW | ||||
ViewBaseURL | Diversity Workbench User | VIEW | ||||
ViewDefaultAgentNameDisplayType | Diversity Workbench User | VIEW | ||||
ViewDiversityWorkbenchModule | Diversity Workbench User | VIEW | ||||
AgentAddress | Diversity Workbench User | FUNCTION | ||||
AgentChildNodes | Diversity Workbench User | FUNCTION | ||||
AgentContactInformation_Public | Diversity Workbench User | FUNCTION | ||||
AgentHierarchy | Diversity Workbench User | FUNCTION | ||||
AgentHierarchyAllSuperior | Diversity Workbench User | FUNCTION | ||||
AgentNames | Diversity Workbench User | FUNCTION | ||||
AgentSuperiorList | Diversity Workbench User | FUNCTION | ||||
AgentSynonymTopID | Diversity Workbench User | FUNCTION | ||||
AgentSynonymy | Diversity Workbench User | FUNCTION | ||||
AgentSynonymyChildNodes | Diversity Workbench User | FUNCTION | ||||
AgentTopID | Diversity Workbench User | FUNCTION | ||||
BaseURL | Diversity Workbench User | FUNCTION | ||||
DefaultAgentNameDisplayType | Diversity Workbench User | FUNCTION | ||||
DefaultProjectID | Diversity Workbench User | FUNCTION | ||||
DiversityWorkbenchModule | Diversity Workbench User | FUNCTION | ||||
UserID | Diversity Workbench User | FUNCTION | ||||
Version | Diversity Workbench User | FUNCTION | ||||
VersionClient | Diversity Workbench User | FUNCTION | ||||
procInsertAgentCopy | Diversity Workbench Editor | PROCEDURE | ||||
procSetVersionAgent | Diversity Workbench Editor | PROCEDURE | ||||
SetUserProjects | PROCEDURE | |||||
Inheriting from roles: |
- DiversityWorkbenchEditor
Role DiversityWorkbenchEditor
Role with write access for the database
Permissions | SELECT | INSERT | UPDATE | DELETE | EXECUTE | Type |
---|---|---|---|---|---|---|
AddressType_Enum | Diversity Workbench User | TABLE | ||||
Agent | Diversity Workbench User | • | • | TABLE | ||
Agent_log | • | • | TABLE | |||
AgentContactInformation | Diversity Workbench User | • | • | TABLE | ||
AgentContactInformation_log | • | • | TABLE | |||
AgentDescriptor | Diversity Workbench User | • | • | • | TABLE | |
AgentDescriptor_log | Diversity Workbench User | • | TABLE | |||
AgentDescriptorType_Enum | Diversity Workbench User | TABLE | ||||
AgentExternalDatabase | Diversity Workbench User | TABLE | ||||
AgentExternalDatabase_log | TABLE | |||||
AgentExternalID | Diversity Workbench User | • | • | TABLE | ||
AgentExternalID_log | TABLE | |||||
AgentGender_Enum | Diversity Workbench User | TABLE | ||||
AgentHierarchyOther | Diversity Workbench User | • | • | • | TABLE | |
AgentHierarchyOther_log | • | • | TABLE | |||
AgentIdentifier | Diversity Workbench User | • | • | • | TABLE | |
AgentIdentifier_log | • | • | TABLE | |||
AgentIdentifierType_Enum | Diversity Workbench User | TABLE | ||||
AgentImage | Diversity Workbench User | • | • | • | TABLE | |
AgentImage_log | • | • | TABLE | |||
AgentImageType_Enum | Diversity Workbench User | TABLE | ||||
AgentKeyword | Diversity Workbench User | • | • | • | TABLE | |
AgentKeyword_log | • | • | TABLE | |||
AgentNameDisplayType_Enum | Diversity Workbench User | TABLE | ||||
AgentProject | Diversity Workbench User | • | • | TABLE | ||
AgentProject_log | • | • | TABLE | |||
AgentReference | Diversity Workbench User | • | • | • | TABLE | |
AgentReference_log | • | • | TABLE | |||
AgentRelation | Diversity Workbench User | • | • | • | TABLE | |
AgentRelation_log | • | • | TABLE | |||
AgentRelationType_Enum | Diversity Workbench User | TABLE | ||||
AgentSynonymisationType_Enum | Diversity Workbench User | TABLE | ||||
AgentTitle_Enum | Diversity Workbench User | TABLE | ||||
AgentType_Enum | Diversity Workbench User | TABLE | ||||
LanguageCode_Enum | Diversity Workbench User | TABLE | ||||
RevisionLevel_Enum | Diversity Workbench User | TABLE | ||||
Agent_Core | Diversity Workbench User | VIEW | ||||
AgentID_AvailableReadOnly | Diversity Workbench User | VIEW | ||||
AgentID_FullAccess | Diversity Workbench User | VIEW | ||||
AgentID_Locked | Diversity Workbench User | VIEW | ||||
AgentID_ReadOnly | Diversity Workbench User | VIEW | ||||
AgentID_UserAvailable | Diversity Workbench User | VIEW | ||||
ProjectList | Diversity Workbench User | VIEW | ||||
PublicAgent | Diversity Workbench User | VIEW | ||||
PublicContactInformation | Diversity Workbench User | VIEW | ||||
PublicIdentifier | Diversity Workbench User | VIEW | ||||
PublicImage | Diversity Workbench User | VIEW | ||||
PublicReference | Diversity Workbench User | VIEW | ||||
PublicRelation | Diversity Workbench User | VIEW | ||||
UserInfo | • | • | VIEW | |||
ViewAgentAddress | Diversity Workbench User | VIEW | ||||
ViewAgentNames | Diversity Workbench User | VIEW | ||||
ViewBaseURL | Diversity Workbench User | VIEW | ||||
ViewDefaultAgentNameDisplayType | Diversity Workbench User | VIEW | ||||
ViewDiversityWorkbenchModule | Diversity Workbench User | VIEW | ||||
AgentAddress | Diversity Workbench User | FUNCTION | ||||
AgentChildNodes | Diversity Workbench User | FUNCTION | ||||
AgentContactInformation_Public | Diversity Workbench User | FUNCTION | ||||
AgentHierarchy | Diversity Workbench User | FUNCTION | ||||
AgentHierarchyAllSuperior | Diversity Workbench User | FUNCTION | ||||
AgentNames | Diversity Workbench User | FUNCTION | ||||
AgentSuperiorList | Diversity Workbench User | FUNCTION | ||||
AgentSynonymTopID | Diversity Workbench User | FUNCTION | ||||
AgentSynonymy | Diversity Workbench User | FUNCTION | ||||
AgentSynonymyChildNodes | Diversity Workbench User | FUNCTION | ||||
AgentTopID | Diversity Workbench User | FUNCTION | ||||
BaseURL | Diversity Workbench User | FUNCTION | ||||
DefaultAgentNameDisplayType | Diversity Workbench User | FUNCTION | ||||
DefaultProjectID | Diversity Workbench User | FUNCTION | ||||
DiversityWorkbenchModule | Diversity Workbench User | FUNCTION | ||||
UserID | Diversity Workbench User | FUNCTION | ||||
Version | Diversity Workbench User | FUNCTION | ||||
VersionClient | Diversity Workbench User | FUNCTION | ||||
procInsertAgentCopy | • | PROCEDURE | ||||
procSetVersionAgent | • | PROCEDURE | ||||
SetUserProjects | PROCEDURE | |||||
Inheriting from roles: |
- DiversityWorkbenchUser
Role DiversityWorkbenchUser
Role with read only access to the database
Permissions | SELECT | INSERT | UPDATE | DELETE | EXECUTE | Type |
---|---|---|---|---|---|---|
AddressType_Enum | • | TABLE | ||||
Agent | • | TABLE | ||||
Agent_log | TABLE | |||||
AgentContactInformation | • | TABLE | ||||
AgentContactInformation_log | TABLE | |||||
AgentDescriptor | • | TABLE | ||||
AgentDescriptor_log | • | TABLE | ||||
AgentDescriptorType_Enum | • | TABLE | ||||
AgentExternalDatabase | • | TABLE | ||||
AgentExternalDatabase_log | TABLE | |||||
AgentExternalID | • | TABLE | ||||
AgentExternalID_log | TABLE | |||||
AgentGender_Enum | • | TABLE | ||||
AgentHierarchyOther | • | TABLE | ||||
AgentHierarchyOther_log | TABLE | |||||
AgentIdentifier | • | TABLE | ||||
AgentIdentifier_log | TABLE | |||||
AgentIdentifierType_Enum | • | TABLE | ||||
AgentImage | • | TABLE | ||||
AgentImage_log | TABLE | |||||
AgentImageType_Enum | • | TABLE | ||||
AgentKeyword | • | TABLE | ||||
AgentKeyword_log | TABLE | |||||
AgentNameDisplayType_Enum | • | TABLE | ||||
AgentProject | • | TABLE | ||||
AgentProject_log | TABLE | |||||
AgentReference | • | TABLE | ||||
AgentReference_log | TABLE | |||||
AgentRelation | • | TABLE | ||||
AgentRelation_log | TABLE | |||||
AgentRelationType_Enum | • | TABLE | ||||
AgentSynonymisationType_Enum | • | TABLE | ||||
AgentTitle_Enum | • | TABLE | ||||
AgentType_Enum | • | TABLE | ||||
LanguageCode_Enum | • | TABLE | ||||
RevisionLevel_Enum | • | TABLE | ||||
Agent_Core | • | VIEW | ||||
AgentID_AvailableReadOnly | • | VIEW | ||||
AgentID_FullAccess | • | VIEW | ||||
AgentID_Locked | • | VIEW | ||||
AgentID_ReadOnly | • | VIEW | ||||
AgentID_UserAvailable | • | VIEW | ||||
ProjectList | • | VIEW | ||||
PublicAgent | • | VIEW | ||||
PublicContactInformation | • | VIEW | ||||
PublicIdentifier | • | VIEW | ||||
PublicImage | • | VIEW | ||||
PublicReference | • | VIEW | ||||
PublicRelation | • | VIEW | ||||
UserInfo | • | VIEW | ||||
ViewAgentAddress | • | VIEW | ||||
ViewAgentNames | • | VIEW | ||||
ViewBaseURL | • | VIEW | ||||
ViewDefaultAgentNameDisplayType | • | VIEW | ||||
ViewDiversityWorkbenchModule | • | VIEW | ||||
AgentAddress | • | FUNCTION | ||||
AgentChildNodes | • | FUNCTION | ||||
AgentContactInformation_Public | • | FUNCTION | ||||
AgentHierarchy | • | FUNCTION | ||||
AgentHierarchyAllSuperior | • | FUNCTION | ||||
AgentNames | • | FUNCTION | ||||
AgentSuperiorList | • | FUNCTION | ||||
AgentSynonymTopID | • | FUNCTION | ||||
AgentSynonymy | • | FUNCTION | ||||
AgentSynonymyChildNodes | • | FUNCTION | ||||
AgentTopID | • | FUNCTION | ||||
BaseURL | • | FUNCTION | ||||
DefaultAgentNameDisplayType | • | FUNCTION | ||||
DefaultProjectID | • | FUNCTION | ||||
DiversityWorkbenchModule | • | FUNCTION | ||||
UserID | • | FUNCTION | ||||
Version | • | FUNCTION | ||||
VersionClient | • | FUNCTION | ||||
procInsertAgentCopy | PROCEDURE | |||||
procSetVersionAgent | PROCEDURE | |||||
SetUserProjects | PROCEDURE |