Package com.appliedolap.essbase
package com.appliedolap.essbase
The classes in this package model client API that works with the Essbase REST API. In general, the design of the
library is completely top-down (similar to the traditional Essbase Java API). The starting place for any client program
working with this library is the
EssServerImpl. Once instantiated, usage procedes in a
top-down manner, such as getting the list of applications on the server, getting the list of cubes from that application, getting
the list of dimensions in that cube, and so on.
All objects in the API are created from a parent object, and all objects maintain a reference to their parent. For
example, the EssApplicationImpl object has a method to return a list of cubes in that application,
via EssApplicationImpl.getCubes(), and each cube in the returned list "knows" about its
parent/owning application, accessible via EssCubeImpl.getApplication().
-
ClassDescriptionParent class for all objects in this library's object hierarchy.Serves as a holder for all the various API interfaces.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
ApiExceptionchecked 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.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.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 adataStorageSetapplies to.How the server consolidates a member into its parent.Where a member's data lives.AdimUpdate, which carries apropertiesblock rather than ambrInfo.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 ambrInfoblock - 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.The generative-AI features a 26.1 server offers over one cube, reached throughEssCube.getAi().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 live, navigable ad hoc grid on a cube - the REST analog of the Java API'sIEssCubeView.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 plainEssCubeView.zoomIn(int, int)is used (no explicit member set).One column of a data source, as the server describes it.The rows a data source returned, with the column names it described them by.Whether a dimension is dense or sparse.The drill-through report typeTies one source column of a drill-through report to a cube dimension.How the cell's members are matched against the column.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 group on a server that owns its own security.Known job types.Models the status of a job.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 throughEssServer.getMcp().One argument of anEssMcpTool, 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.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.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.Object types for the Essbase REST API.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.csvin 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.A calculation or MDX script on a cube.Which kind of script this is, which decides both the endpoint'sfileparameter and how the script is run.A cube type, despite the name.What a server can say about its own generative-AI setup, reached throughEssServer.getAi().A substitution variable defined on the server, visible to every application and cube on it unless one of them defines the same name.How the server wants large files uploaded.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 an application workbook import should actually do.