End-Users CSV - Usage and Schema Description

Printer-friendly version

End-Users CSV

The End-Users CSV may be used for the provisioning, updating or deleting a large amount of end-user accounts in Kaltura.

Purpose and Usage

The end-users CSV for bulk operation may be useful for:

  • Creating multiple end-user accounts. For example:
  • Pre-provisioning of MediaSpace user accounts when user authentication and/or user authorization to access MediaSpace with a specific role should be controlled and managed in Kaltura and not through a SSO/authentication integration.
  • Creating a user list for enabling the selection of MediaSpace’s Channel members from a full list of users managed in Kaltura.
  • An on-going scheduled process for synchronizing the user accounts managed in Kaltura with the organization user directory.

 

Notes:

  • For an efficient on-going CSV based synchronization process, only new user accounts and user accounts that require updating or deletion should be included within the CSV.
  • The end-users CSV is designed for managing end-user accounts. KMC user accounts are managed separately via the KMC Administration tab.
  • For any bulk actions that will create more than 5,000 entries (e.g., users), including categories bulk uploads, please contact your Kaltura representative to coordinate the upload. 


General Guidelines

  • Lines that begin with a # character will not be processed.
  • The first line for processing (fields’ definition line) should start with an * sign and should include the field names to be populated via the CSV, according to the defined schema of each CSV format. Mandatory fields must be present. The field order may be set as needed.
  • Each line for processing within the CSV should include a comma separated list of values ordered by the field ordering set in the fields’ definition line.
  • Each line for processing within the CSV will apply an action on a single Kaltura object. For example: each line in the End-Users CSV will apply the action to a single end-user.  
  • The CSV may be submitted from the KMC (through the Upload menu) or via a script, by utilizing Kaltura’s API.
  • Prior to processing the CSV file, its format is validated. When a mandatory field is missing, the bulk job will fail and processing will not start.
  • Bulk job tracking as well as downloading bulk job related files (the original CSV and log files) are done through the KMC using the Bulk Upload Log feature under the Upload Control page.
  • Email notifications on the completion of bulk upload processing - including completion status and a direct link to the log file, can be configured by Kaltura per request.
  • There is no limitation on the supported number of lines within each CSV.  The overall processing time of each CSV file is affected by the number of lines included in it. 
  • The following special characters can be populated within text fields via the CSV file :

           - _ % ? . :  ;  &  > @ ! $ ^ ~  = [ ] { } |  < 

       See special exceptions within each schema description.

The CSV examples included in this guide are displayed in screens from MS Excel for better clarity.

Schema Description for the End-Users CSV

Parameter Name

Mandatory/ Optional

Description

 

Default

 

Type and Restrictions

action

Optional

Kaltura’s numeric value for the action to apply on a specific user account.

CSV lines with different actions can be combined into a single CSV file. Only fields that are relevant to the CSV action will be used.

The supported action types and their numeric values are:

1=Add - to add a new user account

2=Update – to update an existing user account

3=Delete – to delete an existing user account

6=Add or Update – to add a new user account or update an existing account when the provided user ID is already available in Kaltura.  User accounts may be automatically created in Kaltura upon different cases. It is therefore recommended to use option 6 when adding new user accounts.

1= Add

KalturaBulkUploadAction

userId

Mandatory

The user’s unique identifier.

 

Text Field.

Minimum length: 3 characters Maximum length: 100 Characters

Only the following special characters are supported as part of the userId:

. _ @ -

firstName

Optional

The user’s first name.

 

Text Field. Maximum length: 40 Characters

lastName

Optional

The user’s last name.

 

Text field. Maximum length: 40 Characters

screenName

Optional

The user’s Screen Name as it will appear in the KMC.

 

Text field. Maximum length: 100 Characters

email

Optional

The user’s email address.

 

Text field. Maximum length: 100 Characters

tags

Optional

The tags to be added to the user account. Multiple tags can be separated by commas, while the entire field should be wrapped with double quotation marks (for example: “tag1, tag2). When the CSV is created in a simple text editor or by a script - the wrapping quotation marks should be added explicitly.  When CSV is created with a spread sheet editor (for example: MS Excel) this wrapping is automatically generated when saving to a CSV format with no need for manual editing.

The tag values cannot include commas.

 

Text Field

gender

Optional

Kaltura’s numeric value for gender

1=Male

2=Female

 

KalturaGender

country

Optional

A free text field for populating a user’s country.

 

Text field. No format validation. Maximum length: 16 Characters

state

Optional

A free text field for populating a user’s state.

 

Text field. No format validation. Maximum length: 2 Characters

 

city

Optional

A free text field for populating a user’s city.

 

Text Field. No format validation. Maximum length:  30 characters

zip

Optional

A free text field for populating a user’s zip code.

 

Text Field. No format validation. Maximum length:  10 characters

dateOfBirth

Optional

The users date of birth.

 

YYYY-MM-DD

partnerData

Optional

The partnerData user attribute is managed only via API.

 

Text field

Custom Data

Optional

Custom data fields that are set to extend the Kaltura User object can be populated via the CSV by defining the fields in the following formats:

metadata::the-schema-system-name::the-schema-field-name

Multiple custom data schemas and fields can be populated via the CSV.

Values of custom data fields that have multiple values should be separated with a the following delimiter:   |,|

Note: When updating custom data fields to an existing user account, a new metadata XML is automatically created. For preventing overriding existing values, all custom data fields that are set for the user should be provided in the CSV as part of the update action.

Custom data schemas and fields that apply to the KalturaUser Object are managed only via the Kaltura API.

 

 

MediaSpace Specific User Values

MediaSpace User Role (MediaSpace 5.0)

Optional

This field is applicable only when a user is authorized to a specific MediaSpace role through Kaltura and not through SSO/authentication integration.

The MediaSpace user role is managed as a user custom data in a standard MediaSpace custom data schema created automatically when MediaSpace is installed.

The system name of  MediaSpace Custom data schema is :

KMS_USERSCHEMA1_Your MediaSpace InstanceId

The name of the role field within this schema is: role

The populated values that should be the same as defined in the MediaSpace configuration.

Example: when the MediaSpace InstanceId is set to: “MyVideoPortal”

and one of the standard MediaSpace roles was named: “viewerRole”

The custom data field name in the CSV should be:

metadata::KMS_USERSCHEMA1_MyVideoPortal::role

and the populated value for view only MediaSpace users should be set to : “viewerRole”

 

 

MediaSpace User password

Optional

This field is applicable only when user authentication is handled by Kaltura and not through SSO/authentication integration.

For setting a user password as part of the bulk creation of MediaSpace user accounts, a sha1 hashed password should be populated as part of the partnerData field.

The MediaSpace password should include at least 6 characters.

Example: when a user’s password should be set to:  MyPass123%, the following value should be populated into the partnerData field within the CSV for the user’s record: 

pw=ecc94cd2e13ec3ae3ea30bda01e4fe715f9f9d20

You can also set the password manually from the User Management page in the MediaSpace configuration panel.

 

 

Examples of End-Users CSV

Bulk Provisioning/updating of Media Space’s User Accounts with a Role*

* Users are authenticated through SSO integration. Authorization to access to MediaSpace with a specific role is managed by Kaltura. The role’s metadata field name and possible values are specific per MediaSpace configuration.

Bulk Deletion of Specific MediaSpace User Accounts

(17335 reads)