Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

This page will walk through the process of setting up user profiles in bulk via a file upload.

Upload File Properties

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”

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.

Column

Data Type

Value Mandatory

Description

USERNAME

STRING

Y

Unique id for the user

Example: network id

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

 

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

GROUP_NAME

STRING

N

The group 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.username

Step 2) Generate user 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.

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

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

  2. 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.

  3. As new users are added to the tool

    1. Generate report of unmapped user. and repeat step #3.

  • No labels