BCApps Documentation
repository·main·Indexed 20 days ago
https://github.com/microsoft/bcappsCentral open-source collaboration hub for the Business Central application platform. This repository consolidates the System Application, Business Foundation, Base Application, first-party apps, and developer tools. It includes documentation for building the platform locally, contributing via GitHub, utilizing AI agent tooling like BCQuality, and implementing specific features such as the Contoso Coffee Demo Data Set and the E-Document core application interfaces.
What's inside BCApps
- The Email module provides an API to connect email accounts directly to Business Central. This allows users to send messages from within the system without needing to open external email applications. The module is built around several core entities that manage account connectivity, address suggestions, business process integration, and message lifecycle.
Overview of the Satisfaction Survey module
mainThe Satisfaction Survey module provides methods for presenting satisfaction surveys to users within Business Central. It allows for the activation and deactivation of surveys and the presentation of these surveys to the user interface.
Note: This module is obsoleted and no longer used.
Overview of the External File Storage - Azure Blob Storage Connector
mainThe External File Storage - Azure Blob Storage Connector is a Business Central application component that enables access to Azure Blob Storage Containers. It allows Business Central to interact with files stored in Azure Blob Storage as an external storage provider.Overview of the External File Storage Module
mainThe External File Storage Module for Business Central provides an API that enables connections to external cloud storage accounts. This allows Business Central users to access and manage files stored in external services directly from within the Business Central environment.Overview of the Contoso Coffee Demo Data Set
mainThe Contoso Coffee Demo Data Set is a tool for Business Central developers to learn and explore product capabilities using scenario-based demonstration data. It replaces the old RapidStart package method with a modular, extensible app-based approach. The tool allows for targeted demonstrations by selecting specific modules rather than importing massive, monolithic data sets.Overview of Azure File Services API
mainThe Azure File Services API module provides functionality to interact with files and directories hosted within Azure File Share Services. It allows developers to perform file system operations directly from Business Central applications using Azure's cloud storage capabilities.Overview of Navigation Bar Subscribers
mainTheNavigation Bar Subscriberscollection provides default subscribers to system events specifically for the Business Central Navigation Bar. It also exposes corresponding overridable integration events, allowing developers to hook into and customize the behavior of the Navigation Bar within the system.Overview of BLOB Storage in System Application
mainThe BLOB Storage module provides mechanisms for storing various types of data, such as images, very long texts, and PDF files. It is composed of three primary components:
- TempBlob container: Used for storing BLOB data in-memory.
- Persistent BLOB Management interface: Used for storing BLOB data that must persist between sessions.
- TempBlob List interface: Used for storing sequences of variables, where each variable in the sequence stores BLOB data.
Overview of Advanced Settings module
mainThe Advanced Settings module provides a dedicated settings page within Business Central and exposes integration events that allow developers to hook into and extend the advanced settings functionality.Overview of the System Application
mainThe System Application serves as the primary interface to the Business Central platform and its cloud ecosystem. It acts as a foundational layer that provides connectivity and integration capabilities across various modules within the Business Central environment.Overview of the Microsoft User Feedback Module
mainThe Microsoft User Feedback module (ID:
f7964d32-7685-400f-8297-4bc17d0aab0e) provides APIs for collecting user feedback and managing surveys within Business Central applications. It is part of theSystem Applicationand is intended for use by internal Microsoft apps only.Key capabilities include:
- Requesting general, positive (like), or negative (dislike) feedback.
- Supporting both regular and AI-powered feature feedback.
- Tracking user activity via timer-based or trigger-based survey mechanisms.
- Attaching contextual data (files and properties) to feedback requests.
- Targeting specific feature areas.
Overview of the Business Central Performance Toolkit
mainThe Performance Toolkit module provides functionality for creating and executing Business Central Performance Toolkit test suites. It is designed to help developers automate performance testing and analyze the resulting data to identify bottlenecks in Business Central applications.
Key Capabilities:
- Suite Creation: Generate structured test suites specifically for Business Central performance scenarios.
- Execution & Analysis: Run these test suites and process the output to analyze performance results.