Table of Contents
< All Topics
Print

xGEN User Guide

Introduction


xGEN offers a variety of features designed to simplify the data analytics shift from a variety of sources such as SAP, Snowflake, PostgreSQL, RedShift, etc. analytics tools to native cloud technology, with the ability to extract data from the source systems and load it into a cloud destination.

In this guide, we will walk you through the process of using xGEN from exploring the xGEN user interface, setting up source systems and cloud destinations and then walk you through how to create and configure data syncs, jobs, and schedules. We’ll also cover how to monitor your data integration processes and build data models using the Data Modeller. Additionally, we will also cover how we govern and analyse the data.

Getting Started


Prerequisites

  • Obtain URL to access the Admin application and the User application.
  • Credentials sent by support services.

Admin Application


Login

To access the Admin application, you need to log in with your username and password obtained from support services.

Once you have entered your credentials, click on the Login button to enter the application. The XGEN Admin home screen appears.

Vertical Menu Bar

The vertical menu bar on the left of home screen provides access to various modules and functionalities of the Admin application. Here’s a brief overview of each menu item:

  • Home: Displays application metric details.
  • Customer Accounts: To access the User application, creation and management of customer account will be done and displayed here.
  • Support User: List of support user created in the User application will be displayed here.
  • Business Packs: To access various pre created business packs.

Home Screen KPIs

The menu bar provides access to various modules and functionalities of the Admin application. Here’s a brief overview of each menu item:

  • Account: Shows the number of customer accounts created by the Admin.
  • Subscriptions: Shows the number of subscriptions created by the Admin.
  • Users: Shows the number of user accounts created by the Admin.
Create Customer Account
  1. Navigate to Customer Accounts.
  2. Click on “+”.
  3. Enter parameters under the “New Account” section.
  4. Click “Create” to create a New Account.
Create User Subscription
  1. Click on subscription to create user subscription.
  2. Click on Add Subscription.
  3. Enter parameters under the Add Subscription dialog box.
  4. Select required cloud platform, subscription type, extraction engine and business packs.
  5. Click “Create” to create a Master User subscription

User Application


Login

To access the User application, you need to log in with your username and password created on the “Admin” application under the Customer Account tab. Once you have entered your credentials, click on the Login button, and select the desired subscription to enter the application.

Top Toolbar

The top right corner icon of the application contains several useful features:

  • Subscription: This displays the current subscription you are working in.
  • Username: This displays your username.
  • Turn light on/off (Theme): This button allows you to switch between light and dark mode, depending on your preference.
  • Sign out: This button logs you out of the application.

Menu Bar

The menu bar provides access to various modules and functionalities of the User application. Here’s a brief overview of each menu item:

  • Home: Displays application metric details.
  • Sync: Helps users create data syncs based on tables & views.
  • Data Modeller: Build data models.
  • Analyse:
  • Govern: Explore data in data lake and data warehouse.
  • Operate: Create, monitor, and schedule jobs.
  • System: Create source and destination connections.
  • Account: Create roles and user to access the current subscription.

System


Sources

A source is a connection to any system that allows for the extraction of data. It is an essential component in the process of moving data to a cloud destination. xGEN’s source connectors provides features such as ability to replicate data from tables, views and materialized views, multiple methods of keeping your data fresh, and multiple sync modes.

Relational Database Sources PostgreSQL MS-SQL Salesforce 
Jira (?)   
 
Non-Relational Database Sources MongoDB 
Cloud Database Sources AWS S3 Azure Blob Storage Snowflake 

To set up a variety of sources, follow the steps as elaborated below for any type of source connection provided by xGEN. 

Create Source Connection

  1. Navigate to Sources.
  2. Click on “Add Source +”.
  3. Select the desired “Source system”.
  4. Enter Parameters, refer to individual “Source Settings” as shown below.
  5. Click ‘VALIDATE’ to validate the connection.
  6. Click ‘CREATE’ to create the connection.

1. To set up PostgreSQL source, you need to provide the following settings:

HostHostname of the database
Port5432
Database NameName of the database
SchemasList of schemas to sync from
UsernameUsername to access database
PasswordPassword associated with username
SSL ModesSSL connection mode
SSH Tunnel Modes 
JDBC URL ParametersAdditional parameters to pass to the JDBC URL string when connecting to the database
Update MethodsConfigure how data is extracted from the database

2. To set up Salesforce source, you need to provide the following settings:

SandboxSalesforce sandbox credentials
Client IDSalesforce developer application’s Client ID
Client SecretSalesforce developer application’s Client Secret
Refresh TokenSalesforce developer application’s refresh token used to access your Salesforce account
Start DateEnter date
Force to use BULK APIToggle to use bulk API
Filter Salesforce ObjectsAdd filters to select only required streams

3. To set up MS-SQL source, you need to provide the following settings:

HostHostname of the database
Port5432
Database NameName of the database
SchemasList of schemas to sync from
UsernameUsername to access database
PasswordPassword associated with username
SSL ModesSSL connection mode
SSH Tunnel Modes 
JDBC URL ParametersAdditional parameters to pass to the JDBC URL string when connecting to the database
Update MethodsConfigure how data is extracted from the database

4. To set up JIRA source, you need to provide the following settings:

API TokenJira API token
DomainDomain for Jira account
EmailUser email for Jira account
ProjectsList of Jira keys to replicate data
Start DateDate from which to replicate the data
Expand Issue ChangelogExpand the changelog when replicating the issues
Render Issue FieldsRender issue fields in HTML format in addition to Jira JSON-like format
Expand Issue TransitionsExpand the transition when replicating the issue
Enable Experimental StreamsAllow use of experimental streams which rely on undocumented Jira API end points

Leave a Reply

Your email address will not be published. Required fields are marked *

Cookie Consent

Our website uses cookies to ensure you get the best experience on our website.

Learn More