Skip to content
  1. Home
  2. Docs
  3. Xcalar Notebook User Guide
  4. Xcalar Notebook Overview
  5. Getting Started

Getting Started

This section provides basic information and instructions for accessing Xcalar and working in Xcalar Notebook, specifically for first-time users.

RECOMMENDATION: Before reading this guide, Xcalar recommends reading and following the exercises in the Xcalar Quick Start Guide. This guide walks you through the basic steps for you to create your first application in Xcalar, as well as, helps you navigate the Xcalar integrated development environment (IDE), by providing step-by-step example instructions, screenshots, and SQL.


Before you can start using Xcalar, make sure that you are using the supported web browser:

The following web browser is supported by Xcalar for running a Xcalar instance:

  • Google Chrome for Business, version 65 or later.
IMPORTANT: Xcalar uses cookies, verify in the Google Chrome Privacy and security settings that cookies from Xcalar are not blocked.

Creating a Xcalar account

To create a Xcalar account:

    1. From the Xcalar supported browser on a computer with network connectivity, open a browser window.
    2. In the web browser URL field, enter the following URL:
    3. From the Login page, click Create an account.
    4. In the Create account page, enter your name, company, email, and password credentials.
NOTE: Record your credentials somewhere safe.
    1. Click and read the Xcalar End User License Agreement. if you agree to the conditions, select the I have read and agree to the End User License Agreement check box.
    2. Click Submit.
NOTE: If you do not receive within a few minutes a SaaS verification code email in your email In-box, check your Spam folder. If it is not in your Spam folder, click the Resend It link.
    1. In the Verify your account page, enter the Xcalar SaaS verification code that you received from the email address you provided in the Create account page.
    2. Click Confirm account.
NOTE: Creating a Xcalar cloud cluster instance for your Xcalar account and may take a few minutes.

Once the Xcalar cloud cluster is created, the Xcalar Landing page is displayed and you can start using Xcalar.

Logging in to Xcalar

NOTE: The following procedure assumes that you have created a Xcalar account.

To log in to Xcalar:

    1. From the Xcalar supported browser on a computer with network connectivity, open a browser window.
    2. In the web browser URL field, enter the following URL:
    3. In the EMAIL ADDRESS and PASSWORD fields, enter the user and password credentials that you provided when you created your Xcalar account.
    4. Click Log in.

The Xcalar Landing page opens.

TIP: Whenever you need to get back to the Landing page from either Xcalar Load or Xcalar Notebook, on the Xcalar Main menu bar, click the Xcalar Home icon on the top left corner.

Logging out of Xcalar

When you are not working in Xcalar, it is recommended that you explicitly log out.

To log out of Xcalar, from the Xcalar Notebook Main menu, click the User icon on the top right corner and then select Log out.

Understanding the key components of Xcalar Notebook

This section describes the following key components of Xcalar Notebook:

  • Project
  • Table
  • Module and function

Understanding a project

project is a logical container environment that stores your work. It contains your tables, SQL statements, functions, modules (algorithms), and other Xcalar Notebook objects. You can have multiple projects for different applications.

Before you can work in Xcalar Notebook you must either create a new project or click an existing project.

Understanding a table

table is a visual representation of data, Tables represent your source data created in Xcalar Load and the resultant data from an operation as you create and develop your application from a SQL statement, a Xcalar built-in operator, or a function. Tables also include a schema and metadata about the SQL, the operator’s operation, or a function, such as column names, data types, table size, and creation time.

Understanding a Module and function

Module stores your functions. Where a function is a visual representation of the series of operations performed on data. You control the operations in a function from either a SQL statement or by adding and configuring the Xcalar built-in operators (operators) and specifying the order in which Xcalar executes them.

The Module canvas displays the function as a function diagram that contains the operators, represented as graph-nodes, which display the results and the performance of each operation applied on your data. This enables you to troubleshoot and develop your algorithms one operation at a time. You can edit a function by adding, reconfiguring, and reordering the operators until you arrive at the desired result.

NOTE: Manipulating data in Xcalar Notebook does not modify the source data.

Creating a project

This topic briefly describes how to create a Project in Xcalar Notebook.

A Project is a logical environment that stores your work. It contains your tables, modules (algorithms), and other Xcalar Notebook objects. You can have multiple Projects for different applications.

NOTE: The following example assumes that you are logged into Xcalar and that you have created a table or tables from your source data in Xcalar Load.

To create a project:

    1. In the Project page of Xcalar Notebook, click Create New Project.
TIP: To get back to the Projects page, in the left sidebar, click the Projects icon.
    1. In the highlighted Name field, enter a name for your project using the following project naming convention:
      • The name is case-sensitive.
      • Length must not exceed 255 characters.
      • First character must be a letter of the alphabet.
      • Characters must be A-Z, a-z, 0-9, hyphen (-), underscore (_), or space.
      • Must not be one of the following reserved names:
        • udf
        • udfs
        • preupgrade
    1. Click Enter.
TIP: To add a description for the project, right-click the project name and select Edit Name and Description.
    1. Click the name of your project, which opens the project in the Xcalar Notebook development area.
    2. (Optional) In the Resources panel, verify that the tables you created in Xcalar Load are listed under the Tables section. You can also preview your table’s data source in the Table panel, by clicking on each table.
Was this article helpful to you? Yes No

How can we help?