• Oracle Webチャネル。チャネルを作成すると、チャット・アプリケーションの初期化に必要なチャネルIDと秘密キーが生成されます。
• Oracle Chat ServerのURL。
• Oracle Technology NetworkのODAおよびOMCのダウンロード・ページから取得できるOracle Web SDK (Oracle Native Client SDKs for OCI Native Environmentsにあります)。このZIPをダウンロードしてローカル・システムに抽出します。このZIPには、SDKのクラスを説明するユーザー・ガイドと、その多くの機能をデモで示すサンプル・アプリケーションが含まれます。

• 認証は、JSON Web Token (JWT)を使用して強制されます。顧客のバックエンド・サーバーによってJWTトークンが生成され、その後Oracle Web SDKに渡されます。このトークンは、ODA音声、テキストまたはアタッチメント・サーバーへの各リクエストに使用されます。

  ノート
  
  チャネルへのアクセスを保護するには、トークンは常にリモート・サーバーで生成される必要があります。クライアント・ブラウザ内で生成されないようにしてください。

  WebアプリケーションではODAサーバーに接続する必要がある場合、まずバックエンド・サーバーからのトークンをリクエストし、次にそれを認可ヘッダーに追加します。ODAサーバーによってトークンが検証され、要求が評価された後、ソケットがオープンされるか、接続が拒否されます。

  ヒント:

  この記事では、認証済チャネルを使用してSDKを実行するステップを示します。
• 未認証モード – 未認証モードを使用するのは、クライアントが署名付きJWTトークンを生成できない場合、認証メカニズムが存在しない場合、またはクライアント・ウィジェットがすでに保護されていて認証済ユーザーから参照可能な場合です。

1. メニューから「開発」→「チャネル」を選択します。
2. 「ユーザー」を選択します。
3. 「チャネルの追加」をクリックし、チャネル・タイプとして「Oracle Web」をクリックします。
4. ダイアログを完成させます:
   • チャネル名を入力してください
   • 認証済接続の場合:
     • 「クライアント認証の有効化」トグルをオンに切り替えて、SDKがクライアント認証対応チャネルに接続しているかどうかを確認します。
     • チャネルは、カンマ区切りリストとして追加するドメインのサイトとのみ通信します。たとえば、*.corp.example.com, *.hdr.example.comです。アスタリスク(*)を1つ入力すると、任意のドメインからチャネルに無制限にアクセスできます。通常、開発時にアスタリスクを1つだけ入力します。本番では、ドメインの許可リストを追加します。
     • 「最大トークン有効期限(分)」で、JWTトークンの最大時間を設定します。
   • 未認証接続の場合:
     • 「クライアント認証の有効化」トグルをオフに切り替えます。
     • チャネルにアクセスできるドメインのカンマ区切りリストを入力します。この許可リスト内のドメインにアスタリスクが含まれている場合(*.hdr.example.com)、または許可リストが完全にはわからない場合は、認証された接続を検討できます。
   • セッションの有効期間を設定します。
   • 「作成」をクリックします。Oracle Digital Assistantによって、SDKの初期化に必要なチャネルIDと秘密キーが生成されます。これらは、チャット・ウィジェットをホストするようにHTMLページを構成する際に必要になるため、手近な場所に保持しておきます。
5. チャネルをスキルまたはデジタル・アシスタントにルーティングします。
6. 「チャネル有効」を「オン」に切り替えます。

1. ダウンロードしたOracle Web SDKの抽出済ZIPファイルで、(native-client-sdk-jsディレクトリにある) web-sdk.jsファイルを探します。
2. (抽出済ZIPのnative-client-sdk-jsディレクトリにある) web-sdk.jsをプロジェクト・ディレクトリに保存します。<script>タグのコードに<WebSDK URL>プロパティを定義する際に必要になるため、ファイルの場所をメモしておきます。
3. SDKを初期化する次の関数を使用して、JavaScriptファイルを作成します。このファイルは、SDKに付属するサンプルでsettings.jsと呼びます。

   //settings.js
   var chatSettings = {
       URI: '<Server URI>',
       channelId: '<Channel ID>',
       userId: '<User ID>'
   };
   
   function initSDK(name) {
       // If WebSDK is not available, reattempt later
       if (!document || !WebSDK) {
           setTimeout(function() {
               initSDK(name);
           }, 2000);
           return;
       }
   
       // Default name is Bots
       if (!name) {
           name = 'Bots';
       }
   
       setTimeout(function() {
           var Bots = new WebSDK(chatSettings);    // Initiate library with configuration
   
           var isFirstConnection = true;
           Bots.on(WebSDK.EVENT.WIDGET_OPENED, function() {
               if (isFirstConnection) {
                   Bots.connect()                          // Connect to server
                       .then(function() {
                           console.log('Connection Successful');
                       })
                       .catch(function(reason) {
                           console.log('Connection failed');
                           console.log(reason);
                       });
                      isFirstConnection = false;
               }
           });
   
           window[name] = Bots;
       }, 0);
   }

4. 次のプロパティを定義します:
   • URI - Oracle Digital AssistantインスタンスURLのホスト名。ここで渡す必要があるのは、最初のパス(/)のみです。このURLは、プロトコル(https://)の有無にかかわらず渡すことができます。
   • channelId - Oracle Webチャネルの作成時に生成されるチャネルID。基礎となるスキルにウィジェットを接続するため、このプロパティは必須です。
   • userId - ユーザーID。この値を指定すると、このスキルのユーザー・ベースをインサイトの一意のユーザー・メトリックで追跡できます。ユーザーIDを指定せず、SDKによって新しいセッションごとにIDが生成されます。このプロパティは、未認証接続ではオプションです。
5. HTMLページで、JSファイル(次の例ではsetting.js)のweb-sdk.jsライブラリとWeb SDKネームスペース(通常はBots)の両方の場所を参照します。このネームスペースを使用してパブリックAPIを起動します。たとえば、ネームスペースをBotsに設定した場合、Bots.<API>()としてAPIを起動します。様々な機能およびイベントの詳細は、Oracle Web SDKのZIPファイルに含まれているユーザー・ガイド(readmeとHTMLドキュメントの両方で利用可能)を参照してください。

      <script src="scripts/settings.js"></script>
      <script src="scripts/web-sdk.js" onload="initSdk('Bots')"></script>    

//settings.js
var chatSettings = {
    URI: '<Server URI>',
    clientAuthEnabled: true
};

function generateToken() {
    return new Promise(function(resolve) {
        fetch('https://yourbackend.com/endpointToGenerateJWTToken')
            .then(function(token) {
               resolve(token);
            })
            .catch(function(error) {
                console.log('Token generation error:', error);
            });
    });
}

function initSDK(name) {
    // If WebSDK is not available, reattempt later
    if (!document || !WebSDK) {
        setTimeout(function() {
            initSDK(name);
        }, 2000);
        return;
    }

    // Default name is Bots
    if (!name) {
        name = 'Bots';
    }

    setTimeout(function() {
        var Bots = new WebSDK(chatSettings, generateToken);    // Initiate library with configuration

        var isFirstConnection = true;
        Bots.on(WebSDK.EVENT.WIDGET_OPENED, function() {
            if (isFirstConnection) {
                Bots.connect()                          // Connect to server
                    .then(function() {
                        console.log('Connection Successful');
                    })
                    .catch(function(reason) {
                        console.log('Connection failed');
                        console.log(reason);
                    });
                   isFirstConnection = false;
            }
        });

        window[name] = Bots;
    }, 0);
}