Erstellung von Datenproduktmodulen

Wenn Sie Ihre eigene Geschäftslogik und Ihre eigenen Analysemodelle definieren möchten, erstellen Sie ein benutzerdefiniertes Datenprodukt-Modul. So können Sie Berechnungen für Ihre Basistabellen oder Upstream-Datenprodukte ausführen und die Ergebnisse in bereitstellbare Datasets verpacken.

Vorbereitung

Wir empfehlen, benutzerdefinierte Datenproduktmodule in einem dedizierten benutzerdefinierten Namespace zu erstellen, um das Lebenszyklusmanagement zu verbessern. Achten Sie außerdem darauf, dass die Quelltabelle, die Sie verwenden möchten, im Dataset der Datenbasis vorhanden ist.

Erstellung eines Datenproduktmoduls

Für die Definition eines Datenproduktmoduls sind folgende Schritte erforderlich:

  • Registrierung des Datenproduktmoduls in der Datei config/config.yaml durch Erweitern der Liste data.modules.products mit dem Eintrag:
data:
  # Configuration for data foundation and product modules.
  modules:
    # List of data product modules.
    products:
        # Recommended naming for product_module_id:
        # custom_namespace_product_name
      - moduleId:  product_module_id
        # Path of the data product (namespaced).
        modulePath:  custom_namespace.system_type.products.product_name
        # Map of module dependencies.
        dependencyBindings:
          sapModule: erp
          sapModuleCustNS:  foundation_module_id
        # Reference to the target dataset ID.
        dataTargetId: product_target
        # Whether the module is enabled.
        # enabled: true
        # Whether the foundation is external (does not create target dataset).
        # external: false
        # Custom table settings file, relative to 'config/' file directory
        # Recommended path: '{custom_namespace}/{system_type}/products/{product_name}/table_settings.yaml'
        # If omitted, defaults to '../src/data_modules/{custom_namespace}/{system_type}/products/{product_name}/table_settings.default.yaml'
        # tableSettings: "{custom_namespace}/{system_type}/products/{product_name}/table_settings.yaml"
  • Erstellung der Standarddatei tableSettings (z.B. src/data_modules/custom_namespace/system_type/products/product_name/table_settings.default.yaml).

Diese YAML-Datei steuert Tabellenkonfigurationen wie Materialisierungen und BigQuery-Optimierungsdetails:

common:
  custom_sales_summary:
    materializationType: "table"
    bigQueryLabels:
      - key: data_class
        value: transactional
    dataformTags: ["custom", "sales", "reporting"]
    partitionDetails:
      column: "created_date"
      partitionType: "date"
      timeGrain: "day"
    clusterDetails:
      columns:
        - "customer_id"
  • Erstellung einer Annotationsdatei

Die Annotationsdatei tablename.yaml wird für jedes Ausgabeartefakt des Datenprodukts (Tabelle, Ansicht) erstellt und beschreibt Spalten und Felder im YAML-Format. Während der Kompilierung sucht der Builder automatisch nach Annotationen im Ordner annotations/ des Produkts (z.B. src/data_modules/custom_namespace/system_type/products/product_name/annotations/custom_sales_summary.yaml) und führt diese Strings direkt in die Dataform-Schema-Definitionen der Ausgabe ein, damit sie in den BigQuery-Tabellenmetadaten erhalten bleiben.

Eine Annotationsdatei src/data_modules/custom_namespace/system_type/products/product_name/annotations/tablename.yaml hat folgendes Format:

description: "Description of the table or view purpose"
fields:
  - name: "customer_id"                     # column name
    description: "Customer identifier"      # column description
  - name: "column2"
    description: "Description of Column 2"
  - name: "column3"
    description: "Description of Column 3"
  • Erstellen Sie im Ordner src/data_modules/custom_namespace/system_type/products/product_name/ Ihres Datenprodukts eine Datei manifest.yaml, und behalten Sie dabei die Typ-, Kategorie-, Tabellen- und Modulabhängigkeiten bei. Die Manifestdatei hat folgendes Format:
displayName: Sales Performance Summary
description: Sales performance analytical data product.
category: product
type: generic
builder: sap_product     # Automatically resolves to the global SapProductBuilder fallback
dependencies:
  sapModule:
    modulePath: cortex.sap.foundations.sap
    supportedVersions:
      - ecc
      - s4

Beispiel für ein Datenproduktmodul

Die Schritte zur Implementierung des Datenprodukts flights_usd im Namespace sap_bookingdatamodel des Beispiels für Flüge sind:

  • Registrierung des Datenproduktmoduls in der Datei config/config.yaml durch Erweitern der Liste data.modules.products mit dem Eintrag:
data:
  modules:
    products:
      - moduleId: sap_bookingdatamodel_flights_usd
        modulePath: sap_bookingdatamodel.sap.products.flights_usd
        dependencyBindings:
          sapModule: erp
          sapModuleCustNS: sap_bookingdatamodel
        dataTargetId: product_target
  • Erstellen Sie als Nächstes src/data_modules/sap_bookingdatamodel/sap/products/flights_usd/manifest.yaml mit folgendem Inhalt:
displayName: Flights USD
description: Flight scheduling and pricing USD data product.
category: product
type: generic
dependencies:
  sapModule:
    modulePath: cortex.sap.foundations.sap
    supportedVersions:
      - ecc
      - s4
    tables:
      common:
        - tcurr
  sapModuleCustNS:
    # Type of the dependent Module.
    # use cortex.sap.foundations.sap if you followed "Configure multiple instances of a data foundation module"
    # https://docs.cloud.google.com/cortex/docs/deployment-configuration#multiple-data-foundation-instances
    modulePath: cortex.sap.foundations.sap
    # use sap_bookingdatamodel.sap.foundations.sap if you are connecting to custom-data foundation module:
    # https://docs.cloud.google.com/cortex/docs/extensibility-guide-data-foundation
    #modulePath: sap_bookingdatamodel.sap.foundations.sap
    supportedVersions:
      - ecc
      - s4
    tables:
      common:
        - sflight
builder: sap_product
  • Erstellen Sie im nächsten Schritt die referenzierte Datei mit den Tabelleneinstellungen, um das Schema und die Metadaten der Ausgabetabellen oder ‑ansichten in BigQuery zu konfigurieren.

Erstellen Sie im verwendeten Beispiel src/data_modules/sap_bookingdatamodel/sap/products/flights_usd/table_settings.default.yaml mit folgendem Inhalt:

ecc:
  flights_usd:
    materializationType: incremental
    bigQueryLabels:
      - key: data_class
        value: transactional
    dataformTags: [sap, dataproduct, masterdata]
s4:
  flights_usd:
    materializationType: incremental
    bigQueryLabels:
      - key: data_class
        value: transactional
    dataformTags: [sap, dataproduct, masterdata]
  • Erstellen Sie Annotationen für Datenprodukttabellen, um das Speicherschema mit Beschreibungen zu ergänzen.

Erstellen Sie im verwendeten Beispiel die Datei src/data_modules/sap_bookingdatamodel/sap/products/flights_usd/annotations/flights_usd.yaml mit folgendem Inhalt:

description: "Flight scheduling and pricing information, including currency conversion to USD."
fields:
  - name: "client_mandt"
    description: "Client (Mandant), PK"
  - name: "airline_code_carrid"
    description: "Airline Carrier ID, PK"
  - name: "flight_connection_number_connid"
    description: "Flight Number, PK"
  - name: "flight_date_fldate"
    description: "Flight Date"
  - name: "price_usd"
    description: "Price in USD"
  - name: "price"
    description: "Price in local currency"
  - name: "currency"
    description: "Local currency"
  • Die Geschäftslogik des Datenprodukts wird in js- oder sqlx-Dateien gespeichert.

