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.

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