Utilisation d'un projet de modélisation

Définition de la structure de projet

Objective

After completing this lesson, you will be able to expliquer la structure d'un projet.

Espace de travail, projets, modules et dossiers

Un espace de travail dans SAP Business Application Studio est une structure de fichier dans laquelle vous pouvez travailler sur un ou plusieurs projets. Chaque utilisateur dispose de son propre espace de travail et peut en créer d'autres si nécessaire.

L'espace de travail d'un utilisateur peut contenir autant de projets que nécessaire, mais chaque projet doit avoir un nom différent. En pratique, cela se fait en stockant le contenu de différents projets dans différents dossiers racines. Il est possible d'ouvrir un seul projet/dossier à la fois, ou de créer un espace de travail multi-racines.

Relation de l'espace de travail, des projets et des modules. L'espace de travail d'un utilisateur contient des projets. Un projet contient des modules avec des dossiers et des objets.

Lorsque vous créez un projet, l'assistant de création vous demande de sélectionner un modèle de projet. SAP Business Application Studio est fourni avec plusieurs modèles et vous sélectionnez celui qui convient le mieux au type d'application que vous voulez créer. Selon le modèle que vous sélectionnez, vous serez invité à saisir différentes options, qui seront ensuite utilisées pour créer le shell de projet de base.

Nous allons nous concentrer sur le modèle de projet Base de données SAP HANA, car c'est le plus simple pour développer des vues calculées et d'autres artefacts de modélisation.

Modules

Dans un projet, il existe des modules. Il existe différents types de modules. Par exemple, il existe un module pour Java, un module pour HTML et un module pour les objets de base de données.

La première étape consiste à créer un module du type dont vous avez besoin, puis à commencer à développer le code source dans ce module. Vous pouvez créer autant de modules que nécessaire pour votre projet, même de même type. Généralement, pour un module de base de données, vous n'en avez probablement besoin que d'un seul. Vous devez fournir un nom significatif pour le module afin qu'il soit facile d'identifier le type de module et ce qu'il contient. Ne créez pas de modules vides que vous n'utiliserez pas.

Dans un module, nous avons des dossiers. Les dossiers sont utilisés pour subdiviser vos fichiers source en groupes significatifs. Par exemple, vous pouvez choisir de créer deux dossiers : un pour les tables et un pour les vues calculées.

Modules de base de données HANA

Un module HANA Database, également appelé module HDB, contient tous les fichiers de conception qui définissent les différents objets de base de données qui doivent être déployés avec l'application. Du point de vue de la structure de projet, il se compose d'un dossier auquel vous donnez un nom lors de la création du module HDB, par exemple, db ou dbmodule.

Ce dossier contient, entre autres, un dossier src, généré par défaut, où vous stockez du contenu de modélisation, mais aussi du contenu supplémentaire lié au déploiement HDI (fichier .env, dossier node_module contenant le déployeur HDI node.js et ses dépendances).

Remarque

Le module HDB est référencé par le fichier descripteur de projet, mta.yaml, qui contient également certaines options sur le module, telles que l'ID de base de données ou le nom de schéma (tous ne sont pas obligatoires).

Artefacts de base de données principaux définis dans un module HDB

  • Tables

  • Vues de calcul

  • Fonctions

  • Procédures

  • Privilèges d'analyse

  • Synonymes

Couche de persistance : à l'intérieur du module HDB ou en dehors ?

Selon le type d'application, les données principales gérées par l'application peuvent être stockées à différents endroits.

Une option de conception majeure pour une application consiste à décider si ces données sont stockées dans une couche de persistance définie par l'application elle-même ou si elles sont stockées à un autre emplacement, tel qu'un schéma de base de données classique. Prenons les deux exemples suivants pour illustrer ces approches :

Couche de persistance interne ou externe

Identificateur d'objets et espace nom

Dans la base de données SAP HANA Cloud, chaque objet d'exécution a un identifiant d'objet, qui est utilisé pour référencer cet objet dans le conteneur ou le schéma. Par défaut, le nom de l'exécution est identique au nom du fichier (source) de conception. Cela permet de garder les choses simples.

Un nom d'exécution peut également avoir un espace nom facultatif comme préfixe pour fournir encore plus de signification.

