Skip to main content
Planview Customer Success Center

Quick Start Guide


This quick-start guide walks you through setting up a basic integration, including essential steps like connecting to your repository, constructing your model, and creating your collections.

Whether you're just getting started with Hub or need a quick refresher on how to create an integration, read this quick-start guide for a summary of each step and click the links to learn more.

After you have successfully logged into your Hub account and configured your settings, you are ready to set-up your integration!

Setting up a new integration takes four simple steps.

  1. Connect to your repository.
  2. Construct your model.
  3. Create your collection and map it to the model.
  4. Configure your integration using one of our templates.

Finally, once you've configured your integration, you can easily expand or modify your integration.

Screenshot 2023-06-14 at 10.20.29 AM 1.png


Connect to your Repository

The first step to take when configuring an integration is to connect to your repository.

Your repositories refer to the external tools that Hub will flow information between.

You can create two types of repository connections: Standard and Database. 

To create a new repository connection, select Repositories at the top of the screen.

Screenshot 2023-06-14 at 10.19.34 AM.png

Click + New Repository Connection.


Select the repository you would like to connect to in your integration.

Screenshot 2023-06-06 at 2.59.49 PM.png

Enter your authentication credentials and save your connection.

Screenshot 2023-06-06 at 3.03.38 PM.png

For detailed instructions on connecting to Standard and Database repositories, click here.


Create or Reuse a Model

model is a tool that makes the integration process scalable by defining the fields for each artifact type you would like to integrate.

Hub comes pre-packaged with several out-of-the-box models that are ready for you to use! If you'd like to use a pre-packaged model, you can skip this section and start creating your collections.

On the Models screen, you will see the name of each model, with a number identifying how many fields are included in that model.

To access your models, select Models at the top of the screen.

Screenshot 2023-06-14 at 10.20.13 AM.png

If you'd like to create a new custom model, click + New Model at the top of the screen.

Screenshot 2023-06-06 at 3.14.06 PM.png

To add fields to your model, simply click on the plus sign at the bottom left of the model box.

Screenshot 2023-06-06 at 4.02.58 PM.png

Once you're finished constructing your model, click Save and Done to save your model.

Screenshot 2023-06-06 at 4.05.59 PM.png

For detailed instructions on connecting to Standard and Database repositories, click here.


Create your Collections

The next step to take when configuring an integration is to create your collections.

Your collections define which artifacts are eligible to flow as part of your integration. 

You can create five types of collections: Work Item (Repository)ContainerWork Item (Database)GatewayOutbound Only.  

See the Planview Hub Editions table  to determine if your edition supports all collection types.

To create a new collection, select Collections at the top of the screen.

Screenshot 2023-06-14 at 10.20.19 AM.png

Click + New Collection.

Screenshot 2023-06-06 at 4.13.01 PM.png

Select the collection type.

Screenshot 2023-06-06 at 4.14.53 PM.png

Enter a name for your collection and select the repository that you would like to connect. The collection will include artifacts from the repository you have selected.

Screenshot 2023-06-06 at 4.16.49 PM.png

Add projects to your collection by selecting Manage Projects. These are the projects from which Hub will be able to create, retrieve, and update artifacts.

Screenshot 2023-06-06 at 4.18.54 PM.png

Select the artifact type from the repository that you would like to include in this collection. 

Screenshot 2023-06-06 at 4.24.24 PM.png

Select the model you'd like to use for this collection.

Screenshot 2023-06-06 at 4.26.01 PM.png

Click Save and Done to save your collection.

For detailed instructions on creating specific collection types, click here.


Configure your Integration

The last step is to configure your integration.

An integration is simply the flow of information between 2 or more tools.

Hub offers a variety of integration styles for your custom integration: Work Item SynchronizationContainer + Work Item SynchronizationEnterprise Data StreamCreate via GatewayModify via Gateway.

Hub also offers prebuilt integration patterns for your integration: Code Traceability: Create and Relate a ChangesetCode Traceability: Update an Existing Work ItemTest Synchronization.

See the Planview Hub Editions table to determine if your edition supports all integration styles and patterns.

To configure a new integration, select Integrations at the top of the screen, then click + New Integration.

Screenshot 2023-06-14 at 10.20.29 AM.png

Screenshot 2023-06-07 at 11.58.09 AM.png

Select a style or pattern for your new integration.

Screenshot 2023-06-07 at 12.07.46 PM.png

Name and describe your integration, and select your repositories and collections.

Screenshot 2023-06-07 at 12.09.23 PM.png

Running your Integration

Once you've completed your integration configuration, it's time to run your integration!

  • Simply click Run to run the integration, and Stop to stop the integration.

Screenshot 2023-06-07 at 12.10.11 PM.png

Screenshot 2023-06-07 at 12.10.28 PM.png

For detailed instructions on configuring specific integration styles, click here.