Versions Compared

Old Version 3

changes.mady.by.user Chichi

Saved on

compared with

New Version Current

changes.mady.by.user Dean Nguyen

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Table of Contents
minLevel1
maxLevel6
outlinefalse
styledisc
typelist
printabletrue

...

This process is currently under review for improvements (moving to a UI based upload / bulk action). Your feedback is greatly appreciated.

...

Upload File Format

Ensure the file you create follows the following format

Property

Value

Encoding

UTF-8 (No BOM)

File Delimiter

| (pipe)

Headers

Ordered and present as per contract all in uppercase.

Record Quoting

All fields enclosed in double quotes. “value”.

Any double quotes inside the field value must be escaped with an additional double quote. eg “SELECT ““COLUMN NAME”” from tableA”“Jane” or “Marketing”

Record Delimiter

\n (new line character)

Empty Fields

Non mandatory fields may be left empty. Note that an empty field must still be doubled quoted.

...

Step 1) Generate user upload file

  • Create a csv file using AD / LDAP with the following parameters:

    • Extract contains a row per user.

    • File name: USERS_YYYYMMDDHHMMSS.csv

    • Daily Load: Extracts new users. (Can be loaded less frequently or manually if required)

    • Historical Load: Full snapshot of users.

    • Follows the file format above.

    • Sample:

      View file
      nameUSERS_YYYYMMDDHHMMSS.csv

Column

Data Type

Value Mandatory

Description

USERNAME

STRING

Y

Unique id for the userExample: network id

Typically email of the user especially if SSO with Active Directory is used.

Example: Jane.Doe@email.com

FIRST_NAME

STRING

Y if IS_LOGIN_USER = 'Y'

Example: Jane

LAST_NAME

STRING

Y if IS_LOGIN_USER = 'Y'

Example: Doe

EMAIL

STRING

Y if IS_LOGIN_USER = 'Y'

Example: Jane.Doe@email.com

DESCRIPTION

STRING

N 

Description or Title of the user

Example: Head of Data

IS_SYSTEM_USER

STRING

N

Is the user a human user or a system account ?

One of the following values: (Y, N)

'Y' - system account

'N' - human user

leave empty if unknown

IS_LOGIN_USER

STRING

N

Will the user log into KADA ?

One of the following values: (Y, N)

‘Y’ - login

'N' - no login

Default to 'N' if not provided

ROLES

STRING

N

Comma separated string of roles.

Defaults to “kada_user” if no role is provided ie (when IS_LOGIN_USER=0).

Valid values:

  • kada_user

  • kada_admin

  • kada_data_manager

  • kada_business_user

  • kada_data_gov_user

This will be overridden by roles managed in SSO if configured

GROUP_NAME

STRING

N

The group (Team) the user belongs to.

Must match a value from GROUP MAPPING interface (see below)

USER_ID

STRING

N

Used as override. INTERNAL use only.

As of 5.19. The implementation is based on matching USER_ID with node.signature not user.username.

This means the USER_ID needs to be a hash.

This does not align with Tool > User interface which matches user.usernameLeave empty

...

Step 2) Generate

...

Team upload file

  • Create a csv file using AD / LDAP with the following parameters:

    • Extract contains a row per group.

    • File name: GROUPS_YYYYMMDDHHMMSS.csv

    • Daily Load: Extracts new groups. (Can be loaded less frequently or manually if required)

    • Historical Load: Full snapshot of groups.

    • Follows the format above.

    • Sample:

      View file
      nameGROUPS_YYYYMMDDHHMMSS.csv

Info

In this context Groups = Teams

Column

Data Type

Value Mandatory

Description

NAME

STRING

Y

Name of group (i.e. Team)

Must be unique. If not unique consider prefix / suffix to make it unique

PARENT_NAME

STRING

N

Name of the parent team.

Must match the team name in another row

DESCRIPTION

STRING

N

Description of the team for presentation within the K application

...

Step 3) Upload user and group files to K

...

Load these files generated via Step 1 and Step 2 via Sources → K Client

...

When onboarding a Source

  1. Generate users extract for the tool; Upload via the sources page;

    1. If USERNAME match global user names user will be auto linked

    2. Download report with unmapped users. Update the USER_ID field to link to an existing K user; Upload the extract to K via Admin > Sources

    3. OR User the User IDs page to link one by one.

As new users are added to the tool

...

Info

Requires K administrator access and access to your K instance storage container. If you are using K SAAS use your SAS token provided or request a new token by raising a Support ticket Need more help? Raise a ticket

  1. Log into K

  2. Go to Platform Settings → Sources

  3. Click Add Source.

    1. Select MICROSOFT_WINDOW_AD or LDAP.

    2. Select Load from File

    3. Add a Name: e.g. Active Directory

    4. Add a Host: e.g. ActiveDirectory

    5. Note down the landing folder e.g. windows_ad

    6. Click Next and Finalise the setup

  4. Access the folder created

    1. via Azure Storage Explorer and the SAS token provided by K (for SaaS) or

    2. The storage container for Your Cloud implementation

  5. Upload the files above to the landing directory for the source you created e.g. kada-data/lz/windows_ad/landing

  6. Go back to the Sources page. Click run manual load action on the source you created

  7. Check the monitor page for the status of the job. On completion, your new teams and users will have been created