Oracle Fusion Middleware User's Guide for Oracle Business Intelligence Discoverer EUL Java Command Line, 11g Release 1 (11.1.1)

11g Release 1 (11.1.1)

B40108-03

Contents

Title and Copyright Information

Preface

- Intended Audience

- Documentation Accessibility

- Oracle BI Discoverer Keyboard Navigation

- Related Documents

- Conventions

- JGoodies License Agreement

1 Introducing the Discoverer EUL Command Line for Java

- 1.1 What is the Oracle BI Discoverer EUL Command Line for Java?

- 1.2 What are the differences between the Discoverer Administrator Command Line Interface and the Discoverer EUL Command Line for Java?

- 1.3 What is a Discoverer EUL Command Line for Java command?

- 1.4 What is a Discoverer EUL Command Line for Java command modifier?

- 1.5 What privileges do you require to use the Discoverer EUL Command Line for Java?

- 1.6 How to run a Discoverer EUL Command Line for Java command

- 1.6.1 How to type commands directly at a command prompt

- 1.6.2 How to run commands stored in a command file

- 1.7 About troubleshooting the Discoverer EUL Command Line for Java

- 1.8 About using wildcards to identify EUL objects

- 1.9 Examples of commands

- 1.10 What is a command file?

- 1.11 Examples of command files

- 1.12 List of Discoverer EUL Command Line for Java commands

2 Discoverer EUL Command Line for Java Reference

- 2.1 What command syntax conventions does this guide use?

- 2.2 What is the syntax for commands?

- 2.3 Rules for using the Discoverer EUL Command Line for Java

- 2.4 Setting Oracle BI Discoverer Registry Variables for Use by Oracle BI Discoverer EUL Command Line for Java Commands

- 2.5 Discoverer EUL Command Line for Java command reference

- 2.5.1 -asm

- 2.5.2 -cmdfile

- 2.5.3 -connect

- 2.5.4 -create_eul

- 2.5.5 -delete

- 2.5.6 -delete_eul

- 2.5.7 -export

- 2.5.8 -grant_privilege

- 2.5.9 -help

- 2.5.10 -import

- 2.5.11 -load

- 2.5.12 -refresh_business_area

- 2.5.13 -refresh_folder

- 2.5.14 -refresh_summary

- 2.5.15 -revoke_privilege

- 2.6 Discoverer EUL Command Line for Java command modifier reference

- 2.6.1 -aggregate

- 2.6.2 -all

- 2.6.3 -apps_fndnam

- 2.6.4 -apps_fndnam_password

- 2.6.5 -apps_gwyuid

- 2.6.6 -apps_grant_details

- 2.6.7 -apps_mode

- 2.6.8 -apps_responsibility

- 2.6.9 -apps_security_group

- 2.6.10 -apps_user

- 2.6.11 -asm_policy

- 2.6.12 -asm_space, -asm_tablespace

- 2.6.13 -audit_info

- 2.6.14 -auto_gen_name

- 2.6.15 -auto_refresh

- 2.6.16 -auto_summaries

- 2.6.17 -auto_upgrade

- 2.6.18 -ba_link

- 2.6.19 -business_area

- 2.6.20 -business_area_access

- 2.6.21 -business_area_admin_access

- 2.6.22 -business_area_and_contents

- 2.6.23 -capitalize

- 2.6.24 -character_set_encoding

- 2.6.25 -condition

- 2.6.26 -date_hierarchy

- 2.6.27 -db_link

- 2.6.28 -default_tablespace

- 2.6.29 -description

- 2.6.30 -eul

- 2.6.31 -eul_language

- 2.6.32 -external_element

- 2.6.33 -folder

- 2.6.34 -function

- 2.6.35 -hier_node

- 2.6.36 -hierarchy

- 2.6.37 -identifier

- 2.6.38 -import_rename_mode

- 2.6.39 -item

- 2.6.40 -item_class

- 2.6.41 -join

- 2.6.42 -keep_format_properties

- 2.6.43 -log

- 2.6.44 -log_only

- 2.6.45 -lov

- 2.6.46 -object

- 2.6.47 -overwrite

- 2.6.48 -password

- 2.6.49 -preserve_workbook_owner

- 2.6.50 -private

- 2.6.51 -privilege

- 2.6.52 -remove_prefix

- 2.6.53 -replace_blanks

- 2.6.54 -role

- 2.6.55 -schema

- 2.6.56 -set_created_by

- 2.6.57 -set_created_date

- 2.6.58 -set_updated_by

- 2.6.59 -set_updated_date

- 2.6.60 -sort_folders

- 2.6.61 -sort_items

- 2.6.62 -source

- 2.6.63 -summary

- 2.6.64 -temporary_tablespace

- 2.6.65 -user

- 2.6.66 -wildcard

- 2.6.67 -workbook

- 2.6.68 -workbook_access

- 2.6.69 -xml_workbooks

A Discoverer EUL Command Line for Java error messages

- A.1 Discoverer EUL Command Line for Java error messages

B Differences in syntax between Discoverer command line interfaces

- B.1 Differences in syntax between Discoverer command line interfaces

Index

Oracle® Fusion Middleware

User's Guide for Oracle Business Intelligence Discoverer EUL Java Command Line

11g Release 1 (11.1.1)

B40108-03

November 2011

This document describes how to create and change Discoverer end user layers, by using the Discoverer EUL command line for Java.

Oracle Fusion Middleware User's Guide for Oracle Business Intelligence Discoverer EUL Java Command Line, 11g Release 1 (11.1.1)

B40108-03

Copyright © 2005, 2011, Oracle and/or its affiliates. All rights reserved.

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable:

U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, the use, duplication, disclosure, modification, and adaptation shall be subject to the restrictions and license terms set forth in the applicable Government contract, and, to the extent applicable by the terms of the Government contract, the additional rights set forth in FAR 52.227-19, Commercial Computer Software License (December 2007). Oracle America, Inc., 500 Oracle Parkway, Redwood City, CA 94065.

This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.

This software or hardware and documentation may provide access to or information on content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services.

Preface

This document provides a reference for the Discoverer EUL Command Line for Java. For the latest information, see the Oracle Fusion Middleware Release Notes.

Intended Audience

This guide is intended for Discoverer administrators, Oracle Applications administrators, and anyone who manages Discoverer EULs. Readers are assumed to have a working knowledge of Discoverer End User Layers (EULs).

Documentation Accessibility

For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc.

Access to Oracle Support

Oracle customers have access to electronic support through My Oracle Support. For information, visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.

Oracle BI Discoverer Keyboard Navigation

Oracle BI Discoverer supports standard keyboard navigation. Standard keyboard navigation includes the use of the tab key, mnemonics (using the Alt key and the underlined character), and accelerators (such as Alt+F4 to exit a window).

Related Documents

You can access the documents referenced in this guide, and other information about Oracle Business Intelligence (for example, whitepapers, best practices, documentation updates, other collateral) on Oracle Technology Network at:

http://www.oracle.com/technology

Conventions

Conventions used in this manual are shown in the table below:

Convention

Meaning

boldface

Boldface type indicates graphical user interface elements associated with an action, or terms defined in text or the glossary.

italic

Italic type indicates book titles, emphasis, or placeholder variables for which you supply particular values.

monospace

Monospace type indicates commands within a paragraph, URLs, code in examples, text that appears on the screen, or text that you enter.

< >

Angle brackets enclose user-supplied names or values.

[]

Square brackets enclose optional clauses from which you can choose one or none.

Menu name | Command

Text in this format conveys a sequence of menu choices (for example, choose the menu, then the command under that menu).

For more information about command conventions, see "What command syntax conventions does this guide use?".

JGoodies License Agreement

Oracle Business Intelligence includes the JGoodies software, whose License Agreement follows:

Copyright© 2003 JGoodies Karsten Lentzsch. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

- Neither the name of JGoodies nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

1 Introducing the Discoverer EUL Command Line for Java

This chapter introduces the Oracle BI Discoverer EUL Command Line for Java, and contains the following topics:

- "What is the Oracle BI Discoverer EUL Command Line for Java?"

- "What are the differences between the Discoverer Administrator Command Line Interface and the Discoverer EUL Command Line for Java?"

- "What is a Discoverer EUL Command Line for Java command?"

- "What is a Discoverer EUL Command Line for Java command modifier?"

- "What privileges do you require to use the Discoverer EUL Command Line for Java?"

- "How to run a Discoverer EUL Command Line for Java command"

- "About troubleshooting the Discoverer EUL Command Line for Java"

- "About using wildcards to identify EUL objects"

- "Examples of commands"

- "What is a command file?"

- "Examples of command files"

- "List of Discoverer EUL Command Line for Java commands"

1.1 What is the Oracle BI Discoverer EUL Command Line for Java?

The Oracle BI Discoverer EUL Command Line for Java is a set of text based commands that enable you to create and manipulate Discoverer EULs.

Note: You use Heterogeneous Services to connect to non-Oracle databases, although the EUL is stored in the Oracle database. For more information about using non-Oracle databases, see Oracle Database Heterogeneous Connectivity Administrator's Guide.

The Discoverer EUL Command Line for Java runs in a Java environment, which means that you can run it from any Java-compatible platform (Windows, UNIX, Linux). For example, you might want to refresh (or patch) an EUL from a UNIX system.

The figure below shows three different ways in which you can manipulate Discoverer EULs:

- Using the Discoverer EUL Command Line for Java on either a Windows, UNIX, or Linux system, as described in this guide

- Using Oracle BI Discoverer Administrator on a Windows system

- Using the Oracle BI Discoverer Administrator Command Line Interface on a Windows system
Note: To run the Oracle BI Discoverer Administrator Command Line Interface, you must have Oracle BI Discoverer Administrator installed on your system.

Figure 1-1 Discoverer interfaces to the Discoverer EUL

Notes:

- Discoverer EUL files have an EEX extension (for example, Sales_eul.eex)

- For a list of Discoverer EUL Command Line for Java commands, see "List of Discoverer EUL Command Line for Java commands".

1.2 What are the differences between the Discoverer Administrator Command Line Interface and the Discoverer EUL Command Line for Java?

Much of the Discoverer EUL Command Line for Java is compatible with the Oracle BI Discoverer Administrator Command Line Interface. If you have commands and scripts written for the Oracle BI Discoverer Administrator Command Line Interface, you can easily convert them to run on the Discoverer EUL Command Line for Java.

The Oracle BI Discoverer Administrator Command Line Interface and the Discoverer EUL Command Line for Java differ as follows:

- The Discoverer EUL Command Line for Java runs on multiple platforms. The Oracle BI Discoverer Administrator Command Line Interface runs only on Windows.
Note: Oracle BI Discoverer Administrator need not be installed to run the Discoverer EUL Command Line for Java.

- Discoverer EUL Command Line for Java commands are prefixed with java -jar eulbuilder.jar.

- The Discoverer EUL Command Line for Java contains extra commands (for example, to grant and revoke database privileges, you can use the commands -grant_privilege and -revoke_privilege commands).

- Some commands have minor differences in syntax (for more information, see "Differences in syntax between Discoverer command line interfaces").

1.3 What is a Discoverer EUL Command Line for Java command?

A Discoverer EUL Command Line for Java command is an instruction that manipulates a Discoverer EUL in some way. For example:

- the -connect command connects to a database using the username, password, and database specified. For example, to connect to database my_database as user jchan:

java -jar eulbuilder.jar -connect jchan/12345@my_database

- The -import command imports EUL objects into the current EUL from a specified Discoverer EUL export file (that is, a file with an EEX extension). For example, to import EUL objects from the file c:\data\sales.eex:

java -jar eulbuilder.jar -connect jchan/12345@my_database
-import c:\data\sales.eex

1.4 What is a Discoverer EUL Command Line for Java command modifier?

A Discoverer EUL Command Line for Java command modifier is an instruction that qualifies or refines a command. For example:

- The -log command modifier creates a log file to store processing information during the execution of a command. For example, to import EUL objects from the file c:\data\sales.eex and store log data in sales_import_logfile.txt:

java -jar eulbuilder.jar -connect jchan/12345@my_database
-import c:\data\sales.eex -log sales_import_logfile.txt

- The -item command modifier used with the -delete command specifies which EUL item to remove from an EUL. For example, to delete the item sales.profit:

java -jar eulbuilder.jar -connect jchan/12345@my_database -delete
-item sales.profit

1.5 What privileges do you require to use the Discoverer EUL Command Line for Java?

To use the Discoverer EUL Command Line for Java, the database username that you use to connect to a database must have the following database privileges:

- CREATE SESSION

- CREATE TABLE

- CREATE VIEW

- CREATE SEQUENCE

- CREATE PROCEDURE

The database username also requires a default tablespace, and a quota set on the default tablespace. For more information about granting privileges, see Oracle Fusion Middleware Administrator's Guide for Oracle Business Intelligence Discoverer.

1.6 How to run a Discoverer EUL Command Line for Java command

Note:

Before running the EUL Command Line for Java commands, run the discenv.sh script. For the location of the script, see "Discoverer file locations" in the Oracle Fusion Middleware Configuration Guide for Oracle Business Intelligence Discoverer.
This ensures that the environment variables (NLS_LANG and ORACLE_HOME) that are required for running the EUL Command-Line for Java command are initialized.

You can run the Discoverer EUL Command Line for Java in two ways:

- by entering commands directly at a command prompt (for more information, see "How to type commands directly at a command prompt")

- by running commands stored in command files (for more information, see "How to run commands stored in a command file")

Notes

- The eulapi script is located in <ORACLE_HOME>/bin.

- Make sure that the <ORACLE_HOME>/lib directory is registered in the CLASS PATH.

- Oracle BI Discoverer Administrator Command Line Interface commands are not compatible with Discoverer EUL Command Line for Java commands without amendment (for more information, see "What are the differences between the Discoverer Administrator Command Line Interface and the Discoverer EUL Command Line for Java?").

- To see a list of EUL objects in an EUL, export all EUL objects so that you can inspect it. For example:

java -jar eulbuilder.jar -connect jchan/12345@my_database
-export objectlist.xml -all % -wildcard

1.6.1 How to type commands directly at a command prompt

You might type commands directly at a command prompt when you want to patch an EUL from a UNIX system.

To type a command directly at a command prompt:

1. Open a command prompt (for example, a UNIX command prompt).

2. Type a command directly at the command prompt.
For example, to refresh folders called Sales1 and Sales2, type the following (see Figure 1-2):

java -jar eulbuilder.jar -connect jchan/12345@my_database
-refresh_folder Sales1 -refresh_folder Sales2

Figure 1-2 Using the Discoverer EUL Command Line for Java from a UNIX command prompt

1.6.2 How to run commands stored in a command file

You might run commands stored in a command file when you want to perform a regular EUL update.

To run commands stored in a command file:

1. Create a text file and type the commands into the text file (for example, import.txt).

2. Open a command prompt (for example, a UNIX command prompt).

3. Type the -cmdfile command at the command prompt followed by the name of a command file.
For example, to run commands stored in import.txt, type the following:

java -jar eulbuilder.jar -connect jchan/12345@my_database -cmdfile import.txt

For more information about command files, see "What is a command file?".

Notes

- You can also run multiple command files by repeating the -cmdfile command. For example, to run commands stored in the text file login.txt, then commands in import.txt, type:

java -jar eulbuilder.jar -cmdfile c:\scripts\login.txt
-cmdfile c:\scripts\import.txt

1.7 About troubleshooting the Discoverer EUL Command Line for Java

The Discoverer EUL Command Line for Java provides a log facility. Use the log facility to test commands without changing data (that is, for impact analysis) and troubleshoot problems as follows:

- Testing commands without changing data.
To test commands without changing data, use the -log <log file name> -log_only modifiers. For example:

-log <log file name> -log_only

These modifiers produce a log file showing whether problems occurred during command execution without changing the data. For more information, see "-log_only".

- Troubleshooting problems.
To troubleshoot problems, use the -log <log file name> modifier to store command processing information.

For example, after running a command you see a 'Command completed' message, which means that Discoverer processing is complete. To verify that the operation was carried out successfully, check the log file created using the -log modifier.

For example, if you attempt to delete a folder called 'Store 4' that is used in a summary folder, you see the 'Command completed' message on screen. However, you can find details in the log file specifying why the command could not be executed, similar to the following:

java EulCommandLine -connect jchan/12345@my_database -delete -folder Store 4 -log
Started <date and time>...
Deleting folder Store 4...
Element Store 4 cannot be deleted because it is used in a summary
Completed <date and time>.

1.8 About using wildcards to identify EUL objects

When you use the Discoverer EUL Command Line for Java, you can use wildcards to specify groups of EUL objects to manipulate. Wildcards are special characters that you use to substitute other characters. For example, you might want to import OLAP functions with names that begin with 'BI_'.

There are two wildcards that you can use:

- a percent sign (%) matches zero (that is, none) or more characters

- an underscore (_) matches exactly one character

You can use wildcards when you:

- delete EUL objects

- export EUL objects

- import EUL objects

- refresh folders, business areas, and summary folders

- grant and revoke privileges for workbooks and business areas

You can use wildcards with item names or identifiers. When you use wildcards, you append the command with the -wildcard modifier (for more information, see "-wildcard").

How to identify EUL objects using the percent wildcard:

Use the percent sign (%) followed by the -wildcard modifier.

For example, to delete all business areas with display names that begin with 'A':

java -jar eulbuilder.jar -connect jchan/12345@my_database -delete -business_area A% -wildcard

How to identify EUL objects using the underscore wildcard:

Use the underscore (_) followed by the -wildcard modifier.

For example, to delete all business areas with an identifier 'A', followed by any character, followed by 'C':

java -jar eulbuilder.jar -connect jchan/12345@my_database -delete
-business_area A_C -identifier -wildcard

Notes

- You can combine percent wildcard characters with underscore wildcard characters.

- If you omit the -wildcard modifier, the percent sign (%) or underscore (_) characters are interpreted as literal characters. In other words, the command '-delete -business_area A%' attempts to delete a business area called 'A%'.

1.9 Examples of commands

Example 1

To delete the Sales folder and Sum1 summary from the Sales EUL, use the following command:

java -jar eulbuilder.jar -connect jchan/12345@my_database -delete
-folder Sales -summary Sum1 -eul Sales

Example 2

To refresh the Sales1 and Sales2 folders, use the following command:

java -jar eulbuilder.jar -connect jchan/12345@my_database
-refresh_folder Sales1 -refresh_folder Sales2

Example 3

To create an Applications Mode EUL in the database under user jchan and grant access using the Applications username and password apps/apps, use the following command:

java -jar eulbuilder.jar -connect eul_owner:appsresp/appspwd -create_eul
-apps_mode -apps_grant_details apps/apps -user jchan -password 123456

For more examples, see "Discoverer EUL Command Line for Java Reference".

1.10 What is a command file?

Command files are text files that contain one or more Discoverer EUL Command Line for Java commands. You use command files to run commands automatically without having to type them manually at a command prompt. If you are familiar with MS-DOS or UNIX, command files work in a similar way to MS-DOS batch files and UNIX script files.

Notes:

- The commands in a command file are treated as though they were entered directly at the command prompt.

- Carriage returns embedded in a command file are ignored.

- A command file can in turn invoke other command files.

1.11 Examples of command files

Three example command files are described below:

1. connect.txt contains '-connect jchan/12345@my_database'

2. create.txt contains '-create_eul -log create.log'

3. delete.txt contains '-delete_eul -log delete.log'

You can use these command files in different combinations as shown in the following examples:

Example 1

To connect to a database:

java -jar eulbuilder.jar -cmdfile connect.txt

Example 2

To connect to a database, create an EUL, and store processing information in a log file:

java -jar eulbuilder.jar -cmdfile connect.txt -cmdfile create.txt

Example 3

To connect to a database, delete an EUL, and store processing information in a log file:

java -jar eulbuilder.jar -cmdfile connect.txt -cmdfile delete.txt

1.12 List of Discoverer EUL Command Line for Java commands

The table below lists the Discoverer EUL Command Line for Java commands

Command:

Use to:

-asm <modifiers>

Automate summary management ASM

-cmdfile <command file>

Run commands stored in a command file

-connect <username>/<password> [@<database]

Connect to an EUL

-create_eul <modifiers>

Create an EUL

-delete <modifiers>

Delete an EUL object

