C Discoverer Connections API

This appendix describes the Discoverer Connections API and contains the following topics:

• Section C.1, "What is a Oracle BI Discoverer Connection?"

• Section C.2, "What is the Discoverer Connections API?"

• Section C.3, "What is a Discoverer Connections API Command?"

• Section C.4, "What is a Discoverer Connections API Command Modifier?"

• Section C.5, "What are the Prerequisites for Using the Discoverer Connections API?"

• Section C.6, "What Command Syntax Conventions Does This Guide Use?"

• Section C.7, "What is the Syntax for Commands?"

• Section C.8, "How to Run Discoverer Connections API Commands"

• Section C.9, "How to Run a Command Directly at an Operating System Command Prompt"

• Section C.10, "How to Run Multiple Commands Stored in an Operating System Command File"

• Section C.11, "How to Create, Edit, and Delete Oracle BI Discoverer Connections"

• Section C.12, "Discoverer Connections API Command Reference"

• Section C.13, "Discoverer Connections API Command Modifier Reference"

C.1 What is a Oracle BI Discoverer Connection?

A Oracle BI Discoverer connection is a stored set of login details such as database user name, database password, and database name. Oracle BI Discoverer connections enable end users to start Oracle BI Discoverer without having to enter login details.

Oracle BI Discoverer connections can be private or public, as follows:

• A private Oracle BI Discoverer connection is only accessible to an individual Oracle BI Discoverer end user (typically an OracleAS Single Sign-On user). For example, a private Oracle BI Discoverer connection called 'Western data analysis' that is created for the OracleAS Single Sign-On user jchan is only accessible to the user jchan.

• A public Oracle BI Discoverer connection is accessible to all Oracle BI Discoverer end users. For example, a public Oracle BI Discoverer connection called "Global data analysis" is accessible to all Oracle BI Discoverer end users.

  You can use only private connections with Oracle BI Discoverer Plus OLAP. Public connections are not supported. However, you can use public connections with Oracle BI Discoverer Viewer and Oracle BI Discoverer Portlet Provider to access worksheets that you have created with Oracle BI Discoverer Plus OLAP.

C.2 What is the Discoverer Connections API?

The Discoverer Connections API is a set of text-based commands that enable you to programmatically create and manipulate Oracle BI Discoverer connections. For example, you might use the Discoverer Connections API to create a set of Oracle BI Discoverer connections for an Oracle Business Intelligence installation.

The Discoverer Connections API enables you to create and manipulate both public and private Oracle BI Discoverer connections for all three types of data source:

• Relational data sources

• OLAP data sources

• Oracle Applications data sources

You can run Discoverer Connections API commands individually at an operating system command prompt, or in batch-mode from an operating system command file (for more information, see Section C.8, "How to Run Discoverer Connections API Commands").

Notes

• Oracle BI Discoverer end users can also create, edit, and delete private Oracle BI Discoverer connections using the Connect to Oracle BI Discoverer page that is used to start Oracle BI Discoverer Plus and Oracle BI Discoverer Viewer (if they have the required privileges). For information about displaying the Connect to Oracle BI Discoverer page, see Oracle Fusion Middleware User's Guide for Oracle Business Intelligence Discoverer Plus or Oracle Fusion Middleware User's Guide for Oracle Business Intelligence Discoverer Viewer.

• Middle-tier administrators can also create, edit, and delete public Oracle BI Discoverer connections using the Oracle BI Discoverer Public Connections page that is accessed through the Oracle BI Discoverer Administration tab in Fusion Middleware Control. For information about managing public connections, see Oracle Fusion Middleware Configuration Guide for Oracle Business Intelligence Discoverer.

C.3 What is a Discoverer Connections API Command?

A Discoverer Connections API command is an instruction that creates, updates, or deletes a Oracle BI Discoverer connection. For example, the -create_conn command creates a new Oracle BI Discoverer connection. For a description of each Discoverer Connections API command, see Section C.12, "Discoverer Connections API Command Reference".

C.4 What is a Discoverer Connections API Command Modifier?

A Discoverer Connections API command modifier is an instruction that qualifies or refines a Discoverer Connections API command. For example, the -type command modifier specifies whether a Oracle BI Discoverer connection is public or private. For a description of each Discoverer Connections API command modifier, see Section C.13, "Discoverer Connections API Command Modifier Reference".

C.5 What are the Prerequisites for Using the Discoverer Connections API?

To use the Discoverer Connections API, you need:

• To know the administrator login credentials of the Oracle Internet Directory that the Discoverer middle tier is connected to.

  The Oracle Internet Directory details are required only when you create private connections. To use the Discoverer Connections API, you must connect as the orcladmin user by using the command -ldapconnect orcladmin/<orcladmin password>).

  Note: orcladmin is the default administrator name for Oracle Internet Directory.

  If you need to find out the orcladmin password, then use the ldapsearch command (for more information, see Oracle Fusion Middleware User Reference for Oracle Identity Management).

• To know the WebLogic domain administrator name (by default this is weblogic) and password.

  To access the schema where the Discoverer private and public connection details are stored, you must connect as the weblogic user by using the command -wlsconnect weblogic/<weblogic password>.

• To know the URL of the WebLogic Managed Server where Discoverer Java EE application is deployed.

  Note: In this document, this URL is mentioned as <WLS_DISCO URL>. This URL must be specified in the format t3://<host>:<wls_disco port>.

• To enable OracleAS Single Sign-On for the Oracle Business Intelligence installation (if you want to use the Discoverer Connections API to create private Oracle BI Discoverer connections).

C.6 What Command Syntax Conventions Does This Guide Use?

This guide uses the following command syntax conventions:

• Commands and command modifiers are shown in plain type and are prefixed with a dash (-).

  Note: Do type the dash.

• Mandatory command text is enclosed in angle brackets < >.

  Note: Do not type the angle brackets.

• Optional command text is enclosed in square brackets [].

  Note: Do not type the square brackets.

• Variable command text (that is, where you supply the value) is shown in italics.

• Where command text is separated by a pipe character (|), choose one option from the list. For example, '-olap <"true" | "false">' means specify either -olap "true" or -olap "false".

  Note: Do not type the pipe character.

C.7 What is the Syntax for Commands?

Use the following syntax for Discoverer Connections API commands:

• On Windows, use the following syntax:

  capi.bat <-command> <command modifiers>

• On UNIX, use the following syntax:

  capi.sh <-command> <command modifiers>

Notes:

• Commands and command modifiers are case-sensitive. In other words, you cannot use uppercase and lowercase characters interchangeably.

• Unless stated otherwise, variable command arguments are not case-sensitive.

• Command modifiers can appear in any order if their arguments immediately follow them in the correct order.

• You must specify commands in a single line with no line breaks or carriage returns.

• Enclose command modifier arguments in double quotes (""). For example, if an End User Layer is called Video Store Analysis, then specify the End User Layer name as -eul "Video Store Analysis".

C.8 How to Run Discoverer Connections API Commands

You can run an Discoverer Connections API command in two ways:

• By running the command directly at an operating system command prompt (for more information, see Section C.9, "How to Run a Command Directly at an Operating System Command Prompt")

• By running multiple commands stored in an operating system command file (for more information, see Section C.10, "How to Run Multiple Commands Stored in an Operating System Command File")

C.9 How to Run a Command Directly at an Operating System Command Prompt

You run a Discoverer Connections API command directly at a command prompt as a convenient way to manage Oracle BI Discoverer connections. For example, you might want to create a public Oracle BI Discoverer connection for an OLAP data source without having to use the Connect to Oracle BI Discoverer page in Oracle BI Discoverer.

To run a command directly at an operating system command prompt:

1. Display the operating system command prompt.

2. Type or enter a command.

   For example, to create a public Oracle BI Discoverer connection for an OLAP data source on Windows, you might enter the following command:

   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 How to Run Multiple Commands Stored in an Operating System Command File

You run multiple commands stored in an operating system command file as a convenient way to manage Oracle BI Discoverer connections. For example, you might want to create a set of public Oracle BI Discoverer connections without having to use Fusion Middleware Control.

You create Discoverer Connections API commands in a Windows *.bat file or a UNIX *.sh file that is stored in the util directory on the Oracle Business Intelligence middle-tier machine. For example, on Windows, you might create a batch file called create_connections.bat in <ORACLE_INSTANCE>/Discoverer/Discoverer_<instance-name>/util/create_connections.bat.

You enter Discoverer Connections API commands in a command file (one command per line) as follows:

• On Windows, prefix each command with 'call' followed by a space, as follows:

  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>

• On UNIX, prefix each command with './', as follows:

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

For example, to create three Oracle BI Discoverer connections called 'Analyze Sales Q1', 'Analyze Sales Q2', and 'Analyze Sales Q3' on Windows, a command file might contain the following text:

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"

To run multiple commands stored in an operating system command file:

1. Create a command file in the directory in which the Discoverer Connections API is installed, as follows:

   • On Windows, create a batch (*.bat) file (for example, <ORACLE_INSTANCE>\Discoverer\Discoverer_<instance-name>\util\create_connections.bat)

   • On UNIX, create a script (*.sh) file (for example, <ORACLE_INSTANCE>/Discoverer/Discoverer_<instance-name>/util/create_connections.sh)

2. Enter (or copy) the Discoverer Connections API commands into the command file.

3. Execute the command file.

   For example, you might open a command prompt, type the name of the command file, and then press Enter.

C.11 How to Create, Edit, and Delete Oracle BI Discoverer Connections

This section explains how to create, edit, and delete Oracle BI Discoverer connections, and contains the following topics:

• Section C.11.1, "How to Create a Private Oracle BI Discoverer Connection for a Relational Data Source"

• Section C.11.2, "How to Create a Public Oracle BI Discoverer Connection for a Relational Data Source"

• Section C.11.3, "How to Create a Private Oracle BI Discoverer Connection for an OLAP Data Source"

• Section C.11.4, "How to Create a Public Oracle BI Discoverer Connection for an OLAP Data Source"

• Section C.11.5, "How to Create a Private Oracle BI Discoverer Connection for an Oracle Applications Data Source"

• Section C.11.6, "How to Create a Public Oracle BI Discoverer Connection for an Oracle Applications Data Source"

• Section C.11.7, "How to Update a Private Oracle BI Discoverer Connection for a Relational Data Source"

• Section C.11.8, "How to Delete a Private Oracle BI Discoverer Connection for a Relational Data Source"

Note: This section does not cover every task that you might undertake using the Discoverer Connections API. For comprehensive reference information about available commands, see Section C.12, "Discoverer Connections API Command Reference".

C.11.1 How to Create a Private Oracle BI Discoverer Connection for a Relational Data Source

You create a private Oracle BI Discoverer connection for a relational data source to enable an end user to start Oracle BI Discoverer and analyze relational data without entering login details.

To create a private Oracle BI Discoverer connection for a relational data source:

1. Enter a command based on the following syntax:

   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">]

   The following example command creates a private Oracle BI Discoverer connection for a relational data source on Windows.

   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 How to Create a Public Oracle BI Discoverer Connection for a Relational Data Source

You create a public Oracle BI Discoverer connection for a relational data source to enable end users to start Oracle BI Discoverer and analyze relational data without entering login details.

To create a public Oracle BI Discoverer connection for a relational data source:

1. Enter a command based on the following syntax:

   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">]

   The following example command creates a public Oracle BI Discoverer connection for a relational data source on Windows.

   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 How to Create a Private Oracle BI Discoverer Connection for an OLAP Data Source

You create a private Oracle BI Discoverer connection for an OLAP data source to enable an end user to start Oracle BI Discoverer and analyze multi-dimensional data without entering login details.

To create a private Oracle BI Discoverer connection for an OLAP data source:

1. Enter a command based on the following syntax:

   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">]

   The following example command creates a private Oracle BI Discoverer connection for an OLAP data source on Windows.

   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 How to Create a Public Oracle BI Discoverer Connection for an OLAP Data Source

You create a public Oracle BI Discoverer connection for an OLAP data source to enable end users to start Oracle BI Discoverer and analyze multi-dimensional data without entering login details.

Public connections are not supported with Oracle BI Discoverer Plus OLAP. However, you can use public connections with Oracle BI Discoverer Viewer and Oracle BI Discoverer Portlet Provider to access worksheets that you have created with Oracle BI Discoverer Plus OLAP.

To create a public Oracle BI Discoverer connection for an OLAP data source:

1. Enter a command based on the following syntax:

   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">]

   The following example command creates a public Oracle BI Discoverer connection for an OLAP data source on Windows.

   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 How to Create a Private Oracle BI Discoverer Connection for an Oracle Applications Data Source

You create a private Oracle BI Discoverer connection for an Oracle Applications data source to enable an end user to start Oracle BI Discoverer and analyze Oracle Applications data without entering login details.

To create a private Oracle BI Discoverer connection for an Oracle Applications data source:

1. Enter a command based on the following syntax:

   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">]

   The following example command creates a private Oracle BI Discoverer connection for an Oracle Applications data source on Windows.

   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"

Note: A database password (that you specify using the -dbpasswd command modifier) is mandatory in a non-OracleAS Single Sign-On installation, but optional in an OracleAS Single Sign-On installation.

C.11.6 How to Create a Public Oracle BI Discoverer Connection for an Oracle Applications Data Source

You create a public Oracle BI Discoverer connection for an Oracle Applications data source to enable end users to start Oracle BI Discoverer and analyze Oracle Applications data without entering login details.

To create a public Oracle BI Discoverer connection for an Oracle Applications data source:

1. Enter a command based on the following syntax:

   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">]

   The following example command creates a public Oracle BI Discoverer connection for an Oracle Applications data source on Windows.

   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 How to Update a Private Oracle BI Discoverer Connection for a Relational Data Source

You update a private Oracle BI Discoverer connection for a relational data source to change the login details of an Oracle BI Discoverer connection.

To update a private Oracle BI Discoverer connection for a relational data source:

1. Enter a command based on the following syntax:

   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">]

   The following example command changes the name of the End User Layer for a private Oracle BI Discoverer connection for a relational data source to RegionalSales on Windows:

   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 How to Delete a Private Oracle BI Discoverer Connection for a Relational Data Source

You delete a private Oracle BI Discoverer connection for a relational data source to remove a connection from an Oracle BI Discoverer end user's connection list.

To delete a private Oracle BI Discoverer connection for a relational data source:

1. Enter a command based on the following syntax:

   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"

   The following example command deletes a private Oracle BI Discoverer connection for a relational data source on Windows:

   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 Connections API Command Reference

This section contains detailed reference information about each command in the Discoverer Connections API, and contains the following topics:

• -ldapurl

• -ldapconnect

• -wlsurl

• -wlsconnect

• -create_conn

• -update_conn

• -delete_conn

C.12.1 -ldapurl

Use this command to specify the Oracle Internet Directory URL as a prerequisite to connect to Oracle Internet Directory.

Note: This command is required only for private connections.

Information	Details
Syntax:	-ldapurl <ldap://<ldaphost>:<non-ssl-port> or -ldapurl <ldaps://<ldaphost>:<ssl-port>
Examples:	-ldapurl URL For more command examples, see Section C.11, "How to Create, Edit, and Delete Oracle BI Discoverer Connections". Note: This command is required if the value of -type is set as "private".

C.12.2 -ldapconnect

Use this command to identify the orcladmin user name and password as a prerequisite to connect to Oracle Internet Directory.

Note: This command is required only for private connections.

Information	Details
Syntax:	-ldapconnect orcladmin/<orcladmin password>
Examples:	-ldapurl orcladmin/tiger For more command examples, see Section C.11, "How to Create, Edit, and Delete Oracle BI Discoverer Connections". Note: This command is required if the value of -type is set as "private".

C.12.3 -wlsurl

Use this command to specify the WebLogic Administration Console URL.

Information	Details
Syntax:	-wlsurl <t3://<host>:<wls_disco port>
Examples:	-wlsurl URL For more command examples, see Section C.11, "How to Create, Edit, and Delete Oracle BI Discoverer Connections".

C.12.4 -wlsconnect

Use this command to identify the WebLogic Administrator user name and password as a prerequisite to run the Oracle BI Discoverer connection APIs.

Information	Details
Syntax:	-wlsconnect weblogic/<weblogic password>
Examples:	-wlsconnect weblogic/weblogic For more command examples, see Section C.11, "How to Create, Edit, and Delete Oracle BI Discoverer Connections".

C.12.5 -create_conn

Use this command to create a Oracle BI Discoverer connection that end users can use to start Oracle BI Discoverer.

Information	Details
Syntax:	-create_conn <command modifiers>
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">
Examples:	For command examples, see Section C.11, "How to Create, Edit, and Delete Oracle BI Discoverer Connections".

C.12.6 -update_conn

Use this command to update the details of an existing Oracle BI Discoverer connection.

Information	Details
Syntax:	-update_conn <command modifiers>
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">
Examples:	For command examples, see Section C.11, "How to Create, Edit, and Delete Oracle BI Discoverer Connections".

C.12.7 -delete_conn

Use this command to permanently remove an existing Oracle BI Discoverer connection.

Information	Details
Syntax:	-delete_conn <command modifiers>
Command modifiers:	-cname <"Discoverer connection name"> -sso_user <"Single Sign-On user name"> -type <"private" | "public">
Examples:	For a command example, see Section C.11.8, "How to Delete a Private Oracle BI Discoverer Connection for a Relational Data Source".

