Xplain CLI Reference
Complete reference for all Xplain CLI commands and their parameters.
On this page
Top-level Usage
Usage: xplain [OPTIONS] COMMAND [ARGS]...
Xplain CLI – interact with Xplain analytics sessions.
Options:
--help Show this message and exit.
Commands:
config Config operations.
connect Connect to an Xplain server and optionally load a...
data Data operations.
dimensions Dimensions operations.
explore Explore operations.
init-xplain-session Initialize the current Xplain server session.
models Models operations.
query Query operations.
select Select operations.
startup Load a session from an .xstartup name or local .xview...
temporal Temporal operations.
xplain connect
Establish a connection to an Xplain server.
Usage: xplain connect [OPTIONS]
Connect to an Xplain server and optionally load a dataset.
Connection modes:
1. Profile: xplain connect --profile xoedevtest
2. Credentials: xplain connect --url ... --user ... --password ...
3. Session ID: xplain connect --profile ... --session-id <32-char-id>
To set env vars for the current shell, use:
eval $(xplain connect --profile xoedevtest --env)
Subsequent xplain commands will read XPLAIN_URL + XPLAIN_SESSION_ID
automatically — no files written to disk.
Options:
-p, --profile TEXT Profile name from ~/.xplainpyrc
--url TEXT Server URL (overrides profile)
-u, --user TEXT Username (overrides profile)
--password TEXT Password (overrides profile)
--session-id TEXT Attach to an existing server session by its 32-char ID
-s, --startup TEXT Dataset/startup file to load (e.g. "TestSet1")
--env Print export statements instead of human messages (for
eval)
--help Show this message and exit.
xplain init-xplain-session
Initialize the current Xplain server session.
Usage: xplain init-xplain-session [OPTIONS]
Initialize the current Xplain server session.
Options:
--session TEXT Session ID or name
--output [json|csv|table] Output format
--help Show this message and exit.
xplain startup
Load a saved .xstartup configuration or a local .xview JSON file into
the active session.
Usage: xplain startup [OPTIONS] FILE
Load a session from an .xstartup name or local .xview file.
Options:
--session TEXT Session ID or name
--output [json|csv|table] Output format
--help Show this message and exit.
Examples:
xplain startup TestSet1.xstartup
xplain startup TestSet1
xplain startup ./views/sales_view.xview --output json
xplain explore
Browse and inspect the object hierarchy — objects, dimensions, attributes, and state trees.
16 commands:
xplain explore build-tree-data — Convert complex JSON structure into a format suitable for D3.js tree
xplain explore collapsible-tree — Generate and visualize a collapsible tree using hierarchical data.
xplain explore get-attribute-info — find and retrieves the details of an attribute.
xplain explore get-children — Get children states of a given state
xplain explore get-dimension-info — find and retrieves the details of a dimension.
xplain explore get-full-object-structure — Returns a nested dict of all objects, their dimensions, and attributes,.
xplain explore get-object-info — find and display the details of a xobject in json.
xplain explore get-path-for-states — Get the hierarchy path for specified states in an attribute
xplain explore get-root-object — [Beta] Retrieve the root object.
xplain explore get-state-hierarchy — Get a (partial) state hierarchy for an attribute
xplain explore get-states-list-for-level — Get all states at a specific hierarchy level
xplain explore get-tree-containing-string — Get the subtree of states containing a search string
xplain explore get-tree-details — get the metadata details of certain xplain object, dimension or.
xplain explore get-xobject — [Beta] Retrieve the object with the given name.
xplain explore show-tree — show object tree.
xplain explore show-tree-details — Display the details of the object tree.
xplain explore build-tree-data
Usage: xplain explore build-tree-data [OPTIONS]
Convert complex JSON structure into a format suitable for D3.js tree
visualization.
Options:
--session TEXT Session ID or name
--json-object TEXT [required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain explore collapsible-tree
Usage: xplain explore collapsible-tree [OPTIONS]
Generate and visualize a collapsible tree using hierarchical data.
Options:
--session TEXT Session ID or name
--output [json|csv|table] Output format
--help Show this message and exit.
xplain explore get-attribute-info
Usage: xplain explore get-attribute-info [OPTIONS]
find and retrieves the details of an attribute.
Options:
--session TEXT Session ID or name
--object-name TEXT [required]
--dimension-name TEXT [required]
--attribute-name TEXT [required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain explore get-children
Usage: xplain explore get-children [OPTIONS]
Get children states of a given state
Returns the direct children states of the specified state. Can be called for
a single state or a list of states.
Options:
--session TEXT Session ID or name
--object TEXT Object name (when querying a single state).
--dimension TEXT Dimension name (when querying a single state).
--attribute TEXT Attribute name (when querying a single state).
--state TEXT State name whose children to retrieve. If
omitted, the root state's children are returned.
--list TEXT List of {object, dimension, attribute, state}
combinations for batch child retrieval.
:ref:`schema-XElementPath` (JSON array)
--output [json|csv|table] Output format
--help Show this message and exit.
xplain explore get-dimension-info
Usage: xplain explore get-dimension-info [OPTIONS]
find and retrieves the details of a dimension.
Options:
--session TEXT Session ID or name
--object-name TEXT [required]
--dimension-name TEXT [required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain explore get-full-object-structure
Usage: xplain explore get-full-object-structure [OPTIONS]
Returns a nested dict of all objects, their dimensions, and attributes,.
Options:
--session TEXT Session ID or name
--output [json|csv|table] Output format
--help Show this message and exit.
xplain explore get-object-info
Usage: xplain explore get-object-info [OPTIONS]
find and display the details of a xobject in json.
Options:
--session TEXT Session ID or name
--object-name TEXT [required]
--root TEXT
--output [json|csv|table] Output format
--help Show this message and exit.
xplain explore get-path-for-states
Usage: xplain explore get-path-for-states [OPTIONS]
Get the hierarchy path for specified states in an attribute
Retrieves the path (ancestor chain) for each of the specified states in the
attribute hierarchy. **Note:** State names are treated case-insensitively by
this method.
Options:
--session TEXT Session ID or name
--object TEXT See API documentation. [required]
--dimension TEXT See API documentation. [required]
--attribute TEXT See API documentation. [required]
--states TEXT The state names to find paths for. (JSON array)
[required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain explore get-root-object
Usage: xplain explore get-root-object [OPTIONS]
[Beta] Retrieve the root object.
Options:
--session TEXT Session ID or name
--output [json|csv|table] Output format
--help Show this message and exit.
xplain explore get-state-hierarchy
Usage: xplain explore get-state-hierarchy [OPTIONS]
Get a (partial) state hierarchy for an attribute
Returns the hierarchical structure of states for an attribute, starting from
the given state (or root if not specified) and going down the specified
number of levels.
Options:
--session TEXT Session ID or name
--object TEXT The name of the object. [required]
--dimension TEXT The name of the dimension. [required]
--attribute TEXT The name of the attribute. [required]
--state TEXT The name of a state in the attribute's hierarchy.
If state is not specified, the root state of the
attribute will be taken as default.
--levels INTEGER The levels of hierarchy to be returned. If levels
is not specified, the maximum levels of the
hierarchy will be considered.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain explore get-states-list-for-level
Usage: xplain explore get-states-list-for-level [OPTIONS]
Get all states at a specific hierarchy level
Returns a flat list of all states at the specified level of the hierarchy
for the given attribute.
Options:
--session TEXT Session ID or name
--object TEXT The object name. [required]
--dimension TEXT The dimension name. [required]
--attribute TEXT The attribute name. [required]
--level-name TEXT The level name in the attribute's state
hierarchy. Exactly one of `levelName` or
`levelNumber` must be provided.
--level-number INTEGER The level number in the attribute's state
hierarchy. Exactly one of `levelName` or
`levelNumber` must be provided.
--sort / --no-sort A flag signaling whether the states should be
sorted.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain explore get-tree-containing-string
Usage: xplain explore get-tree-containing-string [OPTIONS]
Get the subtree of states containing a search string
Searches the state hierarchy of an attribute for states whose names contain
the given string, and returns the minimal subtree containing all matching
states.
Options:
--session TEXT Session ID or name
--object TEXT See API documentation. [required]
--dimension TEXT See API documentation. [required]
--attribute TEXT See API documentation. [required]
--string TEXT The search string to match in state names.
[required]
--case-sensitive / --no-case-sensitive
Whether to perform a case-sensitive search.
--subtree-leaf-flags / --no-subtree-leaf-flags
If true, leaf flags reflect whether a state
is a leaf in the search-induced subtree. If
false, leaf flags reflect the complete state
tree.
--search-display-names / --no-search-display-names
If true, the search is also applied to
display names of states in addition to their
regular names.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain explore get-tree-details
Usage: xplain explore get-tree-details [OPTIONS]
get the metadata details of certain xplain object, dimension or.
Options:
--session TEXT Session ID or name
--object-name TEXT
--dimension-name TEXT
--attribute-name TEXT
--output [json|csv|table] Output format
--help Show this message and exit.
xplain explore get-xobject
Usage: xplain explore get-xobject [OPTIONS]
[Beta] Retrieve the object with the given name.
Options:
--session TEXT Session ID or name
--object-name TEXT [required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain explore show-tree
Usage: xplain explore show-tree [OPTIONS]
show object tree.
Options:
--session TEXT Session ID or name
--output [json|csv|table] Output format
--help Show this message and exit.
xplain explore show-tree-details
Usage: xplain explore show-tree-details [OPTIONS]
Display the details of the object tree.
Options:
--session TEXT Session ID or name
--output [json|csv|table] Output format
--help Show this message and exit.
xplain query
Execute queries, manage requests, retrieve and export results.
26 commands:
xplain query add-aggregation — Add an aggregation to an existing request
xplain query add-group-by — Add a group-by to a request
xplain query collapse — Collapse a state in an open query (drill up)
xplain query compute-all-open-requests — Recompute all open (dynamic) requests
xplain query compute-request — (Re-)compute a request
xplain query convert-to-dataframe — Convert query result JSON to pandas DataFrame format.
xplain query count-attribute — Convenient method to count an attribute. Automatically resolves object and
xplain query create-request — Create a request without computing it yet
xplain query delete-all-open-requests — Delete all open (dynamic) requests
xplain query delete-all-requests — Delete all requests from the session
xplain query delete-request — Delete a named request from the session
xplain query execute-and-export-request — Execute a request and immediately export the results to a file
xplain query execute-query — Execute an analytical query and return results.
xplain query execute-request — Execute a statistics request and return results immediately
xplain query expand — Expand a state in an open query (drill down)
xplain query expand-to-level — Expand an open query to a specific hierarchy level
xplain query get-instance-as-dataframe — get a pandas dataframe representation of the xplain artifacts.
xplain query modify-aggregation — Replace an aggregation in an existing request at a given position
xplain query omit-null-value-results — Toggle omission of null/zero-value results for open requests
xplain query open-attribute — Open an attribute as a dynamic group-by (convenience wrapper for
xplain query open-query — [Deprecated] Alias for openRequest
xplain query open-request — Open a dynamic request that auto-recomputes on selection changes
xplain query pause-request — Pause a request (stop automatic recomputation)
xplain query remove-aggregation — Remove an aggregation from a request by position
xplain query remove-group-by — Remove a group-by from a request
xplain query unpause-request — Resume a paused request
xplain query add-aggregation
Usage: xplain query add-aggregation [OPTIONS]
Add an aggregation to an existing request
Add an aggregation (measure) to an already existing request. Supports all
aggregation types: COUNT, SUM, AVG, MIN, MAX, VAR, VARP, STDEV, STDEVP,
COUNTENTITY, COUNTDISTINCT, FIRSTKEY, QUANTILE, and COMPUTED_MEASURE. After
adding aggregations, call `computeRequest` to recompute the results.
Options:
--session TEXT Session ID or name
--request-name TEXT The name/ID of the request to which the
aggregation should be added. [required]
--aggregation TEXT The aggregation to add. :ref:`schema-
AggregationUIModel` (JSON dict) [required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain query add-group-by
Usage: xplain query add-group-by [OPTIONS]
Add a group-by to a request
Add a group-by (grouping dimension) to an existing request. The group-by
defines how data is sliced/segmented in the results. After adding a group-
by, call `computeRequest` to recompute the results.
Options:
--session TEXT Session ID or name
--request-name TEXT The name/ID of the request. [required]
--group-by TEXT The group-by definition to add. :ref:`schema-
GroupByUIModel` (JSON dict) [required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain query collapse
Usage: xplain query collapse [OPTIONS]
Collapse a state in an open query (drill up)
Recursively remove all children states of the specified state from the first
group-by of the open request. The reverse of `expand`. Collapsing a state
removes sub-state results, saving resources (they are no longer computed or
transmitted).
Options:
--session TEXT Session ID or name
--request-name TEXT The name/ID of the open request. [required]
--state-name TEXT The name of the state to collapse (its children
will be removed). [required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain query compute-all-open-requests
Usage: xplain query compute-all-open-requests [OPTIONS]
Recompute all open (dynamic) requests
Trigger recomputation of all requests that were opened with `openRequest`.
Useful after bulk changes to force immediate refresh.
Options:
--session TEXT Session ID or name
--output [json|csv|table] Output format
--help Show this message and exit.
xplain query compute-request
Usage: xplain query compute-request [OPTIONS]
(Re-)compute a request
(Re-)compute the results for a given request. Use this after modifying a
request (e.g. adding aggregations, group-bys, or selections) to recalculate
the results.
Options:
--session TEXT Session ID or name
--request-name TEXT The name/ID of the request to compute.
[required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain query convert-to-dataframe
Usage: xplain query convert-to-dataframe [OPTIONS]
Convert query result JSON to pandas DataFrame format.
Options:
--session TEXT Session ID or name
--data TEXT [required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain query count-attribute
Usage: xplain query count-attribute [OPTIONS]
Convenient method to count an attribute. Automatically resolves object and
dimension.
Options:
--session TEXT Session ID or name
--attribute-name TEXT [required]
--object-name TEXT
--dimension-name TEXT
--request-name TEXT
--data-frame TEXT
--output [json|csv|table] Output format
--help Show this message and exit.
xplain query create-request
Usage: xplain query create-request [OPTIONS]
Create a request without computing it yet
Create a request without immediately computing the results. Once created,
additional aggregations, selections, or group-bys can be added via
`addAggregation`, `addGroupBy`, etc. Then call `computeRequest` to compute.
Two forms are accepted: - With `request` object: creates from a full
StatisticsRequestUIModel. - With `requestName` only: creates an empty named
request.
Options:
--session TEXT Session ID or name
--request TEXT Full request definition (optional; use
requestName for empty request).
:ref:`schema-StatisticsRequestUIModel` (JSON
dict)
--request-name TEXT Name/ID for a new empty request (if request
object is not given).
--delete-if-exists / --no-delete-if-exists
Delete a prior existing request with the
same ID if present.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain query delete-all-open-requests
Usage: xplain query delete-all-open-requests [OPTIONS]
Delete all open (dynamic) requests
Delete all requests that were opened with `openRequest`/`openQuery`. Static
requests created via `executeRequest` are not affected.
Options:
--session TEXT Session ID or name
--output [json|csv|table] Output format
--help Show this message and exit.
xplain query delete-all-requests
Usage: xplain query delete-all-requests [OPTIONS]
Delete all requests from the session
Remove all requests (both static and open/dynamic) from the current session.
After this call, no requests or results will be present in the session. See
also `deleteRequest`.
Options:
--session TEXT Session ID or name
--output [json|csv|table] Output format
--help Show this message and exit.
xplain query delete-request
Usage: xplain query delete-request [OPTIONS]
Delete a named request from the session
Permanently remove a request from the session. The request will no longer
appear in the session state and its results are discarded. See also
`deleteAllRequests`.
Options:
--session TEXT Session ID or name
--request-name TEXT The name/ID of the request to delete. [required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain query execute-and-export-request
Usage: xplain query execute-and-export-request [OPTIONS]
Execute a request and immediately export the results to a file
Execute a statistics request and write the results directly to an export
file, without storing them in the session. This is a combined compute+export
operation useful for large result sets that need not be held in memory. The
alias `executeAndExportQuery` is also accepted.
Options:
--session TEXT Session ID or name
--result-xls TEXT The name of the result (Excel) file.
[required]
--request TEXT The statistics request in JSON object
format. One of `request` or `requests` must
be provided. :ref:`schema-
StatisticsRequestUIModel` (JSON dict)
--requests TEXT An array of statistics requests in JSON
object format. One of `request` or
`requests` must be provided. :ref:`schema-
StatisticsRequestUIModel` (JSON array)
--template-xls TEXT The filename of an Excel template.
--sheet-name TEXT Optional sheet name for the result when a
single request is given.
--column-headers TEXT The array of column names overwrites the
default column headers in the result Excel
file. (JSON dict)
--use-display-names / --no-use-display-names
Signals whether the display names of the
states shall be used in the Excel file
instead of the technical state names.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain query execute-query
Usage: xplain query execute-query [OPTIONS]
Execute an analytical query and return results.
Options:
--session TEXT Session ID or name
--query TEXT [required]
--data-frame TEXT
--output [json|csv|table] Output format
--help Show this message and exit.
xplain query execute-request
Usage: xplain query execute-request [OPTIONS]
Execute a statistics request and return results immediately
Execute the specified statistics request and immediately return the results
in the session JSON document. The results of this request are "static" — the
request will not be automatically recomputed when global selections change.
To get dynamic results that respond to global selection changes, use
`openRequest` instead. The alias `executeQuery` is also accepted (deprecated
name).
Options:
--session TEXT Session ID or name
--request TEXT The statistics request to execute.
:ref:`schema-StatisticsRequestUIModel` (JSON
dict) [required]
--delete-if-exists / --no-delete-if-exists
If true, a prior existing request with the
same ID is deleted first.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain query expand
Usage: xplain query expand [OPTIONS]
Expand a state in an open query (drill down)
Add the children states of the specified state into the first group-by of
the given open request. All states in the group-by must form a hierarchy.
This operation drills into one of the hierarchy nodes, adding sub-states and
computing additional results. Example: For an age hierarchy (0-9, 10-19,
20-40, >40), calling expand with stateName="10-19" will add states 10-13,
14-17, and 18-19 to the group-by.
Options:
--session TEXT Session ID or name
--request-name TEXT The name/ID of the open request containing the
state to expand. [required]
--state-name TEXT The name of the state to expand (its children
will be added). [required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain query expand-to-level
Usage: xplain query expand-to-level [OPTIONS]
Expand an open query to a specific hierarchy level
Add all states up to the specified hierarchy level into the group-by of the
given open request. Useful for expanding a calendar hierarchy to e.g. the
month level to show results for all years, quarters, and months at once.
Options:
--session TEXT Session ID or name
--request-name TEXT The name/ID of the open request. [required]
--level-name TEXT The name of the hierarchy level to expand to.
[required]
--max-states INTEGER Optional limit: only expand if the level has
fewer than this many states. Prevents
accidentally expanding huge hierarchies.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain query get-instance-as-dataframe
Usage: xplain query get-instance-as-dataframe [OPTIONS]
get a pandas dataframe representation of the xplain artifacts.
Options:
--session TEXT Session ID or name
--elements TEXT [required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain query modify-aggregation
Usage: xplain query modify-aggregation [OPTIONS]
Replace an aggregation in an existing request at a given position
Replace the aggregation at the given position in an existing request. The
position is 0-based (0 = first aggregation).
Options:
--session TEXT Session ID or name
--request-name TEXT The name/ID of the request. [required]
--aggregation TEXT The new aggregation to put at the given position.
:ref:`schema-AggregationUIModel` (JSON dict)
[required]
--position INTEGER The 0-based index of the aggregation to replace.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain query omit-null-value-results
Usage: xplain query omit-null-value-results [OPTIONS]
Toggle omission of null/zero-value results for open requests
Control whether result rows where all aggregation values are null or zero
are omitted from the response. When enabled, rows with no meaningful data
are excluded, reducing the size of the result set. If `requestName` is not
given, the setting is applied to all currently open requests. Whenever a new
query is initiated, the default is `omit = false`.
Options:
--session TEXT Session ID or name
--omit / --no-omit Whether to omit null/zero results. Defaults to
true if not given.
--request-name TEXT The specific request to configure. If not given,
applies to all open requests.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain query open-attribute
Usage: xplain query open-attribute [OPTIONS]
Open an attribute as a dynamic group-by (convenience wrapper for
openRequest)
Convenience method equivalent to `openRequest` where the group-by comprises
the first-level states and the root state of the specified attribute. Any
changes to the global selections will automatically trigger recomputation.
Options:
--session TEXT Session ID or name
--request-name TEXT The name/ID of the resulting open query.
[required]
--object TEXT The object name. [required]
--dimension TEXT The dimension name. [required]
--attribute TEXT The attribute name. [required]
--selection-set TEXT The selection set the resulting query should
refer to. If omitted, the standard global
selections are used.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain query open-query
Usage: xplain query open-query [OPTIONS]
[Deprecated] Alias for openRequest
Deprecated synonym for `openRequest`. Use `openRequest` instead.
Options:
--session TEXT Session ID or name
--request TEXT :ref:`schema-StatisticsRequestUIModel` (JSON
dict) [required]
--delete-if-exists / --no-delete-if-exists
See API documentation.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain query open-request
Usage: xplain query open-request [OPTIONS]
Open a dynamic request that auto-recomputes on selection changes
Open a statistics request that automatically recomputes whenever global
selections change. Unlike `executeRequest`, the results are dynamic and
reflect the current selections at all times. Selections explicitly given in
the request body are kept constant; all other selections are pulled from the
global selections and updated automatically. This is the basis for
interactive analytics in the Xplain ObjectExplorer. The alias `openQuery` is
also accepted.
Options:
--session TEXT Session ID or name
--request TEXT The statistics request to open.
:ref:`schema-StatisticsRequestUIModel` (JSON
dict) [required]
--delete-if-exists / --no-delete-if-exists
If true, a prior existing request with the
same name is deleted first.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain query pause-request
Usage: xplain query pause-request [OPTIONS]
Pause a request (stop automatic recomputation)
Pause the given request so that it is no longer automatically recomputed
when global selections change. Paused requests retain their last results.
The alias `pauseQuery` is also accepted.
Options:
--session TEXT Session ID or name
--request-name TEXT The name / ID of the query which should be
paused. [required]
--keep-last-results / --no-keep-last-results
If set to true the most recent results
before pausing are kept.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain query remove-aggregation
Usage: xplain query remove-aggregation [OPTIONS]
Remove an aggregation from a request by position
Remove the aggregation at the given position from a request. Positions are
0-based (0 = first aggregation, 1 = second aggregation, etc.).
Options:
--session TEXT Session ID or name
--request-name TEXT The name/ID of the request. [required]
--position INTEGER The 0-based index of the aggregation to remove.
[required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain query remove-group-by
Usage: xplain query remove-group-by [OPTIONS]
Remove a group-by from a request
Remove the group-by associated with the given attribute from a request.
Options:
--session TEXT Session ID or name
--request-name TEXT The name/ID of the request. [required]
--attribute TEXT The attribute path identifying which group-by to
remove. :ref:`schema-XElementPath` (JSON dict)
[required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain query unpause-request
Usage: xplain query unpause-request [OPTIONS]
Resume a paused request
Resume a previously paused request, causing it to be recomputed with the
current global selections. The alias `unpauseQuery` is also accepted.
Options:
--session TEXT Session ID or name
--request-name TEXT The name/ID of the request to unpause.
[required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain select
Apply and manage selections (filters), references, and selection sets.
26 commands:
xplain select add-selection-set — Add a new named selection set to the session
xplain select build-attribute-from-selection — Build a new attribute from the current selection
xplain select clear-all-selection-sets — Clear all selections for all selection sets
xplain select clear-all-selections — Clear all selections from a selection set
xplain select clear-selections — Clear selections for specific attributes
xplain select download-selections — returns the selection as json for given objects and selection set.
xplain select export-selections — Export selections to a file
xplain select get-selected-leafs — Get selected leaf states for an attribute
xplain select get-selections — Get current selections as JSON (without saving to file)
xplain select go-back-in-selections — Navigate backward in the selection history
xplain select go-forward-in-selections — Navigate forward in the selection history
xplain select import-selections — Load selections from a file
xplain select multiselect — [Deprecated] Apply multiple selections — use select with selections array
xplain select put-selection — Put (overwrite) a selection into a request
xplain select remove-reference — Remove a named reference.
xplain select remove-selection-set — Remove a named selection set from the session
xplain select select — Apply selections (filters) to the session
xplain select select-between — Select states in a range (between two values)
xplain select select-entities — Select entities (root objects) matching a selection
xplain select select-entities-in-field — Select entities corresponding to a result field in an open query
xplain select set-global-selections-as-reference — Set the current global selections as a named reference
xplain select set-propagate-selections-upward — Enable or disable upward selection propagation for objects
xplain select set-reference — Set selections as a named reference for comparison.
xplain select set-selection-set-for-query — Associate a selection set with an open query
xplain select Enable
xplain select Set
xplain select add-selection-set
Usage: xplain select add-selection-set [OPTIONS]
Add a new named selection set to the session
Create a new named selection set that can be used as an independent
selection context for open requests.
Options:
--session TEXT Session ID or name
--name TEXT The name (ID) of the set which is to be added.
[required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain select build-attribute-from-selection
Usage: xplain select build-attribute-from-selection [OPTIONS]
Build a new attribute from the current selection
Create a new attribute whose states are derived from the current global
selections. This allows saving a selection pattern as a reusable attribute
hierarchy.
Options:
--session TEXT Session ID or name
--attribute TEXT The name for the new attribute (plain name string
when combined with `object` and `dimension`, or a
shorthand path when `object` is omitted).
[required]
--new-attribute-name TEXT The name for the new attribute to be created.
--object TEXT The object for which to build the attribute. When
provided, `dimension` and `attribute` must also
be given as plain name strings.
--dimension TEXT The dimension in which to add the new attribute.
Required when `object` is provided.
--selection-set TEXT The selection set to derive states from. Defaults
to `"globalSelections"` if not given.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain select clear-all-selection-sets
Usage: xplain select clear-all-selection-sets [OPTIONS]
Clear all selections for all selection sets
Clear all selections in all selection sets. All open requests are recomputed
with no filters applied across all selection contexts.
Options:
--session TEXT Session ID or name
--output [json|csv|table] Output format
--help Show this message and exit.
xplain select clear-all-selections
Usage: xplain select clear-all-selections [OPTIONS]
Clear all selections from a selection set
Clear all selections from the specified selection set (or globalSelections
if not specified). All open requests referencing the selection set are
recomputed with no filters applied. To clear all selection sets, use
`clearAllSelectionSets`.
Options:
--session TEXT Session ID or name
--selection-set TEXT The name of the selection set to clear. Defaults
to "globalSelections" if not given.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain select clear-selections
Usage: xplain select clear-selections [OPTIONS]
Clear selections for specific attributes
Remove selections for one or more specific attributes from the selection
set. Open requests that reference the selection set are automatically
recomputed.
Options:
--session TEXT Session ID or name
--object TEXT The object for which selections are to be
cleared.
--dimension TEXT The dimension for which selections are to be
cleared.
--attribute TEXT The attribute for which selections are to be
cleared.
--attributes TEXT An explicit list of attributes in terms of their
path. :ref:`schema-AttributePath` (JSON array)
--retain-attributes TEXT An explicit list of attribute paths whose
selections should be retained (all others
cleared). :ref:`schema-AttributePath` (JSON
array)
--selection-set TEXT The selection set for which to clear selections -
if not given "globalSelections" is cleared.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain select download-selections
Usage: xplain select download-selections [OPTIONS]
returns the selection as json for given objects and selection set.
Options:
--session TEXT Session ID or name
--objects TEXT [required]
--selection-set TEXT
--output [json|csv|table] Output format
--help Show this message and exit.
xplain select export-selections
Usage: xplain select export-selections [OPTIONS]
Export selections to a file
Export selections (save to a file) for the global selections or a specified
selection set. Floating semantics are fixed before export. See also
`importSelections` and `getSelections`.
Options:
--session TEXT Session ID or name
--file TEXT The destination file for the exported selections.
:ref:`schema-FileDescriptor` (JSON dict)
[required]
--objects TEXT Optional list of object names to export
selections for. If omitted, selections for all
objects are exported. (JSON array)
--selection-set TEXT The selection set to export.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain select get-selected-leafs
Usage: xplain select get-selected-leafs [OPTIONS]
Get selected leaf states for an attribute
For the current selections (or a given selection set), retrieve the leaf
states of the specified attribute that are currently selected. The
selections must be "simple" (no complex logic or negations).
Options:
--session TEXT Session ID or name
--attribute TEXT The attribute path to retrieve selected leaf
states for. :ref:`schema-AttributePath` (JSON
dict) [required]
--selection-set TEXT The selection set to use.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain select get-selections
Usage: xplain select get-selections [OPTIONS]
Get current selections as JSON (without saving to file)
Return current selections as a JSON document. Unlike `exportSelections`,
this does not write to a file. See also `exportSelections` and
`importSelections`.
Options:
--session TEXT Session ID or name
--objects TEXT Optional list of object names to retrieve
selections for. If omitted, selections for all
objects are returned. (JSON array)
--selection-set TEXT The selection set to retrieve.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain select go-back-in-selections
Usage: xplain select go-back-in-selections [OPTIONS]
Navigate backward in the selection history
Undo the last selection change, navigating to the previous selection state.
Options:
--session TEXT Session ID or name
--steps INTEGER Number of steps to go back in selections history.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain select go-forward-in-selections
Usage: xplain select go-forward-in-selections [OPTIONS]
Navigate forward in the selection history
Redo a previously undone selection change.
Options:
--session TEXT Session ID or name
--steps INTEGER Number of steps to go forward in selections
history.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain select import-selections
Usage: xplain select import-selections [OPTIONS]
Load selections from a file
Load selections from a file on the server and apply them to the specified
selection set (defaults to globalSelections). See also `exportSelections`
and `getSelections`.
Options:
--session TEXT Session ID or name
--file TEXT The selection file to load. :ref:`schema-
FileDescriptor` (JSON dict) [required]
--selection-set TEXT The selection set to import into.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain select multiselect
Usage: xplain select multiselect [OPTIONS]
[Deprecated] Apply multiple selections — use select with selections array
instead
**Deprecated.** Use `select` with the `selections` array parameter instead.
Apply multiple selections simultaneously.
Options:
--session TEXT Session ID or name
--selections TEXT :ref:`schema-SelectionUIModel` (JSON array)
[required]
--selection-set TEXT Target selection set name.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain select put-selection
Usage: xplain select put-selection [OPTIONS]
Put (overwrite) a selection into a request
Put a selection directly into an existing request. If a selection on the
same attribute already exists in the request, it is replaced (overwritten).
Options:
--session TEXT Session ID or name
--request-name TEXT The name/ID of the request. [required]
--selection TEXT The selection to put into the request.
:ref:`schema-SelectionUIModel` (JSON dict)
[required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain select remove-reference
Usage: xplain select remove-reference [OPTIONS]
Remove a named reference.
Options:
--session TEXT Session ID or name
--reference-name TEXT [required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain select remove-selection-set
Usage: xplain select remove-selection-set [OPTIONS]
Remove a named selection set from the session
Delete a previously added named selection set and all its selections.
Options:
--session TEXT Session ID or name
--name TEXT The name (ID) of the set which is to be removed.
[required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain select select
Usage: xplain select select [OPTIONS]
Apply selections (filters) to the session
Apply one or more selections to the current global selection set (or a
specified selection set). All open requests that reference the given
selection set are automatically recomputed. Selections define which states
(values) of an attribute are included in analysis. For example, selecting
Region = "Berlin" filters the data to Berlin only.
Options:
--session TEXT Session ID or name
--selection TEXT A single selection to apply. :ref:`schema-
SelectionUIModel` (JSON dict)
--selections TEXT Multiple selections to apply at once.
:ref:`schema-SelectionUIModel` (JSON array)
--selection-set TEXT The name of the selection set to apply to.
Defaults to "globalSelections" if omitted.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain select select-between
Usage: xplain select select-between [OPTIONS]
Select states in a range (between two values)
Select all states of an attribute that fall between two specified boundary
states. Useful for range-based filtering on ordered attributes (e.g. dates,
numeric ranges).
Options:
--session TEXT Session ID or name
--object TEXT The Object where the dimension and attribute is
to be found.
--dimension TEXT The dimension of the attribute.
--attribute TEXT The attribute, either as string in combination
with the `dimension` and `object` parameter or an
XElementPath pointing to the attribute.
--from- FLOAT Lower value
--to FLOAT Upper value
--low-value FLOAT Lower value - just an alias for the `from`
parameter
--high-value FLOAT Upper value - just an alias for the `to`
parameter
--output [json|csv|table] Output format
--help Show this message and exit.
xplain select select-entities
Usage: xplain select select-entities [OPTIONS]
Select entities (root objects) matching a selection
Select all root-object entities (e.g. patients) that match the given
selection criteria. The resulting selection propagates upward in the object
hierarchy.
Options:
--session TEXT Session ID or name
--object TEXT The object whose entities to select. [required]
--selection TEXT The selection criteria to match. :ref:`schema-
SelectionUIModel` (JSON dict) [required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain select select-entities-in-field
Usage: xplain select select-entities-in-field [OPTIONS]
Select entities corresponding to a result field in an open query
Select entities corresponding to a specific result row (field) in an open
query. Used for cross-filtering when a user clicks on a result cell.
Options:
--session TEXT Session ID or name
--request-name TEXT The name/ID of the open request. [required]
--field TEXT The field name in the result set. [required]
--selection TEXT The selection corresponding to the clicked result
line. :ref:`schema-SelectionUIModel` (JSON dict)
[required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain select set-global-selections-as-reference
Usage: xplain select set-global-selections-as-reference [OPTIONS]
Set the current global selections as a named reference
Save the current global selections as a reference selection set under the
given name. Reference selections can be used for comparison in queries.
Options:
--session TEXT Session ID or name
--reference-name TEXT A unique name for the reference. [required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain select set-propagate-selections-upward
Usage: xplain select set-propagate-selections-upward [OPTIONS]
Enable or disable upward selection propagation for objects
Set the upward propagation schema, i.e. from which objects selections
propagate upward the object tree. For an explanation of how selections
propagate in a complex object model, see the description of the Object
Analytics propagation schema. When upward propagation is enabled for an
object, selections made on that object's attributes are automatically
propagated to its parent objects in the hierarchy.
Options:
--session TEXT Session ID or name
--propagate-selections-upward / --no-propagate-selections-upward
Boolean flag setting upward propagation to
on or off.
--objects TEXT List of object names for which to set the
upward propagation flag. If omitted, the
flag is set for all objects in the session.
(JSON array)
--selection-set TEXT The name of the selection set for which
upward propagation is to be set. If omitted,
defaults to "globalSelections".
--output [json|csv|table] Output format
--help Show this message and exit.
xplain select set-reference
Usage: xplain select set-reference [OPTIONS]
Set selections as a named reference for comparison.
Options:
--session TEXT Session ID or name
--reference-name TEXT [required]
--reference-selections TEXT
--output [json|csv|table] Output format
--help Show this message and exit.
xplain select set-selection-set-for-query
Usage: xplain select set-selection-set-for-query [OPTIONS]
Associate a selection set with an open query
Change the selection set that an open query uses for its dynamic selections.
The alias `setSelectionsForQuery` is also accepted.
Options:
--session TEXT Session ID or name
--request-name TEXT The name (=ID) of the query [required]
--selection-set TEXT The name (=ID) of the selection set (alias
externalSelections)
--external-selections TEXT The name (=ID) of the selection set (alias
selectionSet)
--selections TEXT A set for selections which will be applied as
fixed selections to the query :ref:`schema-
SelectionUIModel` (JSON array)
--output [json|csv|table] Output format
--help Show this message and exit.
xplain dimensions
Add, remove, rename, and manage calculated dimensions and attributes (30+ types).
41 commands:
xplain dimensions add-aggregation-dimension — Add a dimension derived from an aggregation on a sub-object
xplain dimensions add-all-tags — Remove all tags from an element
xplain dimensions add-attribute — Add an attribute to a dimension.
xplain dimensions add-boolean-logic-dimension — Add a boolean-logic dimension combining two boolean dimensions
xplain dimensions add-conditional-factor-dimension — Add a conditional factor dimension
xplain dimensions add-constant-categorial-dimension — [OPTIONS]
xplain dimensions add-date-time-element-dimension — Add a computed dimension extracting a date/time element
xplain dimensions add-day-of-week-dimension — [Deprecated] Add day-of-week dimension — use addDateTimeElementDimension
xplain dimensions add-disaggregation-dimension — Add a disaggregation dimension
xplain dimensions add-elapsed-time-attribute — Add an elapsed-time attribute to a duration dimension
xplain dimensions add-flag-extraction-dimension — Add a flag-extraction dimension
xplain dimensions add-hour-of-day-dimension — [Deprecated] Add hour-of-day dimension — use addDateTimeElementDimension
xplain dimensions add-interval-flag-dimension — Add an interval flag dimension
xplain dimensions add-linear-sum-dimension — Add a linear sum computed dimension
xplain dimensions add-max-number-dimension — Add a maximum computed dimension
xplain dimensions add-min-number-dimension — Add a minimum computed dimension
xplain dimensions add-normalized-response-dimension — [OPTIONS]
xplain dimensions add-number-ranges-attribute — Add a numeric ranges attribute (binning) to a dimension
xplain dimensions add-numeric-dimensions — Add multiple standard numeric attributes to a numeric dimension
xplain dimensions add-point-in-time-attribute — Add a point-in-time attribute (time granularity binning) to a time dimension
xplain dimensions add-product-dimension — Add a product computed dimension
xplain dimensions add-quantile-based-attributes — Generate quantile-based attributes for FLOAT/DOUBLE dimensions.
xplain dimensions add-quotient-dimension — Add a quotient computed dimension
xplain dimensions add-ratio-dimension — Add a ratio dimension (quotient of counts)
xplain dimensions add-sample-dimension — Add a sample dimension (stratified random sample flag)
xplain dimensions add-shift-number-dimension — Add a shift-number dimension (classifies timestamps into work shifts)
xplain dimensions add-tag — Add a tag to an element (object, dimension, or attribute)
xplain dimensions add-threshold-dimension — Add a threshold dimension (boolean flag based on threshold comparison)
xplain dimensions add-time-difference-dimension — Add a time-difference computed dimension
xplain dimensions add-time-duration-attribute — Add a time duration attribute to a dimension
xplain dimensions add-time-in-shift-dimension — Add a time-in-shift dimension (elapsed time within a shift)
xplain dimensions remove-attribute — Remove an attribute.
xplain dimensions remove-attribute-if-exists — Remove an attribute if it exists (no error if missing)
xplain dimensions remove-attributes-with-tag — Remove all attributes with a given tag
xplain dimensions remove-dimension — Remove a dimension from an object
xplain dimensions remove-dimension-if-exists — Remove a dimension if it exists (no error if missing)
xplain dimensions remove-tag — Remove a tag from an element
xplain dimensions rename-dimension — Rename a session-generated dimension
xplain dimensions reorganize-attribute — Reorganize (reindex) an attribute
xplain dimensions replicate-dimension — Replicate a dimension with a new name
xplain dimensions Add
xplain dimensions add-aggregation-dimension
Usage: xplain dimensions add-aggregation-dimension [OPTIONS]
Add a dimension derived from an aggregation on a sub-object
Add a computed dimension on the root object that aggregates values from a
sub-object (e.g. sum of prescription costs per patient).
Options:
--session TEXT Session ID or name
--target-object TEXT Name of the target object. [required]
--aggregation TEXT An aggregation in JSON object format.
:ref:`schema-AggregationUIModel` (JSON dict)
[required]
--dimension TEXT The name of the new dimension. If omitted,
the name will be generated.
--display-name TEXT An optional display name. XOE shows this
instead of the dimension name.
--selections TEXT The set of selections applied as the "where"
clause during aggregation. (JSON dict)
--selection-set TEXT If specified, the aggregation dimension will
use the selections from the given set.
--fix-explicit-selections TEXT Controls fixing semantics for explicit
selections. One of: ``none``, ``all``,
``only_propagate_upward``.
--add-default-attribute / --no-add-default-attribute
If set to `false`, no attribute will be
attached to the new dimension.
--threshold FLOAT An optional threshold for the aggregation.
--negate / --no-negate Negates the threshold condition (used
together with `threshold`).
--zero-point-dimension TEXT If set, activates relative-to-aggregation
mode. :ref:`schema-XElementPath` (JSON dict)
--sort-dimension TEXT Required when `zeroPointDimension` is set.
:ref:`schema-XElementPath` (JSON dict)
--base-object TEXT The base object for relative-to-aggregation
(used with `zeroPointDimension`).
--from- INTEGER Lower bound for relative-to-aggregation
range (used with `zeroPointDimension`).
--to INTEGER Upper bound for relative-to-aggregation
range (used with `zeroPointDimension`).
--output [json|csv|table] Output format
--help Show this message and exit.
xplain dimensions add-attribute
Usage: xplain dimensions add-attribute [OPTIONS]
Add an attribute to a dimension.
Options:
--session TEXT Session ID or name
--object TEXT [required]
--dimension TEXT
--attribute TEXT
--output [json|csv|table] Output format
--help Show this message and exit.
xplain dimensions add-boolean-logic-dimension
Usage: xplain dimensions add-boolean-logic-dimension [OPTIONS]
Add a boolean-logic dimension combining two boolean dimensions
Add a new computed dimension that is the boolean logic combination (AND, OR,
1NOT2, 2NOT1) of two existing boolean dimensions. All involved dimensions
must belong to the same object.
Options:
--session TEXT Session ID or name
--object TEXT The object holding all involved dimensions.
[required]
--dimension1 TEXT First boolean operand dimension name. [required]
--dimension2 TEXT Second boolean operand dimension name.
[required]
--type TEXT The boolean logic operation. One of: ``AND``,
``OR``, ``1NOT2``, ``2NOT1``.
--name TEXT Name for the new dimension (optional).
--output [json|csv|table] Output format
--help Show this message and exit.
xplain dimensions add-conditional-factor-dimension
Usage: xplain dimensions add-conditional-factor-dimension [OPTIONS]
Add a conditional factor dimension
Add a dimension whose value depends on conditions from a boolean attribute.
Different numeric scaling factors are applied based on the active states of
the condition attribute.
Options:
--session TEXT Session ID or name
--dimension-name TEXT Name for the new dimension. [required]
--object TEXT The object containing the condition. [required]
--condition-dimension TEXT The dimension containing the condition
attribute. [required]
--condition-attribute TEXT The boolean condition attribute name.
[required]
--input-dimension TEXT The numeric dimension to scale. [required]
--conditional-values TEXT Map of state name → scaling factor. (JSON dict)
[required]
--default-value FLOAT Factor to apply when no condition matches.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain dimensions add-constant-categorial-dimension
Usage: xplain dimensions add-constant-categorial-dimension
[OPTIONS]
Add a constant-value categorial dimension
Add a dimension that assigns a constant categorial value to all entities
(useful for labeling or tagging groups).
Options:
--session TEXT Session ID or name
--object TEXT The target object. [required]
--dimension TEXT The name of the new constant dimension to be
created. [required]
--root-state TEXT The constant state value to assign to all
instances. [required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain dimensions add-date-time-element-dimension
Usage: xplain dimensions add-date-time-element-dimension [OPTIONS]
Add a computed dimension extracting a date/time element
Add a computed dimension extracting a specific date/time element (such as
day-of-week, hour-of-day, month-of-year) from a timestamp dimension.
Deprecated aliases: `addDayOfWeekDimension` (use `dateTimeElement:
DAY_OF_WEEK`), `addHourOfDayDimension` (use `dateTimeElement: HOUR_OF_DAY`).
Options:
--session TEXT Session ID or name
--object TEXT The object containing the source dimension.
[required]
--source-dimension TEXT The source timestamp dimension (storing ms since
epoch). [required]
--target-dimension TEXT Name for the new computed dimension. [required]
--date-time-element TEXT The date/time element to extract. One of:
``NANO_OF_SECOND``, ``NANO_OF_DAY``,
``MICRO_OF_SECOND``, ``MICRO_OF_DAY``,
``MILLI_OF_SECOND``, ``MILLI_OF_DAY``,
``SECOND_OF_MINUTE``, ``SECOND_OF_DAY``,
``MINUTE_OF_HOUR``, ``MINUTE_OF_DAY``,
``HOUR_OF_AMPM``, ``CLOCK_HOUR_OF_AMPM``,
``HOUR_OF_DAY``, ``CLOCK_HOUR_OF_DAY``,
``AMPM_OF_DAY``, ``DAY_OF_WEEK``,
``ALIGNED_DAY_OF_WEEK_IN_MONTH``,
``ALIGNED_DAY_OF_WEEK_IN_YEAR``,
``DAY_OF_MONTH``, ``DAY_OF_YEAR``, ``EPOCH_DAY``,
``ALIGNED_WEEK_OF_MONTH``,
``ALIGNED_WEEK_OF_YEAR``, ``MONTH_OF_YEAR``,
``PROLEPTIC_MONTH``, ``YEAR_OF_ERA``, ``YEAR``,
``ERA``, ``INSTANT_SECONDS``, ``OFFSET_SECONDS``.
[required]
--zone-id TEXT Time zone identifier (e.g. "Europe/Berlin").
Defaults to server time zone.
--data-type TEXT Data type for the values. Usually omitted (auto-
selected). One of: ``BYTE``, ``SHORT``, ``INT``,
``LONG``.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain dimensions add-day-of-week-dimension
Usage: xplain dimensions add-day-of-week-dimension [OPTIONS]
[Deprecated] Add day-of-week dimension — use addDateTimeElementDimension
instead
**Deprecated.** Use `addDateTimeElementDimension` with `dateTimeElement:
DAY_OF_WEEK` instead.
Options:
--session TEXT Session ID or name
--object TEXT See API documentation. [required]
--source-dimension TEXT See API documentation. [required]
--target-dimension TEXT See API documentation. [required]
--zone-id TEXT See API documentation.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain dimensions add-disaggregation-dimension
Usage: xplain dimensions add-disaggregation-dimension [OPTIONS]
Add a disaggregation dimension
Add a computed dimension that disaggregates a total value proportionally
down to sub-object level based on a weighting dimension.
Options:
--session TEXT Session ID or name
--dimension-name TEXT See API documentation. [required]
--disaggregate-onto-object TEXT
The sub-object onto which to disaggregate.
[required]
--to-be-disaggregated-dimension TEXT
The dimension holding the total value to
disaggregate.
--to-be-disaggregated-value FLOAT
A fixed value to disaggregate (alternative
to dimension).
--output [json|csv|table] Output format
--help Show this message and exit.
xplain dimensions add-elapsed-time-attribute
Usage: xplain dimensions add-elapsed-time-attribute [OPTIONS]
Add an elapsed-time attribute to a duration dimension
Add an ElapsedTimeAttribute. This is a multi-level interval attribute where
the endpoints are numbers representing units of time elapsed since a certain
reference date/time. Either `dimension`, `dimensionPattern`, or
`dimensionExclusionPattern` must be provided to identify the target
dimension(s).
Options:
--session TEXT Session ID or name
--object TEXT The target object. [required]
--ref-date-time TEXT The reference date/time. [required]
--bin-boundaries TEXT The bin boundaries / interval endpoints /
split keys, one array per level. (JSON
array) [required]
--dimension TEXT The target dimension. (Might be replaced by
`dimensionPattern` and/or
`dimensionExclusionPattern`.)
--dimension-pattern TEXT Might be used instead of `dimension`.
--dimension-exclusion-pattern TEXT
Might be used instead of `dimension`.
--attribute TEXT The name of the new attribute to be created.
Defaults to the dimension name.
--new-attribute-name-prefix TEXT
Prefix for new attribute name(s).
--new-attribute-name-suffix TEXT
Suffix for new attribute name(s).
--upper-bin-boundary-included / --no-upper-bin-boundary-included
Signals whether the intervals are left-open
and right-closed (`true`), or left-closed
and right-open (`false`). (Current default
is `true`. This might be changed.)
--level-names TEXT The level names. (The default is `"Level
1"`, `"Level 2"`, and so on.) (JSON array)
--interval-name-scheme TEXT The naming scheme for the attribute states:
`"HALFOPEN_INTERVALS"`, `"FROM_TO"`,
`"FROM_TO_PLUS"`, or `"ONLY_FROM"`. One of:
``HALFOPEN_INTERVALS``, ``FROM_TO``,
``FROM_TO_PLUS``, ``ONLY_FROM``.
--base-time-unit TEXT The base time unit.
--output-time-unit TEXT The output time unit.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain dimensions add-flag-extraction-dimension
Usage: xplain dimensions add-flag-extraction-dimension [OPTIONS]
Add a flag-extraction dimension
Add a dimension that extracts a flag value from a boolean dimension
hierarchy.
Options:
--session TEXT Session ID or name
--object TEXT The name of the object where the new
dimension is to be added. [required]
--dimension TEXT The dimension of the given object that holds
the numeric values where the boolean flag is
to be extracted from. [required]
--bit-index INTEGER The index of the bit to be extracted (index
i stands for value 2^i, lowest possible
index is 0). [required]
--boolean-value-for-null / --no-boolean-value-for-null
Defines the Boolean value for the case of
null in the input dimension.
--output-dimension TEXT The name of the dimension to be created.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain dimensions add-hour-of-day-dimension
Usage: xplain dimensions add-hour-of-day-dimension [OPTIONS]
[Deprecated] Add hour-of-day dimension — use addDateTimeElementDimension
instead
**Deprecated.** Use `addDateTimeElementDimension` with `dateTimeElement:
HOUR_OF_DAY` instead.
Options:
--session TEXT Session ID or name
--object TEXT See API documentation. [required]
--source-dimension TEXT See API documentation. [required]
--target-dimension TEXT See API documentation. [required]
--zone-id TEXT See API documentation.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain dimensions add-interval-flag-dimension
Usage: xplain dimensions add-interval-flag-dimension [OPTIONS]
Add an interval flag dimension
Add a boolean dimension that flags entities within a specified time interval
relative to an event.
Options:
--session TEXT Session ID or name
--object TEXT The name of the object where the new
dimension is to be added. [required]
--dimension TEXT The dimension of the given object that holds
the values to be compared with the limits.
[required]
--lower-limit FLOAT The lower limit of the interval to be
compared with the dimension values.
--lower-limit-strict / --no-lower-limit-strict
Signals whether the dimension values have to
be strictly greater than the lower limit.
--lower-limit-active / --no-lower-limit-active
Explicitly activates/deactivates the lower
limit check.
--upper-limit FLOAT The upper limit of the interval to be
compared with the dimension values.
--upper-limit-strict / --no-upper-limit-strict
Signals whether the dimension values have to
be strictly less than the upper limit.
--upper-limit-active / --no-upper-limit-active
Explicitly activates/deactivates the upper
limit check.
--negate / --no-negate Signals whether the boolean result should be
negated.
--boolean-value-for-null / --no-boolean-value-for-null
Defines the Boolean value for the case of
null in the input dimension.
--output-dimension TEXT The name of the dimension to be created.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain dimensions add-linear-sum-dimension
Usage: xplain dimensions add-linear-sum-dimension [OPTIONS]
Add a linear sum computed dimension
Add a computed dimension that is a weighted linear sum of existing numeric
dimensions.
Options:
--session TEXT Session ID or name
--dimensions TEXT The dimensions to be summed, given as an array of
XElementPath. :ref:`schema-XElementPath` (JSON
array) [required]
--data-type TEXT The data type.
--betas TEXT An array of weights of the same length as
`dimensions` (if omitted, a simple sum is
computed). (JSON array)
--constant FLOAT An additive constant to the linear sum.
--dimension-name TEXT The name of the new dimension. If null, the name
will be generated.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain dimensions add-max-number-dimension
Usage: xplain dimensions add-max-number-dimension [OPTIONS]
Add a maximum computed dimension
Add a computed dimension returning the maximum of specified numeric
dimensions.
Options:
--session TEXT Session ID or name
--input-dimensions TEXT The dimensions to be used for calculating the
maximum, given as array of XElementPath.
:ref:`schema-XElementPath` (JSON array)
[required]
--constant FLOAT A constant to be used in calculating the maximum
value (i.e. a lower bound).
--output-dimension TEXT The name of the new dimension. If null, the name
will be generated.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain dimensions add-min-number-dimension
Usage: xplain dimensions add-min-number-dimension [OPTIONS]
Add a minimum computed dimension
Add a computed dimension returning the minimum of specified numeric
dimensions.
Options:
--session TEXT Session ID or name
--input-dimensions TEXT The dimensions to be used for calculating the
minimum, given as array of XElementPath.
:ref:`schema-XElementPath` (JSON array)
[required]
--constant FLOAT A constant to be used in calculating the minimum
value (i.e. an upper bound).
--output-dimension TEXT The name of the new dimension. If null, the name
will be generated.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain dimensions add-normalized-response-dimension
Usage: xplain dimensions add-normalized-response-dimension
[OPTIONS]
Add a normalized-response dimension
Add a dimension computing normalized response rates relative to a baseline.
The deprecated alias `addNormalisedResponseDimension` is also accepted.
Options:
--session TEXT Session ID or name
--input-dimension TEXT The input dimension (as XElementPath).
:ref:`schema-XElementPath` (JSON dict)
[required]
--categories TEXT The grouping categories (as GroupByUIModel).
(JSON dict) [required]
--dimension TEXT The name of the new dimension. If null, the name
will be generated.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain dimensions add-number-ranges-attribute
Usage: xplain dimensions add-number-ranges-attribute [OPTIONS]
Add a numeric ranges attribute (binning) to a dimension
Add a numeric ranges attribute that bins continuous numeric values into
discrete ranges (e.g. 0-10, 10-20, 20-50, >50).
Options:
--session TEXT Session ID or name
--object TEXT The target object. [required]
--dimension TEXT The target dimension. (Might be replaced by
`dimensionPattern` and/or
`dimensionExclusionPattern`.)
--dimension-pattern TEXT Might be used instead of `dimension`.
--dimension-exclusion-pattern TEXT
Might be used instead of `dimension`.
--attribute TEXT The name of the new attribute to be created.
Defaults to the dimension name.
--new-attribute-name-prefix TEXT
Prefix for new attribute name(s).
--new-attribute-name-suffix TEXT
Suffix for new attribute name(s).
--upper-bin-boundary-included / --no-upper-bin-boundary-included
Signals whether the intervals are left-open
and right-closed (`true`), or left-closed
and right-open (`false`).
--endpoint-class TEXT The fully qualified name of the class for
the interval endpoints.
--creation-mode TEXT The creation mode. One of: ``IRREGULAR``,
``EQUIDISTANT``, ``EXPONENTIAL``.
--endpoint-representation TEXT The endpoints representation mode. One of:
``BINARY``, ``DECIMAL``.
--level-names TEXT The level names. (JSON array)
--interval-name-scheme TEXT The naming scheme for the attribute states.
One of: ``HALFOPEN_INTERVALS``, ``FROM_TO``,
``FROM_TO_PLUS``, ``ONLY_FROM``.
--bin-boundaries TEXT The bin boundaries / interval endpoints /
split keys, one array per level. (JSON
array)
--state-names TEXT The interval names, one array per level.
(JSON array)
--state-display-names TEXT The interval display names, one array per
level. (JSON array)
--lower-limit FLOAT The lower limit for the intervals.
--upper-limit FLOAT The upper limit for the intervals.
--equidistant-creation-bin-size-per-level TEXT
The interval sizes (one per level) for
equidistant creation. (JSON array)
--exponential-creation-base-value FLOAT
The base value for the exponential creation.
--exponential-creation-factor FLOAT
The factor for the exponential creation.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain dimensions add-numeric-dimensions
Usage: xplain dimensions add-numeric-dimensions [OPTIONS]
Add multiple standard numeric attributes to a numeric dimension
Convenience method to add a standard set of numeric range attributes to a
numeric dimension (e.g. fine, medium, and coarse range bins).
Options:
--session TEXT Session ID or name
--object TEXT Name of object where the new dimensions are to be
added. [required]
--key-dimension-name TEXT A dimension of the given object — its values are
used as a key mapping to values in the Excel
file. [required]
--xls-file TEXT Excel file name which defines the numeric
dimension / the mapping from keys to values.
[required]
--sheet TEXT Sheet name in Excel file where the dimension is
defined. [required]
--key-field-name TEXT The name of the column in the Excel sheet which
holds the key values. [required]
--value-field-names TEXT The names of the columns in the Excel sheet which
hold the values of the new dimensions. (JSON
array) [required]
--attribute TEXT If given, states on the first level of this
attribute are used as keys instead of dimension
values.
--attribute-level INTEGER If given in combination with `attribute`, states
on the specified level are used as keys.
--dimension-names TEXT Names of the new dimensions to be added. Defaults
to `valueFieldNames`. (JSON array)
--value-data-types TEXT Data types of the new dimensions. (JSON array)
--output [json|csv|table] Output format
--help Show this message and exit.
xplain dimensions add-point-in-time-attribute
Usage: xplain dimensions add-point-in-time-attribute [OPTIONS]
Add a point-in-time attribute (time granularity binning) to a time dimension
Add an attribute that bins timestamps into discrete time intervals (e.g.
day, week, month, quarter, year) for a point-in-time dimension.
Options:
--session TEXT Session ID or name
--object TEXT The target object. [required]
--start-date-time TEXT A string representing the start of the first
local date/time interval. [required]
--stop-date-time TEXT A string representing the end of the last
local date/time interval. [required]
--date-time-levels TEXT An array of time units (e.g., `"DECADE"`,
`"YEAR"`, `"HALFYEAR"`, `"QUARTER"`,
`"MONTH"`, `"WEEK"`, `"DAY"`, `"HOUR"`).
(JSON array) [required]
--dimension TEXT The target dimension. (Might be replaced by
`dimensionPattern` and/or
`dimensionExclusionPattern`.)
--dimension-pattern TEXT Might be used instead of `dimension`.
--dimension-exclusion-pattern TEXT
Might be used instead of `dimension`.
--attribute TEXT The name of the new attribute to be created.
Defaults to the dimension name.
--new-attribute-name-prefix TEXT
Prefix for new attribute name(s).
--new-attribute-name-suffix TEXT
Suffix for new attribute name(s).
--upper-bin-boundary-included / --no-upper-bin-boundary-included
Signals whether the intervals are left-open
and right-closed (`true`), or left-closed
and right-open (`false`).
--format-locale TEXT A string defining the locale to be used for
formatting the date/time instances.
--format-year TEXT A string defining the format for the state
names of years.
--format-quarter TEXT A string defining the format for the state
names of quarters.
--format-month TEXT A string defining the format for the state
names of months.
--format-week TEXT A string defining the format for the state
names of weeks.
--format-day TEXT A string defining the format for the state
names of days.
--format-hour TEXT A string defining the format for the state
names of hours.
--zone-id TEXT A string representing the time zone.
--dimension-time-unit TEXT The time unit (`"MILLISECOND"`, `"SECOND"`,
`"DAY"`, or `"MONTH"`) characterizing the
units of the underlying dimension.
--endpoint-class TEXT The fully qualified name of the class for
the interval endpoints.
--level-names TEXT The level names. (JSON array)
--interval-name-scheme TEXT The naming scheme for the attribute states.
One of: ``HALFOPEN_INTERVALS``, ``FROM_TO``,
``FROM_TO_PLUS``, ``ONLY_FROM``.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain dimensions add-product-dimension
Usage: xplain dimensions add-product-dimension [OPTIONS]
Add a product computed dimension
Add a computed dimension that is the product of specified numeric
dimensions.
Options:
--session TEXT Session ID or name
--dimensions TEXT The factor dimensions, given as an array of
XElementPath. :ref:`schema-XElementPath` (JSON
array) [required]
--constant-factor FLOAT The constant factor.
--output-dimension TEXT The name of the new dimension. If null, the name
will be generated.
--data-type TEXT The data type.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain dimensions add-quantile-based-attributes
Usage: xplain dimensions add-quantile-based-attributes [OPTIONS]
Generate quantile-based attributes for FLOAT/DOUBLE dimensions.
Options:
--session TEXT Session ID or name
--object-name TEXT
--dimension TEXT
--quantiles TEXT
--quantiles-attribute-name TEXT
--ranges-attribute-name TEXT
--use-names-as-postfix TEXT
--selections TEXT
--sample-size TEXT
--script-file TEXT
--script-file-ownership TEXT
--output [json|csv|table] Output format
--help Show this message and exit.
xplain dimensions add-quotient-dimension
Usage: xplain dimensions add-quotient-dimension [OPTIONS]
Add a quotient computed dimension
Add a computed dimension that is the quotient of two numeric dimensions.
Options:
--session TEXT Session ID or name
--numerator-dimension TEXT The dimension to be used as the numerator for
calculating the quotient. :ref:`schema-
XElementPath` (JSON dict) [required]
--denominator-dimension TEXT The dimension to be used as the denominator
for calculating the quotient. :ref:`schema-
XElementPath` (JSON dict) [required]
--output-dimension TEXT The name of the new dimension. If null, the
name will be generated.
--data-type TEXT The output data type of the quotient
dimension.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain dimensions add-ratio-dimension
Usage: xplain dimensions add-ratio-dimension [OPTIONS]
Add a ratio dimension (quotient of counts)
Add a computed dimension that computes the ratio (share) of the first input
dimension relative to the sum of all input dimensions.
Options:
--session TEXT Session ID or name
--target-object TEXT The object to add the ratio dimension to.
[required]
--dimensions TEXT Input numeric dimensions for the ratio
computation. :ref:`schema-XElementPath`
(JSON array) [required]
--dimension-name TEXT Name for the new ratio dimension.
[required]
--min-denominator FLOAT Minimum denominator value (ratios with
smaller denominators get null).
--add-first-to-denominator / --no-add-first-to-denominator
Whether to include the first dimension in
the denominator.
--target-share FLOAT Optional target share value for the ratio
attribute.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain dimensions add-sample-dimension
Usage: xplain dimensions add-sample-dimension [OPTIONS]
Add a sample dimension (stratified random sample flag)
Add a boolean dimension that flags a random sample of entities, respecting
stratification groups.
Options:
--session TEXT Session ID or name
--dimension TEXT Name of the new dimension. Defaults to
`"Random Segment"`.
--number-of-segments INTEGER The number of random segments.
--sample-object TEXT The object whose instances are assigned to
random segments (root object if not given).
--output [json|csv|table] Output format
--help Show this message and exit.
xplain dimensions add-shift-number-dimension
Usage: xplain dimensions add-shift-number-dimension [OPTIONS]
Add a shift-number dimension (classifies timestamps into work shifts)
Add a computed dimension that classifies timestamp values into numbered work
shifts based on shift-end times.
Options:
--session TEXT Session ID or name
--object TEXT See API documentation. [required]
--source-dimension TEXT Source timestamp dimension (ms since epoch).
[required]
--target-dimension TEXT Name for the new shift-number dimension.
[required]
--shift-ends TEXT End times for each shift (in order). (JSON array)
[required]
--shift-names TEXT Names for each shift (must match length of
shiftEnds if given). (JSON array)
--zone-id TEXT Time zone identifier.
--data-type TEXT One of: ``BYTE``, ``SHORT``, ``INT``, ``LONG``.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain dimensions add-tag
Usage: xplain dimensions add-tag [OPTIONS]
Add a tag to an element (object, dimension, or attribute)
Add the specified tag to a dimension or attribute identified by its
XElementPath. Tags can later be used to select or remove groups of
attributes with `removeAttributesWithTag`.
Options:
--session TEXT Session ID or name
--element TEXT The path to the element to tag. :ref:`schema-
XElementPath` (JSON dict) [required]
--tag TEXT The tag to add. [required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain dimensions add-threshold-dimension
Usage: xplain dimensions add-threshold-dimension [OPTIONS]
Add a threshold dimension (boolean flag based on threshold comparison)
Add a boolean dimension that flags entities where a numeric dimension's
value exceeds (or falls below) a specified threshold.
Options:
--session TEXT Session ID or name
--object TEXT The name of the object where the new
dimension is to be added. [required]
--dimension TEXT The dimension of the given object that holds
the values to be compared with the
threshold. [required]
--threshold FLOAT The threshold to be compared with the
dimension values. [required]
--strict / --no-strict Signals whether the dimension values have to
be strictly greater (instead of greater or
equal) than the threshold.
--negate / --no-negate Signals whether the boolean result should be
negated.
--boolean-value-for-null / --no-boolean-value-for-null
Defines the Boolean value for the case of
null in the input dimension.
--output-dimension TEXT The name of the dimension to be created.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain dimensions add-time-difference-dimension
Usage: xplain dimensions add-time-difference-dimension [OPTIONS]
Add a time-difference computed dimension
Add a computed dimension representing the difference between two timestamp
dimensions in a specified time unit.
Options:
--session TEXT Session ID or name
--minuend-dimension TEXT The dimension to be used as the minuend for
calculating the time difference.
:ref:`schema-XElementPath` (JSON dict)
[required]
--subtrahend-dimension TEXT The dimension to be used as the subtrahend
for calculating the time difference.
:ref:`schema-XElementPath` (JSON dict)
[required]
--time-unit TEXT The output time unit of the new dimension.
(If `ageBased` is `true`, only `"YEAR"` and
`"MONTH"` are allowed.) [required]
--calendar-based / --no-calendar-based
Signals whether the time difference should
be based on a calendar (and a certain time
zone).
--age-based / --no-age-based Signals whether a calendar-based time
difference should follow the style of the
usual age computation.
--zone-id TEXT The time zone (e.g., `"Europe/Berlin"`). If
null, the default of the JVM is used.
--output-dimension TEXT The name of the new dimension. If null, the
name will be generated.
--data-type TEXT The output data type of the time difference
dimension. (null means to infer it
automatically from `timeUnit`.)
--output [json|csv|table] Output format
--help Show this message and exit.
xplain dimensions add-time-duration-attribute
Usage: xplain dimensions add-time-duration-attribute [OPTIONS]
Add a time duration attribute to a dimension
Add an attribute representing time durations in a specified unit.
Options:
--session TEXT Session ID or name
--object TEXT The target object. [required]
--dimension TEXT The target dimension. (Might be replaced by
`dimensionPattern` and/or
`dimensionExclusionPattern`.)
--dimension-time-unit TEXT The time unit that the values of this
dimension are measured in.
--dimension-pattern TEXT Might be used instead of `dimension`.
--dimension-exclusion-pattern TEXT
Might be used instead of `dimension`.
--attribute TEXT The name of the new attribute to be created.
Defaults to the dimension name.
--new-attribute-name-prefix TEXT
Prefix for new attribute name(s).
--new-attribute-name-suffix TEXT
Suffix for new attribute name(s).
--upper-bin-boundary-included / --no-upper-bin-boundary-included
Signals whether intervals are left-open and
right-closed.
--creation-mode TEXT The creation mode. One of: ``IRREGULAR``,
``EQUIDISTANT``, ``EXPONENTIAL``.
--bin-boundaries-in-base-units TEXT
The bin boundaries measured in the time
units specified in `baseUnit`, one array per
level. (Applies only to IRREGULAR mode.)
(JSON array)
--bin-boundaries TEXT The bin boundaries measured in the time
units of the underlying dimension, one array
per level. (Applies only to IRREGULAR mode.)
(JSON array)
--state-names TEXT The interval names, one array per level.
(Applies only to IRREGULAR mode.) (JSON
array)
--state-display-names TEXT The interval display names, one array per
level. (JSON array)
--level-names TEXT The level names. (JSON array)
--interval-name-scheme TEXT The naming scheme for the attribute states.
One of: ``HALFOPEN_INTERVALS``, ``FROM_TO``,
``FROM_TO_PLUS``, ``ONLY_FROM``.
--base-unit TEXT Specifies in which units the bin sizes are
given. (Applies only to EQUIDISTANT and
EXPONENTIAL modes.)
--min-base-units INTEGER The minimum value (measured in `baseUnits`).
(Applies only to EQUIDISTANT and EXPONENTIAL
modes.)
--max-base-units INTEGER The maximum value (measured in `baseUnits`).
(Applies only to EQUIDISTANT and EXPONENTIAL
modes.)
--equidistant-creation-time-unit-bin-sizes TEXT
The interval sizes (one per level) for
equidistant creation. (Mandatory if
`creationMode` is `"EQUIDISTANT"`.) (JSON
array)
--exponential-creation-time-unit-base-value FLOAT
The base value for the exponential creation.
(Mandatory if `creationMode` is
`"EXPONENTIAL"`.)
--exponential-creation-factor FLOAT
The factor for the exponential creation.
(Mandatory if `creationMode` is
`"EXPONENTIAL"`.)
--reduce-units / --no-reduce-units
Signals whether larger numbers of smaller
units should be reduced to smaller numbers
of larger units.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain dimensions add-time-in-shift-dimension
Usage: xplain dimensions add-time-in-shift-dimension [OPTIONS]
Add a time-in-shift dimension (elapsed time within a shift)
Add a computed dimension that calculates the elapsed time within the current
work shift for each timestamp value.
Options:
--session TEXT Session ID or name
--object TEXT See API documentation. [required]
--source-dimension TEXT See API documentation. [required]
--target-dimension TEXT See API documentation. [required]
--shift-ends TEXT Shift end times in HH:MM:SS format. (JSON
array) [required]
--zone-id TEXT See API documentation.
--data-type TEXT One of: ``BYTE``, ``SHORT``, ``INT``,
``LONG``.
--attribute-configuration TEXT Optional attribute configuration JSON. (JSON
dict)
--output [json|csv|table] Output format
--help Show this message and exit.
xplain dimensions remove-attribute
Usage: xplain dimensions remove-attribute [OPTIONS]
Remove an attribute.
Options:
--session TEXT Session ID or name
--object TEXT [required]
--dimension TEXT [required]
--attribute TEXT [required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain dimensions remove-attribute-if-exists
Usage: xplain dimensions remove-attribute-if-exists [OPTIONS]
Remove an attribute if it exists (no error if missing)
Remove an attribute from the current session if it exists. Unlike
`removeAttribute`, this method does not throw an error if the attribute is
not found.
Options:
--session TEXT Session ID or name
--object TEXT The object which holds the dimension. [required]
--dimension TEXT The dimension which holds the attribute.
[required]
--attribute TEXT The attribute to be removed (silently ignored if
not found). [required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain dimensions remove-attributes-with-tag
Usage: xplain dimensions remove-attributes-with-tag [OPTIONS]
Remove all attributes with a given tag
Remove all attributes across all objects and dimensions that have the
specified tag. Optionally ignores errors if a particular attribute cannot be
removed.
Options:
--session TEXT Session ID or name
--tag TEXT The tag name; all attributes with this tag
will be removed. [required]
--ignore-exception / --no-ignore-exception
If true, errors during removal of individual
attributes are suppressed.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain dimensions remove-dimension
Usage: xplain dimensions remove-dimension [OPTIONS]
Remove a dimension from an object
Remove a dimension (and all its attributes) from an object. Throws an error
if the dimension does not exist.
Options:
--session TEXT Session ID or name
--object TEXT See API documentation. [required]
--dimension TEXT See API documentation. [required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain dimensions remove-dimension-if-exists
Usage: xplain dimensions remove-dimension-if-exists [OPTIONS]
Remove a dimension if it exists (no error if missing)
Like `removeDimension` but does not throw an error if the dimension does not
exist.
Options:
--session TEXT Session ID or name
--object TEXT See API documentation. [required]
--dimension TEXT See API documentation. [required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain dimensions remove-tag
Usage: xplain dimensions remove-tag [OPTIONS]
Remove a tag from an element
Remove the specified tag from a dimension or attribute identified by its
XElementPath.
Options:
--session TEXT Session ID or name
--element TEXT The path to the element to untag. :ref:`schema-
XElementPath` (JSON dict) [required]
--tag TEXT The tag to remove. [required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain dimensions rename-dimension
Usage: xplain dimensions rename-dimension [OPTIONS]
Rename a session-generated dimension
Rename a dimension that was generated within the current session. Will
report an error if the dimension is in use (e.g. referenced by selections or
queries) or if it is a pre-existing dimension from an XTable.
Options:
--session TEXT Session ID or name
--dimension TEXT The dimension to rename, specified as an
XElementPath with `object` and `dimension`
fields. :ref:`schema-XElementPath` (JSON dict)
[required]
--new-name TEXT The new name for the dimension. [required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain dimensions reorganize-attribute
Usage: xplain dimensions reorganize-attribute [OPTIONS]
Reorganize (reindex) an attribute
Reorganize (reindex) the internal data of an attribute. This can improve
performance after many selective operations have been applied. Typically
used after building complex hierarchies or after many selection-based
modifications.
Options:
--session TEXT Session ID or name
--new-attribute-name TEXT The name for the resulting reorganized
attribute. [required]
--object TEXT The object which holds the attribute to
reorganize. Required together with `dimension`
and `attribute` when identifying the attribute
by full path; omit when passing `attribute` as
a shorthand path object.
--dimension TEXT The dimension which holds the attribute to
reorganize.
--attribute TEXT The attribute to reorganize. Can be a plain
name string (when combined with `object` and
`dimension`) or a shorthand path object when
`object` is not given.
--hierarchy TEXT The explicit list of first-level state names
defining the new hierarchy. Exactly one of
`hierarchy`, `level`, or `levelName` must be
provided. (JSON array)
--level INTEGER Pull states from this hierarchy level number
up to the first level. Exactly one of
`hierarchy`, `level`, or `levelName` must be
provided.
--level-name TEXT Pull states from this named hierarchy level up
to the first level. Exactly one of
`hierarchy`, `level`, or `levelName` must be
provided.
--hierarchy-level-names TEXT Optional names for the resulting hierarchy
levels. (JSON array)
--others-state-name TEXT Name for the catch-all state that collects
first-level states not present at the pulled-
up level (used with `level` / `levelName`).
Defaults to `"others"`.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain dimensions replicate-dimension
Usage: xplain dimensions replicate-dimension [OPTIONS]
Replicate a dimension with a new name
Create a copy of an existing dimension under a new name, preserving all
attributes and configuration.
Options:
--session TEXT Session ID or name
--dimension TEXT The dimension which will be replicated. It needs
to be a numeric dimension. Specified as an
XElementPath with `object` and `dimension`
fields. :ref:`schema-XElementPath` (JSON dict)
[required]
--to-object TEXT The object into which the dimension should be
replicated. It needs to be a sub-object of the
object where the replicated dimension comes from.
[required]
--name TEXT Name of the new dimension. If not given, the name
will be identical to that of the replicated
dimension.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain temporal
Relative time dimensions, sequences, and longitudinal analysis.
11 commands:
xplain temporal add-relative-time-dimensions — Construct relative time dimension(s) based on reference events
xplain temporal build-sorted-sequence — Build a sorted sequence from time-ordered events
xplain temporal clear-selections-for-sequence — Clear selections associated with a sequence
xplain temporal delete-sequence — Delete a sequence.
xplain temporal delete-sequence-queries — Delete queries associated with a sequence
xplain temporal get-open-sequences — Retrieves details of open sequences by name.
xplain temporal get-sequence-transition-matrix — Retrieves the transition matrix for the specified sequence.
xplain temporal open-sequence — Open sequence queries for analysis.
xplain temporal open-sequence-queries — Open queries for a sequence
xplain temporal run-longitudinal-analysis — Run a longitudinal (event-based) analysis
xplain temporal run-mix-market-analysis — Run a Mix & Market analysis
xplain temporal add-relative-time-dimensions
Usage: xplain temporal add-relative-time-dimensions [OPTIONS]
Construct relative time dimension(s) based on reference events
Construct one or more relative time dimensions, measuring time relative to a
reference event. The reference event is defined by the
`referenceEventSelections` (e.g., "first diagnosis of a specific disease").
If `referenceEventSelections` are given, they define the fixed part of the
relative time axis. If in addition an external selection set is specified
via `selectionSet`, any selections on attributes not part of
`referenceEventSelections` are pulled dynamically from that set (giving the
time axis floating semantics). If no `referenceEventSelections` are given,
the current global selections are used. The deprecated method
`addRelativeTimes` falls through to this method.
Options:
--session TEXT Session ID or name
--reference-time-dimension TEXT
An element path (object and dimension name).
:ref:`schema-XElementPath` (JSON dict)
[required]
--time-dimensions TEXT An array of element paths (each consisting
of object and dimension name). :ref:`schema-
XElementPath` (JSON array)
--interval-end-time-dimension TEXT
An element path (object and dimension name),
optional coding an interval in combination
with referenceTimeDimension. :ref:`schema-
XElementPath` (JSON dict)
--base-object TEXT The name of the base object. If the
baseObject is not given, the root object
used as baseObject.
--relative-time-type TEXT The reference type (`"TO_FIRST"`,
`"TO_LAST"`, `"TO_NEAREST"`, `"TO_NEXT"`,
`"TO_PREVIOUS"`). One of: ``TO_FIRST``,
``TO_LAST``, ``TO_NEAREST``, ``TO_NEXT``,
``TO_PREVIOUS``.
--names TEXT The names of the new relative time
dimensions (must be of same cardinality as
`timeDimensions`). (JSON array)
--reference-event-selections TEXT
The reference event selections.
:ref:`schema-SelectionUIModel` (JSON array)
--fix-explicit-selections TEXT This parameter may have one of the three
values "none" (the default), "all" or
"only_propagate_upward". In case of "none"
the referenceEventSelections for the
relative time dimension are kept as they
are, which means that the resulting
dimension hasn't necessarily a fixed
semantics (may change in case the selections
refer to a dimension which itself has
floating semantics - this includes propagate
upward dimensions). The given selections are
sometimes also called "fixed selections",
which may be miss-leading in that case. If
the parameter is set to "all", all semantics
will be fixed (indeed recursively, i.e., if
the floating semantics emerges from a chain
of references). In case of
"only_propagate_upward" only propagate
upward dimensions are "fixed" and are
replaced by their non-floating counterpart
(in this case non-recursively). This
parameter offers an heuristics how to deal
with the given referenceEventSelections
before they are used as a part of the
definition of the new dimension (it is not a
part of the final definition of the
resulting dimension). See also the
equivalent parameter in
#addAggregationDimension, #pin and
#buildSortedSequence. One of: ``none``,
``all``, ``only_propagate_upward``.
--time-unit TEXT The time unit (`"NANOSECOND"`,
`"MILLISECOND"`, `"SECOND"`, `"MINUTE"`,
`"HOUR"`, `"DAY"`, `"WEEK"`, `"MONTH"`,
`"QUARTER"`, `"HALFYEAR"`, `"YEAR"`,
`"DECADE"`, `"CENTURY"`). One of:
``NANOSECOND``, ``MILLISECOND``, ``SECOND``,
``MINUTE``, ``HOUR``, ``DAY``, ``WEEK``,
``MONTH``, ``QUARTER``, ``HALFYEAR``,
``YEAR``, ``DECADE``, ``CENTURY``.
--calendar-based / --no-calendar-based
Decides whether the time difference is based
on the calendar or not. (Calendar-based
means: the difference between 31.12.2020
00:55 and 01.01.2021 00:05 is ONE
year/month/day although it is actually just
10 minutes, and thus ZERO years/months/days
in the non-calendar-based setting.)
--cache-reference-time / --no-cache-reference-time
Decides whether caching should be applied.
--selection-set TEXT If specified, the relative time axis will
use the selections from the given set as the
reference event selections (= zero point of
time of the relative time axis), thereby
implementing a "floating semantics" concept.
This means, whenever the selections in the
corresponding set change, the relative time
axis will have a different zero point, i.e.
the reference event selections of the time
axis "point" to the given selection set. (As
an exception to that see the parameter
"floatingSemantics", which you may set to
false.) If, in addition to the parameter
selectionSet, explicit reference event
selections are provided for a number of
attributes (the argument
referenceEventSelections), selections on
those attributes are kept fix, however
selections on other attributes are pulled
dynamically from the given selection set.
--floating-semantics / --no-floating-semantics
If, in case of a specified selectionSet (and
if no explicit selections are specified),
this parameter is given as false, then the
current selections of the given selection
set copied from there and henceforth used as
the fixed selections of the time axis. This
parameter it deprecated - don't use it any
more.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain temporal build-sorted-sequence
Usage: xplain temporal build-sorted-sequence [OPTIONS]
Build a sorted sequence from time-ordered events
Build a sorted sequence structure from time-ordered events, enabling
sequence analysis (e.g., patient event journeys sorted by time).
Options:
--session TEXT Session ID or name
--target-object TEXT Name of the target object (optional - if not
given the root object is assumed, or guessed
otherwise). In case of a RankDimension this
parameter is irrelevant. (The object of the
sortDimension is used.)
--ranks TEXT The ranks of the new dimension (position
when sorted according to sortDimension).
(JSON array)
--reverse / --no-reverse For the case of reverse sorting / counting.
--names TEXT Names of the new dimensions - if not given a
name will be generated. There needs to be
one array of names for each
dimensionToReplicate, and each array needs
to be of same size as the number of given
ranks (or a null array). (JSON array)
--name-postfixes TEXT When given instead of `names`, the names
will be generated based on those post-fixes.
(JSON array)
--dimensions-to-replicate TEXT The dimensions which should be replicated
("unfolded" in time). Those need to be from
the same source object. :ref:`schema-
XElementPath` (JSON array)
--sort-dimension TEXT The dimension which defines the sorting
(typically a time dimension, but could by
any numeric dimension). :ref:`schema-
XElementPath` (JSON dict)
--base-object TEXT The embracing object within which events are
sorted (if not given the target object is
assumed if this not in a different object
branch, otherwise the root object). You
might for example sort all events of a
patient and find events of a certain rank,
or you might want to sort events within a
hospital case to define ranks within a case.
--zero-point-dimension TEXT An optional dimension relative to which the
sorting / ranking is done. :ref:`schema-
XElementPath` (JSON dict)
--selections TEXT The set of selections that will be applied
as the "where" clause to the to be
sorted/ranked events. :ref:`schema-
SelectionUIModel` (JSON array)
--fix-explicit-selections TEXT This parameter may have one of the three
values "none" (the default), "all" or
"only_propagate_upward". In case of "none"
the given selections are kept as they are,
which means that the resulting dimension
hasn't necessarily a fixed semantics (may
change in case the selections refer to a
dimension which itself has floating
semantics - this includes propagate upward
dimensions). The given selections are
sometimes also called "fixed selections",
which may be miss-leading in that case. If
the parameter is set to "all", all semantics
will be fixed (indeed recursively, i.e., if
the floating semantics emerges from a chain
of references). In case of
"only_propagate_upward" only propagate
upward dimensions are "fixed" and are
replaced by their non-floating counterpart
(in this case non-recursively). This
parameter offers an heuristics how to deal
with the given selections before they are
used as a part of the definition of the new
dimension (it is not a part of the final
definition of the resulting dimension). One
of: ``none``, ``all``,
``only_propagate_upward``.
--selection-set TEXT If specified, the selections from the given
set will be used as the selections (= the
parameter "selections"), thereby
implementing a "floating semantics" concept.
This means, whenever the selections in the
corresponding set change, the "where clause"
in the definition of the ranks changes: the
selections "point" to the given selection
set. (As an exception to that see the
parameter "floatingSemantics", which you may
set to false.) If, in addition to the
parameter selectionSetDefiningRank, explicit
reference event selections are provided for
a number of attributes (the argument
"selections"), selection on those attributes
are kept fix, however selections on other
attributes are pulled dynamically from the
given selection set.
--selection-set-defining-rank TEXT
An old deprecated parameter which may be
used instead of selectionSet.
--floating-semantics / --no-floating-semantics
If, in case of a specified selection set
(and if no explicit selections are
specified), this parameter is given as
false, then the current selections of the
given selection set copied from there and
henceforth used as the explicit selections
and kept fix. This parameter it deprecated -
don't use it any more.
--attributes-to-copy TEXT A list of attribute names amongst the
attributes attached to the
`dimensionsToReplicate` which are copied to
the new dimensions. If not given all
attributes will be copied. Otherwise, there
needs to be one array for each
dimensionsToReplicate. (JSON array)
--sequence-names TEXT If given the dimensions will be grouped into
a sequence (see the corresponding methods
for more details, e.g. openSequence). (JSON
array)
--rank-dimension-name TEXT If this parameter is given, an additional
"rank dimension" is added to the source
object (the object where the
dimensionsToReplicate come from), which
assigns a number (the rank) to each
instance.
--rank-zero-is-first-instance-equal-or-greater-zero-point / --no-rank-zero-is-first-instance-equal-or-greater-zero-point
If true this means that the first instance
in the array of sorted instances which is >=
zero point receives the rank 0, i.e.
starting from the first equal (or greater)
instance the numbering goes upward 0, 1, 2,
...
--transition-attribute TEXT If non-null, only the transitions will be
coded in the sequence, i.e. only if the
value of this attribute on the given
transitionLevel changes a new entry in the
ranked sequence is made. :ref:`schema-
XElementPath` (JSON dict)
--only-segment-starts / --no-only-segment-starts
If set to true, only the first occurrence of
a segment is assigned a rank, i.e. only if a
new value of the transitionAttribute
appears, whereby new is defined by the
transitionLevel.
--transition-level INTEGER See the parameter transitionAttribute: the
hierarchy level of the attribute which is
used to detect transitions.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain temporal clear-selections-for-sequence
Usage: xplain temporal clear-selections-for-sequence [OPTIONS]
Clear selections associated with a sequence
Remove all selections that have been applied to the specified sequence,
returning it to an unfiltered state.
Options:
--session TEXT Session ID or name
--sequence-name TEXT Name of the sequence. [required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain temporal delete-sequence
Usage: xplain temporal delete-sequence [OPTIONS]
Delete a sequence.
Options:
--session TEXT Session ID or name
--sequence-name TEXT [required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain temporal delete-sequence-queries
Usage: xplain temporal delete-sequence-queries [OPTIONS]
Delete queries associated with a sequence
Delete all open queries (requests) associated with the specified sequence,
freeing their resources without deleting the sequence itself.
Options:
--session TEXT Session ID or name
--sequence-name TEXT Name of the sequence. [required]
--delete-marginal-queries / --no-delete-marginal-queries
If true, queries for the marginal
distributions for each sequence step will be
deleted (one-dimensional).
--delete-transition-queries / --no-delete-transition-queries
If true, queries which describe the
transitions between each step will be
deleted (two-dimensional).
--output [json|csv|table] Output format
--help Show this message and exit.
xplain temporal get-open-sequences
Usage: xplain temporal get-open-sequences [OPTIONS]
Retrieves details of open sequences by name.
Options:
--session TEXT Session ID or name
--sequence-name TEXT [required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain temporal get-sequence-transition-matrix
Usage: xplain temporal get-sequence-transition-matrix [OPTIONS]
Retrieves the transition matrix for the specified sequence.
Options:
--session TEXT Session ID or name
--sequence-name TEXT [required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain temporal open-sequence
Usage: xplain temporal open-sequence [OPTIONS]
Open sequence queries for analysis.
Options:
--session TEXT Session ID or name
--sequence-names TEXT [required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain temporal open-sequence-queries
Usage: xplain temporal open-sequence-queries [OPTIONS]
Open queries for a sequence
Open multiple queries associated with a sequence for parallel computation.
Options:
--session TEXT Session ID or name
--sequence-names TEXT Names of the sequences previously generated
for which to open the queries. (JSON array)
[required]
--open-marginal-queries / --no-open-marginal-queries
If true, queries for the marginal
distributions for each sequence step will be
opened (one-dimensional).
--open-transition-queries / --no-open-transition-queries
If true, queries which describe the
transitions between each step will be opened
(two-dimensional).
--selection-set TEXT If specified, the sequence queries pull
floating selections from the specified set.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain temporal run-longitudinal-analysis
Usage: xplain temporal run-longitudinal-analysis [OPTIONS]
Run a longitudinal (event-based) analysis
Run a longitudinal analysis on the currently loaded data. The analysis is
driven by a configuration that specifies event definitions, time windows,
and output structure. The configuration can be provided either as a file
reference (`configurationFile`) or as an inline JSON object/string
(`configuration`). Exactly one of the two must be specified. After the
analysis completes, the results are added to the session as new sub-objects.
Options:
--session TEXT Session ID or name
--configuration-file TEXT Name of the configuration file (in the `config`
directory). Mutually exclusive with
`configuration`.
--configuration TEXT Inline configuration as a JSON object or JSON
string. Mutually exclusive with
`configurationFile`. (JSON dict)
--output [json|csv|table] Output format
--help Show this message and exit.
xplain temporal run-mix-market-analysis
Usage: xplain temporal run-mix-market-analysis [OPTIONS]
Run a Mix & Market analysis
Run a Mix & Market analysis on the currently loaded data. Similar to
`runLongitudinalAnalysis` but uses a `MixMarketConfiguration`. Provide
either `configurationFile` or `configuration`, but not both.
Options:
--session TEXT Session ID or name
--configuration-file TEXT Name of the configuration file (in the `config`
directory). Mutually exclusive with
`configuration`.
--configuration TEXT Inline configuration as a JSON object or JSON
string. Mutually exclusive with
`configurationFile`. (JSON dict)
--output [json|csv|table] Output format
--help Show this message and exit.
xplain models
Predictive modeling, causal discovery, and variable management.
29 commands:
xplain models add-variable — Add a variable to a causal model
xplain models build-predictive-model — Build a predictive (causal discovery) model
xplain models clear-factor-selection — Clear the factor selection in a predictive model
xplain models clone-model — Clone an existing model under a new name
xplain models close-model — Close an open model
xplain models delete-model — Delete a model from the current session
xplain models estimate-causal-graph — Estimate the causal graph for a Noisy-Or model
xplain models evaluate-all-alternatives — Evaluate all alternative variables for each factor in a model
xplain models evaluate-model — Evaluate a predictive model and return evaluation metrics
xplain models export-model — Export a model to a file
xplain models find-related-factors — Find factors correlated with specified factors
xplain models get-independent-variables-of-model — get the list of independent variables of given predictive model.
xplain models get-model-configuration — Get or load a model configuration
xplain models get-model-names — list all loaded predictive models.
xplain models get-variable-details — Retrieve the details of the independent variables for a predictive model.
xplain models get-variable-list — get the list of independent variables of given predictive model.
xplain models import-model — Import a model from a file into the current session
xplain models open-model — Open a model for interactive exploration
xplain models propose-model-configuration — Generate a model configuration proposal from minimal parameters
xplain models refit-model — Refit an existing model with current data
xplain models reject-factors — Reject specified factors from a Noisy-Or model
xplain models reject-factors-recursively — Recursively reject factors and search for alternatives
xplain models run-discovery-bot — Run the automated discovery bot
xplain models save-model-configuration — Save a model’s current configuration to a file
xplain models search-for-new-factors — Search for new causal factors in a model
xplain models select-factor — Select a factor in a predictive model
xplain models set-causal-relation — Set the causal relation type for variables in a model
xplain models set-model-configuration — Set configuration parameters for an existing model
xplain models add-variable
Usage: xplain models add-variable [OPTIONS]
Add a variable to a causal model
Add a new variable (independent factor) to an existing causal model. The
variable is specified as a dimension/attribute path.
Options:
--session TEXT Session ID or name
--model-name TEXT The name of the model. [required]
--selections TEXT A set of selections which define the semantics of
the variable. Must not be empty. :ref:`schema-
SelectionUIModel` (JSON array) [required]
--threshold INTEGER The threshold of the binary aggregation variable.
[required]
--aggregation TEXT An optional aggregation which defines the
aggregation variable. Default is a simple COUNT
of the corresponding object. :ref:`schema-
AggregationUIModel` (JSON dict)
--output [json|csv|table] Output format
--help Show this message and exit.
xplain models build-predictive-model
Usage: xplain models build-predictive-model [OPTIONS]
Build a predictive (causal discovery) model
Build a predictive model using the Noisy-Or causal discovery algorithm. The
model is trained on the currently loaded data using the specified
configuration. Aliases: `buildModel`, `createModel`, `crossValidateModel`
(all work identically). A model configuration file (`.xmodel`) can be
provided via `xmodelConfigurationFileName` or `configuration`, or the
configuration can be proposed using `proposeModelConfiguration` first.
Options:
--session TEXT Session ID or name
--model-name TEXT The name for the model (must be unique
within the session). [required]
--xmodel-configuration-file-name TEXT
Name of an `.xmodel` configuration file.
Aliases: `xmodelConfigurationName`,
`fileName`.
--configuration TEXT Inline model configuration as a JSON object.
(JSON dict)
--target-event-object TEXT Name of the target event object (for Noisy-
Or models).
--target-dimension TEXT Name of the target dimension.
--significance FLOAT Statistical significance threshold.
--max-independent-variables INTEGER
Maximum number of independent variables to
include.
--min-support INTEGER Minimum support count for a factor to be
considered.
--number-of-validation-partitions INTEGER
Number of cross-validation partitions.
--estimate-causal-graph / --no-estimate-causal-graph
Whether to estimate the causal graph after
building.
--build-recommendations / --no-build-recommendations
Whether to build recommendations.
--segment-measures TEXT Optional list of segment measure names.
(JSON array)
--explanation-generation-file-name TEXT
Optional file containing explanation
generation configuration.
--goal TEXT Optional goal description for explanation
generation (used with
`explanationGenerationFileName`).
--training-scope TEXT Optional array of selections on root object
level to restrict model training. The
validation set is implicitly the model scope
minus the training scope. :ref:`schema-
SelectionUIModel` (JSON array)
--primary-target-selection-attributes TEXT
Optional list of attributes that primarily
define the target selections. Also accepted
as the deprecated alias
`targetSelectionAttributes`. :ref:`schema-
XElementPath` (JSON array)
--target-selections TEXT Optional explicit target selections.
:ref:`schema-SelectionUIModel` (JSON array)
--target-and-surrogate-target-event-space TEXT
Optional target and surrogate target event
space selections. :ref:`schema-
SelectionUIModel` (JSON array)
--start-of-episode-selections TEXT
Optional start-of-episode selections.
:ref:`schema-SelectionUIModel` (JSON array)
--output [json|csv|table] Output format
--help Show this message and exit.
xplain models clear-factor-selection
Usage: xplain models clear-factor-selection [OPTIONS]
Clear the factor selection in a predictive model
Remove all factor selections from the specified model, returning it to a
neutral state.
Options:
--session TEXT Session ID or name
--model-name TEXT The name of the model. [required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain models clone-model
Usage: xplain models clone-model [OPTIONS]
Clone an existing model under a new name
Create an identical copy of an existing Noisy-Or model under a different
name. Both the original and the clone remain in the session.
Options:
--session TEXT Session ID or name
--model-name TEXT The name of the model to clone. [required]
--new-model-name TEXT The name for the cloned model (must be different
from modelName). [required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain models close-model
Usage: xplain models close-model [OPTIONS]
Close an open model
Close a model that was previously opened with `openModel`. Frees the
resources associated with the open model view.
Options:
--session TEXT Session ID or name
--model-name TEXT The name of the model to close. [required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain models delete-model
Usage: xplain models delete-model [OPTIONS]
Delete a model from the current session
Delete the model from the current session. Results will be lost if the model
has not been saved. Use `exportModel` to save before deleting.
Options:
--session TEXT Session ID or name
--model-name TEXT The name of the model to delete. [required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain models estimate-causal-graph
Usage: xplain models estimate-causal-graph [OPTIONS]
Estimate the causal graph for a Noisy-Or model
Estimate the causal graph for the specified Noisy-Or model. The causal graph
shows directional relationships between variables in the model. Requires
that the model has been built first with `buildPredictiveModel`.
Options:
--session TEXT Session ID or name
--model-name TEXT The name of the Noisy-Or model. [required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain models evaluate-all-alternatives
Usage: xplain models evaluate-all-alternatives [OPTIONS]
Evaluate all alternative variables for each factor in a model
Search for and evaluate alternative variables for all factors currently in
the Noisy-Or model. Results are stored in the model and shown in the
visualization.
Options:
--session TEXT Session ID or name
--model-name TEXT The name of the model. [required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain models evaluate-model
Usage: xplain models evaluate-model [OPTIONS]
Evaluate a predictive model and return evaluation metrics
Evaluate the predictive performance of an existing model and return model
evaluation results (e.g., AUC, accuracy, confusion matrix).
Options:
--session TEXT Session ID or name
--model-name TEXT The name of the model to evaluate. [required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain models export-model
Usage: xplain models export-model [OPTIONS]
Export a model to a file
Save a model from the current session to a file. Aliases: `saveModel`,
`exportVariableSet`.
Options:
--session TEXT Session ID or name
--model-name TEXT The name of the model to export. Also accepted as
`predictiveModel`. [required]
--file TEXT The destination file. :ref:`schema-
FileDescriptor` (JSON dict) [required]
--file-name TEXT [Deprecated] Deprecated. Use `file` instead.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain models get
xplain models get-independent-variables-of-model
Usage: xplain models get-independent-variables-of-model [OPTIONS]
get the list of independent variables of given predictive model.
Options:
--session TEXT Session ID or name
--model-name TEXT [required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain models get-model-configuration
Usage: xplain models get-model-configuration [OPTIONS]
Get or load a model configuration
Retrieve a model configuration, either from a file or from an existing model
in the session. Returns the configuration JSON. The alias `getModelProposal`
also works.
Options:
--session TEXT Session ID or name
--file TEXT A `.xmodel` or `.xmodelresult` file to load.
:ref:`schema-FileDescriptor` (JSON dict)
--file-name TEXT [Deprecated] Deprecated. Use `file` instead.
--model-name TEXT Name of an existing model in the session.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain models get-model-names
Usage: xplain models get-model-names [OPTIONS]
list all loaded predictive models.
Options:
--session TEXT Session ID or name
--output [json|csv|table] Output format
--help Show this message and exit.
xplain models get-variable-details
Usage: xplain models get-variable-details [OPTIONS]
Retrieve the details of the independent variables for a predictive model.
Options:
--session TEXT Session ID or name
--model-name TEXT [required]
--data-frame TEXT
--output [json|csv|table] Output format
--help Show this message and exit.
xplain models get-variable-list
Usage: xplain models get-variable-list [OPTIONS]
get the list of independent variables of given predictive model.
Options:
--session TEXT Session ID or name
--model-name TEXT [required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain models import-model
Usage: xplain models import-model [OPTIONS]
Import a model from a file into the current session
Load a previously saved model (`.xmodelresult`) from a file into the current
session. The alias `loadModel` also works.
Options:
--session TEXT Session ID or name
--file TEXT The `.xmodelresult` file to import.
:ref:`schema-FileDescriptor` (JSON dict)
[required]
--file-name TEXT [Deprecated] Deprecated. Use `file` instead.
--explanation-generation-file-name TEXT
Optional file containing explanation
generation configuration.
--goal TEXT Optional goal description for explanation
generation.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain models open-model
Usage: xplain models open-model [OPTIONS]
Open a model for interactive exploration
Open an existing model in the session for interactive exploration and
visualization.
Options:
--session TEXT Session ID or name
--model-name TEXT The name of the model to open. [required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain models propose-model-configuration
Usage: xplain models propose-model-configuration [OPTIONS]
Generate a model configuration proposal from minimal parameters
Generate a basic causal discovery model configuration from as few parameters
as possible. All further parameters are proposed or set to default values.
This serves as a starting point for further refining the configuration. The
returned configuration can be saved to a `.xmodel` file and passed to
`buildPredictiveModel` for the actual model building.
Options:
--session TEXT Session ID or name
--model-name TEXT Mandatory name of the model. [required]
--model-object TEXT Mandatory name of the model object (the entity
for which the statistical model is built).
[required]
--target-object TEXT Name of the target object. If not given, defaults
to `modelObject`.
--search-objects TEXT Optional list of object names to search for
causal factors. If not given, all objects are
searched. (JSON array)
--process-time-scale TEXT Time scale of the process when explaining an
event where the target object is a sub-object of
the model object. Possible values: NANOSECOND,
MILLISECOND, SECOND, MINUTE, HOUR, DAY (default),
WEEK, MONTH, QUARTER, HALFYEAR, YEAR, DECADE,
CENTURY.
--file TEXT If given, the proposed configuration is persisted
to this file. :ref:`schema-FileDescriptor` (JSON
dict)
--exclude TEXT Elements to exclude from the model (list of
XElementPath). (JSON array)
--output [json|csv|table] Output format
--help Show this message and exit.
xplain models refit-model
Usage: xplain models refit-model [OPTIONS]
Refit an existing model with current data
Re-run the model fitting procedure on the current data. Useful after
selections have changed or after adding/removing variables.
Options:
--session TEXT Session ID or name
--model-name TEXT The name of the model which will be re-
fitted. [required]
--significance FLOAT A new significance threshold. If not given,
the previous significance will be used.
--fix-existing-variables / --no-fix-existing-variables
If true, the existing variables will not be
pruned.
--target-time-range TEXT If given, used as a new target time frame.
Must be a selection on the target time
dimension of the original model. If
provided, `newModelName` is mandatory.
:ref:`schema-SelectionUIModel` (JSON dict)
--new-model-name TEXT The name of the new re-fitted model.
Mandatory if `targetTimeRange` is given.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain models reject-factors
Usage: xplain models reject-factors [OPTIONS]
Reject specified factors from a Noisy-Or model
Reject (remove) specific factors from a Noisy-Or model and optionally search
for alternatives. Factors can be specified by name or all can be rejected at
once.
Options:
--session TEXT Session ID or name
--model-name TEXT The name of the Noisy-Or model. [required]
--ignore-events TEXT List of factor/event names to reject. Also
accepted as `ignoreFactors`. (JSON array)
--ignore-all-factors / --no-ignore-all-factors
If true, all current factors are rejected.
--find-alternatives-for TEXT List of factor names for which to search
alternatives after rejection. (JSON array)
--keep-history-point / --no-keep-history-point
Whether to keep a history point before
rejection.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain models reject-factors-recursively
Usage: xplain models reject-factors-recursively [OPTIONS]
Recursively reject factors and search for alternatives
Iteratively rejects indirect factors in a Noisy-Or model based on a
likelihood ratio threshold, cycling until no more factors qualify for
rejection. Optionally writes observations to a file and prunes/refits the
final variable set.
Options:
--session TEXT Session ID or name
--model-name TEXT The name of the Noisy-Or model. [required]
--indirect-factorslikelihood-ratio-limit FLOAT
Likelihood ratio threshold for rejecting
indirect factors. Factors with a ratio below
this value are rejected.
--max-indirect-factors-search-cycles INTEGER
Maximum number of rejection cycles. No limit
if not given.
--observations-file TEXT Optional file to write observations data to.
--prune-and-refit-final-variable-set / --no-prune-and-refit-final-variable-set
Whether to prune and refit the final
variable set.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain models run-discovery-bot
Usage: xplain models run-discovery-bot [OPTIONS]
Run the automated discovery bot
Run the automated causal discovery bot, which performs a systematic analysis
comparing different model configurations and suggesting improvements.
Options:
--session TEXT Session ID or name
--config-file TEXT The bot configuration file (of type
XCD_BOT_CONFIG). :ref:`schema-FileDescriptor`
(JSON dict) [required]
--assumed-current-time TEXT Optional assumed current time for the bot run
(ISO-8601 or similar parseable time string). If
not given, the actual current time is used.
--charset TEXT Optional character set for the CSV result log
file. Defaults to the session's default CSV
export charset.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain models save-model-configuration
Usage: xplain models save-model-configuration [OPTIONS]
Save a model's current configuration to a file
After computing a Causal Discovery model, the final result holds information
about causal factors found and the causal graph. The result file also holds
the original configuration to which changes may have been made during the
model building process. Using `saveModelConfiguration`, you can save the
final configuration to use it as a starting point in a new Causal Discovery
run. All result fields are cleared in the saved output.
Options:
--session TEXT Session ID or name
--model-name TEXT The name of the model for which to save the
configuration. The model must be loaded in the
current session. Can also be specified as
`predictiveModel`. [required]
--file TEXT The file descriptor where the configuration
should be written. :ref:`schema-FileDescriptor`
(JSON dict) [required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain models search-for-new-factors
Usage: xplain models search-for-new-factors [OPTIONS]
Search for new causal factors in a model
Perform a search for new causal factors not yet in the model. This expands
the variable set by looking for additional predictors.
Options:
--session TEXT Session ID or name
--model-name TEXT The name of the existing model to refit and
compare against. [required]
--new-model-name TEXT The name of the new model used as the comparison
target. [required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain models select-factor
Usage: xplain models select-factor [OPTIONS]
Select a factor in a predictive model
Mark a factor as selected in the specified model. Selected factors are
highlighted in the model visualization and can be used for targeted
analysis.
Options:
--session TEXT Session ID or name
--model-name TEXT The name of the model. [required]
--factor TEXT The name of the factor to select. [required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain models set-causal-relation
Usage: xplain models set-causal-relation [OPTIONS]
Set the causal relation type for variables in a model
Set the causal relation type (e.g., CAUSAL, ANTICAUSAL, SPURIOUS) for
specific variables or all variables in a Noisy-Or model.
Options:
--session TEXT Session ID or name
--model-name TEXT The name of the model. [required]
--causal-relation TEXT The causal relation type to assign. Possible
values depend on the `CausalRelationType` enum
(e.g., CAUSAL, ANTICAUSAL, SPURIOUS). [required]
--variables TEXT List of variable names to set the relation for.
If not given, all variables are updated. (JSON
array)
--output [json|csv|table] Output format
--help Show this message and exit.
xplain models set-model-configuration
Usage: xplain models set-model-configuration [OPTIONS]
Set configuration parameters for an existing model
Update configuration parameters for an existing model in the current
session. Currently supports setting the `eventSpace` for Noisy-Or models.
Options:
--session TEXT Session ID or name
--model-name TEXT The name of the model to configure. [required]
--event-space TEXT The event space definition for Noisy-Or models.
:ref:`schema-SelectionUIModel` (JSON array)
--output [json|csv|table] Output format
--help Show this message and exit.
xplain data
Object management, file import/export, sampling, and user data.
31 commands:
xplain data add-object — Load an XTable for a sub-object and add it to an existing object
xplain data clear-user-data — Clear all user data from the session
xplain data copy-table — Copy a table or subset to a new XTable
xplain data download-result — download a file from result directory of server and save it to.
xplain data export-feature-table — Export a feature table for machine learning
xplain data export-results — Export query results to a file
xplain data gen-xtable — gen_xtable.
xplain data get-definition — Get the definition for a session element
xplain data list-analyses — List available xanalysis configurations.
xplain data list-existing-analyses — List available xanalysis configurations.
xplain data list-files — Lists files with the specified ownership and type.
xplain data load-object — Load an XTable for an object from a file
xplain data load-result-file-as-df — Load a file from the session as a pandas DataFrame.
xplain data post-file-download — Triggers the flat table download functionality in XOE.
xplain data put-user-data — Store custom JSON data in the session or a request
xplain data read-file — Reads the specified file.
xplain data remove-object — Remove a sub-object from the session
xplain data remove-object-if-exists — Remove a sub-object if it exists (no error if missing)
xplain data run-export-requests — Run a set of export requests and write results to a directory
xplain data save-as-csv — Save data as a CSV file
xplain data save-selected-instances — Save currently selected instances to a file
xplain data save-selected-root-object-keys — Save the keys of selected root object instances to a file
xplain data set-definition — Set a definition for a session element
xplain data set-user-data — Store custom JSON data (deprecated, use putUserData)
xplain data start-sampling — Start sampling mode for the session
xplain data stop-sampling — Stop sampling mode and return to full data
xplain data store-user-data — Store custom JSON data (deprecated, use putUserData)
xplain data swap-data — Swap the underlying data of an existing object with data from a file
xplain data upload-data — upload the file from current local directory to data directory on.
xplain data upload-xmodel — Upload an .xmodel configuration file to the server’s public model store.
xplain data validate-db — Validates a database connection configuration.
xplain data add-object
Usage: xplain data add-object [OPTIONS]
Load an XTable for a sub-object and add it to an existing object
Load an XTable for a sub-object from a file and add it to the given parent
object. The new object is appended to the parent in the object hierarchy.
Options:
--session TEXT Session ID or name
--file TEXT The file descriptor of the XTable file where
the object has been persisted. :ref:`schema-
FileDescriptor` (JSON dict) [required]
--parent-object TEXT The name of the parent object. [required]
--data-load-method TEXT The data load method, either
"LOAD_VIA_MAPPED_BYTE_BUFFERS" or
"LOAD_VIA_READ_METHOD". One of:
``LOAD_VIA_MAPPED_BYTE_BUFFERS``,
``LOAD_VIA_READ_METHOD``.
--remove-mapped-byte-buffers-after-loading / --no-remove-mapped-byte-buffers-after-loading
Decides whether the mapped byte buffers
should be removed after loading the data.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain data clear-user-data
Usage: xplain data clear-user-data [OPTIONS]
Clear all user data from the session
Removes all custom user data that was previously stored in the session via
`putUserData`. This clears the entire `userData` map.
Options:
--session TEXT Session ID or name
--output [json|csv|table] Output format
--help Show this message and exit.
xplain data copy-table
Usage: xplain data copy-table [OPTIONS]
Copy a table or subset to a new XTable
Copy a table (or a subset according to current selections) and save it as a
new XTable and/or add the subset into the current object model. Use cases
include: - Cutting a subset from a large table for faster analysis - Pulling
a randomized sample for debugging (without exposing raw customer data)
**Note:** Only physical dimensions of the underlying XTable can be copied
(aggregation dimensions cannot be copied). If the subset is used in an
analysis, it must be regenerated before the analysis can be reloaded.
Options:
--session TEXT Session ID or name
--source-object TEXT The object from which to generate a copy.
[required]
--new-table-name TEXT The name of the new XTable / XObject.
Defaults to `<sourceObject> - Copy` if not
given.
--new-table-file-name TEXT File name where the new XTable will be
written. If not given, the table is not
persisted. Must include the `.xtable`
extension.
--add-as-sub-object / --no-add-as-sub-object
If true, the new table is immediately added
into the object tree.
--dimensions-to-copy TEXT If given, only these dimensions are copied.
(JSON array)
--sampling-factor INTEGER If given, only every N-th root object is
written (sampling at root level).
--dimensions-to-randomize TEXT Values in these dimensions are randomly
scrambled. (JSON array)
--randomize-all / --no-randomize-all
If true, all values are randomly scrambled.
--package-size INTEGER The package size for the new table.
--conversions TEXT Optional mapping of dimension names to
target data types for type conversion. (JSON
dict)
--sort-dimension TEXT Optional dimension name to sort by.
--segments-group-by TEXT Required when sortDimension is given. A one-
dimensional group-by JSON object that
defines the segments used for sorting. (JSON
dict)
--others-segment-name TEXT Optional name for the "others" segment when
sortDimension is used.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain data download-result
Usage: xplain data download-result [OPTIONS]
download a file from result directory of server and save it to.
Options:
--session TEXT Session ID or name
--filename TEXT [required]
--save-as TEXT [required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain data export-feature-table
Usage: xplain data export-feature-table [OPTIONS]
Export a feature table for machine learning
Export a feature table (flat table of features) derived from the current
object model, suitable for use in external machine learning workflows.
Options:
--session TEXT Session ID or name
--root-dimensions TEXT List of root dimension names to include. If
not given, all root dimensions are exported.
To export no root dimensions, pass an empty
array. (JSON array)
--aggregation-variable-set TEXT
A variable set JSON object specifying
aggregation dimensions to include as
features. (JSON dict)
--constrain-aggregations-to-current-selections / --no-constrain-aggregations-to-current-selections
If true, aggregations are constrained to the
current global selections.
--encode-names / --no-encode-names
If true, dimension names are encoded
(anonymized) in the output.
--file-name TEXT Output file name. Defaults to "Feature
Table.csv" if not given.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain data export-results
Usage: xplain data export-results [OPTIONS]
Export query results to a file
Export the results of the current requests/queries to a file (e.g., Excel or
CSV). The exact parameters depend on the configuration of the export.
Options:
--session TEXT Session ID or name
--request-names TEXT The names of the requests to be exported.
(JSON array) [required]
--result-xls TEXT The name of the result (Excel) file.
[required]
--template-xls TEXT The filename of an Excel template.
--sheet-names TEXT An optional array of names, one for each
request. If given, those names are used as
sheetNames instead of the request names.
(JSON array)
--column-headers TEXT The array of column names overwrites the
default column headers in the result Excel
file. (JSON dict)
--use-display-names / --no-use-display-names
Signals whether the display names of the
states shall be used in the Excel file
instead of the technical state names.
--ignore-zero-result-lines / --no-ignore-zero-result-lines
Result lines (aggregation cells) where all
exported measures are 0 are omitted.
--fix-invalid-sheet-name / --no-fix-invalid-sheet-name
Fix invalid sheet names if for instance the
name is longer than 31 characters or
contains forbidden characters like colon
(:), backslash, asterisk (*), question mark
(?), slash (/) or square brackets ([,]), or
if it starts or ends with a single quote
character ('). Otherwise, an exception is
thrown with an appropriate error message.
--excel-fonts TEXT A mapping of self-defined font names to font
setting objects, each of which may contain
the entries "bold", "italic", "strikeout"
(all boolean), "underlineStyleIndex" (byte),
"colorIndex", "themeColor" (short),
"fontName" (string), "fontFamilyIndex"
(integer), "fontHeight" (double), and
"typeOffset" (short). (JSON dict)
--excel-cell-styles TEXT A mapping of self-defined cell style names
to cell style setting objects, each of which
may contain the entries "dataFormatIndex",
"indentation" (short), "font" (string),
"horizontalAlignment", "verticalAlignment",
"rotation" (short), "fillPattern",
"fillBackgroundColor", "fillForegroundColor"
(short), border style and color entries,
"hidden", "locked", "quotePrefixed",
"shrinkToFit", "wrapText" (boolean). (JSON
dict)
--map-request-to-excel-header-cell-styles TEXT
A mapping from request names to arrays of
cell style names for the header cells. (JSON
dict)
--map-request-to-excel-data-cell-styles TEXT
A mapping from request names to arrays of
cell style names for the data cells. (JSON
dict)
--output [json|csv|table] Output format
--help Show this message and exit.
xplain data gen-xtable
Usage: xplain data gen-xtable [OPTIONS]
gen_xtable.
Options:
--session TEXT Session ID or name
--data TEXT [required]
--xtable-config TEXT [required]
--file-name TEXT [required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain data get-definition
Usage: xplain data get-definition [OPTIONS]
Get the definition for a session element
Retrieve the JSON definition associated with a specific element in the
session. One of the arguments `dimension`, `attribute` or `request`
(alternatively `query`) needs to be given.
Options:
--session TEXT Session ID or name
--dimension TEXT The dimension for which to get definitions
specified as an XElementPath ({object: <...>,
dimension: <...>}). :ref:`schema-XElementPath`
(JSON dict)
--attribute TEXT The attribute for which to get definitions
specified as an XElementPath ({object: <...>,
dimension: <...>, attribute: <...>}).
:ref:`schema-XElementPath` (JSON dict)
--request TEXT The name/ID of the request for which to get
definitions.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain data list-analyses
Usage: xplain data list-analyses [OPTIONS]
List available xanalysis configurations.
Options:
--session TEXT Session ID or name
--output [json|csv|table] Output format
--help Show this message and exit.
xplain data list-existing-analyses
Usage: xplain data list-existing-analyses [OPTIONS]
List available xanalysis configurations.
Options:
--session TEXT Session ID or name
--output [json|csv|table] Output format
--help Show this message and exit.
xplain data list-files
Usage: xplain data list-files [OPTIONS]
Lists files with the specified ownership and type.
Options:
--session TEXT Session ID or name
--ownership TEXT [required]
--file-type TEXT [required]
--file-extension TEXT
--output [json|csv|table] Output format
--help Show this message and exit.
xplain data load-object
Usage: xplain data load-object [OPTIONS]
Load an XTable for an object from a file
Load the XTable for an object from a file into the current session. The
loaded object becomes the root object of the session.
Options:
--session TEXT Session ID or name
--file TEXT The file descriptor of the file where the
object has been persisted. :ref:`schema-
FileDescriptor` (JSON dict) [required]
--data-load-method TEXT Data load method to use. One of:
``LOAD_VIA_MAPPED_BYTE_BUFFERS``,
``LOAD_VIA_READ_METHOD``.
--remove-mapped-byte-buffers-after-loading / --no-remove-mapped-byte-buffers-after-loading
Whether to remove mapped byte buffers after
loading.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain data load-result-file-as-df
Usage: xplain data load-result-file-as-df [OPTIONS]
Load a file from the session as a pandas DataFrame.
Options:
--session TEXT Session ID or name
--filename TEXT [required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain data post-file-download
Usage: xplain data post-file-download [OPTIONS]
Triggers the flat table download functionality in XOE.
Options:
--session TEXT Session ID or name
--file-name TEXT [required]
--file-type TEXT [required]
--ownership TEXT
--team TEXT
--user TEXT
--delete-after-download TEXT
--output [json|csv|table] Output format
--help Show this message and exit.
xplain data put-user-data
Usage: xplain data put-user-data [OPTIONS]
Store custom JSON data in the session or a request
Add custom data in terms of a JSON document to the current session or
specifically to a named request. Data is stored under a key and later
retrieved from the `userData` property in the session JSON. Typically used
by clients to persist additional formatting or UI state information
alongside the session. When saving an analysis, user data is persisted with
it and restored on reload. The synonyms `storeUserData` and `setUserData`
also work (deprecated, prefer `putUserData`). The parameter `key` can
alternatively be named `userKey`, and `data` can alternatively be named
`jsonObject`.
Options:
--session TEXT Session ID or name
--key TEXT The key under which data are stored. Can also be
named `userKey`. [required]
--data TEXT The data to be stored as a JSON object. Can also
be named `jsonObject`. (JSON dict)
--request TEXT Optional request ID. If given, the data is
attached to that specific request rather than the
session. Can also be named `xElement` or
`xArtifact`.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain data read-file
Usage: xplain data read-file [OPTIONS]
Reads the specified file.
Options:
--session TEXT Session ID or name
--ownership TEXT [required]
--file-type TEXT [required]
--file-path TEXT [required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain data remove-object
Usage: xplain data remove-object [OPTIONS]
Remove a sub-object from the session
Remove a sub-object (and all its associated dimensions and attributes) from
the current session. Throws an error if the object does not exist.
Options:
--session TEXT Session ID or name
--object TEXT The name of the object to be deleted. [required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain data remove-object-if-exists
Usage: xplain data remove-object-if-exists [OPTIONS]
Remove a sub-object if it exists (no error if missing)
Like removeObject but does not throw an error if the object does not exist.
Safe to call in scripts where object existence is not guaranteed.
Options:
--session TEXT Session ID or name
--object TEXT The name of the object to be deleted. [required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain data run-export-requests
Usage: xplain data run-export-requests [OPTIONS]
Run a set of export requests and write results to a directory
Execute a batch of export requests and write their results to a result
directory. Each export request specifies what to export and in what format.
Options:
--session TEXT Session ID or name
--result-directory-name TEXT The name of the directory where result files
are written. [required]
--export-requests TEXT Array of export request definitions
(alternative to exportRequestsFile). (JSON
array)
--export-requests-file TEXT File name of a config file containing export
request definitions (alternative to
exportRequests).
--replacements TEXT Key-value pairs for placeholder substitution
in export templates. (JSON dict)
--output [json|csv|table] Output format
--help Show this message and exit.
xplain data save-as-csv
Usage: xplain data save-as-csv [OPTIONS]
Save data as a CSV file
Save the specified data (based on current selections and/or requests) as a
CSV file. The deprecated alias `exportAsCSV` also works.
Options:
--session TEXT Session ID or name
--elements TEXT The elements (objects, dimensions and
attributes) which should be written into the
resulting JSON documents. (JSON array)
[required]
--keys TEXT An array of root object keys which can be
used to constrain written data to only those
keys. (JSON array)
--file TEXT The file descriptor of the destination (csv)
file. If left void the keys will be written
to a public file with name "Flat Table
Export.csv". :ref:`schema-FileDescriptor`
(JSON dict)
--file-name TEXT [Deprecated] (Deprecated) The filename
parameter for the csv file.
--charset TEXT The name of the character set for encoding
the csv file (e.g., "UTF-8", "ISO-8859-1",
"US-ASCII").
--outer-join / --no-outer-join If set to true, the export will implement an
outer join logic, i.e., if an object
instance does not have data for one its sub-
objects specified in the export, then
nevertheless one line is written for such an
object where data for missing sub-objects
are coded as null.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain data save-selected-instances
Usage: xplain data save-selected-instances [OPTIONS]
Save currently selected instances to a file
Save all instances (rows) that are currently selected by the global
selections to a file. The output can be used to extract a subset of the data
for further analysis.
Options:
--session TEXT Session ID or name
--file-name TEXT Name of the file. [required]
--split INTEGER If a number > 1 is given, data will be split into
multiple files.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain data save-selected-root-object-keys
Usage: xplain data save-selected-root-object-keys [OPTIONS]
Save the keys of selected root object instances to a file
Save the primary keys of all currently selected root object instances to a
file. Useful for identifying and exporting a specific cohort.
Options:
--session TEXT Session ID or name
--file-name TEXT The name of the csv file. If left void the keys
will be written to the file with name "Selected
Root Object Keys.csv".
--output [json|csv|table] Output format
--help Show this message and exit.
xplain data set-definition
Usage: xplain data set-definition [OPTIONS]
Set a definition for a session element
Set a JSON definition associated with a specific element in the session.
Definitions are used for storing structured metadata about dimensions or
attributes. Currently only supported for dimensions (aggregation dimensions,
relative time axis, rank dimensions, selection dimensions, and linear sum
dimensions).
Options:
--session TEXT Session ID or name
--dimension TEXT The dimension for which to get definitions
specified as an XElementPath ({object: <...>,
dimension: <...>}). :ref:`schema-XElementPath`
(JSON dict) [required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain data set-user-data
Usage: xplain data set-user-data [OPTIONS]
Store custom JSON data (deprecated, use putUserData)
Deprecated synonym for `putUserData`. Use `putUserData` instead.
Options:
--session TEXT Session ID or name
--key TEXT See API documentation. [required]
--data TEXT See API documentation. (JSON dict)
--request TEXT See API documentation.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain data start-sampling
Usage: xplain data start-sampling [OPTIONS]
Start sampling mode for the session
Activates sampling mode on the session. In sampling mode, computations are
performed on a sample of the data rather than the full dataset, allowing for
faster interactive exploration. Use `stopSampling` to deactivate.
Options:
--session TEXT Session ID or name
--sample-size INTEGER The sample size in 1 of 1000, i.e. sampleSize=10
means a 1% sample. This parameter needs to be >0
and <1000.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain data stop-sampling
Usage: xplain data stop-sampling [OPTIONS]
Stop sampling mode and return to full data
Deactivates sampling mode. Subsequent computations will use the full dataset
again.
Options:
--session TEXT Session ID or name
--output [json|csv|table] Output format
--help Show this message and exit.
xplain data store-user-data
Usage: xplain data store-user-data [OPTIONS]
Store custom JSON data (deprecated, use putUserData)
Deprecated synonym for `putUserData`. Use `putUserData` instead.
Options:
--session TEXT Session ID or name
--key TEXT See API documentation. [required]
--data TEXT See API documentation. (JSON dict)
--request TEXT See API documentation.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain data swap-data
Usage: xplain data swap-data [OPTIONS]
Swap the underlying data of an existing object with data from a file
Replace the data of an already-loaded object with data from a different
XTable file. The object structure (dimensions, attributes) is preserved;
only the raw data changes.
Options:
--session TEXT Session ID or name
--swap-object TEXT The object where data should be swapped.
--table-file-name TEXT Name of the xtable file with the new data. If you
use this parameter it is assumed that the file is
in the public area. To specify the ownership
explicitly use the "file" parameter.
--file TEXT Fully qualified file descriptor instead of the
parameter tableFileName (see example).
:ref:`schema-FileDescriptor` (JSON dict)
--swap-object-list TEXT An array of objects to be swapped, each with the
parameters swapObject and tableFileName/file (see
example). (JSON array)
--output [json|csv|table] Output format
--help Show this message and exit.
xplain data upload-data
Usage: xplain data upload-data [OPTIONS]
upload the file from current local directory to data directory on.
Options:
--session TEXT Session ID or name
--file-name TEXT [required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain data upload-xmodel
Usage: xplain data upload-xmodel [OPTIONS]
Upload an .xmodel configuration file to the server's public model store.
Options:
--session TEXT Session ID or name
--model-or-path TEXT [required]
--filename TEXT
--ownership TEXT
--output [json|csv|table] Output format
--help Show this message and exit.
xplain data validate-db
Usage: xplain data validate-db [OPTIONS]
Validates a database connection configuration.
Options:
--session TEXT Session ID or name
--db-connection-config TEXT [required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain config
Server settings, performance tuning, diagnostics, and session management.
44 commands:
xplain config cache-aggregation-dimensions — Cache aggregation dimensions
xplain config configure-garbage-collections — Configure when explicit garbage collections are performed
xplain config disable-caching — Disable caching for aggregation dimensions
xplain config drop-aggregation-dimension-caches — Drop all aggregation dimension caches
xplain config enable-caching — Enable caching for aggregation dimensions
xplain config evaluate-performance — Measure server performance across different thread counts
xplain config execute-batch — Execute multiple method calls in one batch
xplain config execute-script — Execute multiple method calls (synonym for executeBatch)
xplain config gc — Invoke garbage collection
xplain config get-analysis — Get the analysis as a JSON document (without loading it)
xplain config get-caching-enabled — Get whether caching is currently enabled
xplain config get-messages — Get current session messages
xplain config get-progress — Get progress information about running jobs
xplain config get-recent-execution-statistics — Get statistics from the most recent computation
xplain config get-session — Get the current session state as JSON
xplain config kill-tasks — Kill all currently running computation tasks
xplain config load-analysis — Load a previously saved analysis into the current session
xplain config output-x-table-statistics — Get XTable memory and structure statistics
xplain config print-error — Print the last error message.
xplain config print-last-stack-trace — Print the stack trace of the last error.
xplain config refresh — synchronize the session content with the backend.
xplain config resource-usage — Get memory and resource usage information
xplain config resume-analysis — Resume a previously saved analysis (load without recomputing)
xplain config run-x-object-diagnostics — Run diagnostics on the XObject tree
xplain config save-analysis — Save the current analysis session to a file
xplain config save-call-log — Save the current call log to a file
xplain config set-default-broadcast — set default broadcast behaviour so that other xplain client sharing.
xplain config set-description — Set the session description
xplain config set-enable-hot-swap — Set whether hot-swap (data swapping) is allowed
xplain config set-format — Set the format string for a dimension
xplain config set-max-nr-instances-for-ranking — Set the maximum number of instances for ranking
xplain config set-max-one-dim-group-by-size — Set the maximum size of a one-dimensional group-by
xplain config set-max-threads — Set the global maximum number of parallel threads
xplain config set-max-threads-for-session — Set the maximum number of threads for this session
xplain config set-memory-parameters — Set memory management parameters
xplain config set-results-format — Set the results format for this session
xplain config set-tasks-per-thread — Set the number of tasks per thread
xplain config start-call-logging — Start logging all API method calls
xplain config stop-call-logging — Stop logging API method calls and clear the call log
xplain config terminate-computation — Request graceful termination of the current computation
xplain config validate-x-table — Validate an XTable
xplain config Drop
xplain config Get
xplain config Set
xplain config cache-aggregation-dimensions
Usage: xplain config cache-aggregation-dimensions [OPTIONS]
Cache aggregation dimensions
Caches all aggregation dimensions which are currently not cached (and which
do not have floating semantics). An optional list of specific dimensions can
be provided; if not given, all eligible aggregation dimensions will be
considered.
Options:
--session TEXT Session ID or name
--dimensions TEXT Optional list of specific dimensions to cache. If
not given, all eligible aggregation dimensions
are cached. :ref:`schema-XElementPath` (JSON
array)
--output [json|csv|table] Output format
--help Show this message and exit.
xplain config configure-garbage-collections
Usage: xplain config configure-garbage-collections [OPTIONS]
Configure when explicit garbage collections are performed
Configure when to perform additional/explicit garbage collections during
various lifecycle phases of data import and startup.
Options:
--session TEXT Session ID or name
--gc-before-import / --no-gc-before-import
Whether to GC before data import.
--gc-during-import-before-mapping-packages / --no-gc-during-import-before-mapping-packages
Whether to GC during import before mapping
package start positions.
--gc-after-import / --no-gc-after-import
Whether to GC after data import.
--gc-before-startup / --no-gc-before-startup
Whether to GC before running a startup
configuration.
--gc-after-startup / --no-gc-after-startup
Whether to GC after running a startup
configuration. If enabled, the GC is run
before the startup script.
--gc-after-startup-script / --no-gc-after-startup-script
Whether to GC after running a startup
script.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain config disable-caching
Usage: xplain config disable-caching [OPTIONS]
Disable caching for aggregation dimensions
Sets the flag `cachingEnabled = false`. As a result, aggregation dimensions
built henceforth will not be cached any more.
Options:
--session TEXT Session ID or name
--output [json|csv|table] Output format
--help Show this message and exit.
xplain config drop-aggregation-dimension-caches
Usage: xplain config drop-aggregation-dimension-caches [OPTIONS]
Drop all aggregation dimension caches
Drops all existing caches of aggregation dimensions, freeing memory. After
this call, aggregation dimensions will need to be recomputed on next use.
Options:
--session TEXT Session ID or name
--output [json|csv|table] Output format
--help Show this message and exit.
xplain config enable-caching
Usage: xplain config enable-caching [OPTIONS]
Enable caching for aggregation dimensions
Sets the flag `cachingEnabled = true`. As a result, aggregation dimensions
built henceforth will be cached, improving performance for repeated queries.
Options:
--session TEXT Session ID or name
--output [json|csv|table] Output format
--help Show this message and exit.
xplain config evaluate-performance
Usage: xplain config evaluate-performance [OPTIONS]
Measure server performance across different thread counts
Measures the server performance by executing a given method call with
different `maxThreads` values and comparing the results. The output is
stored in an Excel file which can be downloaded via:
`<host>:<port>/downloadfile?type=RESULT&filename=performance.xlsx`
Options:
--session TEXT Session ID or name
--threads TEXT The list of maxThreads values to test. (JSON
array) [required]
--method-call TEXT The method call to benchmark. (JSON dict)
[required]
--file-name TEXT Output Excel filename.
--repeats INTEGER Number of repeats per thread count to average
measurements.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain config execute-batch
Usage: xplain config execute-batch [OPTIONS]
Execute multiple method calls in one batch
Execute multiple requests in one batch. Provide either an inline array of
method calls or a reference to a script file. The synonym `executeScript`
also works. Example with inline calls: { "methodCalls": [ { "method":
"deleteAllRequests" }, { "method": "executeRequest", "request": { ... } } ]
} See also the synonym `executeScript`.
Options:
--session TEXT Session ID or name
--file TEXT The file descriptor of a script file to
execute. Either `file`, `fileName`,
`methodCalls`, or `script` must be provided.
:ref:`schema-FileDescriptor` (JSON dict)
--file-name TEXT [Deprecated] Deprecated. Use `file` instead.
--method-calls TEXT Array of method call objects to execute in
sequence. Each object should have a `method`
field plus any required parameters. (A
synonym is `script`.) (JSON array)
--script TEXT Synonym for `methodCalls`. (JSON array)
--recompute-requests-after-batch / --no-recompute-requests-after-batch
Signals whether the requests should be
recomputed after executing the batch.
--execute-in-batch-mode / --no-execute-in-batch-mode
Work in batch mode.
--terminate-on-exception / --no-terminate-on-exception
Decides whether the run is cancelled after
an exception.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain config execute-script
Usage: xplain config execute-script [OPTIONS]
Execute multiple method calls (synonym for executeBatch)
A synonym for `executeBatch`. Execute multiple requests in one batch. Prefer
using `executeBatch` instead.
Options:
--session TEXT Session ID or name
--file TEXT :ref:`schema-FileDescriptor` (JSON dict)
--file-name TEXT [Deprecated]
--method-calls TEXT See API documentation. (JSON array)
--script TEXT See API documentation. (JSON array)
--recompute-requests-after-batch / --no-recompute-requests-after-batch
See API documentation.
--execute-in-batch-mode / --no-execute-in-batch-mode
See API documentation.
--terminate-on-exception / --no-terminate-on-exception
See API documentation.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain config gc
Usage: xplain config gc [OPTIONS]
Invoke garbage collection
Invokes `System.gc()` to request a JVM garbage collection. The JVM is not
guaranteed to immediately perform a full GC, but this signals the intent.
Options:
--session TEXT Session ID or name
--output [json|csv|table] Output format
--help Show this message and exit.
xplain config get-analysis
Usage: xplain config get-analysis [OPTIONS]
Get the analysis as a JSON document (without loading it)
Read a previously saved analysis file and return its contents as a JSON
document, without actually loading it into the current session.
Options:
--session TEXT Session ID or name
--file TEXT The file descriptor of the file from where
to pull the JSON content. :ref:`schema-
FileDescriptor` (JSON dict)
--rebuild-all-dimensions-when-loading / --no-rebuild-all-dimensions-when-loading
If set to `true` all dimensions in the
object tree will be added to the required
artefacts script, even if not required for
the current analysis (in any queries or
selections).
--drop-results / --no-drop-results
Optional parameter which may be used to drop
results before returning the analysis as
JSON so to only return the query structure
without results.
--keep-only-artefact-definitions / --no-keep-only-artefact-definitions
Optional parameter which may be used to drop
all data except artefact definitions (e.g.
drop data the user has added to the session,
formatting data of the frontend, ...) before
returning the analysis as JSON.
--get-as-script / --no-get-as-script
Optional parameter: in case this parameter
is set to true, the session/analysis is not
returned in the usual format (with a
requiredArtifactsScript and additional
fields coding the queries and selections),
but one single script is returned which re-
builds just everything. Executing this
script will result in the original analysis
(except any formatting). You may edit this
script to adjust the parameters of this
analysis.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain config get-caching-enabled
Usage: xplain config get-caching-enabled [OPTIONS]
Get whether caching is currently enabled
Returns the current value of the `cachingEnabled` flag.
Options:
--session TEXT Session ID or name
--output [json|csv|table] Output format
--help Show this message and exit.
xplain config get-messages
Usage: xplain config get-messages [OPTIONS]
Get current session messages
Get current messages, for example information on the progress of the
predictive models or on missing states when loading a session. Those
messages are also transmitted as a property of the session document.
Options:
--session TEXT Session ID or name
--clear / --no-clear If true, messages are cleared after being
returned.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain config get-progress
Usage: xplain config get-progress [OPTIONS]
Get progress information about running jobs
Get progress information about running computation jobs. Returns a fraction
of processed load and absolute counts. Special values for `progress`: -
`-1.0`: No tasks are currently registered in the task list. - `-2.0`: A task
exists but total load is 0. Special value `-1` for `processedLoad` and
`totalLoad` indicates an empty task list.
Options:
--session TEXT Session ID or name
--output [json|csv|table] Output format
--help Show this message and exit.
xplain config get-recent-execution-statistics
Usage: xplain config get-recent-execution-statistics [OPTIONS]
Get statistics from the most recent computation
Returns timing and performance statistics from the most recently completed
computation. Returns empty if no computation has been performed yet.
Options:
--session TEXT Session ID or name
--output [json|csv|table] Output format
--help Show this message and exit.
xplain config get-session
Usage: xplain config get-session [OPTIONS]
Get the current session state as JSON
Get the full session as a JSON document. Most method calls return the
session anyway, but this method can be used to retrieve the current session
state without making any changes. Useful when a client has lost its session
state (e.g. after a browser crash) and needs to re-sync. An alternative
method name `getSessionModel` is also accepted.
Options:
--session TEXT Session ID or name
--output [json|csv|table] Output format
--help Show this message and exit.
xplain config kill-tasks
Usage: xplain config kill-tasks [OPTIONS]
Kill all currently running computation tasks
Immediately terminates all running computation tasks for this session. Use
`terminateComputation` to request a graceful stop instead.
Options:
--session TEXT Session ID or name
--output [json|csv|table] Output format
--help Show this message and exit.
xplain config load-analysis
Usage: xplain config load-analysis [OPTIONS]
Load a previously saved analysis into the current session
Load a previously saved analysis file into the current session. This
replaces the current session state (objects, dimensions, requests,
selections) with the saved state.
Options:
--session TEXT Session ID or name
--file TEXT The name of the file from which to load.
:ref:`schema-FileDescriptor` (JSON dict)
[required]
--retain TEXT An optional list of dimensions which should not
be re-generated but kept with the existing logic.
(JSON array)
--output [json|csv|table] Output format
--help Show this message and exit.
xplain config output-x-table-statistics
Usage: xplain config output-x-table-statistics [OPTIONS]
Get XTable memory and structure statistics
Returns detailed statistics about the internal structure and memory
consumption of the loaded XTable(s).
Options:
--session TEXT Session ID or name
--indentation-string TEXT Indentation string used for formatting the
output.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain config print-error
Usage: xplain config print-error [OPTIONS]
Print the last error message.
Options:
--session TEXT Session ID or name
--output [json|csv|table] Output format
--help Show this message and exit.
xplain config print-last-stack-trace
Usage: xplain config print-last-stack-trace [OPTIONS]
Print the stack trace of the last error.
Options:
--session TEXT Session ID or name
--output [json|csv|table] Output format
--help Show this message and exit.
xplain config refresh
Usage: xplain config refresh [OPTIONS]
synchronize the session content with the backend.
Options:
--session TEXT Session ID or name
--output [json|csv|table] Output format
--help Show this message and exit.
xplain config resource-usage
Usage: xplain config resource-usage [OPTIONS]
Get memory and resource usage information
Returns detailed memory and resource usage statistics for the current JVM,
including heap memory, non-heap memory, system CPU load, and session
instance counts.
Options:
--session TEXT Session ID or name
--output [json|csv|table] Output format
--help Show this message and exit.
xplain config resume-analysis
Usage: xplain config resume-analysis [OPTIONS]
Resume a previously saved analysis (load without recomputing)
Load a previously saved analysis, restoring the session state including
results as they were when saved, without recomputing requests. Faster than
loadAnalysis when results do not need to be recomputed.
Options:
--session TEXT Session ID or name
--session-data TEXT A session as a JSON object. (JSON dict)
--file TEXT The file descriptor of the analysis file to
resume from. Either `session` or `file` must be
provided. :ref:`schema-FileDescriptor` (JSON
dict)
--retain TEXT An optional list of dimensions which should not
be re-generated but kept with the existing logic.
(JSON array)
--output [json|csv|table] Output format
--help Show this message and exit.
xplain config run-x-object-diagnostics
Usage: xplain config run-x-object-diagnostics [OPTIONS]
Run diagnostics on the XObject tree
Runs a comprehensive diagnostic on the XObject hierarchy and returns a JSON
document with the diagnostic results.
Options:
--session TEXT Session ID or name
--output [json|csv|table] Output format
--help Show this message and exit.
xplain config save-analysis
Usage: xplain config save-analysis [OPTIONS]
Save the current analysis session to a file
Persist the current analysis session (including all loaded objects,
dimensions, requests, selections, and results) to a file for later
retrieval.
Options:
--session TEXT Session ID or name
--file TEXT File descriptor where the analysis should be
saved. If not given, the session is returned
as JSON and can be persisted client-side.
:ref:`schema-FileDescriptor` (JSON dict)
--rebuild-all-dimensions-when-loading / --no-rebuild-all-dimensions-when-loading
If set to true, all dimensions in the object
tree will be rebuilt even if not required
for the current analysis.
--drop-results / --no-drop-results
If set to true, results are dropped before
saving so only the query structure is
persisted.
--keep-only-artefact-definitions / --no-keep-only-artefact-definitions
If set to true, all data except artefact
definitions is dropped before saving.
--output [json|csv|table] Output format
--help Show this message and exit.
xplain config save-call-log
Usage: xplain config save-call-log [OPTIONS]
Save the current call log to a file
Saves all method calls logged since `startCallLogging` was called to the
specified file. The resulting script file can be replayed with
`executeBatch`.
Options:
--session TEXT Session ID or name
--file-name TEXT The file name where the call log should be saved.
[required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain config set-default-broadcast
Usage: xplain config set-default-broadcast [OPTIONS]
set default broadcast behaviour so that other xplain client sharing.
Options:
--session TEXT Session ID or name
--broadcast TEXT [required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain config set-description
Usage: xplain config set-description [OPTIONS]
Set the session description
Set a description for the current session. The description is typically used
to describe the purpose of a session or analysis. The ObjectExplorer shows
this description when clicking the corresponding info icon and allows
editing it as an HTML document.
Options:
--session TEXT Session ID or name
--description TEXT The description text (may contain HTML).
[required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain config set-enable-hot-swap
Usage: xplain config set-enable-hot-swap [OPTIONS]
Set whether hot-swap (data swapping) is allowed
Sets whether the user / the current session allows data swaps (hot-swap).
When enabled, waiting data on the stage will be immediately swapped in.
Options:
--session TEXT Session ID or name
--hot-swap-enabled / --no-hot-swap-enabled
Whether data swaps are allowed (true or
false).
--output [json|csv|table] Output format
--help Show this message and exit.
xplain config set-format
Usage: xplain config set-format [OPTIONS]
Set the format string for a dimension
Sets the format string for the given dimension. All dimensions which inherit
format information will also immediately have this updated format in the
session JSON.
Options:
--session TEXT Session ID or name
--dimension TEXT A JSON object specifying the dimension path (with
`object` and `dimension` properties). (JSON dict)
[required]
--format TEXT The format string. [required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain config set-max-nr-instances-for-ranking
Usage: xplain config set-max-nr-instances-for-ranking [OPTIONS]
Set the maximum number of instances for ranking
Set the maximum number of instances allowed for ranking computations.
Increasing this number might drastically increase runtime when using ranking
resources. Pass `null` to remove the limit.
Options:
--session TEXT Session ID or name
--max-nr-instances-for-ranking INTEGER
The maximum number of instances (or null for
no limit). [required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain config set-max-one-dim-group-by-size
Usage: xplain config set-max-one-dim-group-by-size [OPTIONS]
Set the maximum size of a one-dimensional group-by
Sets the maximum size of a one-dimensional group-by for the current session.
The size of a group-by is the number of distinct states (e.g., if there are
500 different states in the "Product" attribute, the size is 500). This
parameter limits each component of a potentially multi-dimensional group-by,
to avoid transmitting too-large result sets to web-based frontends.
Options:
--session TEXT Session ID or name
--size INTEGER The maximum number of states allowed in a one-
dimensional group-by. [required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain config set-max-threads
Usage: xplain config set-max-threads [OPTIONS]
Set the global maximum number of parallel threads
Sets the global `MAX_PARALLEL_THREADS` value. This affects all sessions on
the server. Use `setMaxThreadsForSession` to limit threads for a specific
session only.
Options:
--session TEXT Session ID or name
--max-threads INTEGER The maximum number of parallel threads.
[required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain config set-max-threads-for-session
Usage: xplain config set-max-threads-for-session [OPTIONS]
Set the maximum number of threads for this session
Sets the maximum number of parallel threads for this specific session only
(does not affect global settings). A value of 0 or negative resets to the
global default.
Options:
--session TEXT Session ID or name
--max-threads INTEGER The maximum number of threads for this session. A
value ≤ 0 resets to the global default.
[required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain config set-memory-parameters
Usage: xplain config set-memory-parameters [OPTIONS]
Set memory management parameters
Configure memory parameters for the Xplain engine. All parameters are
optional; only those provided are updated.
Options:
--session TEXT Session ID or name
--stock-increment-size INTEGER The size increment for stock allocations
(STOCK_INCREMENT_SIZE).
--stock-size-limit INTEGER The upper limit for stock size
(STOCK_SIZE_LIMIT).
--output [json|csv|table] Output format
--help Show this message and exit.
xplain config set-results-format
Usage: xplain config set-results-format [OPTIONS]
Set the results format for this session
Sets the format in which results are returned for the current session. The
alias `setResultFormat` (without the 's') also works.
Options:
--session TEXT Session ID or name
--format TEXT The results format name (e.g., a ResultsFormat
enum value). [required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain config set-tasks-per-thread
Usage: xplain config set-tasks-per-thread [OPTIONS]
Set the number of tasks per thread
Sets the global `TASKS_PER_THREAD` value, controlling how many computation
tasks are assigned to each thread during parallel computation.
Options:
--session TEXT Session ID or name
--tasks-per-thread INTEGER The number of tasks per thread. [required]
--output [json|csv|table] Output format
--help Show this message and exit.
xplain config start-call-logging
Usage: xplain config start-call-logging [OPTIONS]
Start logging all API method calls
Enables logging of all subsequent `executeUserInteraction` calls. Logged
calls can later be saved to a file with `saveCallLog` and replayed with
`executeBatch`. Stop logging with `stopCallLogging`.
Options:
--session TEXT Session ID or name
--output [json|csv|table] Output format
--help Show this message and exit.
xplain config stop-call-logging
Usage: xplain config stop-call-logging [OPTIONS]
Stop logging API method calls and clear the call log
Disables call logging and clears the accumulated call log. Save the log
first with `saveCallLog` if you want to keep it.
Options:
--session TEXT Session ID or name
--output [json|csv|table] Output format
--help Show this message and exit.
xplain config terminate-computation
Usage: xplain config terminate-computation [OPTIONS]
Request graceful termination of the current computation
Sets a flag requesting that the current computation be gracefully
terminated. The computation will stop at the next safe checkpoint. For
immediate termination, use `killTasks` instead.
Options:
--session TEXT Session ID or name
--output [json|csv|table] Output format
--help Show this message and exit.
xplain config validate-x-table
Usage: xplain config validate-x-table [OPTIONS]
Validate an XTable
Validates the integrity of an XTable. Checks consistency of data structures
and reports any errors found.
Options:
--session TEXT Session ID or name
--object TEXT The object whose XTable should be validated.
--print / --no-print Whether to print validation output to the log.
--output [json|csv|table] Output format
--help Show this message and exit.