How webcon-bps/develop-docs works
Project Type and Purpose
• This repository is a collection of example SDK extensions for WebCon, divided into three separate solution projects: QuickStart (basic examples), Examples (intermediate examples), and AdvancedExamples (integration scenarios).
• The project demonstrates different extension capabilities, such as custom actions, custom authentications, and form field extensions (including both back-end C# logic and front-end JavaScript components for the PhoneNumber example).
Analyzing the File Structure
• Top-level directories include a hidden .github folder (with workflow definitions for CI/CD) and a major directory named “WebCon.BpsExt.Examples” that contains all the sample projects.
• WebCon.BpsExt.QuickStart
• WebCon.BpsExt.Examples
• WebCon.BpsExt.AdvancedExamples
• Each of these projects has subdirectories for “CustomActions”, “CustomAuthentications”, “FormFieldExtensions”, as well as properties and configuration files.
• The AdvancedExamples include examples that integrate with front-end (e.g., PhoneNumberJS) along with back-end extension logic, indicating a mix of technologies (C# for server-side and JavaScript for client-side).
Extracting Architectural Details from README
• The README clarifies that these packages provide examples of SDK extensions, categorizing them by complexity level. This categorization is important for describing the modular structure and potential integration points with WebCon’s main system.
• There is a clear separation of concerns among the three projects, each serving a specific audience from beginners to advanced integrators.
• Container the Solution Projects:
• CustomActions: Module(s) handling custom business processes triggered by events (include components for each type, such as CopyAttachment, SetItemList, StartNewDocument).
• CustomAuthentications: Module(s) demonstrating authentication extensions (e.g., DatabaseAuthentication, RestAuthentication).
• FormFieldExtensions: Module(s) focused on extending form fields. For example, the PhoneNumber extension shows both the back-end logic (C# classes like PhoneNumberLogic and configuration) and the front-end implementation (PhoneNumberJS with React or similar structure components like PhoneNumber.js, CSS, etc.).
• Additional Components:
• CI/CD Pipeline: From the .github/workflows folder, indicate the existence of automated build/deployment pipelines.
• Shared Components and Configurations: Represent properties files (AssemblyInfo.cs) and common configuration files (e.g., temporary_key.snk, project JSON files) that are reused by different modules.
Relationships and Interactions
• For each example extension, show how the configuration (e.g., *Config.cs files) and logic (e.g., *.cs files) integrate with the underlying WebCon platform.
• For the PhoneNumber extension, show the interaction between the JavaScript front-end component (client-side UI validation, custom control logic) and its server-side counterpart (C# logic).
• Demonstrate dependencies:
• That all examples rely on the underlying WebCon.BpsExt SDK (implied as a common integration point, even if not explicitly in the repository).
• That CI/CD (via GitHub Actions) integrates with the build and deployment process for all solution projects.
Architectural Patterns and Design Principles
• Modularization: Clearly show that the project is divided into distinct extension types, each isolated in its own folder/module.
• Separation of Concerns: Emphasize that UI components (front-end) are separated from core business logic (back-end C# code).
• Extensibility: Indicate the plug-in nature of SDK extensions, making it easy to add further custom modules as needed.