C.13 Discoverer Connections API Command Modifier Reference

This section contains detailed reference information about each command modifier in the Discoverer Connections API, and contains the following topics:

• -apps

• -cdesc

• -cname

• -dbname

• -dbpasswd

• -dbuser

• -eul

• -locale

• -olap

• -resp

• -sg

• -showdetails

• -sso_user

• -type

C.13.1 -apps

Use this command modifier to specify whether anOracle BI Discoverer connection accesses an Oracle Applications End User Layer.

Information	Details
Syntax:	-apps <"true" | "false">
Optional or Mandatory:	Mandatory
Examples:	-apps "true"

C.13.2 -cdesc

Use this command modifier to specify a description for an Oracle BI Discoverer connection. For example, you might use a description to inform users which sales region they can analyze when they select the connection to start Oracle BI Discoverer.

The description that you specify is displayed in the Description column on the Connect to Oracle BI Discoverer page.

Information	Details
Syntax:	-cdesc <"Discoverer connection description">
Optional or Mandatory:	Optional
Notes:	The description must be between 1 and 200 characters in length. If you create an Oracle BI Discoverer connection without specifying a description using -cdesc, then the Description column on the Connect to Oracle BI Discoverer page is blank. If you update an Oracle BI Discoverer connection without specifying a description using -cdesc, then the existing description (if any) is maintained.
Examples:	-cdesc "Analyze sales for the Eastern region"

C.13.3 -cname

Use this command modifier to specify a connection name. If you are creating an Oracle BI Discoverer connection, then use this command modifier to specify a unique name to use to identify the connection.

The connection name that you specify is displayed in the Name column on the Connect to Oracle BI Discoverer page.

Information	Details
Syntax:	-cname <"Discoverer connection name">
Optional or Mandatory:	Mandatory
Notes:	The name must be between 1 and 1000 characters in length. If you are updating or deleting an Oracle BI Discoverer connection, then ensure that you: Specify the connection name correctly (including initial capitalization and spaces where these appear in the connection name). Specify the connection type correctly using the -type command modifier (two different Oracle BI Discoverer connections can have the same name if one is a public Oracle BI Discoverer connection and one is a private Oracle BI Discoverer connection).
Examples:	-cname "Eastern First Quarter Sales"

C.13.4 -dbname

Use this command modifier to specify the database that is used by an Oracle BI Discoverer connection.

Information	Details
Syntax:	-dbname <"Database name">
Optional or Mandatory:	Mandatory
Notes:	For an Oracle BI Discoverer connection to a relational or Oracle Applications data source, the database that you specify using -dbname must meet one of the following conditions: The name must be included in the tnsnames.ora file on the machine on which the Discoverer Connections API program is installed. The name must include the full database details, such as address, protocol, port, and SID. For example (DESCRIPTION = (ADDRESS_LIST = (ADDRESS = (PROTOCOL = TCP)(HOST = hostname.organization.com)(PORT = 1523))) (CONNECT_DATA = (SID = VIS))) For an Oracle BI Discoverer connection to an OLAP data source, the database that you specify using -dbname must be in the following format: host:port:SID where: host is the machine hosting the database containing the data port is the TNS listener port SID is the database system identifier For an Oracle BI Discoverer connection to an OLAP data source, the SID must be in uppercase. For more information, contact the database administrator.
Examples:	-dbname "db1" (for a relational data source) -dbname "host1:1521:DB2" (for an OLAP data source)

C.13.5 -dbpasswd

Use this command modifier to specify the database password for the database user name that you specify using the -dbuser command modifier.

Information	Details
Syntax:	-dbpasswd <"Database password">
Optional or Mandatory:	The -dbpasswd command modifier is mandatory when you create or edit a private Oracle BI Discoverer connection in a non-OracleAS Single Sign-On installation. The -dbpasswd command modifier is optional in the following cases: You create or edit a public Oracle BI Discoverer connection. You create or edit a private Oracle BI Discoverer connection in an OracleAS Single Sign-On installation. For an example, see Section C.11.5, "How to Create a Private Oracle BI Discoverer Connection for an Oracle Applications Data Source".
Notes:	When the -dbpasswd command modifier is optional: If you do not specify a database password using -dbpasswd, then end users are prompted for a password when they select the connection. If you do specify a database password using -dbpasswd, then end users are not prompted for a password when they select the connection.
Examples:	-dbpasswd "12345"

C.13.6 -dbuser