-delete_eul <modifiers>

Delete an EUL

-export <export file> <modifiers>

Export EUL object

-grant_privilege <modifiers>

Grant Discoverer privileges to a database user

-help [command name(s)] [-all]

Display online help

-import <import file(s)> <modifiers>

Import EUL objects

-load <business area> <modifiers>

Load a business area

-refresh_business_area <business area(s)> <modifiers>

Refresh a business area

-refresh_folder <folder name(s)> <modifiers>

Refresh a folder

-refresh_summary <summary name(s)> <modifiers>

Refresh a summary folder

-revoke_privilege <modifiers>

Remove Discoverer privileges from a database user

Note: Detailed information about command modifiers is contained in the command reference section (for more information, see "Discoverer EUL Command Line for Java Reference").

2 Discoverer EUL Command Line for Java Reference

This chapter provides detailed reference information for the Discoverer EUL Command Line for Java, and contains the following topics:

- "What command syntax conventions does this guide use?"

- "What is the syntax for commands?"

- "Rules for using the Discoverer EUL Command Line for Java"

- "Setting Oracle BI Discoverer Registry Variables for Use by Oracle BI Discoverer EUL Command Line for Java Commands"

- "Discoverer EUL Command Line for Java command reference"

- "Discoverer EUL Command Line for Java command modifier reference"

2.1 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 (-).
Do type the dash.

- Mandatory command arguments and command modifiers are enclosed in angle brackets < >.
Do not type the angle brackets.

- Optional command arguments and command modifiers are enclosed in square brackets [].
Do not type the square brackets.

- Variable command arguments (that is, where you supply the value) are shown in italics.

- Where options are separated by a pipe character (|), choose one from the list. For example, 'source <server | gateway>' means type either 'source server' or 'source gateway'.
Do not type the pipe character.

Figure 2-1 Command conventions used in this guide

Key to figure:

a. Discoverer EUL Command Line for Java executable file.
b. Command
c. Variable command arguments (mandatory), where you supply the user name and password separated by a slash (/) character.
d. Optional command argument, where you supply the database name.
e. Optional command modifier.

2.2 What is the syntax for commands?

Use the following syntax for Discoverer EUL Command Line for Java commands:

java -jar eulbuilder.jar -connect <username>/<password>[@database]
<-command> [-argument(s)] [-modifiers] [-argument(s)]

Notes:

- Commands and modifiers are not case-sensitive. In other words, you can use either upper-case or lower-case characters interchangeably.

- Variable command arguments can be case-sensitive. For example, EUL names and tablespace names. In other words, an EUL called VIDEO5 must be specified as 'VIDEO5', not 'Video5' or 'video5'.

- Commands can appear in any order if their arguments immediately follow them in the correct order.

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

- You must type commands in a single line with no line breaks or carriage returns.

- When you want to perform an operation on multiple EUL objects, repeat the optional command modifier for each EUL object.
For example, to refresh the Sales1 and Sales2 folders, you repeat the -refresh_folder command, as follows:

java -jar eulbuilder.jar -connect jchan/12345@my_database
-refresh_folder Sales1 -refresh_folder Sales2

- When specifying an item name or identifier that contain spaces or special characters, enclose it in double quotes (""). For example, if a folder is called Video Analysis Information, specify the folder name as "Video Analysis Information".

- If you include connection details in a command file (for example, -connect username/password@database), you need not include the -connect command after the java -jar eulbuilder.jar section. In other words, if you store connection details in connect.txt, you might use the following command to connect to a database:

java -jar eulbuilder.jar -cmdfile connect.txt

2.3 Rules for using the Discoverer EUL Command Line for Java

When using the Discoverer EUL Command Line for Java, the following rules apply:

- If you omit the optional <database> argument when you specify connection information, you connect to the Oracle database installed on your system. Use the optional <database> argument if you have multiple databases installed on your system, or if you are connecting to a database on a different system.

- If you do not specify an object name where one is required, Discoverer uses the default object for that database username. For example, if you do not specify an EUL using the -eul modifier, Discoverer uses the default EUL for the current database username. For more information about specifying an EUL, see "-eul".

- You can use nearly all commands with both Oracle or non-Oracle databases. There is one exception, the -refresh_summary command. You can only use the -refresh_summary command with Oracle databases (for more information, see "-refresh_summary").

- When specifying Discoverer EUL objects, you can use either item names (for example, folder names) or identifiers (unique IDs assigned to EUL objects). For example, if a Discoverer folder is called Sales, and its identifier is SALES_132388, you can specify this folder as an argument to the -refresh_folder command in either of the following ways:

- -refresh_folder Sales

- -refresh_folder SALES_132388 -identifier

Hint: Where possible, use identifiers rather than item names to specify EUL objects. Using identifiers avoids translation issues and EUL update problems caused by names being changed arbitrarily (for more information, see -identifier).

For more information about Discoverer identifiers, see Oracle Fusion Middleware Administrator's Guide for Oracle Business Intelligence Discoverer.

- To access a remote database, you must have the Transparent Network Substrate (TNS) settings for that database stored in the tnsnames.ora file.
For more information about TNS settings, see Oracle Enterprise Manager Administrator's Guide.

2.4 Setting Oracle BI Discoverer Registry Variables for Use by Oracle BI Discoverer EUL Command Line for Java Commands

When using some of the commands provided by the Oracle BI Discoverer EUL Command Line for Java, you might want to explicitly set certain Discoverer registry variables, as shown below:

Command

Discoverer Registry Variable

-export

- ArchiveCacheFlushInterval

- FormatXMLExportJoinFromMaster

refresh_object

- DefaultPreserveDisplayPropertyForRefresh

- EnableTriggers

-import

- FormatXML

-connect -apps_user

- AppsFNDNAM

- AppsGWYUID

-load

- SetNULLItemHeadingOnBulkLoad

- MaxNumberJoinPredicates

all commands

- SqlTrace

On Windows platforms, Discoverer registry variables are stored in the Windows Registry. On Linux, Solaris, and HP-UX platforms, Discoverer registry variables are stored in the .reg_key.dc file.

To set these Discoverer registry variables, do the following:

- Specify values for registry variables as required by entering the following at a command prompt:
dis51pr -setadminpref registry_variable_name value

For example, before using the -import -refresh option, you might want to set the DefaultPreserveDisplayPropertyForRefresh value to 1 by entering the following command:

dis51pr -setadminpref DefaultPreserveDisplayPropertyForRefresh=1

For more information about Discoverer registry variables (including descriptions, default values and allowable values), see Oracle Fusion Middleware Administrator's Guide for Oracle Business Intelligence Discoverer.

2.5 Discoverer EUL Command Line for Java command reference

This section contains detailed reference information about each command in the Discoverer EUL Command Line for Java. Note the following:

- commands are listed in alphabetical order

- you can refine commands using command modifiers (for more information, see "Discoverer EUL Command Line for Java command modifier reference")

The following commands are described in this section:

- -asm

- -cmdfile

- -connect

- -create_eul

- -delete

- -delete_eul

- -export

- -grant_privilege

- -help

- -import

- -load

- -refresh_business_area

- -refresh_folder

- -refresh_summary

- -revoke_privilege

2.5.1 -asm

Use this command to manage Discoverer's Automated Summary Management facility (ASM).

Information

Details

Syntax

-asm -asm_space <bytes> [modifiers]|
-asm_space <bytes>
-asm_tablespace <tablespace name> [modifiers]

Modifiers

-asm_space, -asm_tablespace
-log <log file name> [-log_only]

Notes

If -asm_space, -asm_tablespace modifiers are not specified, the ASM policy tablespace and space are used.

Examples

java -jar eulbuilder.jar -connect jchan/12345@my_database
-asm -asm_space 2182 -asm_tablespace user_data

Note: For more information about Automated Summary Management in Discoverer, see Oracle Fusion Middleware Administrator's Guide for Oracle Business Intelligence Discoverer.

2.5.2 -cmdfile

Use this command to automatically run Discoverer EUL Command Line for Java commands stored in a text file.

Information

Details

Syntax

-cmdfile <command file> [modifiers]

Modifiers

-character_set_encoding <character set>

Notes

To create a command file, create a text file containing one or more Discoverer EUL Command Line for Java commands using a standard text editor. To run the command(s) in the text file, type the following at the command prompt:

java -jar eulbuilder.jar -cmdfile <command file>

If you omit a directory path when you specify <command file>, the default Discoverer EUL Command Line for Java directory is used.

For more information, see "What is a command file?".

Examples

Example 1: To run command(s) stored in the text file refresh.txt, type the following at the command prompt:

java -jar eulbuilder.jar -connect jchan/12345@my_database
-cmdfile c:\scripts\refresh.txt

2.5.3 -connect

This command enables you to specify a database username and password, and to connect to an EUL.

Information

Details

Syntax

-connect <username>/<password>[@database][modifiers]

Modifiers

-apps_fndnam <foundation name>
-apps_fndnam_password <foundation name password>

-apps_gwyuid <gateway user ID>

-apps_responsibility <responsibility>

-apps_security_group <security group>

-apps_user

-auto_upgrade

-eul <EUL>

-log <log file name> [-log_only]

Notes

The database that you specify using <database> must either:

- be included in the tnsnames.ora file on the system

- include the full database details (for example, address, protocol, port, SID) in the <database> string
For example (DESCRIPTION = (ADDRESS_LIST = (ADDRESS = (PROTOCOL = TCP)(HOST = hostname.organization.com)(PORT = 1523))) (CONNECT_DATA = (SID = VIS)))

If no database is specified, Discoverer uses the default database for the specified username.

Examples

Example 1: A typical Oracle Applications connection, specifying an Oracle Applications username and password:

java -jar eulbuilder.jar –connect sysapps/sysapps@apps_db
–apps_user apps –apps_responsibility “sysresp1 UK”
-eul AppsEUL

Example 2: A new Oracle Applications connection specifying a Oracle Applications username and FNDNAM password:

java -jar eulbuilder.jar -connect sysapps/sysapps@apps_db
-apps_user -apps_responsibility sysresp1
-fndnam_password APPS -eul AppsEUL

Example 3: A non-Oracle Applications connection:

java -jar eulbuilder.jar –connect jchan/12345@my_database
-eul eultest

2.5.4 -create_eul

Use this command to create a Discoverer EUL.

Note: To create an Oracle Applications Mode EUL, use the -apps_mode modifier.

Information

Details

Syntax

-create_eul [modifiers]

Modifiers

-apps_grant_details <fnd user/password>
-apps_mode [-apps_grant_details]

-default_tablespace <default tablespace name>

-eul_language <EUL language>

-log <log file name> [-log_only]

-overwrite

-password <password>

-private

-temporary_tablespace <tablespace name>

-user <username>

Notes

Use the -user command modifier to specify the username that owns the new EUL. If you do not specify a username, the currently connected username becomes the owner of the new EUL.
Use the -overwrite command modifier to overwrite any existing EUL owned by the intended owner of the new EUL.

Use the -private command modifier to specify that the new EUL is private. The default setting for the new EUL is 'public'.

Examples

Example 1: To create a private EUL for a user named 'Bob', whose password is 'welcome', overwriting any existing EUL and recording all log entries in a file named create.log, enter:

java -jar eulbuilder.jar -connect jchan/12345@my_database
-create_eul -overwrite -user bob -password welcome -private
-log create.log

Example 2: To create an Oracle Applications Mode EUL, enter:

java -jar eulbuilder.jar -connect jchan/12345@my_database
-create_eul -apps_mode -apps_grant_details apps/apps

Example 3: To create an EUL and specify tablespace details to store EUL tables:

java -jar eulbuilder.jar –connect jchan/12345@my_database
-create_eul –user bob –password 3728372 –default_tablespace usr
–temporary_tablespace temp

2.5.5 -delete

Use this command to remove EUL objects from an EUL.

Note: To remove an entire EUL, use the -delete_eul command.

Information

Details

Syntax

-delete <modifiers>

Modifiers

-asm_policy <ASM policy>
-business_area <business area>

-business_area_and_contents <business area>

-ba_link <business area>.<folder>

-condition <folder>.<condition>

-folder <folder>

-function <PL/SQL function>

-hierarchy < hierarchy>

-hier_node <hierarchy>.<hierarchy node>

-identifier

-item <folder>.<item>

-item_class <item class>

-join <join name>

-log <log file name> [-log_only]

-summary <summary>

-wildcard

-workbook <workbook>

Notes

You can delete one or more EUL objects at a time (see examples below).

Examples

Example 1: To delete two business areas named Test BA and Final BA from an EUL named eul51, and write to a log file named delba.log, enter:

java -jar eulbuilder.jar -connect jchan/12345@my_database
-delete -business_area "Test BA" -business_area "Final BA"
-eul eul51 -log delba.log

Example 2: To delete a folder named Sales, and a Summary named Sum1 from an EUL named eul51, and write to a log file named del.log, enter:

java -jar eulbuilder.jar -connect jchan/12345@my_database
-delete -folder Sales -summary Sum1 -eul eul51 -log del.log

Example 3: To delete three items from an EUL. You store the identifiers of the items you want to delete in a text file called delete.txt. The -identifier command modifier specifies that the EUL items are identified by identifier, rather than item name. Log information is stored in delete08082003.log.

Note: The file delete.txt contains the following text:

-item FII_ACCOUNTS.ACCOUNT_NO

-item FII_ACCOUNTS.BANK

-item FII_ACCOUNTS.LOCATION

Enter:

java -jar eulbuilder.jar -delete -identifier
-connect jchan/12345@my_database -cmdfile delete.txt
-log delete08082003.log

2.5.6 -delete_eul

Use this command to delete the current Discoverer EUL.

Note: To selectively remove individual EUL objects, use the -delete command.

Information

Details

Syntax

-delete_eul

Modifiers

-log <log file name> [-log_only]

Notes

You can only delete EULs for which you are the registered owner (the username specified by the -connect command).

Examples

Example 1: To delete an EUL and store processing details in a log file.

java -jar eulbuilder.jar -connect jchan/12345@my_database
-delete_eul -log "c:\my log dir\delete_eul.log"

2.5.7 -export

Use this command to export EUL objects to a Discoverer export file (that is, a file with an EEX extension). You can selectively export individual EUL objects (for example, folders, business areas, functions) or entire EULs (using the -all modifier).

Information

Details

Syntax

-export <export file> <modifiers>

Modifiers

-all
-asm_policy <ASM policy>

-audit_info <audit details>

-business_area <business area>

-business_area_and_contents <business area>

-external_element <name of external XML file>

-folder <folder>

-function <function>

-hierarchy <hierarchy>

-identifier

-item_class <item_class>

-log <log file name> [-log_only]

-summary <summary>

-wildcard

-workbook <workbook> [-xml_workbooks]

Notes

The <export file> argument specifies the name of the target EEX file into which you export EUL objects. If a directory path is not specified, the target file is created in the default Discoverer folder. To override the default target directory setting, specify a directory path for the file (for example, c:\data\sales.eex).
Note: The directory path must be an absolute path, not a relative path.

Use the -business_area_and_contents modifier to export an entire business area and contents. If you only want to export the business area definition, use the -business_area modifier.

When you export a business area using the -business_area modifier, Discoverer exports only business area definitions and links to the folders in the business area. Discoverer exports the folders and workbooks only when they are specified by name.

When specifying EUL objects, you can use either their Display Name or Identifier.

To maintain data relationships, you must also export linked (or joined) objects.

The EUL export file produced using the export command is in XML format.

Examples

Example 1: To export two business areas named Test BA and Final BA from an EUL named eul51, into a file named export.eex, and write to a log file named export.log, enter:

java -jar eulbuilder.jar -connect jchan/12345@my_database
-export export.eex -business_area "Test BA"
-business_area "Final BA" -eul eul51 -log export.log

Example 2: In another example, you want to export four items. You store the names of the items you want to export in a text file called export.txt. The -identifier command modifier specifies that the EUL items are identified by identifier, rather than item name. Log information is stored in export07222001.log. The -audit_info command modifier is also used to store update information.

Note: The command file 'export.txt' contains this text:

-folder FII_ACCOUNTS

-hierarchy FII_BANK

-hierarchy FII_ACCOUNT_LOCATION

-item_class FII_LOCATION_NAME

Enter:

java -jar eulbuilder.jar -identifier -export test.eex
-connect jchan/12345@my_database -audit_info
-created_by ORACLE_APPS -set_updated_by ORACLE_APPS
-cmdfile export.txt -log export07222001.log

2.5.8 -grant_privilege

Use this command to grant Discoverer privileges to database users and roles for specified actions (for example, using drills, saving workbooks).

Information

Details

Syntax

-grant_privilege <modifiers>

Modifiers

-user <username>
-role <role>

-business_area_access <business area>

-business_area_admin_access <business area>

-workbook_access <workbook>

-privilege <privilege>

-apps_responsibility <responsibility>

-identifier

-log <log file name> [-log_only]

-wildcard

Notes

Examples of privileges include: administration, user_edition, format_business_area, and create_edit_business_area. For more information about privileges available, see "-privilege".
See also: -revoke_privilege.

Examples

Example 1: To grant the create edit business area privilege to user JOE:

java -jar eulbuilder.jar –connect jchan/12345@my_database
-eul eultest –grant_privilege
–user JOE –privilege create_edit_business_area

Example 2: To grant workbook access to role USER_ROLE:

java -jar eulbuilder.jar –connect jchan/12345@my_database
-grant_privilege –role USER_ROLE
–workbook_access jchan.“Workbook one”

Note: When identifying EUL objects, you are recommended to use identifiers rather than display names. If you are using display names rather than identifiers to identify EUL objects, specify the owner of the object. For example, to specify a workbook owned by jchan, use jchan.“Workbook one” rather than “Workbook one”. For more information about identifiers, see "-identifier".

Example 3: To grant all administration privileges to users JOE and JCHAN:

java -jar eulbuilder.jar –connect jchan/12345@my_database
-grant_privilege –user JOE -user JCHAN
–privilege all_admin_privs

2.5.9 -help

This command displays a list of Discoverer commands and their syntax and arguments.

Information

Details

Syntax

-help [command name(s)] [-all]

Modifiers

<command name(s)>
-all

Examples

To see a terse list of commands:

java -jar eulbuilder.jar -help

To see detailed help on specific commands:

java -jar eulbuilder.jar -help <command name(s)>

Note: To see help on multiple commands, separate commands with a comma.

To see detailed help on all commands:

java -jar eulbuilder.jar -help -all

2.5.10 -import

Use this command to selectively import EUL objects from one or more Discoverer export files (that is, EEX files). Discoverer export files are created using the -export command, and contain EUL objects (for example, folders, business areas, functions, or an entire EUL). For example, if you export a business area using the -export command, you can import the business area from the EEX file created by the export.

When you import multiple files, Discoverer automatically resolves references between the files. For example, you can export the Emp folder in fileA.eex and the Dept folder in fileB.eex. If Emp and Dept are joined, the join information is in both files, but neither file contains the information for both folders. If you import both files, the join is recreated when the second file is processed.

Information

Details

Syntax

-import <import file(s)> [modifiers]

Modifiers

-auto_refresh
-identifier

-import_rename_mode <rename_new|rename_old|do_not_import|refresh>

-keep_format_properties

-log <log file name> [-log_only]

-preserve_workbook_owner

-auto_gen_name

Notes

The <import file(s)> argument specifies the name(s) of the source EEX file(s). You must specify the full path name for the files (for example, c:\data\sales.eex).
Note: The directory path of the EEX file must be an absolute path, not a relative path.

Where an import filename include spaces, enclose the filename in double quotes (""). Separate multiple import filenames with a space.

Examples

Example 1: To import EUL objects from three files (file1.eex, file2.eex, and file3.exx), enter:

java -jar eulbuilder.jar -connect jchan/12345@my_database -import file1.eex -import file2.eex -import file3.eex

Example 2: In another example, you want to import four files. You store the names of the files you want to import in a text file called import.txt. This file also contains the -import command. Log information is stored in import07222003.log.

Note: The command file import.txt contains:

-import C:\bblock\discover\US\file1.eex

-import C:\bblock\discover\US\file2.eex

-import C:\bblock\discover\US\file3.eex

-import C:\bblock\discover\US\file4.eex

Enter:

