Préparation de la page HTML pour le contenu Oracle Analytics imbriqué

Afin d'imbriquer du contenu Oracle Analytics, vous devez créer ou mettre à jour la page HTML pour inclure la déclaration DOCTYPE requise, l'attribut global dir, référencer la source JavaScript embedding.js et l'URL du classeur imbriqué. Vous devez également préciser le mode d'imbrication (JET ou autonome) ainsi qu'une méthode d'authentification, et ajouter des attributs.

Cette rubrique contient les informations suivantes :

Déclaration DOCTYPE

Définissez la déclaration DOCTYPE sur <!DOCTYPE html>. Un comportement inattendu se produit, par exemple la page n'affiche pas les résultats correctement, si vous utilisez une déclaration DOCTYPE autre que <!DOCTYPE html> ou si vous oubliez d'inclure une déclaration DOCTYPE.

Attribut global dir

Définissez l'attribut global dir comme requis par l'environnement local de la page Web. L'attribut global dir indique le sens de disposition du contenu Analytics imbriqué.

Remarque :

Si vous devez prendre en charge plusieurs environnements locaux, utilisez JavaScript pour définir l'attribut.

Les options de valeur de l'attribut sont les suivantes :

rtl : à utiliser pour un sens de mise en page de droite à gauche.
ltr : à utiliser pour un sens de mise en page de gauche à droite.
auto : ne pas l'utiliser. Cette valeur n'est pas prise en charge par Oracle Analytics.

Balise <script> et référencement de la source JavaScript

Remarque :

Oracle Analytics génère la balise <script> et l'URL de la source JavaScript à inclure.

Ajoutez une balise <script> qui référence embedding.js dans la page HTML.

Voici la structure de l'URL de la source JavaScript :

"https://<instance>.analytics.ocp.oraclecloud.com/public/dv/v1/embedding/<embeddingMode>/embedding.js". Les exemples de ce document utilisent cette URL.
Pour les déploiements plus anciens, utilisez : "http://<instance>.analytics.ocp.oraclecloud.com/ui/dv/v1/embedding/<embeddingMode>/embedding.js".

Où <embeddingMode> doit être jet ou standalone :

Employez jet si vous imbriquez du contenu Analytics dans une application Oracle JET existante. Si vous employez jet, la version d'Oracle JET utilisée par l'application doit correspondre à la version principale d'Oracle JET utilisée par Oracle Analytics. Par exemple, si Oracle Analytics utilise JET 11.0.0, l'application personnalisée doit utiliser JET 11.0.0 ou 11.1.0. Oracle Analytics utilise Oracle JET version 11.1.10.
Pour rechercher la version de JET utilisée par Oracle Analytics, connectez-vous à Oracle Analytics, ouvrez la console de navigateur et exécutez la commande suivante :
```
requirejs('ojs/ojcore').version
```
Si l'application d'imbrication utilise Oracle JET, Oracle Analytics étend l'application avec les composants nécessaires. Reportez-vous à Imbrication de contenu Oracle Analytics dans une application personnalisée utilisant Oracle JET.

Oracle JET consiste en un ensemble de bibliothèques JavaScript utilisées pour l'interface utilisateur Oracle Analytics.
Utilisez standalone lors de l'imbrication de contenu de visualisation dans une application générique qui n'utilise pas Oracle JET.

Si l'application d'imbrication n'utilise pas Oracle JET, Oracle Analytics effectue sa distribution JET vers la page avec des composants supplémentaires. Reportez-vous à Imbrication de contenu Oracle Analytics dans une application personnalisée n'utilisant pas Oracle JET.

Authentification

Vous avez besoin d'une session authentifiée pour afficher le contenu Analytics imbriqué. Vous pouvez utiliser une authentification par invite de connexion ou par protocole OAuth à trois acteurs. Reportez-vous à Ajout d'une authentification.

Elément <oracle-dv>

Pour imbriquer un classeur, vous devez ajouter le fragment de code HTML suivant avec les valeurs d'attribut dans un élément de taille appropriée. Oracle Analytics génère le code HTML à inclure.

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

Attributs pris en charge : ces attributs prennent en charge les propriétés et les chaînes statiques définies dans un modèle Knockout. Knockout est une technologie employée dans Oracle JET.

Remarque :

Pour voir un exemple de liaison de ces attributs à un modèle Knockout, reportez-vous à Imbrication de contenu Oracle Analytics dans une application personnalisée n'utilisant pas Oracle JET.

project-path : indique le chemin du classeur que vous voulez afficher.
active-page (facultatif) : indique si des informations clés autres que celles par défaut sont affichées. Lorsque vous indiquez active-page, vous devez également utiliser active-tab-id pour indiquer le canevas Présenter exact que vous affichez. La valeur valide est insight.

Remarque :
La valeur active-page canvas est en phase d'abandon. Oracle recommande de remplacer le code d'imbrication qui utilise canvas par insight. Le contenu Analytics imbriqué existant qui utilise canvas continue à fonctionner et un avertissement apparaît dans la console du navigateur.
active-tab-id (facultatif) : indique l'ID du canevas Visualiser ou Présenter affiché.
filters (facultatif) : permet la transmission par programmation des valeurs de filtre vers un classeur imbriqué.
project-options (facultatif) : dans cet attribut, project fait référence au classeur. Permet de transmettre les options suivantes :
- bDisableMobileLayout : désactive ou active la présentation mobile. La présentation mobile fait référence à la présentation de carte récapitulative disponible uniquement sur les appareils mobiles. La valeur doit être true ou false.
- bShowFilterBar : affiche ou masque la barre de filtre. La valeur doit être true ou false.
- showCanvasNavigation : affiche ou masque les canevas dans le classeur en fonction du paramètre de navigation du canevas dans l'onglet Présenter du classeur. La valeur doit être true ou false.
Par exemple, <oracle-dv project-path="{{projectPath}}" active-page="canvas" active-tab-id="1" filters="{{filters}}" project-options='{"bDisableMobileLayout":true, "bShowFilterBar":false}'></oracle-dv>
brushing-type : contrôle le fonctionnement du brushing. La valeur que vous indiquez remplace tous les autres paramètres, y compris les paramètres et valeurs par défaut système dans le classeur enregistré. La valeur doit être la chaîne on, off ou auto.
- on : permet d'émettre des requêtes de brushing avec une priorité normale. Les requêtes de brushing et de visualisation sont mélangées et exécutées en même temps.
- auto : valeur par défaut. Permet d'émettre des requêtes de brushing avec une priorité faible. Lorsqu'un utilisateur interagit avec une visualisation, l'affichage des marques dans les autres visualisations peut subir un délai jusqu'à la fin des requêtes de brushing.
compatibility-mode : à utiliser en présence de versions majeures différentes d'Oracle JET. Cela crée un iFrame au moment de l'exécution pour placer le contenu Analytics imbriqué dans un modèle d'environnement restreint. La valeur doit être la chaîne yes, no ou auto.
Remarque :

Lorsque vous définissez cet attribut, prenez en considération les deux éléments suivants :

Si vous utilisez le mode de compatibilité, vérifiez que l'option Autoriser les cadres est sélectionnée pour l'application que l'administrateur a inscrite en tant que domaine sécurisé. Reportez-vous à Inscription d'une application en tant que domaine sécurisé.
Pour rechercher la version de JET utilisée par Oracle Analytics, connectez-vous à Oracle Analytics, ouvrez la console de navigateur et exécutez la commande suivante :
```
requirejs('ojs/ojcore').version
```
- yes : à utiliser lorsque vous voulez toujours placer le contenu Analytics imbriqué dans un modèle d'environnement restreint. Cela est utile en cas d'imbrication dans des applications Oracle APEX.
- no : valeur par défaut. A utiliser lorsque vous ne voulez pas créer d'iFrame.
- auto : à utiliser pour détecter automatiquement les différences majeures de version d'Oracle JET entre l'application d'imbrication hôte et Oracle Analytics. Vous pouvez l'utiliser en cas d'imbrication dans Oracle APEX.

Exemple

Dans cet exemple, toutes les instances de project font référence au classeur.

<!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>