Ready to get started?

Learn more about the CData ADO.NET Provider for HPCC or download a free trial:

Download Now

Build MVC Applications with Connectivity to HPCC Systems Data

This article shows how to use only the Entity Framework and the CData ADO.NET provider to access HPCC Systems from an ASP.NET MVC application.

This article shows how to use wizards in Visual Studio to drop the CData ADO.NET Provider for HPCC Systems into a simple MVC (model, view, controller) project.

Create the Entity Framework Model

Follow the steps below to save connection properties and map tables to entities in the data model.

  1. Create a new MVC project in Visual Studio. In this example, the project name is MvcHPCCApp.
  2. If you are using Entity Framework 6, you will need to take the preliminary step of registering the HPCC Systems Entity Framework provider for your project. See the "LINQ and Entity Framework" chapter in the help documentation for a guide.

    Note that MVC 3 scaffolding and MVC 4 scaffolding do not support Entity Framework 6. You can use your scaffolding with Entity Framework 6 by upgrading to the latest version of MVC.

  3. To add the .edmx file from the designer, right-click your Models folder and click Add New Item. Select ADO.NET Entity Data Model, name the model, and click Add. In this example, the name of the model is HPCCModel.
  4. In the Entity Data Model wizard, select the option 'EF Designer from database'. The Entity Data Model wizard is displayed.
  5. Click New Connection. Select CData HPCC Systems Data Source in the dialog that is displayed.
  6. Specify the required connection string properties.

    To connect, set the following connection properties: Set URL to the machine name or IP address of the server and the port the server is running on, for example, https://server:port. The User and Password are required to authenticate to the HPCC Systems cluster specified in the URL. Note that LDAP authentication is not currently supported by our ODBC driver.

    Set Version to the WsSQL Web server version. Note that if you have not already done so, you will need to install the WsSQL service on the HPCC Systems server. The WsSQL Web service is used to interact with the underlying HPCC Systems platform.

    Set Cluster to the target cluster.

    A typical connection string is below:

    URL=http://127.0.0.1:8510;User=test;password=xA123456;Version=1;Cluster=hthor;
  7. Name the connection and select whether to include sensitive information, such as connection credentials, in the connection string. For simplicity, this example saves sensitive information in Web.config. The connection settings are saved as HPCCEntities.

  8. Select the views you need. In this example, hpcc::test::orders is imported. Also, the option to pluralize object names is deselected in this example. Click Finish to create the .edmx file.
  9. Build your project to complete this step.

Scaffold the Controller and Views

After creating the model and building the project, you can use ASP.NET Scaffolding wizards to create the controller and the views.

  1. In Solution Explorer, right-click the controllers folder and click Add -> Controller. Select MVC 5 Controller with views, using Entity Framework.
  2. In the Add Controller dialog that is then displayed, select the following options:

    • Model class: Select a table you imported; for example, hpcc::test::orders.
    • Data context class: Select your context class.
  3. Leave the default values for the other fields.

You can now access the list of hpcc::test::orders records at http://MySite/hpcc::test::orders. With every state change the site picks up any data changes.