java -jar eulbuilder.jar -connect jchan/12345@my_database
-eul EUL4_US -apps_user
-apps_responsibility "System Administrator"
-apps_gwyuid applsyspub/pub -apps_fndnam APPS
-apps_security_group Standard -import_rename_mode refresh
-auto_refresh -identifier -cmdfile import.txt
-log import07222003.log

2.5.11 -load

Use this command to bulk load objects from a database into a Discoverer business area.

Information

Details

Syntax

-load <business area> [modifiers]

Modifiers

-aggregate <SUM|MAX|MIN|COUNT|AVG|DETAIL>
-auto_summaries

-capitalize

-date_hierarchy <date hierarchy>

-db_link <database link>

-eul <EUL>

-description <description>

-join <join policy>

-log <log file name> [-log_only]

-lov <CHAR|DATE|DECIMAL|INTEGER|KEY>

-object <database objects>

-remove_prefix

-replace_blanks

-sort_folders

-sort_items

-source <source>

-user <username>

Notes

To maximize Discoverer performance, it is recommended that you use the -auto_summaries command modifier to automatically create summary folders. For more information, see "-auto_summaries".
Use the -source modifier to specify the source of the data (default is the current database server). If you are loading data from an EUL Gateway, the source name must exactly match the EUL Gateway name.

Use the -eul modifier to specify an EUL into which to load the objects (default is the Discoverer manager's own EUL). If you specify an EUL, you must have access privileges to the named EUL in order for the operation to succeed.

When doing a bulk load from an Oracle database (Enterprise Edition release 9.2.0.7 and later), constraints on views are also considered when Discoverer creates joins.

Examples

Example 1: To bulk load into an EUL named eul51 from an Oracle Designer source on the current connection, creating a new business area named Test BA, enter:

java -jar eulbuilder.jar -connect jchan/12345@my_database
-load "Test BA" -source "Designer 6i - bobsworkarea"
-eul eul51 -user bob -capitalize -remove_prefix
-replace_blanks -lov CHAR, INTEGER, DECIMAL
-aggregate AVG -log load.log -description "Test BA"

2.5.12 -refresh_business_area

Use this command to refresh one or more Discoverer business areas by retrieving an up-to-date EUL structure from the database.

Information

Details

Syntax

-refresh_business_area <business area> [modifiers]

Modifiers

-log <log file name> [-log_only]
-identifier

-schema

-source <server|gateway>

-user <username>

-wildcard

Examples

Example 1: To refresh two business areas named Test BA and Final BA that reside in an EUL named eul_a, from an Oracle Designer source on the current connection owned by user Bob, and summarize information in a log file named refba.log, enter:

java -jar eulbuilder.jar -connect jchan/12345@my_database
-refresh_business_area "Test BA"
-refresh_business_area "Final BA" -source "Designer 6i
- bobsworkarea" -eul eul_a -user bob -log refba.log

Example 2: To refresh several business areas identified by identifier, enter:

java -jar eulbuilder.jar -connect jchan/12345@my_database
-eul eul4138_us -apps_user
-apps_responsibility "Business Views Setup"
-apps_gwyuid APPLSYSPUB/PUB -apps_fndnam apps
-apps_security_group STANDARD -identifier
-log refresh_all_bas_eul4138.log
-refresh_business_area ABM_ACTIVITIES
-refresh_business_area ABM_COST_OBJECTS
-refresh_business_area ABM_DEPARTMENTS
-refresh_business_area ABM_MATERIALS
-refresh_business_area AMS_MARKETING_ONLINE
-refresh_business_area...

2.5.13 -refresh_folder

Use this command to refresh one or more Discoverer folders. When you refresh folders, the metadata for the folder is updated. For example, if a new database column has been added to a table, the EUL is updated with details of the new column.

Information

Details

Syntax

-refresh_folder <folder> [modifiers]

Modifiers

-identifier
-log <log file name> [-log_only]

-source <server|gateway>

-user <username>

-wildcard

Examples

Example 1: To refresh two folders named Sales1 and Sales2 and write to a log file named reffol.log, enter:

java -jar eulbuilder.jar -connect jchan/12345@my_database
-refresh_folder Sales1 -refresh_folder Sales2
-log reffol.log

2.5.14 -refresh_summary

Use this command to refresh one or more Discoverer summary folders. The query on which the summary folder is based is re-run to retrieve up-to-date data.

Information

Details

Syntax

-refresh_summary <summary> [modifiers]

Modifiers

-business_area <business area>
-eul <EUL>

-identifier

-log <log file name> [-log_only]

-wildcard

Examples

Example 1: To refresh two summary folders named Summary1 and Summary2 from a business area named Test BA, in an EUL named eul51, and write to a log file named refsum.log, enter:

java -jar eulbuilder.jar -connect jchan/12345@my_database
-refresh_summary Summary1 -refresh_summary Summary2
-business_area "Test BA" -log refsum.log -eul eul51

2.5.15 -revoke_privilege

Use this command to remove Discoverer privileges from database users for specified actions (e.g using drills, saving workbooks).

Information

Details

Syntax

-revoke_privilege <modifiers>

Modifiers

-user <username>
-role <role>

-business_area_access <business area>

-business_area_admin_access <business area>

-workbook_access <workbook>

-privilege <privilege>

-apps_responsibility <responsibility>

-identifier

-log <log file name> [-log_only]

-wildcard

Notes

Examples of privileges include: administration, user_edition, format_business_area, and create_edit_business_area. For a complete list of privileges, see the -privilege modifier.
See also: -grant_privilege.

Examples

Example 1: To revoke the create edit business area privilege from user JOE:

java -jar eulbuilder.jar –connect jchan/12345@my_database
-eul eultest –revoke_privilege
–user JOE –privilege create_edit_business_area

Example 2: To revoke access to a workbook from a role:

java -jar eulbuilder.jar –connect jchan/12345@my_database
-revoke_privilege –role USER_ROLE –workbook_access “Workbook one”

Example 3: To revoke all administration and user privileges from users JOE and JCHAN:

java -jar eulbuilder.jar –connect jchan/12345@my_database
-revoke_privilege –user JOE -user JCHAN –privilege all_admin_privs –privilege all_user_privs

2.6 Discoverer EUL Command Line for Java command modifier reference

This section contains detailed reference information about optional command modifiers available in the Discoverer EUL Command Line for Java. Command modifiers are used to refine or qualify Discoverer EUL Command Line for Java commands. Note the following:

- command modifiers are listed in alphabetical order

- for more information about Discoverer EUL Command Line for Java commands, see "Discoverer EUL Command Line for Java command reference"

The following command modifiers are described in this section:

- -aggregate

- -all

- -apps_fndnam

- -apps_fndnam_password

- -apps_gwyuid

- -apps_grant_details

- -apps_mode

- -apps_responsibility

- -apps_security_group

- -apps_user

- -asm_policy

- -asm_space, -asm_tablespace

- -audit_info

- -auto_gen_name

- -auto_refresh

- -auto_summaries

- -auto_upgrade

- -ba_link

- -business_area

- -business_area_access

- -business_area_admin_access

- -business_area_and_contents

- -capitalize

- -character_set_encoding

- -condition

- -date_hierarchy

- -db_link

- -default_tablespace

- -description

- -eul

- -eul_language

- -external_element

- -folder

- -function

- -hier_node

- -hierarchy

- -identifier

- -import_rename_mode

- -item

- -item_class

- -join

- -keep_format_properties

- -log

- -log_only

- -lov

- -object

- -overwrite

- -password

- -preserve_workbook_owner

- -private

- -privilege

- -remove_prefix

- -replace_blanks

- -role

- -schema

- -set_created_by

- -set_created_date

- -set_updated_by

- -set_updated_date

- -sort_folders

- -sort_items

- -source

- -summary

- -temporary_tablespace

- -user

- -wildcard

- -workbook

- -workbook_access

- -xml_workbooks

2.6.1 -aggregate

Use this command modifier to specify the default aggregate to be used during a bulk load.

Information

Details

Syntax

-aggregate <SUM|MAX|MIN|COUNT|AVG|DETAIL>

Used with

-load

2.6.2 -all

Use this command modifier to select every object in an EUL for export. Used with the -help command, this command modifier displays online help for all commands.

Information

Details

Syntax

-all

Used with

-help
-export

2.6.3 -apps_fndnam

Use this command modifier to override the value of the Applications Foundation name (FNDNAM).

Information

Details

Syntax

-apps_fndnam <foundation name>

Used with

-connect

Examples

java -jar eulbuilder.jar -connect appsuser:appsresp/appspwd
-apps_fndnam apps

2.6.4 -apps_fndnam_password

Use this command modifier to specify a Foundation Name password instead of an Oracle Applications user password when you connect to an Applications mode EUL.

Information

Details

Syntax

-apps_fndnam_password <foundation name password>

Used with

-connect

2.6.5 -apps_gwyuid

Use this command modifier to specify a Gateway User ID when you use the -apps_fndnam modifier.

Information

Details

Syntax

-apps_gwyuid <gateway user ID>/<password>

Used with

-connect

Examples

Example 1:
java -jar eulbuilder.jar -connect appsuser:appsresp/appspwd
-apps_gwyuid applsyspub/pub

2.6.6 -apps_grant_details

Use this command modifier to specify an Oracle Applications schema and password when creating an Oracle Applications mode EUL.

Information

Details

Syntax

-apps_grant_details <schema>/<password>

Used with

-create_eul

2.6.7 -apps_mode

Use this command modifier to create an Applications Mode EUL in the database, and connects you to it. This command modifier is used with the -create_eul command.

Information

Details

Syntax

-apps_mode

Used with

-create_eul

Notes

See also: -apps_grant_details

2.6.8 -apps_responsibility

Use this command modifier to specify an Oracle Application's responsibility when connecting as an Oracle Applications user to grant (or revoke) privileges.

Information

Details

Syntax

-apps_responsibility <Oracle Applications responsibility name>

Notes:

The Oracle Applications responsibility name can also be included immediately following a colon (:) placed after the Oracle Applications user name (before the password). For example:
java -jar eulbuilder.jar -connect appsuser:appsresp/appspwd -apps_gwyuid applsyspub/pub

Used with

-connect
-grant_privilege

-revoke_privilege

2.6.9 -apps_security_group

Use this command modifier to specify an Oracle Applications security group when connecting as an Oracle Applications user.

Information

Details

Syntax

-apps_security_group <Oracle Applications security group name>

Used with

-connect

2.6.10 -apps_user

Use this command modifier to connect to Discoverer as an Oracle Applications user.

Information

Details

Syntax

-apps_user <Applications user>

Modifiers

-apps_responsibility
-apps_security_group

Used with

-connect

Examples

Example 1:
java -jar eulbuilder.jar -connect appsuser/appspwd
-apps_user -apps_responsibility UK_Purchasing
-apps_security_group UK_Managers

Example 2:

java -jar eulbuilder.jar -connect appsuser:UK_Purchasing/appspwd
-apps_user -apps_security_group UK_Managers

2.6.11 -asm_policy

Use this command modifier to specify which Oracle Automated Summary Management (ASM) policy you want to delete or export.

Note: There is one ASM policy per EUL.

Information

Details

Syntax

-asm_policy <ASM policy>

Used with

-delete
-export

2.6.12 -asm_space, -asm_tablespace

Use these command modifiers to override space and tablespace values set in the ASM policy and uses space and tablespace constraints that you specify. The following are valid combinations of tablespace and space values:

Information

Details

Syntax

-asm_space <bytes>
OR
-asm_space <bytes> -asm_tablespace <tablespace name>

Notes

Use -asm_space <bytes> to specify the size of the ASM policy tablespace.
Use -asm_tablespace <tablespace name> -asm_space <bytes> to specify a tablespace and tablespace size.

Note: You must specify a valid tablespace name.

Used with

-asm

2.6.13 -audit_info

Use this command modifier to export audit fields with every Created By, Created Date, Updated By, or Updated Date object.

Information

Details

Syntax

-audit_info [-set_created_by <name of creator>]
[-set_created_date <date of creation>]
[-set_updated_by <name of updater>]
[-set_updated_date <date of update>]

Used with

-export

Notes

See also:
-set_created_by

-set_created_date

-set_updated_by

-set_updated_date

2.6.14 -auto_gen_name

Use this command modifier to set the Auto Generate name property, of all secondary elements to Yes, for all folders imported. For example, you might export a business area called Performance to an EEX file. If you then import the Performance business area from the EEX file at a later date, Discoverer sets the Auto Generate name property of all secondary elements to Yes, irrespective of the value that exists in exported file. For more information about secondary elements and the Auto generate name property, see the Oracle Fusion Middleware Administrator's Guide for Oracle Business Intelligence Discoverer.

Information

Details

Syntax

-auto_gen_name

Used with

-import

2.6.15 -auto_refresh

Use this command modifier to automatically get up-to-date metadata from the database for all folders imported. For example, you might export a business area called Performance to an EEX file. If you then import the Performance business area from the EEX file at a later date, Discoverer retrieves up-to-date metadata from the data dictionary.

Information

Details

Syntax

-auto_refresh

Used with

-import

2.6.16 -auto_summaries

Use this command modifier to automatically create summary folders during a bulk load using Discoverer's powerful Automated Summary Management (ASM) facility. Summary folders contain data that has been queried and processed so that it can be reused. This modifier enables you to improve Discoverer's performance and minimize response times for Discoverer end-users.

Information

Details

Syntax

-auto_summaries

Used with

-load

For more information about summary folders and ASM, see Oracle Fusion Middleware Administrator's Guide for Oracle Business Intelligence Discoverer.

2.6.17 -auto_upgrade

Use command modifier to enable Discoverer to automatically upgrade an EUL when you connect to an EUL. For example, you might have upgrade when a new version of Discoverer is installed. If you do not use the -auto_upgrade modifier when an upgrade is required, the connect fails and an error message is displayed.

Information

Details

Syntax

-auto_upgrade

Used with

-connect

2.6.18 -ba_link

Use this command modifier to remove a folder from a business area by removing the link between the two.

Information

Details

Syntax

-ba_link <business area>.<folder>

Notes

The folders or business areas themselves are not removed, only the link between them.
For example, to remove the folder Stores from the business area Video Analysis Information, you specify "Video Analysis Information".Stores.

Used with

-delete

Hint: To remove a folder from an EUL completely, use '-delete -folder' (for more information, see "-folder").

2.6.19 -business_area

Use this command modifier to specify a business area for export or deletion.

Note: Only the definition of the business area is exported or deleted, not the objects (for example, folders, items, item classes) contained within it. To export or delete a business area and the objects contained within it, use -business_area_and_contents.

Information

Details

Syntax

-business_area <business area>

Used with

-delete
-export

-refresh_summary

2.6.20 -business_area_access

Use this command modifier to grant (or revoke) access to business areas to (or from) database users, roles, and Oracle Applications responsibilities.

Information

Details

Syntax

-business_area_access <business area>

Used with

-grant_privilege
-revoke_privilege

2.6.21 -business_area_admin_access

Use this command modifier to grant (or revoke) business area administration privileges to business areas to (or from) database users, roles, and Oracle Applications responsibilities.

Information

Details

Syntax

-business_area_admin_access <business area>

Used with

-grant_privilege
-revoke_privilege

2.6.22 -business_area_and_contents

Use this command modifier to specify a business area and objects (for example, folders, items, item classes) contained within it for export or deletion.

Note: To export or delete a business area definition but leave the objects (for example, folders, items, item classes) contained within it intact, use -business_area).

