Here is the enhanced User Guide for ELITEA Toolkit integration with Rally, incorporating your feedback and requirements:

ELITEA Toolkit Guide: Rally Integration

Introduction

Purpose of this Guide

This guide is your definitive resource for integrating and effectively utilizing the Rally toolkit within ELITEA. It provides a detailed, step-by-step walkthrough, from setting up your Rally API Key to configuring the toolkit in ELITEA and seamlessly incorporating it into your Agents. By following this guide, you will unlock the power of automated Agile project management, streamlined workflows, and enhanced team collaboration, all directly within the ELITEA platform. This integration empowers you to leverage AI-driven automation to optimize your Rally-driven workflows, enhance project visibility, and improve team productivity within your Agile development environment.

Brief Overview of Rally

Rally, by Broadcom, is a leading Agile project management platform designed to support and streamline Agile software development methodologies. It provides a comprehensive suite of tools for planning, tracking, and managing Agile projects at scale. Rally is widely used by Agile teams to:

Integrating Rally with ELITEA brings these powerful Agile project management capabilities directly into your AI-driven workflows. Your ELITEA Agents can then intelligently interact with your Rally workspaces and projects to automate Agile task management, enhance project tracking, improve team collaboration, and leverage AI to optimize your entire Agile development lifecycle within Rally.

Toolkit's Account Setup and Configuration in Rally

Account Setup

