Verbrauchsanalysen mit Headless Samples in Oracle Content Management integrieren

Einführung

Oracle Content Management stellt Funktionen zur Verbrauchsanalyse bereit, mit denen Sie die Nutzung und Popularität von Assets auf Sites verfolgen können. Die Aktivierung von Verbrauchsanalysen für Headless-Sites ist ein einfacher Vorgang, bei dem nur einige einfache Änderungen am Quellcode Ihrer Anwendung erforderlich sind.

In diesem Tutorial fügen wir der headless React-Blogbeispielsite Verbrauchsanalysen hinzu und zeigen die Analysen in Oracle Content Management an.

Dieses Tutorial konzentriert sich auf React, Sie können jedoch einen ähnlichen Ansatz für andere Web-Technologien verwenden, einschließlich Angular, Gatsby, Next.js, Svelte und Vue.js.

Das Tutorial besteht aus drei Schritten:

  1. Verbrauchsanalysen in Oracle Content Management aktivieren
  2. Beispielcode ändern
  3. Analyse anzeigen

Voraussetzungen

Bevor Sie mit diesem Tutorial fortfahren, sollten Sie zuerst folgende Informationen lesen:

Um diesem Tutorial zu folgen, benötigen Sie:

Aufgabe 1: Verbrauchsanalysen in Oracle Content Management aktivieren

Wenn noch keine Oracle Content Management-Instanz vorhanden ist, erfahren Sie unter Schnellstart, wie Sie sich für Oracle Cloud registrieren, eine Oracle Content Management-Instanz bereitstellen und Oracle Content Management als Headless CMS konfigurieren.

Nach der Einrichtung müssen Sie das System konfigurieren, um Verbrauchsanalysen zu aktivieren:

  1. Melden Sie sich als Administrator bei der Oracle Content Management-Weboberfläche an.

  2. Klicken Sie im linken Navigationsmenü auf System, und wählen Sie in der Dropdown-Liste die Option Analysen aus.

    Diese Abbildung zeigt die Systemeinstellungen.

  3. Aktivieren Sie unter "Verbrauchsanalysen" die Option Anlagenverbrauchsanalysen. Optional können Sie Ihren eigenen Infinity-Service aktivieren. Dies kann hilfreich sein, wenn die bereitgestellten Analysen zu begrenzt sind. Anschließend können Sie eine zusätzliche Infinity-Lizenz erwerben und mit Oracle Content Management verbinden. Normalerweise ist dies für die ersten Schritte mit Analysen nicht erforderlich. Dieses Tutorial behandelt dies nicht.

  4. Klicken Sie anschließend auf Speichern. Wir müssen Oracle Content Management lediglich anweisen, grundlegende Analysen zu erfassen, wie z.B. Laden und Anzeigen von Ereignissen in bestimmten Kanälen, Zugriff nach Region und Land, und welche Browser und Betriebssysteme Assets anzeigen.

Aufgabe 2: Beispielcode ändern

In diesem Tutorial erhalten wir Analysen für ein React-Blogbeispiel, wenn ein Benutzer eine der Unterseiten auf der Hauptseite anzeigt, wie z.B. die Seite "Trinkungen". Nachdem Verbrauchsanalysen konfiguriert wurden, können wir diese Analysen in der Oracle Content Management-Weboberfläche anzeigen.

Dieses Bild zeigt die Blog-Hauptseite.

Analytics-Skript hinzufügen

Die folgende generische Version des Analyseskripts muss in den HTML-Code der Seite eingefügt werden, für die Analysen erfasst werden sollen:

<script type="text/javascript" src="//<instance>.ocecdn.oraclecloud.com/_sitesclouddelivery/analytics/ocm-asset-analytics.js?channelId=<channel-id>" async></script>

Im Beispiel für den React-Blog wird das folgende Analyseskript zum HTML-Code hinzugefügt:

<script type="text/javascript" src={`//${process.env.SERVER_URL.replace(/^https?:\/\//,'')}/_sitesclouddelivery/analytics/ocm-asset-analytics.js?channelId=${process.env.CHANNEL_ID}`} async> </script>

Dies wird in der Datei TopicsListPage.jsx im angezeigten Komponentenabschnitt unter TopicsListContainer div hinzugefügt.

Beachten Sie, dass die Instanz die Server-URL ist, die in https://samples.mycontentdemo.com für die für Oracle Content Management verfügbaren Beispiele gehostet wird. Für das Analyseskript möchten wir den https://-Teil aus der Server-URL entfernen, die in der Datei (.env) der Umgebung aufgeführt ist. Deshalb wird .replace(/^https?:\/\//, '') hinzugefügt.

Das Analyseskript wird unter der Server-URL + /_sitesclouddelivery/analytics/ocm-asset-analytics.js gehostet, sodass das Skript zur Analyse der Ereignisse unter https://samples.mycontentdemo.com/_sitesclouddelivery/analytics/ocm-asset-analytics.js angezeigt wird. Beachten Sie, dass Analysen in Oracle Content Management aktiviert wurden (enableAnalytics ist wahr), und dass die Service-ID und die Account-ID hier in die Skriptinstanz eingebettet sind. Wir müssen uns nicht mit der Service-ID oder der Account-ID befassen.

Kanal-ID abrufen

Außerdem muss die Kanal-ID für den Content-Kanal abgerufen werden. Beachten Sie, dass die Kanal-ID und das Kanaltoken zwei separate IDs sind.

So suchen Sie die Kanal-ID:

  1. Melden Sie sich als Administrator bei der Oracle Content Management-Weboberfläche an.

  2. Klicken Sie im linken Navigationsmenü auf Inhalt, und wählen Sie in der Dropdown-Liste die Option Kanäle veröffentlichen aus.

  3. Wählen Sie den entsprechenden Kanal aus (OCEGettingStartedChannel für den Bloginhalt).

  4. Klicken Sie auf Bearbeiten, und öffnen Sie den Seitenbereich.

  5. Öffnen Sie den Bereich Eigenschaften und anschließend die Registerkarte API, um sowohl die Kanal-ID als auch das Kanaltoken anzuzeigen. Achten Sie darauf, das Kanaltoken nicht zu aktualisieren, wenn Sie an anderen Stellen wie der Umgebungsdatei hartcodiert sind.

Diese Abbildung zeigt die Schritte für die Kanal-ID.

Sie müssen diese Einstellung in der Datei (.env) vornehmen, indem Sie unten in der Datei Folgendes hinzufügen:

CHANNEL_ID=RCHANNELA57XXXXXXXXXXXXXXXXXXXXXXXXXXXX

Für das Beispiel für den React-Blog müssen Sie außerdem dem Abschnitt new webpack.DefinePlugin des Abschnitts plugin der Datei webpack.base.config.js Folgendes hinzufügen:

'process.env.CHANNEL_ID': JSON.stringify(process.env.CHANNEL_ID),

Seiteninstrumentierung hinzufügen

Um Anlagenverbrauchsereignisse automatisch aufzuzeichnen, müssen Sie dem gerenderten Anlagen-Markup auf der Seite ein spezielles "Daten"-Attribut hinzufügen. Das Attribut data-asset-operation weist die Library ocm-asset-analytics.js an, automatisch analytische Ereignisse zu erstellen.

Details dazu, welche Werte in das Datenattribut eingefügt werden sollen, finden Sie in der Oracle Content Management-Dokumentation.

Für das Beispiel des React-Blogs, da wir Analysen erhalten möchten, wenn ein Benutzer eine der Unterseiten auf der Hauptseite anzeigt, wie z.B. die Seite "Getränke", soll das Attribut data-asset-operation wie folgt lauten:

<div data-asset-operation={`view:${topic.id}:view`} />

Dieser wird im HTML-Code neben jedem TopicListItem platziert. Das Attribut data-asset-operation gibt hier an, dass ein Log über die Registerkarte "Netzwerk" in einer Ansicht des relevanten Seitenassets gesendet wird, wenn ein Benutzer auf eine Unterseite von der Listenseite der Top-Level-Themen klickt.

Übersicht über alle Codeänderungen in React Blog Beispiel

So sieht der Code TopicsListPage aus, nachdem das Analyseskript und das Attribut data-asset-operation injiziert wurden:

return (
<div data-testid="TopicsListContainer">
   <script type="text/javascript" src={`//${process.env.SERVER_URL.replace(/^https?:\/\//, '')}/_sitesclouddelivery/analytics/ocm-asset-analytics.js?channelId=${process.env.CHANNEL_ID}`} async> </script>
   <Header
      companyTitle={companyTitle}
      companyThumbnailRenditionUrls={companyThumbnailRenditionUrls}
      aboutUrl={aboutUrl}
      contactUrl={contactUrl}
   />
   {topics && (
   <div id="topics">
      {topics.map(
      (topic) => (
         <><div data-asset-operation={`view:${topic.id}:view`} /><TopicsListItem topic={topic} key={topic.id} /></>
      ),
      )}
   </div>
   )}
</div>
);

Außerdem mussten wir die Kanal-ID abrufen, den Parameter CHANNEL_ID in der .env-Datei hinzufügen und den Abschnitt "webpack.base.config.js-Datei-Plug-in" aktualisieren, um diese Ergänzung der Umgebungsvariablen anzugeben.

Aufgabe 3: Analytics anzeigen

Jetzt sollten wir die Ereignisse analysieren können. Sehen wir uns den HTML-Code auf der Blog-Homepage an:

Diese Abbildung zeigt die HTML der Homepage des Blogs.

Beachten Sie, wie das Analyseskript und das Attribut data-asset-operation jetzt dem HTML-Code hinzugefügt werden. Damit werden Analysedaten an eine Infinity Analytics-Instanz von Oracle gesendet. Die Netzwerkereignisnamen, die mit "dcs.gif" beginnen, sind alle Analysen, die in der Anforderungs-URL verarbeitet und übertragen werden, die im Analyseskript analysiert wird.

Diese Abbildung zeigt die Registerkarte "Netzwerk".

Die Analysedaten werden täglich von Infinity abgefragt und in der Oracle Content Management-Weboberfläche angezeigt. Beachten Sie, dass die Anzeige der Analysen einige Zeit in Anspruch nimmt und die Daten in der Regel um etwa einen Tag verzögert werden. Um die Analysen anzuzeigen, klicken Sie auf die Anlage, navigieren Sie zum Menüsymbol oben rechts, um die Seitenleiste zu öffnen, und wählen Sie im Dropdown-Menü die Option Analysen aus. Beachten Sie, dass in der unteren rechten Ecke angezeigt wird, wann die Daten zuletzt aktualisiert wurden.

In dieser Abbildung werden die Analysen angezeigt.

Schlussfolgerung und nächste Schritte

In diesem Tutorial haben wir Verbrauchsanalysen aktiviert und das Headless React-Blogbeispiel geändert, um diese Analysen für eine Infinity-Analyseinstanz bereitzustellen. Schließlich haben wir diese Analysen direkt in Oracle Content Management angezeigt.

Ein weiterer nächster Schritt für erweiterte Features könnte sein, dass Sie Ihren persönlichen Infinity Analytics-Account einrichten und Oracle Content Management für die Verwendung dieses Accounts konfigurieren.