Discover how a bimodal integration strategy can address the major data management challenges facing your organization today.
Get the Report →Build MVC Applications with Connectivity to Reckon Accounts Hosted Data
This article shows how to use only the Entity Framework and the CData ADO.NET provider to access Reckon Accounts Hosted from an ASP.NET MVC application.
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 Reckon Accounts Hosted 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.
- Create a new MVC project in Visual Studio. In this example, the project name is MvcReckonAccountsHostedApp.
If you are using Entity Framework 6, you will need to take the preliminary step of registering the Reckon Accounts Hosted 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.- 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 ReckonAccountsHostedModel.
- In the Entity Data Model wizard, select the option 'EF Designer from database'. The Entity Data Model wizard is displayed.
- Click New Connection. Select CData Reckon Accounts Hosted Data Source in the dialog that is displayed.
Specify the required connection string properties.
The connector makes requests to Reckon Accounts Hosted through OAuth. Specify the following connection properties:
- SubscriptionKey: Required. You get this value when you created your developer account.
- CountryVersion: Defaults to 2021.R2.AU.
- CompanyFile: Required. The path to the company file.
- User: Required. The username of the company file.
- Password: Required. The password of the company file.
- InitiateOAuth: Set this to GETANDREFRESH to let the driver handle access tokens.
- CallbackURL: The redirectURI of your Custom OAuth App.
- OAuthClientId: The client id of your Custom OAuth App.
- OAuthClientSecret: The client secret of your Custom OAuth App.
CData provides an embedded OAuth application that simplifies OAuth desktop authentication. See the Help documentation for information on other OAuth authentication methods (web, headless, etc.), creating custom OAuth applications, and reasons for doing so.
A typical connection string is below:
SubscriptionKey=my_subscription_key;CountryVersion=2021.R2.AU;CompanyFile=Q:/CompanyName.QBW;User=my_user;Password=my_password;CallbackURL=http://localhost:33333;OAuthClientId=my_oauth_client_id;OAuthClientSecret=my_oauth_client_secret;InitiateOAuth=GETANDREFRESH
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 ReckonAccountsHostedEntities.
- Select the tables and views you need. In this example, Accounts is imported. Also, the option to pluralize object names is deselected in this example. Click Finish to create the .edmx file.
- 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.
- In Solution Explorer, right-click the controllers folder and click Add -> Controller. Select MVC 5 Controller with views, using Entity Framework.
- In the Add Controller dialog that is then displayed, select the following options:
- Model class: Select a table you imported; for example, Accounts.
- Data context class: Select your context class.
-
Leave the default values for the other fields.