Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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.

WebData objects can be integrated into user interfaces, allowing for direct interaction with web services and RESTful APIsReport WebData allows you to interact with and manipulate data entries directly through the Web Data Editor, an integral part of the reporting and data management functionalities.

On this page:

Table of Contents
maxLevel3
stylenone


Image Added

WebData Configuration

Creating a WebData Object

You

Configuring the Reports webData

In the Web Data Editor, you can create, modify, or delete data entries according to your project solution requirements.

  1. Go to Reports → Web Data/ WebData.
  2. Click the "Add" button to create a new Web Data entry, WebData and fill in the following columns:

Image Removed

Tip

Only the Name and Encoding properties are necessary for the basic use of the WebData object.


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

Report Configuration Properties

Field

Description

Name

Assign a unique name to your Web Data entry for easy identification.

Encoding

Chooses the right encoding format for data exchange. Options include JSON, XML, HTML, and or plain Text.

DefaultURL*

Inputs Defines the primary default URL for accessing the data sourceweb service interaction.

Authorization*

Sets up necessary authorization parameters. Options range from No Auth, Bearer Token, Basic Auth (Username and Password), to Custom authorization.

Headers

Indicates any extra headers required for the data request.

:

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

SaveFileName

Defines 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

Defines the length of the WebData.

TemplateID

Associates a template ID with the Web Data entry.

Description

Adds an optional description for the Web Data entry.

*

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.

*(Columns displayed by default on 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:In this section...

Page Tree
root@parent
spacesV10