How To: NopCommerce Best Practices for Order table
NopCommerce Versions: 3.7
NOTE: DRAFT IN PROGRESS
The Order table captures both registered Customers and Guest orders.
Registered Customer Orders will use the Customer.Id associated to them at registration. During checkout, users are prompted for the billing and shipping address. The billing and shipping Address records are duplicated as point in time records and associated to the Order.
Guest Checkout Orders orders will leave a cookie on the client with a generated ID that was created in the Customer table. The Next time the registered Guest user comes to the site and places an order as Guest, it will use the originally created Customer.Id to use and associate to the Order. If the user decides to register at this point, it will use the originally created Customer record associated to the cookie.ID to be used for the newly registered account.
You will find that any time an order is placed, a point in time copy of a billing and shipping address record is created and associated to the order. This allows the order to have historical records at that point in time. The created address will not by modified again.
Table: Order
- AffiliateId (int, 4)
- AllowStoringCreditCardNumber (bit, 1)
- AuthorizationTransactionCode (nvarchar, not null)
- AuthorizationTransactionId (nvarchar, not null)
- AuthorizationTransactionResult (nvarchar, not null)
- BillingAddressId (int, 4)
- CaptureTransactionId (nvarchar, not null)
- CaptureTransactionResult (nvarchar, not null)
- CardCvv2 (nvarchar, not null)
- CardExpirationMonth (nvarchar, not null)
- CardExpirationYear (nvarchar, not null)
- CardName (nvarchar, not null)
- CardNumber (nvarchar, not null)
- CardType (nvarchar, not null)
- CheckoutAttributeDescription (nvarchar, not null)
- CheckoutAttributesXml (nvarchar, not null)
- CreatedOnUtc (datetime, 8)
- CurrencyRate (decimal, 9)
- CustomerCurrencyCode (nvarchar, not null)
- CustomerId (int, 4)
- CustomerIp (nvarchar, not null)
- CustomerLanguageId (int, 4)
- CustomerTaxDisplayTypeId (int, 4)
- CustomValuesXml (nvarchar, not null)
- Deleted (bit, 1)
- ForEndCustomerCompanyAddressId (int, 4, not null)
- ForEndCustomerCompanyId (int, 4, not null)
- ForResellerCompanyAddressId (int, 4, not null)
- ForResellerCompanyId (int, 4, not null)
- ForResellerCompanyTypeId (int, 4, not null)
- Id (PK, int, 4)
- IsTransferable (bit, 1)
- MaskedCreditCardNumber (nvarchar, not null)
- OrderDiscount (decimal, 9)
- OrderGuid (uniqueidentifier, 16)
- OrderShippingExclTax (decimal, 9)
- OrderShippingInclTax (decimal, 9)
- OrderStatusId (int, 4)
- OrderSubTotalDiscountExclTax (decimal, 9)
- OrderSubTotalDiscountInclTax (decimal, 9)
- OrderSubtotalExclTax (decimal, 9)
- OrderSubtotalInclTax (decimal, 9)
- OrderTax (decimal, 9)
- OrderTotal (decimal, 9)
- PaidDateUtc (datetime, 8, not null)
- PaymentMethodAdditionalFeeExclTax (decimal, 9)
- PaymentMethodAdditionalFeeInclTax (decimal, 9)
- PaymentMethodSystemName (nvarchar, not null) - This is the name of the plugin system name used to do the payment. Example: Payments.PurchaseOrder (Nop.Plugin.Payments.Manual), Payments.Manual (Nop.Plugin.Payments.Manual).
- PaymentStatusId (int, 4)
- PickUpInStore (bit, 1)
- RefundedAmount (decimal, 9)
- RewardPointsWereAdded (bit, 1)
- ShippingAddressId (int, 4, not null)
- ShippingMethod (nvarchar, not null)
- ShippingRateComputationMethodSystemName (nvarchar, not null)
- ShippingStatusId (int, 4)
- StoreId (int, 4)
- SubscriptionTransactionId (nvarchar, not null)
- TaxRates (nvarchar, not null)
- VatNumber (nvarchar, not null)
Related Tables:
- OrderItem
- OrderNote
- GenericAttribute
Uses:
- Check Out > Registered User:
- Checkout > Guest:
- Admin > Order:
Extending:
How To: NopCommerce Best Practices for Address table
NopCommerce Versions: 3.7
Note: This is a draft version in progress.
Description: The Address table is used for capturing Address information for Registered Customers, Guest Checkout Customers and Orders.
- The best way to think about the Address table is that it has multi-state data meaning the Address data can be point in time created and associated with an Order and won't change again or current data that represents the current Address of a customer. Every time an order is created a snapshot point in time Address record is created (Duplicated) for the Billing Address and Shipping Address.
Table: Address
- Address1 (nvarchar, not null)
- Address2 (nvarchar, not null)
- City (nvarchar, not null)
- Company (nvarchar, not null)
- CompanyId (int, 4, not null)
- CountryId (int, 4, not null)
- CreatedOnUtc (datetime, 8)
- CustomAttributes (nvarchar, not null)
- Email (nvarchar, not null)
- FaxNumber (nvarchar, not null)
- FirstName (nvarchar, not null)
- Id (PK, int, 4)
- LastName (nvarchar, not null)
- PhoneNumber (nvarchar, not null)
- StateProvinceId (int, 4, not null)
- ZipPostalCode (nvarchar, not null)
Related Tables:
- AddressAttribute
- AddressAttributeValue
- CustomerAddresses
Uses:
- Retail Site > My Account > Addresses
- Customer Entity > Checkout
- Admin > Customer > Addresses
Extending:
- The Address table already contains an extensive common set of information relating to addresses. Instead of modifying the table, you should add a table that has a foreign key to the Address table but is also the primary key.
How To: NopCommerce Best Practices for Customer table
NopCommerce Versions: 3.7
NOTE: DRAFT IN PROGRESS
Description:
The Customer table is used for capturing both registered and non registered users of the system. For registered users, it only contains a small set of information usch as Username, Email, and password as shown below. Additional information relating to the customer such as First Name, Last Name and Gender is captured in the GenericAttribute table. The different way Customer information is entered are:
- When a user goes through the Retail > Register process a record is created in the Customer table.
- When a user does a Checkout > Guest Checkout (not logged in) they will have a generic empty record added. The Username, Email, Password, PasswordSalt, AdminContent, SystemName, LastLoginDateutc fields are set as NULL. The Id, CustomerGuid, PasswordFormatId, IsTaxExempt, AffiliateId, VendorId, HasShoppingCartItems, Active, Deleted, IsSystemAccount, LastIpAddress, CreatedOnUtc, LastActivityDateUtc, BillingAddress_id, ShippingAddress_Id are set. New Billing and Shipping Address records are created and then associated to the new Customer record.
- Guest Checkout Orders orders will leave a cookie on the client with a generated ID that was created in the Customer table. The Next time the registered Guest user comes to the site and places an order as Guest, it will use the originally created Customer.Id to use and associate to the Order. If the user decides to register at this point, it will use the originally created Customer record associated to the ID to be used for the new registered to the account.
- Admins going through Administration > Customer > New and
Table: Customer
- Active (bit, 1)
- AdminComment (nvarchar, not null)
- AffiliateId (int, 4)
- BillingAddress_Id (int, 4, not null)
- CompanyId (int, 4, not null)
- CreatedOnUtc (datetime, 8)
- CustomerGuid (uniqueidentifier, 16)
- CustomerTypeId (int, 4, not null)
- Deleted (bit, 1)
- Email (nvarchar, 2000, not null)
- HasShoppingCartItems (bit, 1)
- Id (PK, int, 4)
- IsSystemAccount (bit, 1)
- IsTaxExempt (bit, 1)
- LastActivityDateUtc (datetime, 8)
- LastIpAddress (nvarchar, not null)
- LastLoginDateUtc (datetime, 8, not null)
- Password (nvarchar, not null)
- PasswordFormatId (int, 4)
- PasswordSalt (nvarchar, not null)
- ShippingAddress_Id (int, 4, not null)
- SystemName (nvarchar, 800, not null)
- Username (nvarchar, 2000, not null)
- VendorId (int, 4)
Related Tables:
- Customer_CustomerRole_Mapping
- CustomerAddressess
- CustomerAttribute
- CustomerAttributeValue
- CustomerRole
- CustomerType
Uses:- Retail Site > Register:
- Checkout > Guest:
- Admin > Customer:
Extending:- If you are need to capture information relating to the user, you can capture information in the GenericAttribute table, but beware of the GenericAttribute tables usages. WARNING: storing data in here does not enforce referential integrity. You might want to consider the below option of creating a new table with foreign keys if you need data integrity.
- If you need to enforce referential integrity, instead of adding columns to the Customer table, add a second Table with the foreign key to the Customer table and set it as the Primary Key and then add your custom columns to that new table.
How To: NopCommerce Best Practices for GenericAttribute table
NOTE: DRAFT IN PROGRESS
Description:
A generic storage table for long term and short term data for any
entity in NopCommerce that inherits from BaseEntity. But be careful how you use this table or
what you do with it because it has both long term and short term data and not understanding the of the data that's stored could cause issues.. The GenericAttribute table can persist long term Customer data such as First Name, Last Name and Gender. You can use the GenericAttribute table to persist the long term order data but the
KeyGroup must be Order and the EntityId represents the OrderId
Table: GenericAttribute
- Id (int, identity, not null, pk)
- EntityId (int, not null)
- KeyGroup (nvarchar(400), not null)
- Key (nvarchar(400), not null)
- Value (nvarchar(max), not null)
- StoreId (int, not null) - Settings Store to 0 means all stores
Related Tables:
Uses:- Customer Entity : Register : You'll find that it stores long term information like Gender, FirstName, LastName and more on customers who have registered. Note that StoreId is set 0 which means it applies to all stores. This is long term storage meaning it won't change unless change are made by the user specifically.
- Long Term Records:
- KeyGroup: Customer
- Key's are:
- Gender
- FirstName
- LastName
- DateOfBirth
- Customer Entity : Checkout : You'll find that it temporarily stores short term data such as a a user selections as you transitions from one section to the next during the checkout process for that customer. Any values stored during this will be overwritten by the next order for that customer.
- Temporary Records:
- KeyGroup: Customer
- Key's are:
- SelectedPickUpInStore
- UseRewardPointsDuringCheckout
Extending:- The GenericAttribute table is well, generic by nature. Extending it probably is not necessary. However be warned that it does not enforce referential integrity and I would probably try to avoid if possible..
How To : NopCommerce Best Practices for Database Updates using Entity Framework.
Compatible With: NopCommerce 3.7
These instructions will help you setup Entity Framework Migrations on the Nop.Data project with the assumption that you did a NopCommerce 3.7 fresh default database setup install with or without sample data. The NopCommerce default database install will be the base used.
Enabling Entity Framework Migrations will allow you to apply Entity Framework Code First to the database to update the default NopCommerce schema. The benefits are that you have a starting point database with NopCommerce and any changes that you apply after that are captured as individual database changes that are applied to the NopCommerce Default database. The Migrations can be reapplied later on to a Fresh NopCommerce install using the migrations.
Prerequisites:
- Fresh NopCommerce 3.7 Source Code Installed
- Fresh NopCommerce 3.7 Database Installed with or without sample data
Getting Started:
- Open NopCommerce Solution
- Change Presentations\Nop.Web\Web.Config to point to the database you want to use.
<connectionStrings>
<add name="NopCommerce" providerName="System.Data.SqlClient" connectionString="Data Source=.;Initial Catalog=NopCommerce37;Integrated Security=False;User Id=sa;Password=yourpassword;MultipleActiveResultSets=True" />
</connectionStrings>
- Open Package Manager Console
- Set Default project: Nop.Data
- Type: Enable-Migrations - this will create a folder called Migrations under the Nop.Data project.
- Type: Add-Migration “InitialDatabaseSnapshot” –IgnoreChanges
Note: The –IgnoreChanges switch will tell our Nop.Data project to not compare the Nop.Data Migrations against the current database. Because we don't have any existing migrations, by not using the "-IgnoreChanges", it would create all the code to regenerate all the tables from NopCommerce duplicating what NopCommerce will create by default. Our Migrations are meant to capture changes moving forward after the default NopCommerce 3.7 Database is setup and be easily reapplied.
After you have ran this, the Nop.Data project will have a new folder called Migrations with two new files:
- Configuration.cs
- {DateTimeStamp}_InitialDatabaseSnapshot.cs – Initial place holder for Migrations. This has an empty Up() and Down() method intentionally because we used the "-IgnoreChanges" switch in our command earlier. It assumes that Created the tables and sample data and anything moving forward is newly added.
Next Steps: Applying the changes to the database
In Package Manager Console:
You should receive a confirmation that the project is ready.
This will enable Migrations in the database by adding a __Migrations table. The __Migrations table is a history of Migration changes applied to it. The newly added migration we created earlier InitialDatabaseSnapshot will to be applied to the default NopCommerce 3.7 database we setup earlier, but since we did the -IgnoreChanges switch, the {DateTimeStamp}_InitialDatabaseSnapshot.cs contains no code in Up() or Down(), so no changes are applied to the database with the exception of the newly added __Migrations table which is what we want. If you open the new __Migrations table, it will have a single record for the InitialDatabaseSnapshot migration that was applied to the database. Now that a record was captured for InitialDatabaseSnapshot, it will never be applied again to the database..
Your database and solution is now ready for Code First Updates using Migrations.
Next Steps:
ADDING A NEW ENTITY AND RUNNING ADD-MIGRATION
Important: These instructions will create Migrations code to generate tables after the adding of new Entities
Prerequisite:
- Added a newly Entity Person (Example: Person.cs) to the Nop.Core\Domain\Custom;
Steps:
- Open Presentations\Nop.Web\Web.Config and verify the connection string that it is pointing to the database you want to use.
- Open: Package Manager Console
- set Default Project: Libraries\Nop.Data
- Type: Add-Migration “SomeDescriptionHere”
- Example: Add-Migration “Add New Person Entity”
NOTE: After you run “Add-Migration”, the Nop.Data project will have a new file called
- {DateTimeStamp}_AddNewPersonEntity.cs
This new file contains code to generate any new tables from new Entities you have defined in Entity Framework in the Up () method and code to remove tables in the Down() method.
• Type: Update-Database
This will cause the newly added migration AddNewPersonEntity to be applied to the database and a new table called Person tables to be created. The AddNewPersonEntity migration will be tracked in the __Migrations table so it’s never applied again.
Numbers To Words Generator - C# Project
Numbers to Words is a C# project that takes a number and converts it to a word.
NOTE: THIS WAS DONE IN 3 HOURS FOR A TEST SO IT IS IN NO WAY SHAPE
OR FORM CLEANED OR OPTIMIZED OR BEST PRACTICES. HOWEVER, THIS PROJECT WAS BUILT DOING TDD (Test Driven Development) SO THERE A LOT OF TESTS TO VALIDATE IT AND SHOWS THE VALUE OF UNIT TESTS.
Example: (1000000 generates the words "One Million")
Project examples:
Ones (Example: 3 returns "Three")
Tens (Example: 14 returns "Fourteen")
Hundreds (Example: 397 returns "Three Hundred Ninety Seven")
Thousands (Example: 7923 returns "Seven Thousand Twenty Three")
Ten Thousands (Example: 22222 returns "Twenty Two Thousand Two Hundred Twenty Two")
Hundred Thousands (Example: 832935 returns "Eight Hundred Thirty Two Thousand Nine Hundre Thirty Five")
Millions (Example: 9882235 returns "Nine Million Eighty Hundred Eighty Two Thousand Two Hundred Thirty Five")
Billions (Example: 1012345678 returns "One Billion Twelve Million Three Hundred Fourty Five Thousand Six Hundred Seventy Eight")
Also supports decimal. but in percent. Have fun.
Source Code : https://github.com/Gigundo/Numbers-to-Words
How To : ASP.NET MVC With Microsoft Identity with a GUID Id and Unity Injection
This downloadable project contains the code to do ASP.NET Identity with a GUID ID and doing Unity Injection
Download File: AspNet Identity Working with GUID ID and Unity Injection Final.zip (8.2MB)
Previous Version for default ASP.NET Identity is available :
http://www.enterpriseframework.com/post/how-to-asp-net-mvc-with-microsoft-identity-and-unity-bootstrapper
Scenario:
We have a Web Service which talks to a 3rd party service and receives json where the property names that are not standard to our organization. We don't want the overhead of created multiple DTO objects to support transformations.
Example:
{"office_code" : "ABC1234"} (office_code needs to be "Code")
We have to take the incoming json and deserialize to a organization standard POCO and run rules to it and serialize it again back out to the organization so it would now look like:
Example: {"Code" : "ABC1234"}
The workflow:
3rd Party Json => Our Web Service => Run Rules => Serialize to Internal consumer using company standard naming
so:
{"office_code" : "ABC1234"} => POCO Deserialzied to {"Code" : "ABC1234"} => Run Rules => POCO Serialized {"Code" : "ABC1234"}
example:
Our Original POCO looks like: If I Serialize it as is, it will have
Code serialized to
office_code which what I don't want. I want to stay as
Code [DataContract]
public class Test
{
[DataMember]
public int Id { get; set; }
[DataMember]
public string Name { get; set; }
[DataMember]
public string Description { get; set; }
[DataMember]
public string Whatever { get; set; }
[DataMember]
[JsonProperty("office_code")]
public string Code { get; set; }
}
Updated Test Object by adding a private method called _code with Attributes and method
[DataMember]
[JsonProperty("office_code")]
private string _code { get; set; }
Then updated the public string Code property to use the private property _code
[DataMember]
public string Code
{
get
{
return _code;
}
set
{
_code = value;
}
}
Microsoft Serializer and Newtonsoft both support a method called ShouldSerialize{Property} that is not heavily documented. We'll create a method for our _code property
public bool ShouldSerialize_code()
{
return false;
}You can deserialize Json office_code to C# _code but when you Serialize Test, it will not serialize _code
[DataContract]
public class Test
{
[DataMember]
public int Id { get; set; }
[DataMember]
public string Name { get; set; }
[DataMember]
public string Description { get; set; }
[DataMember]
public string Whatever { get; set; }
[DataMember]
public string Code
{
get
{
return _code;
}
set
{
_code = value;
}
}
[DataMember]
[JsonProperty("office_code")]
private string _code { get; set; }
public bool ShouldSerialize_code()
{
return false;
}
public bool ShouldSerializeWhatever()
{
return false;
}
}
Running the Test
using Microsoft.AspNet.Identity;
using Microsoft.AspNet.Identity.EntityFramework;
using Microsoft.AspNet.Identity.Owin;
using Microsoft.Practices.Unity;
using Newtonsoft.Json;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Net;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Runtime.Serialization;
using System.Threading.Tasks;
using System.Web.Http;
namespace Generic
{
public class BlahController : ApiController
{
[HttpGet]
public Test Get()
{
Test test1 = null;
//JSON Deserialization string {"Id":0,"Name":"Robert","Description":"Cool","office_code":"BlahBlahBlah"}
//office_code will be deserialized to a private property called _code
string deserializeFrom = "{\"Id\":0,\"Name\":\"Robert\",\"Description\":\"Cool\",\"office_code\":\"BlahBlahBlah\"}";
test1 = JsonConvert.DeserializeObject(deserializeFrom);
string serializeTo = JsonConvert.SerializeObject(test1);
//Results
// Json string to Serialized Object {"Id":0,"Name":"Robert","Description":"Cool","office_code":"BlahBlahBlah"}
// Serialized objec to json string {"Id":0,"Name":"Robert","Description":"Cool","Code":"BlahBlahBlah"}
//
Test test2 = new Test();
test2.Id = 0;
test2.Name = "Robert";
test2.Description = "Cool";
test2.Whatever = "How Annoying";
test2.Code = "BlahBlahBlah";
//test._code = "BlahBlahBlah" Inaccessible
return test2;
}
}
}