使用Adobe I/O Runtime動作處理的AEM事件

瞭解如何使用處理收到的AEM事件 Adobe I/O Runtime 動作。 此範例強化了先前的範例 Adobe I/O Runtime動作與AEM事件,在繼續此專案之前,請確定您已完成它。

在此範例中,事件處理會將原始事件資料和收到的事件儲存為活動訊息,並存放在Adobe I/O Runtime儲存體中。 但是,如果事件為 內容片段已修改 型別,然後它也會呼叫AEM作者服務來尋找修改詳細資料。 最後,它會在單頁應用程式(SPA)中顯示事件詳細資訊。

先決條件

若要完成本教學課程,您需要:

IMPORTANT
AEMas a Cloud Service事件僅適用於搶鮮版模式的註冊使用者。 若要在您的AEMas a Cloud Service環境中啟用AEM事件,請聯絡 AEM-Eventing團隊.

AEM Events處理器動作

在此範例中,事件處理器 動作 會執行下列工作:

  • 將收到的事件剖析為活動訊息。
  • 如果收到的事件為 內容片段已修改 型別,回撥AEM作者服務以尋找修改詳細資料。
  • 在Adobe I/O Runtime儲存空間中儲存原始事件資料、活動訊息和修改詳細資訊(如果有的話)。

若要執行上述工作,我們先將動作新增至專案,開發JavaScript模組以執行上述工作,最後更新動作程式碼以使用開發的模組。

請參閱附件中的 WKND-AEM-Eventing-Runtime-Action.zip 檔案以取得完整程式碼,而下節會醒目提示重要檔案。

新增動作

  • 若要新增動作,請執行以下命令:

    code language-bash
    aio app add action
    
  • 選取 @adobe/generator-add-action-generic 作為動作範本,將動作命名為 aem-event-processor.

    新增動作

開發JavaScript模組

為了執行上述工作,讓我們開發下列JavaScript模組。

  • src/dx-excshell-1/actions/aem-event-processor/eventValidator.js 模組會判斷收到的事件是否為 內容片段已修改 型別。

    code language-javascript
    async function needsAEMCallback(aemEvent) {
    // create a Logger
    const logger = Core.Logger('eventValidator', {
        level: 'info',
    });
    
    let isValid = false;
    
    // verify the event is a Content Fragment Modified event
    if (
        aemEvent
        && aemEvent.ContentType === 'contentFragment'
        && aemEvent.EventName === 'modified'
    ) {
        logger.info('Processing Content Fragment Modified Event');
        isValid = true;
    }
    
    return isValid;
    }
    
    module.exports = needsAEMCallback;
    
  • src/dx-excshell-1/actions/aem-event-processor/loadEventDetailsFromAEM.js 模組會呼叫AEM作者服務以尋找修改詳細資料。

    code language-javascript
    ...
    const auth = require('@adobe/jwt-auth');
    ...
    // Get AEM Service Credentials aka Technical Account details.
    // These are passed to the action as params and added in .env file.
    const clientId = params.AEM_SERVICECREDENTIALS_TECHNICALACCOUNT_CLIENTID;
    const technicalAccountId = params.AEM_SERVICECREDENTIALS_ID;
    const orgId = params.AEM_SERVICECREDENTIALS_ORG;
    const clientSecret = params.AEM_SERVICECREDENTIALS_TECHNICALACCOUNT_CLIENTSECRET;
    // Private key is passed as a string with \n and \r characters escaped.
    const privateKey = params.AEM_SERVICECREDENTIALS_PRIVATEKEY.replace(
        /\\n/g,
        '\n',
    ).replace(/\\r/g, '\r');
    const metaScopes = params.AEM_SERVICECREDENTIALS_METASCOPES.split(',');
    const ims = `https://${params.AEM_SERVICECREDENTIALS_IMSENDPOINT}`;
    
    // Get the access token from IMS using Adobe I/O SDK
    const { access_token } = await auth({
        clientId,
        technicalAccountId,
        orgId,
        clientSecret,
        privateKey,
        metaScopes,
        ims,
    });
    ...
    // Call AEM Author service to get the CF details using AEM Assets API
    const res = await fetch(
        `${aemAuthorHost}${cfPath.replace('/content/dam/', '/api/assets/')}.json`,
    {
      method: 'GET',
      headers: {
        'Content-Type': 'application/json',
        Authorization: `Bearer ${access_token}`,
      },
    },
    );
    
    let newValuesOfCFPropertiesAddedOrModified = {};
    // If the response is OK, get the values of the CF properties that were added or modified
    if (res.ok) {
        logger.info('AEM Event Details loaded from AEM Author instance');
        const responseJSON = await res.json();
    
        // Get the values of the CF properties that were added or modified
        if (
        responseJSON
        && responseJSON.properties
        && responseJSON.properties.elements
        ) {
        const allCurrentCFProperties = responseJSON.properties.elements;
    
        newValuesOfCFPropertiesAddedOrModified = cfPropertiesAddedOrModified.map(
            (key) => ({
            key,
            value: allCurrentCFProperties[key],
            }),
        );
        }
    }
    ...
    

    請參閱 AEM服務認證教學課程 以進一步瞭解。 此外, App Builder設定檔案 用於管理秘密和動作引數。

  • src/dx-excshell-1/actions/aem-event-processor/storeEventData.js 模組會將原始事件資料、活動訊息和修改詳細資料(如果有的話)儲存在Adobe I/O Runtime儲存空間。

    code language-javascript
    ...
    const filesLib = require('@adobe/aio-lib-files');
    ...
    
    const files = await filesLib.init();
    
    const eventDataAsJSON = JSON.stringify({
        activity: activityMessage,
        aemEvent,
        aemEventDetails,
    });
    
    // store details in a folder named YYYY-MM-DD and a file named <eventID>.json
    const bytesWritten = await files.write(
        `${formattedDate}/${aemEvent.getEventID()}.json`,
        eventDataAsJSON,
    );
    ...
    

更新動作程式碼

最後,請更新上的動作程式碼 src/dx-excshell-1/actions/aem-event-processor/index.js 以使用已開發的模組。

...
// handle the challenge probe request, they are sent by I/O to verify the action is valid
if (params.challenge) {
    logger.info('Challenge probe request detected');
    responseMsg = JSON.stringify({ challenge: params.challenge });
} else {
    logger.info('AEM Event request received');

    // create AEM Event object from request parameters
    const aemEvent = new AEMEvent(params);

    // get AEM Event as activity message using the helper method
    const activityMessage = aemEvent.getEventAsActivityMessage();

    // determine if AEM Event requires callback to AEM Author service
    const callbackAEMForEventDetails = await needsAEMCallback(aemEvent);

    let eventDetails = {};
    if (callbackAEMForEventDetails) {
    // call AEM Author service to get specifics about the event
    eventDetails = await loadEventDetailsFromAEMAuthorService(
        aemEvent,
        params,
    );
    }

    // store AEM Event and Event details in the file system
    const storageDetails = await storeEventData(
    activityMessage,
    aemEvent,
    eventDetails || {},
    );
    logger.info(`Storage details: ${JSON.stringify(storageDetails)}`);

    // create response message
    responseMsg = JSON.stringify({
    message: 'AEM Event processed',
    activityMessage,
    });

    // response object
    const response = {
    statusCode: 200,
    body: responseMsg,
    };
    logger.info('Adobe I/O Runtime action response', response);

    // Return the response to the caller
    return response;
}
...

其他資源

  • src/dx-excshell-1/actions/model 資料夾包含 aemEvent.jserrors.js 檔案,動作會使用這些檔案來分別剖析收到的事件和處理錯誤。
  • src/dx-excshell-1/actions/load-processed-aem-events 資料夾包含動作程式碼,SPA會使用此動作從Adobe I/O Runtime儲存空間載入已處理的AEM事件。
  • src/dx-excshell-1/web-src 資料夾內含SPA程式碼,會顯示已處理的AEM事件。
  • src/dx-excshell-1/ext.config.yaml 檔案包含動作設定和引數。

概念與主要要領

雖然專案之間的事件處理需求不同,但此範例的關鍵要點是:

  • 可以使用Adobe I/O Runtime動作完成事件處理。
  • 執行階段動作可與您的內部應用程式、協力廠商解決方案和Adobe解決方案等系統通訊。
  • 執行階段動作是商務程式的入口點,是針對內容變更而設計。
recommendation-more-help
4859a77c-7971-4ac9-8f5c-4260823c6f69