JsonDataSource.ConnectionName Property

Specifies the connection name that the JsonDataSource uses to get authentication or query parameters.

Namespace: DevExpress.DataAccess.Json

Assembly: DevExpress.DataAccess.v24.1.dll

NuGet Packages: DevExpress.DataAccess, DevExpress.Win.PivotGrid, DevExpress.Win.TreeMap

Declaration

C#

[LocalizableCategory(DataAccessStringId.PropertyGridConnectionCategoryName)]
[TypeConverter(typeof(ConnectionNameTypeConverter))]
public string ConnectionName { get; set; }

VB.NET

<TypeConverter(GetType(ConnectionNameTypeConverter))>
<LocalizableCategory(DataAccessStringId.PropertyGridConnectionCategoryName)>
Public Property ConnectionName As String

Property Value

Type
String

Remarks

If the JsonDataSource object retrieves JSON data from a web service endpoint that requests authentication, you should specify authentication parameters. To do this, you can use the JsonDataSource‘s ConnectionName property. Set this property to the name of the connection string defined in your application’s configuration file. The JsonDataSource object obtains authentication parameters from the specified connection string.

The following connection string illustrates how to specify basic authentication parameters, token-based authentication parameters and query parameters.

XML

<configuration>
    <connectionStrings>
        <add name="JsonConnection" connectionString="Uri=https://northwind.netcore.io/customers.json;
            Username=user;Password=pwd;
            header:MyAuthHeader1=secretToken1;header:MyAuthHeader2=secretToken2;
            query:id=123456;query:name=MyName" 
        providerName="JsonSourceProvider" />
    </connectionStrings>
    <!--...-->
</configuration>

The following code demonstrates how to specify a JsonDataSource‘s ConnectionName property.

C#

public static JsonDataSource CreateDataSourceFromConnectionString() {
    JsonDataSource jsonDataSource = new DevExpress.DataAccess.Json.JsonDataSource() {
        // The application's configuration file should include the "JsonConnection" connection string
        ConnectionName = "JsonConnection"
    };
    return jsonDataSource;
} 

VB.NET

Public Shared Function CreateDataSourceFromConnectionString() As JsonDataSource
    Dim jsonDataSource As JsonDataSource = New DevExpress.DataAccess.Json.JsonDataSource() With {.ConnectionName = "JsonConnection"}
    Return jsonDataSource
End Function

Tip

Online Example: How to Provide Authentication to Access Json Data in Reports

Note

You can also use the JsonSource object associated with the JsonDataSource to specify authentication parameters.

Refer to the Provide Authentication to Access JSON Data (Runtime Sample) topic for information on how to provide a report‘s JSON data source with authentication parameters at runtime.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ConnectionName property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

asp-net-web-forms-dashboard-register-data-sources/CS/WebFormsDashboardDataSources/Pages/JsonDashboard.aspx.cs#L21

DashboardJsonDataSource jsonDataSourceUrl = new DashboardJsonDataSource("JSON Data Source (URL)");
jsonDataSourceUrl.ConnectionName = "jsonUrlConnection";
jsonDataSourceUrl.RootElement = "Employee";

reporting-winforms-provide-authentication-to-access-json-data/CS/Form1.cs#L107

i++;
jsonDS.ConnectionName = string.Format("newJsonConnection_{0}{1}", report.Name, i.ToString());

asp-net-mvc-dashboard-register-data-sources/CS/MvcDashboardDataSources/Configuration/JsonDataSourceConfigurator.cs#L20

jsonDataSourceFile.ConnectionName = "jsonConnection";
jsonDataSourceFile.RootElement = "Customers";

aspnet-web-forms-dashboard-data-federation/CS/AspNetWebFormsDataFederation/Default.aspx.cs#L41

DashboardJsonDataSource jsonDataSource = new DashboardJsonDataSource("JSON Data Source");
jsonDataSource.ConnectionName = "jsonCategories";
Uri fileUri = new Uri(HostingEnvironment.MapPath(@"~/App_Data/Categories.json"), UriKind.RelativeOrAbsolute);

VB.NET

asp-net-web-forms-dashboard-register-data-sources/VB/WebFormsDashboardDataSources/Pages/JsonDashboard.aspx.vb#L21

Dim jsonDataSourceUrl As DashboardJsonDataSource = New DashboardJsonDataSource("JSON Data Source (URL)")
jsonDataSourceUrl.ConnectionName = "jsonUrlConnection"
jsonDataSourceUrl.RootElement = "Employee"

reporting-winforms-provide-authentication-to-access-json-data/VB/Form1.vb#L107

i += 1
jsonDS.ConnectionName = String.Format("newJsonConnection_{0}{1}", report.Name, i.ToString())

asp-net-mvc-dashboard-register-data-sources/VB/MvcDashboardDataSources/Configuration/JsonDataSourceConfigurator.vb#L20

jsonDataSourceFile.ConnectionName = "jsonConnection"
jsonDataSourceFile.RootElement = "Customers"

aspnet-web-forms-dashboard-data-federation/VB/AspNetWebFormsDataFederation/Default.aspx.vb#L35

Dim jsonDataSource As DashboardJsonDataSource = New DashboardJsonDataSource("JSON Data Source")
jsonDataSource.ConnectionName = "jsonCategories"
Dim fileUri As Uri = New Uri(HostingEnvironment.MapPath("~/App_Data/Categories.json"), UriKind.RelativeOrAbsolute)