C Discoverer接続API

この付録では、Discoverer接続APIについて説明します。この付録の内容は次のとおりです。

• 第C.1項「Oracle BI Discoverer接続」

• 第C.2項「Discoverer接続API」

• 第C.3項「Discoverer接続APIコマンド」

• 第C.4項「Discoverer接続APIコマンド修飾子」

• 第C.5項「Discoverer接続APIを使用するための前提条件」

• 第C.6項「このマニュアルで使用するコマンド構文規則」

• 第C.7項「コマンドの構文」

• 第C.8項「Discoverer接続APIコマンドの実行方法」

• 第C.9項「オペレーティング・システムのコマンド・プロンプトで直接コマンドを実行する方法」

• 第C.10項「オペレーティング・システムのコマンド・ファイルに格納されている複数のコマンドを実行する方法」

• 第C.11項「Oracle BI Discoverer接続を作成、編集、および削除する方法」

• 第C.12項「Discoverer接続APIコマンド・リファレンス」

• 第C.13項「Discoverer接続APIコマンド修飾子リファレンス」

C.1 Oracle BI Discoverer接続

Oracle BI Discoverer接続とは、保存されたログイン詳細(データベース・ユーザー名、データベース・パスワード、データベース名など)のセットです。Oracle BI Discoverer接続により、エンド・ユーザーはログイン詳細を入力せずにOracle BI Discovererを起動することができます。

Oracle BI Discoverer接続は、次のようなパブリック接続またはプライベート接続です。

• プライベートのOracle BI Discoverer接続は、個々のOracle BI Discovererエンド・ユーザー(通常、OracleAS Single Sign-Onユーザー)のみがアクセス可能です。たとえば、OracleAS Single Sign-Onユーザーであるjchanに対して作成される「Western data analysis」というOracle BI Discoverer接続は、このユーザーjchanのみがアクセス可能です。

• パブリックのOracle BI Discoverer接続は、すべてのOracle BI Discovererエンド・ユーザーがアクセス可能です。たとえば、「Global data analysis」というパブリックのOracle BI Discoverer接続は、すべてのOracle BI Discovererエンド・ユーザーがアクセスできます。

  Oracle BI Discoverer Plus OLAPではプライベート接続のみ使用可能です。パブリック接続はサポートされていません。ただし、Oracle BI Discoverer ViewerおよびOracle BI Discoverer Portlet Providerとのパブリック接続を使用して、Oracle BI Discoverer Plus OLAPで作成したワークシートにアクセスすることはできます。

C.2 Discoverer接続API

Discoverer接続APIはテキストベースのコマンドのセットで、ユーザーがプログラムによってOracle BI Discoverer接続を作成および操作できるようにします。たとえば、Discoverer接続APIを使用して、Oracle Business IntelligenceインストールのOracle BI Discoverer接続セットを作成することができます。

Discoverer接続APIでは、次の3種類のデータ・ソースに対し、パブリックとプライベートの両方のOracle BI Discoverer接続を作成および操作できます。

• リレーショナル・データ・ソース

• OLAPデータ・ソース

• Oracle Applicationsデータ・ソース

Discoverer接続APIコマンドは、オペレーション・システムのコマンド・プロンプトで個々に実行することも、オペレーション・システムのコマンド・ファイルからバッチモードで実行することもできます(詳細は、第C.8項「Discoverer接続APIコマンドの実行方法」を参照)。

注意

• Oracle BI Discovererエンド・ユーザーは、必要な権限を持っていれば、Oracle BI Discoverer PlusおよびOracle BI Discoverer Viewerの起動に使用される「Oracle BI Discovererに接続」ページを使用して、プライベートのOracle BI Discoverer接続の作成、編集、および削除を行うこともできます。「Oracle BI Discovererに接続」ページの表示の詳細は、『Oracle Fusion Middleware Oracle Business Intelligence Discoverer Plusユーザーズ・ガイド』または『Oracle Fusion Middleware Oracle Business Intelligence Discoverer Viewerユーザーズ・ガイド』を参照してください。

• 中間層管理者は、「Oracle BI Discovererパブリック接続」ページを使用して、パブリックのOracle BI Discoverer接続を作成、編集、および削除することもできます。このページには、Fusion Middleware Controlの「Oracle BI Discoverer管理」タブからアクセスできます。パブリック接続の管理の詳細は、『Oracle Fusion Middleware Oracle Business Intelligence Discoverer構成ガイド』を参照してください。

C.3 Discoverer接続APIコマンド

Discoverer接続APIコマンドは、Oracle BI Discoverer接続の作成、更新、または削除を行う命令です。たとえば、-create_connコマンドは新しいOracle BI Discoverer接続を作成します。各Discoverer接続APIコマンドの説明は、第C.12項「Discoverer接続APIコマンド・リファレンス」を参照してください。

C.4 Discoverer接続APIコマンド修飾子

Discoverer接続APIコマンド修飾子は、Discoverer接続APIコマンドを修飾または調整する指示です。たとえば、-typeコマンド修飾子は、Oracle BI Discoverer接続がパブリックであるかプライベートであるかを表します。各Discoverer接続APIコマンド修飾子の説明は、第C.13項「Discoverer接続APIコマンド修飾子リファレンス」を参照してください。

C.5 Discoverer接続APIを使用するための前提条件

Discoverer接続APIを使用するには、次の条件を満たす必要があります。

• Discoverer中間層を接続するOracle Internet Directoryの管理者ログイン資格証明を知っていること。

  Oracle Internet Directoryの詳細は、プライベート接続の作成時にのみ必要になります。Discoverer接続APIを使用するには、コマンド-ldapconnect orcladmin/<orcladmin password>を使用してorcladminユーザーとして接続する必要があります。

  注意: orcladminは、Oracle Internet Directoryのデフォルトの管理者名です。

  orcladminパスワードを確認する必要がある場合は、ldapsearchコマンドを使用します(詳細は、Oracle Fusion Middleware Oracle Identity Managementリファレンスを参照)。

• WebLogicドメイン管理者名(デフォルトではweblogic)とパスワードを知っていること。

  Discovererのプライベートおよびパブリック接続の詳細が格納されているスキーマにアクセスするには、コマンド-wlsconnect weblogic/<weblogic password>を使用してweblogicユーザーとして接続する必要があります。

• Discoverer Java EEアプリケーションがデプロイされているWebLogic管理対象サーバーのURLを知っていること。

  注意: このマニュアルでは、このURLを<WLS_DISCO URL>と表記します。このURLは、t3://<host>:<wls_disco port>の書式で指定する必要があります。

• Oracle Business Intelligenceのインストールに対してOracleAS Single Sign-Onを有効にすること(Discoverer接続APIを使用してプライベートのOracle BI Discoverer接続を作成する場合)。

C.6 このマニュアルで使用するコマンド構文規則

このマニュアルで使用するコマンド構文規則は次のとおりです。

• コマンドおよびコマンド修飾子は標準のフォントで示し、先頭にはダッシュ(-)を付けています。

  注意: ダッシュは必ず入力してください。

• 必須のコマンド・テキストは、山カッコ< >で囲んでいます。

  注意: 山カッコ自体は入力しないでください。

• オプションのコマンド・テキストは、大カッコ[ ]で囲んでいます。

  注意: 大カッコ自体は入力しないでください。

• 変数コマンド・テキスト(値を指定する部分)はイタリック体で示しています。

• コマンド・テキストがパイプ文字(|)で区切られ、リストになっている部分では、そのリストから1つを選択します。たとえば、「-olap <"true" | "false">」は-olap "true"または-olap "false"を指定することを意味します。

  注意: パイプ文字自体は入力しないでください。

C.7 コマンドの構文

Discoverer接続APIコマンドには次の構文を使用します。

• Windowsの場合、次の構文を使用します。

  capi.bat <-コマンド> <コマンド修飾子>

• UNIXの場合、次の構文を使用します。

  capi.sh <-コマンド> <コマンド修飾子>

注意:

• コマンドおよびコマンド修飾子では、大文字と小文字が区別されます。つまり、大文字のかわりに小文字、小文字のかわりに大文字を使用できません。

• 特に記載がないかぎり、変数コマンド引数では、大文字と小文字は区別されません。

• コマンド修飾子は、その引数が直後に正しい順序で続いている場合、どのような順序で指定しても構いません。

• コマンドは、改行やキャリッジ・リターンを使用せず、1行で指定する必要があります。

• コマンド修飾子引数は、二重引用符("")で囲みます。たとえば、End User LayerがVideo Store Analysisと呼ばれる場合、End User Layer名は-eul "Video Store Analysis"と指定します。

C.8 Discoverer接続APIコマンドの実行方法

Discoverer接続APIコマンドは、次の2通りの方法で実行できます。

• オペレーティング・システムのコマンド・プロンプトで直接コマンドを実行する(詳細は、第C.9項「オペレーティング・システムのコマンド・プロンプトで直接コマンドを実行する方法」を参照)。

• オペレーティング・システムのコマンド・ファイルに格納された複数のコマンドを実行する(詳細は、第C.10項「オペレーティング・システムのコマンド・ファイルに格納されている複数のコマンドを実行する方法」を参照)。

C.9 オペレーティング・システムのコマンド・プロンプトで直接コマンドを実行する方法

Oracle BI Discoverer接続を管理するには、コマンド・プロンプトでDiscoverer接続APIコマンドを直接実行すると便利です。たとえば、Oracle BI Discovererの「Oracle BI Discovererに接続」ページを使用せずに、OLAPデータ・ソースのパブリックOracle BI Discoverer接続を作成できます。

オペレーティング・システムのコマンド・プロンプトで直接コマンドを実行するには:

1. オペレーティング・システムのコマンド・プロンプトを表示します。

2. コマンドを入力します。

   たとえばWindowsでOLAPデータ・ソースのパブリックOracle BI Discoverer接続を作成する場合、次のようなコマンドを入力します。

   capi.bat -create_conn -wlsurl <WLS_DISCO URL>
    -wlsconnect weblogic/<weblogic password> -ldapurl <OID URL>
    -ldapconnect orcladmin/<orcladmin password> -cname "Analyze Sales Q1"
    -cdesc "Analyze Sales First Quarter" -type "public" -olap "true"
    -apps "false" -dbuser "jchan" -dbpasswd "12345" -dbname "host1:1521:DB2"
    -showdetails "true"
   

C.10 オペレーティング・システムのコマンド・ファイルに格納されている複数のコマンドを実行する方法

Oracle BI Discoverer接続を管理するには、オペレーティング・システムのコマンド・ファイルに格納されている複数のコマンドを実行すると便利です。たとえば、Fusion Middleware Controlを使用せずに、パブリックのOracle BI Discoverer接続セットを作成できます。