Information

Details

Syntax

-business_area_and_contents <business area>

Used with

-delete
-export

-refresh_business_area

2.6.23 -capitalize

Use this command modifier to request that folder names have initial capital letters when they are generated from their respective column names during a bulk load.

Information

Details

Syntax

-capitalize

Used with

-load

2.6.24 -character_set_encoding

Use this command modifier to specify the character set in which command files are saved (for example, EUC, Shift_JIS, UTF-8). For example, a command file created on Solaris with a Japanese locale is encoded in the default Java character set (that is, EUC). However, on Windows, Japanese characters are usually encoded in Shift_JIS or UTF-8, which means that you must specify a character set so that Java can interpret commands correctly.

Information

Details

Syntax

-character_set_encoding <character set>

Used with

-cmdfile

Notes

You must specify this modifier at the command prompt immediately following the -cmdfile command. In other words, you cannot include the -character_set_encoding command modifier inside the command file itself.

2.6.25 -condition

Use this command modifier to specify a condition for deletion.

Information

Details

Syntax

-condition <condition>

Used with

-delete

2.6.26 -date_hierarchy

Use this command modifier to specify the date hierarchy to be used during a bulk load. If you do not specify a date hierarchy, the default date hierarchy is used.

Information

Details

Syntax

-date_hierarchy <date hierarchy>

Used with

-load

2.6.27 -db_link

Use this command modifier to specify the database link to be used during a bulk load.

Information

Details

Syntax

-db_link <database link>

Used with

-load

2.6.28 -default_tablespace

Use this command modifier to specify a default tablespace for the current username when you create an EUL. The value specified changes the default tablespace value for the current username (for more information, see "What privileges do you require to use the Discoverer EUL Command Line for Java?").

Information

Details

Syntax

-default_tablespace <tablespace name>

Used with

-create_eul

Notes

Database tablespace names are case sensitive.

2.6.29 -description

Use this command modifier to specify a description for an object.

Information

Details

Syntax

-description <description>

Used with

-load

Notes

If a description contains spaces, enclose the <description> value in double quotes ("").

2.6.30 -eul

Use this command modifier to specify an EUL on which to run a command. You must have access privileges to the specified EUL. If not specified, the default EUL for the database user is used.

Information

Details

Syntax

-eul <EUL>

Used with

-connect
-load

-refresh_summary

Notes

<EUL> must be the name of a valid EUL.
This modifier does not change the default EUL for the user.

2.6.31 -eul_language

Use this command modifier to specify a language for the EUL.

Information

Details

Syntax

-eul_language <language>

Used with

-create_eul

2.6.32 -external_element

Use this command modifier to place XML code from a specified file at the top of an export file. The -external_element command modifier is used only with the -export command.

Information

Details

Syntax

-external_element <filename>

Used with

-export

Notes

To use this command modifier, type the XML that you want to place at the top of the export file into a separate file and specify the name of this file as the <filename> argument.
You can use the -external_element command modifier multiple times in the same export operation (see example below).

<filename> is the name of the file containing the XML that you want to include in the EEX file.

Examples

Example 1: To place the xml from the files custom1.xml and custom2.xml into the top of the export file myBA.eex, enter:

java -jar eulbuilder.jar -connect jchan/12345@my_database
-export myBA.eex -business_area bus_area1
-external_element custom1.xml -external_element custom2.xml

2.6.33 -folder

Use this command modifier to specify a folder for export or deletion.

Information

Details

Syntax

-folder <folder>

Used with

-delete
-export

Hint: If you want to remove a folder from a business area without removing the folder from the EUL, use -ba_link.

2.6.34 -function

Use this command modifier to specify a function for export or deletion.

Information

Details

Syntax

-function <PL/SQL function>

Used with

-delete
-export

2.6.35 -hier_node

Use this command modifier to specify a node in a hierarchy for deletion.

Information

Details

Syntax

-hier_node <hierarchy>.<hierarchy node>

Used with

-delete

2.6.36 -hierarchy

Use this command modifier to specify a hierarchy for export or deletion.

Information

Details

Syntax

-hierarchy <hierarchy>

Used with

-delete
-export

2.6.37 -identifier

Use this command modifier to specify EUL objects by identifier, rather than by display name. If you omit this command modifier, EUL objects are identified by their display name.

Information

Details

Syntax

-identifier

Used with

-delete
-export

-grant_privilege

-refresh_business_area

-refresh_folder

-refresh_summary

-revoke_privilege

Notes

If you reference an object prefixed with a parent object name, you must also reference the parent object name using its identifier. For example, to delete the item Region.City, you must use identifiers for both objects, as follows:
-delete -item REGION_01.CITY_01 -identifier

Examples

Example 1: To delete the item Video Analysis Information.Store Name using identifiers, enter:

java -jar eulbuilder.jar -connect jchan/12345@my_database
-delete -item DC_VIDEO_ANALYSIS_INFORMATION4.STORE_NAME01
-identifier

Example 2: To delete a folder with the identifier FOLDER_01, enter:

java -jar eulbuilder.jar -connect jchan/12345@my_database
-delete -folder FOLDER_01 -identifier

