Skip to content

Repository files navigation

Jira Reconciliation

The "Jira Reconciliation" application is a utility application helping organizations reconcile project-related data between SAP S/4HANA Cloud Public Edition and Atlassian Jira.

The application acts as a companion to the SAP S/4HANA integration package helping teams detect and address cross-system inconsistencies.

Personas

Project Managers

Project Managers are responsible for delivery tracking, execution oversight, and resource coordination. They rely on Jira issues being aligned with current SAP project structures and WBS assignments so they can monitor progress, identify risks early, and maintain confidence in project execution data.

Finance / Cost Controllers

Finance and Cost Controllers are responsible for ensuring that project-related effort and activities are assigned to the correct cost objects. They depend on accurate WBS-to-Jira mappings to support cost transparency, financial control, and reliable reporting across projects.

PMO / Delivery Leads

PMO and Delivery Leads are responsible for governance, reporting quality, and delivery oversight across multiple initiatives. They need visibility into inconsistencies between SAP and Jira in order to reduce manual follow-up, improve reporting accuracy, and support better execution decisions.

Features and Values

  • Orphaned Issue Detection - Identifies Jira issues linked to WBS elements that no longer exist in SAP S/4HANA, preventing effort from being associated with invalid project structures.
  • Missing WBS Assignment Detection - Flags Jira issues with no valid WBS link, ensuring every issue contributes to accurate project cost tracking.
  • Closed WBS Assignment Detection - Highlights Jira issues still linked to completed or closed WBS elements, preventing effort from being logged against inactive cost objects.
  • Inactive Employee Assignment Detection - Detects Jira issues assigned to employees who are no longer active in SAP, keeping resource data current and compliant.
  • Early Warning Visibility - Surfaces reconciliation issues before they propagate into financial reports or delivery dashboards.
  • Improved Cost Transparency - Supports accurate project cost tracking by keeping Jira and SAP S/4HANA in sync.
  • Reduced Manual Reconciliation Effort - Automates detection of cross-system inconsistencies that would otherwise require time-consuming manual comparison.
  • Faster Issue Resolution - Consolidates reconciliation findings in a single view so teams can identify and address problems quickly.

Documentation

Detailed guides are available in the documentation/ folder.

Document Description
Project Scope Business purpose, supported use cases, out-of-scope items, and intended audience.
Prerequisites BTP services, entitlements, and external system destinations required before setup or deployment.
Setup SAP BTP subaccount configuration — service instances, destinations, roles, and optional Work Zone integration.
Deployment Step-by-step guide to building and deploying the MTA archive to SAP BTP Cloud Foundry.
Work Zone Setup Provisioning SAP Build Work Zone, creating a site, and exposing the app via Content Manager.
Cross-Subaccount Access How to subscribe to the app from a different BTP subaccount and configure the required CF route in the provider.
Bill of Materials Full BOM — BTP modules, required service entitlements, external API endpoints, and technical dependencies.

Overview

This project helps streamline reconciliation and tagging workflows by combining:

  • a SAPUI5 frontend for user interaction,
  • a CAP service layer for business logic and integrations,
  • deployment and runtime support for SAP BTP environments.

It is intended for teams working with Jira-based delivery processes and SAP BTP landscapes.

Tech Stack

  • TypeScript
  • Node.js
  • SAP CAP
  • SAPUI5 / Fiori
  • SAP Business Technology Platform (BTP)

Project Structure

  • app/jira-reconciliation/webapp/: SAPUI5 Fiori frontend (TypeScript, XML views, controllers, i18n, etc.)
  • srv/: CAP service layer (CDS models, TypeScript handlers, connectors, utils)
  • @cds-models/: Generated or external models for integration (Jira, S/4HANA, etc.)
  • gen/: Generated CAP artifacts
  • mta.yaml: Multi-target application descriptor for BTP deployment
  • xs-app.json: Approuter configuration for HTML5 repo and authentication

Getting Started

Prerequisites

Local development tools

Make sure the following are installed:

  • Node.js (v22+ recommended)
  • npm
  • @sap/cds (globally or locally)
  • SAPUI5 Tooling (for frontend)

Required integration

Ensure the standard SAP S/4HANA Cloud Public Edition Integration with Jira integration for SAP Integration Suite is available and configured in your landscape.

Install Dependencies

npm install
cd app/jira-reconciliation
npm install

Setup for local testing with BTP destinations

Manually create the necessary destination in your BTP Cockpit. Use the below json to import:

{
  "exportTime": "2025-11-25 15:57:48.012006035",
  "destination": {
    "Name": "jrcon-s4hana-destination",
    "Type": "HTTP",
    "Description": "",
    "URL": "{{SAP S/4HANA Cloud Public Edition Base URL}}",
    "ProxyType": "Internet",
    "Authentication": "BasicAuthentication",
    "User": "{{ SAP S/4HANA Cloud Public Edition Communication Username}}",
    "Password": "{{ SAP S/4HANA Cloud Public Edition Communication Password}}"
  }
}
{
  "exportTime": "2025-11-25 15:57:40.972765114",
  "destination": {
    "Name": "jrcon-jira-destination",
    "Type": "HTTP",
    "Description": "",
    "URL": "{{ Atlassian Jira Base URL }}",
    "ProxyType": "Internet",
    "Authentication": "BasicAuthentication",
    "User": "{{ Atlassian Jira Org Admin User }}",
    "Password": "{{ Atlassian Jira API Token }}"
  }
}

Then bind the following BTP services to your local setup.

cf login --sso -a {{ BTP CloudFoundry API Endpoint }}

cf create-service xsuaa application cpapp-xsuaa
cf create-service-key cpapp-xsuaa cpapp-xsuaa-key

cf create-service destination lite cpapp-destination
cf create-service-key cpapp-destination cpapp-destination-key

cds bind -2 cpapp-xsuaa,cpapp-destination

For a reference, you can check the official CAP guide;

Run the CAP Application

npm run watch

This starts the CAP service locally with live reload using the hybrid environment.

Access the App

Once the application is running locally, open:

This loads the full application index, including both backend and frontend components.

Deployment to SAP BTP

  1. Build and deploy the MTA archive:
    cds up
  2. The app will be available in the HTML5 Applications repository and can be added to SAP Build Work Zone.

Integration with SAP Build Work Zone

  • Open SAP Build Work Zone.
  • After deployment, add the app from "HTML5 Applications" in Content Manager.
  • Assign and publish to your Work Zone site or workspace.

License

This software is licensed under the terms described in the LICENSE file.

For SPDX/REUSE compatibility, the license is also provided in LICENSES/LicenseRef-WiserSUL-1.1.txt.

Disclaimer

This repository and its contents are provided for informational and example purposes only.

The content is provided "as is", without warranty of any kind, express or implied, including but not limited to warranties of merchantability, fitness for a particular purpose, and non-infringement.

No guarantee is provided regarding the completeness, correctness, reliability, or suitability of the content for productive or commercial use.

See DISCLAIMER.md for additional information.

Commercial Use

Commercial use is subject to the applicable licensing terms.

See COMMERCIAL_LICENSE.md for details.

Contact

For issues, feature requests, or contribution-related questions, please contact the project maintainer or open a GitHub issue.

About

This CAP-based application serves as an extension to the standard 'SAP S/4HANA Cloud Public Edition integration with Jira.' While the OOTB integration package for SAP Integration Suite handles core data synchronization, this application provides a dedicated workspace for Project Managers and Stakeholders to perform Jira Reconciliation activities.

Topics

Resources

Security policy

Stars

2 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages