Home
Extending product function
Learn how to extend the product.
Programming with HCL Compass CM API
HCL Compass CM API object model overview
The HCL Compass CM API common object model maps HCL Compass objects to a resource proxy hierarchy, based on the WVCM proxy and property model. This common data model enables API client applications to retrieve data, through one set of interfaces, as API resources.
Location objects
Each resource has a location that uniquely identifies it to the server.
Location syntax
Each Resource has a location that uniquely identifies the resource at a specific point in time.
File name location specifications
ControllableResources in a file area can be referenced by an absolute or relative file-system path name by using the host operating system naming conventions.

Extending product function
Learn how to extend the product.
- HCL Compass REST API developer guide
- Programming with the HCL Compass OSLC CM REST API
  Learn how to use Compass CM REST API that supports both, OSLC v1 and v2.
- Programming with HCL Compass CM API
  - HCL Compass CM API introduction
    The HCL Compass CM API is a unified Java™ API through that you can access HCL Compass.
  - HCL Compass CM API object model overview
    The HCL Compass CM API common object model maps HCL Compass objects to a resource proxy hierarchy, based on the WVCM proxy and property model. This common data model enables API client applications to retrieve data, through one set of interfaces, as API resources.
    - Resources and proxies
      The HCL Compass CM API comprises proxy objects for the persistent resources that are stored in the HCL Compass repositories.
    - Location objects
      Each resource has a location that uniquely identifies it to the server.
      - Location syntax
        Each Resource has a location that uniquely identifies the resource at a specific point in time.
        Stable locations
        An alternate form of location specification uses repository and object IDs (typically UUIDs) instead of names.
        File name location specifications
        ControllableResources in a file area can be referenced by an absolute or relative file-system path name by using the host operating system naming conventions.
    - Properties and meta-properties
      Resources have properties. Each property has a name, a type, and a value; it might have other meta-properties associated with it (such as its value, size, or an indication of its validity).
    - Collections
      Several HCL Compass CM API methods return collections of resources.
    - Change contexts and context resources
      A change context is a workspace or container for editing context resources which are nonversioned resources, such as records and queries.
    - Exceptions
      All problems are reported by means of an exception object, which is a subclass of the exception object defined by WVCM.
  - Class overviews
    The Javadoc information that is included with the HCL Compass CM API provides an overview section that includes descriptions of the available classes. Each class represents a major collection of operations supported by the API.
  - Configuring HCL Compass CM API logging
    You can configure HCL Compass CM API logging.

File name location specifications

ControllableResources in a file area can be referenced by an absolute or relative file-system path name by using the host operating system naming conventions.

For example:

/my_views/my_dir/my_file.txt

The namespace of a file location specification is Namespace.PNAME. The object name field is the path name and the remaining fields are null. The path name is not modified by the Provider or Location class.

The HTTP file scheme prefix "file://" is also recognized as a valid flag for a file selector. For example:

file:///c:/my_views/my_testview/my_testDir/my_file.txt