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

Step groups

A step group is a set of steps you write once and add to many test cases, such as signing in or searching from the home page. Each test case calls the group instead of holding its own copy, so you fix the steps in one place.

A step group has its own manual steps and its own automated steps. You add it to a test case’s manual steps from Details, and to its automated steps from Automated steps.

A step group’s manual steps come in the same two formats as a test case’s:

  • Steps: a table of numbered steps, each with an expected result. Add it to test cases that use the Steps template.
  • Documentation: two text areas, Steps and Expected Results. Add it to test cases that use the Documentation template.

You pick the format when you create the group. A step group goes only into test cases and step groups of the same format, and the format locks once the group is in use. See Change a step group’s format.

  1. Open Step Groups in the left navigation and click Create Step Group. The New step group drawer opens.

  2. In Name, enter a title that says what the steps do. Names are unique in a project. If the name is already taken, an error says the step group title already exists.

  3. In Template type, keep Steps or select Documentation.

  4. Write the steps:

    • With Steps, enter the first step under Steps and what should happen under Expected results. Click Add Step, or press ⌘+↵, for each further step. To include another step group, click Add Step Group.

      The New step group drawer in the Steps format, with Template type, the steps table, Add Step, and Add Step Group outlined

    • With Documentation, write the steps in Steps and what should happen in Expected Results. To include another step group, type /step-group on its own line. See Nest a step group.

    The New step group drawer, with Name, Template type set to Documentation, the Steps and Expected Results areas, and Create step group outlined

  5. Click Create step group.

Arcus saves the group to Step Groups and gives it an ID made of the project key, SG, and a number. The group opens with a Steps tab and an Automated steps tab. On the right, WORKFLOW shows its Template Type, ATTACHMENTS holds files you add with Upload Attachments, such as a test data sheet, and LINKED TEST CASES lists the test cases that use it, or reads “No cases have been linked”.

Changes to a step group save as you make them.

To leave the drawer without saving, click Cancel. If you’ve started writing, Arcus asks “Discard this new step group?”. Click Discard to close it, or Keep editing to go back.

A step group’s automated steps run wherever the group is called from a test case’s automated steps.

  1. Open the step group and select Automated steps.
  2. Click Write the script manually, or Author with Copilot to record the steps in a browser. See Write automated steps.
  3. Under READS AS, click “no sentence yet” and enter the sentence test cases show for the group when they call it.
  4. (Optional) Under INPUTS, click + input name and add each value a test case should pass in.
  5. Write the steps, as on a test case’s Automated steps tab. To use an input in a step, type its name in braces.

A step group's Automated steps tab, with INPUTS and READS AS outlined above the steps.

  1. Open the test case on the Details tab. Under WORKFLOW, Template Type must read Steps.

  2. Below the steps, click Add Step Group. The Add Step Group drawer opens with the project’s step groups in that format.

  3. Enter part of the name in Search Step Groups to narrow the list. Expand a group to preview its Steps and Expected Results.

  4. Click Add on the group.

The test case shows the group as a row with its name. Expand it to see the group’s steps. Click the open icon to open the group in a new tab.

If the project has no step groups in that format yet, the drawer reads “No step groups yet.” Create one from Step Groups first.

To turn steps the test case already has into a step group, click Create Step Group beside Add Step Group. In Select Steps for Step Group, enter a title, select two or more steps in a row, and click Create and Replace. Arcus creates the group with those steps and puts the group in their place in the test case.

  1. Open the test case on the Details tab. Under WORKFLOW, Template Type must read Documentation.

  2. In Steps, put the cursor on its own line where the group belongs and type /. Select Step Group under Step Groups, or keep typing /step-group.

    A Documentation test case's Steps area, with /step-group typed and the Step Group option in the menu outlined

  3. In the Add Step Group drawer, find the group, expand it to preview its steps, and click Add.

    The Add Step Group drawer, with Search Step Groups, a group expanded to preview its Steps and Expected Results, and Add outlined

The group appears in the text as a collapsible row with its name. Expand it to read its steps, or click the open icon to open the group. The row always shows the group’s current steps, so editing the group updates every test case that holds it.

A Documentation test case's Steps area, with a placed step group expanded to show the step group inside it, and the open icon outlined

If you restore an older version of a test case that holds a group deleted since, the group’s row reads “This step group no longer exists.” Remove the row and add another group.

  1. Open the test case and select Automated steps.

  2. In an empty step row, type / and select Step group. The row lists the project’s step groups.

    The step group list in a step row, with Search stays for two guests in a city outlined.

  3. Select the group and press Enter.

The row reads Step Group followed by the group’s READS AS sentence. Click the arrow beside the row number to see the group’s steps, or the link icon to open the group.

A test case calling the step group, with the Step Group row outlined and its three steps below.

Click the row to see its Step settings: the STEP GROUP, the values passed under ARGUMENTS, and READS AS. A group without inputs reads “This group takes no inputs.”

Step settings for a step group call, with STEP GROUP, ARGUMENTS, and READS AS.

For the other blocks, see Blocks and conditions.

A step group can hold other step groups, one level deep. An outer group can hold inner groups, but an inner group can’t hold groups of its own.

Add a group to a step group the same way as to a test case: click Add Step Group in a Steps group, or type /step-group in a Documentation group. The Add Step Group drawer lists only groups in the same format. A group that already holds step groups shows “This step group has step groups of its own, so it can’t go inside another step group.”, and its Add is unavailable. The drawer’s footer reads “A step group can hold one level of step groups.”

The Add Step Group drawer, with a group that holds its own step groups and its message outlined

Once a group is inside another group, you can’t add step groups to it. When you click Add Step Group in that group, the drawer reads “This step group is inside another step group, so it can’t hold step groups.”

Open the step group and, under WORKFLOW, change Template Type between Steps and Documentation. Switching removes what the group holds. Going to Documentation removes the step rows. Going to Steps removes the Steps and Expected Results text, its files, and any step groups placed in it. If the group has content, Arcus asks first. Click Switch to Documentation or Switch to Steps to go ahead.

A step group that’s used by a test case or another step group keeps its format. Template Type is unavailable and reads “This step group is used in test cases or other step groups, so its type can’t be changed.” To change it, remove the group from everything that uses it first. LINKED TEST CASES lists where it’s used.

A step group that holds another step group, with Template Type unavailable and its message, the nested group, and LINKED TEST CASES outlined

Step Groups lists each group with its NAME and USED BY, the number of test cases that use it. Click Search Step Groups, or press ⌘+F, to search.

  • Import opens the Step Groups tab of Project Settings > Import, where you upload a .csv file. See Import step groups.
  • Export opens Export step groups with the number of step groups in the project. Click Export (n) to export them all as an Excel (.xlsx) file. To export only some, tick their rows and click Export in the bar that appears.

The file has one sheet, Step Groups, with the columns ID, Title, Description, Labels, Step Description, and Step Expected Result. Arcus builds the file in the background and emails you a download link. Click Go to Exports to open Project Settings > Export, where the file is also listed.

Click the ellipsis icon (⋯) on a step group’s row for Edit, Clone, or Delete. To delete several at once, tick their rows and click Delete Selected in the bar that appears.

  1. Click Clone. The title reads the group’s name followed by “(Clone)”.
  2. Change the Title.
  3. (Optional) In Target Project, select another project to clone the group into.
  4. Click Clone.

The Clone Step Group dialog, with Target Project outlined.

The clone is a separate group with its own ID. Test cases that use the original keep using it.

Click Edit, or click the group’s name, and change it. Every test case that uses the group shows the changed steps, and every test case that calls it runs the changed automated steps.

You can delete a step group only when nothing uses it. Arcus deletes it permanently.

  1. Click Delete.

  2. If the group is in use, the Deletion Warning reads “This step group is currently in use. To delete it, you must first remove it from the linked entities below.” and lists the test cases and step groups under Linked Entities. Click each one to open it, and remove the group from it. Then click Close and start again.

    The Deletion Warning, with the test case that uses the group outlined under Linked Entities

  3. In Delete step group?, select “Confirm deletion; this action is permanent and cannot be undone.”

  4. Click Delete Step Group.

Was this page helpful?