Summary: This document provides basic information about the extension providing Entity Framework support for C# and VB.NET

Description

This extension provides support for Entity Framework. The calculation of Automated Function Points for your .NET analyses will be supplemented through the creation of new objects and links specific to Entity Framework framework that will link back to objects/links produced by the base .NET analyzer.

In what situation should you install this extension?

If your .NET application contains Entity Framework source code and you want to view these object types and their links, then you should install this extension. More specifically the extension will identify:

"use" links from Entity Framework objects to participating Database tables
"rely on" links from C#/VB.NET Classes to Entity Wrapper objects

Entity Framework support

Entity Framework is delivered with the .NET Framework. Therefore the following .NET frameworks are supported by this extension:

Version	Supported
3.0 and above

Supported Annotations in code-first

'System.Data.Linq.EntityMapping.TableAttribute',
'System.Data.Objects.DataClasses.EdmEntityTypeAttribute',
'System.Data.Objects.DataClasses.EdmTypeAttribute.Name',
'System.ComponentModel.DataAnnotations.TableAttribute',
'System.ComponentModel.DataAnnotations.Schema.TableAttribute'
'System.ComponentModel.DataAnnotations.Schema.NotMapped',
'System.ComponentModel.DataAnnotations.Schema.NotMappedAttribute',
'System.ComponentModel.DataAnnotations.NotMappedAttribute'

Supported methods in fluent api

System.Data.Entity.DbModelBuilder.Entity<TEntityType>()
System.Data.Entity.DbModelBuilder.Conventions.Remove<TConvention>()
System.Data.Entity.DbContext.OnModelCreating( DbModelBuilder modelBuilder )
System.Data.Entity.ModelConfiguration.EntityTypeConfiguration<TEntityType>.ToTable(String)

Supported tags in .edmx file

<edmx:StorageModels>
	<EntityType>
	<Property>
	</Property>
	</EntityType>
</edmx:StorageModels>

<edmx:ConceptualModels>
	<EntityType>
	<Property>
	</Property>
	</EntityType>
</edmx:ConceptualModels>

<edmx:Mappings>
	<MappingFragment>
	<ScalarProperty>
	</ScalarProperty>
	</MappingFragment>
</edmx:Mappings>

Function Point, Quality and Sizing support

This extension provides the following support:

Function Points (transactions): a green tick indicates that OMG Function Point counting and Transaction Risk Index are supported
Quality and Sizing: a green tick indicates that CAST can measure size and that a minimum set of Quality Rules exist

Function Points (transactions)	Quality and Sizing

CAST AIP compatibility

This extension is compatible with:

CAST AIP release	Supported	Supported Technology
8.3.x		C# and VB.NET
8.2.x		C# and VB.NET

Supported DBMS servers

This extension is compatible with the following DBMS servers:

DBMS	Supported
CSS/PostgreSQL
Oracle
Microsoft SQL Server

Prerequisites

An installation of any compatible release of CAST AIP (see table above)

Bug Fix List

Please see Entity Framework 1.1 - Bug Fix List.

Download and installation instructions

Include the extension using the interface in AIP Console:

CAST AIP Technologies > Entity Framework support for CSharp and VB.NET - 1.1 > include.jpg

There is nothing further to do. Follow the instructions below to run a new analysis/snapshot to generate new results:

CAST Transaction Configuration Center (TCC) configuration

In Entity Framework ≥ 1.1, if you are using the extension with CAST AIP ≥ 8.3.x, a set of Entity specific items are now automatically imported when the extension is installed. These items will be available in the CAST Transaction Configuration Center (click to enlarge):

CAST AIP Technologies > Entity Framework support for CSharp and VB.NET - 1.1 > entry_points.jpg

Manual import action for CAST AIP ≤ 8.2.x (optional)

Locate the .TCCSetup file in the extension folder: Configuration\TCC\DotNet_Entity.TCCSetup
In the CAST Transaction Configuration Center, ensure you have selected the Templates node:

CAST AIP Technologies > Entity Framework support for CSharp and VB.NET - 1.1 > templates.jpg

This .TCCSetup file is to be imported into the CAST Transaction Calibration Center using either the:
- File > Import Configuration menu option:

CAST AIP Technologies > Entity Framework support for CSharp and VB.NET - 1.1 > TCC1.jpg

- Or right clicking on the Template node and selecting Import Configuration:

CAST AIP Technologies > Entity Framework support for CSharp and VB.NET - 1.1 > TCC2.jpg

The import of the "DotNet_Entity.TCCSetup" file will provide you with a sample Transaction End point in the Free Definition node under Templates (click to enlarge):

CAST AIP Technologies > Entity Framework support for CSharp and VB.NET - 1.1 > entry_points.jpg

Now right click the one of the items and select copy:

CAST AIP Technologies > Entity Framework support for CSharp and VB.NET - 1.1 > copy.jpg

Paste the item into the equivalent node under the Application, for example, below we have copied it into the Application MEUDON:

CAST AIP Technologies > Entity Framework support for CSharp and VB.NET - 1.1 > paste.jpg

Repeat the copy / paste process for all items.

Packaging, delivering and analyzing your source code

Once the extension is installed, no further configuration changes are required before you can package your source code and run an analysis. The process of packaging, delivering and analyzing your source code does not change in any way:

Package and deliver your application (that includes source code which uses the Entity Framework) in the exact same way as you always have. You can refer to the existing official CAST documentation for more information about this - see: http://doc.castsoftware.com/display/DOC82/Source+Code+Delivery+Guide+for+Application+Teams.
Analyze your delivered J2EE application source code in the CAST Management Studio in the exact same way as you always have - the source code which uses Silverlight will be detected and handled correctly. You can refer to the existing official CAST documentation for more information about configuring an analysis - see: http://doc.castsoftware.com/display/DOC82/2.+Application+Analysis+Process+with+CAST+AIP

What results can you expect?

Once the analysis/snapshot generation has completed, you can view the results in the normal manner. The following objects and links will be displayed in CAST Enlighten:

Objects

Icon	Object type
	Entity Wrapper
	Conceptual Model
	Conceptual Class
	Conceptual Property
	Database Object
	Mapping Model
	Mapping Class
	Mapping Property
	Storage Model
	Storage Model Table
	Storage Model Property

Links

Source

Link type

Target

Example

Public C#/VB.NET class

Rely on

Entity object

Because CAST cannot be absolutely certain that the C#/VB.NET class is "entity associated", these rely-on links will always be flagged as "dynamic" and will therefore always appear in the Dynamic Link Manager for review.

Entity object

Use

Database table

CAST AIP Technologies > Entity Framework support for CSharp and VB.NET - 1.1 > entity_example2.jpg

Class property get/set

Call

Conceptual property

CAST AIP Technologies > Entity Framework support for CSharp and VB.NET - 1.1 > entity_example3.jpg

Conceptual property

Call

Storage Model Property via Mapping Property

CAST AIP Technologies > Entity Framework support for CSharp and VB.NET - 1.1 > entity_example4.jpg

Storage Model Property

Use

Database table

CAST AIP Technologies > Entity Framework support for CSharp and VB.NET - 1.1 > entity_example5.jpg

Limitations

In this section we list the most significant functional limitations that may affect the analysis of applications using Entity Framework:

Analyzing the participating database tables is mandatory for the extension to work correctly.
No support for links between LINQ and SQL objects
Entity Framework objects are not correctly presented in the CAST Engineering Dashboard.
Enum Collections are not supported.
DBContexts are not supported.
Not all Entity Framework and Entity Core namespaces are supported and the analysis log may contain warning about these missing namespaces.