---
title: "Manual Steps Library"
canonical: "https://docs.getxray.app/space/XRAYCLOUD/723648516/Manual%20Steps%20Library"
format: markdown
---
![image](media://cfe436cc-b842-4659-9fa4-26415f1673cc)

> Macro (rw-ui-expands-macro)
> 
> > Macro (rw-expand)
> 
> > Macro (toc)

# Introduction

## Overview

The Manual Steps Library (MSL) provides a centralized repository of reusable **Manual ****[Test Steps](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44565316)** that can be referenced across Manual Test cases in Xray.

Its main goals are to:

- Allow users to save time writing Manual Tests by using pre-existing Manual Steps.
- Promote consistency and standardization in Manual Test authoring.
- Reduce duplication of similar Manual Steps across projects.

Manual Steps represent **human‑executed actions** and are written in clear, instructional language, as opposed to automated or [BDD steps](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44577261).

> ⚠️ - The MSL works only with **Test** Work Type items and Xray Projects.
> ⚠️ - You can only use MSL with Manual Tests (not available for [Gherkin](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44565320) or Cucumber Tests).

## Test Steps Usage

The number of Steps available (per Jira Space) is limited according to the[ Xray tier](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/393183414) of the user.

| **Standard** | **Advanced** | **Enterprise** |
| --- | --- | --- |
| 10 steps | 100 steps | Unlimited |

You can find this information on the MSL main screen (Figure 1 - 1).

![Figure 1 - Steps](media://70626a55-d0f4-4365-9fb8-bc244fa28e49)

## MSL Best Practices

- Search the library before creating new Steps to avoid duplication.
- Use clear, action‑oriented descriptions for the Steps, while keeping them concise and unambiguous.
- Apply labels (not mandatory) consistently across projects.

# Operations

## Access Management

### Permissions

Access to the Manual Steps Library is governed by Xray and Jira permissions.

Depending on the configuration, you may have permission to:

- View Steps.
- Create, edit, and delete Steps.

Administrators can control these permissions to align with organizational governance.

#### Managing Permissions

> Macro (rw-ui-steps-macro)
> 
> > Macro (rw-step)
> 
> To manage a Space’s permissions regarding MSL, go to the Space you want to work on (Figure 2 - 1) and click the ellipsis icon (Figure 2 - 2) and then *Space Settings* (Figure 2 - 3).
> 
> ![Figure 2 - Settings](media://ca69b1ec-78a3-4ec6-8859-5b30a11ecff8)
> 
> > Macro (rw-step)
> 
> The Space Details screen will open (Figure 3).
> 
> On the left side of the screen, click *Apps* (Figure 3 - 1) and then *Xray Settings* (Figure 3 - 2).
> 
> ![Figure 3 - Settings](media://289d9ab2-cd5e-42d6-9ede-af96bf4d0c9d)
> 
> > Macro (rw-step)
> 
> The Xray Settings screen will open (Figure 4).
> 
> 1. Click Manual Step Library (Figure 4 - 1). Use the search bar/dropdown menu (Figure 4 - 2) to add the groups that can edit the MSL (add/delete Steps, configure labels, etc.).
> 2. Once you’re done, click Save (Figure 4 - 3). You will see a success message, and the permissions will be immediately given.
> 
> ![Figure 4 - Settings](media://74d1ac2f-4702-44ce-a6b5-e5745baae867)

### MSL Enablement

> Macro (rw-ui-steps-macro)
> 
> > Macro (rw-step)
> 
> On your Jira Cloud instance (you must have Admin privilege), click the gear/Admin icon (Figure 5 - 1) and then *Jira apps* (Figure 5 - 2).
> 
> ![Figure 5 - Admin](media://8370243a-817c-4983-a18f-fe8208b12b82)
> 
> > Macro (rw-step)
> 
> A menu will open on the left (Figure 6). There, under *Xray*, click *[Features](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44565845)* (Figure 6 - 1).
> 
> ![Figure 6 - Features](media://874d0087-b0ec-429a-9535-fe0763934693)
> 
> > Macro (rw-step)
> 
> On the *Features* screen (Figure 6), click the *Manual Step Library* toggle (Figure 6 - 2) to enable/disable it.
> 
> Once it’s enabled, you are able to access it.
> 
> ### Access
> 
> > Macro (rw-step)
> 
> On your Jira Cloud instance, enter a Space (Figure 7).
> 
> > Macro (rw-step)
> 
> Access the Space’s board (Figure 7 - 1). 
> 
> On its top menu, click *More* (Figure 7 - 2) and then *[Testing Board](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44574837)* (Figure 7 - 3).
> 
> ![Figure 7 - Board](media://348e2e32-e584-4171-a817-822b207ee251)
> 
> > Macro (rw-step)
> 
> The MSL will open (Figure 8).
> 
> ![Figure 8 - Manual steps](media://3fe73d71-8fd9-4da6-8c3d-bb40e815dffc)
> 
> You can click the hamburger icon (Figure 8 - 1) to access all MSL from all the Testing Board features (Figure 9 - 1).

## Creating Steps

> Macro (rw-ui-steps-macro)
> 
> > Macro (rw-step)
> 
> On the MSL, click *Create new step* (Figure 8 - 1).
> 
> > Macro (rw-step)
> 
> Fill in the fields:
> 
> - *Action* (Figure 9 - 1; mandatory field): a short, descriptive text that clearly identifies the action performed.
> - *Data* (Figure 9 - 2; optional field).
> - *Expected Result* (Figure 9 - 3; optional field).
> - *Labels* (Figure 9 - 4; optional field): labels can be assigned to each Step to facilitate organization and filtering.
> - Attachments (Figure 9 - 5; optional field).
> - Description (Figure 9 - 6; optional field).
> 
> ![Figure 9 - Fields](media://7fc8481a-531f-415b-9e12-60fcda67cfa5)
> 
> > Macro (rw-step)
> 
> Once you’re finished, click *Save new step* (Figure 9 - 7). 
> 
> You will see a confirmation message, and the new step will be immediately added to the Actions list (Figure 10 - 1).
> 
> ![Figure 10 - Step](media://926bc9ce-7fc0-4140-b042-6c5690697bec)

## MSL Main Screen

On the MSL main screen (Figure 10), you can:

- Edit a step by clicking the arrow next to it (Figure 10 - 2). Once you do, you will see the screen depicted in Figure 11. When you edit a step and save it in the MSL, if it’s linked to a Work item, this change will be reflected on the Work item.
- See the Work items that contain the respective Test Step (Figure 10 - 2).
- Check the labels associated with each Step (Figure 10 - 3).
- Expand all Steps, so you can see all of the Steps' fields by clicking *Expand All* (Figure 10 - 4; then click *Collapse* all to hide them).
- Search for Steps (Figure 10 - 5).
- See the list of Steps (Figure 10 - 1) and click the respective arrow to edit the Step’s fields (Figure 11 - 1):
  - Once you’ve finished editing the field(s), click *Save changes* (Figure 11 - 3).
  - You can delete the step by clicking *Delete step* (Figure 11 - 2). A modal will open for you to confirm the operation.
  - If you delete a Step from the MSL that was linked to a Work item, the Step will no longer appear on that Work item.

![Figure 11 - Fields](media://6758f1fb-976b-4bea-96b5-9118cc2e8278)


## Using Manual Steps from the MSL via a Test Work Type Item

Once you’ve added Steps to the MSL, you can import them via Work items (only via **Test** Work Type items and Xray Projects; for Manual Test Type only - Figure 12 - 1).

### Adding Steps

> Macro (rw-ui-steps-macro)
> 
> > Macro (rw-step)
> 
> Go to a Test Work item (Figure 12) and make sure it’s a Manual Test Type (Figure 12 - 1).
> 
> ![Figure 12 - Test](media://8e743347-bf74-4842-942a-9ae4c6c607f3)
> 
> > Macro (rw-step)
> 
> Click *Add Step* (Figure 12 - 2) and then *Import Step* (Figure 12 - 3). A modal will open (Figure 13).
> 
> > Macro (rw-step)
> 
> Here (Figure 13), you can:
> 
> - Use the search bar to find Steps (Figure 13 - 1).
> - Select the already listed Steps from the MSL (Figure 13 - 2).
>   - Click the arrow next to the respective step (Figure 13 - 3) to see all of the Step’s details (the fields from Figure 9).
>   - Click *Expand All* (Figure 13 - 4) to show all of the listed Steps' details (and then *Collapse All* to hide them).
> 
> ![Figure 13 - Modal](media://c6a45ac6-a217-4616-b7fb-0243dcbc2d9c)
> 
> > Macro (rw-step)
> 
> Once you’ve selected the Step(s) you wish to add to your Test, click *Import* (Figure 13 - 5).
> 
> > Macro (rw-step)
> 
> The Step will immediately appear on your Test (Figure 14).
> 
> From here (Figure 14), you can:
> 
> - Drag the Step to reorder it among other Steps (Figure 14 - 1).
> - Edit in dialog, along with other Steps you may or may not have (Figure 14 - 2).
> - Delete, clone, and view the Step in the MSL (Figure 14 - 3). More below.
> 
> ![Figure 14 - Test](media://8b005761-9a18-443d-8647-2816c28f92d6)

### Collapsing Steps

> Macro (rw-ui-steps-macro)
> 
> > Macro (rw-step)
> 
> Hover over a Step and click *Collapse* (Figure 15 - 1).
> 
> ![Figure 15 - Collapse](media://5a1e13a0-d52c-428e-b1b6-7b1a170c8ab8)
> 
> > Macro (rw-step)
> 
> The Step’s details will be hidden, allowing you to only see the Action (Figure 16 - 1).
> 
> ![Figure 16 - Expand](media://2ba10b95-8888-4793-9bc4-ead055b56320)
> 
> > Macro (rw-step)
> 
> Click anywhere on the grey area (Figure 16 - 2) to expand and see all the Step’s information.

### Unlinking a Step from the MSL

> Macro (rw-ui-steps-macro)
> 
> > Macro (rw-step)
> 
> Go to the Test Step you wish to detach from the MSL and click *Unlink step from Library* (Figure 17 - 1).
> 
> ![Figure 17 - Unlink](media://b3c5096b-e384-4e42-895b-003e23e0534b)
> 
> > Macro (rw-step)
> 
> A dialog box will open. Click *Unlink* (Figure 17 - 1) to proceed.
> 
> > Macro (rw-step)
> 
> The Test Step will immediately appear as a regular Step (Figure 18 - 1), no longer with the *Managed on Library *label (Figure 17 - 3), and with different coloring. 
> 
> ![Figure 18 - Link](media://8971616b-77a1-40ce-a0b0-9f5ff260d217)
> 
> > ✅ To link the Step to the MSL again, click *Add to Library* (Figure 18 - 2). You will see a success message, and the Step will go back to look as depicted in Figure 17 - 1.

### Viewing on Library

> Macro (rw-ui-steps-macro)
> 
> > Macro (rw-step)
> 
> Go to the Test Step you wish to open on the MSL and click *View on Library* (Figure 19 - 1).
> 
> ![Figure 19 - View](media://d0799a23-3910-4f8a-befc-ef060667e30f)
> 
> > Macro (rw-step)
> 
> You will be immediately redirected to the MSL (Figure 20).
> 
> ![Figure 20 - Manual steps library](media://cc24af5b-93cb-4db9-a026-8789c44cad47)

### Viewing

> Macro (rw-ui-steps-macro)
> 
> > Macro (rw-step)
> 
> Go to the Test Step you wish to open and click *View* (Figure 21 - 1).
> 
> ![Figure 21 - View](media://4ad6caee-27e8-402b-8ab2-4e098c4e946e)
> 
> > Macro (rw-step)
> 
> A modal will open (Figure 22). 
> 
> There, you can: edit (Figure 22 - 1), create, add, import, and export Steps (Figure 22 - 2). Once you’ve finished, click *Save* (Figure 22 - 3).
> 
> ![Figure 22 - Modal](media://46ff580d-5908-4bed-a6ea-fd536147f20a)
> 
> > ℹ️ While editing the step, if you start typing (Figure 23 - 1), the *Get Suggestions* button will be enabled (Figure 23 - 2).
> > ℹ️ 
> > ℹ️ ![Figure 23 - Suggestions](media://0f71b7d3-864f-494b-b3d1-be6a887ada06)
> > ℹ️ 
> > ℹ️ Once you click the button, a modal will open (Figure 23), allowing you to search for a Step from the MSL to use in the Test (Figure 23 - 3). If you wish to do so, select the Step and then click *Import* (Figure 23 - 4).
> 
> 
> > Macro (rw-step)
> 
> The changes will take immediate effect, and you will be redirected to your Work item (Figure 24).
> 
> ![Figure 24 - Work item](media://2626b10f-641a-46b6-a259-9a0ee449a1dd)

### Cloning a Step

> Macro (rw-ui-steps-macro)
> 
> > Macro (rw-step)
> 
> Go to the Test Step you wish to clone. Click the ellipsis icon (Figure 25 - 1) and then *Clone* (Figure 25 - 2).
> 
> ![Figure 25 - Cloning](media://a83d919b-8dc7-4858-ac2b-b8cd268728ca)
> 
> > Macro (rw-step)
> 
> A modal will open (Figure 26). There, click *Clone* to proceed (Figure 26 - 1).
> 
> ![Figure 26 - Modal](media://5882b995-cd82-4e09-acb4-aae467acd0f8)
> 
> > Macro (rw-step)
> 
> You will see a success message, and the duplicate Step will immediately appear on your Work item (Figure 27 - 1).
> 
> ![Figure 27 - Clone](media://b3a8c5bd-d143-49bb-9eed-7fad95a6d160)

### Moving Steps

> Macro (rw-ui-steps-macro)
> 
> > Macro (rw-step)
> 
> Go to the Test Step you wish to move, click the ellipsis icon (Figure 28 - 1), and then *Move To* (Figure 28 - 2).
> 
> ![Figure 28 - Move](media://b521c99c-bbfe-4c6c-bf50-c49b8f761383)
> 
> > Macro (rw-step)
> 
> A modal will open (Figure 29), prompting you to insert the rank number you want the Step to occupy (Figure 29 - 1).
> 
> ![Figure 29 - Modal](media://3a2d02bd-be55-4d31-a22a-d66c5a558c70)
> 
> > Macro (rw-step)
> 
> Add the rank number (Figure 29 - 1) and click *Move* (Figure 29 - 2).
> 
> > Macro (rw-step)
> 
> You will see a success message, and the Step will be transferred to its new position immediately (Figure 30 - 1).
> 
> ![Figure 30 - Position](media://800a7afd-fcb7-4c6a-bb20-488a7ced9e57)
> 
> > ✅ Alternatively, you can place your cursor over the white dots (Figure 30 - 1) and drag the Step to the desired position.

### Deleting a Step

> Macro (rw-ui-steps-macro)
> 
> > Macro (rw-step)
> 
> Go to the Test Step you wish to remove, click the ellipsis icon (Figure 31 - 1), and then *Delete* (Figure 31 - 2).
> 
> ![Figure 31 - Delete](media://e0981a85-4c4b-482d-9253-389d5cc25d6b)
> 
> > Macro (rw-step)
> 
> A modal will open (Figure 32). Click *Delete* to proceed (Figure 32 - 1).
> 
> ![Figure 32 - Modal](media://63e1e59d-3f76-4270-94ec-d9e989ce10c6)
> 
> > Macro (rw-step)
> 
> You will see a success message, and the Step will be removed from the Work item right away (Figure 33).
> 
> ![Figure 33 - Removed](media://0912d86c-a529-46be-8d5f-38bf3172f933)

> Macro (rw-ui-expands-macro)
> 
> > Macro (rw-expand)
> 
> If you have questions or technical issues, please [contact the Support team via the Customer Portal (Jira service management)](https://jira.getxray.app/servicedesk/customer/portal/2/user/login?destination=portal%2F2%2Fcreate%2F28) or [send us a message using the in-app chat](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44577312).