About the Oracle BI Server Command-Line Utilities

You can use command-line utilities with the Oracle BI Server to make programmatic changes to your repository file, run sample queries, delete unwanted repository objects, and perform other tasks.

The table describes the Oracle BI Server command-line utilities.

Important:

When using tools such as nqcmd, biserverxmlcli, and comparerpd, you must edit the input to match the format expected by SQL, for example, don't include a single quote in your XML content.

Utility Name Description Where to Go for More Information

biserverextender

Use to import flex object changes from ADF data sources and map them to the Business Model and Mapping layer and Presentation layer.

Automatically Map Flex Object Changes Using the biserverextender Utility

biservergentypexml

Used to compare data types of logical columns between a particular repository and a generated list of logical column types to ensure that the types match as expected.

Generate a List of Logical Column Types

Compare Logical Column Types

XML utilities (biserverxmlgen, biserverxmlexec, biserverxmlcli)

Use to leverage the Oracle BI Server XML API for metadata migration, programmatic metadata generation and manipulation, metadata patching, and other functions.

The XML utilities include:

  • biserverxmlgen: generates XML from an existing Oracle BI repository file. Also includes an option to generate repositories in MDS XML format.

  • biserverxmlexec: runs the XML in offline mode to create or modify a repository file. Also includes an option to run XML in MDS XML format.

  • biserverxmlcli: runs the XML against the Oracle BI Server.

XML Schema Reference for Oracle Business Intelligence Enterprise Edition

comparerpd

Used to compare two repositories and generate a CSV diff file, an XML patch file, or an MDS XML diff.

Compare Repositories Using comparerpd

deleteapproles

Use to upload a JSON file containing a list of application roles to delete from a specific server instance.

Delete Application Role Command

deleteusers

Used to upload a JSON file containing a list of users to delete from a specific server instance.

Delete Users Command

downloadrpd

Use to download the repository to work offline on diagnostics and development tasks.

Download Repository Command

equalizerpds

Use to equalize objects in two repositories that have the same name, but different Upgrade IDs. Running this utility before merging repositories prevents unintended renaming during the merge.

Equalize Objects

externalizestrings

Use to localize the names of Presentation layer subject areas, tables, hierarchies, columns and their descriptions.

Configure Oracle Analytics Server to Use DataDirect

extractprojects

Use to extract projects from a given repository.

Use the extractprojects Utility

listConnectionPool

Use to create a list of connection pools in JSON format for a specific server instance.

List Connection Pool Command

listrpdvariable

Use to create a list of repository variables in JSON format for a specific service instance.

List Repository Variables Command

mhlconverter

Use to convert MUD history files from .mhl format to .xml format so that you can check in the files under source control.

Check In New Versions of the MUD Master and MUD Log File to Source Control

nqaggradvisor

Use to invoke the Oracle BI Summary Advisor to generate an aggregate specification script that's run to create aggregates. This utility is only available for Oracle Analytics Server running on an Oracle Exalytics machine.

Using the nqaggradvisor Utility to Run the Oracle BI Summary Advisor

nqcmd

Use to run test queries against the repository. Connects using an Oracle BI Server ODBC DSN.

Using nqcmd to Test and Refine the Repository

nqlogviewer

Use to view the query log.

Administering Oracle Analytics Server

obieerpdpwdchg

Used to change the Oracle BI repository password.

Changing the Oracle BI Repository Password Using the obieerpdpwdchg Utility

patchrpd

Use to apply an XML patch file. This utility is especially useful for patching repository files on Linux systems.

Using patchrpd to Apply a Patch

prunerpd

Use to delete unwanted repository objects from your repository file, such as databases, tables, columns, initialization blocks, and variables.

Delete Unwanted Objects from the Repository

renameapproles

Use to upload a JSON file containing information about the application roles to rename for a specific server instance.

Rename Application Role CommandRename Application Role Command

renameusers

Used to upload a JSON file containing a list of information about users to rename for a specific server instance.

Rename Users Command

sametaexport

Use to generate the information necessary for the Oracle Database SQL Access Advisor to preaggregate relational data and improve query performance.

Exchange Metadata with Databases to Enhance Query Performance

updateConnectionPool

Use to upload a modified JSON file containing updated connection pool values to a specific server instance.

Update Connection Pool Command

updaterpdvariable

Use to upload a JSON file or a modified JSON file containing variable information to a specific server instance.

Update Repository Variables Command

uploadrpd

Use to upload the repository to the Oracle BI Server and include changes in the Oracle Analytics Server archive (BAR) file.

Upload Repository Command

validaterpd

Use to check the consistency of a repository.

Using the validaterpd Utility to Check Repository Consistency