Changes

'''This feature Reporting is obsolete {{Version/WinXSince|3.6}}'''<br /><br /> Our Reporting feature allows users to create reports from queries, which will be saved to a file on disk, and displayed using a web browser.Reports will contain information about the child objects endeavor of providing requested data in the query that the user is currently viewingform of a document. All offline available children, as well as all their properties and their children will recursively be captured and written to the report file. Reports There can be used for printingarbitrary reports about almost anything, documentationbut we always need to collect, or logging purposes.Users may also configure custom styling for extract, format and export the reportsdesired data. == Creating a report Techniques ==Please see '''With {{UBIK}}, there are next to no restrictions on how to approach reporting technically. However, we do have experience with several techniques and there is a [[media:UBIK_WinX_Reporting.mp4Reporting_(Plugin)|this videoreporting plugin]]''' to see how to create and open report files.If you cannot view the video, follow these instructionsKnown techniques are: # Navigate to any query object* [[Reporting_(Plugin)|UBIK.# Click the "Create Report" button in the left-hand paneModule.# The application picker will immediately be shown. Pick the application you wish to open the XML file Reporting]] HTML/PDF report generation from managed code with.Scriban#* Due to a security feature of Chrome, the report will not be properly styled[https://learn. Please use another browsermicrosoft.com/en-us/sql/reporting-services SSRS] SQL Server Reporting Services for data extraction from DB Views#* You may also open the report using a regular text editor[https://learn. Note that the report will not be styled in that casemicrosoft.# Reports will be stored under '''LocalStatecom/en-us/power-bi/create-reports/ PowerBI Paginated Reports'''] e.g. You may open them again from this folder at any time, from Excel or discard them.an Azure SQL DB== Approach ==In general, reporting consists of scope definition, collection, extraction, formatting and exporting.== Styling reports = Scope definition ===The user can completely customize For any report, it is important to have very clear requirements about the look temporal and layout spatial scope of reports in any way they please. We have provided a default stylesheet that can be overwritten or edited. The stylesheet uses the XSLT language, which converts XML data into HTML. This means we want to know, for which is interpreted by web browsers. XSLT should be uses mostly for creating templates or "containers" for XML elementstime frame do we want to create a report, while additional (external) CSS files can be used to handle (visual) styling. This and precisely what kind of data is also the approach we used for the default stylesheetexpected. === Editing the stylesheet Collection ===Our default stylesheet will In order to make a report about something, we need to get the source data first. We have to make sure we have access to all required data in a raw way. This might be located under '''LocalState/Reports/Stylesheet'''an infrastructure topic; our technique depends on how we can access the data. If E.g., in some cases where {{UBIK}} is hosted in the stylesheet file or folders do cloud, SSRS might not exist yetbe available if the customer's IT doesn't allow it.Next, our default stylesheet will it might be copied necessary to this location upon app startupprovide a DB View or managed code providing access to the raw data. === Extraction ===The file will never raw source data rarely is available in a form that can be overwritten again by displayed in the default stylesheetreport directly. Hence, so it the next step is safe to customize process the contents of this file to your likingsource data into the data we need. To revert your changes quicklyUsually, you can simply delete this means getting the file againdata into a different shape, i.e., gather data from different source objects and it will be regenerated once put the individual parts into a new report is createdresulting object. However, it can also mean running statistics or aggregation functions on the app is restartedraw data.=== Formatting ===To edit All the stylesheet, simply open data in the world is of little use if it with your favorite code editor or notepadcan't be interpreted. We suggest that you familiarize yourself Therefore, a crucial step in reporting is to come up with a fine representation of the XSLT (as well as HTML) syntax data. This means mostly the layout, labelling and functions before trying to make changes to this filegraphical display of the data. You Depending on the chosen technique, one can find an introductory tutorial use various tools to XSLT '''[https://wwwdesign the report.w3schools.com/xml/xsl_intro.asp here]'''. AdditionallyAs a consequence, we have included comments inside must also provide the default stylesheet data to clarify some of the code. Using XSLT, you reporting service in a way it can create templates for each individual XML elementbe applied. To style these templates, you may use external CSS files (or inline CSS styles in HTML). For convenienceThus, we have included an external CSS stylesheet within this XSLT file. To view must design our data model and the changes you have made used data types according to the stylesheetreport's needs. Extraction and formatting therefore are co-dependent.=== Exporting ===Usually, simply reload the receiver of the report wants it in your browserthe form of a nice document. Hence, exporting the previously generated report as PDF or create publishing it on a new oneweb page are viable options that can be discussed with the customer.== See also ==* [[Reporting_(Plugin)|{{UBIK}} reporting plugin]]