The Discoverer command-line interface runs only on a Windows platform.

The Discoverer command-line interface enables you to perform tasks without running the Discoverer Administrator or Discoverer Desktop graphical user interface (GUI). For example, using the Discoverer command-line interface you can:

22.3 What are the differences between the Discoverer command-line interface and the Discoverer EUL command line for Java

Much of the Discoverer command-line interface is compatible with the Discoverer EUL command line for Java. If you have commands and scripts written for the Discoverer command-line interface, you can easily convert them to run on the Discoverer EUL command line for Java.

The Discoverer command-line interface and the Discoverer EUL command line for Java differ as follows:

The Discoverer EUL command line for Java runs on any platform. The Discoverer command-line interface runs only on Windows.

Note: You do not need to have Discoverer Administrator installed to run the Discoverer EUL Command Line for Java.

Discoverer EUL command line for Java commands are prefixed with eulapi.

22.6 About using the Discoverer command-line interface

Enter a command in the Windows Run dialog box, which you display by selecting Run from the Windows Start menu).

Enter a command at the DOS command prompt. For example, to display all the available commands available in Discoverer Administrator.

Store a series of commands in a text file (known as a command file) and run the text file as a single argument to the Discoverer executable file.

For example, to run commands stored in the text file import.txt, enter the following command at the command prompt:

dis51adm.exe /cmdfile import.txt

22.7 What privileges are required to run the Discoverer command-line interface?

To use the Discoverer command-line interface, you require the same Discoverer privileges as you do to use the Discoverer graphical user interface.

If you want to perform an operation on an EUL using the Discoverer command-line interface, you must have the correct privileges. If you do not have the correct privileges, the operation will fail.

When using the Discoverer command-line interface, you can explicitly specify an EUL using the modifier /eul (for more information, see "/eul") or if you do not specify an EUL, Discoverer will identify the default EUL for the database user.

22.8 Notes on using commands

When using the Discoverer command-line interface, the following rules apply:

You can display all the commands available in Discoverer Administrator by entering the command dis51adm.exe /? in the Windows Run dialog.

Commands are not case-sensitive - you can use either upper-case or lower-case characters interchangeably.

Commands can appear in any order, if their arguments immediately follow them in the order defined.

Command modifiers can appear in any order, if their arguments immediately follow them in the order defined.

If you do not specify an object name where one is required (for example, an EUL or business area) Discoverer defaults to the Discoverer manager-owned object.

When specifying Discoverer EUL objects, you can use either a display name or an identifier. For example, if a Discoverer folder has the display name Sales, and the identifier SALES_132388, you can specify this folder as an argument to the /refresh_folder command in two ways:

When specifying an object's display name or identifier that contains a special character (for example, a space), enclose the entire string in double quotation marks (“ “). For example, enter the name of the folder object Sales Figures as /folder “Sales Figures”.

When using commands, execute them one at a time. If you try to run more that one command at a time, you might cause errors.

If you use the /connect command to bypass the "Connect dialog", arguments that begin with a slash (/) must be enclosed in double-quotes. For example:

/connect "/[@<dbname>]"

If you want to use the Discoverer Desktop command-line interface to open a workbook from the database (using the /opendb command), the workbook name must not contain a period.

22.9 What command syntax conventions does this guide use?

This guide uses the following command syntax conventions:

Discoverer commands and modifiers are shown in plain type.

Mandatory command arguments are enclosed in angle brackets < >.

Optional command arguments are enclosed in square brackets [ ].

Where command arguments are separated by a pipe character (|), enter one from the list. For example, for the command '/refresh | /rename', enter either '/refresh' or '/rename'.

Figure 22-2 Command conventions used in this guide

22.10 What is the syntax for commands?

Use this syntax for the Discoverer command-line interface (typed in a single line with no line breaks or carriage returns):

Where:

dis51adm.exe - the name of the Discoverer executable file. The name depends on the version of Discoverer you are using, as follows:

22.12 What is a command file?

Command files are text files that contain one or more Discoverer commands that can be run automatically from the command line. Command files work in a similar way to MS-DOS batch files and UNIX script files.

