Entwickeln eines Asset Compute-Metadaten-Sekundärs

Benutzerdefinierte Asset Compute-Sekundäre können XMP(XML)-Daten erstellen, die zurück an AEM gesendet und als Metadaten für ein Asset gespeichert werden.

Häufige Anwendungsfälle umfassen:

Vorgehensweise

In diesem Tutorial erstellen wir einen Asset Compute-Metadaten-Sekundär, der die am häufigsten verwendeten Farben in einem Bild-Asset ableitet und die Farbnamen in die Metadaten des Assets in AEM schreibt. Während der Sekundär selbst recht einfach ist, greift dieses Tutorial darauf zurück, um das Erstellen, Entwickeln und Bereitstellen eines benutzerdefinierten Asset Compute-Sekundärs für die Verwendung mit AEM as a Cloud Service zu untersuchen.

Logischer Ablauf des Aufrufs eines Asset Compute-Metadaten-Sekundärs

Der Aufruf von Asset Compute-Metadaten-Sekundären ist fast identisch mit dem einer binären Ausgabedarstellung, die Sekundäre generiert, wobei der Hauptunterschied der Rückgabetyp eine XMP(XML)-Ausgabedarstellung ist, deren Werte auch in die Metadaten des Assets geschrieben werden.

Asset Compute-Sekundäre implementieren den API-Vertrag für den Asset Compute-SDK-Sekundär in der Funktion renditionCallback(...), die konzeptionell lautet:

Konfigurieren von manifest.yml manifest

Alle Asset Compute-Sekundäre müssen in manifest.yml registriert werden.

Öffnen Sie die manifest.yml des Projekts und fügen Sie einen Sekundäreintrag hinzu, der den neuen Sekundär konfiguriert, in diesem Fall metadata-colors.

Denken Sie daran, dass in .yml die Leerzeichen berücksichtigt werden.

packages:
  __APP_PACKAGE__:
    license: Apache-2.0
    actions:
      worker:
        function: actions/worker/index.js
        web: 'yes'
        runtime: 'nodejs:12'
        limits:
          timeout: 60000 # in ms
          memorySize: 512 # in MB
          concurrency: 10
        annotations:
          require-adobe-auth: true
      metadata-colors:
        function: actions/metadata-colors/index.js
        web: 'yes'
        runtime: 'nodejs:12'
        limits:
          memorySize: 512 # in MB

function verweist auf die im nächsten Schritt erstellte Sekundärimplementierung. Ordnen Sie Sekundäre semantisch zu (z. B. hätte actions/worker/index.js besser actions/rendition-circle/index.js benannt werden können), da diese in der Sekundär-URL erscheinen, und bestimmen Sie auch den Ordnernamen der Testsuite des Sekundärs.

Die limits und require-adobe-auth werden diskret pro Sekundär konfiguriert. In diesem Sekundär werden 512 MB des Speichers zugewiesen, wenn der Code (potenziell) große binäre Bilddaten prüft. Die anderen limits werden entfernt, um die Standardwerte zu verwenden.

Entwickeln eines Metadaten-Sekundärs metadata-worker

Erstellen Sie eine neue JavaScript-Datei für einen Metadaten-Sekundär im Asset Compute-Projekt unter dem Pfad, wo manifest.yml für den neuen Sekundär definiert wurde, unter /actions/metadata-colors/index.js

Installieren von npm-Modulen

Installieren Sie die zusätzlichen npm-Module (@adobe/asset-compute-xmp, get-image-color und color-namer), die in diesem Asset Compute-Sekundär verwendet werden.

$ npm install @adobe/asset-compute-xmp
$ npm install get-image-colors
$ npm install color-namer

Code für den Metadaten-Sekundär

Dieser Sekundär sieht sehr ähnlich wie der Ausgabedarstellungs-Sekundär aus. Der Hauptunterschied besteht darin, dass er XMP(XML)-Daten an den rendition.path schreibt, damit sie wieder in AEM gespeichert werden.

"use strict";

const { worker, SourceCorruptError } = require("@adobe/asset-compute-sdk");
const fs = require("fs").promises;

// Require the @adobe/asset-compute-xmp module to create XMP
const { serializeXmp } = require("@adobe/asset-compute-xmp");

// Require supporting npm modules to derive image colors from image data
const getColors = require("get-image-colors");
// Require supporting npm modules to convert image colors to color names
const namer = require("color-namer");

exports.main = worker(async (source, rendition, params) => {
  // Perform any necessary source (input) checks
  const stats = await fs.stat(source.path);
  if (stats.size === 0) {
    // Throw appropriate errors whenever an erring condition is met
    throw new SourceCorruptError("source file is empty");
  }
  const MAX_COLORS = 10;
  const DEFAULT_COLORS_FAMILY = 'basic';

  // Read the color family parameter to use to derive the color names
  let colorsFamily = rendition.instructions.colorsFamily || DEFAULT_COLORS_FAMILY;

  if (['basic', 'hex', 'html', 'ntc', 'pantone', 'roygbiv'].indexOf(colorsFamily) === -1) {
      colorsFamily = DEFAULT_COLORS_FAMILY;
  }

  // Use the `get-image-colors` module to derive the most common colors from the image
  let colors = await getColors(source.path, { options: MAX_COLORS });

  // Convert the color Chroma objects to their closest names
  let colorNames = colors.map((color) => getColorName(colorsFamily, color));

  // Serialize the data to XMP metadata
  // These properties are written to the [dam:Asset]/jcr:content/metadata resource
  // This stores
  // - The list of color names is stored in a JCR property named `wknd:colors`
  // - The colors family used to derive the color names is stored in a JCR property named `wknd:colorsFamily`
  const xmp = serializeXmp({
      // Use a Set to de-duplicate color names
      "wknd:colors": [...new Set(colorNames)],
      "wknd:colorsFamily": colorsFamily
    }, {
      // Define any property namespaces used in the above property/value definition
      // These namespaces are automatically registered in AEM if they do not yet exist
      namespaces: {
        wknd: "https://wknd.site/assets/1.0/",
      },
    }
  );

  // Save the XMP metadata to be written back to the asset's metadata node
  await fs.writeFile(rendition.path, xmp, "utf-8");
});

/**
 * Helper function that derives the closest color name for the color, based on the colors family
 *
 * @param {*} colorsFamily the colors name family to use
 * @param {*} color the color to convert to a name
 */
function getColorName(colorsFamily, color) {
    if ('hex' === colorsFamily) {  return color; }

    let names = namer(color.rgb())[colorsFamily];

    if (names.length >= 1) { return names[0].name; }
}

Lokales Ausführen des Metadaten-Sekundärs development-tool

Wenn der Sekundär-Code vollständig ist, kann er mit dem lokalen Asset Compute-Entwicklungs-Tool ausgeführt werden.

Da unser Asset Compute-Projekt zwei Sekundäre enthält (die vorherige Kreisausgabe und diesen metadata-colors-Sekundär), listet die Profildefinition des Asset Compute-Entwicklungs-Tools Ausführungsprofile für beide Sekundäre auf. Die zweite Profildefinition verweist auf den neuen metadata-colors-Sekundär.

Testen des Sekundärs test

Metadaten-Sekundäre können mit dem gleichen Asset Compute-Test-Framework wie binäre Ausgabedarstellungen getestet werden. Der einzige Unterschied besteht darin, dass es sich bei der Datei rendition.xxx im Testfall um die erwartete XMP(XML)-Ausgabedarstellung handeln muss.

Bereitstellen des Sekundärs für Adobe I/O Runtime deploy

Um diesen neuen Metadaten-Sekundär aus AEM Assets aufzurufen, muss er mithilfe des folgenden Befehls für Adobe I/O Runtime bereitgestellt werden:

$ aio app deploy

Beachten Sie, dass dadurch alle im Projekt enthaltenen Sekundäre bereitgestellt werden. Lesen Sie die vollständigen Bereitstellungsanweisungen zur Bereitstellung in den Staging- und Produktionsarbeitsbereichen.

Integrieren mit AEM-Verarbeitungsprofilen processing-profile

Rufen Sie den Sekundär von AEM auf, indem Sie einen neuen Verarbeitungsprofil-Service erstellen oder einen vorhandenen benutzerdefinierten Verarbeitungsprofil-Service bearbeiten, der diesen bereitgestellten Sekundär aufruft.

Aktualisieren des Metadatenschemas metadata-schema

Um die Farbmetadaten zu überprüfen, ordnen Sie zwei neue Felder im Metadatenschema des Bildes den neuen Metadateneigenschaften zu, die der Sekundär auffüllt.

Verarbeitung von Assets

Mit den Farbmetadaten auf der [dam:Asset]/jcr:content/metadata-Ressource, die in die Metadaten des Assets geschrieben wurden, werden diese Metadaten mit der Möglichkeit indiziert, Assets mithilfe dieser Begriffe über die Suche zu erkennen, und sie können sogar in die Binärdatei des Assets zurückgeschrieben werden, wenn der Workflow DAM-Metadaten-Writeback aufgerufen wird.

Metadaten-Ausgabedarstellung in AEM Assets

Die tatsächliche XMP-Datei, die vom Asset Compute-Metadaten-Sekundär generiert wurde, wird ebenfalls als eigenständige Ausgabedarstellung für das Asset gespeichert. Diese Datei wird im Allgemeinen nicht verwendet. Stattdessen werden die auf den Metadatenknoten des Assets angewendeten Werte verwendet, aber die XML-Rohausgabe des Sekundärs ist in AEM verfügbar.

Code des Sekundärs „metadata-colors“ auf Github

Die endgültige metadata-colors/index.js ist auf Github verfügbar unter:

Die endgültige Testsuite für test/asset-compute/metadata-colors ist auf Github verfügbar unter: