Build MVC Applications with Connectivity to Epicor Kinetic Data

In this article, we will guide you through the process of utilizing wizards within Visual Studio to seamlessly integrate the CData ADO.NET Provider for Epicor Kinetic into a basic 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 MvcepicorKineticApp.

2. If you are using Entity Framework 6, you will need to take the preliminary step of registering the Epicor Kinetic 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 epicorKineticModel.
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 Epicor Kinetic Data Source in the dialog that is displayed.

6. Specify the required connection string properties.

   To successfully connect to your ERP instance, you must specify the following connection properties:

   • Url:the URL of the server hosting your ERP instance. For example, https://myserver.EpicorSaaS.com
   • ERPInstance: the name of your ERP instance.
   • User: the username of your account.
   • Password: the password of your account.
   • Service: the service you want to retrieve data from. For example, BaqSvc.

   In addition, you may also set the optional connection properties:

   • ApiKey: An optional key that may be required for connection to some services depending on your account configuration.
   • ApiVersion: Defaults to v1. May be set to v2 to use the newer Epicor API.
   • Company: Required if you set the ApiVersion to v2.

   A typical connection string is below:

   Service=Erp.BO.CustomerSvc;ERPInstance=MyInstance;URL=https://myaccount.epicorsaas.com;User=username;Password=password;InitiateOAuth=GETANDREFRESH

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 epicorKineticEntities.

8. Select the tables and views you need. In this example, Customers 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

Once you've established the model and completed the project build, you can employ ASP.NET Scaffolding wizards to generate both 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, Customers.
   • Data context class: Select your context class.
3. Leave the default values for the other fields.