Synchronize CPI Artifacts
Prerequisites
Begin by registering your SAP BTP credentials and the corresponding SAP Integration Suite environment within ReleaseOwl.
Navigate to the Projects section and create a new project.
Project Type: Select SAP CPI.
Once the project is created, add the registered environments to the project via Project Settings > Environment.
Click Sync All Artifacts to fetch and display the available CPI artifacts within the selected project.
Navigate to Build > SAP CPI Management and click on the actions button to view Sync Artifacts.
The Modified By and Modified Date information displayed in the ReleaseOwl dashboard is sourced directly from SAP CPI for supported artifact types such as IFLOW, ODATAAPIPROVIDER, SOAPAPIPROVIDER, and RESTAPIPROVIDER.
For artifact types like SCRIPT_COLLECTION, MESSAGE_MAPPING, and VALUE_MAPPING, SAP CPI does not provide these metadata fields via its public APIs.
In such cases, ReleaseOwl derives and updates the Modified By and Modified Date based on ReleaseOwl activity and processing timestamps, reflecting when the artifact was last handled or updated within ReleaseOwl rather than the original CPI metadata.
Synchronize Integration Suite Artifacts
Click Sync Artifacts to fetch various artifacts like IFlows, Value Maps, Packages, Configuration parameters, etc. from the registered SAP CPI environment into ReleaseOwl.
If there are changes made to the existing artifacts, the changes will also be updated.
Click Sync Artifacts to sync the CPI artifacts.
Sync History
With this, you can view the history of all the artifact syncs that have occurred. Click Sync History, to view the CPI sync history of this project.
Sort
You can sort the artifacts as per your convenience. To sort them:
Click the Sort icon.
In the page displayed, choose an option and click OK.
Actions
Multiple actions can be performed on an artifact, based on the type of artifact. These actions include – View Test Cases, Comment , Configure, Deployment History, Versions and Download.
Manage Environment Wide IFlow Configurations
You can maintain configuration parameters for IFlows for each environment separately in ReleaseOwl. These will be updated accordingly during the deployment.
To configure an artifact:
1. Go to the required artifact, click Actions and choose Configure.
2. The following screen is displayed that will show various configuration parameters for the Integration Suite environments that are part of the landscape.
3. No changes can be made to Dev environment.
4. To make changes in any other environment, click the edit icon on the required name and make changes. Click Save.
Artifact Versions
1. To view the versions, go to the required artifact, click Actions and choose Versions.
The following screen is displayed showing the user different versions of the artifact.
Assign User Story option is used to link a specific version of an artifact (such as a configuration or integration flow) to a designated User Story.
On clicking Assign User Story, the system will prompt you to:
Select a User Story from a searchable button.
Associate the current version of the artifact with the selected User Story, establishing a traceable link between the artifact version and the development requirement.
Click Actions and choose either Download or Where Used List based on the requirement.
Creating a Release Pipeline
Release Pipelines in ReleaseOwl manage approvals, validations, deployments, automated tests, task assignments, and user story updates for SAP systems.
1. Create a New Release Pipeline:
Switch to the Project view and select the Release section.
Navigate to Release Pipelines and click on Create New Release Pipeline.
Provide a Pipeline Name.
Add stages (e.g., QA, Prod) and assign tasks to each stage.
2. Add Deployment Tasks:
Click the Add button in a task stage to include deployment tasks.
Fill in the required details:
Name: Enter a preferred name for the deployment task.
Deploy Type: Select the type of deployment.
Select CPI Environment: Select the target CPI environment where the deployment will take place.
Deployment Action: Choose between:
Upload Only: Uploads the deployment package without executing the deployment.
Upload and Deploy: Uploads the deployment package and executes the deployment.
Notify Users: Sends a notification to selected users when the task is created or when pipeline execution reaches this stage
Notify Promotion User: Sends a notification to the user who promoted the artifact or initiated the deployment to this stage.
Notify to Button : It has three options — User, Role, and Custom — to specify the recipients of the notification based on individual users, assigned roles, or custom groups.
User
Sends the notification directly to a specific individual user.
Role
Sends the notification to all users who belong to a specific predefined role (such as Developer, Tester, Release Manager). Every user in the role will receive the notification.
Custom
Sends the notification based on a custom mapping between components and roles. Different components can notify different roles, depending on your configuration.
Save and Configure Notifications:
Add notification emails if needed.
Save the pipeline configuration.
Managing Sprints and User Stories
1. Create a Sprint:
In the Project View, navigate to Change Management and click Create Sprint.
Enter the sprint name and click Save.
Click the three dots (Actions) button and select Start Sprint.
2. Create a User Story:
Go to User Stories and click Create New User Story.
Fill in the required details:
Summary: Provide a summary of the user story.
Type: Select the type of story.
Click Save.
Edit and Promote User Story:
After creating the user story, click the three dots (Actions) and select Edit.
Select the release pipeline and associated component.
Add the artifact in CPI Artifacts and click Save.
Import Settings
The CPI Import Settings dialog, accessible from the User Story Edit View under the CPI Artifacts section, enables users to configure deployment settings for each target CPI environment. It allows selective activation of the Force Deploy option, which permits redeployment of artifact versions when necessary.
Click the “...” next to a CPI artifact and select “CPI Import Settings.”
In the popup, you’ll see a list of available target environments.
Check the Force Deploy box if you want to allow redeployment of CPI artifacts.
Click Save.
Adding Links in the Attachments Section
The Attachments section allows users to add reference links directly to their items for easy access and documentation.
Steps to Add a Link
Navigate to the Attachments section of the desired item.
Click the Link button.
In the dialog box, enter the following details:
Name – Provide a meaningful name for the link.
URL – Enter the complete URL of the reference link.
Click Add to attach the link.
The added link will be listed in the Attachments section and can be viewed by all relevant users
Promotion of User Story
To promote the user story, click the three dots (Actions) and select Promote.
You can view the Deploy Logs under the SAP CPI Deploy Logs window after promoting the user story.
Upload Status: Indicates whether the artifact was successfully uploaded.
Config Status: Confirms if the configuration for new or updated artifacts was successful.
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, configuration, or upload fails or times out, users can use the Manual Completion option to resolve the issue manually and continue the pipeline execution.
Refresh Button Fetches the CPI runtime artifact deployment status and updates the runtime status in the deployment log.
Retry Button Allows you to reattempt a failed deployment or pipeline stage.
Status Button If the status is shown as "Suspended", it usually indicates that the pipeline or task has been paused or is awaiting a manual action.
Last updated