Build MVC Applications with Connectivity to CircleCI 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 CircleCI 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 MvcAPIApp.

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

6. Specify the required connection string properties.

   Using API Key Authentication

   CircleCI uses personal API tokens to authenticate API requests. To generate a personal API token, log in to your CircleCI account, navigate to User Settings > Personal API Tokens, and click Create New Token. Copy the token value immediately as it is only shown once.

   After setting the following connection properties, you are ready to connect:

   • AuthScheme: Set this to APIKey.
   • APIKey: Set this to your CircleCI personal API token.

   Example connection string:

   Profile=C:\profiles\CircleCI.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_personal_api_token';
   

   A typical connection string is below:

   Profile=C:\profiles\CircleCI.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_personal_api_token';

   👁 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 APIEntities.

   👁 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, Artifacts 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, Artifacts.
   • 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 Artifacts records at http://MySite/Artifacts. With every state change the site picks up any data changes. 👁 The live table. (QuickBooks is shown.)