Build MVC Applications with Connectivity to Sage 300 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 Sage 300 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 MvcSage300App.

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

6. Specify the required connection string properties.

   Sage 300 requires some initial setup in order to communicate over the Sage 300 Web API.

   • Set up the security groups for the Sage 300 user. Give the Sage 300 user access to the option under Security Groups (per each module required).
   • Edit both web.config files in the /Online/Web and /Online/WebApi folders; change the key AllowWebApiAccessForAdmin to true. Restart the webAPI app-pool for the settings to take.
   • Once the user access is configured, click https://server/Sage300WebApi/ to ensure access to the web API.

   Authenticate to Sage 300 using Basic authentication.

   Connect Using Basic Authentication

   You must provide values for the following properties to successfully authenticate to Sage 300. Note that the provider reuses the session opened by Sage 300 using cookies. This means that your credentials are used only on the first request to open the session. After that, cookies returned from Sage 300 are used for authentication.

   • Url: Set this to the url of the server hosting Sage 300. Construct a URL for the Sage 300 Web API as follows: {protocol}://{host-application-path}/v{version}/{tenant}/ For example, http://localhost/Sage300WebApi/v1.0/-/.
   • User: Set this to the username of your account.
   • Password: Set this to the password of your account.

   A typical connection string is below:

   User=SAMPLE;Password=password;URL=http://127.0.0.1/Sage300WebApi/v1/-/;Company=SAMINC;

   👁 The connection for the model. (QuickBooks is shown.)
   

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

   👁 The completed connection step in the ADO.NET Entity Data Model wizard. (A QuickBooks connection is shown.)
   
8. Select the views you need. In this example, OEInvoices is imported. Also, the option to pluralize object names is deselected in this example. Click Finish to create the .edmx file.👁 Tables to be imported into the .edmx file. (QuickBooks is shown.)
   
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, OEInvoices.
   • Data context class: Select your context class.
3. Leave the default values for the other fields. 👁 Creating a new controller from an existing entity data model in the Add Controller dialog in MVC 5. (QuickBooks is shown.)
   

You can now access the list of OEInvoices records at http://MySite/OEInvoices. With every state change the site picks up any data changes. 👁 The live table. (QuickBooks is shown.)