Documentation: BIDM
The RIB project is no longer under development, and this website is no longer being updated.
BIDM

The Basic Interoperability Data Model

TABLE OF CONTENTS
1 | BIDM
2 | Extensions to the BIDM
3 | Figures
4 | Glossary


1 | BIDM

RIB uses the IEEE Standard 1420.1, Basic Interoperability Data Model (BIDM), as the default data model for storing and exchanging metadata. The purpose of BIDM is to define the minimal set of information about assets that reuse libraries should be able to exchange in order to support interoperability. Since the BIDM describes a minimal set, other data that would be useful for interoperability, such as library data model information as well as communication protocol and related standards, are not included in the BIDM.

The BIDM consists of five classes that each have a set of attributes and relationships. An attribute is a field that contains textual data. A relationship is a field that is used to relate one class to another class. In the context of RIB, the value of a relationship is a URL. RIGObject is the root class of the BIDM model. The "Name" attribute defined in the RIGObject class is inherited by all subclasses. The four BIDM subclasses along with their attributes and relationships are described below. Relationships are denoted by an asterik ( * ). For a graphical depiction of the data model, see Figure 2 below.


  • Asset contains information about items of interest that are stored in a reuse library, such as design documentation, specifications, source code, test suites, or any other unit of information of potential value to the reuser. Assets contain the following attributes and relationships:
  • Abstract
    Cost
    DateOfInformation
    DistributionStatement
    Domain
    IsComposedOf.Asset*
    IsLocatedIn.Library*
    IsMadeOf.Element*
    Keyword
    Language
    Name (inherited from RIGObject class)
    Restrictions
    SecurityClassification
    TargetEnvironment
    UniqueId
    Version
    VersionDate
    WasCreatedBy.Organization*

  • Element consists of a single file. This file is given the following attributes:
  • ElementType
    Media
    Name (inherited from RIGObject class)

  • Library is made up of Assets. Each library may have the attribute and relationship:
  • ContactIs.Organization*
    IsComposedOf.Library*
    Name (inherited from RIGObject class)

  • Organization may be a person, company, research group, etc., that creates and manages an Asset or Library. The following attributes may be specified for an Organization:
  • Address
    Email
    Fax
    Name (inherited from RIGObject class)
    Telephone

    The BIDM standards document (IEEE Standard 1420.1) may be purchased by contacting the IEEE at 1-800-678-IEEE or by visiting their website at http://standards.ieee.org/. The standard was developed as a collaboration between the Reuse Library Interoperability Group (RIG) and the Software Engineering Standards Committee (SESC) of the IEEE Computer Society, which evolved into the Reuse Steering Committee (RSC). Back to Table of Contents


    2 | EXTENSIONS TO THE BIDM

    Standard NHSE extension While using the BIDM within the National HPCC Software Exchange (NHSE), several fields in addition to the standard BIDM fields were found to be useful. Those fields are included in the standard NHSE extension. The fields are :

    • RigObject.RecordMaintainedBy.Organization : The Organization that is responsible for maintaining the information in the data object.
    • RigObject.Webpage : A URL where further information about the data object can be found.
    • Asset.ContactIs.Organization : The Organization which serves as a contact for the Asset.
    • Asset.TitleLine : A one-line description of the Asset.
    Note that the fields added to the RigObject class are inherited by all other classes, since RigObject is the root class of the BIDM.
    Asset Certification Framework The Asset Certification Framework (ACF) extension to the BIDM is an IEEE standard (1420.1a) that includes additional classes for information about Asset Certification, also called software review or evaluation. See
    Figure 3 below for a graphical depiction of the ACF. These additional classes can be used by reuse libraries to describe their certification policies and to exchange certification metadata.
    Intellectual Property Rights Framework The Intellectual Property Rights Framework (IPRF) extension to the BIDM is an IEEE standard (1420.1b) that includes additional classes for information about the rights management policies for a reuse library. See Figure 4 below for a graphical depiction of the IPRF. These additional classes allow reuse libraries to provide a basis for understanding what rights are attached to a particular asset and what restrictions are placed on the reuser.
    NHSE Deployment The NHSE Deployment extension includes classes which can be used to describe the deployment (installation) status of Assets. It includes two new classes - Machine, and Deployment. The Deployment class contains the relationships DeployedOn.Machine and IsDeploymentOf.Asset which can be used by RIB to create joins. Click here for more information about joins (NOTE: The joins page will open in a new browser window). Back to Table of Contents
    3 | FIGURES


    FIGURE 1 | BIDM LEGEND

    FIGURE 2 | GRAPHICAL DEPICTION OF THE BIDM see legend above

    FIGURE 3 | GRAPHICAL DEPICTION OF THE BIDM W/ ACF EXTENSIONS see legend above

    FIGURE 4 | GRAPHICAL DEPICTION OF THE BIDM W/ IPRF EXTENSIONS see legend above

    FIGURE 5 | GRAPHICAL DEPICTION OF THE BIDM W/ ACF & IPRF EXTENSIONS see legend above

    Back to Table of Contents
    4 | GLOSSARY

      Abstract - general definition or explanation of an asset.
      Address - in Organization, the mailing address of the organization (or person). Includes street number, name, city, state, zipcode, and country.
      Attribute - a characteristic of a class for which a value may be given for an instance of that class.
      Asset - any reusable entity in the software life cycle process (e.g ., a software package, tool, or routine).
      AwardedWith - relates an asset to a certificate that states that th e asset has been assessed or evaluated according to specified evaluation criteria.
      BIDM - Basic Interoperability Data Model
      Certificate - software review or evaluation.
      CertificationArtifact - a tangible result from a certification process (e.g., inspection checklist, metric report).
      CertificationLevel - Certification level awarded to an asset by a certificate.
      CertificationMethod - the method applied in assessing a certification property (e.g., inspection, static analysis, testing, formal verification, benchmarking).
      CertificationPolicy - The policy used for the certification process of the Asset.
      CertificationProperty - A feature or characteristic of an asset that may be assessed during a certification process.
      CertificationStatus - status of the certificate (e.g., approved, rejected, in progress).
      CertifiedBy - indicates the organization that issued the certificate or performed the certification process.
      Class - type of BIDM object
      ContactIs - An organization that is a point of contact for a library or asset (an organization can be a person).
      Cost - the type and amount of fees a subscriber must pay to obtain the right to reuse an asset, including type of currency paid and pricing policy for maintenance support and upgrades.
      DateOfInformation - the date the information about an asset was last updated.
      DistributionStatement - an indication of who may receive an asset.
      Domain - a broad area of interest, application area, or area of activity or knowledge.
      Element - a file that is part of an asset
      ElementType - the kind of element (e.g., source code, test suite, makefile)
      Field - an attribute or relationship.
      Icon - the url for an icon that graphically represents or provides information about the asset.
      IsComposedOf - indicates an asset that is a subset or part of an as set.
      IsLocatedIn - indicates a library (i.e., repository) in which an asset is located.
      IsMadeOf - indicates an element (i.e., file) that is part of an asset.
      Keyword - a word or phrase that describes the asset. Language - programming language used to express one or more elements of an asset.
      Library - repository that contains assets.
      LicensingTerms - Licensing terms for an asset or rights category. This outlines the specific licensing requirements that detail all of the terms between licensor and licensee of an asset or rights category.
      Local - found in the repository currently being administrated.
      Media - the media through which an element can be obtained (e.g., Cd-ROM, electronic, etc.).
      Name - name or title of an object
      Non-local - found in another (foreign) repository.
      Object - an instance of a class.
      Organization - a person, company, research group, etc. that creates and manages an asset or library.
      PolicyEffectiveDate - date the CertificationPolicy was made effective for the organization.
      PolicyReference - reference to document(s) or standard(s) that define a CertificationPolicy.
      PropertyDescription - a statement about some feature or characteristic of an asset that may be assessed as being true or false during a certification process.
      RecordMaintainedBy - an organization (see Organization) that is responsible for maintaining the catalog record for an object.
      Relationship - a relationship between two classes, expressed by a link from an instance of the first class to an instance of the second.
      Restrictions - legal information governing the use of the asset, including possibly copyright, patents, data rights, disclaimers, export restrictions, and licenses.
      RIB - Repository In a Box
      RIG - Reuse Library Interoperability Group
      RightsAssessment - A statement of the intellectual property rights of an asset determined by some organization.
      RightsCategory - A rights management (eg., distribution - shareware, public domain, etc.) category defined by a RightsPolicy
      RightsPolicy - A statement of a reuse library's policy for rights management
      SecurityClassification - the highest security classification assigned to the asset or to any part of it.
      TargetEnvironment - computer system, operating system, and/or compiler for which an asset was developed or on which an asset will operate.
      ToolApplied - reference to the automated tool applied in support of the CertificationMethod assessing the CertificationProperty.
      TitleLine - a one line description of an asset.
      UniqueID - a name or handle used to refer to the set of data that makes up the identity of the asset or element.
      Version - the designation of the version of an asset (usually a number).
      VersionDate - the publication date for the given version of an asset (i.e., the date the asset was made available for public use).
      WasCreatedBy - an organization (see Organization) that originated or produced an asset.
      Webpage - the url for the home page of the asset.
    Back to Table of Contents


      Sep 02 2014 Admin Login