Get Rally Integration ID Values

ccppmop1581
As an administrator, perform the following tasks and get ID values to configure and maintain the integration between
Clarity
and Rally:
2
2
Configure Multiple PPM Integration Records
To control what default owner and project values are assigned when initiatives are created, configure and maintain multiple
Classic PPM
integration records. You can configure multiple integration records either for the same
Rally
workspace or different workspaces. However, you can map a
Classic PPM
project to only a single
Rally
workspace or instance.
To synchronize a
Classic PPM
project with a
Rally
portfolio item, you select the appropriate integration record in the Agile System field of the project. After synchronization, an initiative is created for the
Classic PPM
project. The new initiative is populated using the following default values that you defined in the
Classic PPM
integration record:
  • Agile Central Owner ID
  • Agile Central Project ID
Link a
Clarity
Project to a Rally Portfolio Item
To link an existing
Classic PPM
project to an existing
Rally
portfolio item, update the project Agile External ID attribute with the 
Rally
portfolio item object ID. The Agile External ID attribute is used internally to link
Classic PPM
projects to
Rally
portfolio items. As an administrator, update the custom information element in the Project XOG schema with the following information:
  • The object ID of the
    Rally
    portfolio item with which the project is synchronizing.
  • The
    Rally
    portfolio item with which the project is synchronizing (for example, initiative or feature).
  • The ID for the
    Rally
    integration instance.
  • The option to initiate the synchronization with
    Rally
    .
See the following example:
<CustomInformation> <ColumnValue name="agl_ext_id">39345976308</ColumnValue> <ColumnValue name="agl_id">I1</ColumnValue> <ColumnValue name="agl_system">rally1</ColumnValue> <ColumnValue name="agl_sync">true</ColumnValue> </CustomInformation>
Get the Rally Workspace ID
To obtain the workspace ID, complete the following steps:
  1. Log in to the
    Rally
    workspace (for example, rally1.rallydev.com) with your credentials.
  2. Access the following URL:
    https:///slm/webservice/v2.0/workspace
    A JSON response appears.
  3. Copy the _refObjectUUID from the JSON response and use it as the workspace ID.
    The following code shows a sample JSON response with the workspace ID bolded.
    {
    "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/40681926241",
    "_refObjectUUID": "
    6e99c9d5-95ff-4046-9155-e7384d6f353a
    ",
    "_refObjectName": "ITC Development",
    "_type": "Workspace"
    }
    ]
    }
Get the Default Rally Owner ID
To obtain the default  Rally Owner ID, complete the following 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 similar to the following appears:
    { "QueryResult": { "_rallyAPIMajor": "2", "_rallyAPIMinor": "0", "Errors": [], "Warnings": [], "TotalResultCount": 1, "StartIndex": 1, "PageSize": 20, "Results": [ { "_rallyAPIMajor": "2", "_rallyAPIMinor": "0", "_ref": , "_refObjectUUID": "6e99c9d5-95ff-4046-9155-e7384d6f353a", "_refObjectName": "ITC Development", "_type": "Workspace" } ] }
    When configuring the portfolio item hierarchy in PPM, use the portfolio item type names exactly as they appear in Rally. For example, follow the same casing and space between the words.
  3. Open a separate browser tab and copy and paste the following URL from the JSON response:
    https:///slm/webservice/v2.0/workspace/40681926241
    After accessing the URL, you get the default Rally owner ID in a JSON response.
    The following code shows a sample JSON response with the owner ID bolded:
    {
    "Workspace": {
    "_rallyAPIMajor": "2",
    "_rallyAPIMinor": "0",
    "_ref": "https://rally1.rallydev.com/slm/webservice/v2.0/workspace/40681926241",
    "_refObjectUUID": "6e99c9d5-95ff-4046-9155-e7384d6f353a",
    "_objectVersion": "3",
    "_refObjectName": "ITC Development",
    "CreationDate": "2015-08-06T15:57:42.093Z",
    …..
    ……
    "_type": "Subscription"
    },
    "Children": {
    "_rallyAPIMajor": "2",
    "_rallyAPIMinor": "0",
    "_ref": "https://rally1.rallydev.com/slm/webservice/v2.0/Workspace/40681926241/Children",
    "_type": "Project",
    "Count": 5
    },
    "Description": "Sandbox workspace for ITC development to play around with to better understand Rally and the integration with PPM",
    "Name": "ITC Development",
    "Notes": "",
    "
    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"
    },
    "Projects": {
    "_rallyAPIMajor": "2",
    "_rallyAPIMinor": "0",
    "_ref": "https://rally1.rallydev.com/slm/webservice/v2.0/Workspace/40681926241/Projects",
    "_type": "Project",
    "Count": 15
    },
    ….
    ….
    },
    "WorkspaceConfiguration": {
    "_rallyAPIMajor": "2",
    "_rallyAPIMinor": "0",
    "_ref": "https://rally1.rallydev.com/slm/webservice/v2.0/workspaceconfiguration/40681926241",
    "_refObjectUUID": "dca55e6e-5db2-49a0-aaf3-4409391270b6",
    "_type": "WorkspaceConfiguration"
    },
    "Errors": [],
    "Warnings": []
    }
    }
Get Portfolio Item Type Ordinals
To obtain the portfolio item type ordinals for configuring the portfolio item hierarchy in PPM, complete the following steps:
  1. Log in to the
    Rally
    workspace (for example, rally1.rallydev.com) as an administrator.
  2. Click your profile icon at the top-right and select
    System Administration
    .
  3. Select
    Workspaces & Projects
    and then select a workspace.
  4. In the left navigation panel, select
    Fields
    . Next, from the
    Type
    drop-down list, select
    Portfolio Item
    .
  5. Scroll down to the
    Portfolio Item Type
    field and from the gear menu, select
    Edit
    .
    The portfolio item types appear listed in descending order. The highest level item is at the top and the lowest level item is at the bottom.
  6. To obtain the ordinal corresponding to each portfolio item level, open a new tab in the browser and enter the following URL:
    https://rally1.rallydev.com/slm/doc/webservice
  7. On the new tab, in the left navigation panel, select the
    Type Definition
    topic.
    The Type Definition topic appears in the right pane
  8. On the right pane, enter the following query in the
    Query String
    field.
    ((Parent.Name = "Portfolio Item") and (Creatable = true))
  9. Select the
    Fetch full objects
    checkbox and click
    Query
    .
  10. Copy the
    Ordinal
    values for each portfolio item type from the JSON response. Use the same ordinals for the items in the portfolio item hierarchy in
    Clarity
    .
    The following image shows a sample JSON response with the
    Ordinal
    value highlighted for the
    Feature
    portfolio item type:
    portfolio_item_ordinal.jpg
Get the Default Rally Project ID
To obtain the default  Rally Project ID, complete the following steps:
  1. Log in to the
    Rally
    workspace (for example, rally1.rallydev.com) with your credentials.
  2. Obtain the
    Rally
    workspace ID. See the description for the
    Integration Instance
    field for details.
  3. Access the following URL using the workspace ID value you obtained in Step 2:
    https:///slm/webservice/v2.0/workspace/
    <workspace id>
    /projects
    A JSON response appears containing workspace projects.
  4. Use the project UUID as the default Project ID of the
    Rally
    integration instance.
    The following code shows a sample JSON response with the project ID (ca3ca519-49b5-421b-a08d-e2532227bed) in bold near the end:
    {
    "QueryResult": {
    "_rallyAPIMajor": "2",
    "_rallyAPIMinor": "0",
    "Errors": [],
    "Warnings": [],
    "TotalResultCount": 15,
    "StartIndex": 1,
    "PageSize": 20,
    "Results": [
    {
    "_rallyAPIMajor": "2",
    "_rallyAPIMinor": "0",
    "_ref": "https://rally1.rallydev.com/slm/webservice/v2.0/project/40681926325",
    "_refObjectUUID": "c6f9155c-ee45-4fa7-b82f-c04399437c13",
    "_objectVersion": "2",
    "_refObjectName": "Sample Project",
    "CreationDate": "2015-08-06T15:57:42.135Z",
    "_CreatedAt": "Aug 6, 2015",
    "ObjectID": 40681926325,
    "ObjectUUID": "c6f9155c-ee45-4fa7-b82f-c04399437c13",
    "VersionId": "2",
    "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"
    },
    "BuildDefinitions": {
    "_rallyAPIMajor": "2",
    "_rallyAPIMinor": "0",
    "_ref": "https://rally1.rallydev.com/slm/webservice/v2.0/Project/40681926325/BuildDefinitions",
    "_type": "BuildDefinition",
    "Count": 1
    },
    "Children": {
    "_rallyAPIMajor": "2",
    "_rallyAPIMinor": "0",
    "_ref": "https://rally1.rallydev.com/slm/webservice/v2.0/Project/40681926325/Children",
    "_type": "Project",
    "Count": 0
    },
    "Description": "",
    "Editors": {
    "_rallyAPIMajor": "2",
    "_rallyAPIMinor": "0",
    "_ref": "https://rally1.rallydev.com/slm/webservice/v2.0/Project/40681926325/Editors",
    "_type": "User",
    "Count": 5
    },
    "Iterations": {
    "_rallyAPIMajor": "2",
    "_rallyAPIMinor": "0",
    "_ref": "https://rally1.rallydev.com/slm/webservice/v2.0/Project/40681926325/Iterations",
    "_type": "Iteration",
    "Count": 1
    },
    "Name": "Sample Project",
    "Notes": "",
    "Owner": {
    "_rallyAPIMajor": "2",
    "_rallyAPIMinor": "0",
    "_ref": "https://rally1.rallydev.com/slm/webservice/v2.0/user/34854539788",
    "_refObjectUUID": "65bd754e-42b0-45fe-93ce-3359060a5f76",
    "_refObjectName": "team-ppm-rad-admin",
    "_type": "User"
    },
    "Parent": null,
    "Releases": {
    "_rallyAPIMajor": "2",
    "_rallyAPIMinor": "0",
    "_ref": "https://rally1.rallydev.com/slm/webservice/v2.0/Project/40681926325/Releases",
    "_type": "Release",
    "Count": 0
    },
    "RevisionHistory": {
    "_rallyAPIMajor": "2",
    "_rallyAPIMinor": "0",
    "_ref": "https://rally1.rallydev.com/slm/webservice/v2.0/revisionhistory/40681926326",
    "_refObjectUUID": "29e6f0b0-5b5f-49cf-b89e-b6a816fc324c",
    "_type": "RevisionHistory"
    },
    "SchemaVersion": "093898709ed1969ccd44bf5b936e9c5b",
    "State": "Open",
    "TeamMembers": {
    "_rallyAPIMajor": "2",
    "_rallyAPIMinor": "0",
    "_ref": "https://rally1.rallydev.com/slm/webservice/v2.0/Project/40681926325/TeamMembers",
    "_type": "User",
    "Count": 1
    },
    "Workspace": {
    "_rallyAPIMajor": "2",
    "_rallyAPIMinor": "0",
    "_ref": "https://rally1.rallydev.com/slm/webservice/v2.0/workspace/40681926241",
    "_refObjectUUID": "6e99c9d5-95ff-4046-9155-e7384d6f353a",
    "_refObjectName": "ITC Development",
    "_type": "Workspace"
    },
    "_type": "Project"
    },
    {
    "_rallyAPIMajor": "2",
    "_rallyAPIMinor": "0",
    "_ref": "https://rally1.rallydev.com/slm/webservice/v2.0/project/42778749224",
    "_refObjectUUID": "ca3ca519-49b5-421b-a08d-e2532227bed1",
    "_objectVersion": "49",
    "_refObjectName": "
    Learn Rally
    ",
    "CreationDate": "2015-09-10T17:13:30.964Z",
    "_CreatedAt": "Sep 10, 2015",
    "ObjectID": 42778749224,
    "ObjectUUID": "
    ca3ca519-49b5-421b-a08d-e2532227bed1
    ",
    ......
    },
    …………..
    …………..
    ]
    }
    }