> For the complete documentation index, see [llms.txt](https://releaseowl.gitbook.io/releaseowl-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://releaseowl.gitbook.io/releaseowl-docs/releaseowl-user-guide/sap-integration-suite/working-with-user-stories.md).

# Working with User Stories

User Stories allow you to group and manage artifacts that are deployed together through a [Release Pipeline](https://releaseowl.gitbook.io/releaseowl-docs/releaseowl-user-guide/working-with-release-pipelines/use-cases/automated-cpi-deployments). You can associate artifacts from different SAP Integration Suite services, such as Cloud Integration (CPI), Integration Advisor, API Management, and B2B Scenarios, with a single User Story.

### Creating a User Story

1. Navigate to **Change Management** and click on **User Stories**.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2Fo9Q7C4Myh0PL5ZOs3lQq%2Fimage.png?alt=media&amp;token=179bf6da-60cb-4cd0-8f32-672360cc9f13" alt=""><figcaption></figcaption></figure>

2. Click **Create New User Story**.
3. Enter the required details in the user story creation form.
4. Click **Create** to save the user story.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2FwBqPNZquJFIuPxRlmENL%2Fimage.png?alt=media&amp;token=035c4c23-c35b-40b9-b341-13ac48f5e7f8" alt=""><figcaption></figcaption></figure>

5. Click the **Actions** button and select **Edit**.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2FfvnH7eWP7hl9Dirx9mkG%2Fimage.png?alt=media&amp;token=38244217-6369-4329-8456-5efd490f921a" alt=""><figcaption></figcaption></figure>

### CPI Artifacts

Use this tab to add SAP Cloud Integration (CPI) artifacts to the User Story.

#### Adding CPI Artifacts

1. Open the required User Story.
2. Select the **CPI Artifacts** tab.
3. Click **Add**.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2FSidSvs7CduH10U1fsJpy%2Fimage.png?alt=media&amp;token=c3b85fa8-07bb-46d9-83a6-0f5c1d99d667" alt=""><figcaption></figcaption></figure>

4. Select the required CPI artifacts.
5. Click **OK** to add the selected CPI Artifacts to the User Story.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2FriuCsZnho6Q2xACmFUfQ%2Fimage.png?alt=media&amp;token=84e83044-bc7f-4103-9a7c-636ea09b6098" alt=""><figcaption></figcaption></figure>

### Integration Advisor Artifacts

Use this tab to associate **Integration Advisor** artifacts with the User Story. These artifacts are promoted through the Release Pipeline along with other integration artifacts.

#### Adding Integration Advisor Artifacts

1. Open the required User Story.
2. Select the **Integration Advisor Artifacts** tab.
3. Click **Add**.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2FndV1VrfqnB9NsSA05eN2%2Fimage.png?alt=media&amp;token=2a6eb644-1544-4f59-9e7e-f26fdc3a785f" alt=""><figcaption></figcaption></figure>

4. From the **Artifact Type** dropdown, select the required artifact type:
   * **MAGs**
   * **MIGs**
5. Select the required artifacts from the available list.
6. The selected artifacts are displayed in the **Selected Artifacts** section.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2FFRO3uD7d1i5ARRH3fZMu%2Fimage.png?alt=media&amp;token=1198a22c-91eb-4301-b480-e5fdcaf31e50" alt=""><figcaption></figcaption></figure>

7. Click **OK** to add the selected Integration Advisor Artifacts to the User Story.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2FrjGBLAdnZknpuz2f22tq%2Fimage.png?alt=media&amp;token=01aaea3b-23f6-4010-93fb-89764a160ee1" alt=""><figcaption></figcaption></figure>

### API Management Artifacts

Use this tab to associate **API Management** artifacts with the User Story. The selected API Management artifacts are deployed through the configured Release Pipeline.

#### Adding API Management Artifacts

1. Open the required User Story.
2. Select the **API Management Artifacts** tab.
3. Click **Add**.
4. From the **Artifact Type** dropdown, select the required artifact type:
   * **API Proxies**
   * **API Providers**
   * **Key Value Maps**
   * **Products**
5. Select the required artifacts from the available list.
6. The selected artifacts are displayed in the **Selected Artifacts** section.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2FfpN1sEB7taoo6Ya5lYtR%2Fimage.png?alt=media&amp;token=da084128-8f28-40b8-8509-26795cf63584" alt=""><figcaption></figcaption></figure>

7. Click **OK** to add the selected API Management artifacts to the User Story.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2FUsPkw7GDBjzYWBkDDUTK%2Fimage.png?alt=media&amp;token=a7926e46-2e42-40fa-b1e5-5b436916826a" alt=""><figcaption></figcaption></figure>

### B2B Scenarios Artifacts

Use this tab to add the agreements/partner directory configuration with the User Story. The selected artifacts are deployed through the configured Release Pipeline.

#### Adding  Artifacts

1. Open the required User Story.
2. Select the **B2B Scenarios** tab.
3. Click **Add**.
4. From the **Artifact Type** dropdown, select the required artifact type:
   * **Agreements**
   * **Partner Directory Configuration**
5. Select the required artifacts from the available list.
6. The selected artifacts are displayed in the **Selected Artifacts** section.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2F1Nw4BUFaYTN82HgHDo9c%2Fimage.png?alt=media&amp;token=e152d049-e09e-4f15-ad7b-bcca77d3c90f" alt=""><figcaption></figcaption></figure>

Click **OK** to add the selected B2B Scenarios to the User Story.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2F6ADPVJP3z4cMPylIfTPJ%2Fimage.png?alt=media&amp;token=1d38fed7-db5d-4d14-9476-1a6d5614ed22" alt=""><figcaption></figcaption></figure>

### Attachments

The **Attachments** section allows you to add supporting files or external links to the User Story.

* Click **Browse File**.
* Upload the required file or provide the external link.
* Click **Upload File** to attach the file or link to the User Story.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2F3NbjnGtSwTKIuK1J6AfN%2Fimage.png?alt=media&amp;token=a5bceebd-4535-4e53-87d4-c2669f30be67" alt=""><figcaption></figcaption></figure>

### Import Settings- CPI

1. Click the **three-dot (More Actions)** menu.
2. Select **Import Settings**.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2FaWcAKbb7ORhVgB6oYwlC%2Fimage.png?alt=media&amp;token=572f86be-c773-4831-b2e9-2670bb8a5b7b" alt=""><figcaption></figcaption></figure>

3. A pop-up message will appear, where you can enable the **Force Deploy** option. Click **Save** to apply the changes.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2Fk7CFKEmaaa6mvgQgJHwa%2Fimage.png?alt=media&amp;token=786170a0-e901-4197-ac13-51e857670ac1" alt=""><figcaption></figcaption></figure>

### Import Settings- Integration Advisor

1. Click the **three-dot (More Actions)** menu.
2. Select **Import Settings**.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2FHjoQg2ngimONx1DceVtS%2Fimage.png?alt=media&amp;token=7c01fba1-ad64-4cb4-a994-cdaabda8f5d3" alt=""><figcaption></figcaption></figure>

3. A pop-up message will appear, where you can enable the **Force Deploy** option. Click **Save** to apply the changes.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2Fg3N0o5wfXt0MstklxwAS%2Fimage.png?alt=media&amp;token=375270a5-d627-4f42-8718-657eae17070b" alt=""><figcaption></figcaption></figure>

### Import Settings- API

1. Click the **three-dot (More Actions)** menu.
2. Select **Import Settings**.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2FtSNtT9Ko6M4w0hMdoNta%2Fimage.png?alt=media&amp;token=aa1e1e09-31bd-40f9-8591-873972aeb4b8" alt=""><figcaption></figcaption></figure>

3. A pop-up message will appear, where you can enable the **Force Deploy** option. Click **Save** to apply the changes.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2F6VmNg1Dt0c9QzAZQPAhq%2Fimage.png?alt=media&amp;token=2b7869e5-01a1-4bfd-aae6-fc1974fcbc71" alt=""><figcaption></figcaption></figure>

### Import Settings- B2B Scenarios&#x20;

1. Click the **three-dot (More Actions)** menu.
2. Select **Import Settings**.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2FlDG4iISJbJw8hmhXMtbt%2Fimage.png?alt=media&amp;token=306e42be-890b-40e3-b094-bb0c1cb81e84" alt=""><figcaption></figcaption></figure>

3. **Agreements:** A pop-up window appears where you can enable the **Force Deploy** option and configure the **Import Options** according to the target environment. Click **Save** to apply the configured settings.

   **Partner Directory Configuration:** A pop-up window appears where you can enable the **Force Deploy** option. Configure Import Options are not available for Partner Directory Configuration. Click **Save** to apply the configured settings.

<div><figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2FRA2bSNFEmjH8Mkmks79q%2Fimage.png?alt=media&amp;token=c03576f4-cfa4-4049-b458-61770329bc6c" alt=""><figcaption></figcaption></figure> <figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2FmWEK3PWHxKUuh4fbVcZ3%2Fimage.png?alt=media&amp;token=d8fe46b5-1cab-4f4f-8889-80b62d754023" alt=""><figcaption></figcaption></figure></div>

{% hint style="info" %}
Note : **Force Deploy** — lets you redeploy the artifacts/agreements again even if it was already deployed.

* When *Force Deploy* is enabled, version validation checks do not block the deployment.
* If the target environment version is higher than the source environment version, a warning message is displayed.
  {% endhint %}

### Deployment -CPI

1. Click **Promote** to start the deployment process.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2FcGQFSUzMRTQp2VMNz4qC%2Fimage.png?alt=media&amp;token=5feed897-4a2b-44f5-8285-168c0c9be1b4" alt=""><figcaption></figcaption></figure>

2. If the Release Pipeline includes a **Deployment** task, monitor the deployment status of the User Story.
3. Click **Deploy Logs** to view the deployment details.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2FJIWQ2DqOdQtHmjW8Dqoq%2Fimage.png?alt=media&amp;token=dd8c4809-6e27-44db-aa6b-39004c866e5a" alt=""><figcaption></figcaption></figure>

4. The deployment details are displayed in the **SAP CPI Deploy Logs** window with the following columns:

* **Upload Status** – Indicates whether the artifact was successfully uploaded.
* **Config Status** – Confirms whether the configuration for new or updated artifacts was completed successfully.
* **Deploy Status** – Reflects the final deployment status of the artifact.
* **Already Deployed** – Indicates that the artifact was previously deployed, either during a retry operation or through manual completion. This status helps avoid duplicate deployments and provides clarity during re-runs.
* **Manual Completion** – If a deployment fails or times out, users can use the Manual Completion option in ReleaseOwl to resolve the issue manually and continue the pipeline execution. Selecting **Mark as Complete** indicates that the artifact has been manually completed in the target environment. ReleaseOwl records the deployment as completed and continues the pipeline execution.
* **Refresh Button** – Fetches the CPI runtime artifact deployment status and updates the runtime status in the deployment log.
* **Icon in Artifact Name** - An icon is displayed in the Deployment Logs section next to the artifact name to indicate that **Force Deployment** was applied.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2FFMOo9tysGZtJmyzjI4eU%2Fimage.png?alt=media&amp;token=299eb0c1-18db-4e95-8c57-6e0a8fe5ab12" alt=""><figcaption></figcaption></figure>

### **Deployment-Integration Advisor**

The deployment details are displayed in the **SAP Integration Advisor Deploy Logs** window with the following columns:

* **Integration Artifact Name** – Displays the name of the Integration Advisor artifact selected for deployment.
* **Version** – Indicates the version of the Integration Advisor artifact being deployed.
* **Deploy Status** – Reflects the current deployment status of the Integration Advisor artifact.
* **Icon in Artifact Name** - An icon is displayed in the Deployment Logs section next to the artifact name to indicate that **Force Deployment** was applied.
* **Info** – Displays additional information about the deployed artifact.
  * **For MAG :** Displays the **Message Type** details and **Administrative Data**.
  * **For MIG :** Displays the **Source MIG**, **Target MIG**, and **Administrative Data**.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2FdTFTfDogxcI0sjtldJc8%2Fimage.png?alt=media&amp;token=002ad10b-9c36-4385-a631-2aa89ac84234" alt=""><figcaption></figcaption></figure>

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2FqWM4kqviiBzJs1ma1I9S%2Fimage.png?alt=media&amp;token=3cc71644-867f-4147-970b-d2021c352598" alt=""><figcaption></figcaption></figure>

* **Already Deployed** – Indicates that the artifact was previously deployed, either during a retry operation or through manual completion. This status helps avoid duplicate deployments and provides clarity during deployment re-runs.
* **Manual Completion** – If a deployment fails or times out, users can use the **Manual Completion** option in ReleaseOwl to manually update the deployment status and continue the pipeline execution. Selecting **Mark as Complete** indicates that the artifact has been manually completed in the target environment. ReleaseOwl records the deployment as completed and continues the pipeline execution.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2FKLBCIX16d2osljaAiX0X%2Fimage.png?alt=media&amp;token=f3d0a6b8-be7d-4869-9f9f-caeee3339022" alt=""><figcaption></figcaption></figure>

### **Deployment-API Management**

The deployment details are displayed in the **API Management** window with the following columns:

* **Version** – Indicates the version of the API Management artifact being deployed.
* **Deploy Status** – Reflects the current deployment status of the API Management artifact.
* **Icon in Artifact Name** - An icon is displayed in the Deployment Logs section next to the artifact name to indicate that **Force Deployment** was applied.
* **Already Deployed** – Indicates that the artifact was previously deployed, either during a retry operation or through manual completion. This status helps avoid duplicate deployments and provides clarity during re-runs.
* **Manual Completion** – If a deployment fails or times out, users can use the Manual Completion option in ReleaseOwl to resolve the issue manually and continue the pipeline execution. Selecting **Mark as Complete** indicates that the artifact has been manually completed in the target environment. ReleaseOwl records the deployment as completed and continues the pipeline execution.
* **Refresh Button** – Fetches the CPI runtime artifact deployment status and updates the runtime status in the deployment log.
* **User Story -** Displays the ID of the User Story associated with the deployment.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2F8SDYlfKCnNWslpI20Gws%2Fimage.png?alt=media&amp;token=c8c4c1c1-cbef-4da6-8b9c-ce93dd3019f8" alt=""><figcaption></figcaption></figure>

### **Deployment-B2B Scenarios**&#x20;

The deployment details are displayed in the **B2B Scenarios Deploy Logs** window with the following columns:

* **Artifact Name** – Displays the name of the B2B scenario artifact being deployed.
* **Type** – Indicates the type of B2B scenario artifact, such as **Agreements** or **Partner Directory Configuration**.
* **Version** – Displays the version of the artifact being deployed.
* **Import Status** – Indicates the import status of the artifact in the target tenant. Click the **Import Status** icon to view the corresponding **deployment logs** and review the details of the import operation.

<div><figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2FwqJMqtlJPOkzQotb0WoU%2Fimage.png?alt=media&amp;token=a8a67f05-6e28-46f8-bbdc-5211c1b2a72e" alt=""><figcaption></figcaption></figure> <figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2FMjPwYPRdm2ifvkn4VNta%2Fimage.png?alt=media&amp;token=60d9132f-eac6-42c3-94e1-1f99e8abc5c2" alt=""><figcaption></figcaption></figure></div>

* **Activate Agreement Status** – Indicates the activation status of the Agreement in the target environment. This field is applicable only to **Agreement** artifacts. For **Partner Directory Configuration** artifacts, the value is displayed as **N/A**.

<div><figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2FUlsM0NpsQhnk1GY5CTXV%2Fimage.png?alt=media&amp;token=850d874c-07d2-421d-a4e4-72899c6384ca" alt=""><figcaption></figcaption></figure> <figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2Fxy9CetaVCFcYpLXqYDqh%2Fimage.png?alt=media&amp;token=bcedabf1-773f-4727-b03c-b0a761dbfbf3" alt=""><figcaption></figcaption></figure></div>

* **Deployment Time** – Displays the date and time when the deployment was completed.
* **Already Deployed** – Indicates that the artifact was previously deployed, either during a retry operation or through manual completion. This status helps avoid duplicate deployments and provides clarity during deployment re-runs.
* **Manual Completion** – If a deployment fails or times out, use the **Manual Completion** option to manually mark the deployment as completed and continue the pipeline execution.

{% hint style="info" %}
**Note:** Selecting **Mark as Complete** indicates that the artifact has been manually completed in the target environment. ReleaseOwl records the deployment as completed and continues the pipeline execution.
{% endhint %}

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2FvxwTi7M5KOY6OPIvfPvX%2Fimage.png?alt=media&amp;token=b6103922-673d-4fc1-9deb-be8819c5b0f8" alt=""><figcaption></figcaption></figure>
