Skip to main content
User Metadata Sources for Yapster
M
Written by Meg Payne
Updated over 2 years ago

Yapster can import metadata relating to these object types from one or more CSV files:

  • users

  • groups

  • hierarchy (users belong to a group, groups belonging to a group)

The very minimum information Yapster requires to function is a list of users with:

  • a stable identifier

    • e.g. employee-id, SSO login id

  • name

  • email address

    • to be used for onboarding - we can also use SMS messages for onboarding, at additional cost

However, this will be very bare-bones and Yapster will be much better if you can provide some groupings for users - such as the location(s) they work in, and a structured job title, if available. The groupings will be made into addressable objects in Yapster, and will be kept up to date, so when a user moves location the chats addressed to locations are updated accordingly


User Metadata Fields

Here's a list of the fields Yapster's user-metadata CSV importer supports. If you have an existing CSV format that has the required information, but e.g. has different field names, or needs some lookups or transformation, we can probably work with that too so please flag this to the Support Team to investigate and confirm.

employee-number

A unique id for a user - need not be their actual payroll id, but must be unique

forename

surname

email

an email address we can send an invite to

personal-mobile-number

(optional) a mobile number we can send a SMS invite to

job-title

(optional) A job-title for display in the directory - will not be made into a group

location-1

display name of user's first location (e.g. store, restaurant)

location-id-1

(optional) id of user's first location (e.g. store-id, restaurant-id). if blank then the location-1 will be used as an id

location-2

location-id-2

...

as many location-groups as needed

function-1

display name of user's first function group (e.g. structured job title)

function-id-1

(optional) id of user's first function group (e.g. structured job-code). if blank, then function-1 will be used as an id

function-2

function-id-2

...

as many function groups as needed


Hierarchy Metadata Fields

If you have a hierarchy of groupings, e.g.

  • sites in location groups

    • stores are grouped into areas, which are in turn grouped into regions e.g.

      • Region 1

        • Area A

          • Store I

          • Store II

        • Area B

          • Store III

          • Store IV

        etc.

  • job-titles in function groups

    • "Sale manager" and "sales consultant" might both be job-titles in the "sales team" e.g.

      • Sales

        • Sales Manager

        • Sales Co-ordinator

        • Sales Consultant

      • Warehouse

        • Warehouse Manager

        • Warehouse Supervisor

        • Warehouse Operative

        etc.

then Yapster can model this hierarchy, and all the objects in your hierarchy will become addressable and behave as you might expect (e.g. you can address a conversation to the "sales team in north-east region"), while in the Yapster directory the hierarchy will be browsable

Here's a list of the fields used by the Yapster CSV hierarchy importer. Each row in the importer can specify multiple links through the hierarchy, e.g. store -> area -> region

hierarchy-flavour

either "location" or "function" - where "location" hierarchies relate to geography, like store->area->region and "function" covers everything else

group-id-1

id of first group "highest" in the hierarchy e.g. area-code

group-name-1

name of first group

group-role-1

(optional) the class of group, e.g. "area" or "region"

group-id-2

id of the next "lowest" in the chain, e.g. store-code

group-name-2

name of second group

group-role-2

(optional) the class of group e.g. "store"

group-id-3

(optional) further groups in the chain...

group-name-3

group-role-3

Did this answer your question?