Prepare for the Integration

Before you can configure the integration between
Clarity
and
Rally
, you need to fetch connection information from
Rally
. Keep this information handy so that you can provide them while configuring the integration.
Depending on the integration type you choose, obtain the following information:
Create a
Rally
 API Key
The
Clarity
-
Rally
integration supports two types of authentication - basic and API Key. Skip this procedure if you want to use basic authentication. API key authentication provides additional security and hence allows the integration to securely connect to
Rally
. The API Key is associated with a 
Rally
user that has the required privileges to update the
Rally
workspace. Whenever you synchronize information from or  to
Rally
, the updates appear for the
Rally
user that is associated with the API Key.
Follow these steps to create an API Key
:
  1. Log in to
    Rally
    (https://rally1.rallydev.com/, for example) as an Administrator.
  2. Click
    Create New API Key.
  3. Enter a
    Description
    .
  4. Select the
    Full Access
    checkbox and click
    Create
    .
  5. Note down the API Key that you created.
Get the
Rally
Workspace ID
Get the ID of the
Rally
Workspace that you want to use for synchronizing
Clarity
projects. After the integration is configured, the
Clarity
projects will be synchronized with the Portfolio Items in this workspace. 
Follow these steps
:
  1. Log in to the
    Rally
    workspace (for example, rally1.rallydev.com) with your credentials.
  2. Access the following URL:
    https://rally1.rallydev.com
    /slm/webservice/v2.0/workspace
    A JSON response appears.
  3. Note down the value of _refObjectUUID from the JSON response.
    The following code shows a sample JSON response with the workspace ID in
    bold
    .
    { "QueryResult": { "_rallyAPIMajor": "2", "_rallyAPIMinor": "0", "Errors": [], "Warnings": [], "TotalResultCount": 1, "StartIndex": 1, "PageSize": 20, "Results": [ { "_rallyAPIMajor": "2", "_rallyAPIMinor": "0", "_ref": "https://rally1.rallydev.com/slm/webservice/v2.0/workspace/41529001", "_refObjectUUID": "
    3497d043-3ea7-4c8a-bf78-069847936c13
    ", "_refObjectName": "
    Rally
    ", "_type": "Workspace" } ] } }
Get the
Rally
Project ID and Owner ID
If you are planning to use the Portfolio Item integration type, you need to get the project ID and owner ID from
Rally
. After the integration is configured, the synchronization job uses this information to create the following objects in
Rally
:
  • Create an Initiative
  • Create other portfolio items when you select the following integration direction:
    • Clarity
      -
      Rally
    • Bi-directional
For the investment integration type, the project ID and owner ID are not required as investments are not tied to a specific project and neither do they require an owner to be associated.
  1. Log in to
    Rally
    (rally1.rallydev.com, for example) and switch to the workspace that you want to associate with the integration.
  2. Access the following URL:
    A JSON response with the high-level attributes of the selected workspace appears.
  3. Click the URL in the _ref key as highlighted in
    bold
    below:
    { "QueryResult": { "_rallyAPIMajor": "2", "_rallyAPIMinor": "0", "Errors": [], "Warnings": [], "TotalResultCount": 1, "StartIndex": 1, "PageSize": 20, "Results": [ { "_rallyAPIMajor": "2", "_rallyAPIMinor": "0", "_ref": "
    https://rally1.rallydev.com/slm/webservice/v2.0/workspace/41529001
    ", "_refObjectUUID": "3497d043-3ea7-4c8a-bf78-069847936c13", "_refObjectName": "
    Rally
    ", "_type": "Workspace" } ] } }
    A JSON response with details of the selected workspace appears.
  4. Search for
    Owner
    and note down the value of _refObjectUUID as the Owner ID:
    "Owner": { "_rallyAPIMajor": "2", "_rallyAPIMinor": "0", "_ref": "https://rally1.rallydev.com/slm/webservice/v2.0/user/42778241050", "_refObjectUUID":
    "f8d849a9-1691-44ef-bc90-5fadb8392709"
    , "_refObjectName": "ITC Admin Portfolio Manager", "_type": "User" },
  5. Search for
    Projects
    in the same JSON response and click the URL as highlighted in
    bold
    below:
    "Projects": { "_rallyAPIMajor": "2", "_rallyAPIMinor": "0", "_ref":
    "https://rally1.rallydev.com/slm/webservice/v2.0/Workspace/40681926241/Projects"
    , "_type": "Project", "Count": 20 },
    A JSON response with details of all the projects in your current workspace appears.
  6. Identify the
    Rally
    project that you want to use for the integration using _refObjectName key.
  7. Note down the value of the corresponding _refObjectUUID as the Project ID. The following code snippet highlights the project name and its UUID in
    bold
    :
    { "_rallyAPIMajor": "2", "_rallyAPIMinor": "0", "_ref": "https://rally1.rallydev.com/slm/webservice/v2.0/project/40681926325", "_refObjectUUID": "
    c6f9155c-ee45-4fa7-b82f-c04399437c13
    ", "_objectVersion": "80", "_refObjectName":
    "Acme Corporation"
    , "CreationDate": "2015-08-06T15:57:42.135Z", "_CreatedAt": "Aug 6, 2015", "ObjectID": 40681926325, "ObjectUUID": "c6f9155c-ee45-4fa7-b82f-c04399437c13", "VersionId": "80", "Subscription": { "_rallyAPIMajor": "2", "_rallyAPIMinor": "0", "_ref": "https://rally1.rallydev.com/slm/webservice/v2.0/subscription/32868941812", "_refObjectUUID": "fc3c31fd-4761-401c-9851-d825709e6ec6", "_refObjectName": "Tech Partner - CA Technologies", "_type": "Subscription" },
Get the Portfolio Item Type Ordinals
If you are planning to use the Investment integration type, obtain the ordinal value of all the portfolio item types in your
Rally
hierarchy. The ordinals are used for creating and maintaining the hierarchy in
Clarity
  1. Access the
    Rally
    webservice from the following URL: https://rally1.rallydev.com/slm/doc/webservice
  2. On the left pane, click
    typeDefinition
    under
    Object Model
    .
  3. On the right pane, enter the following query in the
    Query String
    field.
    ((Parent.Name = "Portfolio Item") and (Creatable = true))
  4. Select the
    Fetch full objects
    checkbox and click
    Query
    .
  5. Copy the
    Ordinal
    values for each portfolio item type from the JSON response. Note down the _refObjectName and the corresponding ordinal value for each portfolio item type. Use the same name and ordinal value while configuring the integration. The following snippet shows a sample JSON response with the
    Ordinal
    value highlighted for the
    Feature
    portfolio item type:
    { "_rallyAPIMajor": "2", "_rallyAPIMinor": "0", "_ref": "https://rally1.rallydev.com/slm/webservice/v2.0/typedefinition/4628560478", "_refObjectUUID": "402c5194-9e3f-44ac-95b8-8d8da2826f85", "_objectVersion": "3",
    "_refObjectName": "Feature",
    "CreationDate": "2012-09-01T06:00:00.000Z", "_CreatedAt": "Sep 1, 2012", "ObjectID": 4628560478, "ObjectUUID": "402c5194-9e3f-44ac-95b8-8d8da2826f85", "VersionId": "3", "Subscription": { "_rallyAPIMajor": "2", "_rallyAPIMinor": "0", "_ref": "https://rally1.rallydev.com/slm/webservice/v2.0/subscription/400059", "_refObjectUUID": "76de2093-5f8d-403d-a2db-fcec9c5c7079", "_refObjectName": "
    Rally
    Development 100", "_type": "Subscription" }, "Workspace": { "_rallyAPIMajor": "2", "_rallyAPIMinor": "0", "_ref": "https://rally1.rallydev.com/slm/webservice/v2.0/workspace/41529001", "_refObjectUUID": "3497d043-3ea7-4c8a-bf78-069847936c13", "_refObjectName": "
    Rally
    ", "_type": "Workspace" }, "Abstract": false, "Attributes": { "_rallyAPIMajor": "2", "_rallyAPIMinor": "0", "_ref": "https://rally1.rallydev.com/slm/webservice/v2.0/TypeDefinition/4628560478/Attributes", "_type": "AttributeDefinition", "Count": 154 }, "Copyable": true, "Creatable": true, "Deletable": true, "DisplayName": "Portfolio Item Feature", "ElementName": "Feature", "IDPrefix": "F", "Name": "Feature", "Note": "Portfolio Item",
    "Ordinal": 0,
After you obtain the connection information, you are ready to configure the integration with
Rally
.
Next Step: