Administration: Export Your Entire Subscription Data

Products

• Rally On-Premise
• Rally SaaS

Issue/Introduction

I am looking to export all data from my Rally Subscription. How can I accomplish this?

Environment

Release: AGILE CENTRAL, RALLY SAAS

Resolution

Requesting an Export

The Rally Support Team can provide you a secure download with a full export of your data in XML or JSON format. Please note that you will need to leverage internal resources if you must translate the data into another format.

To request this export, please submit a new support case at https://support.broadcom.com -- a verifiable Subscription Administrator must submit the request.  Requests from generic support accounts or shared logins can not be accepted due to the inability to verify the authenticity of the request.

Please provide the following details when requesting an export:

• Desired format (JSON or XML)

 

XML/JSON Export Details

The exported data includes your subscription's configuration, your artifacts, and timeboxes. 

Included in the full subscription export:

• Test Case Steps
• Test Cases
• Test Case Results
• Discussion Posts
• Tasks
• Defects
• Defect Suites
• Portfolio Items
• User Stories
• Iterations
• Releases
• Projects (Open and Closed)
• Workspaces
• Workspace Configuration

 

Not included in the full subscription export:

• Attachments
• Revision History
• Milestones
• Investments
• Test Sets
• Risks
• Users
• Permissions
• Schema definition, including custom field definitions

 

The export process will execute WSAPI queries against these REST endpoints, collect the result pages and store the objects in a series of files in the requested format.

 

File Format

These files will have a naming convention of "EndPoint_<index>.format" where <index> as an incremental integer starting with 0, and 'format' is the file suffix, either 'XML' or 'JSON' depending on your requested format.

 

For example (for an XML requested export):

• Defects will be provided in a series of files named: Defect_0.xml, Defect_1.xml, Defect_2.xml and so forth. 
• Tasks will be provided in a series of files named: Task_0.xml, Task_1.xml, Task_2.xml and so forth.

 

The data that is exported within these files is the full details of the objects as they are returned by the WSAPI query.

Notice that collection fields would include their reference. The export will provide you with the reference to the collection, the included count and the reference to the individual items of that collection. What the export will not do is combine or link together these referenced collections with the parent object. Essentially, this is exactly as what you will get if you ran a WSAPI query yourself that returned this user story. Also there you shall receive the reference to the collections' items. 

 

How to Download Your Data After Rally Support Has Completed The Export Process

After Rally Support has exported your data a Subscription Administrator can download it by going to Setup through the Tools icon in the upper right. From there select the Subscription tab. On the Subscription tab there will be a link to download your data. It will include the file size, and the expiration date. If it isn't downloaded before it expires you will no longer be able to do so. 

 

Using Exported Data

The main purpose of providing this export is for you to have a backup, perhaps to introspect your objects in case you needed to learn your data more deeply. Further purpose could be if you wanted to run offline data integrity checks. 

The purpose of this export is not to provide a ready-to-go file or set of files, that are ready for import into another product or system. If you wanted to migrate Rally's data into another platform, we recommend using the supported Rally Connectors and enter the search terms 'rally connectors'. These connectors vary in capabilities/functionality, they are specific to their target system. They provide an online integration between Rally and their targets. They can more easily be used to sync data or migrate data from Rally to other platforms.

The main reason the subscription data export is not best used for such migration is that the cross-references between objects are captured in various files depending on the involved endpoints. For example: if you wanted to migrate user stories along with their test cases and defects then you will have to develop a program that finds the stories, learns about all applicable test cases and defects, then locates each of those in their own respective exported files - then migrate them as one unit into your target. Essentially, this would be what the connectors will do.

Another challenge with using our XML/JSON data export to migrate data to external platforms is that you'll have to map our data to a digestible format of your target. Again, this is something that's already done by our specific connectors as they were written for this purpose.

 

Additional Information

agile central; rally; data export; data extract; export all data; Subscription Export