Client version checking

Not all methods are available to older client applications if the methods became available in a later version. Version information can help provide information for determining what methods are available for all clients you may be supporting. The individual method sections of this Reference documentation include notes for what version a given Perl or COM API method became available.

The version numbering convention for HCL products follows the standard HCL VRMF (Version, Release, Maintenance, Fix Pack) versioning model. This change may impact existing HCL Compass API code that checks or compares version numbers (that can be used to prevent older or specific client versions from making changes to records). For example, existing code that checks version numbers as string values using a Perl le (less than or equal) or ge (greater than or equal) comparison operator may not work as expected for a comparison between a newer version number and an older version number.

The following table lists product version and feature level numbers returned by the HCL Compass API methods:

for Perl: GetProductVersion method of the ProductInfo object
for VBScript: GetProductVersion method of the Session object
for Perl and VBScript: GetMinCompatibleFeatureLevel and GetMaxCompatibleFeatureLevel methods of the Session object

Note: You can use the GetDatabaseFeatureLevel method of the Database object to get the feature level in use by a database. The value must be within the range of the MinCompatibleFeatureLevel and MaxCompatibleFeatureLevel for the client to work with the database.

The following table lists API version information returned by the HCL Compass API methods for each product version:

for Perl: GetObjectModelVersionMajor and GetObjectModelVersionMinor methods of the Session object
for VBScript: GetClearQuestAPIVersionMajor and GetClearQuestAPIVersionMinor methods of the Session object