Skip to content
Docs
Arcus
Popular questions
↑↓ to navigate↵ to selectesc to close
Book a demo

OpenProject

The OpenProject integration syncs the active sprints and work packages of your OpenProject projects into Arcus. You generate test cases from them in QI Home, trace accepted test cases back to their work packages, and log defects as work packages.

Once a project is linked, Arcus syncs its active and planned sprints with their stories and tasks. Each sprint appears on the Sprints tab of QI Home.

After the first sync, Arcus keeps the work packages current:

  • New and updated work packages: Arcus syncs the change. A work package added to a sprint after its test cases were generated appears in the Arcus sprint, ready to generate.
  • Deleted work packages: Arcus detects the deletion. Test cases linked to a deleted work package stay in your library and keep the link. The work package shows an Orphaned badge on the test case.

Arcus receives changes through a webhook that you add in OpenProject. Arcus also checks OpenProject for changes on a schedule, so it catches changes that the webhook misses.

You create an OAuth application in OpenProject, then enter its credentials in Arcus.

  1. Go to Settings > Integrations.

  2. Click Setup Integration on the OpenProject card. The Connect OpenProject dialog opens, with the OpenProject steps on the left and the Arcus fields on the right.

  3. In OpenProject, open Administration > Authentication > OAuth applications.

  4. Add an application named Arcus.

  5. Copy the Redirect URI and the Scope (api_v3) from the Arcus dialog into the new application.

  6. Turn on Confidential. OpenProject issues a client secret only for a confidential application.

  7. Save the application.

  8. Copy the client ID and client secret that OpenProject shows.

  9. In Arcus, enter the Instance URL, the address you use to open OpenProject, for example https://openproject.example.com.

  10. Enter the Client ID and Client secret.

  11. Click Connect. OpenProject asks you to approve access for Arcus.

  12. Approve the access in OpenProject. Arcus opens Settings > Integrations again, and the OpenProject card shows Connected.

For the OpenProject side of the setup, see OAuth applications in the OpenProject documentation.

Section titled “Link an Arcus project to OpenProject projects”

An Arcus project can link to one or more OpenProject projects.

  1. Open the project switcher and click Project Settings.

  2. Under Project Management Tool, click Link OpenProject Project. If the project already has a link, the button reads Add OpenProject Project.

  3. Select an OpenProject project. You can search by name.

  4. If the project has subprojects, choose Link no subprojects, Link all subprojects, or Choose subprojects. For Choose subprojects, select the subprojects to link.

  5. Click Link. If the parent project is already linked, the button reads Save. You can change the linked subprojects later while the parent project stays linked.

Arcus saves the link and syncs the active sprints of the linked projects. To unlink a project, click the X on its name and confirm.

Arcus doesn’t create the webhook. Add it in OpenProject with the URL and secret from Arcus. The webhook details appear in Project Settings under Project Management Tool once an OpenProject project is linked.

  1. On the OpenProject card under Project Management Tool, click Copy Webhook URL.

  2. Click Copy Secret. Arcus shows the secret only once. If Regenerate Secret shows instead, click it to create a new secret, then copy it.

  3. In OpenProject, open Administration > API and webhooks and add a webhook. Paste the URL as the payload URL and the secret as the Signature secret. See webhooks in the OpenProject documentation.

  4. Select the events that the Arcus card lists under Events: work_package:created, work_package:updated, work_package_comment:comment, project:created, and project:updated.

  5. Enable the webhook for every OpenProject project linked to Arcus. OpenProject doesn’t include subprojects on its own, so select each linked subproject too.

  6. Save the webhook.

The Test Authoring Agent generates test cases for every story in the sprint in one session.

  1. Open QI Home. Synced sprints appear on the Sprints tab under CURRENT SPRINTS.

  2. Click Generate on the sprint.

  3. (Optional) In the session, click + to attach more context, such as a Figma design or a recording.

The session continues as for any sprint: approve the Generation Plan, generate test cases for the scenarios, then review them. See Generate test cases for the review steps.

Use an Adhoc session to generate test cases for a single work package, such as one story.

  1. Open QI Home and open the Adhoc tab.

  2. Click Add Context and select OpenProject.

  3. Select the work package.

  4. (Optional) Attach more context from any other source.

  5. Click Save.

  6. Enter a prompt.

  7. Click Send.

When you accept a generated test case, Arcus links it to the work package it was generated from.

To link a work package manually, open the test case. Under REQUIREMENTS in the right panel, click Link OpenProject Work Package, then search for the work package by title or ID and select it. To unlink one, click the close icon on its chip.

Log a defect from a test run with the Report a defect sheet. The sheet works the same way for every tracker. Only the fields that say where the issue goes, and the OpenProject fields under More OpenProject fields, differ. For the full procedure, including how to link an existing work package and how to report a defect from an automated run, see Defects.

  1. In the left navigation, open Test Runs, then open a test run.

  2. Open the test case and click Add a Defect, or click the defect icon on the test case’s row in an automated run. The Report a defect against sheet opens.

  3. In Tracker, select OpenProject.

  4. Select the Project and the Type. Arcus selects the last ones you used, or the first linked project and the defect type set for the link.

  5. Check the Subject and the Description, which Arcus writes from the test case. Enter any field the type requires.

  6. (Optional) Set the Assignee. It lists only people the OpenProject project lets you assign. To assign a defect to someone, add them as a project member in OpenProject first.

  7. (Optional) Fill in More OpenProject fields: Status and any optional field the type allows, such as version, category, dates, and custom fields.

  8. Click Create defect. Arcus creates the work package in OpenProject and lists it under the test case’s Reported Defects.

To link a work package that already exists instead, click Link existing at the top of the sheet, search by title or ID, pick the work packages, and click Link defect.

Was this page helpful?