ユーザーは、Oracle Business Intelligence中間層マシンのutilディレクトリに保存されているWindows *.batファイルまたはUNIX *.shファイルに、Discoverer接続APIコマンドを作成します。たとえば、Windowsでは、<ORACLE_INSTANCE>/Discoverer/Discoverer_<instance-name>/util/にcreate_connections.batというバッチ・ファイルを作成できます。

コマンド・ファイルに1行につき1コマンドずつ、次のようにDiscoverer接続APIコマンドを入力します。

• Windowsでは、次のように、各コマンドの先頭に「call」を付け、その後にスペースを入れます。

  call capi.bat <-command> <mandatory command modifiers> [optional command modifiers] -wlsurl <WLS_DISCO URL> -wlsconnect weblogic/<weblogic password> -ldapurl <OID URL> -ldapconnect orcladmin/<orcladmin password>

• UNIXでは、次のように各コマンドの先頭に「./」を付けます。

  ./capi.sh <-command> <mandatory command modifiers> [optional command modifiers]-wlsurl <WLS_DISCO URL> -wlsconnect weblogic/<weblogic password> -ldapurl <OID URL> -ldapconnect orcladmin/<orcladmin password>

たとえば、Windowsで「Analyze Sales Q1」、「Analyze Sales Q2」、「Analyze Sales Q3」という3つのOracle BI Discoverer接続を作成する場合、コマンド・ファイルには次のようなテキストが含まれます。

call capi.bat -create_conn -wlsurl <WLS_DISCO URL> -wlsconnect weblogic/<weblogic password> -cname "Analyze Sales Q1" -cdesc "Analyze Sales First Quarter" -type "public" -olap "false" -apps "false" -dbuser "jchan" -dbpasswd "12345" -dbname "db1" -showdetails "true"
call capi.bat -create_conn -wlsurl <WLS_DISCO URL> -wlsconnect weblogic/<weblogic password> -cname "Analyze Sales Q2" -cdesc "Analyze Sales Second Quarter" -type "public" -olap "false" -apps "false" -dbuser "jchan" -dbpasswd "12345" -dbname "db1" -showdetails "true"
call capi.bat -create_conn -wlsurl <WLS_DISCO URL> -wlsconnect weblogic/<weblogic password> -cname "Analyze Sales Q3" -cdesc "Analyze Sales Third Quarter" -type "public" -olap "false" -apps "false" -dbuser "jchan" -dbpasswd "12345" -dbname "db1" -showdetails "true"

オペレーティング・システムのコマンド・ファイルに格納されている複数のコマンドを実行するには:

1. 次のように、Discoverer接続APIがインストールされているディレクトリにコマンド・ファイルを作成します。

   • Windowsの場合、バッチ(*.bat)ファイルを作成します(例: <ORACLE_INSTANCE>\Discoverer\Discoverer_<インスタンス名>\util\create_connections.bat)。

   • UNIXの場合、スクリプト(*.sh)ファイルを作成します(例: <ORACLE_INSTANCE>/Discoverer/Discoverer_<インスタンス名>/util/create_connections.sh)。

2. コマンド・ファイルにDiscoverer接続APIコマンドを入力(またはコピー)します。

3. コマンド・ファイルを実行します。

   たとえば、コマンド・プロンプトを開き、コマンド・ファイル名を入力して[Enter]キーを押します。

C.11 Oracle BI Discoverer接続を作成、編集、および削除する方法

この項では、Oracle BI Discoverer接続を作成、編集および削除する方法について説明します。この項の内容は次のとおりです。

• 第C.11.1項「リレーショナル・データ・ソースに対するプライベートのOracle BI Discoverer接続を作成する方法」

• 第C.11.2項「リレーショナル・データ・ソースに対するパブリックのOracle BI Discoverer接続を作成する方法」

• 第C.11.3項「OLAPデータ・ソースに対するプライベートのOracle BI Discoverer接続を作成する方法」

• 第C.11.4項「OLAPデータ・ソースに対するパブリックのOracle BI Discoverer接続を作成する方法」

• 第C.11.5項「Oracle Applicationsデータ・ソースに対するプライベートのOracle BI Discoverer接続を作成する方法」

• 第C.11.6項「Oracle Applicationsデータ・ソースに対するパブリックのOracle BI Discoverer接続を作成する方法」

• 第C.11.7項「リレーショナル・データ・ソースに対するプライベートのOracle BI Discoverer接続を更新する方法」

• 第C.11.8項「リレーショナル・データ・ソースに対するプライベートのOracle BI Discoverer接続を削除する方法」

注意: この項は、Discoverer接続APIを使用して行う各タスクについて説明するものではありません。使用可能なコマンドについての総合的な参照情報は、第C.12項「Discoverer接続APIコマンド・リファレンス」を参照してください。

C.11.1 リレーショナル・データ・ソースに対するプライベートのOracle BI Discoverer接続を作成する方法

1人のエンド・ユーザーがログイン詳細を入力せずにOracle BI Discovererを起動し、リレーショナル・データを分析できるようにするには、リレーショナル・データ・ソースに対するプライベートのOracle BI Discoverer接続を作成します。

リレーショナル・データ・ソースに対するプライベートのOracle BI Discoverer接続を作成するには:

