# User Stories

### Creating User Stories With ALM Integration

To  Sync user stories using an ALM integration (e.g., JIRA), follow these steps:

1\) Navigate to the **User Stories** section under **Change Management**.

2\) Click the **Sync User Stories** option from the User Stories screen. The user stories from the external system will be synced and displayed in the **User Stories** screen.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2FW0AATVONxiaqJULut2FO%2Fimage.png?alt=media&#x26;token=81a246f0-8bb4-4dd4-a49e-4c2423836d0c" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
&#x20;**Note:** Clicking **Sync User Stories** will synchronize records of all issue types from the externally integrated ALM project into ReleaseOwl.

a) If the project you are working on is associated with an external system (e.g., JIRA), any user stories from that system will appear in the **User Stories** screen after syncing.

b) Always ensure to **sync the Sprints first** before syncing the User Stories.
{% endhint %}

3\) Click **OK**. The user stories created in the external system will be synced to ReleaseOwl and will appear on the **User Stories** screen.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2Fwc5FkrejDubjFOe9mtRp%2Fimage.png?alt=media&#x26;token=e7bc76c8-2740-4596-814a-6dc484485e60" alt=""><figcaption></figcaption></figure>

4\) To view previously performed sync actions, click on **Sync History**.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2FKzBN4OgaMK9mlYYnS4ud%2Fimage.png?alt=media&#x26;token=49d7947f-3f76-4cc0-b2c3-4b401f9891f2" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
**Note :**  The column widths for **User Story ID**, **Status**, **Type**, and **Assigned To** are now dynamically adjusted based on content length. The **Summary** and **Pipeline Status** columns are restricted to a maximum width of **20%** of the table to maintain layout consistency and prevent overflow.
{% endhint %}

### Creating User Stories Without ALM Integration

To create user stories manually for systems not integrated through ALM , follow these steps:

1\) To create a new user story manually, click the **Create New User Story** button.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2Fz3aaPFRbKNsAqs1xGc1P%2Fimage.png?alt=media&#x26;token=a67a99ba-ca66-441d-8eef-731969816543" alt=""><figcaption></figcaption></figure>

2\) Enter the following details and click **Save**:

| **Field**           | **Description**                                                                                                                                                               |
| ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Summary**         | A summary of the user story being created.                                                                                                                                    |
| **Description**     | A detailed description of the user story being created.                                                                                                                       |
| **Type**            | Default type is **Story**. Available issue types: **Story**, **Task**, **Sub-task**, **Bug**, **Issue**, **Epic**, **Incident**. Any issue type can be created in ReleaseOwl. |
| **Assigned To**     | Select the user to whom the user story is to be assigned.                                                                                                                     |
| **Sprint**          | The sprint in which the user story will be handled.                                                                                                                           |
| **Release Version** | The version of the release in which the user story will get released.                                                                                                         |

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2FMayVWM9E4teKYWjE4Z5t%2Fimage.png?alt=media&#x26;token=695f75a5-4f4c-4955-b8c2-d658360e5c03" alt=""><figcaption></figcaption></figure>

3\) The user story gets created and gets listed in the **User Story** grid.

4\) You can delete user stories by clicking the **Delete** button.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2FvFTx8pbgZa88hnofSNwG%2Fimage.png?alt=media&#x26;token=f209ee45-6df7-41aa-aa4e-74139b4fa3c0" alt=""><figcaption></figcaption></figure>

5\) The following columns are seen for a user story:

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2FvzOY6XAZtqIpiSJWMdiQ%2Fimage.png?alt=media&#x26;token=529d64c2-3dab-448b-a2a4-7d27c9ff1b76" alt=""><figcaption></figcaption></figure>

