Crea una classe di messaggi di origine

Questa guida descrive come creare una classe di messaggi di origine per Manufacturing Data Engine (MDE).

Modellazione della classe di messaggi di origine

Le classi di messaggi di origine devono essere definite per acquisire un insieme di messaggi di origine che condividono una struttura comune.

Più specifiche sono le classi di messaggi di origine che progetti, meno istruzioni condizionali devi scrivere negli script Whistle per gestire le differenze di schema tra i diversi messaggi di origine. Tuttavia, la creazione di classi di messaggi di origine più specifiche comporta la necessità di avere più parser.

Pertanto, la modellazione delle classi di messaggi di origine comporta la ricerca del giusto equilibrio tra, da un lato, avere classi di messaggi di origine con schemi di messaggi uniformi e, dall'altro, il numero di parser da gestire.

Creazione della classe di messaggi di origine

Questa sezione descrive la procedura per creare una classe di messaggi di origine utilizzando le chiamate API o l'interfaccia della console.

Importante: a partire dalla release 1.4.1 di MDE e versioni successive, le intestazioni dei messaggi Pub/Sub vengono archiviate in un attributo riservato denominato mdeHeaders. Le classi di messaggi esistenti delle release precedenti che utilizzavano espressioni come #root.headers['SOME_ATTRIBUTE'] continueranno a funzionare per un numero limitato di release future prima di essere ritirate. Assicurati di aggiornare le espressioni delle classi di messaggi in modo che utilizzino #root.mdeHeaders['SOME_ATTRIBUTE'] invece.

REST

POST /configuration/v1/message-classes

{
  "name": "MESSAGE_CLASS_NAME",
  "MESSAGE_CLASS_NAME": "PRIORITY",
  "expression": "SPEL_EXPRESSION"
}

Sostituisci quanto segue:

• MESSAGE_CLASS_NAME: il nome della classe di messaggi da creare.
• PRIORITY: la priorità della classe di messaggi. La priorità di una classe di messaggi è un numero intero compreso tra 0 e 65535 inclusi. I numeri interi più bassi indicano priorità più elevate.
• SPEL_EXPRESSION: l'espressione SpEL che definisce la classe di messaggi. Ad esempio #root.event['value'] instanceof T(Number)

Console

1. Apri la sezione "CLASSI DI MESSAGGI" dell'interfaccia utente per creare una classe di messaggi di origine. In questa sezione dell'interfaccia utente viene visualizzato un elenco di tutte le classi di messaggi disponibili:

   

   Per ogni classe di messaggi, nell'elenco vengono visualizzati i seguenti parametri:

   • Nome classe di messaggi: il nome della classe di messaggi. Deve essere univoco.
   • Espressione classe di messaggi: l'espressione SpEL effettiva associata a la classe di messaggi.
   • Priorità: la priorità della classe di messaggi (i numeri più bassi rappresentano priorità più elevate).
   • Attivato: lo stato delle classi di messaggi. Le classi di messaggi disattivate non faranno parte dell'acquisizione.
   • Azioni: un pulsante contestuale che fornisce l'accesso alla funzione "Visualizza/ Modifica" e alle funzioni "Attiva / Disattiva" per la classe di messaggi selezionata.

2. Per aggiungere una nuova classe di messaggi, fai clic sul pulsante "AGGIUNGI NUOVA CLASSE DI MESSAGGI" in alto. Viene visualizzato un nuovo menu laterale contenente tutti i parametri classe di messaggi richiesti da fornire:

   

   • Nome classe di messaggi: una stringa univoca che definisce la classe di messaggi.
   • Espressione classe di messaggi: si riferisce all'espressione SpEL che definisce la classe di messaggi.
   • Priorità: definisce la priorità associata alla classe di messaggi. La priorità di una classe di messaggi è un numero intero compreso tra 0 e 65535 inclusi. I numeri interi più bassi indicano priorità più elevate. Se un messaggio convalida l'espressione di due classi di messaggi, viene attivata solo quella con il valore di priorità inferiore.

3. Per creare una nuova classe di messaggi , inserisci un'espressione SpEL valida nel campo Espressione classe di messaggi e imposta la priorità.

4. Fai clic sul pulsante 'CREA' per salvare le modifiche. Se la nuova classe di messaggi viene creata correttamente, viene visualizzato un messaggio di conferma.

Nota: in fase di runtime, tutte le classi di messaggi di origine attive vengono ordinate in base alla priorità, e per ogni messaggio, viene valutata l'espressione di ogni classe di messaggi finché non viene trovata un'espressione che restituisce true A questo punto, la valutazione delle classi di messaggi si interrompe.

Testare un'espressione di classe di messaggi di origine

Puoi sperimentare e testare le espressioni delle classi di messaggi di origine prima di creare una classe di messaggi di origine.

REST

POST /configuration/v1/message-classes:test

{
  "expression": "SPEL_EXPRESSION",
  "testMessage": "TEST_MESSAGE"
}

Sostituisci quanto segue:

• SPEL_EXPRESSION: l'espressione SpEL che definisce la classe di messaggi.
• TEST_MESSAGE: l'oggetto del messaggio di origine di test.

L'oggetto restituito ti informa se l'espressione fornita è sintatticamente corretta e se restituirebbe true o false per il messaggio fornito.

Console

L'interfaccia utente offre la possibilità di testare l'espressione SpEL della nuova classe di messaggi con un messaggio di test.

1. Inserisci il messaggio di esempio nella casella "Messaggio di test" con il JSON.
2. Fai clic su "ESEGUI TEST" per eseguire la convalida. Il risultato del test è "Corrispondenza trovata" o "Nessuna corrispondenza trovata" e una breve spiegazione dei criteri di corrispondenza.

Valutare un messaggio di test rispetto a tutte le classi di messaggi attive

Puoi valutare un messaggio per determinare in quale classe di messaggi di origine rientrerebbe un messaggio di test per un insieme di classi di messaggi di origine attive.

REST

POST /configuration/v1/message-classes:evaluate

{
  "testMessage": "TEST_MESSAGE"
}

Sostituisci quanto segue:

• TEST_MESSAGE con l'oggetto del messaggio di origine di test.

L'oggetto restituito ti informa su quale classe di messaggi di origine è stata trovata per il messaggio fornito, se presente.