1. 次の構文に基づいてコマンドを入力します。

   capi.bat | capi.sh -create_conn -wlsurl <WLS_DISCO URL> -wlsconnect weblogic/<weblogic password> -ldapurl <OID URL> -ldapconnect orcladmin/<orcladmin password> -cname <"Discoverer connection name"> [-cdesc <"Discoverer connection description">] -sso_user <"Single Sign-On user name" -type "private" -olap "false" -apps "false" -dbuser <"Database user name"> -dbpasswd <"Database password"> -dbname <"Database name"> -eul <"End User Layer name"> [-showdetails <"true" | "false">] [-locale <"Locale">]

   次のコマンド例は、Windows上でリレーショナル・データ・ソースに対するプライベートのOracle BI Discoverer接続を作成します。

   capi.bat -create_conn -wlsurl <WLS_DISCO URL> -wlsconnect weblogic/weblogic -ldapurl <OID URL> -ldapconnect orcladmin/tiger -cname "Analyze Sales" -cdesc "Analyze Sales First Quarter" -sso_user "jchan" -type "private" -olap "false" -apps "false" -dbuser "jchan" -dbpasswd "12345" -dbname "db1" -eul "Video Stores" -showdetails "true" -locale "EN_US"

C.11.2 リレーショナル・データ・ソースに対するパブリックのOracle BI Discoverer接続を作成する方法

複数のエンド・ユーザーがログイン詳細を入力せずにOracle BI Discovererを起動し、リレーショナル・データを分析できるようにするには、リレーショナル・データ・ソースに対するパブリックのOracle BI Discoverer接続を作成します。

リレーショナル・データ・ソースに対するパブリックのOracle BI Discoverer接続を作成するには:

1. 次の構文に基づいてコマンドを入力します。

   capi.bat | capi.sh -create_conn -wlsurl <WLS_DISCO URL> -wlsconnect weblogic/<weblogic password> -cname <"Discoverer connection name"> [-cdesc <"Discoverer connection description">] -type "public" -olap "false" -apps "false" -dbuser <"Database user name"> [-dbpasswd <"Database password">] -dbname <"Database name"> -eul <"End User Layer name"> [-showdetails <"true" | "false">] [-locale <"Locale">]

   次のコマンド例は、Windows上でリレーショナル・データ・ソースに対するパブリックのOracle BI Discoverer接続を作成します。

   capi.bat -create_conn -wlsurl <WLS_DISCO URL> -wlsconnect weblogic/weblogic -cname "Analyze Sales" -cdesc "Analyze Sales First Quarter" -type "public" -olap "false" -apps "false" -dbuser "jchan" -dbpasswd "12345" -dbname "db1" -eul "Video Stores" -showdetails "true" -locale "EN_US"

C.11.3 OLAPデータ・ソースに対するプライベートのOracle BI Discoverer接続を作成する方法

1人のエンド・ユーザーがログイン詳細を入力せずにOracle BI Discovererを起動し、多次元データを分析できるようにするには、OLAPデータ・ソースに対するプライベートのOracle BI Discoverer接続を作成します。

OLAPデータ・ソースに対するプライベートのOracle BI Discoverer接続を作成するには:

1. 次の構文に基づいてコマンドを入力します。

   capi.bat | capi.sh -create_conn -wlsurl <WLS_DISCO URL> -wlsconnect weblogic/<weblogic password> -ldapurl <OID URL> -ldapconnect orcladmin/<orcladmin password> -cname <"Discoverer connection name"> [-cdesc <"Discoverer connection description">] -sso_user <"Single Sign-On user name"> -type "private" -olap "true" -apps "false" -dbuser <"Database user name"> -dbpasswd <"Database password"> -dbname <"Database name"> [-showdetails <"true" | "false">] [-locale <"Locale">]

   次のコマンド例は、Windows上でOLAPデータ・ソースに対するプライベートのOracle BI Discoverer接続を作成します。

   capi.bat -create_conn -wlsurl <WLS_DISCO URL> -wlsconnect weblogic/weblogic -ldapurl <OID URL> -ldapconnect orcladmin/tiger -cname "Analyze Sales" -cdesc "Analyze Sales First Quarter" -sso_user "jchan" -type "private" -olap "true" -apps "false" -dbuser "jchan" -dbpasswd "12345" -dbname "host1:1521:DB2" -showdetails "true" -locale "EN_US"

C.11.4 OLAPデータ・ソースに対するパブリックのOracle BI Discoverer接続を作成する方法

複数のエンド・ユーザーがログイン詳細を入力せずにOracle BI Discovererを起動し、多次元データを分析できるようにするには、OLAPデータ・ソースに対するパブリックのOracle BI Discoverer接続を作成します。

Oracle BI Discoverer Plus OLAPではパブリック接続はサポートされていません。ただし、Oracle BI Discoverer ViewerおよびOracle BI Discoverer Portlet Providerとのパブリック接続を使用して、Oracle BI Discoverer Plus OLAPで作成したワークシートにアクセスすることはできます。

OLAPデータ・ソースに対するパブリックのOracle BI Discoverer接続を作成するには:

1. 次の構文に基づいてコマンドを入力します。

   capi.bat | capi.sh -create_conn -wlsurl <WLS_DISCO URL> -wlsconnect weblogic/<weblogic password> -cname <"Discoverer connection name"> [-cdesc <"Discoverer connection description">] -type "public" -olap "true" -apps "false" -dbuser <"Database user name"> [-dbpasswd <"Database password">] -dbname <"Database name"> [-showdetails <"true" | "false">] [-locale <"Locale">]

   次のコマンド例は、Windows上でOLAPデータ・ソースに対するパブリックのOracle BI Discoverer接続を作成します。

   capi.bat -create_conn -wlsurl <WLS_DISCO URL> -wlsconnect weblogic/weblogic -cname "Analyze Sales" -cdesc "Analyze Sales First Quarter" -type "public" -olap "true" -apps "false" -dbuser "jchan" -dbpasswd "12345" -dbname "host1:1521:DB2" -showdetails "true" -locale "EN_US"