| **Field**                    | **Description**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| ---------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **User Story**               | Represents the user story being tracked.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| **User Story ID**            | Unique identifier for the user story.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| **Summary**                  | A brief description of the user story.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| **Status**                   | Current status of the user story. **Status options**: To Do, In Progress, QA Ready, Prod Ready, Done                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| **Type**                     | Issue type of the user story. Available types: **Story**, **Task**, **Sub-task**, **Bug**, **Issue**, **Epic**, **Incident**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| **External ID**              | ID of the user story from an external system shown if the project is integrated with external systems.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| **Assigned To**              | The user to whom the issue type is assigned.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| **Validation Status Filter** | <p>The <strong>Validation Status</strong> shows the current stage of the user story validation process. The possible statuses are:</p><ul><li><strong>Not Validated</strong>: Validation has not yet started for this user story.</li><li><strong>Started</strong>: The validation process has been initiated.</li><li><strong>In Progress</strong>: Validation is actively running and not yet completed.</li><li><strong>Success</strong>: Validation is completed successfully without any errors.</li><li><strong>Review Pending</strong>: Validation is completed, but the results are awaiting manual review.</li><li><strong>Review Completed</strong>: The validation review has been completed and closed.</li></ul> |
| **Pipeline Stage**           | Default value is **Dev**. Updates to the next stage upon each promotion in the release pipeline.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| **Pipeline Status**          | Status of the release pipeline execution.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| **Actions**                  | <p>Actions available for the user story: <strong>Edit</strong>, <strong>Validate</strong>, <strong>Validation Report</strong>, <strong>Promote</strong>, <strong>Pipeline Activity</strong>. </p><p></p><p><em><strong>Note</strong></em><strong>:</strong> Promote not available for MTAR applications.</p>                                                                                                                                                                                                                                                                                                                                                                                                                  |

6\) When you click the **Action** button, you will see the list of available actions that can be performed on the user story.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2F1M3nx48EDluDhSSjn1Xa%2Fimage.png?alt=media&#x26;token=4b10c05d-c075-422b-958c-8974a77d8157" alt=""><figcaption></figcaption></figure>

#### **2. User Story Tab**

This is the primary section for entering and managing story information.

**a. Core Fields**

| Field                | Description                                                                                                            |
| -------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| **Summary**          | A short title summarizing the purpose of the user story.                                                               |
| **Description**      | Provides detailed context or requirements for the story (optional).                                                    |
| **Type**             | Identifies the work item type.                                                                                         |
| **Assigned To**      | The user responsible for implementing this story.                                                                      |
| **Status**           | Current state of the story (*Open*, *In Progress*, *Done*).                                                            |
| **No Artifacts**     | When enabled, all artifacts associated with the User Story are **automatically deleted** to maintain data consistency. |
| **Release Pipeline** | The release pipeline associated with the story, used for deployment tracking.                                          |
| **Release Version**  | Specifies the release version or build where this story is included.                                                   |
| **Component**        | Refers to the business or technical component impacted (e.g., *TC* for Testing Component).                             |
| **External ID**      | A unique identifier used to map or synchronize the User Story with external systems                                    |

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2FuNXnPsQaQ2Yoxxyiw6dI%2Fimage.png?alt=media&#x26;token=ffd3cd1d-326a-4b12-bb6f-5c832f438ffb" alt=""><figcaption></figcaption></figure>

**b. Actions**

| Action                | Description                                                                                                                                               |
| --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Validate**          | Performs validation to ensure all required details are complete.                                                                                          |
| **Validation Report** | Displays a summary of validation results.                                                                                                                 |
| **Promote**           | Promotes the story to the next stage in the release workflow.                                                                                             |
| **Save**              | Saves all modifications made to the story details.                                                                                                        |
| **Activity Log**      | Displays a chronological list of all actions performed on the story, including status changes, updates, and user actions, allowing for full traceability. |

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2FTfXKSGZmJ3wxnFW20Nrm%2Fimage.png?alt=media&#x26;token=87ed72ea-989c-4895-8b6e-76ab92d559ff" alt=""><figcaption></figcaption></figure>

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2Fmt2rosFH8fa2iDyJnVTg%2Fimage.png?alt=media&#x26;token=ca8a61e1-f481-4530-a284-c535d225159a" alt=""><figcaption></figcaption></figure>