2.6.38 -import_rename_mode

Use this command modifier to specify how to manage imported EUL objects that match EUL objects in your current EUL.

Information

Details

Syntax

-import_rename_mode <rename_new|rename_old|do_not_import|refresh>

Used with

-import

Notes

Use rename_new to rename imported objects that match existing objects.
Use rename_old to rename existing objects that match imported objects.

Use do_not_import to not import objects that match existing objects.

Use refresh to merge imported objects with existing objects. By default, merged objects are matched on display name.

Use the -identifier command modifier to match on identifier.

2.6.39 -item

Use this command modifier to specify an item for deletion.

Information

Details

Syntax

-item <item>

Used with

-delete
-export

2.6.40 -item_class

Use this command modifier to specify an item class for export or deletion.

Information

Details

Syntax

-item_class <item class>

Used with

-delete
-export

2.6.41 -join

This command modifier is used in two ways depending on which command you use it with:

- used with the -load command, the -join command modifier enables you to specify how Discoverer creates joins during a bulk load

- used with the -delete command, the -join command modifier enables you to remove a specific join

Information

Details

Syntax

-load -join <NONE|COLUMN_NAME|PRIMARY_KEY>

-delete -join <join name>

Used with

-delete
-load

2.6.42 -keep_format_properties

Use this command modifier to keep existing format properties (for example, display names, descriptions) on import. If you do not use this command modifier, you update existing format properties with the display names and descriptions in the import file (that is, the EEX file).

Information

Details

Syntax

-keep_format_properties

Used with

-import

2.6.43 -log

This modifier enables you to specify a name for the log file that stores command status messages. After each command is executed, Discoverer writes a status message indicating whether the command was successful. You can use -log with the optional -log_only command modifier.

Information

Details

Syntax

-log <log file name> [-log_only]

Used with

All commands except -help.

Notes

If the file specified by <log file name> exists, the existing log file is overwritten.
If the file specified by <log file name> does not exist, a new file is created.

2.6.44 -log_only

Use this command modifier to perform impact analysis by simulating a command and generating a log, without changing live data. Using this command modifier enables you to check for errors and exceptions before changing data.

This command is used with the -log command modifier.

Information

Details

Syntax

-log <log file name> [-log_only]

Used with

-log
-delete

-import

-refresh_business_area

-refresh_folder

Notes

This command modifier cannot be used with the -auto_upgrade command modifier.

2.6.45 -lov

Use this command modifier to specify the data types for which a list of values are generated during a bulk load.

Information

Details

Syntax

-lov <CHAR|DATE|DECIMAL|INTEGER|KEY>

Used with

-load

2.6.46 -object

Use this command modifier to bulk load objects from a database into a Discoverer business area.

Information

Details

Syntax

-object <mask>
Note: You can use wildcard characters.

Used with

-load

2.6.47 -overwrite

Use this command modifier to overwrite an existing EUL owned by the intended owner when you create an EUL. If omitted, the default is to not overwrite an existing EUL.

Information

Details

Syntax

-overwrite

Used with

-create_eul

2.6.48 -password

Use this command modifier to specify the password for a new user created using the -create_eul command.

Information

Details

Syntax

-password <password>

Used with

-create_eul

2.6.49 -preserve_workbook_owner

Use this command modifier to specify that the original workbook owners maintain ownership of an imported workbook when you import an EUL.

Information

Details

Syntax

-preserve_workbook_owner

Used with

-import

2.6.50 -private

Use this command modifier to specify that public access is not granted to a newly created EUL. In other words, only the EUL owner can access the newly created EUL. If omitted, public access is granted to the newly created EUL.

Information

Details

Syntax

-private

Used with

-create_eul

2.6.51 -privilege

Use this command modifier to specify the privileges to grant (or revoke) to (or from) database users. For more information about granting and revoking privileges, see "-grant_privilege" and "-revoke_privilege".

Information

Details

Syntax

-privilege <privilege>

Used with

-grant_privilege
-revoke_privilege

The possible values for <privilege> are:

- Use 'administration' to enable the user or role to log in to Discoverer Administrator. Note that to allow the user to access the features in Discoverer Administrator, you must select individual Administration privileges (for example, create_summaries, collect_qpp).

- Use 'user_edition' to enable the user or role to log in to Discoverer Desktop and Discoverer Plus. Note that to allow the user to access the features in Discoverer Desktop and Discoverer Plus, you must select individual Desktop/Plus privileges (for example, drill out, schedule_workbook).

- Use 'format_business_area' to enable the user or role to edit formatting information (for example, folders, summary folders, joins) in an existing business area to which they have access.

- Use 'create_edit_business_area' to enable the user or role to create and modify business areas, folders, summary folders, joins, calculations, conditions, hierarchies and item classes.

- Use 'create_summaries' to enable the user or role to create summary folders. This privilege also requires database resource privileges.

- Use 'set_privilege' to enable the user to maintain and modify user privileges.
Note: You cannot grant this privilege to a role.

- Use 'manage_scheduled_workbooks' to enable the user or role to monitor and maintain scheduled workbooks.

- Use 'create_edit_query' to enable the user or role to create new worksheets (queries) and modify existing ones. Without this privilege, the user can only open and run existing workbooks and worksheets.

- Use 'collect_qpp' to collect performance statistics when the user opens workbooks and worksheets.

- Use 'item_drill' to enable the user or role to drill down into worksheet data.

- Use 'drill_out' to enable the user or role to launch another application to see related information by drilling on an item in a worksheet.

- Use 'grant_workbook' to enable the user or role to grant access to their workbooks so that other users can access them.

- Use 'schedule_workbook' to enable the user to schedule a workbook to run at a later time or at regular intervals (that is, daily, weekly, monthly).
Note: You cannot grant this privilege to a role.

- Use 'save_workbook_database' to enable the user or role to save the workbooks in the database.

- Use 'all_admin_privs' to enable the user or role to the following privileges:

- administration

- format_business_area

- create_edit_business_area

- create_summaries

- set_privilege

- manage_scheduled_workbooks

- Use 'all_user_privs' to enable the user or role to the following privileges:

- user_edition

- create_edit_query

- collect_qpp

- item_drill

- drill_out

- grant_workbook

- schedule_workbook

- save_workbook_database

2.6.52 -remove_prefix

Use this command modifier to specify that item names do not include the column name prefix when they are generated from their respective column names during a bulk load.

Information

Details

Syntax

-remove_prefix

Used with

-load

Examples

java -jar eulbuilder.jar -connect jchan/12345@my_database
-load "Test BA" -remove_prefix

In this example, an item named Stores_Store_name would be loaded as Store_name.

2.6.53 -replace_blanks

Use this command modifier to replace underscores with spaces in EUL object names during a bulk load.

Information

Details

Syntax

-replace_blanks

Used with

-load

Examples

java -jar eulbuilder.jar -connect jchan/12345@my_database
-load "Test BA" -replace_blanks

In this example, an item named Store_name would be loaded as Store name.

2.6.54 -role

Use this command modifier to specify a database role when you grant (or revoke) privileges to (or from) database users.

Information

Details

Syntax

-role <role>

Used with

-grant_privilege
-revoke_privilege

2.6.55 -schema

Use this command modifier to specify a schema (user) during a business area refresh.

Information

Details

Syntax

-schema <schema>

Used with

-refresh_business_area

2.6.56 -set_created_by

Use this command modifier to specify who performed an export for audit purposes (during an export).

Information

Details

Syntax

-audit_info -set_created_by <name of creator>

Used with

-audit_info

Examples

Example 1: To export a business areas Test BA from an EUL named eul51, into a file named export.eex, and specify that the export was performed by jchan, enter:

java -jar eulbuilder.jar -connect jchan/12345@my_database
-export export.eex -business_area "Test BA" -audit_info
-set_created_by jchan

2.6.57 -set_created_date

Use this command modifier to specify an export date for audit purposes (during an export).

Information

Details

Syntax

-audit_info -set_created_date <date of creation>

Used with

-audit_info

Examples

Example 1: To export a business areas Test BA from an EUL named eul51, into a file named export.eex, and specify that the export was performed on January 1st 2004, enter:
java -jar eulbuilder.jar -connect jchan/12345@my_database -export export.eex -business_area "Test BA" -audit_info -set_created_date "1st January 2004"

2.6.58 -set_updated_by

Use this command modifier to specify who updated an EUL for audit purposes (during an export).

Information

Details

Syntax

-audit_info -set_updated_by <name of updater>

Used with

-audit_info

2.6.59 -set_updated_date

Use this command modifier to specify a date of update for audit purposes (during an export).

Information

Details

Syntax

-audit_info -set_updated_date <date of update>

Used with

-audit_info

2.6.60 -sort_folders

Use this command modifier to specify that Discoverer must alphabetically sort folders during a bulk load.

Information

Details

Syntax

-sort_folders

Used with

-load

2.6.61 -sort_items

Use this command modifier to specify that Discoverer must alphabetically sort items during a bulk load.

Information

Details

Syntax

-sort_items

Used with

-load

2.6.62 -source

Use this command modifier to specify a data source.

Information

Details

Syntax

-source <gateway name>

Used with

-load
-refresh_business_area

Notes

Use gateway name to specify the name of an Oracle Designer object or other gateway.
The gateway name must exactly match the gateway name displayed in the Load Wizard. In the case of Oracle Designer, specify "Designer 6i - <workarea name>" (if you are using a version of Oracle Designer earlier than Oracle Designer 6i, simply specify "Oracle Designer repository").

If you do not specify a gateway using -source, Discoverer uses the online dictionary.

2.6.63 -summary

Use this command modifier to specify a summary for export or deletion.

Information

Details

Syntax

-summary <summary>

Used with

-delete
-export

2.6.64 -temporary_tablespace

Use this command modifier to specify a temporary tablespace when you create an EUL.

Information

Details

Syntax

-temporary_tablespace <temporary tablespace name>

Used with

-create_eul

2.6.65 -user

Use this command modifier to specify the username to be used for the operation. When used with the -create_eul command, this command modifier enables you to create a new database user.

Information

Details

Syntax

-user <username>

Used with

-create_eul
-grant_privilege

-refresh_business_area

-refresh_folder

-refresh_summary

-revoke_privilege

Notes

