Getting Started Guide
Introduction
To demonstrate the apiro fundamentals, we will work through an example of sourcing, cleansing, enriching and distributing Customer data, in both batch and real time processing. Subsequent sections will increase in complexity.
[OPTIONAL] Platform Overview (9 minutes)
| Description | Go to Apiro platform overview |
|---|---|
| Required | No |
| Description | This is a high level non-technical introduction to the platform |
[REQUIRED] Getting started guide overview (2 minutes)
| Description | Go to Getting started guide overview |
|---|---|
| Required | Yes |
| Description | This is a quick description of what will be covered in this Quick start guide |
[REQUIRED] Installation (10 minutes)
| Description | Go to Installation |
|---|---|
| Required | Yes |
| Description | This is the guide that walks you through all the steps to setup you local Apiro instance |
SECTION 1 [REQUIRED] Create a GIT Data Source (Excel) via the UI (9 minutes)
| Description | Go to Create GIT data source via the UI |
|---|---|
| Required | Yes |
| Description | In this section we will create an GIT data source, a data feed and a schema using the Apiro UI |
SECTION 2 [REQUIRED] Create a GIT Data Source (Excel) manualy, using InteliJ (19 minutes)
| Description | Go to Create GIT Data source manually using IntelliJ | |
|---|---|---|
| Required | Yes | |
| Description | In this section we will create an GIT data source, a data feed and a schema using IntelliJ | |
| Prerequisites | First complete Section 1 - GIT via UI |
SECTION 3 [REQUIRED] Create a second GIT Data Source (Excel) manualy, using InteliJ (11 minutes)
| Description | Go to Create a second GIT Data source manually using IntelliJ | |
|---|---|---|
| Required | Yes | |
| Description | In this section we will create a second GIT feed to source a second Excel file | |
| Prerequisites | First complete Section 2 - GIT via UI |
SECTION 4 [REQUIRED] Create RAW Validators, using InteliJ (22 minutes)
| Description | Go to Section 4 - Create Raw Validators using IntelliJ | |
|---|---|---|
| Required | Yes | |
| Description | In this section we will create NOT_NULL, POSTIVE and also configurable ones | |
| Required prerequisites | First complete Section 3 - Create a second GIT Data source manually using IntelliJ |
SECTION 5 [REQUIRED] Create Data Consolidators, using InteliJ (9 minutes)
| Description | Go to Create data consolidators using IntelliJ | |
|---|---|---|
| Required | Yes | |
| Description | In this section we will create a consolidation algorithm for portfolio value. | |
| Required prerequisites | First complete Section 4 - Create Raw Validators using IntelliJ |
SECTION 6 [REQUIRED] Section 6 - Create Data Cleansers using IntelliJ (5 minutes)
| Description | Go to Create Data Cleansers using IntelliJ | |
|---|---|---|
| Required | Yes | |
| Description | In this section we will create a data cleanser for yearly income. | |
| Required prerequisites | First complete Section 5 - Create data consolidators using IntelliJ |
SECTION 7 [REQUIRED] Create Raw data processors using IntelliJ (5 minutes)
| Description | Go to Create Raw data processors using IntelliJ | |
|---|---|---|
| Required | Yes | |
| Description | In this section we will create a raw data processor for first name. | |
| Required prerequisites | First complete Section 5 - Create data consolidators using IntelliJ |
SECTION 8 [REQUIRED] Create Consolidated data processors using IntelliJ (5 minutes)
| Description | Go to Create Consolidated data processors using IntelliJ | |
|---|---|---|
| Required | Yes | |
| Description | In this section we will create a consolidated data processor to mask TFN values. | |
| Required prerequisites | First complete Section 5 - Create data consolidators using IntelliJ |
SECTION 9 [REQUIRED] Create Consolidated validator using IntelliJ (5 minutes)
| Description | Go to Create Consolidated data processors using IntelliJ | |
|---|---|---|
| Required | Yes | |
| Description | In this section we will create a consolidated data validator to check for historical value shifts of the PORTFOLIO_VALUE data point. |
|
| Required prerequisites | First complete Section 8 - Create Consolidated data processors using IntelliJ |
SECTION 10 [REQUIRED] Create Data Sinks using UI and IntelliJ (5 minutes)
| Description | Go to Create Data Sinks using UI and IntelliJ | |
|---|---|---|
| Required | Yes | |
| Description | In this section we will create an EMAIL and FILESYSTEM Data Sinks. | |
| Required prerequisites | First complete Section 9 - Create Consolidated validator using IntelliJ |
SECTION 11 [REQUIRED] Create Datablock collections using UI and IntelliJ (5 minutes)
| Description | Go to Create a Datablock Collection using UI and IntelliJ | |
|---|---|---|
| Required | Yes | |
| Description | In this section we will a Datablock collection that can be used in a Distribution. | |
| Required prerequisites | First complete Section 10 - Create Data Sinks using UI and IntelliJ |
SECTION 12 [REQUIRED] Create Distribution using UI and IntelliJ (11 minutes)
| Description | Go to Create a Distribution using UI and Intellij | |
|---|---|---|
| Required | Yes | |
| Description | In this section we will a Datablock collection that can be used in a Distribution. | |
| Required prerequisites | First complete Section 11 - Create a Datablock collection using UI and IntelliJ |