#### **3.  Artifacts Tab**

This tab dynamically updates based on the projects added in the Artifacts section. Only the relevant artifacts associated with those projects will be displayed.

#### **4. Attachments Tab**

Use this tab to upload and manage supporting files and links related to your user story. You can browse for a file, attach it, or add a reference link as needed.

**Details**

* Maximum file size allowed: **10 MB**.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2FeL6NmK02OSLwpIVEe05w%2Fimage.png?alt=media&#x26;token=dcd08c12-dd15-4bca-9b87-7709fba27755" alt=""><figcaption></figcaption></figure>

#### Validation&#x20;

* Navigate to the **User Stories** section.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2F9N7kIPSquPWqvHJAMOcx%2Fimage.png?alt=media&#x26;token=fbba15fe-8544-4c1b-a985-1864208aa692" alt=""><figcaption></figcaption></figure>

* Click on the **Validation** option.
* Navigate back to the **User Story** section.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2FlwnldUuSs7MoGKDqQ5Ai%2Fimage.png?alt=media&#x26;token=de9ed39b-c029-4754-9501-8bdae41e9607" alt=""><figcaption></figcaption></figure>

* A pop-up dialog appears prompting you to select the appropriate **SAP CPI target environment** from the list.
* After selecting the target environment, click the **Validate** button to initiate the validation process.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2FZWqGgYgcXp6cfm65oOcN%2Fimage.png?alt=media&#x26;token=b38d16a5-c31a-45a7-bcfa-769143efce7a" alt=""><figcaption></figcaption></figure>

#### Validation  Report

* Navigate back to the **User Story** section. Click on the **Validation Report** button

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2F55CGygDk0XTIcS4wdzQw%2Fimage.png?alt=media&#x26;token=98af2399-9d5e-44f7-9c58-2284e9666990" alt=""><figcaption></figcaption></figure>

* The system generates the validation report based on the selected environment and displays the results.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2FXFhJD7Bvyppsh1bLtQrJ%2Fimage.png?alt=media&#x26;token=cb1fd11d-0a0b-4fa4-8b16-30bfaa226514" alt=""><figcaption></figcaption></figure>

**Pipeline Activity:**

To view the pipeline activity:

1. Navigate to the **User Story** section.
2. Click on the **Pipeline Activity** button.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2F7XD6VX7xyrZVsIQ1FR00%2Fimage.png?alt=media&#x26;token=20a481a9-dbaf-43cd-9db2-1ff66cb8574b" alt=""><figcaption></figcaption></figure>

3. On clicking **Pipeline Activity**, you can view the **release pipeline execution status**, including the current stage, progress, and overall execution details.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2FMhKgt7YuMkppQza7fFpR%2Fimage.png?alt=media&#x26;token=3a481d11-b6cb-4910-8514-c2ddba0c2a0e" alt=""><figcaption></figcaption></figure>

**Options in Pipeline Activity Screen (Right Panel)**\
The right side of the **Pipeline Activity** screen contains the following options:

* **Abort:**\
  This button allows users to stop a currently running pipeline activity. When clicked, a confirmation popup appears where the user must provide a reason to proceed. Once confirmed, the pipeline status changes to **Aborted** for the respective task.
* When aborting an action, users can also update the status of the associated User Story.

{% hint style="info" %}
**Note:** The **Abort** action **will not** interrupt a deployment that is already in progress. Use this action only when the pipeline is in a **Waiting for Approval** or **Suspended** state.
{% endhint %}

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2F8LRQoWOm0pdC4cJ0J3FB%2Fimage.png?alt=media&#x26;token=1041cbc3-620d-4fa9-9681-ebdf9f179506" alt=""><figcaption></figcaption></figure>

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2FSG3ZhmPkgNEVSr6V3gUR%2Fimage.png?alt=media&#x26;token=29055c02-197b-444c-a13b-59a684ebda33" alt=""><figcaption></figcaption></figure>

