Using API and Command-line Specifications

You can run PS2Essbase from the Create Cube page using Process Scheduler or the command line.

The following table lists the parameters that PS2Essbase uses when PS2Essbase runs from the command line.



A, a

Outline Name.

R, r

Run Control ID.

I, i

Process Instance ID number, such as I42, usually passed by Process Scheduler.

CT, ct

Database type.

For example, -CTORACLE.

CD, cd

Database name.

For example, -CDPT850RC1.

CO, co

Operator ID.

For example, -COPTDMO.

CP, cp


For example, -CPPASSWORD.

EC, ec

Essbase Connection Name.

OP, op

Log files output destination.

Note: When running PS2Essbase from the command line, in the –OP command line option, you must enclose the output destination patch in quotes.

For example, –OP “c:\tmp\ps”.

M, m

Metadata action, such as -mC:

  • N - No action on metadata.

  • C - (Re)create metadata from scratch.

  • U - Incrementally merge updates with existing metadata.

  • R - Incrementally update existing metadata, remove unspecified members.

D, d

Outline Restructure option:

  • N - Keep all data.

  • R - Discard all data.

  • I - Reload all data.

  • D - Keep only level 0 data.

  • A - Keep only input data or data blocks created by data loading.

L, l

Logging level.

For example, L31.

X, x (optional)

Dimension name for single dimension execution.

Y, y (optional)

PS Data Query name for single factory execution.

Z, z

Parameter used to load the aggregations on load option. Available options are:

  • R,r - Replace.

  • A,d - Addition.

  • S,s - Subtraction.

For example, the parameters list passed using this command line:

ps2essbase.exe -CX -CTORACLE -CDPT850RC1 -COPTDMO 
  • Run Control ID = EMPLOYMENT

  • Outline = EG_DIVISION

  • Metadata Action = Create

    Note: The log files will be deposited in the –OP location. For this example, the –OP location is “c:\tmp\ps”.

  • Restructure Option = Discard all data

    These metadata and restructure options indicate that metadata will be fully recreated or created if it did not exist, and all previous data, if it existed, will be discarded.

  • Logging level includes Basic, Detail, Member, and Fact map logging; we specified L15, where 15 = 1 (Basic) + 2 (Detail) + 4 (Member) + 8 (Fact).

  • Single Dimension = GL_ACCOUNT

  • Single Data Query = QRY_MEASURES


You can pass the log level with the L option to the command line of psolap.exe; for example, L2 or L6, and so on.

The following table lists the log level and the data recorded in each log level.

Log Level

What is recorded


Basic logging


Detail logging


Dimension member logging


Fact map logging


API logging

When you run the process using Process Scheduler, the logging level is set on the Create Cube page. When you run the process from the command line, the logging level is set using the –L parameter. To calculate these logging settings, Cube Builder adds the options that you define. For example:

  • To see logs for Single Dimensions and Essbase API, enter 20.

    20 is the sum of Dimension member logging + API logging = 4 + 16 = 20.

  • To see all the logs that are available, enter 31.

    31 is the sum of Basic logging + Detail logging + Dimension member logging + Fact map logging + API logging = 1 + 2 + 4 + 8 + 16 = 31.