Skip to Main Content
InterSystems Ideas
We love hearing from our users. Tell us what you want to see next and upvote ideas from the community.
* Bugs and troubleshooting should as usual go through InterSystems support.
Status Future consideration
Categories InterSystems IRIS
Created by Shareek Ahamed
Created on Oct 6, 2022

A Dynamic Cheat Sheet to lookup for Common Core Functions for Reusability

When developing Region or site level codes, sometimes we tend to create our own functions to complete it; But what if there is a core function which does the same thing and you didn't know of.

Below advantages can be achieved if the common core functions are in your fingertips.
REUSABILITY - Can reuse the existing core function without re-inventing.
QUICK - Since not required to write the function or test it, it will save precious time.
ACCURATE - Since it's a core function and tested and finalized, it is accurate.
CONCISTANT - Since going to point to the same function where ever you are, it will be consistent across the system.

    Jan 26, 2023

    Thank you for submitting the idea. The status has been changed to "future consideration".

    Stay tuned!

  • Shareek Ahamed
    Jun 26, 2023

    Thank you for your comments Raj & Vadim;
    Please find my idea in detail below.

    Dynamic Cheat Sheet: Empowering Developers with Enhanced IDE Features

    Introduction: My proposed idea aims to improve the functionalities of IDE (Cache Studio or Visual Code) by introducing a dynamic cheat sheet feature. This feature will provide developers with quick access to a repository of common core functions, allowing them to enhance their coding efficiency, reusability, accuracy, and maintain consistency across projects.

    Problem Statement: When working on region or site-specific code development, developers often find themselves reinventing the wheel by implementing / creating functions that already exist in the core libraries. This not only wastes valuable time but also hinders code accuracy and consistency.

    Solution: My solution is to integrate a dynamic cheat sheet within the IDE, which will serve as a comprehensive reference for common core functions. By implementing this feature, developers will benefit from the following advantages:

    1. Reusability: The dynamic cheat sheet will provide developers with instant access to a wide range of pre-existing core functions. They can leverage these functions instead of reinventing the wheel, saving time and effort in writing and testing redundant code.

    2. Time Efficiency: Developers will no longer need to spend time researching, writing, and debugging functions that already exist. With the dynamic cheat sheet, they can quickly locate the required core function, significantly reducing development time.

    3. Accuracy: Core functions are typically thoroughly tested and refined, ensuring their reliability and accuracy. By utilizing these pre-existing functions, developers can leverage the stability and quality assurance already embedded within them.

    4. Consistency: The dynamic cheat sheet will serve as a central repository for core functions, ensuring consistent usage across the entire system. Regardless of the developer's location within the codebase, they can rely on the same set of established core functions, promoting code uniformity and reducing the chances of errors caused by inconsistency.

    Conclusion: Introducing a dynamic cheat sheet feature within IDE will greatly enhance the coding experience for developers. By providing quick access to common core functions, we empower developers to improve their productivity, reduce code duplication, and maintain accuracy and consistency. Implementing this feature will significantly elevate the overall development process, benefiting both individual developers and the entire software development teams across regions.

    To explain this with some examples:

    Example 1: Extend and Re-Use
    Number to Text Conversion when printing on a receipt
    To achieve this will have to write our own code or use some 3rd party library etc.
    If there is a well defined function anyone can extend and reuse it.

    Example 2: Copy and Re-Implement code chunks
    Let's say the task is to create a new Report which will use ^CacheTemp
    If we can have a cheat-sheet having the template of such Stored Procedures.
    It will save a lot of development / testing / code review time.

    Example 3: One Click Re-use of code logics
    Let's say there is a scenario to calculate Length of Stay (LOS)
    This type of code often confuses the developer and the tester when each developer uses there own variable names and code logic. Rather if we can have a common code chunk where it will used undoubtedly everywhere across.

  • Admin
    Vadim Aniskin
    Jun 26, 2023

    @Shareek Ahamed, you have a question about your idea. Please answer it to help your idea to be promoted.

  • Admin
    Raj Singh
    Jan 12, 2023

    Can you add more detail? I'm not sure what you're asking for.