Documentation Generator
Content
Introduction
This feature streamlines your reporting process by automatically generating detailed system reports that encompass entities and components within the defined environment. Additionally, it offers flexibility by enabling the creation of custom business-case reports tailored to the specific requirements. With its capability to produce comprehensive and customizable reports, it allows to efficiently gather the information needed to make informed decisions and optimize operations.
Default Report
The Default Report offers insights into all system components. It contains two report types:
Default Report List: A detailed list of components offering key system insights, searchable by name.
Visualization Report: A comprehensive diagram that illustrate the interconnectivity and dependencies of all components.
Default Report List
The Default Report List provides a comprehensive overview of the global system.
System: Identifies the specific system to which each component belongs, clarifying its role in the infrastructure.
Component: Differentiates components by name and type, such as Azure Function, C# code, or D365 object.
Number of calls: Shows how many access points a component has for different kind of events, highlighting interdependencies.
Number of triggers: Shows the number of entry points a component has to other events, aiding in the assessment of system criticality and reliability.
Component Link: Provides a direct link to a component for quick reference and deeper investigation.
Source Code Link: Direct access to a component's source code for in-depth analysis.
Real-life Example
System: Azure from the Golet.Ketion Project (Example Project)
Component: Azure Function named GoletHTTPFunction3
Number of calls: The GoletHttpFunction3 has two APICalls
Number of triggers: The Azure Function is triggered by one other component
Component Link: Click to access the component
Source: Click to view the source code of the component
Default Report Visualization
System components are visualized in detailed diagrams, simplifying connectivity understanding. Users can rearrange components and events, improving clarity. For example, users can focus on the account creation process by rearranging components and events in the Default Report or search for the specific component.
Additional component info is accessible by clicking "i" or "<>" icons.
Standard Default Report Visualization
The standard default report offers a holistic overview, providing a clear and informative snapshot of your system
Specific Process Analysis
Enhance analysis by adjusting and organizing components and events to focus specifically on chosen processes.
Detailed Component Information
See more at: Process and Logic Visualization | Step by Step Instructions
Best-practice Violations
Components with “Best Practice Violations” are represented by a red rectangle with a number indicating the count of violations within the component (See more: Best-practice Check)
A simple click on the rectangle opens a window displaying detailed information about the component's violations (see screenshot below)
Differentiate between Components and Events
Glossar | Components: depicted as gray boxes, include entities like D365-Objects, Azure Functions, or C# entry points (e.g., Plugin, WebApi, ConsoleApp).
Glossar | Event: depicted as green boxes, include items such as Triggers or, in this example, HTTP calls.
