Overview
WebData , is a configuration object designed to facilitate data exchange between applications using different formats like JSON, XML, or HTML. It allows you to load files or save data in those formats for immediate use by other applications or for further offline processing.
, allows saving this data to a file for offline use or further processing. WebData objects can be integrated into user interfaces, allowing for direct interaction with web services and RESTful APIs.
On this page:
| Table of Contents | ||||
|---|---|---|---|---|
|
WebData Configuration
Creating a WebData Object
You can create, modify, or delete data entries according to your solution requirements.
- Go to Reports → / WebData.
- Click the "Add" button to create a new WebData and fill in the following columns:
WebData Usage
Using a configured WebData in the Reports Modules at runtime is straightforward. Add a ReportViewer to a display and configure it by inserting the path of the target form in the ReportViewer configuration item using the following syntax: Report.WebData.<TargetWebDataName>. The ReportViewer is a graphical component designed to display WebData configured in the Reports module. To use it, navigate to Displays/Draw, select the Viewers WPF Only category, choose ReportViewer, and place it on the Drawing area by clicking or dragging and dropping. Double-click the object to configure it, then enter the path to access the target configured WebData in the Reports Module, such as 'Report.WebData.Test'.
Refer to ReportViewer Control for more details.
| Tip |
|---|
Only the Name and Encoding properties are necessary for the basic use of the WebData object. |
Properties Reference
WebData
Property | Description |
|---|---|
ID | Identifies the unique identifier for the WebData object. |
VersionID | Specifies the version of the WebData object. |
Name* | Names the WebData object for reference. |
Encoding* | Selects the data format for exchange; options include JSON, XML, HTML, or plain Text. |
DefaultURL* | Defines the default URL for web service interaction. |
Authorization* | Sets up authorization parameters: No Auth: selects no authentication method; no credentials will be sent with the request. Bearer Token: uses a Bearer Token for authentication; a token must be provided to access the resource. Basic Auth: implements basic authentication; requires a username and password to be sent with the request. Custom: allows for a custom authentication method to be defined and used according to specific requirements. |
Headers* | Contains metadata for the data request or response. |
SaveFileName* | Designates the file name for saving the data locally. |
Padding* | Adjusts whitespace around tag values with options: Compact (no extra characters); PadRight (extra space on the right); PadLeft (extra space on the left). |
EditSecurity | Assigns the security permissions groups for editing the WebData. |
Length* | Measures the size of the data in bytes. |
Level | Determines the access level required for the WebData. |
Category | Assigns the WebData object for organization. |
LockState | Indicates the lock status to prevent concurrent edits. |
LockOwner | Identifies the current owner of the edit lock. |
DateCreated | Records the creation date of the WebData object. |
DateModified | Logs the last modification date of the WebData object. |
Description* | Provides a brief explanation of the WebData object. |
*(Column Columns displayed by default on data grid)the DataGrid)
Edit WebData Content
The built-in WebData Editor allows you to define the data structure for JSON, XML, HTML or Text content.
→ Learn more at Reports WebData Editor.
In this section:
| Page Tree | ||||
|---|---|---|---|---|
|