API Management
Last updated
Last updated
The API Management module in ReleaseOwl provides a comprehensive set of tools to streamline the management of SAP API artifacts. From synchronizing and configuring API proxies to tracking revisions and managing deployments across environments, this module ensures efficient control over your API landscape. It supports artifact promotion, revision history tracking, deployment validation, and environment-specific configurations.
To synchronize the API artifacts, navigate to the Project View and click on API Management (Beta) under the Build section.
Click Synchronize to fetch various API artifacts such as API Proxies and Key Value Maps from the registered SAP API Management environment into ReleaseOwl.
With this, you can view the history of all the artifact syncs that have occurred. Click Sync History, to view the API Sync History of this project.
Multiple actions can be performed on an artifact, based on the type of artifact. These actions include – Sync, Configure, Revisions, Deployment History and Download.
You can maintain configuration parameters for API artifacts separately for each environment in ReleaseOwl. These parameters will be applied automatically during deployment.
To configure an API artifact:
Navigate to the required artifact, click the Actions button, and select Configure.
The configuration screen displays various API Proxies for the SAP API Management environments that are part of the deployment landscape.
Note: No changes can be made to the Dev environment.
To update parameters for other environments:
Click the Edit icon next to the desired environment.
Make the necessary changes.
Click Save.
Use the Target Endpoints view to configure endpoint details for the API Proxy. The dropdown menu allows you to switch between and manage different named target endpoints.
Revisions refer to versioned snapshots of an API Proxy. Every time you make changes—such as modifying endpoints, policies, or configurations—and save them, a new revision is automatically created to capture those updates.
To perform revisions, follow these steps:
Click on the "Revisions" button.
The following options are available:
Compare Environments
Compare Versions
Assign User Story
Unassign User Story
Additional configuration actions
The Compare Environments option allows you to compare the source version of an API Proxy or Product in the Source Environment with the active version in the Destination Environment.
Click Compare Environments, select the Source Environment and Destination Environment, then click Submit to initiate the comparison.
The Compare Versions option allows you to compare two different versions of an API Proxy or Product. Ensure that you select two versions of the same artifact to perform the comparison.
You can assign a user story to yourself or another team member for better ownership and tracking. To assign a user story, click on the Assignee field, and select the desired user from the list.
Unassign User Story: If a user story needs to be released from an assignee, you can unassign it. To unassign a user story, click on the Assignee field, and choose Unassigned or clear the current selection.
Additionally, you can perform configuration actions within the Revisions section.
You can download the API artifact as a ZIP file. The selected API artifact will be packaged and downloaded to your system.
Displays the recent deployments of API Proxy artifacts, including the artifact name, associated user story, target environment, deployment timestamp, and deployment status.
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
Navigate to Release Pipelines.
Click 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 API.
API Management: Select the target API environment.
3. Add Approval Tasks
Click the Add button in a task stage to include approval tasks.
Fill in the required details:
Name: Enter a preferred name for the approval task.
Assign To: Select the user responsible for approval.
Click Save.
1. Create a Sprint
In the Project View, navigate to Change Management.
Click Create Sprint.
Enter the Sprint Name and click Save.
Click the 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.
Click the Action button, then select Edit.
3. Manage API Management Artifacts
Go to API Management Artifacts.
Click + Add to add API Management artifacts.
Select the Release Pipeline and Component.
Click Save.
Click the Action button, then select Promote.
Activity log: The activity log helps track the progress of deployment tasks, identify any issues or failures, and maintain a record of who performed each action.
4. Approval Process
Before deployment, an Approval Section appears.
The assigned user must approve/reject the task.
Navigate to My Tasks.
Click Approve/Reject in the Actions column.
5. Deployment Monitoring
After approval, go to Pipeline Activity.
Once the Deployment Tasks are marked as Approved, the deployment process begins. After completing the deployment, you can review the detailed Deploy Logs.
Deploy Status: Reflects the final deployment status of the API artifact to the target environment.
Already Deployed: Indicates that the API artifact was previously deployed, either as part of a retry or through manual completion. This status helps avoid redundant deployments and ensures clarity during re-runs.
Manual Completion: If a deployment fails in ReleaseOwl, but the artifact has been successfully deployed or addressed directly in the backend system (e.g., SAP API Management) through manual intervention, users can use the Manual Completion option in ReleaseOwl to mark the deployment step as completed.
To perform manual completion:
Click the Mark as Complete button to proceed with the pipeline.
After marking as complete, click the Continue button to resume the previously failed deployment stage.
You will see a confirmation that the deployment has resumed successfully.
The deployment status will then update to Completed, indicating that the process finished successfully.
Retry Button Allows users to retry a failed deployment or re-execute a failed stage of the pipeline.
After deploying the artifacts, you will receive a notification email containing the deployment details, including the user story ID, artifact type, version ID, and deployment status.