C.11.5 Oracle Applicationsデータ・ソースに対するプライベートのOracle BI Discoverer接続を作成する方法

1人のエンド・ユーザーがログイン詳細を入力せずにOracle BI Discovererを起動し、Oracle Applicationsデータを分析できるようにするには、Oracle Applicationsデータ・ソースに対するプライベートのOracle BI Discoverer接続を作成します。

Oracle Applicationsデータ・ソースに対するプライベートのOracle BI Discoverer接続を作成するには:

1. 次の構文に基づいてコマンドを入力します。

   capi.bat | capi.sh -create_conn -wlsurl <WLS_DISCO URL> -wlsconnect weblogic/<weblogic password> -ldapurl <OID URL> -ldapconnect orcladmin/<orcladmin password> -cname <"Discoverer connection name"> [-cdesc <"Discoverer connection description">] -sso_user <"Single Sign-On user name"> -type "private" -olap "false" -apps "true" -dbuser <"Database user name"> [-dbpasswd <"Database password">] -dbname <"Database name"> -eul <"End User Layer name"> -resp <"Oracle Applications Responsibility"> -sg <"Oracle Applications Security Group"> [-showdetails <"true" | "false">] [-locale <"Locale">]

   次のコマンド例は、Windows上でOracle Applicationsデータ・ソースに対するプライベートのOracle BI Discoverer接続を作成します。

   capi.bat -create_conn -wlsurl <WLS_DISCO URL> -wlsconnect weblogic/weblogic -ldapurl <OID URL> -ldapconnect orcladmin/tiger -cname "Analyze Sales" -cdesc "Analyze Sales First Quarter" -sso_user "jchan" -type "private" -olap "false" -apps "true" -dbuser "jchan" -dbpasswd "12345" -dbname "db1" -eul "HR" -resp "HR Manager" -sg "US HR Security Group" -showdetails "true" -locale "EN_US"

注意: OracleAS Single Sign-On以外のインストールではデータベースのパスワード(-dbpasswdコマンド修飾子を使用してユーザーが指定するもの)が必須ですが、OracleAS Single Sign-Onインストールではこれはオプションです。

C.11.6 Oracle Applicationsデータ・ソースに対するパブリックのOracle BI Discoverer接続を作成する方法

複数のエンド・ユーザーがログイン詳細を入力せずにOracle BI Discovererを起動し、Oracle Applicationsデータを分析できるようにするには、Oracle Applicationsデータ・ソースに対するパブリックのOracle BI Discoverer接続を作成します。

Oracle Applicationsデータ・ソースに対するパブリックのOracle BI Discoverer接続を作成するには:

1. 次の構文に基づいてコマンドを入力します。

   capi.bat | capi.sh -create_conn -wlsurl <WLS_DISCO URL> -wlsconnect weblogic/<weblogic password> -cname <"Discoverer connection name"> [-cdesc <"Discoverer connection description">] -type "public" -olap "false" -apps "true" -dbuser <"Database user name"> [-dbpasswd <"Database password">] -dbname <"Database name"> -eul <"End User Layer name"> -resp <"Oracle Applications Responsibility"> -sg <"Oracle Applications Security Group"> [-showdetails <"true" | "false">] [-locale <"Locale">]

   次のコマンド例は、Windows上でOracle Applicationsデータ・ソースに対するパブリックのOracle BI Discoverer接続を作成します。

   capi.bat -create_conn -wlsurl <WLS_DISCO URL> -wlsconnect weblogic/weblogic -cname "Analyze Sales" -cdesc "Analyze Sales First Quarter" -type "public" -olap "false" -apps "true" -dbuser "jchan" -dbpasswd "12345" -dbname "db1" -eul "HR" -resp "HR Manager" -sg "US HR Security Group" -showdetails "true" -locale "EN_US"

C.11.7 リレーショナル・データ・ソースに対するプライベートのOracle BI Discoverer接続を更新する方法

Oracle BI Discoverer接続のログイン詳細を変更するには、リレーショナル・データ・ソースに対するプライベートのOracle BI Discoverer接続を更新します。

リレーショナル・データ・ソースに対するプライベートのOracle BI Discoverer接続を更新するには:

1. 次の構文に基づいてコマンドを入力します。

   capi.bat | capi.sh -update_conn -wlsurl <WLS_DISCO URL> -wlsconnect weblogic/<weblogic password> -ldapurl <OID URL> -ldapconnect orcladmin/<orcladmin password> -cname <"Discoverer connection name"> [-cdesc <"Discoverer connection description">] -sso_user <"Single Sign-On user name"> -type "private" -olap "false" -apps "false" -dbuser <"Database user name"> -dbpasswd <"Database password"> -dbname <"Database name"> -eul <"End User Layer name"> [-showdetails <"true" | "false">] [-locale <"Locale">]

   次のコマンド例は、Windows上でリレーショナル・データ・ソースに対するRegionalSalesへのプライベートOracle BI Discoverer接続のEnd User Layer名を変更します。

   capi.bat -update_conn -wlsurl <WLS_DISCO URL> -wlsconnect weblogic/weblogic -ldapurl <OID URL> -ldapconnect orcladmin/tiger -cname "Analyze Sales" -cdesc "Analyze Sales First Quarter" -sso_user "jchan" -type "private" -olap "false" -apps "false" -dbuser "jchan" -dbpasswd "12345" -dbname "db1" -eul "RegionalSales" -showdetails "true" -locale "EN_US"

