Using the stream graph

The Streams tab lists streams while the Stream Graph tab displays a graphical representation of the relationships between parent and child streams in a selected depot.

To display streams in the Streams tab:

  1. Go to View > Streams to open the Streams tab.
  2. Select a display option by clicking the Show streams in list or tree icon streams display:

  3. Search for streams or restrict the streams that are displayed by using the Filter pane at the top of the tab. You can filter by owner, stream name, parent stream, stream type, and depot.

    For more information about filters, see Searching and filtering.

To display streams in the Stream graph:

Stream Graph display conventions

The Stream Graph provides a graphical view of stream relationships and provides tools and shortcuts for working with streams.

The graph uses location and color to depict stream types: mainline streams are gray and placed in the middle of the graph, release streams are orange and appear above the mainline, and development streams are blue and appear below.

stream graph

Status indicators between streams tell you which streams have changes to contribute and where the changes can be copied or merged:

Merge indicator: stream arrow merge

Copy indicator: stream arrow copy

The arrows are color-coded to indicate status:

For example, the following arrows above the dev-2.1M2 stream indicate that you must update it by merging down from its parent, after which you can copy up changes to the parent.

streams merge copy indic

The workspace icon workspaces indicates the stream you are currently working in.

You can drag the workspace icon to another stream to switch your workspace to that stream. The Stream field value in the workspace definition changes to the new stream.

Configure the stream graph display

  1. In the Stream Graph tab, click the arrow icon at the top left to open the filter pane.

  2. From the Depot list, select the depot that contains the streams you want to view.
  3. If the depot contains more than one mainline stream, from the Mainline list, select the mainline stream you want displayed in the graph. The field below the list populates with a tree view of the selected stream.

    The full depot path appears at the bottom of the filter pane and at the top of the Stream Graph tab, next to the arrow icon.

  4. (Optional) To focus on specific child streams, select them in the tree view.

    You may need to expand the tree to view the streams you want to select. To access quick filter options, click the filter list .

    Tip

    You can select multiple streams and then press the Spacebar to select or clear the respective check boxes.

  5. Click Apply.

    The Stream Graph displays the streams that you specified.

  6. To save the Stream graph:

    1. Click the filter list and select Save Graph As.
    2. In the Add Stream Graph Filter dialog, enter a name for the filter and click OK.

      You can now access the filter from the filter list .

  7. To close the filter pane, click the arrow icon again.
  8. (Optional) To view the actual depot location of the selected streams in the Stream Graph, from the Label list, select Stream Root.

    The full depot path appears in the stream node for each stream:

    streamrootdisplay

    This is useful if you have parent streams with child task streams that are located in other depots.

  9. (Optional) To change the size of the stream node to accommodate long depot paths, move the Width slider.

  10. (Optional) Click the navigator icon stream graph navigator to open the Graph Navigator.

    The Graph Navigator allows you to navigate the Stream graph when it is too big to fit into the available display area. In the Graph Navigator window, the red rectangle indicates the portion of the graph that is currently displayed in the Stream graph. You can use your mouse or cursor keys to move the rectangle and shift focus in the Stream graph.

    Note

    The navigator icon stream graph navigator is only available if the Stream graph is larger than the display area.

Display stream status

Double-click a stream to view a popup that contains status details:

stream popup

Work in a stream

To work in a stream or switch from one stream to another, do one of the following:

Branching with Streams

To create a new development or release branch, you create a child stream from a parent. You can also create virtual siblings of your mainline stream by branching.

Note

You can create task streams by creating a child stream from a parent, but you can also create parentless task streams. For more information about how branch a task stream, see Working with Task Streams.

To create a child stream:

  1. In the Streams tab, right-click the stream and select Create New Stream from 'stream_name'…​.
  2. In the Stream: New dialog, define the new stream.

    See Creating new streams.

  3. Verify that the new stream appears correctly in the stream graph.

    If you have specified the stream type correctly, more stable streams are displayed above the parent and less stable streams below the parent.

You can also reparent streams that have already been branched. To reparent a stream, do one of the following:

Note

You cannot reparent task streams.