Getting Started with Dark CPI Extension

Last Updated on 2024-12-03

Welcome to the Dark CPI Web Extension for SAP CPI repository! This open-source project provides a sleek, dark interface for your SAP environment, enhancing visual comfort and overall user experience.

Our Vision of this Project

The Dark CPI Extension was born from the desire to create a more visually comfortable and cohesive interface for SAP applications. With an eye towards improving user experience, we extended the dark theme across various UI elements, making your SAP environment not only more stylish but also easier on the eyes during long sessions.

We believe that a well-designed interface can significantly enhance productivity and user satisfaction. Our goal is to provide a solution that aligns with individual preferences while ensuring a consistent and enjoyable experience across SAP CPI.

Privacy and Data Protection

Your privacy is paramount. The Dark CPI Extension is designed with your data security in mind:

  • No Personal Data Collection: We do not collect personal data, tenant information, or any other sensitive details.
  • Transparency: As an open-source project, our source code is available for review, ensuring full transparency.
  • No Third-Party Libraries: We have developed our own secure logging solutions instead of relying on third-party libraries.

We are committed to maintaining the highest standards of data protection and security.

Blog Post

For more insights and updates about the Dark CPI Extension, check out our SAP Blog Post in Community.

Installation

Getting started with the Dark CPI Extension is simple:

  1. Download the Extension:

  2. Manual Installation:

    • Download the latest release from our GitHub repository.
    • Extract the archive and navigate to the bin folder.
    • Open Google Chrome and go to chrome://extensions/.
    • Enable "Developer mode" and click "Load unpacked". Select the extracted folder.
WARNING:
The extension is currently not supported on Firefox.

Usage

Using the Dark CPI Extension is straightforward:

  1. Open your SAP CPI environment.
  2. The extension will automatically apply the dark theme to your interface or select from extension icon on top in browser besides URL if pin it.

Available Themes

The extension comes with the following predefined themes:

  • Morning Horizon - New Theme By SAP
  • Evening Horizon - Dark Theme similar to New UI
  • Quartz Light - Previous UI Theme before Morning Horizon
NOTE:
Other SAP themes are not compatible with this extension.(Paramerter base switch is for test purpose, Use UI to switch)

Versioning Scheme

  • Format: Major.Minor.Maintenance.Build
    • Major: Significant changes or new features.
    • Minor: Small features or improvements.
    • Maintenance: Bug fixes or minor updates.
    • Build (optional): Used for internal purposes such as build numbers or source control revisions. This number will not appear in the changelog and is only included in maintenance versions.

Changelogs

v2.0.0

  • Feature Updated in Native UI5.
  • Improvement load time was decreased by optimizing the extension runtime.
  • Improvement Limited CSS overwrites to ensure a seamless native experience.

v1.3.7/8

  • Feature Generic Bug fixes.![Important] Discontinuing support for SAP Build and Theme Designer from v2.0.

v1.3.6

  • Feature Unix & ISO time stamp converter added in popup
  • Improvement load time was decreased by optimizing the extension runtime.
  • BugFix Events includes further minor UI tweaks and consistent bit order
  • Release Adding Release on GitHub to quickly get binary via GitHub.
  • BugFix Toolbar will not be compromised with Super Easy extension.

v1.3.5

  • Bugfix Corrected the CPI panel display issue on search.
  • Improvement Optimized the extension size, reducing it from 2 MB to approximately 350 KB.
  • Improvement Limited CSS overwrites to ensure a seamless native experience.

v1.3.4

  • Feature: Support for additional SAP CPI - fka HCI / old Tenants.
  • Bugfix: UI changes and fixes.

v1.3.3

  • Bugfix: Resolved issues with SAP UI theme Horizon (trace half-screen visibility).
  • Bugfix: Fixed visibility issues in mmap files and simulation error color.
  • Feature: Added support for SAP Builds Workzone and its theme designer.
  • Feature: Enhanced dark theme support for CPI capabilities like Integration and Migration Assessment.
  • Improvement: Updated UI for the popup.

v1.2.0

  • Feature: Navigation bar automatically closes on startup.
  • Feature: Added to Edge Store.
  • Bugfix: Fixed SAP UI theme Horizon issues.
  • Improvement: Improved UI for theme selection from the extension icon.

v1.1.0

  • Bugfix: Added support for mapping pages.
  • Feature: Theme change functionality from the popup page.

v1.0.0

  • Initial public release with dark theme support for SAP CPI.

Code of Conduct

We strive to maintain a welcoming environment for all contributors and users. Please review our Code of Conduct for guidelines on expected behavior.

Contributing

We encourage community contributions! To get involved:

  1. Fork the Repository: Click "Fork" on our GitHub page.
  2. Clone Your Fork: Use git clone .
  3. Create a Branch: Use git checkout -b feature-branch.
  4. Make Changes: Implement your changes.
  5. Commit and Push: Use git commit -m "Description of changes" and git push origin feature-branch.
  6. Create a Pull Request: Submit a pull request to our repository.
IMPORTANT:
No 3rd party lib is allowed in minified version. If you want to include then it should be uncompressed version So that we can review / set other environment as `ISOLATED` for security reasons.

Please refer to our Contribution Guidelines for more detailed information.

Code Review Guidelines

To ensure quality and project integrity:

  • Security: Ensure code does not introduce vulnerabilities.

Thank you for your contributions and patience during the review process.

Support

For questions or issues, please open an issue on GitHub.

Thank you for choosing the Dark CPI Extension! We hope it enhances your SAP experience.

End of article.