All Classes and Interfaces
Class
Description
Parent class for all objects in this library's object hierarchy.
Serves as a holder for all the various API interfaces.
HTTP Basic on every request, never establishing a session.
An OAuth-style bearer token.
The generative-AI capabilities a server can offer, each independently switchable.
Why a cube's AI features will or won't work, worked out before calling one of them.
A general, unchecked exception that we can be used to wrap the
ApiException checked exceptions that are all
over the generated client code.The server's own machine-readable description of its REST API - what its Swagger UI renders.
An enumeration for the different application states.
An application's configuration, as a small language for reading and changing it.
One application configuration setting - a key from Essbase's catalogue, what it is for, and the
value this application gives it if any.
One configuration key on an application: the catalogue entry describing it, and the value this
application gives it if any.
Represents an Essbase application object.
A substitution variable defined on an application, visible to its cubes unless one of them defines
the same name, and invisible to every other application.
A variable defined on an application.
How a client proves who it is to Essbase.
A batch outline edit document, built action by action.
One action in the document.
Which members a
dataStorageSet applies to.How the server consolidates a member into its parent.
Where a member's data lives.
A
dimUpdate, which carries a properties block rather than a mbrInfo.A dimension's type, in the schema's vocabulary.
Whether a dimension's blocks are dense or sparse.
How a hierarchy under a dimension is aggregated.
An action carrying a
mbrInfo block - add, addOrUpdate, update.What to restructure after the edit.
What a time-balance member skips.
Time balance, for an accounts dimension.
What a batch outline edit did, read out of the log the server sends back.
One labelled line of the log, kept whole alongside the bits worth reading separately.
How the server labels a line:
Info[1370001]:, Warn[1370101]:, Error[1370271]:.A named, reusable pointer to somewhere data lives, plus how to reach it.
The kinds of connection Essbase models.
A global connection on the server.
The generative-AI features a 26.1 server offers over one cube, reached through
EssCube.getAi().The AI capabilities of one cube, spoken to over the
/ai endpoints a 26.1 server adds.Represents an Essbase cube on the server.
Deprecated.
since 2.1.0.
A substitution variable defined on one cube, which shadows an application or server variable of the
same name for queries and calculations against that cube.
A variable defined on one cube, which shadows an application or server variable of the same name
for anything running against that cube.
A live, navigable ad hoc grid on a cube - the REST analog of the Java API's
IEssCubeView.A new value for one data cell.
A coarse classification of a cell as either a data position or a member/label.
Where a dimension sits in the grid: in the POV, on a top/column axis, or on a left/row axis.
A grid's three regions.
Ad hoc display/navigation preferences, mirroring the classic "Essbase Options" dialog to the
extent the REST wire format supports.
How indented member rows/columns are, mirroring the classic ad hoc "Indentation" setting.
A member to place at a specific grid position, replacing whichever member currently occupies
that spot on its row or column axis tier.
A rectangle of cells, given as two corners in either order.
The server's zoom-in behavior when a plain
EssCubeView.zoomIn(int, int) is used (no explicit member set).One column of a data source, as the server describes it.
A data source object on the Essbase server, which seems to be a general abstraction for a tabular data
source, such as a SQL table, MDX result set, CSV file, and others.
The rows a data source returned, with the column names it described them by.
Whether a dimension is dense or sparse.
A special type of member that represents a dimension.
The drill-through report type
Ties one source column of a drill-through report to a cube dimension.
How the cell's members are matched against the column.
Represents a drill-through report on a given cube.
The detail rows behind a drilled cell.
One column of a drill-through result: what it is called and what the server says it holds.
One variable name as a cube actually sees it: the definition that wins, and the ones it hides.
A file or folder in the Essbase server file hierarchy.
Represents a folder in the remote Essbase server pseudo-filesystem.
Special Type of Member that represents a Generation
A group on a server that owns its own security.
Known job types.
Models the status of a job.
Represents a server job, which is any number of different types of actions that have been performed on the
server, such as a dimension build, data load, and others.
Special Type of Member that represents a Level
One line of an Essbase log, read apart into its fields.
ODL severities, in the order Oracle ranks them.
How one ODL log handler rotates - which is the answer to why a log stops where it does.
What the server says about the machine it is running on - the only thing in the REST API that
does.
The MCP server built into Essbase 26.1, reached through
EssServer.getMcp().Talks to the MCP server Essbase 26.1 serves from inside its own REST API.
One argument of an
EssMcpTool, read out of the tool's JSON Schema.What a tool call came back with.
One tool the server's built-in MCP server offers, as it describes itself.
One MDX function the server understands, as the server itself describes it.
A named family of MDX functions - the server's own grouping, not one imposed here.
Reads the server's own MDX function reference.
What the MDX generator made of a question asked in English.
An MDX query's result, with the names of the dimensions on each axis as well as the cells.
The grid of an MDX result, with the dimension names from the result's metadata.
How the server should present an MDX query's result: whether to include the data, and how to
name the members.
How a member's data is held.
Whether a dimension's blocks are dense or sparse.
The role a dimension plays in the outline.
A member in an Essbase cube.
Object types for the Essbase REST API.
Models the outline for a particular cube.
One role granted to one user or group, at the service or at an application.
One dimension as EPM Cloud exports it, read from the
.csv in an artifact snapshot.One member row, with the columns that mean something to an Essbase outline pulled out.
An EPM Cloud artifact snapshot, read as a source for building an Essbase cube.
One dimension's outcome.
What a dimension in the snapshot looks like, without importing anything.
What an import did, dimension by dimension.
How much of one system resource is free, and what the configured ceiling is.
Models a particular scenario in a scenarios-enabled Essbase cube.
A calculation or MDX script on a cube.
Which kind of script this is, which decides both the endpoint's
file parameter and how
the script is run.A calculation or MDX script on a cube.
A cube type, despite the name.
What a server can say about its own generative-AI setup, reached through
EssServer.getAi().The server-level half of the AI diagnosis, made of exactly the rungs that do not need a cube.
Server connection.
Database creation options.
A substitution variable defined on the server, visible to every application and cube on it unless
one of them defines the same name.
A variable defined on the server itself.
Models a session (connection) on the server.
How the server wants large files uploaded.
Models a URL object that can be returned from the URLs endpoint.
A user entry on the server.
Represents one of the downloadable utilities on the Essbase server.
A substitution variable, at whichever of the three scopes it is defined.
Which level a variable is defined at, in cascade order - each shadows the ones before it.
What the three scopes of variable have in common: a name, a value, and the fact that the server
models all three with the same
Variable document.What an application workbook import should actually do.
A dimension that the query left off both axes, so it contributes a single point-of-view
member to every cell.
Username and password until the server hands back a session, then the session from then on.
An already-established session, presented as cookies.