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 OracleBI Discoverer Registry Variables for Use by OracleBI Discoverer EUL Command Line for Java Commands"
"Discoverer EUL Command Line for Java command reference"
"Discoverer EUL Command Line for Java command modifier reference"

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 (-).

Hint: Do type the dash.
Mandatory command arguments and command modifiers are enclosed in angle brackets < >.

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

Hint: Do not type the square brackets.
Variable command arguments (i.e. where you supply the value) are shown in italics.
Where options are separated by a pipe character (i.e. |), choose one from the list. For example, 'source <server | gateway>' means type either 'source server' or 'source gateway'.

Note: Do not type the pipe character.

Figure 2-1 Command conventions used in this guide

Description of "Figure 2-1 Command conventions used in this guide"

Key to figure:

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

What is the syntax for commands?

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

eulapi -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 as long as their arguments immediately follow them in the correct order.
Command modifiers can appear in any order as long as 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 more than one EUL object, 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:
```
eulapi -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 (e.g. -connect username/password@database), you do not need to include the -connect command after the eulapi section. In other words, if you store connection details in connect.txt, you might use the following command to connect to a database:
```
eulapi -cmdfile connect.txt
```

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 machine. Use the optional <database> argument if you have more than one database installed on your machine, or if you are connecting to a database on a different machine.
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 (e.g. folder names) or identifiers (i.e. 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 Business Intelligence Discoverer Administration Guide.
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.

Setting OracleBI Discoverer Registry Variables for Use by OracleBI Discoverer EUL Command Line for Java Commands

When using some of the commands provided by the OracleBI 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 Business Intelligence Discoverer Administration Guide.

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

-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 will be used.
Examples:	eulapi -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 Business Intelligence Discoverer Administration Guide.

-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: eulapi -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: eulapi -connect jchan/12345@my_database -cmdfile c:\scripts\refresh.txt

-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 machine include the full database details (e.g. 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: eulapi –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: eulapi -connect sysapps/sysapps@apps_db -apps_user -apps_responsibility sysresp1 -fndnam_password APPS -eul AppsEUL Example 3: A non-Oracle Applications connection: eulapi –connect jchan/12345@my_database -eul eultest

-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 will own 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: eulapi -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: eulapi -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: eulapi –connect jchan/12345@my_database -create_eul –user bob –password 3728372 –default_tablespace usr –temporary_tablespace temp

-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: eulapi -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: eulapi -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: eulapi -delete -identifier -connect jchan/12345@my_database -cmdfile delete.txt -log delete08082003.log

-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 (i.e. the username specified by the -connect command).
Examples:	Example 1: To delete an EUL and store processing details in a log file. eulapi -connect jchan/12345@my_database -delete_eul -log "c:\my log dir\delete_eul.log"

-export

Use this command to export EUL objects to a Discoverer export file (i.e. a file with an EEX extension). You can selectively export individual EUL objects (e.g. 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 (e.g. 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 will export 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: eulapi -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: eulapi -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

-grant_privilege

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

Information	Details
Syntax:	-grant_privilege <modifiers>
Modifiers:	-apps_responsibility <responsibility> -business_area_access <business area> -business_area_admin_access <business area> -identifier -log <log file name> [-log_only] -privilege `<`privilege> -role <role> -user <username> -wildcard -workbook_access <workbook>
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: eulapi –connect jchan/12345@my_database -eul eultest –grant_privilege –privilege create_edit_business_area –user JOE Example 2: To grant workbook access to role USER_ROLE: eulapi –connect jchan/12345@my_database -grant_privilege –workbook_access jchan.ÒWorkbook oneÓ –role USER_ROLE 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: eulapi –connect jchan/12345@my_database -grant_privilege –user JOE -user JCHAN –privilege all_admin_privs

-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: eulapi -help To see detailed help on specific commands: eulapi -help <command name(s)> Note: To see help on more than one command, separate commands with a comma. To see detailed help on all commands: eulapi -help -all

Information

Details

Syntax:

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

Modifiers:

-all

Examples:

To see a terse list of commands:

eulapi -help

To see detailed help on specific commands:

eulapi -help <command name(s)>

Note: To see help on more than one command, separate commands with a comma.

To see detailed help on all commands:

eulapi -help -all

-import

Use this command to selectively import EUL objects from one or more Discoverer export files (i.e. EEX files). Discoverer export files are created using the -export command, and contain EUL objects (e.g. 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 will be 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 (e.g. 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: eulapi -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: eulapi -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

-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 Oracle9i (and later) database, 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: eulapi -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"

-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: eulapi -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 a number of business areas identified by identifier, enter:
	eulapi -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...

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

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: eulapi -connect jchan/12345@my_database -refresh_folder Sales1 -refresh_folder Sales2 -log reffol.log

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

eulapi -connect jchan/12345@my_database -refresh_folder Sales1 -refresh_folder Sales2 -log reffol.log

-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: eulapi -connect jchan/12345@my_database -refresh_summary Summary1 -refresh_summary Summary2 -business_area "Test BA" -log refsum.log -eul eul51

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:

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

-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:	-apps_responsibility <responsibility> -business_area_access <business area> -business_area_admin_access <business area> -identifier -log <log file name> [-log_only] -privilege `<`privilege> -role <role> -user <username> -wildcard -workbook_access <workbook>
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: eulapi –connect jchan/12345@my_database -eul eultest –revoke_privilege –privilege create_edit_business_area –user JOE Example 2: To revoke access to a workbook from a role: eulapi –connect jchan/12345@my_database -revoke_privilege –workbook_access ÒWorkbook oneÓ –role USER_ROLE Example 3: To revoke all administration and user privileges from users JOE and JCHAN: eulapi –connect jchan/12345@my_database -revoke_privilege –privilege all_admin_privs –privilege all_user_privs –user JOE user JCHAN

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"

-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

-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

-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:	eulapi -connect appsuser:appsresp/appspwd -apps_fndnam apps

-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

-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: eulapi -connect appsuser:appsresp/appspwd -apps_gwyuid applsyspub/pub

-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

-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 in conjunction with the -create_eul command.

Information	Details
Syntax:	-apps_mode
Used with:	-create_eul
Notes:	See also -apps_grant_details.

-apps_responsibility

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

Information	Details
Syntax:	-apps_responsibility <Oracle Applications responsibility name>
Note:	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: eulapi -connect appsuser:appsresp/appspwd -apps_gwyuid applsyspub/pub
Used with:	-connect -grant_privilege -revoke_privilege

Information

Details

Syntax:

-apps_responsibility <Oracle Applications responsibility name>

Note:

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:

eulapi -connect appsuser:appsresp/appspwd -apps_gwyuid applsyspub/pub

Used with:

-connect

-grant_privilege

-revoke_privilege

-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

-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: eulapi -connect appsuser/appspwd -apps_user -apps_responsibility UK_Purchasing -apps_security_group UK_Managers Example 2: eulapi -connect appsuser:UK_Purchasing/appspwd -apps_user -apps_security_group UK_Managers

-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

-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

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

-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

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:

-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 Business Intelligence Discoverer Administration Guide.

Information	Details
Syntax:	-auto_gen_name
Used with:	-import

-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

-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 already been queried and processed so that it can be re-used. This enables you to improve Discoverer's performance and minimize response times for Discoverer end-users.

Information	Details
Syntax:	-auto_summaries
Used with:	-load

Notes:

For more information about summary folders and ASM, see Oracle Business Intelligence Discoverer Administration Guide.

-auto_upgrade

Use command modifier to enable Discoverer to automatically upgrade an EUL when you connect to an EUL. For example, you might need to 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

-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").

-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 (e.g. 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

Information

Details

Syntax:

-business_area <business area>

Used with:

-delete

-export

-refresh_summary

-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

-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

-business_area_and_contents

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

Note: To export or delete a business area definition but leave the objects (e.g. 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

Information

Details

Syntax:

-business_area_and_contents <business area>

Used with:

-delete

-export

-refresh_business_area

-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

-character_set_encoding

Use this command modifier to specify the character set in which command files are saved (e.g. 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 (i.e. EUC). However, on Windows, Japanese characters are usually encoded in Shift_JIS or UTF-8, which means that you need to 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.

-condition

Use this command modifier to specify a condition for deletion.

Information	Details
Syntax:	-condition <condition>
Used with:	-delete

-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

-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

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

-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 ("").

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

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.

-eul_language

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

Information	Details
Syntax:	-eul_language <language>
Used with:	-create_eul

-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: eulapi -connect jchan/12345@my_database -export myBA.eex -business_area bus_area1 -external_element custom1.xml -external_element custom2.xml

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

-function

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

Information	Details
Syntax:	-function <PL/SQL function>
Used with:	-delete -export

-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

-hierarchy

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

Information	Details
Syntax:	-hierarchy <hierarchy>
Used with:	-delete -export

-identifier

Use this command modifier to specify EUL objects by identifier, rather than by 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: eulapi -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: eulapi -connect jchan/12345@my_database -delete -folder FOLDER_01 -identifier

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

-item

Use this command modifier to specify an item for deletion.

Information	Details
Syntax:	-item <item>
Used with:	-delete -export

-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

-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

-keep_format_properties

Use this command modifier to keep existing format properties (e.g. 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 (i.e. the EEX file).

Information	Details
Syntax:	-keep_format_properties
Used with:	-import

-log

This 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> already exists, the existing log file is overwritten. If the file specified by <log file name> does not exist, a new file is created.

-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 in conjunction with the -log command modifier.

Information	Details
Syntax:	-log <log file name> [-log_only]
Used with:	-log

-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

-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

-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

-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

-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

-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

-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
Notes:	<privileges> can be one of the following: 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 (e.g. 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 (e.g. drill out, schedule_workbook). Use 'format_business_area' to enable the user or role to edit formatting information (e.g. 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.
Notes continued:	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 (i.e. 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 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 following privileges: user_edition create_edit_query collect_qpp item_drill drill_out grant_workbook schedule_workbook save_workbook_database

-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:	eulapi -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.

-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:	eulapi -connect jchan/12345@my_database -load "Test BA" -replace_blanks In this example, an item named Store_name would be loaded as Store name.

-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

-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

-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: eulapi -connect jchan/12345@my_database -export export.eex -business_area "Test BA" -audit_info -set_created_by jchan

-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: eulapi -connect jchan/12345@my_database -export export.eex -business_area "Test BA" -audit_info -set_created_date "1st January 2004"

-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

-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

-sort_folders

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

Information	Details
Syntax:	-sort_folders
Used with:	-load

-sort_items

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

Information	Details
Syntax:	-sort_items
Used with:	-load

-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 prior to Oracle Designer 6i, simply specify "Oracle Designer repository").

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

-summary

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

Information	Details
Syntax:	-summary <summary>
Used with:	-delete -export

-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

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

-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':

eulapi -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:

eulapi -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'.

-workbook

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

Information	Details
Syntax:	-workbook <workbook> [-xml_workbooks]
Used with:	-delete -export

-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

-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

Information	Details
Syntax:	-load -join <NONE\|COLUMN_NAME\|PRIMARY_KEY> -delete -join <join name>
Used with:	-delete -load