K Knowledge Base
K Knowledge Base
Breadcrumbs

IICS (via Collector method) - v3.0.0

This collector is for Informatica Intelligent Cloud Services (IICS)

About Collectors

Pre-requisites

Collector Server Minimum Requirements

IICS Requirements

  • IICS with access to both V2 and V3 APIs

  • Establish IICS Access

Collector Limitations

Step 1: Create the Source in K

Create a IICS source in K

  • Go to Settings, Select Sources and click Add Source

  • Select "Load from File" option

  • Give the source a Name - e.g. IICS Production

  • Add the Host name for the IICS Production

  • Click Finish Setup

Step 2: Getting Access to the Source Landing Directory

Step 3: Install the Collector

It is recommended to use a python environment such as pyenv or pipenv if you are not intending to install this package at the system level.

Some python packages also have dependencies on the OS level packages, so you may be required to install additional OS packages if the below fails to install.

You can download the Latest Core Library and whl via Platform Settings → Sources → Download Collectors

Run the following command to install the collector

pip install kada_collectors_extractors_<version>-none-any.whl

You will also need to install the common library kada_collectors_lib for this collector to function properly.

pip install kada_collectors_lib-<version>-none-any.whl

Step 4: Configure the Collector

The collector requires a set of parameters to connect to and extract metadata from IICS

FIELD

FIELD TYPE

DESCRIPTION

EXAMPLE

username

string

Username to log into IICS

"myuser"

password

string

Password to log into IICS


login_url

string

Base url for your IICS login service

https://dm-ap.informaticacloud.com/ma/api/v2/user/login

days_active

integer

Number of days which a task must have run to be considered active

60

timeout

integer

Timeout in seconds for IICS API responses

20

output_path

string

Absolute path to the output location

"/tmp/output"

mask

boolean

To enable masking or not

true

compress

boolean

To gzip the output or not

true

kada_iics_extractor_config.json

JSON
{
    "username": "",
    "password": "",
    "login_url": "",
    "timeout": 30,
    "active_days": 60,
    "mapping": {},
    "output_path": "/tmp/output",
    "mask": true,
    "compress": true
}

Step 5: Run the Collector

This is the wrapper script: kada_iics_extractor.py

Python
import os
import argparse
from kada_collectors.extractors.utils import load_config, get_hwm, publish_hwm, get_generic_logger
from kada_collectors.extractors.iics import Extractor

get_generic_logger('root')

_type = 'iics'
dirname = os.path.dirname(__file__)
filename = os.path.join(dirname, 'kada_{}_extractor_config.json'.format(_type))

parser = argparse.ArgumentParser(description='KADA IICS Extractor.')
parser.add_argument('--config', '-c', dest='config', default=filename)
parser.add_argument('--name', '-n', dest='name', default=_type)
args = parser.parse_args()

start_hwm, end_hwm = get_hwm(args.name)

ext = Extractor(**load_config(args.config))
ext.test_connection()
ext.run(**{"start_hwm": start_hwm, "end_hwm": end_hwm})

publish_hwm(args.name, end_hwm)

Advance options:

If you wish to maintain your own high water mark files elsewhere you can use the above section's script as a guide on how to call the extractor. The configuration file is simply the keyword arguments in JSON format.

If you are handling external arguments of the runner yourself, you'll need to consider the following for the run method https://kadaai.atlassian.net/wiki/spaces/KKB/pages/3333849163/Collector+Integration+General+Notes#Extractor-run-method

Python
from kada_collectors.extractors.snowflake import Extractor

kwargs = {my args}
hwm_kwrgs = {"start_hwm": "end_hwm": }

ext = Extractor(**kwargs)
ext.run(**hwm_kwrgs)

Step 6: Check the Collector Outputs

K Extracts

A set of files (eg metadata, databaselog, linkages, events etc) will be generated. These files will appear in the output_path directory you set in the configuration details

High Water Mark File

A high water mark file is created in the same directory as the execution called iics_hwm.txt and produce files according to the configuration JSON. This file is only produced if you call the publish_hwm method.

If you want prefer file managed hwm, you can edit the location of the hwm by following these instructions https://kadaai.atlassian.net/wiki/spaces/KKB/pages/3333849163

Step 8: Push the Extracts to K

Once the files have been validated, you can push the files to the K landing directory.

You can use Azure Storage Explorer if you want to initially do this manually. You can push the files using python as well (see Airflow example below)

Example: Using Airflow to orchestrate the Extract and Push to K