Catalog Entry

Go up to Terms and Definitions

A Catalog Entry is a managed description of and reference to one identified subject or a defined grouping of subjects within a Catalog.

A Catalog Entry can describe and reference:

• An Organization
• A Community of Interest
• A User
• A Role
• A Node
• A Node Set
• A Deployment Target
• A Test Definition
• A Test Environment
• A Test Run
• A Test Result
• A Baseline
• An Artifact
• An Executable Artifact
• A Resource
• An Operational Resource
• Another identified subject

A Catalog Entry can identify:

• Its identity
• Its name
• Its description
• Its entry type
• Its Version
• The identity of the described subject
• The type of the described subject
• The applicable Version of the described subject
• The location of the described subject
• The owner of the described subject
• The provider of the described subject
• The status of the described subject
• The availability of the described subject
• The capabilities provided by the described subject
• The requirements associated with the described subject
• The dependencies of the described subject
• The relationships of the described subject
• The applicable classifications
• The applicable search terms
• The applicable access constraints
• The applicable Policies
• The applicable Governance Policies
• The applicable content digest
• Its Provenance
• Its Traceability

A Catalog Entry can contain descriptive information directly or reference descriptive information maintained by another system.

A Catalog Entry can reference a subject stored in a Repository without copying the subject into the Catalog.

managed description of and reference to one identified subject or a defined grouping of subjects within a Catalog

Adapted from:

• Catalog
• DIDO Reference Architecture
• DIDO Reference Implementation Conceptual Model
• DIDO-TE draft Requirements Register

This definition establishes Catalog Entry as the unit of managed descriptive and discovery information contained within a Catalog.

Use the singular glossary term Catalog Entry. Link plural usage to the same controlling page:

[[dido:99_annexes:annex-b-terms-and-definitions:c:catalog_entry|Catalog Entries]]

A Catalog Entry differs from a Catalog:

• A Catalog is the managed collection
• A Catalog Entry describes and references one identified subject or a defined grouping of subjects

A Catalog Entry differs from the subject it describes:

• A Catalog Entry contains descriptive and discovery information
• The described subject is the entity, Artifact, Resource, or other item to which the entry refers

Creating, changing, or removing a Catalog Entry does not necessarily create, change, or remove the described subject.

Changing the described subject does not automatically update the Catalog Entry. The applicable Catalog-management process must maintain consistency between the Catalog Entry and the described subject.

A Catalog Entry differs from an Artifact stored in a Repository:

• A Catalog Entry describes and references the Artifact
• A Repository stores and manages the Artifact

A Catalog Entry can itself be represented as a Data Object or Artifact. That representation remains distinct from the subject described by the Catalog Entry.

A Catalog Entry differs from a registry entry:

• A Catalog Entry supports description and discovery
• A registry entry records a subject under an identified registration authority and registration process

The same entry can satisfy both definitions when the Catalog also acts as a Registry.

One subject can have multiple Catalog Entries when:

• Different Catalogs describe the subject
• Different Communities of Interest apply different descriptions
• Different Governance Domains apply different classifications
• Different Versions require separate entries
• Different access scopes expose different information

Multiple Catalog Entries that describe the same subject should preserve a common subject identity or another explicit relationship.

A Catalog Entry does not necessarily establish:

• Ownership
• Approval
• Availability
• Authenticity
• Authority
• Conformance
• Deployment
• Endorsement
• Registration
• Validation

The Catalog Entry must state these characteristics explicitly when they apply.

A Catalog Entry should identify the exact Version of the described subject when the subject has multiple Versions.

A Catalog Entry should preserve Traceability among:

• The Catalog
• The Catalog Entry
• The described subject
• The applicable Version
• The source of the descriptive information
• The governing Authority
• The applicable Policies
• The applicable Provenance

A DIDO-TE Test Definition Catalog contains a Catalog Entry for a Test Definition that evaluates distributed transaction consistency.

The Catalog Entry identifies:

• The Test Definition identity
• The Test Definition Version
• The test purpose
• The applicable Test Items
• The applicable Test Environment requirements
• The applicable Validation Criteria
• The approving Authority
• The approval status
• The applicable Governance Policies
• The Repository location
• The content digest
• The applicable Provenance
• The applicable Traceability

A User discovers the Test Definition through the Catalog Entry. The User retrieves the referenced Test Definition from the Artifact Repository.

The Catalog Entry describes and locates the Test Definition but remains distinct from the Test Definition itself.