SAP Sybase SQL Anywhere

The Dashboard Designer provides the capability to connect to multiple types of SQL databases using the Data Source wizard. You can also use data access API to connect to the database and select the required data in code.

This tutorial describes how to establish a connection to a SAP SQL Anywhere database and select the required data.

Important

To connect to various SQL databases, the Dashboard Designer requires a corresponding provider to be installed on the client machine. To learn more, see Supported Data Sources.

Creating a Data Source in the Data Source Wizard

To connect to the SAP Sybase SQL Anywhere database in the Dashboard Designer, perform the following steps.

  1. Click the New Data Source button in the Data Source ribbon tab.

    DataBinding_NewDataSource

  2. On the first page of the invoked Data Source Wizard dialog, select Database and click Next.

    DataSourceWizard_Database

  3. On the next page, select the SAP Sybase SQL Anywhere data provider and choose the required Server type. If you selected the Server, the Data Source wizard provides the following connection settings.

    DataSourceWizard_SQLAnywhere

    • Hostname

      Specifies the hostname of the SAP SQL Anywhere server to which the connection should be established.

    • Server name

      Specifies the name of the SAP SQL Anywhere server to which the connection should be established.

    • User name

      Specifies the user name used to authenticate to the SAP SQL Anywhere server.

    • Password

      Specifies the password used to authenticate to the SAP SQL Anywhere server.

    • Database

      Specifies the name of the database that contains the required data.

    If you selected the Embedded Server type, the Data Source wizard provides the following connection settings.

    DataSourceWizard_SQLAnywhere_Embedded

    • Database

      Specifies the path to the database that contains the required data. To locate the database, click the ellipsis button next to the Database field.

    • User name

      Specifies the user name used to connect to the SAP SQL Anywhere database.

    • Password

      Specifies the password used to connect to the SAP SQL Anywhere database.

  4. After you have specified the required connection parameters, click Next and specify how to select data from the database.

    DataSourceWizard_Query

    You can choose from the following options.

    • Select the Query option and run the Query Builder by clicking the Run Query Builder... button. The Query Builder allows you to choose the required tables/columns visually and passes the resulting SQL query to the SQL String editor. After you constructed the query in the Query Builder, the text of the generated query will be passed to the Data Source wizard.

      DataSourceWizard_GeneratedQuery

      Click Finish to create the data source.

      Note

      If you applied filtering to this query and created the query parameter, you can click Next to specify the settings of the query parameter.

    • Select the Stored Procedure option to select one of the stored procedures from the database.

      DataSourceWizard_SelectStoredProcedure

      Then click Next to specify the settings of the stored procedure parameter(s).

  5. On the final page, you can optionally add query parameters and preview data.

    DataSourceWizard_AddQueryParameters

    Click Finish to create the data source.

Creating a Data Source in Code

To create a data source that uses a connection to the SAP SQL Anywhere database, create the instance of the DashboardSqlDataSource class and perform the following steps.

  1. Specify connection parameters to the SAP SQL Anywhere database. Create the AsaConnectionParameters class object and specify the following properties.

    Assign the resulting AsaConnectionParameters object to the SqlDataSource.ConnectionParameters property.

    Note

    As an alternative, you can add a connection string with required parameters to the application configuration file. Then, assign the connection string name to the SqlDataSource.ConnectionName property.

  2. Select the required data by specifying the query. You can do this in the following ways.

    • The SelectQuery object allows you to specify a set of tables/columns, which form a SELECT statement when executing a query.
    • The CustomSqlQuery object allows you to specify an SQL query manually.
    • The StoredProcQuery object allows you to perform a stored procedure call to supply the dashboard with data.

    Add the created query to the SqlDataSource.Queries collection exposed by the DashboardSqlDataSource object.

  3. Add the created DashboardSqlDataSource object to the Dashboard.DataSources collection.

The following code snippet shows how to supply the dashboard with data from the Northwind database deployed on the SAP SQL Anywhere database server.

using DevExpress.DashboardCommon;
using DevExpress.DataAccess.ConnectionParameters;
using DevExpress.DataAccess.Sql;
// ... 
            AsaConnectionParameters asaParams = new AsaConnectionParameters();
            asaParams.Hostname = "localhost";
            asaParams.ServerName = "testserver";
            asaParams.DatabaseName = "Northwind";
            asaParams.UserName = "Admin";
            asaParams.Password = "password";

            DashboardSqlDataSource sqlDataSource = new DashboardSqlDataSource("Data Source 1", asaParams);
            SelectQuery selectQuery = SelectQueryFluentBuilder
                .AddTable("SalesPerson")
                .SelectColumns("CategoryName", "Extended Price")
                .Build("Query 1");
            sqlDataSource.Queries.Add(selectQuery);
            sqlDataSource.Fill();
            dashboard.DataSources.Add(sqlDataSource);