The commands in a command file are treated as though they were entered directly on the command line. Carriage returns embedded in the text file are ignored.

A command file can in turn invoke other command files. This provides a convenient work around for the Microsoft Windows imposed limitation of restricting a command line to not more than 255 characters in length.

22.13 How to create a command file

You can create a command file using a text editor. Type the command into the text editor and save the file using the extension txt.

22.14 How to run a command file

To run a command file, start the Discoverer Administrator executable (for example, dis51adm.exe) with the name of the command file as an argument to the /cmdfile command. For example, to run commands stored in the text file Import.txt, type:

dis51adm.exe /cmdfile Import.txt

You can also run more than one command file by repeating the /cmdfile command. For example, to run commands stored in the text file Login.txt, then commands in Import.txt, type:

dis51adm.exe /cmdfile Login.txt /cmdfile Import.txt

22.15 Examples of command files

Command files are a convenient way to store modular commands, which can then be used in different combinations. For example, the following three command files contain the following commands:

connect.txt

contains the line /connect me/mypassword@mydatabase

create.txt

contains the line /create eul /log create.log

delete.txt

contains the line /delete eul /log delete.log

These three files can then be run from the command line in any of the following three combinations:

dis51adm.exe /cmdfile connect.txt

This would be a simple connect from the command line.

dis51adm.exe /cmdfile connect.cmd /cmdfile create.txt

This would connect and create an EUL for the connected user, storing all output into a log file named create.log.

dis51adm.exe /cmdfile connect.cmd /cmdfile delete.txt

This would connect and delete the EUL owned by the connected user, storing all output into a log file named delete.log.

22.16 Quick guide to Discoverer Administrator commands

Use the table below to find a brief description of a Discoverer Administrator command:

22.17.9 /create_eul /apps_mode

This command enables you to create an Oracle Applications Mode EUL using the Discoverer command-line interface. This command starts Discoverer Administrator (in Oracle Applications mode), creates the Applications Mode EUL in the database, and connects you to it. The example also includes the specification of schema/password.

22.17.13 /export (EUL objects)

This command enables you to export EUL objects to a Discoverer export file (EEX file). You can selectively export individual EUL objects (for example, folders, business areas, functions) or entire EULs (using the /all modifier). 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 will actually be in both files, but neither file contains the information for both folders. If you import both files, the join is re-created when the second file is processed.

<filename> - The name of the target *.EEX file. 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 that the directory path must be an absolute path, not a relative path.

Wildcards are not allowed for parameters (for example, business areas, folders) these must be named explicitly.

[<bus_area_name>] - Use this option to export an entire business area and its contents (that is, all EUL objects in the business area). If you only want to export the business area definition and metadata for the contents, use the /business_area modifier.

When you export a business area using the /business_area modifier, Discoverer exports only business area definitions (for example, business area name and description) and links to the folders in the business area. Discoverer will export the folders and workbooks only when they are specified by name.

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

Example:

To export two business areas named Test BA and Final BA, residing in an EUL named eul_sales, into a file named export.eex, and write to a log file named export.log, enter:

22.17.15 /import (EUL objects)

This command enables you to import EUL objects from one or more Discoverer export files (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).

<source filename(s)> - the name(s) of the source *.EEX file(s). You must specify the full path name for the file (for example, 'c:\data\sales.eex'). Note that the directory path must be an absolute path, not a relative path.

Wildcards are not allowed for parameters (for example, business areas, folders) these must be named explicitly.

Where multiple files are being imported, all files must be encapsulated in one pair double quotes and separated by spaces (for example, see below).

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.

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

Specify an alternative database link from which to fetch the data (default is the current connection).

Filter the load by schema name (/user) (default is that no filter is used).

Filter the load by object name (default is that no filter is used).

Specify pre-formatting of the data with respect to capitalization, prefixes and blank spaces (default is that no pre-formatting is done).

Specify the data source from which to refresh the named Business Area(s).

