Home
Managing change and releases
Learn how to manage change and release in the product.
Using your HCL Compass Web client
HCL Compass Web is a browser-based interface to HCL Compass that runs on Windows, the UNIX system, and Linux. You can track defects and change requests in HCL Compass Web through this interface. When a session times out, you can re-authenticate and continue where you left off because the state of the user interface is retained.
Creating REST URIs to log on and perform common tasks
Using the HCL Compass Web client, you can create Representational State Transfer (REST) Uniform Resource Identifiers (URIs) to log on to your user database and perform common tasks. REST URIs provide a uniform interface to Web resources, letting you access data by using any HTTP client.
Creating REST URIs to log on
You can create REST URIs to log on to HCL Compass Web.

Managing change and releases
Learn how to manage change and release in the product.
- Using your HCL Compass Web client
  HCL Compass Web is a browser-based interface to HCL Compass that runs on Windows, the UNIX system, and Linux. You can track defects and change requests in HCL Compass Web through this interface. When a session times out, you can re-authenticate and continue where you left off because the state of the user interface is retained.
  - Understanding your HCL Compass Web client
  - Using records to store change requests
  - Adding attachments to records to store additional information
  - Using queries to find records
  - Viewing query results in reports
  - Analyzing query results in charts
  - Using integrations for Collaborative Lifecycle Management
    You can use Collaborative Lifecycle Management (CLM) integrations to connect the work of all team members. Collaborative Lifecycle Management integrations with HCL Compass Web are also referred to as the HCL Compass Bridge.
  - Creating REST URIs to log on and perform common tasks
    Using the HCL Compass Web client, you can create Representational State Transfer (REST) Uniform Resource Identifiers (URIs) to log on to your user database and perform common tasks. REST URIs provide a uniform interface to Web resources, letting you access data by using any HTTP client.
    - Creating REST URIs to log on
      You can create REST URIs to log on to HCL Compass Web.
    - Creating REST URIs to reference records
      You can create REST URIs to reference records in your user database.
    - Creating REST URIs to run queries
      You can create REST URIs to run queries.
    - Creating REST URIs to run data-push reports
      You can create REST URIs to run traditional data-push reports.
    - Creating REST URIs to run data-push charts
      You can create REST URIs to run traditional data-push charts.
  - HCL Compass records enabled for UCM
    When you use the integration with HCL VersionVault Unified Change Management (UCM), HCL Compass records enabled for UCM provide current information about associated UCM activity.
  - Working with database replicas
- Using the HCL Compass Client
  Use the HCL Compass Client to submit, modify, and track change requests and to analyze project progress.
- Using HCL Compass for Windows® client
  You can use HCL Compass to perform daily activities after the schema developer and administrator define and set up the schema, schema repository, and user database.
- Using HCL Compass ALM
  The application lifecycle management (ALM) packages and ALM schema provide out-of-the-box solutions for ensuring ALM best practices in your new or existing HCL Compass change management system.

Creating REST URIs to log on

You can create REST URIs to log on to HCL Compass Web.

About this task

To create a REST URI to log on to HCL Compass Web:

Procedure

On the HCL Compass Web toolbar, click the arrow next to New Change Request and select New REST URI.
The New REST URI wizard opens.
Select Log on from the REST URI Type list.
Click Create.
The REST URI logon template appears in the REST URI Template field.
Copy the template into a text editor and replace the placeholders {{loginid}} and {{password}} with your login ID and password, respectively.
Optional: Change the default format for the resource request from HTML to XML or ATOM.
Copy the modified template into your Web application or another Web browser window.
Click Reset to create a new REST URI template or Close to exit.

Example

The following REST URI template to log on to HCL Compass Web was created by using the New REST URI wizard.

http://CQWebServerHost/cqweb/restapi/YourConnection/YourUserDB?format=HTML&loginId={{loginid}}&password={{password}}

The variables and template placeholders have the following meanings:

CQWebServerHost: Web address of your HCL Compass Web server host system. This value is defined when the REST URI template is created.
YourConnection: Your HCL Compass connection. This value is defined when the REST URI template is created.
YourUserDB: Your HCL Compass user database. This value is defined when the REST URI template is created.
format: The default format for the resource request is HTML. You can change the format to XML or ATOM, if desired.
{{loginid}}: Placeholder for your logon ID.
{{password}}: Placeholder for your password.