C.11.8 リレーショナル・データ・ソースに対するプライベートのOracle BI Discoverer接続を削除する方法

Oracle BI Discovererエンド・ユーザー接続リストから接続を削除するには、リレーショナル・データ・ソースに対するプライベートのOracle BI Discoverer接続を削除します。

リレーショナル・データ・ソースに対するプライベートのOracle BI Discoverer接続を削除するには:

1. 次の構文に基づいてコマンドを入力します。

   capi.bat | capi.sh -delete_conn -wlsurl <WLS_DISCO URL> -wlsconnect weblogic/<weblogic password> -ldapurl <OID URL> -ldapconnect orcladmin/<orcladmin password> -cname <"Discoverer connection name"> -sso_user <"Single Sign-On user name"> -type "private"

   次のコマンド例は、Windows上でリレーショナル・データ・ソースに対するプライベートのOracle BI Discoverer接続を削除します。

   capi.bat -delete_conn -wlsurl <WLS_DISCO URL> -wlsconnect weblogic/weblogic -ldapurl <OID URL> -ldapconnect orcladmin/tiger -cname "Analyze Sales" -sso_user "jchan" -type "private"

C.12 Discoverer接続APIコマンド・リファレンス

この項では、Discoverer接続APIの各コマンドについての詳細な参照情報について説明します。この項の内容は次のとおりです。

• -ldapurl

• -ldapconnect

• -wlsurl

• -wlsconnect

• -create_conn

• -update_conn

• -delete_conn

C.12.1 -ldapurl

このコマンドは、Oracle Internet Directoryに接続するための前提条件としてOracle Internet DirectoryのURLを指定する際に使用します。

注意: このコマンドは、プライベート接続の場合にのみ必要になります。

情報	詳細
構文:	-ldapurl <ldap://<ldaphost>:<non-ssl-port> または-ldapurl <ldaps://<ldaphost>:<ssl-port>
例:	-ldapurl URL その他のコマンド例については、第C.11項「Oracle BI Discoverer接続を作成、編集、および削除する方法」を参照してください。 注意: このコマンドは、-typeの値を"private"と設定した場合に必要になります。

C.12.2 -ldapconnect

このコマンドは、Oracle Internet Directoryに接続するための前提条件としてorcladminユーザー名とパスワードを識別する際に使用します。

注意: このコマンドは、プライベート接続の場合にのみ必要になります。

情報	詳細
構文:	-ldapconnect orcladmin/<orcladmin password>
例:	-ldapurl orcladmin/tiger その他のコマンド例については、第C.11項「Oracle BI Discoverer接続を作成、編集、および削除する方法」を参照してください。 注意: このコマンドは、-typeの値を"private"と設定した場合に必要になります。

C.12.3 -wlsurl

このコマンドは、WebLogic管理コンソールのURLを指定する際に使用します。

情報	詳細
構文:	-wlsurl <t3://<host>:<wls_disco port>
例:	-wlsurl URL その他のコマンド例については、第C.11項「Oracle BI Discoverer接続を作成、編集、および削除する方法」を参照してください。

C.12.4 -wlsconnect

このコマンドは、Oracle BI Discoverer接続APIを実行するための前提条件としてWebLogic Administratorユーザー名とパスワードを識別する際に使用します。

情報	詳細
構文:	-wlsconnect weblogic/<weblogic password>
例:	-wlsconnect weblogic/weblogic その他のコマンド例については、第C.11項「Oracle BI Discoverer接続を作成、編集、および削除する方法」を参照してください。

C.12.5 -create_conn

このコマンドは、エンド・ユーザーがOracle BI Discovererの起動に使用できるOracle BI Discoverer接続を作成する際に使用します。

情報	詳細
構文:	-create_conn <command modifiers>
コマンド修飾子:	-apps <"true" | "false"> -cdesc <"Discoverer connection description"> -cname <"Discoverer connection name"> -dbname <"Database name"> -dbpasswd <"Database password"> -dbuser <"Database user name"> -eul <"End User Layer name"> -locale <"Locale"> -olap <"true" | "false"> -resp <"Oracle Applications Responsibility"> -sg <"Oracle Applications Responsibility Security Group"> -showdetails <"true" | "false"> -sso_user <"Single Sign-On user name"> -type <"private" | "public">
例:	その他のコマンド例については、第C.11項「Oracle BI Discoverer接続を作成、編集、および削除する方法」を参照してください。

C.12.6 -update_conn

このコマンドは、既存のOracle BI Discoverer接続の詳細を更新する際に使用します。

情報	詳細
構文:	-update_conn <command modifiers>
コマンド修飾子:	-apps <"true" | "false"> -cdesc <"Discoverer connection description"> -cname <"Discoverer connection name"> -dbname <"Database name"> -dbpasswd <"Database password"> -dbuser <"Database user name"> -eul <"End User Layer name"> -locale <"Locale"> -olap <"true" | "false"> -resp <"Oracle Applications Responsibility"> -sg <"Oracle Applications Responsibility Security Group"> -showdetails <"true" | "false"> -sso_user <"Single Sign-On user name"> -type <"private" | "public">
例:	その他のコマンド例については、第C.11項「Oracle BI Discoverer接続を作成、編集、および削除する方法」を参照してください。

C.12.7 -delete_conn

このコマンドは、既存のOracle BI Discoverer接続を完全に削除するために使用します。

