Appearance
Commands
The Taurec database can be queried and managed using several API commands. The commands are clustered into the following command groups:
Command
| Group | Description |
|---|---|
| Command | Commands are the fundamental units of execution within the API. This group contains commands for creating, editing, and running logic, either individually or in lists. |
| Command Command Group | Command groups allow for the organization of multiple API commands into logical units for batch execution. This group contains commands for creating, editing, and running these groups. |
Database
| Group | Description |
|---|---|
| Database | Databases are managed through their overall lifecycle and state, including creation, loading, and saving. This group contains commands for exporting data and managing database-specific settings and structure. |
| Database Command | Database API commands can be inspected to query information about their usage. This group contains commands for retrieving parameters, output fields, and usage examples. |
| Database Connection | Connections manage the session and connectivity between clients and the database. This group contains commands for establishing connections, verifying status, and monitoring active connections. |
Dimension
| Group | Description |
|---|---|
| Dimension | Dimensions define the structure of data and serve as the master data within the database. This group contains commands for creating, editing, and deleting dimensions, along with data import/export operations. |
| Dimension Distribution | Distributions allow for the weighting of dimension items against each other for allocation and planning. This group contains commands for creating and managing distribution sets and their weights. |
| Dimension Formula | Formulas manage calculated structures consisting of items and sums within a dimension. This group contains commands for defining aggregation logic and maintaining formulas through dedicated operations. |
| Dimension Item | Items are the individual members of a dimension, each uniquely identified by its name. This group contains commands for managing items and their attributes, as well as identifying item usage across the database. |
| Dimension Tree | Trees represent hierarchical structures within a dimension where sums aggregate items and other sums. This group contains commands for building, modifying, and navigating these hierarchies. |
| Dimension Tree Subtree | Subtrees define specific subsets or specialized views of larger tree hierarchies. This group contains commands for creating, exporting, or importing custom tree extracts. |
Global
| Group | Description |
|---|---|
| Global File | Files can be managed within the database directory structure beyond structured data. This group contains commands for directory management, moving files, and reading or writing file content. |
| Global Log | Logging captures operations performed on the database and system for auditing and troubleshooting. This group contains commands for managing log files and inspecting logging configurations. |
| Global Script | Scripts provide a way to implement custom logic and automated calculations using Basic or Pascal syntax. This group contains commands for creating, testing, and executing scripts. |
| Global Text | Text blocks allow for the storage and retrieval of reusable text content for documentation or modular components. This group contains commands for creating, editing, and organizing text blocks. |
| Global Variable | Variables serve as dynamic placeholders that can be referenced within API commands and scripts. This group contains commands for managing variable definitions, including creation and bulk import/export. |
| Global Visual | Visual scripts enable the creation of calculations and KPIs through a graphical interface. This group contains commands for exploring available visual commands and their input parameters. |
Permission
| Group | Description |
|---|---|
| Permission | Permissions control access to various database objects including tables, dimensions, scripts, and files. This group contains commands for defining granular access levels for users and roles. |
| Permission Role | Roles allow for the grouping of permissions and their assignment to multiple users. This group contains commands for creating, copying, and editing roles. |
| Permission User | User accounts are managed to control access and configuration. This group contains commands for creating users, managing passwords, and configuring individual permissions. |
System
| Group | Description |
|---|---|
| System | System information and performance can be monitored and optimized on the database server. This group contains commands for retrieving system details and performing memory optimization. |
Table
| Group | Description |
|---|---|
| Table | Tables, or cubes, are the primary containers for multidimensional data. This group contains commands for managing table structures, data import/export, and metadata inspection. |
| Table Calculation | Calculations represent automated arithmetic processes designed to manipulate and analyze data within tables. This group contains commands for defining calculation logic and executing these processes. |
| Table Calculation Step | Calculations are performed in sequential steps that define the exact order of operations. This group contains commands for managing individual steps and their filters. |
| Table Link | Links facilitate data synchronization between tables to ensure changes are reflected automatically. This group contains commands for creating and managing relational links. |
| Table Record | Records contain the actual data entries identified by a unique combination of dimension items. This group contains commands for manipulating records, including consolidation, copying, and updating data. |
| Table Subtable | Subtables are filtered extracts of a parent table used to define specific data viewpoints. This group contains commands for creating and configuring subtables for query management. |
| Table Tablecalculation | Table calculations incorporate visual scripts for dynamic data transformations and analysis. This group contains commands for managing table calculation definitions and their visual scripts. |