* The **Pipeline Stage** and **Pipeline Status** of the related user story are also updated to **Aborted**.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2FWDW1b5lAKvnGHajWhrj0%2Fimage.png?alt=media&#x26;token=3d784d14-11fa-4323-bd2e-acc939eb8d07" alt=""><figcaption></figcaption></figure>

* **History**:&#x20;

This option displays the execution history of the release pipeline, including details such as the number of times the pipeline was executed, who triggered each execution, and the status of each run.&#x20;

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2FZTt5447f697gD9zmez9n%2Fimage.png?alt=media&#x26;token=f559f3d5-deb6-4aff-8325-f23c4f8b206a" alt=""><figcaption></figcaption></figure>

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2FbaBbmfvmus1dzalgRox2%2Fimage.png?alt=media&#x26;token=b78adf33-dcad-40d8-b0c6-d35760ecb7c0" alt=""><figcaption></figcaption></figure>

* When you click on the arrow button (**>**), you are taken to the **Pipeline Activity** screen.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2FA2ohHCSGiSucDrWRTW79%2Fimage.png?alt=media&#x26;token=7046e72c-100a-413c-9725-8d2ca601654d" alt=""><figcaption></figcaption></figure>

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2FcvWb3YfIFRR0bz0PU3xO%2Fimage.png?alt=media&#x26;token=204cbe61-8bb6-4a28-a16a-547e1a9ba076" alt=""><figcaption></figcaption></figure>

**Refresh**:&#x20;

This button allows you to update the **Pipeline Activity** screen with the latest information. When you click on the Refresh button, it reloads the current status of the release pipeline to reflect any recent changes or updates.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2FTYPgtqmH7DphWLcNP3vo%2Fimage.png?alt=media&#x26;token=32628820-5db1-4a6b-88e5-602ba569f628" alt=""><figcaption></figcaption></figure>

#### Dependencies ( Beta)

The **Dependencies (Beta)** feature ensures that **User Stories are executed in the correct sequence during deployments**. This helps prevent **conflicts, execution blockers, and missed dependencies**, resulting in a smoother and more reliable deployment process.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2F5AmwJNaBBGnqAXJKGmo8%2Fimage.png?alt=media&#x26;token=81afa7dd-a799-4fcf-bef4-f0bc4c29ac51" alt=""><figcaption></figcaption></figure>

#### Release Audit Report&#x20;

You have the option to export the details as a **Release Audit Report**. The exported document provides comprehensive information to help track and communicate the progress of the user story.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2FNUocYSe0Q2tmHAW9s4vP%2Fimage.png?alt=media&#x26;token=e342658c-c4b1-4aa4-9dec-0afc74d1d5fb" alt=""><figcaption></figcaption></figure>

The exported PDF provides the following comprehensive information:

1. **Release Summary**
   * A high-level overview of the release associated with the user story.
2. **Stage-by-Stage Deployment Details**
   * Detailed deployment information for each stage of the pipeline.
3. **Code and Artifact Changes Summary**
   * A summary of the changes made to the code and associated artifacts, ensuring clarity on what has been modified.
4. **Traceability Matrix**
   * Links between:
     * Requirements
     * User stories
     * Code changes
     * Deployment stages
   * This ensures end-to-end traceability for audit and review purposes.
5. **Approval and Audit Summary**

   * A comprehensive summary of:

     * Approvals obtained for the user story.
     * Audit trails detailing all actions taken.

   <figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2F4j4m5Z9CsiPbgvITOyBN%2Fimage.png?alt=media&#x26;token=2efc9c4a-2934-4016-89df-8eb47bf324bf" alt=""><figcaption></figcaption></figure>
