Extractors

ID Name Reads from

essbase-xml

Essbase Outline XML Extractor

A local Essbase outline XML export file

essbase-java-xml

Essbase Java API XML Extractor

Essbase directly, via the Essbase Java API, exporting outline XML and reading it back

essbase-java-members

Essbase Java API Member Extractor

Essbase directly, via the Essbase Java API, walking the member tree recursively

essbase-rest-xml

Essbase REST XML Extractor

Essbase directly, via the Essbase REST API, exporting outline XML and reading it back

essbase-rest-members

Essbase REST Member Extractor

Essbase directly, via the Essbase REST API, walking the member tree recursively

pbcs

PBCS Extractor

An Oracle EPM Cloud (PBCS/Planning) plan type

jdbc

JDBC Extractor

A previously-written outline, read back from the relational tables jdbc (the writer) produces

Every extractor that connects to something live (the Java API, REST, and PBCS variants) accepts server/username/password (or endpoint for the REST variants) plus application/cube, and carries those three onto the extracted outline automatically (Server/application/cube propagation). Run describe-providers (Discovering providers) at any time for the authoritative, exact property list per extractor - the tables below are current as of this manual’s printing, but the command is always live.

Essbase Outline XML Extractor

The exception to the rest of this section - essbase-xml doesn’t connect to anything. Point file-path at a local Essbase outline XML export (the same format essbase-xml-writer produces, or one exported some other way) and it reads that file directly, no server or credentials needed.

Property Type Required Default Description

file-path

String

Yes

Path to an exported outline XML file to read

alias-tables

String

No

Optional alias table filter - restricts which alias tables get read, if you only need specific ones

Essbase Java API XML Extractor

Connects to Essbase via the Essbase Java API, exports outline XML, and reads that back in - the same round trip essbase-xml performs against a file you already have, done live against a server.

Property Type Required Default Description

server

String

Yes

Essbase server hostname or alias

username

String

Yes

Essbase username

password

String

Yes

Essbase password

application

String

Yes

Essbase application; resolved from the configured server

cube

String

Yes

Essbase cube; resolved from the selected application

output-file

String

No

Optional local copy of the exported outline XML

Essbase Java API Member Extractor

Connects to Essbase via the Essbase Java API and walks the live member tree recursively, rather than exporting and re-parsing XML - the same source information, a different path to it.

Property Type Required Default Description

server

String

Yes

Essbase server hostname or alias

username

String

Yes

Essbase username

password

String

Yes

Essbase password

application

String

Yes

Essbase application; resolved from the configured server

cube

String

Yes

Essbase cube; resolved from the selected application

Essbase REST XML Extractor

Connects to Essbase via the Essbase REST API, downloads an outline XML export, and reads it back in - the REST equivalent of essbase-java-xml, for environments without direct Java API access.

Property Type Required Default Description

endpoint

String

Yes

Essbase REST API base URL

username

String

Yes

Essbase username

password

String

Yes

Essbase password

application

String

Yes

Essbase application; resolved from the configured endpoint

cube

String

Yes

Essbase cube; resolved from the selected application

output-file

String

Yes

Local file to save a copy of the downloaded outline XML

Essbase REST Member Extractor

Connects to Essbase via the Essbase REST API and walks the member tree recursively, one request per member - the REST equivalent of essbase-java-members.

Property Type Required Default Description

endpoint

String

Yes

Essbase REST API base URL

username

String

Yes

Essbase username

password

String

Yes

Essbase password

application

String

Yes

Essbase application; resolved from the configured endpoint

cube

String

Yes

Essbase cube; resolved from the selected application

PBCS Extractor

Connects to an Oracle EPM Cloud (PBCS/Planning) plan type and reads its dimensions.

Property Type Required Default Description

server

String

Yes

PBCS server hostname only - no protocol, path, or slashes

username

String

Yes

PBCS username

password

String

Yes

PBCS password

application

String

Yes

PBCS application; suggestions are resolved from the configured server

cube

String

Yes

PBCS plan type/cube; suggestions are resolved from the selected application

dimension-list

String

No

Semicolon-delimited dimension names to extract explicitly; when omitted, dimensions are discovered automatically from the plan type

JDBC Extractor

Reads a previously-extracted outline back out of the relational tables the JDBC Writer produces (JDBC Writer) - either an explicit version (the numeric ID a previous write returned), or the latest available version if version is left unset. "Latest" can be scoped to a specific server/application/cube, or left unscoped to mean the most recent write from any source.

Set embedded: true to point at the same on-disk H2 database the JDBC Writer defaults to, with zero further configuration - genuinely "read what you just wrote." For anything else, set jdbcUrl (plus username/password if needed) to point at a real database - see Bringing Your Own JDBC Driver if that database isn’t H2.

Every member property the JDBC Writer captured comes back intact - description, formula, comment, consolidation, member number, and solve order, plus UDAs (reassembled from their own normalized table). Not carried: alias table values and attribute-dimension associations (What doesn’t round-trip yet).

Property Type Required Default Description

jdbcUrl

String

No

JDBC URL for a non-embedded database; ignored when embedded=true

embedded

Boolean

No

false

Read from the on-disk embedded H2 database instead of jdbcUrl

version

Integer

No

Explicit version to read; when omitted, the latest available version is used

username

String

No

Defaults to H2’s own default (sa) when embedded=true

password

String

No

Defaults to H2’s own default (blank) when embedded=true

server

String

No

Scopes "latest" to versions written for this server; leave blank to consider every source

application

String

No

Scopes "latest" to versions written for this application; leave blank to consider every source

cube

String

No

Scopes "latest" to versions written for this cube; leave blank to consider every source