Linq pour CommerceServer : merci CSMetal !

Mar 28

Linq pour CommerceServer : merci CSMetal !

Commerce Server, Développement Add comments

Salut! Si vous êtes nouveau, vous pouvez souscrire à mon flux RSS et ainsi être tenu au courant des derniers posts publiés.

Il y a déjà quelques semaines, Kerry Havas, Architecte Produit Commerce Server, a publié la version 2 de CSMetal.

Qu’est-ce que CSMetal ? C’est un utilitaire pour Commerce Server qui génère des classes fortement typées utilisable à travers un provider LINQ basé sur l’API Commerce Foundation => ie, ça ne remplace pas l’API Commerce Foundation !

Kerry frappe fort avec CSMetal, car le développement sous Commerce Server devient un “jeu d’enfant”!

Avant de pouvoir utiliser le provider LINQ pour Commerce Server, il nous faut auparavant générer les entités. Pour cela, nous devons utiliser l’outil de commande en ligne CSMetal.

Pour que CSMetal entre en action, il vous faut:

Le fichier ChannelConfiguration.config correctement configuré
- Attention de bien mettre la valeur de l’attribut useSharedCommerceContexts à false.
- Ajouter dans le noeud MessageHandler avec l’attribut name "CommerceQueryOperation_CommerceEntityDefinition" les noeuds enfant suivants:

<!-- Note that RepositoryMetadataLoader is replaced by a slightly customized one -->
<Component name="RepositoryMetadataLoader" type="Microsoft.Commerce.Metal.Generator.OperationSequenceComponents.RepositoryMetadataLoader, Microsoft.Commerce.Metal.Generator, Version=1.0.0.0, Culture=neutral" />
<!-- Note that this is added to add overlay capability to the Metadata repository -->
<Component name="MetadataOverlayProcessor" type="Microsoft.Commerce.Metal.Generator.OperationSequenceComponents.MetadataOverlayProcessor, Microsoft.Commerce.Metal.Generator, Version=1.0.0.0, Culture=neutral" />

Notez que le dernier noeud permet en gros de pouvoir générer d’autres entités ou attributs sans toucher au fichier MetadataDefinitions.xml. Nous y revenons plus bas.

Le fichier MetadataDefinitions.xml proprement mis à jour
- Ajouter au noeud RelationshipTypes, un noeud enfant :
  - <RelationshipType name="Inherits"/>
- Consultez le fichier “CSMetal_Beta2_ReadMe.rtf” pour ajouter à 2 entités:
  - Basket
    - les énumérations des status de commande
  - Ads
    - Les énumérations des tailles d’une publicité
Les “traditionnels” OrderObjectMappings.xml et OrderPipelineMappings.xml, eux aussi mis à jour.

Une fois ces ingrédients sous la main, mettez-les par exemple dans un répertoire temporaire. Ajoutez les fichiers nécessaires à la bonne exécution de CSMetal:

CSMetal.exe
CSMetal.exe.config qui est une copie du web.config de votre application web
GeneratorSettings.xml qui vous permet de définir les dossiers d’outputs pour les assemblies générées avec un namespace et un nom de context de votre choix!
Microsoft.Commerce.Metal.Generator.dll pour la génération de code

Soit:

Afin de bénéficier pleinement du Linq provider pour Commerce Server, nous avons certaines metadatas à faire évoluer ou créer. Pour cela, Kerry a introduit un concept très pratique appellé “MetaDataOverlays”:

Cela revient à étendre les metadatas via un fichier xml extérieur sans avoir à toucher à votre fichier MetadataDefinitions.xml. Dans le cas de notre provider Linq pour Commerce Server, nous avons un certains nombres d’entités à mettre à jour mais qui n’ont pas d’intéret à être dans le runtime de l’application web puisqu’utilisé uniquement par notre provider Linq.

Pour cela, dans le répertoire CSMetal ajouter un nouveau dossier enfant appellé MetadataOverlays et ajoutez-y le fichier xml Metadata_CSMetal.xml

<?xml version="1.0" encoding="utf-8" ?>
<!-- 
This file contains the Metadata Repository
-->
<MetadataDefinitions xmlns="urn:schemas-microsoft-multi-channel-commerce-foundation-metadata">
    <DefaultChannel>
        <CommerceEntities>
            <!-- Added for Linq based Search -->
            <CommerceEntity name="CatalogEntity">
                <DisplayName value="Catalog Entity" />
                <Properties>
                    <Property name="Phrase"    dataType="String">
                        <DisplayName value="Phrase"/>
                    </Property>
                    <Property name="ReturnTypes"    dataType="Integer">
                        <DisplayName value="Return Types"/>
                    </Property>
                    <Property name="FirstItem"    dataType="Integer">
                        <DisplayName value="First Item"/>
                    </Property>
                    <Property name="WhereClause"    dataType="String">
                        <DisplayName value="Where Clause"/>
                    </Property>
                    <Property name="TotalItemCount"    dataType="Integer">
                        <DisplayName value="Total Item Count"/>
                    </Property>
                    <Property name="ResultsPerPage"    dataType="Integer">
                        <DisplayName value="Results Per Page"/>
                    </Property>
                </Properties>
            </CommerceEntity>
            <!-- Added for Linq based Search -->
  
            <!-- Catalog Start -->
            <CommerceEntity name="Catalog">
                <Relationships>
                    <Relationship name="DependantCatalogs" type="Relationship" modelName="Catalog" isMultipleItems="true" >
                        <DisplayName value="Dependant Catalogs" />
                    </Relationship>
                    <Relationship name="SourceCatalogs" type="Relationship" modelName="Catalog" isMultipleItems="true" >
                        <DisplayName value="Source Catalogs" />
                    </Relationship>
                </Relationships>
            </CommerceEntity>
  
            <!-- CreditCard Start -->
            <CommerceEntity name="CreditCard">
                <Relationships>
                    <Relationship name="PaymentAccount" type="Inherits" modelName="PaymentAccount" isMultipleItems="false">
                    </Relationship>
                </Relationships>
            </CommerceEntity>
  
            <!-- Basket Start -->
            <CommerceEntity name="Basket">
                <Relationships>
                    <Relationship name="LineItems" modelName="LineItem" type="Relationship" isMultipleItems="true" />
                    <Relationship name="Addresses" modelName="Address" type="Relationship" isMultipleItems="true" />
                    <Relationship name="Payments" modelName="Payment" type="Relationship" isMultipleItems="true" />
                    <Relationship name="Shipments" modelName="Shipment" type="Relationship" isMultipleItems="true" />
                    <Relationship name="RequestedPromoCodes" modelName="RequestedPromoCode" type="Relationship" isMultipleItems="true" />
                </Relationships>
            </CommerceEntity>
  
            <!-- ShopperList Start -->
            <CommerceEntity name="ShopperList">
                <Relationships>
                    <Relationship name="LineItems" modelName="LineItem" type="Relationship" isMultipleItems="true" />
                </Relationships>
            </CommerceEntity>
  
            <!-- LineItem Start -->
            <CommerceEntity name="LineItem">
                <Relationships>
                    <Relationship name="ItemLevelDiscounts" modelName="Discount" type="Relationship" isMultipleItems="true" />
                </Relationships>
            </CommerceEntity>
  
            <!-- CashCard Start -->
            <CommerceEntity name="CashCard">
                <Relationships>
                    <Relationship name="PaymentAccount" type="Inherits" modelName="PaymentAccount" isMultipleItems="false">
                    </Relationship>
                </Relationships>
            </CommerceEntity>
  
            <!-- GiftCertificate Start -->
            <CommerceEntity name="GiftCertificate">
                <Relationships>
                    <Relationship name="PaymentAccount" type="Inherits" modelName="PaymentAccount" isMultipleItems="false">
                    </Relationship>
                </Relationships>
            </CommerceEntity>
  
            <!-- Shipment Start -->
            <CommerceEntity name="Shipment">
                <Relationships>
                    <Relationship name="ShippingMethod" modelName="ShippingMethod" type="Relationship" isMultipleItems="false" />
                </Relationships>
            </CommerceEntity>
  
            <!-- Payment Start -->
  
            <!-- PaymentAccount Start -->
            <CommerceEntity name="PaymentAccount">
                <Properties>
                    <Property name="Id" dataType="String">
                        <DisplayName value="Id"/>
                        <Description value="Unique ID of the payment." />
                    </Property>
                    <Property name="CustomerName" dataType="String">
                        <DisplayName value="CustomerName"/>
                        <Description value="Name of Customer." />
                    </Property>
                    <Property name="BillingAddressId" dataType="String">
                        <DisplayName value="BillingAddressId"/>
                        <Description value="Id of billing address" />
                    </Property>
                    <Property name="DisplayName" dataType="String">
                        <DisplayName value="DisplayName"/>
                        <Description value="DisplayName." />
                    </Property>
                </Properties>
                <Relationships>
                    <Relationship name="PaymentMethod" modelName="PaymentMethod" type="Relationship" isMultipleItems="false" />
                </Relationships>
            </CommerceEntity>
            
            <CommerceEntity name="Payment">
                <Relationships>
                    <Relationship name="PaymentAccount" modelName="PaymentAccount" type="Relationship" isMultipleItems="false" />
                </Relationships>
            </CommerceEntity>
        </CommerceEntities>
    </DefaultChannel>
</MetadataDefinitions>

Exécutez maintenant CSMetal.exe:

Dans le répertoire configuré dans le GeneratorSettings.xml, vous trouverez 3 fichiers .cs correspondant à vos entités Commerce Server :

Vous noterez un fichier odata généré qui sera particulièrement utile pour exposer nos données Commerce Server, mais cela fera l’objet de plusieurs autres posts Smile

Copiez les fichiers GeneratedContexts.cs et GeneratedTypes.cs générés par CSMetal dans le repertoire GeneratedTypes du projet CSMetalLinqProvider (ou mettez les dans les paramètres output de CSMetal, ie le fichier GeneratorSettings.xml, pour ne pas avoir à les copier) et relancez une compilation du projet CSMetalLinqProvider.

Vos entités sont maintenant générées et le provider Linq disponible Smile

Récuperer une catégorie reviens maintenant à:

var category = new CategoryContext(commerceServiceProxy)
                  .IncludeChildCategories()
                  .Single(o => o.Id=="Departments" && o.CatalogId==DefaultCatalog);
var childCategories = category.ChildCategories;

ou pour un produit :

var product = new ProductContext(commerceServiceProxy)
                 .Single(o=>o.CatalogId==DefaultCatalog && o.Id=="AW200-12")
var productCode = product.ProductCode;

Ce n’est qu’un petit échantillon de ce que l’on peut faire, et d’autres posts viendront bientôt vous montrer la puissance de ce provider Smile => Pour vos développeurs, plus besoin de connaitre en profondeur CS pour pouvoir l’attaquer et donc faciliter l’adoption de Commerce Server.