Document toolboxDocument toolbox

[M - Done] How to: Onboard a new source

Applicable to KADA administrators

Purpose of this article

Use the following instructions to on-board databases and tools onto the K platform.

 

 

Instructions

1. On-boarding sources

To commence on-boarding log in with an account that has Admin privileges.

On the bottom left click the Platform Setttings icon as shown below.

 

Under INTEGRATIONS select Sources. You will now see the Sources screen. Click on + ADD SOURCE to start on-boarding a new source.

 

2. Add a new source

Add a new source will allow the KADA Admin to define how to connect and connection credentials for a source.

There are 3 classes of sources:

  1. Identity Stores - These are sources such as Active Directory or LDAP to load User and Group information into KADA.

  2. Databases - These are sources such as Oracle, Teradata, Snowflake to load metadata and logs from the database source.

  3. Tools - There are sources like Tableau, Alteryx, Informatica to load metadata and logs from the tool.

 

For each source there a a comm set of properties to populate

Field

Example of What to Enter

Field

Example of What to Enter

Name

The display name for the source. This can be changed at a later point in time.

Host

The host machine name/DNS/common name. Host must be unique for each onboarded source. Example: K01SYDAU01.KADA.AI

This can not be changed once configured.

Landing Folder Name

The name of the root folder where log files need to be loaded.

Keywords path

In general this can be left as the default value

 

Example. Integrating to Teradata Database.

  1. In the Source Type drop down, select Teradata. If the source you are looking for is not available you can use the Generic_database, Generic_tool types.

  2. Select a connection type
    DIRECT CONNECT - KADA Platform will be configured to pull from the source.

    LOAD FROM FILE → KADA Platform will receive files in a landing zone.

  3. Then follow the remaining steps on screen to populate the configuration.

  4. Once you have finished the setup you should see your new source in the Sources screen.

  5. To update an existing connection click on the Edit icon on the source.

3. Scheduling a Source

A source can be scheduled by clicking on the clock icon. Set the the appropriate schedule.

Depending on the source’s connection type you will see a different scheduler.

For Source configured to LOAD FROM FILE - The admin can set a poll frequency.

For Source configured to DIRECT CONNECT - The Admin can set a time to run.

Note that scheduling a source can take up to 15 minutes to propagate the change.

 

 

4. Manually Triggering Source loads

In addition to the scheduled sources. A source can be manually triggered to run.

On the bottom left click the Platform Setttings icon as shown below.

Under PLATFORM SETTINGS select Batch Manager.

In SOURCE LOAD select RUN. Then select the source you want to trigger from the dropdown and click RUN.

After the source is triggered, the screen will change to the Monitor tab where you can see the progress of the job.