Rally is a commercial Agile project management platform. To create a Rally account, follow these steps:

  1. Visit Broadcom Rally Website: Open your web browser and navigate to the official Broadcom Rally website (e.g., rallydev.com or your organization's specific Rally URL).
  2. Sign Up or Request Access: Click on the "Sign Up", "Free Trial", or "Request Demo" button, depending on your organization's access and trial requirements.
  3. Follow Registration Process: Follow the on-screen instructions to create an account or request access. You will typically need to provide your business email address and other required information.
  4. Email Verification and Account Setup: After submitting the registration form, you should receive a confirmation email from the Rally team. This email may include instructions on how to verify your email address and set up your Rally account. Follow the instructions in the email to complete the account creation process.
  5. Log In to Rally: Once your account is set up and verified, log in to Rally using your newly created credentials.

Token/API Key Generation: Creating an API Key in Rally

For secure integration with ELITEA, it is essential to use a Rally API Key for authentication. This method is more secure than using your primary Rally account password directly and allows you to control access permissions for ELITEA.

Follow these steps to generate an API Key in Rally:

For secure integration with ELITEA, it is essential to use a Rally API Key for authentication. This method is more secure than using your primary Rally account password directly and allows you to control access permissions for ELITEA.

Follow these steps to generate an API Key in Rally:

  1. Sign in to Rally and Access Setup Icon: Begin by signing in to your Rally workspace. Once logged in, locate and click on the Setup icon (⚙️). This icon is typically found in the top right corner of the Rally interface and provides access to user and workspace settings.

    Rally-Setup

  2. Access My Settings via Avatar: After clicking the Setup icon, click on your Avatar (your profile picture or initials), located in the top right corner of the Rally interface, next to the Setup icon. From the dropdown menu that appears, select "My Settings".

    Rally-Workspaces_Projects

  3. Locate API Keys Section in Top Banner: On the "My Settings" page, look for the "API Keys" section. This section is prominently displayed in a banner at the top of the "My Settings" page, making it easily accessible.

  4. Create API Key: Once you have located the "API Keys" section, click on the "Create" button. This button will initiate the generation of a new API key for your Rally account.

    Rally-Create_API_Key

  5. Securely Copy and Store Your API Key: A new API Key will be generated and displayed. Immediately copy the newly generated API Key. This is the only time you will see the full API Key value. It is crucial to store it securely in a password manager or, preferably, ELITEA's built-in Secrets feature for enhanced security within ELITEA. You will need this API Key to configure the Rally toolkit in ELITEA.

System Integration with ELITEA

Agent Creation/Configuration

To integrate Rally functionalities into your workflows, you will need to configure the Rally toolkit within an ELITEA Agent. You can either create a new Agent specifically for Rally interactions or modify an existing Agent to incorporate Rally tools.

  1. Navigate to Agents Menu: In ELITEA, go to the Agents menu from the main navigation panel.
  2. Create or Edit Agent:
    • Create a New Agent: Click on the "+ Agent" button to create a new Agent. Follow the on-screen prompts to define essential Agent attributes such as Agent name, a descriptive Agent description, the desired Agent type, and initial instructions for the Agent.
    • Edit an Existing Agent: Select the Agent you intend to integrate with Rally from your list of Agents. Click on the Agent's name to open its configuration settings for editing.
  3. Access Tools Section: Within the Agent configuration interface, scroll down until you locate the "Tools" section. This section is where you will add and configure toolkits, including the Rally toolkit.

Toolkit Configuration

This section provides detailed instructions on how to configure the Rally toolkit within your ELITEA Agent.

  1. Add Toolkit: In the "Tools" section of the Agent configuration, click on the "+" icon. This action will display a dropdown list of available toolkits that can be integrated with your Agent.
  2. Select Rally Toolkit: From the dropdown list of available toolkits, choose "Rally". Selecting "Rally" will open the "New Rally tool" configuration panel, where you will specify the settings for your Rally integration.
  3. Configure Rally Toolkit Settings: Carefully fill in the following configuration fields within the "New Rally tool" section:

    • Name: Enter a descriptive Name for your Rally toolkit instance. Choose a name that is easily recognizable and helps you identify its purpose within your Agent's instructions (e.g., "ProjectRally", "AgileManagementAccess", "RallyIntegration").
    • Description: Provide a concise Description for the toolkit. This description should clarify the toolkit's purpose or the specific Rally workspace or project it is intended to access (e.g., "Toolkit for accessing and managing user stories in Rally", "Integration for Rally Workspace 'Project Alpha'").
    • Rally Server URL: Enter the base URL of your Rally instance. Ensure you use the correct format, including https:// or http:// and the full workspace URL (e.g., https://rally1.rallydev.com). For Epam Rally, use https://rally.epam.com.
    • Workspace Name: Enter the Workspace Name in Rally that you want to access with this toolkit. The Workspace Name is the name of your Rally workspace (e.g., "My Workspace").
    • Project Name: Enter the Project Name within your Rally workspace that you want to access with this toolkit. The Project Name is the name of your Rally project (e.g., "Project Alpha").
    • Authentication Options - API Key: Select the "API Key" authentication option.
      • Password/Secret: Choose "Password" and paste the API Key you generated in Rally (during the "Software-Specific Setup" section of this guide) into the "Password" field.
      • Enhanced Security with Secrets (Recommended): For enhanced security, it is strongly recommended to use ELITEA's Secrets Management feature to store your Rally API Key securely. Instead of directly pasting the token into the "Password" field, select the "Secret" option and choose the pre-configured secret containing your Rally API Key from the dropdown list. This prevents hardcoding sensitive credentials in your toolkit configuration.

    Rally-Toolkit_Configuration

  4. Enable Desired Tools: In the "Tools" section within the Rally toolkit configuration panel, select the checkboxes next to the specific Rally tools that you want to enable for your Agent. It is crucial to enable only the tools that your Agent will actually need to use to adhere to the principle of least privilege and minimize potential security risks. Available tools include:

    • Get types - Retrieves the types of artifacts available in Rally.
    • Get entities - Fetches specific entities from Rally based on provided criteria.
    • Create artifact - Allows the Agent to create new artifacts (e.g., user stories, tasks) in Rally.
    • Update artifact - Enables the Agent to update existing artifacts in Rally.
    • Get project - Allows the Agent to retrieve details of a specific project in Rally.
    • Get workspace - Fetches information about the workspace in Rally.
    • Get user - Retrieves user details from Rally.
    • Get context - Provides context-specific information from Rally.
  5. Complete Setup: After configuring all the necessary settings and enabling the desired tools, click the arrow icon (typically located at the top right of the toolkit configuration section) to finalize the Rally toolkit setup and return to the main Agent configuration menu.
  6. Click Save in the Agent configuration to save all changes and activate the Rally toolkit integration for your Agent.

Tool Overview: Rally Toolkit Functionalities

Once the Rally toolkit is successfully configured and added to your Agent, you can leverage the following tools within your Agent's instructions to enable intelligent interaction with your Rally workspaces and projects:

Instructions and Prompts for Using the Rally Toolkit

To effectively utilize the Rally toolkit within your ELITEA Agents, you need to provide clear and precise instructions within the Agent's "Instructions" field, telling the Agent how and when to use these tools.

General Instruction Structure:

When instructing your Agent to use a Rally tool, you will typically follow this pattern:

Use the "[tool_name]" tool to [describe the action you want to perform] in Rally.
Provide the following parameters:
- Parameter 1: <value or description of value>
- Parameter 2: <value or description of value>
- ...

Example Agent Instructions for Rally Toolkit Tools:

Important Considerations for Agent Instructions:

Best Practices and Use Cases for Rally Integration

Best Practices for Efficient Integration

Use Cases for Rally Toolkit Integration

The Rally toolkit opens up a wide range of automation possibilities for Agile project management, workflow automation, and reporting within ELITEA. Here are some compelling use cases:

Troubleshooting and Support

Troubleshooting Common Issues

FAQs

  1. Q: Can I use my regular Rally username and password for the ELITEA integration?
    • A: No, it is mandatory to use a Rally API Key instead of your main account password for secure integration with ELITEA. Direct password authentication is not supported. API Keys provide a more secure and controlled way to grant access to external applications like ELITEA.
  2. Q: What permissions should I grant to the Rally API Key?
    • A: Rally API Keys, when generated through the user profile, inherently provide access based on the user's permissions within Rally. Ensure that the Rally user account associated with the API Key has the necessary permissions within Rally to access and modify the workspaces and projects your Agent will be interacting with. You do not need to configure specific scopes during API Key generation as permissions are managed through Rally user roles and project access control.
  3. Q: What is the correct format for the Rally Server URL in the toolkit configuration?
    • A: The Rally Server URL should be entered in the full format, including https:// or http:// and the complete workspace URL (e.g., https://rally1.rallydev.com or https://rally.epam.com). Ensure there are no typos or missing parts in the URL.
  4. Q: How do I find the Workspace Name and Project Name for my Rally project?
    • A: The Workspace Name and Project Name are typically displayed in the Rally web interface when you are logged in and viewing your Rally project. The Workspace Name is usually visible in the top navigation bar, and the Project Name is displayed on the project dashboard or project selection menus. You can also find these names in the URL when you are within your Rally workspace or project.
  5. Q: Why is my Agent getting "Permission Denied" errors even though I think I have configured everything correctly?
    • A: Double-check the following:
      • API Key Validity: Ensure that the API Key is valid and has not been revoked in your Rally user settings.
      • Rally Account Permissions: Verify that the Rally account associated with the API Key has the necessary permissions to access the specific workspaces and projects your Agent is trying to interact with.
      • Workspace and Project Names Accuracy: Double-check that you have entered the correct Workspace Name and Project Name in the toolkit configuration and that they correspond to the Rally workspace and project you intend to access.
      • Server URL Accuracy: Ensure that the Server URL is correctly entered and points to the base URL of your Rally instance.

Support and Contact Information

If you encounter any issues, have questions, or require further assistance beyond what is covered in this guide regarding the Rally integration or ELITEA Agents in general, please do not hesitate to contact our dedicated ELITEA Support Team. We are here to help you resolve any problems quickly and efficiently and ensure you have a smooth and productive experience with ELITEA.

How to Reach ELITEA Support:

Best Practices for Effective Support Requests:

To help us understand and resolve your issue as quickly as possible, please ensure you provide the following information in your support email:

Before Contacting Support:

We encourage you to first explore the resources available within this guide and the broader ELITEA documentation. You may find answers to common questions or solutions to known issues in the documentation.

To further enhance your understanding and skills in integrating Rally with ELITEA, here are some helpful resources: