Preparación de la página HTML para el contenido embebido de Oracle Analytics

Para embeber contenido de Oracle Analytics, debe crear o actualizar la página HTML para incluir la declaración DOCTYPE necesaria, el atributo global dir, y hacer referencia al origen JavaScript embedding.js y a la URL del libro de trabajo embebido. También debe especificar el modo de embebido (JET o independiente), un método de autenticación y agregar los atributos necesarios.

Declaración doctype

Defina la declaración doctype en <!DOCTYPE html>. Se producirá un comportamiento impredecible, como que la página no se represente correctamente, si utiliza una declaración doctype distinta de <!DOCTYPE html> o si olvida incluir una declaración doctype.

Atributo global dir

Defina el atributo global dir según los requiera la configuración regional de la página web. El atributo global dir indica la dirección del diseño del contenido de análisis embebido.

Nota:

Si necesita soportar varias configuraciones regionales, utilice JavaScript para definir el atributo.

Las opciones de valor del atributo son las siguientes:

  • rtl: utilice esta opción para la dirección de diseño de derecha a izquierda.
  • ltr: utilice esta opción para la dirección de diseño de izquierda a derecha.
  • auto: no utilice esta opción. Este valor no está soportado por Oracle Analytics.

Referencia de etiqueta <script> y origen JavaScript

Nota:

Oracle Analytics genera la etiqueta <script> y la URL del origen de JavaScript que debe incluir.

Agregue una etiqueta <script> que haga referencia a embedding.js en su página HTML.

La estructura de la URL del origen de JavaScript es:
  • ”https://<instance>.analytics.ocp.oraclecloud.com/public/dv/v1/embedding/<embeddingMode>/embedding.js”. Los ejemplos de este documento utilizan esta URL.
  • Para despliegues anteriores, use: "http://<instance>.analytics.ocp.oraclecloud.com/ui/dv/v1/embedding/<embeddingMode>/embedding.js".

Donde <embeddingMode> debe ser jet o bien standalone:

  • Utilice jet si va a embeber contenido de análisis en una aplicación de Oracle JET existente. Si utiliza jet, la versión de Oracle JET que usa la aplicación debe coincidir con la versión principal de Oracle JET que utiliza Oracle Analytics. Por ejemplo, si Oracle Analytics usa JET 11.0.0, la aplicación personalizada debe usar JET 11.0.0 u 11.1.0. Oracle Analytics usa Oracle JET versión 11.1.10.

    Para buscar la versión de JET que usa Oracle Analytics, conéctese a Oracle Analytics, abra la consola del explorador y ejecute este comando:
    requirejs('ojs/ojcore').version

    Si la aplicación de embebido utiliza Oracle JET, Oracle Analytics amplía la aplicación con los componentes que necesita. Consulte Embebido de contenido de Oracle Analytics en una aplicación personalizada que utilice Oracle JET.

    Oracle JET es un juego de bibliotecas basadas en Javascript que se utiliza para la interfaz de usuario de Oracle Analytics.

  • Utilice standalone al embeber el contenido de visualización en una aplicación genérica que no utiliza Oracle JET.

    Si la aplicación de embebido no utiliza Oracle JET, Oracle Analytics aporta a la página su distribución JET con componentes adicionales. Consulte Embebido de contenido de Oracle Analytics en una aplicación personalizada que no utilice Oracle JET.

Autenticación

Necesita una sesión autenticada para ver el contenido de análisis embebido. Puede utilizar una autenticación mediante petición de datos de conexión u OAuth de 3 partes. Consulte Adición de autenticación.

<oracle-dv> Elemento

Para embeber un libro de trabajo, debe agregar el siguiente fragmento HTML con valores de atributo dentro de un elemento con el tamaño adecuado. Oracle Analytics genera el HTML que necesita incluir.

<oracle-dv project-path="" active-page="" active-tab-id="" filters=""></oracle—dv>

Atributos soportados: estos atributos soportan cadenas estáticas y propiedades definidas en un modelo Knockout. Knockout es una tecnología que se utiliza en Oracle JET.

Nota:

Consulte Embebido de contenido de Oracle Analytics en una aplicación personalizada que no utilice Oracle JET para ver un ejemplo del enlace de estos atributos a un modelo Knockout.

  • project-path: especifica la ruta del libro de trabajo que desea presentar.

  • active-page: (opcional) especifica si se presentan unas estadísticas distintas del valor por defecto. Si especifica active-page, también se utiliza active-tab-id para especificar el lienzo Presentar exacto que se muestra. El valor válido es insight.

    Nota:

    El valor de active-page canvas está en desuso. Oracle recomienda que modifique el código de embebido que utiliza canvas en insight. El contenido de análisis embebido existente que utiliza canvas seguirá funcionando y aparece una advertencia en la consola del explorador.
  • active-tab-id: (opcional) especifica el ID del lienzo Visualizar o el lienzo Presentar que se muestra.

  • filters: (opcional) permite la transferencia programática de valores de filtro a un libro de trabajo embebido.

  • project-options: (Opcional) En este atributo, con project se hace referencia a libro de trabajo. Permite transferir estas opciones:
    • bDisableMobileLayout: desactiva o activa el diseño para móvil. El diseño para móvil hace referencia al diseño de tarjeta de resumen disponible solo en dispositivos telefónicos. El valor debe ser true o false.
    • bShowFilterBar: muestra u oculta la barra de filtro. El valor debe ser true o false.
    • showCanvasNavigation: muestra u oculta los lienzos en el libro de trabajo según el valor de navegación de lienzos en el separador Presentar del libro de trabajo. El valor debe ser true o false.

    Por ejemplo, <oracle-dv project-path="{{projectPath}}" active-page="canvas" active-tab-id="1" filters="{{filters}}" project-options='{"bDisableMobileLayout":true, "bShowFilterBar":false}'></oracle-dv>

  • brushing-type: controla el funcionamiento del cepillado. El valor que especifique sustituye todos los demás valores, incluidos los valores por defecto del sistema y los valores del libro de trabajo guardado. El valor debe ser la cadena on, off o auto.
    • on: se utiliza para emitir consultas de cepillado con prioridad normal. Las consultas de cepillado y las consultas de visualización se mezclan y se ejecutan al mismo tiempo.
    • auto: valor por defecto. Se utiliza para emitir consultas de cepillado con prioridad baja. Cuando un usuario interactúa con una visualización, puede producirse un retraso que muestre marcas en otras visualizaciones hasta que se completen las consultas de cepillado.
  • compatibility-mode: utilícelo cuando haya diferentes versiones principales de Oracle JET. Crea un iFrame en tiempo de ejecución para incluir en un sandbox el contenido de análisis embebido. El valor debe ser la cadena yes, no o auto.

    Nota:

    Al definir este atributo, tenga en cuenta estos dos elementos:

    Si está utilizando el modo de compatibilidad, confirme que Permitir marcos está seleccionado para la aplicación que ha registrado su administrador como dominio seguro. Consulte Registro de una aplicación como un dominio seguro.

    Para buscar la versión de JET que usa Oracle Analytics, conéctese a Oracle Analytics, abra la consola del explorador y ejecute este comando:
    requirejs('ojs/ojcore').version
    • yes: utilice este valor cuando desee incluir en un sandbox el contenido de análisis embebido. Resulta útil al realizar un embebido en aplicaciones de Oracle APEX.
    • no: valor por defecto. Utilícelo cuando no desee crear un iFrame.
    • auto: utilice este valor para detectar automáticamente las diferencias principales en la versión de Oracle JET entre la aplicación de embebido de host y Oracle Analytics. Puede utilizarlo al realizar el embebido en Oracle APEX.

Ejemplo

En este ejemplo, todas las instancias de proyecto hacen referencia a libro de trabajo.

<!DOCTYPE html>
<html dir="ltr">
    <head>
        <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
        <title>Embedded Oracle Analytics Workbook Example</title>
        <script src="https://<instance>.analytics.ocp.oraclecloud.com/public/dv/v1/embedding/<embedding mode>/embedding.js" type="application/javascript">
        </script>

    </head>
    <body>
        <h1>Embedded Oracle Analytics Workbook</h1>
        <div style="border:1px solid black;position: absolute; width: calc(100% - 40px); height: calc(100% - 120px)" >
            <!--
            The following <oracle-dv> tag is the tag that will embed the specified workbook.
            -->
            <oracle-dv
               project-path="<project path>"
               active-page="insight"
               active-tab-id="snapshot!canvas!1">
            </oracle-dv>
        </div>
        <!--
        Apply Knockout bindings after DV workbook is fully loaded.  This should be executed in a body onload handler or in a <script> tag after the <oracle-dv> tag.
        -->
        <script>
        requirejs(['knockout', 'ojs/ojcore', 'ojs/ojknockout', 'ojs/ojcomposite', 'jet-composites/oracle-dv/loader'], function(ko) {
        ko.applyBindings();
        });
        </script>
    </body>
</html>