Turn Off Tabs
Serena Dimensions CM Documentation Roadmap
This document provides a complete overview of the Serena Dimensions CM documentation and where to find it. Last updated on 2017-08-24.

Contents

Where to Find Help

You can find help for Dimensions CM in the following locations:

  • Serena Documentation Center

    Visit the Documentation Center to find help systems, PDFs, readmes, and videos. The Documentation Center is a public portal that enables you to search, browse, or download the latest documentation or view older versions in the documentation archive.

  • Serena Support Site

    You can download PDFs from Serena Support including CM documentation that is not available on the Documentation Center.

  • Serena Knowledgebase

    Visit the extensive, searchable Knowledgebase to find troubleshooting information, tips, and tricks. You can search for terms and phrases in the CM documentation and the Knowledgebase will return PDFs with matching results. Note that you must have a serena.com user account to view items in the KB. Register for a free account if you do not already have one.

  • Serena Central

    Visit Serena Central to find helpful blog posts and videos. You can also test your knowledge and become certified in CM.

    Check out the User Forums to interact with other users and learn more about using Serena products. You can view and search for information, but you must create and log in to a forum account to respond to articles and interact with other users.

Documentation Summary

Readme

Each readme contains important information about a specific Dimensions CM release, including new features, installing and upgrading, fixes, limitations, and known issues.

The Dimensions CM New Feature History describes key enhancements in the last major releases, starting with version 10.1.

The readmes and feature history and are located on the Serena Documentation Center.

Documentation for Users

All documentation (Help systems and PDFs) is located on the Documentation Center unless otherwise noted in the Comments column.

Title Format Description Comments

User's Guide

 PDF and HTML

Describes how to use Dimensions CM, including:

  • Managing changes and versions
  • Working with projects and streams
  • Merging changes across streams
  • Running builds
  • Managing baselines

Help is also installed with desktop and web clients.

Getting Started Guide

 PDF

An overview of Dimensions CM including:

  • Applications and workflows
  • Change and version management
  • Access control

Command-Line Reference

 PDF

Provides full details about using the CM command-line interface.

Text-based help is installed with the command-line client.
Deployment Guide PDF and HTML

Describes how to use Dimensions CM deployment to manage items as they move through the development process.

Help is also installed with the web client.
Reports Guide PDF

Describes how to run reports, including:

  • Standard reports: product structure and change management reports.
  • Database published views for objects such as design parts, baselines, requests, items, projects, releases, and products.
Build Tools User's Guide PDF and HTML

Describes how to configure, manage, and run builds using Dimensions Build. Also describes how to integrate with Ant and build management tools (such as Jenkins).

Help is also installed with Dimensions Build.
Dimensions for z/OS User's and Administrator's Guide PDF

Describes how a z/OS mainframe can participate in a CM network, includes information about using the:

  • ISPF client
  • Batch interface
  • Command-line on USS
Docker Registry Guide PDF

Describes the CM integration that provides a Docker Private Registry for your images.

Documentation for System Administrators

All documentation (Help systems and PDFs) is located on the Documentation Center unless otherwise noted in the Comments column.

Title Format Description Comments
Installation Guide for UNIX PDF

Describes how to install, and upgrade, a Dimensions CM server, agent, and client on UNIX. Includes information about:

  • Preparing a database
  • Pre- and post-installation tasks
  • Troubleshooting
Installation Guide for Windows PDF

Describes how to install, and upgrade, a Dimensions CM server, agent, and client on Windows. Includes information about:

  • Preparing a database
  • Pre- and post-installation tasks
  • Troubleshooting
Installing the Serena-Supplied Runtime RDBMS PDF

Describes how to install the Serena-supplied RDBMS.
System Administrator's Guide PDF

Describes how to administer and configure:

  • Tomcat
  • CM server environments
  • Licences and a license server
  • Databases
  • Data migration
  • CM networks
  • Replicator
  • Archive, Retrieval, and Transfer Facilities
  • CM Pulse
Architecture and Optimization Guide PDF

Describes:

  • The CM architecture
  • How to optimize the performance of CM
Migrating to Dimensions CM PDF

Describes how to migrate to CM from:

  • PVCS Version Manager
  • CVS
  • Subversion
  • ClearCase
  • ChangeMan DS
Process Configuration Guide PDF and HTML

Describes how to configure a process model, including:

  • Privileges, users, and roles
  • Design parts
  • Products
  • Lifecycles
  • Baseline and release templates
  • Upload rules
  • Data types and MIME formats

Help is also installed with the administration console.
Serena License Manager Installation Guide PDF

Provides instructions on installing the Serena License Manager.

Documentation for Integrations

All documentation (Help systems and PDFs) is located on the Documentation Center unless otherwise noted in the Comments column.

Title Format Description Comments
Dimensions for Eclipse User’s Guide PDF and HTML

Describes how to use the CM integration with Eclipse.

Help is also installed with the Eclipse integration.
Dimensions for Visual Studio User’s Guide PDF and HTML

Describes how to use the CM integration with Microsoft Visual Studio.

Help is also installed with the Visual Studio integration.
Dimensions CM Connect for Serena Business Manager User’s Guide PDF

Describes how to setup a synchronization service between Serena Business Manager and Dimensions CM.
Dimensions CM–Dimensions RM ALM Integration Guide PDF

Describes how to setup and manage an integration between Dimensions CM and RM.
IDE User’s Guide PDF

Describes how to use CM's integration with:

  • IBM Doors
  • PowerBuilder
  • HP Quality Center
CM Bridge Getting Started Guide PDF

Describes how to use CM Bridge, a connector between a Subversion enabled client and a CM server. Includes the following clients:

  • Apple Xcode
  • TortoiseSVN
  • The Subversion Command Line

Documentation for Developers

All documentation (Help systems and PDFs) is located on the Documentation Center unless otherwise noted in the Comments column.

Title Format Description Comments
Dimensions CM Make User's Guide PDF

Describes how to use Dimensions CM Make, an integration of CM's product version management capabilities with Make.
Developer’s Reference PDF

A complete reference for:

  • The C/C++ API DTK
  • Event Callouts
  • The Java API
  • The CM templating language
  • Web services
Web Services API Documentation HTML

The complete web services API.

 HTML format

Helpful Tips

  • You can watch videos of CM features online at the Documentation Center. You can also download them from Serena Support
  • The PDF portfolio includes all the CM documentation. You can download individual PDFs from Serena Support.
  • If you open the PDF portfolio in your browser and can only see the cover page, do one of the following:
    • Chrome: right-click the page and select Save as.
    • Firefox: right-click the page and select Save Page As.
    • Open the file using Internet Explorer.
  • The CM help systems are available online from the Documentation Center.
  • Watch a quick tour of Dimensions CM Pulse.

Copyright © 2017 Serena Software, Inc. All rights reserved.