Cloud Environment Registration
CPI Environment Registration
Navigate to Environments from the Administration menu.
Select CPI environment and click on register CPI environment.
Provide the following details:
Field
Description
Name
Enter a unique name for the SAP CPI Environment.
Auth Type
Select the authentication type: Basic Auth or OAuth2.
API URL
Provide the API URL for connecting to the SAP CPI Environment.
Enable Test Automation (Optional)
Toggle to enable or disable test automation capabilities.
IFLOW OAuth Credential
Select the OAuth credentials used for IFLOW authentication.
IFLOW URL
Enter the IFLOW URL from the service key.
Use Custom IdP
Enable this option to set up a custom Identity Provider (IdP). Note: The setup process is outlined in the section below.
SSO URL
Provide the Single Sign-On (SSO) URL for authentication. Note: The setup process is outlined in the section below.
IDP Auth Email Address / Group Name
The group name or email address configured in the 'Value' section under User Groups or Attribute Mappings should also match the corresponding group or email configuration in the IDP Auth Email Address/Group Name within the ReleaseOwl CPI environment registration page.
Integration Advisor
Enable Integration Advisor to provide the Host URL.
Host URL
The host URL is the base address of your SAP Integration Suite instance. (Example: https://<subdomain>.integrationsuite-<region>.cfapps.<domain>.hana.ondemand.com)
Enable Git (Optional)
Enable this option to integrate Git with the environment.
Git Credential
Select the credential for accessing the Git repository.
Repository URL
Provide the Git repository URL.
Branch
Specify the branch to be used for the integration.
Environment Type
Select the environment type (e.g., Dev, QA, Prod).
Custom Identity Provider (IDP) Setup and Configuration
A Custom IDP (Identity Provider) must be configured to allow secure authentication and authorization for users who interact with the Integration Suite (CPI) instance through ReleaseOwl.
Use Case: This is particularly useful for executing test cases, simulation testing and updating value mappings as part of the pipeline.
Steps to Configure a Custom Identity Provider (IDP)
A Custom Identity Provider (IDP) is required for deploying certain artifact types—such as Value Mapping, REST, SOAP, and OData APIs—as well as for executing test cases associated with these artifacts via ReleaseOwl.
Download SAP BTP SAML Metadata
Navigate to the Security section of your SAP BTP Subaccount.
Go to Trust Configuration.
Click Download SAML Metadata to download the BTP metadata file.
Extract the SAP BTP SSO URL
Open the downloaded SAML metadata XML file in a text editor (e.g., Notepad++, VS Code, or a browser).
Search for the
<AssertionConsumerService>tag.In this tag, locate the Location attribute. The value of this attribute is your SAP BTP SSO URL.
Copy the extracted SSO URL.
Paste it into the SSO URL field in the SAP CPI Environment.
After clicking the Save button, a Test button will appear. This button is used to verify whether the entered credentials are correct. Click on the Test button to validate the connection.
Upon successful validation, a Download option will be available to download the tenant-specific metadata and the SAP CPI environment descriptor file.
Create Trust Configuration in SAP BTP
Return to Trust Configuration in the SAP BTP Cockpit.
Click New Trust Configuration and select New SAML Trust Configuration.
Upload the ReleaseOwl CPI Environment metadata XML file.
Uncheck the option "Available for User Logon" to prevent this IDP from appearing on the SAP login screen.
Click Save.
Assign Role Collections (Choose One of the Methods Below)
To assign role collections, you can choose one of the following methods:
Method 1: Assign Role Collections using User Groups
Open the newly created Custom IDP for Applocations and click Edit.
Go to the User Groups section and Click the "+" button to add a new mapping.
Configure the mappings like the example below:
PI_Integration_Developer
Groups
equals
group name
Method 2: Assign Role Collections using Attribute Mapping (Email-Based)
In the same Trust Configuration screen, scroll to Attribute Mappings.
Click the "+" button to add a new mapping.
Define mappings like this:
PI_Integration_Developer
emailAddress
equals
The email ID of the service user
Method 3: Configure Custom Role Collection Mappings for the IdP
You can configure granular permissions by creating the custom role collection with the below required roles:
Custom Role Collection
Required Roles
Roles required for ReleaseOwl CPI test generator
Trail-content-adminstrator
PI_Integration_Developer
PI_Administrator
The group name or email address configured in the 'Value' section under User Groups or Attribute Mappings should match the corresponding group or email configuration in the IDP Auth Email Address/Group Name on the ReleaseOwl CPI environment registration page.
Create a Project
Go to the projects in the adminstation view.
Click on the "Create New Project"
Fill in the necessary details, select the project type as 'SAP CPI', and click the Save button
Adding Environments to the Project
For artifacts to load in SAP CPI Management page, the Integration Suite environments must be registered in Project Settings in ReleaseOwl.
To register SAP Integration Suite environment:
1. Go to Projects drop down at the top right corner and click Project Settings.
2. In Project Settings, go to Environment.
3. The following screen is displayed.
4. Click +Add button to add a new environment in ReleaseOwl.
5. In the subsequent screen, choose the required environment from the list displayed by selecting Source. Only the artifacts with source are synced to ReleaseOwl.
6. The environment is added to the corresponding project in ReleaseOwl.
7. Click Permissions (under Users tab in Project Settings), to add users that can access (read or deploy to) the registered CPI environment.
Click Permissions. The roles that are assigned to the selected user are seen.
Managing CPI Packages
1. Access SAP CPI Management:
Switch to the Project view.
Click on SAP CPI Management in the Build section.
2. Add and Sync Packages:
Click the Add Packages button in the CPI Packages section.
Select Package: Use the search bar to find a package, then check the box next to the desired package(s).
Sync Package: Click Sync to add and synchronize the selected package(s).
A pop-up screen will display the sync history. Use the Refresh button to update the sync status and view the latest details. Click Close when done.
3. Configure Artifacts:
Click the arrow next to the package name.
In the "Artifacts" list, click the three dots in the "Actions" column for the desired artifact.
Select "Configure" from the list.
4. Save Changes:
Modify the required values in the configuration screen.
Save: Update the existing artifact directly.
Save as Artifact: Create a new version of the artifact with the modified values.
After selecting "Save as Artifact", a new artifact is created with the updated values.
To view more details about the new artifact, click the three dots (Actions) next to it.
Click on Edit Configuration to open the artifact configuration.
Verify or modify the updated values by clicking on the pencil icon (Modify Values button), then click the Save button to apply the changes.
Editing timer configuration parameters (such as start time, recurrence, etc.) is not supported directly from ReleaseOwl.
A newly created artifact will be displayed with its specified name and the associated configuration settings.
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