Project ALM connections

A project ALM connection links an SD Elements project with a project in another ALM tool through an existing system connector.

Add/Edit a project ALM connection

Create or update an existing project ALM connection by following the steps below.

Prerequisites:

  1. The user must satisfy one of the following:

    • Is a member of the project’s business unit and has the permission Global Roles→Administration→Edit all projects.

    • Is a member of the project and has the permission Project Roles→Project Management→Sync with ALM tools.

    • Is a member of the project and has the permission Global Roles→Integration→Edit ALM connections.

Steps:

  1. Select a project, then select the Integration tab.

  2. Select the ALM tab.

    • The project ALM integrations page appears.

  3. To add a connection, click the plus add_circle button on the right.

    • To edit an existing connection, click the connection name.

  4. Enter the following information:

    • Parent: Select the system integration connection for the ALM tool, such as JIRA or CA Agile Central.

      • If you do not see the appropriate system connector in the Parent list, contact your administrator to request a new system connector.

    • Connection Name: Enter a name for the connection.

  5. Additional configuration fields appear.

    • Refer to the ALM tool’s configuration guidance for more details.

    • It is very important that you enter the correct values for these fields instead of using the default values to ensure the integration is successful.

  6. Click Test Connection at the bottom-left of the dialog.

  7. Click Done at the bottom of the page.

The connection is ready to sync.

Test an ALM connection

To test the configuration of an ALM connection follow the steps below.

Prequisites:

  1. The user has the permission Project Roles→Integration→Sync with ALM tools.

Steps

  1. Select a project, then select the tab ALM.

    • The project ALM integrations page appears.

  2. Click the connection name.

  3. Click Test Connection at the bottom-left of the dialog.

The system will connect to the ALM and verify the provided configuration. A message will appear on the bottom-right with either a pass:

alm connection test pass.png

or an error:

alm connection test fail.png

In the case of an error, the details will be displayed at the bottom of the connection’s form.

Delete a project ALM connection

Delete a project ALM connection by following the steps below.

Prerequisites:

  • The user has the permission Project Roles→Integration→Sync with ALM tools.

Steps

  1. Open the project task list page.

  2. Select the ALM tab.

  3. Search for the connection from the list.

  4. Hover your mouse over the row on the far right and select the trashcan delete icon. A dialog will appear.

    alm connection delete.png

  5. Acknowledge the warning.

  6. Click Delete.

The connection is removed from the project and no future sync operations will occur. No changes are made to any issues in the ALM project.

Synchronize tasks

After creating a connection between your SD Elements project and an ALM project, SD Elements tasks will synchronize to the ALM project according to your selection.

For example, if you selected an automatic synchronization frequency (such as hourly or daily), synchronization will occur at the scheduled time. If you selected manual synchronization, you must click the Sync button on the ALM Integrations page to synchronize the SD Elements tasks with your ALM project.

Prerequisites:

  • The user has the permission Project Roles→Integration→Sync with ALM tools

Steps:

  1. Open the project’s list of ALM connections.

  2. Search for the desired connection from the list.

  3. Click the connection’s Sync button.

The synchronization process is initiated. It may take a few minutes or more, depending on the number of tasks in scope for integration and the latency between SD Elements and the ALM server.

During synchronization, SD Elements will attempt to add tasks to the ALM project if they do not already exist. SD Elements will add a note to each synchronized task with a reference to the new item created in the ALM system.

Project ALM connection status

A project’s ALM integrations page shows the synchronization status of each connection. The status of an integration will be shown in the "Status" column, having one of four values:

  1. Ready: The integration is ready to be run.

  2. In progress: The integration is underway.

  3. Failed: An error occurred during synchronization.

    • Click the red exclamation mark to view further details.

    • Check that the user has sufficient permission

    • Use Test Connection to troubleshoot further. and any required fields are set for a new ALM issue.

  4. Completed: The integration is successful, see the ALM project for SD Elements tasks.

results matching ""

    No results matching ""