情報	詳細
構文:	-delete_conn <command modifiers>
コマンド修飾子:	-cname <"Discoverer connection name"> -sso_user <"Single Sign-On user name"> -type <"private" | "public">
例:	コマンド例については、第C.11.8項「リレーショナル・データ・ソースに対するプライベートのOracle BI Discoverer接続を削除する方法」を参照してください。

C.13 Discoverer接続APIコマンド修飾子リファレンス

この項では、Discoverer接続APIの各コマンド修飾子についての詳細な参照情報について説明します。この項の内容は次のとおりです。

• -apps

• -cdesc

• -cname

• -dbname

• -dbpasswd

• -dbuser

• -eul

• -locale

• -olap

• -resp

• -sg

• -showdetails

• -sso_user

• -type

C.13.1 -apps

このコマンド修飾子は、Oracle BI DiscovererアクセスでOracle Applications End User Layerにアクセスするかどうかを指定する際に使用します。

情報	詳細
構文:	-apps <"true" | "false">
オプションか必須か:	必須
例:	-apps "true"

C.13.2 -cdesc

このコマンド修飾子は、Oracle BI Discoverer接続の説明を指定する際に使用します。たとえば、説明を使用して、Oracle BI Discovererを起動するための接続を選択する際に分析できる販売地域をユーザーに知らせることができます。

指定した説明は、「Oracle BI Discovererに接続」ページの「説明」列に表示されます。

情報	詳細
構文:	-cdesc <"Discoverer connection description>"
オプションか必須か:	オプション
注意:	説明は1から200文字で入力します。 -cdescを使用して説明を指定せずにOracle BI Discoverer接続を作成した場合、「Oracle BI Discovererに接続」ページの「説明」列は空白になります。 -cdescを使用して説明を指定せずにOracle BI Discoverer接続を更新した場合、既存の説明があれば、その説明がそのまま維持されます。
例:	-cdesc "Analyze sales for the Eastern region"

C.13.3 -cname

このコマンド修飾子は、接続名を指定する際に使用します。Oracle BI Discoverer接続を作成するときに、このコマンド修飾子を使用して、その接続の識別に使用する一意の名前を指定します。

指定した接続名は、「Oracle BI Discovererに接続」ページの「名前」列に表示されます。

情報	詳細
構文:	-cname <"Discoverer connection name">
オプションか必須か:	必須
注意:	名前は1から1000文字で入力します。 Oracle BI Discoverer接続を更新または削除している場合は、次の点を確認してください。 接続名を正しく指定していること(先頭を大文字にすること、接続名内のスペースの位置など)。 -typeコマンド修飾子を使用して正しく接続タイプを指定していること(2つの異なるOracle BI Discoverer接続のうち、1つがパブリックのOracle BI Discoverer接続でもう1つがプライベートのOracle BI Discoverer接続の場合、これらは同じ名前を持つことができます)。
例:	-cname "Eastern First Quarter Sales"

C.13.4 -dbname

このコマンド修飾子は、Oracle BI Discoverer接続で使用するデータベースを指定する際に使用します。

情報	詳細
構文:	-dbname <"Database name">
オプションか必須か:	必須
注意:	リレーショナル・データ・ソースまたはOracle Applicationsデータ・ソースへのOracle BI Discoverer接続の場合、-dbnameを使用して指定するデータベースは、次の条件のいずれかを満たす必要があります。 名前が、Discoverer接続APIプログラムがインストールされているマシンのtnsnames.oraファイルに含まれていること。 名前に、アドレス、プロトコル、ポート、SIDなど完全なデータベース詳細が含まれていること。 例: (DESCRIPTION = (ADDRESS_LIST = (ADDRESS = (PROTOCOL = TCP)(HOST = hostname.organization.com)(PORT = 1523))) (CONNECT_DATA = (SID = VIS))) OLAPデータ・ソースへのOracle BI Discoverer接続の場合、-dbnameを使用して指定するデータベースは、次のフォーマットでなければなりません。 host:port:SID 説明: hostはデータを含むデータベースをホストするマシンです。 portはTNSリスナー・ポートです。 SIDはデータベースのシステムIDです。 OLAPデータ・ソースへのOracle BI Discoverer接続の場合、SIDは大文字にする必要があります。詳細は、データベース管理者に問い合せてください。
例:	-dbname "db1" (リレーショナル・データ・ソースの場合) -dbname "host1:1521:DB2" (OLAPデータ・ソースの場合)

C.13.5 -dbpasswd

このコマンド修飾子は、-dbuserコマンド修飾子を使用して指定したデータベース・ユーザー名に対するデータベース・パスワードを指定する際に使用します。

情報	詳細
構文:	-dbpasswd <"Database password">
オプションか必須か:	OracleAS Single Sign-On以外のインストールでプライベートのOracle BI Discoverer接続を作成または編集する際には、-dbpasswdコマンド修飾子は必須です。 次のような場合は、-dbpasswdコマンド識別子はオプションで、省略できます。 パブリックのOracle BI Discoverer接続を作成または編集する場合。 OracleAS Single Sign-OnインストールでプライベートのOracle BI Discoverer接続を作成または編集する場合。 例については、第C.11.5項「Oracle Applicationsデータ・ソースに対するプライベートのOracle BI Discoverer接続を作成する方法」を参照してください。
注意:	-dbpasswdコマンド修飾子がオプションの場合は、次のようになります。 -dbpasswdを使用してデータベース・パスワードを指定しなかった場合、エンド・ユーザーは接続を選択する際にパスワードを要求されます。 -dbpasswdを使用してデータベース・パスワードを指定した場合、エンド・ユーザーは接続を選択する際にパスワードを要求されません。
例:	-dbpasswd "12345"