Any valid username.

2.6.66 -wildcard

Use this command modifier to specify EUL objects using wildcard characters (for more information, see About using wildcards to identify EUL objects).

Information

Details

Syntax

-wildcard

Used with

-delete
-export

Examples

Example 1: For example, to delete all business areas with display names beginning with 'A':

java -jar eulbuilder.jar -connect jchan/12345@my_database
-delete -business_area A% -wildcard

Example 2: To delete all business areas with a developer key of 'A' followed by exactly two more characters:

java -jar eulbuilder.jar -connect jchan/12345@my_database
-delete -business_area A__ -identifier -wildcard

In the above example, a business area with a developer key 'ABC' would be deleted, but not a business area with a developer key 'ABCD'.

2.6.67 -workbook

Use this command modifier to specify a workbook for export or deletion.

Information

Details

Syntax

-workbook <workbook> [-xml_workbooks]

Used with

-delete
-export

2.6.68 -workbook_access

Use this command modifier to grant (or revoke) access to workbooks to (or from) database users, roles, or responsibilities.

Information

Details

Syntax

-workbook_access <workbook>

Used with

-grant_privilege
-revoke_privilege

2.6.69 -xml_workbooks

This command modifier (used with the -export command) forces all workbooks to be exported in XML format and binary large object (BLOB) format. Exporting workbooks in XML format enables you to view the definition of exported workbooks in a text editor or XML browser.

Information

Details

Syntax

-xml_workbooks

Used with

-export

A Discoverer EUL Command Line for Java error messages

This appendix describes error messages used by the Discoverer EUL Command Line for Java.

A.1 Discoverer EUL Command Line for Java error messages

This appendix provides reference information about error message used by the Discoverer EUL Command Line for Java.

Error text

Error description

Delete requested without specifying any objects to delete

A delete request has been specified without providing any EUL objects to delete.

Error creating export file

A file error on creating the EEX file during an export.

Error creating impact analysis file

A file error on creating the impact analysis file using the -log -log_only command.

Error creating log file

A file error on creating the log file.

Error parsing command file <option>

The command file contained syntax errors.

Export requested without specifying any objects to export

An export request was specified without specifying any EUL elements to export (and without specifying the -all option).

Incomplete option

A valid option has been specified but without specifying all the additional options required. For example, if you type '-delete -folder' without specifying a folder name.

Invalid aggregate

An invalid aggregate option has been specified for the bulk load operation. Valid options are sum, max, min, count, avg, and detail.

Invalid date format - use dd/mm/yyyy hh:mm:ss

During an export request you can specify the Created Date and Updated Date. The dates must be in the format 'dd/mm/yyyy hh:mm:ss' or SYSDATE; otherwise, this error is returned.

Invalid gateway type

An invalid gateway option has been specified for the bulk load operation. Valid options are online_dictionary, designer, and external.

Invalid import rename mode

An import request was made specifying an unrecognized rename mode. Valid options are rename_old, rename_new, do_not_import, and refresh.

Invalid join option

An invalid join option has been specified for the bulk load operation. Valid options are primary_key, column_name, and none.

Invalid LOV option

An invalid LOV option has been specified for the bulk load operation. Valid options are char, integer, decimal, date, and key.

Invalid option

An unrecognized command line option has been specified.

Invalid option - cannot set <option> without setting <option>

An option has been requested without specifying the parent option. For example, specifying -lov without being in the context of a bulk load request.

Invalid option - cannot set <option> without setting one of <option>

An option has been requested without specifying a valid parent option. This is the same as above but for options which make sense in more than context. For example, -folder can be valid both for export and delete requests.

No Apps password specified for create Apps EUL operation

A create Applications mode EUL request has been made without specifying the Applications password.

No Apps user specified for create Apps EUL operation

A create Applications mode EUL request has been made without specifying the Applications user.

No command file specified

A command file request was made without specifying a command file to use.

No connection to an EUL has been established

A command request was made without a connection having been made to an EUL.

No user specified for create EUL operation.

A command request was made without specifying a database username (or Applications username).

No password specified for create EUL operation.

A command request was made without specifying a database password (or Applications password).

Refresh requested without specifying any folders or business areas to refresh

A refresh request was made without specifying any folders or business areas to refresh.

You must specify a connect string

A connect request has been specified but no connect string provided.

You must specify a connection to an EUL

A request has been specified without requesting a connection.

You must specify a name for the log file

The -log option has been specified without a filename for the log file.

You must specify an export file

An export request was made without specifying an EEX file to export to.

You must specify some .EEX files to import

An import request was specified without specifying any EEX files to import.

B Differences in syntax between Discoverer command line interfaces

This appendix describes the differences between the Discoverer EUL Command Line for Java and the Discoverer Administrator Command Line Interface.

B.1 Differences in syntax between Discoverer command line interfaces

The Discoverer EUL Command Line for Java is similar to the Oracle Discoverer Administrator Command Line Interface. If you are migrating commands from Oracle Discoverer Administrator Command Line Interface to Discoverer EUL Command Line for Java, note the following differences:

Oracle9iAS Discoverer Administrator Command Line Interface command

Equivalent Discoverer EUL Command Line for Java command

commands and command modifiers are prefixed with the '/' character

commands and command modifiers are prefixed with the '-' character

/insert_blanks

-replace_blanks

/refresh

-import_rename_mode has values <rename_new|rename_old|do_not_import|refresh>

/refresh_bus_area

-refresh_business_area

/rename

-import_rename_mode has values <rename_new|rename_old|do_not_import|refresh>

Index

C  D  E  H  I  J  L  O  P  Q  S  T  U  W  X

C

character set encoding, 2.6.24

EUC Shift_JS UTF-8, 2.6.24

class paths for eulapi, 1.6

command

examples, 1.9

examples of command files, 1.11

syntax, 2.2

testing before use, 1.7

command modifiers

aggregate, 2.6.1

all, 2.6.2

apps_fndnam, 2.6.3

apps_fndnam_password, 2.6.4

apps_grant_details, 2.6.6

apps_gwyuid, 2.6.5

apps_mode, 2.6.7

apps_responsibility, 2.6.8

apps_security_group, 2.6.9

apps_user, 2.6.10, 2.6.11

asm_space, 2.6.12

asm_tablespace, 2.6.12

audit_info, 2.6.13

auto_gen_name, 2.6.14

auto_refresh, 2.6.15

auto_summaries, 2.6.16

auto_upgrade, 2.6.17

ba_link, 2.6.18

business_area, 2.6.19

business_area_access, 2.6.20

business_area_admin_access, 2.6.21

business_area_and_contents, 2.6.22

capitalize, 2.6.23

character_set_encoding, 2.6.24

condition, 2.6.25

date_hierarchy, 2.6.26

db_link, 2.6.27

default_tablespace, 2.6.28

description, 2.6.29

eul, 2.6.30

eul_language, 2.6.31

external_element, 2.6.32

folder, 2.6.33

function, 2.6.34

hier_node, 2.6.35

hierarchy, 2.6.36

identifier, 2.6.37

import_rename_mode, 2.6.38

item, 2.6.39

item_class, 2.6.40

join, 2.6.41

keep_format_properties, 2.6.42

log, 2.6.43

log_only, 2.6.44

lov, 2.6.45

object, 2.6.46

overwrite, 2.6.47

password, 2.6.48

preserve_workbook_owner, 2.6.49

private, 2.6.50

privilege, 2.6.51

remove_prefix, 2.6.52

replace_blanks, 2.6.53

role, 2.6.54

schema, 2.6.55

set_created_by, 2.6.56

set_created_date, 2.6.57

set_updated_by, 2.6.58

set_updated_date, 2.6.59

sort_folders, 2.6.60

sort_items, 2.6.61

source, 2.6.62

summary, 2.6.63

temporary_tablespace, 2.6.64

user, 2.6.65

wildcard, 2.6.66

workbook, 2.6.67

workbook_access, 2.6.68

xml_workbooks, 2.6.69

commands

asm, 2.5.1

character set encoding, 2.6.24

cmdfile, 2.5.2

connect, 2.5.3

create_eul, 2.5.4

delete, 2.5.5

delete_eul, 2.5.6

export, 2.5.7

grant_privilege, 2.5.8

help, 2.5.9

how to enter, 1.6

import, 2.5.10

load, 2.5.11

refresh_business_area, 2.5.12

refresh_folder, 2.5.13

refresh_summary, 2.5.14

revoke_privilege, 2.5.15

compatibility

Linux, 1.1

UNIX, 1.1

Windows, 1.1

D

database

specifying, 2.5.3

tnsnames.ora, 2.5.3

database privileges, 1.5

Discoverer EUL Command Line for Java

about, 1.1

about command modifiers, 1.4

about commands, 1.3

command file examples, 1.11

command files, 1.10

command reference, 2.5

example commands, 1.9

quick guide, 1.12

required database privileges, 1.5

syntax conventions, 2.1

E

eulapi

class paths, 1.6

command syntax, 2.2

directory location, 1.6

example commands, 1.9

how to run commands, 1.6

export files

adding XML code to, 2.6.32

H

help

online, 2.5.9

Heterogeneous Connectivity, 1.1

Heterogeneous Services, 1.1

I

impact analysis, 1.7, 2.6.44

J

Java compatibility, 1.1

L

Linux compatibility, 1.1, 1.1

log files, 1.7

O

objects

loading, 2.6.46

online help, 2.5.9

Oracle BI Discoverer

registry variables, 2.4

P

privileges

database, 1.5

granting, 2.5.8

quota, 1.5

revoking, 2.5.15

tablespace, 1.5

problems

diagnosing, 1.7

Q

quick guide to commands, 1.12

S

syntax

command syntax, 2.2

conventions, 2.1

T

testing commands before use, 1.7

tnsnames.ora, 2.5.3

troubleshooting, 1.7

error messages, A.1

U

UNIX compatibility, 1.1, 1.1

W

wildcards

example using %, 1.8

example using _, 1.8

using to specify EUL objects, 1.8

Windows compatibility, 1.1, 1.1

Windows registry

Discoverer, 2.4

workbook export

XML format, 2.6.69

X

XML

adding to export file, 2.6.32

format for workbook export, 2.6.69

Copyright © 2005, 2011, Oracle and/or its affiliates. All rights reserved.