Configuration de base

Le déploiement standard de Manufacturing Data Engine (MDE) n'applique aucun paramètre de configuration par défaut, qui sont nécessaires pour commencer à ingérer des données.

Ce guide vous explique comment effectuer une configuration de base de MDE. Par exemple, pour tester le fonctionnement de bout en bout du système. Ce guide vous permet de créer des classes de messages, des types et des analyseurs pour les trois archétypes.

Si vous prévoyez d'utiliser Manufacturing Connect Edge (MCe) pour ingérer des données, déployez plutôt le package de configuration par défaut.

Vous pouvez utiliser l'API MDE ou l'interface Web pour effectuer cette configuration.

Remarque : Pour utiliser l'API, vous devez avoir configuré le tunneling SSH via IAP auparavant.

Avertissement : Cette configuration n'est pas destinée à être utilisée en production. Adaptez toujours votre configuration à des cas d'utilisation spécifiques.

Classes de messages

Cette section fournit des exemples de classes de messages disponibles dans MDE.

Important : À partir de la version 1.4.1 de MDE, les en-têtes de message sont stockés dans un attribut réservé appelé mdeHeaders. Les classes de messages existantes qui utilisaient des expressions telles que #root.headers['SOME_ATTRIBUTE'] continueront de fonctionner pendant quelques versions avant d'être obsolètes. Assurez-vous de mettre à jour vos expressions de classe de messages pour utiliser #root.mdeHeaders['SOME_ATTRIBUTE'] à la place.

Classe de messages pour numeric

Voici un exemple de classe de messages basic-numeric :

REST

POST /configuration/v1/message-classes

{
   "name": "basic-numeric",
   "priority": 2000,
   "expression": "#root.event['value'] instanceof T(Number) && #root.event['timestamp'] != null && #root.event['tagName'] != null"
}

Interface Web

Nom de la classe de messages : basic-numeric

1. Dans l'interface Web de MDE, cliquez sur Message Classes (Classes de messages).
2. Cliquez sur Add new Message Class (Ajouter une classe de messages).
3. Dans le champ Message Class name (Nom de la classe de messages), saisissez basic-numeric.

4. Copiez l'expression suivante et collez-la dans la zone Expression :

      #root.event['value'] instanceof T(Number) && #root.event['timestamp'] != null && #root.event['tagName'] != null
   

5. Remplacez la priorité par 2000.

6. Cliquez sur Create (Créer).

   

Classe de messages pour discrete

Voici un exemple de classe de messages basic-discrete :

REST

POST /configuration/v1/message-classes

   {
      "name": "basic-discrete",
      "priority": 1975,
      "expression": "#root.event['value'] != null && !(#root.event['value'] instanceof T(Number)) && #root.event['timestamp'] != null && #root.event['tagName'] != null"
   }

Interface Web

Nom de la classe de messages : basic-discrete

1. Dans l'interface Web de MDE, cliquez sur Message Classes (Classes de messages).
2. Cliquez sur Add new Message Class (Ajouter une classe de messages).
3. Dans le champ Message Class name (Nom de la classe de messages), saisissez basic-discrete.

4. Copiez l'expression suivante et collez-la dans la zone Expression :

      #root.event['value'] != null && !(#root.event['value'] instanceof T(Number)) && #root.event['timestamp'] != null  && #root.event['tagName'] != null
   

5. Remplacez la priorité par 1975.

6. Cliquez sur Create (Créer).

   

Classe de messages pour continuous

Voici un exemple de classe de messages basic-continuous :

REST

POST /configuration/v1/message-classes

   {
      "name": "basic-continuous",
      "priority": 1950,
      "expression": "#root.event['value'] != null && !(#root.event['value'] instanceof T(Number)) && #root.event['startTimestamp'] != null && #root.event['endTimestamp'] != null && #root.event['tagName'] != null"
   }

Interface Web

Nom de la classe de messages : basic-continuous

1. Dans l'interface Web de MDE, cliquez sur Message Classes (Classes de messages).
2. Cliquez sur Add new Message Class (Ajouter une classe de messages).
3. Dans le champ Message Class name (Nom de la classe de messages), saisissez basic-continuous.

4. Copiez l'expression suivante et collez-la dans la zone Expression :

   #root.event['value'] != null && !(#root.event['value'] instanceof T(Number)) && #root.event['startTimestamp'] != null && #root.event['endTimestamp'] != null && #root.event['tagName'] != null
   

5. Remplacez la priorité par 1950.

6. Cliquez sur Create (Créer).

   

Types

Cette section présente les types disponibles dans MDE.

Important : Lorsque vous créez les types, assurez-vous d'attendre qu'ils soient entièrement provisionnés et activés avant de créer les analyseurs. Cela peut prendre deux à trois minutes.

Type pour numeric

Voici un exemple de type basic-numeric :

REST

POST /configuration/v1/types

{
   "archetype": "NUMERIC_DATA_SERIES",
   "name": "basic-numeric"
}

Interface Web

Nom : basic-numeric

1. Dans l'interface Web de MDE, cliquez sur Types.
2. Cliquez sur Add new Type (Ajouter un type).
3. Dans le champ Type name (Nom du type), saisissez basic-numeric.

4. Sélectionnez NUMERIC_DATA_SERIES dans la liste déroulante Archetype (Archétype) :

   

5. Ouvrez la section Storage Settings (Paramètres de stockage).

6. Activez l'option Send to BigQuery (Envoyer à BigQuery).

7. Cliquez sur Create (Créer).

Type pour discrete

Voici un exemple de type basic-discrete :

REST

POST /configuration/v1/types

{
   "archetype": "DISCRETE_DATA_SERIES",
   "name": "basic-discrete"
}

Interface Web

Nom : basic-discrete

1. Dans l'interface Web de MDE, cliquez sur Types.
2. Cliquez sur Add new Type (Ajouter un type).
3. Dans le champ Type name (Nom du type), saisissez basic-discrete.

4. Sélectionnez `DISCRETE_DATA_SERIES dans la liste déroulante Archetype (Archétype) :

   

5. Ouvrez la section Storage Settings (Paramètres de stockage).

6. Activez l'option Send to BigQuery (Envoyer à BigQuery).

7. Cliquez sur Create (Créer).

Type pour continuous

Voici un exemple de type basic-continuous :

REST

POST /configuration/v1/types

{
   "archetype": "CONTINUOUS_DATA_SERIES",
   "name": "basic-continuous"
}

Interface Web

Nom : basic-continuous

1. Dans l'interface Web de MDE, cliquez sur Types.
2. Cliquez sur Add new Type (Ajouter un type).
3. Dans le champ Type name (Nom du type), saisissez basic-continuous.

4. Sélectionnez `CONTINUOUS_DATA_SERIES dans la liste déroulante Archetype :

   

5. Ouvrez la section Storage Settings (Paramètres de stockage).

6. Activez l'option Send to BigQuery (Envoyer à BigQuery).

7. Cliquez sur Create (Créer).

Analyseurs

Cette section présente les différents analyseurs disponibles dans MDE. Assurez-vous que les types sont entièrement provisionnés et active avant de créer les analyseurs. Ce processus peut prendre jusqu'à trois minutes.

Important : À partir de la version 1.4.1 de MDE, les en-têtes de message sont désormais stockés dans un attribut réservé appelé mdeHeaders. Si vos messages d'entrée contiennent cet attribut, une expression telle que embeddedMetadata: $root[where ($.field !=...)] remplace l'attribut réservé et entraîne une perte des données d'en-tête fournies avec le message Edge. Veillez à utiliser l'expression de filtre Whistle générique avec prudence afin d'éviter toute perte de données.

Analyseur pour numeric

Voici un exemple d'analyseur basic-numeric :

REST

POST /configuration/v1/parsers

{
   "name": "basic-numeric-to-basic-numeric",
   "messageClassName": "basic-numeric",
   "typeReference": {
         "name": "basic-numeric",
         "version": 1
   },
   "script": "package mde\n\n[{\ntagName: $root.tagName;\ntimestamps: MapTimestamp($root);\ndata: MapData($root);\nembeddedMetadata: $root[where ($.field != \"value\" and $.field != \"tagName\" and $.field != \"timestamp\" and $.field != \"messageId\")];\n}]\n\ndef MapTimestamp(input) {\n    eventTimestamp: input.timestamp;\n}\n\ndef MapData(input) {\n    numeric: input.value;\n}"
}

Interface Web

Nom : basic-numeric-to-basic-numeric

1. Dans l'interface Web de MDE, cliquez sur Parsers (Analyseurs).
2. Cliquez sur Add new Parser (Ajouter un analyseur).
3. Dans le champ Parser name (Nom de l'analyseur), saisissez basic-numeric-to-basic-numeric.
4. Sélectionnez basic-numeric dans la liste déroulante Message Class Name (Nom de la classe de messages).

5. Copiez et collez le code Whistle suivant dans la zone Parser (Analyseur) :

    package mde
   
    [{
    tagName: $root.tagName;
    timestamps: MapTimestamp($root);
    data: MapData($root);
    embeddedMetadata: $root[where ($.field != "value" and $.field != "tagName" and $.field != "timestamp" and $.field != "messageId")];
    }]
   
    def MapTimestamp(input) {
       eventTimestamp: input.timestamp;
    }
   
    def MapData(input) {
       numeric: input.value;
    }
   

6. Sélectionnez basic-numeric | version: 1 dans la liste déroulante Type.

7. Cliquez sur Create (Créer).

   

Analyseur pour discrete

Voici un exemple d'analyseur basic-discrete :

REST

POST /configuration/v1/parsers

{
   "name": "basic-discrete-to-basic-discrete",
   "messageClassName": "basic-discrete",
   "typeReference": {
         "name": "basic-discrete",
         "version": 1
   },
   "script": "package mde\n\n[{\ntagName: $root.tagName;\ntimestamps: MapTimestamp($root);\ndata: MapData($root);\nembeddedMetadata: $root[where ($.field != \"value\" and $.field != \"tagName\" and $.field != \"timestamp\" and $.field != \"messageId\")];\n}]\n\ndef MapTimestamp(input) {\n    eventTimestamp: input.timestamp;\n}\n\ndef MapData(input) {\n    complex: input.value;\n}\n"
}

Interface Web

Nom : basic-discrete-to-basic-discrete

1. Dans l'interface Web de MDE, cliquez sur Parsers (Analyseurs).
2. Cliquez sur Add new Parser (Ajouter un analyseur).
3. Dans le champ Parser name (Nom de l'analyseur), saisissez basic-numeric-to-basic-discrete.
4. Sélectionnez basic-discrete dans la liste déroulante Message Class Name (Nom de la classe de messages).

5. Copiez et collez le code Whistle suivant dans la zone Parser (Analyseur) :

    package mde
   
    [{
    tagName: $root.tagName;
    timestamps: MapTimestamp($root);
    data: MapData($root);
    embeddedMetadata: $root[where ($.field != "value" and $.field != "tagName" and $.field != "timestamp" and $.field != "messageId")];
    }]
   
    def MapTimestamp(input) {
       eventTimestamp: input.timestamp;
    }
   
    def MapData(input) {
       complex: input.value;
    }
   

6. Sélectionnez basic-discrete | version: 1 dans la liste déroulante Type.

7. Cliquez sur Create (Créer).

   

Analyseur pour continuous

Voici un exemple d'analyseur basic-continuous :

REST

POST /configuration/v1/parsers

{
   "name": "basic-continuous-to-basic-continuous",
   "messageClassName": "basic-continuous",
   "typeReference": {
         "name": "basic-continuous",
         "version": 1
   },
   "script": "package mde\n\n[{\ntagName: $root.tagName;\ntimestamps: MapTimestamp($root);\ndata: MapData($root);\nduration: $root.duration;\nembeddedMetadata: $root[where ($.field != \"value\" and $.field != \"tagName\" and $.field != \"startTimestamp\" and $.field != \"endTimestamp\" and $.field != \"messageId\")];\n}]\n\ndef MapTimestamp(input) {\n    continuousTimestamp: {\n        eventTimestampStart: input.startTimestamp;\n        eventTimestampEnd: input.endTimestamp;\n    };\n}\n\ndef MapData(input) {\n    complex: input.value;\n}\n"
}

Interface Web

Nom : basic-continuous-to-basic-continuous

1. Dans l'interface Web de MDE, cliquez sur Parsers (Analyseurs).
2. Cliquez sur Add new Parser (Ajouter un analyseur).
3. Dans le champ Parser name (Nom de l'analyseur), saisissez basic-numeric-to-basic-continuous.
4. Sélectionnez basic-continuous dans la liste déroulante Message Class Name (Nom de la classe de messages).

5. Copiez et collez le code Whistle suivant dans la zone Parser (Analyseur) :

    package mde
   
    [{
    tagName: $root.tagName;
    timestamps: MapTimestamp($root);
    data: MapData($root);
    duration: $root.duration;
    embeddedMetadata: $root[where ($.field != "value" and $.field != "tagName" and $.field != "startTimestamp" and $.field != "endTimestamp" and $.field != "messageId")];
    }]
   
    def MapTimestamp(input) {
       continuousTimestamp: {
          eventTimestampStart: input.startTimestamp;
          eventTimestampEnd: input.endTimestamp;
       };
    }
   
    def MapData(input) {
       complex: input.value;
    }
   

6. Sélectionnez basic-continuous | version: 1 dans la liste déroulante Type.

7. Cliquez sur Create (Créer).