C.13.6 -dbuser

このコマンド修飾子は、Oracle BI Discoverer接続で使用されるデータベース・ユーザー名(またはOracle Applicationsユーザー)を指定する際に使用します。

情報	詳細
構文:	-dbuser <"Database user name">
オプションか必須か:	必須
注意:	プライベートのOracle BI Discoverer接続を作成または更新している場合は、-sso_userコマンド修飾子を使用してOracleAS Single Sign-Onユーザー名も正しく指定してください。
例:	-dbuser "jchan"

C.13.7 -eul

このコマンド修飾子は、リレーショナル・データ・ソースまたはOracle Applicationsデータ・ソースへのOracle BI Discoverer接続に対してEnd User Layerを指定する際に使用します。

情報	詳細
構文:	-eul <"End User Layer name">
オプションか必須か:	リレーショナル・データ・ソースまたはOracle Applicationsデータ・ソースへのOracle BI Discoverer接続の場合、このコマンド修飾子は必須です。 OLAPデータ・ソースへのOracle BI Discoverer接続の場合は、このコマンド修飾子は使用しないでください。
注意:	End User Layer名では大/小文字が区別されます。たとえば、VIDEO5というEnd User Layerは、"Video5"や"video5"ではなく、"VIDEO5"と指定する必要があります。
例:	-eul "Video Stores Analysis"

C.13.8 -locale

このコマンド修飾子は、Oracle BI Discoverer接続に対して言語および国を指定する際に使用します(標準のISO言語コードおよび国コードで指定します)。

情報	詳細
構文:	-locale <"Language Code_Country Code">
オプションか必須か:	オプション
注意:	ロケールを指定しなかった場合、Oracle BI Discovererではエンド・ユーザーのWebブラウザに指定されたロケールが使用されます。
例:	-locale "EN_US"

C.13.9 -olap

このコマンド修飾子は、Oracle BI Discoverer接続がOLAPデータ・ソース用であることを指定する際に使用します。

情報	詳細
構文:	-olap <"true" | "false">
オプションか必須か:	必須
注意:	なし。
例:	-olap "true"

C.13.10 -resp

このコマンド修飾子は、Oracle BI Discoverer接続のOracle Applications職責(HR Managerなど)を指定する際に使用します。

情報	詳細
構文:	-resp <"Oracle Applications Responsibility">
オプションか必須か:	Oracle Applicationsデータ・ソースへのOracle BI Discoverer接続の場合、このコマンド修飾子は必須です。 リレーショナル・データ・ソース、またはOLAPデータ・ソースへのOracle BI Discoverer接続の場合は、このコマンド修飾子は使用しないでください。
注意:	なし。
例:	-resp "HR Manager"

C.13.11 -sg

このコマンド修飾子は、Oracle BI Discoverer接続に対してOracle Applicationsセキュリティ・グループ(US HR Security Groupなど)を指定する際に使用します。

情報	詳細
構文:	-sg <"Oracle Applications Security Group">
オプションか必須か:	Oracle Applicationsデータ・ソースへのOracle BI Discoverer接続の場合、このコマンド修飾子は必須です。 リレーショナル・データ・ソース、またはOLAPデータ・ソースへのOracle BI Discoverer接続の場合は、このコマンド修飾子は使用しないでください。
注意:	なし。
例:	-sg "US HR Security Group"

C.13.12 -showdetails

このコマンド修飾子は、Oracle BI Discovererエンド・ユーザーが「Oracle BI Discovererに接続」ページ(およびOracle BI Discoverer Plusの「バージョン情報」ダイアログ)にOracle BI Discoverer接続のログイン詳細を表示できるようにするかどうかを指定する際に使用します。

情報	詳細
構文:	-showdetails <"true" | "false">
オプションか必須か:	オプション
注意:	-showdetailsコマンド修飾子を使用しなかった場合、デフォルトでOracle BI Discovererエンド・ユーザーはログイン詳細を表示できます。
例:	-showdetails "false"

C.13.13 -sso_user

このコマンド修飾子は、プライベートのOracle BI Discoverer接続に対してOracleAS Single Sign-Onユーザー名を指定する際に使用します。このコマンド修飾子により、認証されたOracleAS Single Sign-OnユーザーにプライベートのOracle BI Discoverer接続を提供できるようになります。

情報	詳細
構文:	-sso_user <"Single Sign-On user name">
オプションか必須か:	プライベートのOracle BI Discoverer接続の場合、このコマンド修飾子は必須です。 パブリックのOracle BI Discoverer接続の場合は、このコマンド修飾子は使用しないでください。
注意:	プライベートのOracle BI Discoverer接続を作成するには、-typeの値を"private"に設定することも必要です。
例:	-sso_user "jchan"

C.13.14 -type

このコマンド修飾子は、Oracle BI Discoverer接続がパブリックであるかプライベートであるかを指定する際に使用します。パブリックおよびプライベートのOracle BI Discoverer接続の詳細は、第C.1項「Oracle BI Discoverer接続」を参照してください。

情報	詳細
構文:	-type "public" | "private"
オプションか必須か:	必須
注意:	Discoverer接続APIを使用してプライベートのOracle BI Discoverer接続を作成するには、Oracle Business IntelligenceのインストールでOracleAS Single Sign-Onを有効にする必要があります。 プライベートのOracle BI Discoverer接続を作成する場合は、-sso_userを使用してOracleAS Single Sign-Onユーザー名を指定する必要もあります。
例:	-type "public"