La structure d'un objet d'exécution complet est donc la suivante :

Code Snippet
1
<Namespace>::<Runtime Object Name>
  • Le nom de l'objet d'exécution est obligatoire.

  • L'espace nom est une partie facultative de l'identifiant d'objet et est principalement utilisé pour organiser logiquement les objets d'exécution dans le conteneur.

Remarque

Dans ce cours, la convention d'espace nom que nous avons choisie pour l'application principale est d'avoir un préfixe HC, appliqué uniformément à tous les objets, quel que soit l'emplacement du dossier des objets de conception. En d'autres termes, l'espace nom est le même pour tous les objets d'exécution définis dans tous les dossiers de notre module HDB. Ainsi, ces objets ont tous le modèle d'identifiant HC::<nom de l'objet d'exécution>.

Identificateurs d'objets d'exécution

Les identifiants d'objet (y compris l'espace nom) sont toujours indiqués dans les objets de conception. Autrement dit, les objets de conception doivent définir la manière dont les objets d'exécution seront identifiés.

Prenons l'exemple d'un objet de modélisation, d'une vue de calcul CVC_SalesOrders, avec sa version de conception dans l'espace de travail SAP Business Application Studio et sa version d'exécution (créée lors du déploiement) dans le schéma de conteneur.

Lors du processus de compilation, le nom des objets d'exécution déployés est créé sur la base d'un espace nom et du nom d'objet. Les deux sont dérivés du contenu du fichier de conception dans l'espace de travail de l'utilisateur. L'espace nom et le nom d'objet sont séparés par : : (deux signes deux-points)

La figure « Identificateurs d'objets d'exécution » explique comment les dossiers sont utilisés pour organiser les fichiers de conception dans le module HDB de votre application et montre ce que peut être l'identifiant de l'objet d'exécution. Dans ce scénario, l'identifiant de la vue de calcul a un espace de noms. Discutons maintenant des principales règles et des options possibles pour définir l'espace nom.

Espace nom

Les règles suivantes s'appliquent à l'espace nom :

  • L'espace nom est facultatif. Certains objets peuvent être définis avec un espace nom dans leur identifiant et d'autres sans.

  • Un module HDB ne peut avoir aucun espace nom défini ou peut spécifier un nombre quelconque d'espaces noms différents.

  • L'espace nom est toujours identique pour tous les objets de conception stockés dans le même dossier.

  • L'espace nom doit toujours être explicitement mentionné dans les fichiers de conception et doit correspondre à l'espace nom défini explicitement dans le dossier contenant, ou implicitement en cascade à partir des dossiers parents.

Le fichier .hdinamespace

La définition d'un espace nom est possible dans le dossier src d'un module HDB, ainsi que dans n'importe lequel de ses sous-dossiers. Pour ce faire, utilisez un fichier appelé .hdinamespace.

Lorsque vous créez un module HDB, un fichier .hdinamespace est créé automatiquement dans le dossier <hdbmodulename>→src et contient une valeur par défaut "<application_name>.<HDB_module_name>". Vous pouvez modifier ce fichier pour appliquer des règles différentes de celles par défaut aux espaces noms de votre projet.

Remarque

Il est recommandé d'effectuer une telle modification au début du projet pour éviter de rompre les dépendances. De même, vous devez décider tôt si un espace nom unique doit être utilisé pour tous les objets d'exécution de vos artefacts de modélisation ou si vous voulez en utiliser plusieurs.
Un fichier .hdinamespace dans la structure d'un projet, affichant le contenu du fichier, à savoir les clés nom et sous-dossier utilisées pour définir la règle d'espace nom. Les valeurs correspondantes sont MyApp1.db pour la clé name et append pour la clé subfolder.

Éléments du fichier .hdinamespace

Le contenu d'un fichier .hdinamespace est toujours composé de deux éléments, nom et sous-dossier.

ElementValeurs possiblesValeur par défaut
"name"
  • "<Tout espace nom syntaxiquement correct de votre choix>"
  • "" [aucun espace nom spécifié]
"<nom_application>.<Nom_module_HDB>"
"subfolder"
  • "ajouter"
  • "Ignorer"