Use this command modifier to specify the database user name (or Oracle Applications user) that is used by an Oracle BI Discoverer connection.

Information	Details
Syntax:	-dbuser <"Database user name">
Optional or Mandatory:	Mandatory
Notes:	If you are creating or updating a private Oracle BI Discoverer connection, then ensure that you also specify the OracleAS Single Sign-On user name correctly using the -sso_user command modifier.
Examples:	-dbuser "jchan"

C.13.7 -eul

Use this command modifier to specify an End User Layer for an Oracle BI Discoverer connection to a relational or Oracle Applications data source.

Information	Details
Syntax:	-eul <"End User Layer name">
Optional or Mandatory:	This command modifier is mandatory for an Oracle BI Discoverer connection to a relational or Oracle Applications data source. Do not use this command modifier for an Oracle BI Discoverer connection to an OLAP data source.
Notes:	End User Layer names are case-sensitive. For example, you must specify an End User Layer called VIDEO5 as "VIDEO5", not "Video5" or "video5".
Examples:	-eul "Video Stores Analysis"

C.13.8 -locale

Use this command modifier to specify a language and country for an Oracle BI Discoverer connection (using a standard ISO language code and country code).

Information	Details
Syntax:	-locale <"Language Code_Country Code">
Optional or Mandatory:	Optional
Notes:	If you do not specify a locale, then Oracle BI Discoverer uses the locale specified in the end user's Web browser.
Examples:	-locale "EN_US"

C.13.9 -olap

Use this command modifier to specify that an Oracle BI Discoverer connection is for an OLAP data source.

Information	Details
Syntax:	-olap <"true" | "false">
Optional or Mandatory:	Mandatory
Notes:	None.
Examples:	-olap "true"

C.13.10 -resp

Use this command modifier to specify an Oracle Applications Responsibility (for example, HR Manager) for an Oracle BI Discoverer connection.

Information	Details
Syntax:	-resp <"Oracle Applications Responsibility">
Optional or Mandatory:	This command modifier is mandatory for an Oracle BI Discoverer connection to an Oracle Applications data source. Do not use this command modifier for an Oracle BI Discoverer connection to a relational or OLAP data source.
Notes:	None.
Examples:	-resp "HR Manager"

C.13.11 -sg

Use this command modifier to specify an Oracle Applications Security Group (for example, US HR Security Group) for an Oracle BI Discoverer connection.

Information	Details
Syntax:	-sg <"Oracle Applications Security Group">
Optional or Mandatory:	This command modifier is mandatory for an Oracle BI Discoverer connection to an Oracle Applications data source. Do not use this command modifier for an Oracle BI Discoverer connection to a relational or OLAP data source.
Notes:	None.
Examples:	-sg "US HR Security Group"

C.13.12 -showdetails

Use this command modifier to specify whether you want to enable Oracle BI Discoverer end users to view login details for an Oracle BI Discoverer connection on the Connect to Oracle BI Discoverer page (and in the About dialog in Oracle BI Discoverer Plus).

Information	Details
Syntax:	-showdetails <"true" | "false">
Optional or Mandatory:	Optional
Notes:	If you do not use the -showdetails command modifier, then Oracle BI Discoverer end users can view login details by default.
Examples:	-showdetails "false"

C.13.13 -sso_user

Use this command modifier to specify an OracleAS Single Sign-On user name for a private Oracle BI Discoverer connection. This command modifier enables you to provide private Oracle BI Discoverer connections for authenticated OracleAS Single Sign-On users.

Information	Details
Syntax:	-sso_user <"Single Sign-On user name">
Optional or Mandatory:	This command modifier is mandatory for a private Oracle BI Discoverer connection. Do not use this command modifier for a public Oracle BI Discoverer connection.
Notes:	To create a private Oracle BI Discoverer connection, you must also set the value of -type to "private".
Examples:	-sso_user "jchan"

C.13.14 -type

Use this command modifier to specify whether an Oracle BI Discoverer connection is public or private. For more information about public and private Oracle BI Discoverer connections, see Section C.1, "What is a Oracle BI Discoverer Connection?".

Information	Details
Syntax:	-type "public" | "private"
Optional or Mandatory:	Mandatory
Notes:	To create a private Oracle BI Discoverer connection using the Discoverer Connections API , OracleAS Single Sign-On must be enabled on the Oracle Business Intelligence installation. If you create a private Oracle BI Discoverer connection, then you must also specify an OracleAS Single Sign-On user name using -sso_user.
Examples:	-type "public"