Specify an EUL in which to find the business area(s) to refresh. The Discoverer manager's own EUL is the default. If you specify the EUL, you must have access privileges to the named EUL in order for the operation to succeed.

Filter the refresh by schema name. By default, no filter is used.

Specify a log file.

Example:

To refresh two Business Areas named Test BA and Final BA that reside in an EUL named eul_sales, from a source on the current connection that contains tables matching the pattern test% owned by user Bob, and summarize information in a log file named refba.log, enter:

Specify in which EUL the Business Area can be found. The Discoverer manager's own EUL is the default EUL for the search. If you specify the EUL, you must have access privileges to the named EUL in order for the operation to succeed.

It is necessary to name at least one summary folder and explicitly name the Business Area in which the summary resides.

Specify a log file path (optional).

A status message indicating the success or failure of the operation will be output to the specified log file path, or the default log file if one was not specified.

Example:

To refresh two summaries named Summary1 and Summary2, found in an EUL named eul_sales, and write to a log file named refsum.log, enter:

22.18 Discoverer Administrator command modifier reference

This section contains detailed reference information about optional Discoverer Administrator command modifiers available in the Discoverer command-line interface. Command modifiers are used to refine or qualify commands. Note the following:

22.18.1 /aggregate

The /aggregate modifier enables you to specify the default aggregate to be used by a command.

Information

Details

Syntax:

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

22.18.2 /all

The /all modifier enables you to select every object in an EUL for import, export or deletion.

Information

Details

Syntax:

/all

22.18.3 /apps_grant_details

The /apps_grant_details modifier enables you to specify an Oracle Applications schema and password when creating an Oracle Applications mode EUL. For example, to specify the Oracle Applications foundation name and password (<fndnam>/<password>).

Information

Details

Syntax:

/apps_grant_details <schema>/<password>

22.18.4 /apps_responsibility

The /apps_responsibility modifier enables you to specify an Oracle Applications responsibility when connecting as an Oracle Applications database user. This can also be included immediately following a colon (:) placed after the Oracle Applications user name but before the password.

Information

Details

Syntax:

/apps_responsibility <“Oracle Applications responsibility name”>

22.18.5 /apps_security_group

The /apps_security_group modifier enables you to specify an Oracle Applications security group when connecting as an Oracle Applications database user.

Information

Details

Syntax:

/apps_security_group <"Oracle Applications security group name">

22.18.6 /asm_space, /asm_tablespace

The /asm_tablespace modifier ignores any tablespace value set in the ASM policy and uses this tablespace constraint instead. The /asm_space modifier ignores any space value set in the ASM policy and uses this space constraint instead. The following are valid combinations of tablespace and space values:

No command-line modifiers - The ASM policy tablespace and space will be used.

/asm_space - The ASM policy tablespace will be used with the specified value of space.

/asm_tablespace /asm_space - The specified values of tablespace and space will be used. An error will be raised if you specify an invalid tablespace.

22.18.7 /audit_info

The /audit_info modifier enables you to export audit fields with every object, (Created By, Created Date, Updated By, Updated Date). You can override the Created By and Updated By fields using the additional modifiers /set_created_by and /set_updated_by.

22.18.8 /auto_gen_name

The /auto_gen_name modifier enables you to set the Auto-Generate name property of all imported secondary elements to Yes (only if the AutogenNameOnCreate Registry setting is present in the registry and its value is set to 1). For more information, see "What are primary and secondary elements?".

For example, you might export a business area called Performance to an EEX file. If you subsequently import the Performance business area from the EEX file and specify this command modifier, Discoverer sets the Auto-Generate name property of all imported secondary elements to Yes, irrespective of the value that exists in exported file. For more information, see "About generating and updating EUL item names automatically".

22.18.9 /ba_link

The /ba_link modifier enables you to specify a business area and folder for deletion.

Information

Details

Syntax:

/ba_link <business area>.<folder>

22.18.10 /business_area

The /business_area modifier enables you to specify a business area for import, export or deletion

Information

Details

Syntax:

/business_area <business area>

Notes:

When used with the /export command, this modifier only exports the business area definition (for example, business area name and description).If you want to export the entire business area (including folders, item classes, hierarchies, and so on), use with the /all modifier also.

22.18.11 /capitalize

The /capitalize modifier enables you 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

22.18.12 /condition

The /condition modifier enables you to specify a condition for deletion.

Information

Details

Syntax:

/condition <condition>

22.18.13 /date_hierarchy

The /date_hierarchy modifier enables you to specify the date hierarchy to be used during a bulk load.

Information

Details

Syntax:

/date_hierarchy <date_hier>

Notes:

Any valid date hierarchy name or ““. If you set <date_hier> to "", Discoverer Administrator will not create a hierarchy for dates during bulk load.

22.18.14 /db_link

The /db_link modifier enables you to specify the database link to be used by a command.

Information

Details

Syntax:

/db_link <db_link>

Notes:

<db_link> can be any valid database link.

22.18.15 /description

The /description modifier enables you to specify a description for an object.

Information

Details

Syntax:

/description <description>

Notes:

<description> can be any string.

22.18.16 /eul

The /eul modifier enables you 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>

Notes:

<EUL> must be the name of a valid EUL.

Note that this does not change the default EUL for the user.

22.18.17 /eul_language

The /eul_language modifier used (currently by Oracle Applications) with the /create_eul command, enables you to specify a language for the EUL.

Information

Details

Syntax:

/eul_language <language>

22.18.18 /external_element

The /external_element modifier is used only with the /export command. The external_element modifier enables you to place XML code from a specified file at the top of the export file.

Information

Details

Syntax:

/external_element <filename>

Notes:

To use this modifier you enter the XML (that you want to place at the top of the export file) into a separate file then include this filename as the <filename> argument.

The /external_element modifier can be used 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.

22.18.30 /log

The /log modifier enables you to specify a name for the log file that stores command status messages. After each command is executed, Discoverer Administrator writes a status message indicating whether the command was successful. You can override the name and location of the log file using the /log modifier.

Information

Details

Syntax:

/log <filename>

Notes:

Any valid filename (dependent on the operating system).

22.18.31 /log_only

The /log_only modifier enables you to simulate a command and generate a log, without changing your data. This option enables you to check for errors and exceptions before changing your data.

Information

Details

Syntax:

/log <filename> [/log_only]

Notes:

Any valid filename (dependent on the operating system).

The optional log_only argument enables you to simulate an import and generate a log, without importing the data. This option enables you to check for import errors before changing your data

22.18.32 /lov

The /lov modifier enables you to specify the data types for which a list of values should be generated during a bulk load.

Information

Details

Syntax:

/lov [CHAR|DATE|DECIMAL|INTEGER|KEY]

22.18.33 /object

The /object modifier enables you to specify an object for bulk load, import, export or deletion.

Information

Details

Syntax:

/object <mask>

Notes:

Any valid object name. You can use wildcard characters.

22.18.34 /overwrite

The /overwrite modifier enables you to overwrite an existing EUL owned by the intended owner. If omitted, the default is to not overwrite an existing EUL.

Information

Details

Syntax:

/overwrite

22.18.35 /parameter

The /parameter modifier enables you to specify a parameter for deletion. When specifying parameters, you can use either their Display Name or Identifier.

Information

Details

Syntax:

/parameter <folder>.<parameter>

22.18.36 /password

The /password modifier enables you to specify a new password to be used by the operation.

Information

Details

Syntax:

/password <password>

Notes:

Any valid password associated with the value specified by the /user modifier.

22.18.37 /private

When you create an EUL, the /private modifier enables you to define its status as private to the Discoverer manager. If omitted, the status defaults to 'public'.

Information

Details

Syntax:

/private

22.18.38 /refresh

The /refresh modifier enables you to merge imported objects with existing objects. By default, merged objects are matched on display name. Use the "/identifier" modifier to match on identifier.

Information

Details

Syntax:

/refresh

22.18.39 /remove_prefix

The /remove_prefix modifier enables you to request 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

Example:

Columns:

EMP_EMPNO EMP_ENAME

Items:

EMPNO ENAME

22.18.40 /rename

The /rename modifier enables you to specify which objects are renamed when importing objects that match existing objects.

Information

Details

Syntax:

/rename <NEW|OLD|NONE>

Notes:

NEW - rename the imported objects that match the existing objects.

OLD - rename the existing objects that match the imported objects.

NONE - stop the operation without importing the objects.

22.18.41 /schema

The /schema modifier enables you to specify a schema (user) for the operation.

Information

Details

Syntax:

/schema <schema>

22.18.42 /show_progress

The /show_progress modifier enables you to monitor a command in operation.

Information

Details

Syntax:

/show_progress

22.18.43 /sort_folders

The /sort_folders modifier enables you to specify that Discoverer will alphabetically sort folders during a bulk load.

Information

Details

Syntax:

/sort_folders <ON|OFF>

Notes:

ON is the default

22.18.44 /sort_items

The /sort_items modifier enables you to specify that Discoverer will alphabetically sort items during a bulk load.

Information

Details

Syntax:

/sort_items <ON|OFF>

Notes:

OFF is the default

22.18.45 /source

The /source modifier enables you to specify the source for the operation.

Information

Details

Syntax:

/source <server|gateway>

Notes:

<server> is the name of a native Oracle database

<gateway>is the name of the gateway. The gateway name must exactly match the gateway name displayed in the Load Wizard.).

22.18.46 /summary

The /summary modifier enables you to specify a summary for import, export or deletion.

Information

Details

Syntax:

/summary <summary>

22.18.47 /user

The /user modifier enables you to specify the user ID to be used for the operation.

Information

Details

Syntax:

/user <user_id>

Notes:

Any valid user ID.

22.18.48 /workbook

The /workbook modifier enables you to specify a workbook for import, export or deletion.

Information

Details

Syntax:

/workbook <workbook>

22.18.49 /xmlworkbook

The /xmlworkbook modifier (used with the /export command) forces all workbooks to be exported both in XML format and binary large object (BLOB) format. The /xmlworkbook modifier enables you to view exported workbooks in an XML browser.

Information

Details

Syntax:

/xmlworkbook

Notes:

Takes no parameters.

22.19 Discoverer Desktop command reference

This section contains detailed reference information about each command in the Discoverer Desktop command-line interface. Note that commands are listed in alphabetical order.

22.19.1 /?

This command displays a list of Discoverer Desktop commands.

Information

Details

Syntax:

/?

Modifiers:

None

Notes:

None

Restrictions:

None

Example:

dis51usr.exe /?

22.19.2 /apps_fndnam

This command overrides the values for the fields FNDNAM in the Connection tab of the Options dialog.

Tip: The multiple workbooks example above is particularly useful if you are moving from Discoverer Desktop to Discoverer Plus and need to copy lots of workbooks from the file system to the database.

22.19.15 /sheet

This command enables you execute a query for the specified sheet(s).

Information

Details

Syntax:

/sheet {<sheet-name>|<sheet-number>|ALL}

Modifiers:

None

Notes:

Discoverer executes a query for:

the sheet name <sheet-name>

the specified sheet number <sheet-number>

all sheets (ALL).

22.20 Discoverer Desktop command modifier reference

This section contains detailed reference information about optional Discoverer Desktop command modifiers available in the Discoverer command-line interface. Command modifiers are used to refine or qualify commands. Note the following:

22.20.1 /all

The /all modifier enables you to select every object in an EUL for import, export or deletion.

Information

Details

Syntax:

/all

22.20.2 /apps_responsibility

The /apps_responsibility modifier enables you to specify an Oracle Applications responsibility when connecting as an Oracle Applications database user. This can also be included immediately following a colon (:) placed after the Oracle Applications user name but before the password.

Information

Details

Syntax:

/apps_responsibility <“Oracle Applications responsibility name”>

22.20.3 /eul

The /eul modifier enables you 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>

Notes:

<EUL> must be the name of a valid EUL.

Note that this does not change the default EUL for the user.

Scripting on this page enhances content navigation, but does not change the content in any way.