CXTM Documentation

CXTM provides 3 primary documentation references directly accessible from the sidebar menu.

• REST API
• CXTM's interactive REST API documentation
• Also linked from the Credentials dropdown in your lab guide
• Robot Documentation
• Documentation related to CXTM's use of the Robot Framework and associated libraries
• Includes the CXTA (CX Test Automation) Keyword Index used earlier in the lab
• The Keyword index is also linked from the Credentials dropdown in your lab guide
• CXTM Docs
• CXTM User Guide
• CXTM Release Notes
• Use to supplement this lab guide, or as a self-guided tour of CXTM

Step 1 - Locate CXTM Documentation in the sidebar menu

Step 2 - Open the API Documentation

In the left sidebar navigation menu:

1. Click on REST API

The REST API documentation page will open in a new browser window.





Any operation done in CXTM's GUI can also be done through the API, and the embedded swagger interactive documentation is the place to go to experiment when developing your pipelines. Here you'll find the API endpoints for the CXTM features, along with examples and schemas. Once you generate an API Key through CXTM, you'll be able to return to this page to make API calls to CXTM and review the responses.

2. Close this browser window and return to CXTM

Step 3 - Open the Robot Documentation

In the left sidebar navigation menu:

1. Click on Robot Documentation

The Robot Documentation page will open in a new browser window.





These Robot Documentation pages provide useful information on CXTA (CX Test Automation), the collection of automation libraries built around Robot Framework.

2. Click on the Keyword Index link







The Keyword Index documents all the Keywords available in the CXTA collection of libraries, and is particularly relevant to this lab. You'll find this to be a valuable resource when developing Robot test cases using CXTA libraries.

3. Close this browser window and return to CXTM