Erstellen Sie im angegebenen Beispiel die Datei src/data_modules/sap_bookingdatamodel/sap/products/flights_usd/definitions/flights_usd.js mit folgendem Inhalt:

// ___MODULE_CONTEXT___
// ___TABLE_CONFIG___

const moduleConfig = config.product[moduleContext.moduleId];
const sapModuleConfigDatasetId = moduleConfig.sources.sapModule.datasetId;
const sapModuleCustNSConfigDatasetId = moduleConfig.sources.sapModuleCustNS.datasetId;

const materializationType = tableConfig.materializationType || "incremental";

const incremental = require("includes/cortex/incremental.js");
const publish_config = require("includes/cortex/publish_config.js");

const publishConfig = publish_config.getPublishConfig(
   materializationType,
   tableConfig,
   moduleConfig,
   [
       "client_mandt",
       "airline_code_carrid",
       "flight_connection_number_connid",
       "flight_date_fldate"
   ]
);

publish("flight_usd", publishConfig).query(
   (ctx) => `
WITH flight_base AS (
   SELECT
       mandt,
       carrid,
       connid,
       fldate,
       price,
       currency,
       -- Convert flight date string (YYYYMMDD) to an integer to calculate SAP's inverted date key
       CAST(99999999 - CAST(fldate AS INT64) AS STRING) AS inverted_fldate
   FROM   ${ctx.ref(sapModuleCustNSConfigDatasetId, 'sflight')} AS flight
),
ranked_exchange_rates AS (
   SELECT
       f.mandt,
       f.carrid,
       f.connid,
       f.fldate,
       f.price,
       f.currency,
       t.ukurs,
       -- Window function to grab the closest historical exchange rate
       ROW_NUMBER() OVER (
           PARTITION BY f.mandt, f.carrid, f.connid, f.fldate
           ORDER BY t.gdatu ASC
       ) AS latest_rate_rank
   FROM flight_base f
   LEFT JOIN ${ctx.ref(sapModuleConfigDatasetId, 'tcurr')} AS t
     ON f.mandt = t.mandt
    AND t.kurst = 'M'       -- 'M' is the standard SAP default for average exchange rates
    AND t.fcurr = f.currency
    AND t.tcurr = 'USD'
    -- Chronological (rate_date <= flight_date) translates to (t.gdatu >= inverted_fldate)
    AND t.gdatu >= f.inverted_fldate
)

SELECT
   client_mandt,
   airline_code_carrid,
   flight_connection_number_connid,
   flight_date_fldate,
   price,
   currency,
   price_usd,
   CURRENT_TIMESTAMP() AS bq_loaded_at
FROM (
  SELECT
    mandt              AS client_mandt,
    carrid             AS airline_code_carrid,
    connid             AS flight_connection_number_connid,
    PARSE_TIMESTAMP('%Y%m%d', fldate) AS flight_date_fldate,
    price              AS price,
    currency           AS currency,
    -- Currency Conversion Logic
    CASE
       WHEN currency = 'USD' THEN price
       WHEN ukurs IS NULL   THEN NULL -- Handles cases where no exchange rate is found
       -- If UKURS is negative, it's an indirect quotation (1 USD = X Local) -> Divide
       WHEN ukurs < 0       THEN ROUND(price / ABS(ukurs), 2)
       -- If UKURS is positive, it's a direct quotation (1 Local = X USD) -> Multiply
       ELSE ROUND(price * ukurs, 2)
     END AS price_usd
  FROM ranked_exchange_rates
  WHERE latest_rate_rank = 1
)
${incremental.getWhere(ctx, ["flight_date_fldate"])}
`
);

Überprüfung der benutzerdefinierten Namespace-Erweiterung

So überprüfen Sie, ob die Datenproduktmodule des Google Cloud Cortex Framework erfolgreich erstellt wurden: