Os trabalhadores do Custom Asset Compute podem produzir dados XMP (XML) que são enviados de volta ao AEM e armazenados como metadados em um ativo.
Os casos de uso comuns incluem:
Neste tutorial, criaremos um trabalhador de metadados do Asset Compute que deriva as cores mais usadas em um ativo de imagem e grava os nomes das cores de volta nos metadados do ativo no AEM. Embora o trabalhador em si seja básico, este tutorial o usa para explorar como os trabalhadores do Asset Compute podem ser usados para gravar metadados em ativos no AEM as a Cloud Service.
A invocação de trabalhadores de metadados do Asset Compute é quase idêntica à invocação de trabalhadores geradores de rendição binária, com a principal diferença sendo o tipo de retorno é uma representação XMP (XML) cujos valores também são gravados nos metadados do ativo.
Os trabalhadores do Asset Compute implementam o contrato de API do trabalhador do SDK do Asset Compute, na função renditionCallback(...)
, que é conceitualmente:
renditionCallback(...)
do trabalhador de metadados do Asset Compute personalizado, derivando uma representação XMP (XML), com base no binário do ativo (1a) e em qualquer parâmetro do Perfil de processamento (1b).rendition.path
.rendition.path
são transportados por meio do SDK do Asset Compute para o AEM Author Service e os expõem como (4a) uma representação de texto e (4b) persistem no nó de metadados do ativo.Todos os trabalhadores do Asset Compute devem ser registrados no manifest.yml.
Abra o manifest.yml
do projeto e adicione uma entrada de trabalhador que configure o novo trabalhador, neste caso metadata-colors
.
Lembre- .yml
se de que o espaço em branco é sensível.
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
aponta para a implementação do trabalhador criada na próxima etapa. Nomeie trabalhadores semanticamente (por exemplo, o actions/worker/index.js
pode ter sido mais bem nomeado actions/rendition-circle/index.js
), como eles mostram no URL do trabalhador e também determinam o nome da pasta do conjunto de testes do trabalhador.
Os limits
e require-adobe-auth
são configurados discretamente por trabalhador. Neste trabalhador, 512 MB
da memória é alocada conforme o código inspeciona (potencialmente) grandes dados de imagem binária. Os outros limits
são removidos para usar os padrões.
Crie um novo arquivo JavaScript de trabalhador de metadados no projeto do Asset Compute no caminho manifest.yml definido para o novo trabalhador, em /actions/metadata-colors/index.js
Instale os módulos npm adicionais (@adobe/asset-compute-xmp, get-image-colors e color-namer) que serão usados neste trabalhador do Asset Compute.
$ npm install @adobe/asset-compute-xmp
$ npm install get-image-colors
$ npm install color-namer
Esse trabalhador é muito semelhante ao trabalhador gerador de rendição, a principal diferença é que ele grava dados XMP (XML) no rendition.path
para ser salvo de volta no AEM.
"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 will be 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; }
}
Com o código do trabalhador concluído, ele pode ser executado usando a Ferramenta de desenvolvimento Asset Compute local.
Como nosso projeto do Asset Compute contém dois trabalhadores (a anterior representação de círculo e esse trabalhador metadata-colors
), a definição de perfil da Ferramenta de desenvolvimento do Asset Compute lista os perfis de execução para ambos os trabalhadores. A segunda definição de perfil aponta para o novo trabalhador metadata-colors
.
Na raiz do projeto Asset Compute
Execute aio app run
para iniciar a Ferramenta de desenvolvimento Asset Compute
No Selecione um arquivo… suspenso, escolha um imagem de amostra para processar
Na segunda configuração de definição de perfil, que aponta para o trabalhador metadata-colors
, atualize "name": "rendition.xml"
conforme esse trabalhador gera uma representação XMP (XML). Opcionalmente, adicione um parâmetro colorsFamily
(valores compatíveis basic
, hex
, html
, ntc
, pantone
, roygbiv
).
{
"renditions": [
{
"worker": "...",
"name": "rendition.xml",
"colorsFamily": "pantone"
}
]
}
Toque em Executar e aguarde a representação XML ser gerada
A seção Representações visualiza a representação gerada. Toque em rendition.xml
para baixá-lo e abra-o no Código VS (ou no editor de texto XML/favorito) para revisar.
Os trabalhadores de metadados podem ser testados usando a mesma estrutura de teste do Asset Compute que renderizações binárias. A única diferença é que o arquivo rendition.xxx
no caso de teste deve ser a representação XMP (XML) esperada.
Crie a seguinte estrutura no projeto do Asset Compute:
/test/asset-compute/metadata-colors/success-pantone/
file.jpg
params.json
rendition.xml
Use o arquivo de amostra como file.jpg
do caso de teste.
Adicione o seguinte JSON ao params.json
.
{
"fmt": "xml",
"colorsFamily": "pantone"
}
Observe que "fmt": "xml"
é necessário para instruir o conjunto de testes a gerar uma renderização baseada em texto .xml
.
Forneça o XML esperado no arquivo rendition.xml
. Para tal, pode recorrer-se:
<?xml version="1.0" encoding="UTF-8"?><rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:wknd="https://wknd.site/assets/1.0/"><rdf:Description><wknd:colors><rdf:Seq><rdf:li>Silver</rdf:li><rdf:li>Black</rdf:li><rdf:li>Outer Space</rdf:li></rdf:Seq></wknd:colors><wknd:colorsFamily>pantone</wknd:colorsFamily></rdf:Description></rdf:RDF>
Execute aio app test
a partir da raiz do projeto Asset Compute para executar todos os conjuntos de teste.
Para chamar esse novo trabalhador de metadados do AEM Assets, ele deve ser implantado no Adobe I/O Runtime, usando o comando:
$ aio app deploy
Observe que isso implantará todos os trabalhadores no projeto. Revise as instruções de implantação não resumidas para saber como implantar em espaços de trabalho de Preparo e Produção.
Chame o trabalhador do AEM criando um novo ou modificando um serviço de Perfil de processamento personalizado existente que chama esse trabalhador implantado.
https://...adobeioruntime.net/api/v1/web/wkndAemAssetCompute-0.0.1/metadata-colors
aio app get-url
. Verifique se o URL aponta para o espaço de trabalho correto com base no ambiente do AEM as a Cloud Service.colorFamily
pantone
basic
, hex
, html
, ntc
, pantone
, roygbiv
image/jpeg
, image/png
, image/gif
, image/svg
Leave blank
Para analisar os metadados de cores, mapeie dois novos campos no esquema de metadados da imagem para as novas propriedades de dados de metadados que o trabalhador preenche.
Colors Family
./jcr:content/metadata/wknd:colorsFamily
Colors
./jcr:content/metadata/wknd:colors
Colors Family
e Colors
campos de metadados para os metadados escritos a partir do trabalhador de metadados personalizado do Asset Compute.Com os metadados de cor gravados nos metadados do ativo, no recurso [dam:Asset]/jcr:content/metadata
, esses metadados são indexados e aumentam a capacidade de descoberta do ativo usando esses termos por meio da pesquisa, e podem até ser gravados de volta no binário do ativo se, em seguida, o fluxo de trabalho Writeback de metadados DAM for chamado nele.
O arquivo XMP real gerado pelo trabalhador de metadados do Asset Compute também é armazenado como uma representação discreta no ativo. Esse arquivo geralmente não é usado, em vez disso, os valores aplicados ao nó de metadados do ativo são usados, mas a saída XML bruta do trabalhador está disponível no AEM.
O metadata-colors/index.js
final está disponível no Github em:
O conjunto de testes final test/asset-compute/metadata-colors
está disponível no Github em: