# IceCube 2

Une documentation complémentaire est présente dans [ARRR](http://arrr.mediaspole.local/)

## Database

| Table | Description |
| ------------- | -------------------------------------------------- |
| AssetCategory | Dossiers virtuels ou sont catégorisés les fichiers |
| AssetVersioning | Version des fichiers |
| AssetCategory | Applications et favoris personalisés affiché sur la page d'accueil du BO |
| BOAuthProviders | - |
| BOContentActions | - |
| BOEventLog | Log des actions faites dans le BO |
| BOEventLogModification | Log des modifications faites dans le BO |
| BOFavorites | Lien des favoris affiché sur la page d'accueil de la BO |
| BookEntry | Réservations |
| BookResource | Types de réservations |
| BookResourceRule | Plages horaires autorisé pour un type de réservations |
| BOSession | Session du BO |
| Category | Catégories pour les objets |
| CategoryItem | Valeurs pour les catégories de type sélection simple/multiple |
| CategoryItemXObject | Table de liaison entre un objet et une valeur pour les catégories de type sélection simple/multiple |
| CategoryTab | - |
| CategoryXObject | - |
| CategoryXObjectType | Table de liaison entre un object et un catégorie |
| Choice | Type de variantes |
| ChoiceItem | Variantes |
| ChoiceItemName | Nom de la variante par langue |
| ChoiceName | Nom du type de variante par langue |
| ChoiceXObject | Table de liaison entre un type de variante et un objet |
| ContentGlossary | Glossaire |
| ContentTypeXTemplate | - |
| ContentVariables | Variables |
| Country | Pays |
| CountryGroup | Groupes de pays |
| CountryGroupXCountry | Table de liaison entre un groupe et un pays |
| Currency | Monnaies |
| CustomerActivationLinks | - |
| CustomerAuthProviders | - |
| CustomerGroup | Groupe de client |
| CustomerImportNewsletterLogs | - |
| CustomerMessages | - |
| CustomerMeters | - |
| CustomerPasswordLink | - |
| CustomerProperties | - |
| Customers | Clients |
| CustomersGroupsNavigationRights | Droits de navigation par groupe de clients |
| CustomersGroupsPathRights | Droit de fichiers par groupe de clients |
| CustomersNewsletter | Clients inscit à la Newletter interne |
| CustomersType | - |
| CustomersTypeCustomers | - |
| CustomerXMeter | - |
| CustomerXTag | - |
| CustomView | Vues personalisées |
| Document | Pages |
| ErrorLog | Log d'erreur |
| ExternalFeedItems | - |
| FileDownloadToken | - |
| FileMetaData | Fichiers |
| FileXObject | Table de liaison fichiers-objets |
| Form | Formulaires |
| FormField | Champs de formualire |
| FormFieldParameter | Paramètre des champs de formulaire |
| FormGroup | |
| FormList | |
| FormOption | |
| FormOptionStats | |
| FormResponse | |
| FormResponseCustomStatus | |
| FormXList | |
| GuestBook | |
| Images | Images |
| ImagesInGallery | Images dans une galleries |
| ImageTags | Tags sur une image |
| ImageXObject | Table de liaison images-objets |
| LinkedObjects | Table de liaison objets-objets |
| LinkedVideos | - |
| MasterPageApplication | - |
| MessagingExecutionContexts | - |
| MessagingProviders | - |
| MobileNavigation | - |
| MobileNavigationConfiguration | - |
| ModuleQuota | - |
| Modules | Modules |
| ModulesParameters | Paramètre des modules |
| Navigation | Navigation |
| NavigationAuthenticationProvider | - |
| NavigationCookieCondition | |
| NavigationScopes | Porté de navigation |
| News | Actualités |
| Newsletter | Liste de diffusion |
| NewsletterSent | - |
| NewsProperties | - |
| NewsXTag | - |
| Object | Objets |
| Object100XX | Objet personalisé (extension d'objet) |
| ObjectCategory | |
| ObjectLock | - |
| ObjectNotes | - |
| ObjectNumericRating | - |
| ObjectProperty | - |
| ObjectPropertyValue | - |
| ObjectType | Type d'objets |
| ObjectTypeMetaData | - |
| ObjectVersioning | Version de l'objet |
| ObjectXCustomer | - |
| ObjectXObjectList | |
| OrderIDCurrentValue | Valeur de l'id de la dernière commande |
| Orders | Commandes |
| PageContentTypes | Type de contenu par page |
| Parameters | Paramètres globaux |
| PaymentContext | - |
| PaymentWorkflow | - |
| PictureGallery | Gallerie d'images |
| PictureGalleryXTag | Tags sur galleries d'images |
| RecycleBinItem | Corbeil |
| S3Files | - |
| S3Queue | - |
| ScheduledTasks | - |
| SearchSurfaces | - |
| ShopCustomerDiscountLog | Log sur les code de réductions |
| ShopCustomerPoints | Points de réduction par clients |
| ShopCustomerPointsLog | Log sur les points de réductions |
| ShopCustomerPointsTokens | - |
| ShopDiscount | Code de réduction |
| ShopDiscountXCountry | Table de liaison code de réduction-Pays |
| ShopDiscountXProduct | Table de liaison code de réduction-Produit |
| ShopFee | Frais personalisé |
| ShopGMCCategories | Catégories Google Merchent Center |
| ShopGMCCategoryXObject | Table de liaison Catégories Google Merchent Center-Produit |
| ShopLinked | - |
| ShopLinkedObjects | - |
| ShopObjectLocation | Table de liaison produits-navigation |
| ShopPackages | Groupement de produits par paquet |
| ShopPaymentMethodRules | table de liaison -Pays |
| ShopPaymentMethods | Méthodes de paiement |
| ShopProductInventory | Stock |
| ShopProductPriceRule | - |
| ShopProductSKUInventory | - |
| ShopProductType | Type de produits |
| ShopReferral | - |
| ShopShipping | Frais de port |
| ShopShippingMethods | Méthodes d'envoi |
| ShopStock | - |
| ShopStockInventory | - |
| ShopTax | Taxes |
| ShopTaxXCountry | Table de liaison Taxes-Pays |
| ShortURLPairs | - |
| SitePartTemplateRule | - |
| Sqlog | - |
| State | - |
| SyncNavigationMap | - |
| SyncObjectMap | - |
| Tags | - |
| Template | Tempaltes |
| TitleStyle | Style des titres pour les blocs d'éditions |
| TranslationTerms | Noms des termes de traductions |
| TranslationTermValues | Valeurs des termes de traductions selon la langue |
| URLPairs | Moniker |
| Users | Utilisateurs |
| UsersClipboard | - |
| UsersGroupPathRights | Droits de fichier pour les groupes d'utilisateurs |
| UsersGroups | Groupes d'utilisteurs |
| UsersGroupsApplicationPermissions | Permission d'utilisation des application pour les groupes d'utilisateurs |
| UsersGroupsBookResourceRights | Permission des réservations selon les groupes d'utilisateurs |
| UsersGroupsFormRights | Permission des formulaires selon les groupes d'utilisateurs |
| UsersGroupsNavigationPermissions | Permission de navigation selon les groupes d'utilisateurs |
| UsersGroupsNavigationRights | Droits de navigation selon les groupes d'utilisateurs |
| UsersGroupsZoneRights | Droits des zones selon les groupes d'utilisateurs |
| UsersParameters | Paramètre supplémentaires pour les utilisateurs |
| UsersRights | Droits des utilisateurs |
| UsersXGroups | Table de liaison utilisateurs-groupes |
| Versioning | - |
| VideoConversionJob | Statut de progression pour la conversion d'une video |
| Zone | Zones |
| ZoneDomain | Domaine en fonctions des zones |

## Custom view

> BO / Objets / Vue personalisés

Les vues personalisé sont utilisées pour afficher un listing d'objets selon une requête SQL (une procédure stoquée la plupart du temps)

| Paramètre | Descitpion |
| --------- | ---------- |
| Nom | Nom dans le BO |
| Nom de la vue | Nom présent dans l'URL */Scripts/Modules/CustomView/List.aspx?name=**NomDeLaVue*** |
| Nom du bloc | Nom du bloc utilisé dans le template |
| Chemin d'accès du template | Chemin relatif du template depuis /htdocs |
| Type de réponse MIME | Si vide alors *text/html* |
| Chemin d'accès du template | Chemin relatif du template depuis /htdocs |
| Requêtes | Requête permettant la récupération des données |
| Paramètres | Paramètres passé à la requêtes: *Name,Type,DefaultValue* (séparé par *;* si plusieurs) |
| Repeater Callback Type | Type de répéteur utilisé par le template |
| Site Part ID | Type de l'objet retourné par la vue |

Certains paramètres de requêtes sont pré-définis: Voir "Paramètres pré-définis de requêtes" dans [ARRR](http://arrr.mediaspole.local/)

## Blocs dynamiques

Les blocs dynamiques sont utilisés pour afficher du contenu personalisé (non prévu par IC2), ils peuvent être appelé directement dans les templates ou peuvent être inséré dans un bloc depuis la zone d'édition.

Les bloc dynamiques sont définis dans le fichier *extension.config*

### Types de blocs

#### Repeater

Affiche les résultats d'une requête SQL.

<Part
ID="ProducerAll"
Type="IceCube.BuiltInParts.Repeater,IceCube_Business"
Enabled="true"
TemplatePath="Modules/Producer/Template/SmallListProducerAllProducts.html"
Query="exec Shop_ProducerAllProduct_s @ObjectID,@ZoneID,1,99"
RepeaterCallbackType="IceCube.Formatters.ShopV2Formatter.Callback, IceCube_Business"
BlockName="Objects"
QueryParameters="ObjectID,System.Int32,-1;ZoneID,System.Int32,-1"
/>

| Nom | Description |
| -------- | -------- |
| ID | Identifiant du bloc |
| Type | Type de bloc |
| Enabled | Actif |
| TemplatePath | Chemin du template depuis */htdocs* |
| Query | Requête permettant la récupération des données |
| RepeaterCallbackType | Type de répéteur utilisé par le template |
| BlockName | Nom du bloc utilisé dans le template |
| QueryParameters | Paramètres passé à la requêtes: *Name,Type,DefaultValue* (séparé par *;* si plusieurs) |

#### StatelessUserControl

Execute le code ASP/C# d'un fichier ascx.

<Part
ID="DLKEmptyCart"
Type="IceCube.BuiltInParts.StatelessUserControl, IceCube_Business"
Enabled="true"
ControlPath="~/Scripts/Modules/DLK/EmptyCart.ascx"
DesignTimeBrowsable="true"
/>
| Nom | Description |
| -------- | -------- |
| ID | Identifiant du bloc |
| Type | Type de bloc |
| Enabled | Actif |
| ControlPath | Chemin du script |
| DesignTimeBrowsable | Indique que ce bloque peut être inséré depuis la zone d'édition. |

#### DLL

Execute du code d'une DLL.

<Part
ID="StudentRegistration"
Type="Artionet.Customers.Euruni.StudentRegistration,Artionet.Customers.Euruni"
Enabled="true"
DesignTimeBrowsable="true"
/>

| Nom | Description |
| -------- | -------- |
| ID | Identifiant du bloc |
| Type | Type de bloc |
| Enabled | Actif |
| DesignTimeBrowsable | Indique que ce bloque peut être inséré depuis la zone d'édition. |

### UIControl

Permet d'ajouter des paramètres lorsque l'on ajoute un bloc dynamique depuis la zone d'édition.
Voir "Configuration de blocs dynamiques avec UIControl" dans [ARRR](http://arrr.mediaspole.local/).

## Répéteurs

| Nom | Description |
| -------- | -------- |
| ShopV2Formatter | Affiche des produits (moduel Shop) |
| ObjectFormatter | Affiche des objets avec leur propriétés |
| DocumentFormater | Affiche des pages avec leur propriétés |
| FormResponseFormatter | Affiche des résponse de formulaires |

## Requête SQL

Pour que le template puisse boucler sur les objets ainsi qu'accéder au différentes propriétés de ce dernier, il faut que la requête retourne obligatoirement ces 3 colonnes:

| Nom | Description |
| ---- | -------- |
| ID | ID de l'objet |
| RN | Row Number, ordre d'affichage de l'objet |
| TotalCount | Nombre total d'objets |

La colonne *NavIDOverride* permet de supplenter l'identifiant de navigation du context du template.

## Templating

Une syntax propre à IC2 est utilisé pour insérer du contenu dynamique dans une page HTML.
Voir "Syntaxe templating IC" dans [ARRR](http://arrr.mediaspole.local/).

## AppCustomization

Permet de s'abonner à des évènements afin de modifier le comportement standard.
Voir "Personnalisations avec AppCodeCustomization" dans [ARRR](http://arrr.mediaspole.local/).

L'abonnement au évènement peut se faire depuis */AppCode/Customization.cs* ou en héritant de la class `SiteCustomizationBase`.

Exemple:

[AppCodeExtension]
public class AppCodeCustomization
{
public static void Initialize()
{
// Subscribe to the event "TemplateLoaded"
RequestEvents.TemplateLoaded += new Action<ITemplate>(RequestEvents_TemplateLoaded);
}

static void RequestEvents_TemplateLoaded(ITemplate t)
{
// Do something...
}
}

### Evènements

| Nom | Déclanchement | Exemple d'utilisation |
| -------------------------------------------- | ------------------------------------ | -------------------------------------------------------------------------------------- |
| ShopEvents.Instance.* | Evènements liés au produits | |
| ShopEvents.Instance.CalculatedProductPrice | Calcule du prix d'un produit | Modifier le prix d'une produits selon la quantité présent dans le panier |
| ShopEvents.Instance.CalculatedShippingTotal | Calcule du prix des frais de ports | Modifier les frais de ports si >200 CHF |
| ShopEvents.Instance.EstimatedShippingMethods | Affiche les méthodes d'envoi | Cacher l'envoie par Poste si le client ne vie |
| ShopEvents.Instance.CalculatedPaymentMethods | Affiche les méthodes de paiement | Cacher le paimenet par facture si le client n'est pas solvable |
| ShopEvents.Instance.SavedOrderUI | Passage d'une étape à l'autre dans le processus de paiement | Setter une propriété de panier pour l'export |
| IndexerEvents.Instance.BeforeAdd | Avant l'ajout de l'index dans Lucene | Permet de ne pas indexer une page selon une condition avec `e.Object.CanIndex = false` |

**Exemple d'abonnement a un évènement personalisé (ici à chaque création, modification et suppression d'un document)**

ModuleUpdateHandler h = new ModuleUpdateHandler(UpdateHandler);
ModuleNotification flags = ModuleNotification.Create | ModuleNotification.Update | ModuleNotification.Delete;
ModuleUpdateDispatcher.Instance.SubscribeToNotifications(h, Module.Document, flags);

public static void UpdateHandler(object sender, ModuleUpdateEventArgs args)
{
//...
}

## Méthodes/Snippets utiles

### Méthodes

| Nom | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
| Common.Default.GetParameter / Common.Default.GetParameterInt / Common.Default.GetParameterBool / ... | Récupère un paramètre général |
| Common.GetRequestParameter / Common.GetRequestParameterInt / GetRequestParameterArray / Common.GetRequestParameterDate / Common.GetRequestParameterEnum / ... | Récupère un paramètre de requête |
| Common.SafeToString / Common.SafeToInt / Common.SafeToLong / ... | Essaie de convertir un objet dans le type désiré, sinon retourne une valeur par défaut |
| Common.IDZone | Récupère l'ID de la zone courrante |
| Translations.Instance.GetString | Récupère le terme de traduction |

### Parcourir les résultats d'une requête SQL

var results = Common.Default.GetDataViewByQuery(
"SELECT Name, Age FROM Person WHERE Age > @Age",
new SqlParameter("@Age", 18)
);

foreach (DataRowView result in results)
{
string name = Common.SafeToString(result["Name"]);
string age = Common.SafeToInt(result["Age"]);

// ...
}

### Parcourir un fichier XML

XPathDocument xPathDoc = new XPathDocument(PATH);
XPathNavigator xPathNavigator = xPathDoc.CreateNavigator();
XPathNodeIterator xPathIterator = xPathNavigator.Select("/Nodes/Node");

foreach (XPathNavigator image in xPathIterator)
{
string name = image.GetChildValueInt("Name");
string firstName = image.GetChildValue("FirstName");

// ...
}

public static string GetChildValue(this XPathNavigator xPathNavigator, string childNode)
{
XPathNavigator nav = xPathNavigator.SelectSingleNode(childNode);
return nav == null ? string.Empty : nav.Value;
}

### Créer une page + object avec propriétés

private static void CreatePage(string title)
{
IceCubeObjects o = new IceCubeObjects{ connString = Common.ConnectionString };
int newObjectID = o.CreateNewObject(TYPE_ID);

IceCubeObject iceCubeObject = new IceCubeObject
{
ID = newObjectID,
TypeID = TYPE_ID,
Title = title
};

o.Save(iceCubeObject);

CategorizationEditor ce = new CategorizationEditor { connString = Common.ConnectionString };
List<CategoryValue> categories = CreateCategories(category, gps, location, startDate, endDate, restriction, message, startDatePublication, endDatePublication, idFile, email, url);

ce.Save(newObjectID, TYPE_ID, categories, true);

CustomObjects.UpdateEditorTitle(newObjectID, TYPE_ID, title, categories, false);
}

private static List<CategoryValue> CreateCategories()
{
return new List<CategoryValue>
{
CreateCategoryValue(100, "John"),
CreateCategoryValueSS(101, 10),
CreateCategoryValueMV()
};
}

// Scalar value
private static CategoryValue CreateCategoryValue(int id, string value)
{
return new CategoryValue()
{
CategoryID = id,
SelectionType = Categorization.Instance.GetCategory(id.ToString(), "fr").SelectionType,
Value = value,
ValueAsString = value
};
}

// Single selection value
private static CategoryValue CreateCategoryValueSS(int id, int value)
{
return new CategoryValue()
{
CategoryID = id,
SelectionType = CategorySelectionType.SingleSelection,
Value = value
};
}

// Multiple selection value
private static CategoryValue CreateCategoryValueSS()
{
List<CategoryItemValue> values = new List<CategoryItemValue>();

values.Add(new CategoryItemValue(1333, "Name 1"));
values.Add(new CategoryItemValue(1334, "Name 2"));

return new CategoryValue()
{
CategoryID = id,
SelectionType = Categorization.Instance.Categories["100"][string.Empty].SelectionType,
Value = values
};
}

### Générer du contenu en fonction d'un template

var tpl = new ASPTemplate();
tpl.LoadFromFileOrResourceKey(PATH, "");

var formatter = new ShopV2Formatter();
formatter.Initialize(new Dictionary<string, string>()
{
{"RenderCustomer", "0"},
{"RenderImages", "0"},
{"RenderFiles", "0"}
});

var dvMightAlsoLikeProducts = Common.Default.GetDataViewByQuerySP("Shop_ProductMightAlsoLike_s"
, new SqlParameter("@ObjectID", shopID)
, new SqlParameter("@ZoneID", Common.IDZone)
, new SqlParameter("@Page", 1)
, new SqlParameter("@PageSize", 3));

tpl.FormatRepeater("MightAlsoLikeProducts", dvMightAlsoLikeProducts, new RepeaterItemCallback(formatter.Callback));

string result = "";
result = tpl.Generate();

context.Response.Write(result);

## Applications

Cette section montre des applications backoffice "custom" qui peut être utilisées comme départ de nouveau développement.

| Instance | Application | Description |
| --------------------- | ------------ | --------------------------------------------------------------------------------------------------------------- |
| Jurapastoral (lychee) | Messes | Application qui utilise un calendrier. Elle effectue une exportation des données au format Excel. |
| GSHC (serveur gshc) | Team Manager | Application qui effectue des opérations CRUD sur des objets. Il y a aussi une grille avec des champs éditables. |
| SID (cranberry) | Calculator | Permet de d’enregistrer des données sous forme d’une matrice (grille) avec champs éditables. |
| Clint (grapes) | Calculator | Opérations CRUD sur les différentes tables utilisé pour les calculateurs |
| Immofute (banana) | Real Estate | CRUD + Envoi FTP sur les différentes plateformes de gestion immobilière |