Incorta

https://docs.incorta.com
Admin
Incorta is a data analytics platform that enables users to acquire, enrich, analyze, and act on...
Tokens:580,563
Snippets:9,783
Trust Score:9.8
Update:2 months ago
Show doc for...
Tokens:
Raw
### Download and Initialize Component SDK

Source: https://docs.incorta.com/latest/references-component-sdk-getting-started

Commands to install the SDK globally and start the development environment.

```bash
% npm install -g @incorta-org/create-incorta-component
```

```bash
create-incorta-component
```

--------------------------------

### Copy core-site.xml configuration

Source: https://docs.incorta.com/latest/tools-versioning-migration-tool

Example command to copy the core-site.xml file to the required installation directory.

```bash
cp /incorta/core-site.xml /home/incorta/IncortaAnalytics/cmc/lib/
```

--------------------------------

### Installer Prompts

Source: https://docs.incorta.com/latest/g-aws-ha-incorta-cluster-deploy

Standard responses for the initial installation prompts.

```text
Welcome prompt        : Press ENTER


License Agreement     : Y : (Accept)


Installation Type     : 1 : (New Installation)


Installation Set      : 2 : (Custom Installation)


Incorta HA components : 1 : (Central Management Console (CMC))


Installation Folder   : Press Enter to accept the default directory
```

--------------------------------

### Schema Status Request Examples

Source: https://docs.incorta.com/latest/references-api-schema-status-endpoint-v1

Example URLs for querying schema status on cloud and local cluster installations.

```text
https://my-cluster.cloud.incorta.com/incorta/api/v1/schema/SALES/status
```

```text
https://10.1.2.3:8080/incorta/api/v1/schema/SALES/status
```

--------------------------------

### Unzip Installation Package

Source: https://docs.incorta.com/latest/g-aws-ha-incorta-cluster-upgrade

Extract the installation package and enter the directory.

```bash
unzip incorta-package-<new-version>.zip -d incorta-package-<new-version>/
cd incorta-package-<new-version>
```

--------------------------------

### Install Required Utilities

Source: https://docs.incorta.com/latest/g-aws-ha-incorta-cluster-deploy

Install telnet and expect utilities.

```bash
sudo yum -y install telnet
sudo yum -y install expect
```

--------------------------------

### Installation Status Output

Source: https://docs.incorta.com/latest/g-aws-ha-incorta-cluster-deploy

Expected output upon successful installation.

```text
==============================================================
Installation Status
-------------------
Success! Incorta Analytics has been installed under the
following path:


/home/incorta/IncortaAnalytics/cmc


To access your CMC installation please go to this link.
        http://<HOST_1_Private_IP>:6060/cmc/
```

--------------------------------

### Request URL Examples

Source: https://docs.incorta.com/latest/references-api-list-schema-objects-endpoint-v2

Example URLs for listing objects in the OnlineStore schema.

```text
https://mycluster.incorta.com/incorta/api/v2/default/schema/OnlineStore/list
```

```text
https://10.1.2.3:8080/incorta/api/v2/default/schema/OnlineStore/list
```

--------------------------------

### startsWith() Usage Example

Source: https://docs.incorta.com/latest/references-built-in-functions-boolean-startswith

Example demonstrating how to filter or identify countries starting with specific characters.

```text
startsWith(
    SALES.COUNTRIES.COUNTRY_NAME,
    "a",
    "d",
    "n"
)
```

```text
startsWith(SALES.COUNTRIES.COUNTRY_NAME,"a","d","n")
```

--------------------------------

### Prepare Installation Directory

Source: https://docs.incorta.com/latest/g-aws-ha-incorta-cluster-upgrade

Commands to navigate to tmp and create the installation directory.

```bash
cd /tmp
```

```bash
mkdir incorta-package-<new-version>
```

--------------------------------

### contains() Usage Example

Source: https://docs.incorta.com/latest/references-built-in-functions-boolean-contains

Example usage of the contains() function to identify countries starting with specific characters.

```text
contains(
    SALES.COUNTRIES.COUNTRY_NAME,
    "b",
    "g",
    "s"
)
```

```text
contains(SALES.COUNTRIES.COUNTRY_NAME, "b", "g", "s")
```

--------------------------------

### Prepare Installation Directory

Source: https://docs.incorta.com/latest/g-aws-ha-incorta-cluster-upgrade

Navigate to the temporary directory and prepare the installation package.

```bash
cd /tmp
```

```bash
mkdir incorta-package-<new-version>
```

```bash
unzip incorta-package-<new-version>.zip -d incorta-package-<new-version>
```

--------------------------------

### Locating Dashboard and Insight GUIDs

Source: https://docs.incorta.com/latest/references-api-insight-query-endpoint-v2

Example URL structure showing where to find the dashboard and insight GUIDs in the browser.

```text
https://{cluster_URL}/incorta/#/dashboard/{dashboardGuid}/tab/{tabGuid}/insight/{insightGuid}
```

--------------------------------

### Example Properties File

Source: https://docs.incorta.com/latest/tools-versioning-migration-tool

A sample configuration file used for running the migration tool in unattended mode.

```properties
dbURL=jdbc:mysql://127.0.0.1:3306/incorta_metadata
dbUser=user
dbPassword=1234
tenants=demo
schemas=HR
tablePattern=
backupDate=true
backupPath=
maxThreads=10
```

--------------------------------

### Run the Incorta Installer

Source: https://docs.incorta.com/latest/g-aws-ha-incorta-cluster-upgrade

Execute the installer JAR file to begin the upgrade process.

```bash
cd incorta-package-<new-version>
java -Djdk.util.zip.disableZip64ExtraFieldValidation=true -jar incorta-installer.jar -i console
```

--------------------------------

### subString() Usage Example

Source: https://docs.incorta.com/latest/references-built-in-functions-string-subString

Extracts a substring from the string 'Hello' starting at index 2.

```text
substring("Hello", 2)
```

--------------------------------

### Use sample data

Source: https://docs.incorta.com/latest/tools-tenant-management-tool

Includes sample data when creating a new tenant.

```bash
-s,--sample
```

--------------------------------

### Identify Quarter Start Date from Timestamp

Source: https://docs.incorta.com/latest/references-built-in-functions-conversion-quarterstartdate

Example of using the function with a timestamp string.

```text
quarterStartDate(
timestamp(
"2021-05-20 03:09:11"
)
)
```

--------------------------------

### Identify Quarter Start Date from Date

Source: https://docs.incorta.com/latest/references-built-in-functions-conversion-quarterstartdate

Example of using the function with a date string.

```text
quarterStartDate(
    date(
        "2021-08-17"
    )
)
```

--------------------------------

### Navigate to CSS directory and create file

Source: https://docs.incorta.com/latest/references-customize-incorta-with-css

Commands to switch to the incorta user, set the installation path, and open the custom-new.css file for editing.

```bash
sudo su incorta
INSTALLATION_PATH='/home/incorta/IncortaAnalytics/IncortaNode/runtime/webapps/ROOT/css'
cd $INSTALLATION_PATH
vim custom-new.css
```

--------------------------------

### subString() Usage Example

Source: https://docs.incorta.com/latest/references-built-in-functions-string-subString-exp

Extracts a substring from the input string starting at index 1 for a length of 3.

```text
substring("Hello", 1, 3)
```

--------------------------------

### Prepare Installation Directory

Source: https://docs.incorta.com/latest/g-aws-ha-incorta-cluster-upgrade

Commands to navigate to the temporary directory and extract the new installation package.

```bash
cd /tmp
```

```bash
mkdir incorta-package-<new-version>
```

```bash
unzip incorta-package-<new-version>.zip -d incorta-package-<new-version>/
cd incorta-package-<new-version>
```

--------------------------------

### Calculate Month Start Date from Timestamp

Source: https://docs.incorta.com/latest/references-built-in-functions-conversion-monthstartdate

Example of identifying the beginning of the month for a specific timestamp string.

```sql
monthStartDate(
timestamp(
"2021-07-20 03:09:11"
)
)
```

--------------------------------

### Create system tenant

Source: https://docs.incorta.com/latest/tools-tenant-management-tool

Creates the system-level tenant.

```bash
-cst,--create-system-tenant
```

--------------------------------

### Create new tenant

Source: https://docs.incorta.com/latest/tools-tenant-management-tool

Initializes a new tenant with the specified name.

```bash
-c,--create <tenant name>
```

--------------------------------

### Calculate Month Start Date from Date

Source: https://docs.incorta.com/latest/references-built-in-functions-conversion-monthstartdate

Example of identifying the beginning of the month for a specific date string.

```sql
monthStartDate(
    date(
        "2021-08-17"
    )
)
```

--------------------------------

### Calculate week start date in an insight formula

Source: https://docs.incorta.com/latest/references-built-in-functions-conversion-weekstartdate

Example of using the weekStartDate() function within the Formula Builder for an insight.

```SQL
weekStartDate(TIMESTAMP("2021-07-20 03:09:11"))
```

--------------------------------

### Start Notebook Add-on Service

Source: https://docs.incorta.com/latest/guides-upgrade-to-latest-releases

Execute the start script using the identified Notebook Add-on Service name.

```bash
NOTEBOOK_ADD_ON=<SERVICE_NAME>
<INCORTA_NODE_INSTALLATION_PATH>/IncortaNode/startNotebook.sh ${NOTEBOOK_ADD_ON}
```

--------------------------------

### Configure JAVA_HOME and PATH

Source: https://docs.incorta.com/latest/install-java

Set the JAVA_HOME environment variable to the installation directory and prepend the Java bin directory to the system PATH.

```bash
export JAVA_HOME="<INSTALL_FOLDER>/java/jdk1.8.0_131"
export PATH=”$JAVA_HOME/bin:$PATH"
```

--------------------------------

### Using quarterStartDate() in Formulas

Source: https://docs.incorta.com/latest/references-built-in-functions-date-quarterstartdate

Examples of using the function to retrieve the start date and to filter sales data based on the current quarter.

```text
quarterStartDate()
```

```text
SALES.SALES.TIME_ID > quarterStartDate()
```

--------------------------------

### Run Incorta Installer

Source: https://docs.incorta.com/latest/guides-upgrade-to-latest-releases

Execute the installer in console mode to begin the upgrade process.

```bash
java -Djdk.util.zip.disableZip64ExtraFieldValidation=true -jar incorta-installer.jar -i console
```

--------------------------------

### Grant Spark Metastore Admin Permissions for Existing Installations

Source: https://docs.incorta.com/latest/references-notebook-for-business-users

Use these commands to grant the required CREATE USER permission to the Spark Metastore admin for existing Advanced SQLi setups.

```sql
GRANT CREATE USER ON *.* TO 'SPARK_Metastore_Admin_USER_NAME'@'localhost' WITH GRANT OPTION;  
FLUSH PRIVILEGES;
```

--------------------------------

### Installer Wizard Prompts

Source: https://docs.incorta.com/latest/g-aws-ha-incorta-cluster-deploy

Standard responses for the Incorta HA component installation wizard.

```text
Welcome prompt                  : Enter


License Agreement               : Y


Installation Type               : 1 (New Installation)


Installation Set                : 2 (Custom Installation)


Incorta HA Components           : 2 (Incorta HA Node)


Installation Folder             : `/home/incorta/IncortaAnalytics`


Node Agent Configuration (port) : 4500


Public IP Address               : <HOST_2_IPv4_Public_IP>


Start Node Agent                : 1 (Start node agent)**
```

--------------------------------

### Request URL Examples

Source: https://docs.incorta.com/latest/references-api-rename-move-dashboards-endpoint-v2

Example URLs for the dashboard endpoint.

```text
https://mycluster.incorta.com/incorta/api/v2/default/dashboards
```

```text
https://10.1.2.3:8080/incorta/api/v2/default/dashboards
```

--------------------------------

### On-Premises Server URL Example

Source: https://docs.incorta.com/latest/integrations-microsoft-fabric-advanced-sqli

Example format for connecting to an Incorta On-Premises cluster.

```text
203.0.113.45:10009
```

--------------------------------

### Installation Wizard Inputs

Source: https://docs.incorta.com/latest/g-aws-ha-incorta-cluster-upgrade

Required inputs for the interactive installation wizard during the upgrade.

```text
Welcome                    : Enter
Copyright                  : Enter
Copyright/License          : Y
Installation Type          : 2- Upgrade
Installation Set           : 2- Custom
Incorta HA components      : 1- Central Management Console (CMC)
Choose Installation Folder : Enter (default)
Start CMC                  : 1- Start CMC
Installation Status        : Enter
```

--------------------------------

### descendantOf Example Usage

Source: https://docs.incorta.com/latest/references-built-in-functions-miscellaneous-descendantof

Example identifying employees who are descendants of John.

```text
descendantOf(
    HR.EMPLOYEES.FIRST_NAME,
    "John"
)
```
Tokens:
Raw