"ajouter"

Pour structurer votre contenu de modélisation d'exécution de manière à répondre à vos besoins, vous pouvez ajouter un fichier .hdinamespace à n'importe quel sous-dossier du dossier src. L'option "subfolder" détermine si les noms de sous-dossiers doivent être ajoutés implicitement à l'espace nom pour les objets situés dans les sous-dossiers (append) ou non (ignore).

Par conséquent, vos objets de modélisation d'exécution peuvent faire référence à plusieurs espaces noms. Par exemple, dans votre module HDB, vous pouvez décider de la convention suivante :

  • Les tables sont précédées de db.data.table et
  • Le calcul est précédé de db.models.dim et db.models.cube.

Attention

Lorsque vous modifiez les spécifications du fichier .hdinamespace (ou que vous créez un nouveau fichier .hdinamespace dans un dossier), cette modification a un effet immédiat sur les identificateurs affectés à vos objets de conception.

Cependant, lorsqu'il s'agit de déployer ces objets, les nouvelles règles d'espace nom ne sont prises en compte qu'après le déploiement du fichier .hdinamespace. Avant le déploiement du nouveau fichier .hdinamespace, le déploiement de ces objets, par exemple une vue de calcul avec la nouvelle spécification d'espace de nom, échouera car, du côté du conteneur HDI, les anciennes règles sont toujours utilisées pour valider l'identifiant de l'objet d'exécution.

Comme recommandation générale, les règles d'espace nom doivent être définies avant la création du contenu de modélisation. En effet, si vous modifiez ces règles après avoir créé du contenu de modélisation, vous devez ajuster les identifiants d'objet (qui inclut l'espace nom) avant de pouvoir déployer vos modèles. Et cela est encore plus compliqué s'il existe des dépendances entre les modèles.

Nom de l'objet

La manière de définir un nom d'objet d'exécution dans les fichiers de conception est régie par l'une des deux règles suivantes, en fonction du type d'objet.

Définition des noms d'objets d'exécution

Type d'objet de modélisationNombre d'objets par fichier de conceptionRègle d'appellation
Vues de calcul, fonctions tabulaires, procédures, privilèges analytiquesChaque fichier de conception définit un seul objet d'exécution (*).Le nom de l'objet d'exécution est défini dans le contenu de l'objet et doit correspondre au nom du fichier de conception (sans extension de fichier).
Synonymes, définition d'importation de données de table, rôlesChaque fichier de conception peut définir un ou plusieurs objets d'exécution.Le nom de l'objet d'exécution est défini uniquement dans le contenu de l'objet et n'est pas lié au nom du fichier de conception.

(*) Ici, il s'agit d'un seul objet d'exécution principal. Comme vous l'avez peut-être observé, même une vue de calcul simple génère une vue de colonne principale, ainsi que d'autres vues de colonne enfant pour les attributs, les hiérarchies, etc.

Remarque

Dans ce tableau, nous ne couvrons pas l'ensemble de la typologie des modèles, mais seulement les principaux qui sont abordés dans ce cours.

Prenons deux exemples, un pour chacune des deux approches.

Exemple de nom d'objet : vue de calcul

Capture d'écran du nom de l'objet dans le code du fichier de conception et dans l'explorateur de base de données. Les deux emplacements affichent l'espace nom et le nom de l'objet. Le nom de l'objet et le nom du fichier doivent correspondre pour trouver plus facilement un fichier de conception à partir du nom de l'objet d'exécution.

Techniquement, le nom du fichier de conception pour une vue de calcul peut être différent du nom de l'objet d'exécution.

Cependant, SAP vous recommande de toujours synchroniser ces noms pour faciliter la recherche d'un objet de conception en fonction du nom de l'objet d'exécution.

Exemple de nom d'objet : synonymes

Capture d'écran d'un fichier .hdbsynonyms utilisé pour définir des références conformes aux règles d'espace nom applicables au dossier dans lequel se trouve le fichier de définition de synonyme.

Ce deuxième exemple de configuration montre qu'un fichier de conception pour les synonymes peut définir plusieurs synonymes. Dans ce cas, il n'existe pas de règle ou de recommandation spécifique pour le nom du fichier de conception.