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
- Navigate to Customer Accounts.
- Click on “+”.
- Enter parameters under the “New Account” section.
- Click “Create” to create a New Account.
Create User Subscription
- Click on subscription to create user subscription.
- Click on Add Subscription.
- Enter parameters under the Add Subscription dialog box.
- Select required cloud platform, subscription type, extraction engine and business packs.
- 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
- Navigate to Sources.
- Click on “Add Source +”.
- Select the desired “Source system”.
- Enter Parameters, refer to individual “Source Settings” as shown below.
- Click ‘VALIDATE’ to validate the connection.
- Click ‘CREATE’ to create the connection.
1. To set up PostgreSQL source, you need to provide the following settings:
Host | Hostname of the database |
Port | 5432 |
Database Name | Name of the database |
Schemas | List of schemas to sync from |
Username | Username to access database |
Password | Password associated with username |
SSL Modes | SSL connection mode |
SSH Tunnel Modes | |
JDBC URL Parameters | Additional parameters to pass to the JDBC URL string when connecting to the database |
Update Methods | Configure how data is extracted from the database |
2. To set up Salesforce source, you need to provide the following settings:
Sandbox | Salesforce sandbox credentials |
Client ID | Salesforce developer application’s Client ID |
Client Secret | Salesforce developer application’s Client Secret |
Refresh Token | Salesforce developer application’s refresh token used to access your Salesforce account |
Start Date | Enter date |
Force to use BULK API | Toggle to use bulk API |
Filter Salesforce Objects | Add filters to select only required streams |
3. To set up MS-SQL source, you need to provide the following settings:
Host | Hostname of the database |
Port | 5432 |
Database Name | Name of the database |
Schemas | List of schemas to sync from |
Username | Username to access database |
Password | Password associated with username |
SSL Modes | SSL connection mode |
SSH Tunnel Modes | |
JDBC URL Parameters | Additional parameters to pass to the JDBC URL string when connecting to the database |
Update Methods | Configure how data is extracted from the database |
4. To set up JIRA source, you need to provide the following settings:
API Token | Jira API token |
Domain | Domain for Jira account |
User email for Jira account | |
Projects | List of Jira keys to replicate data |
Start Date | Date from which to replicate the data |
Expand Issue Changelog | Expand the changelog when replicating the issues |
Render Issue Fields | Render issue fields in HTML format in addition to Jira JSON-like format |
Expand Issue Transitions | Expand the transition when replicating the issue |
Enable Experimental Streams | Allow use of experimental streams which rely on undocumented Jira API end points |