JUSPAY Unified Dashboard

Batch Users Onboarding

Overview

The Batch Users Onboarding module provides comprehensive bulk user creation capabilities for onboarding multiple users simultaneously through CSV file uploads. It offers real-time progress tracking, status monitoring, and detailed reporting for all user creation operations processed through the Juspay payment platform.

This module is designed for a wide range of users, including:

  • Operations Teams: For creating multiple user accounts in bulk and monitoring user onboarding performance across different roles and access levels with comprehensive operational logs and audit trails.

  • HR Teams: For bulk user account creation during organizational onboarding, employee provisioning, and tracking user creation operations across multiple departments with detailed status reporting.

  • System Administrators: To process bulk user creation requests, manage user access provisioning, and provide accurate updates on user account creation status and system access activation.

Accessing the Module

  1. Log in to the Juspay dashboard.

  2. From the main navigation menu on the left, click on Users.

  3. Select Batch Users Onboarding from the Users submenu.

  4. The navigation URL for this module is https://portal.juspay.in/batch-users-onboardinglink icon.

Batch Users
Batch Users

Step-by-Step Usage Instructions

Creating Batch User Onboarding Operations

Step 1: Access the Batch Users Onboarding Interface

  1. Navigate to the Batch Users Onboarding module using the steps above.

  2. You will see the main dashboard with a description: "This module helps in onboarding user in bulk using a file upload. It provides a holistic view of the files uploaded. Upon clicking the filename in the table below a detailed view of each entry uploaded is displayed."

  3. The interface displays any previously uploaded batch user files in a table format.

Step 2: Initiate New Batch User Upload

  1. Click the "Create Batch Users" button (visible only to users with appropriate permissions).

  2. The system will open the "Upload CSV File" modal with detailed instructions and upload interface.

Batch Users
Batch Users

Step 3: Prepare and Upload CSV File

  1. Download Sample File: Click on the "Download Sample CSV" button to download the CSV template (batch_users_onboarding_sample.csv).

  2. Prepare Your Data: Fill in your user data following the CSV field specifications (see table below).

  3. File Limitations:

    • Maximum 1000 entries per file

    • CSV format only (.csv file extension required)

    • File size limitations apply

  4. Upload Process:

    • Click "Click to upload or drag and drop" or drag and drop your CSV file into the upload area

    • The system validates the file format and structure

    • Mandatory fields are checked (Username, Email Id, Full Name, Role)

    • Column types are validated for proper data format

    • File format must be .csv only

Step 4: File Processing and Validation

  1. File Validation: The system performs the following checks:

    • CSV format validation (.csv file extension required)

    • Mandatory field presence (userName, emailId, fullName, role)

    • Data type validation for each column

    • Email format validation for emailId field

    • Username format validation

    • Role validation against available system roles

    • Row count validation (maximum 1000 entries)

  2. Error Handling: If validation fails, specific error messages are displayed:

    • Missing mandatory fields

    • Invalid data types

    • Invalid email format

    • Invalid username format

    • Invalid role values

    • File format errors

    • Row limit exceeded

  3. Successful Upload: Upon successful validation:

    • File is queued for processing

    • Batch ID is generated

    • Initial status is set to processing

    • User creation processing begins

Step 5: Monitor Processing Status

  1. Status Indicators:

    • COMPLETED: Successfully processed user creation operations (Green indicator)

    • FAILED: Failed user creation attempts (Red indicator)

    • QUEUED: User creation operations waiting in processing queue (Blue indicator)

Monitoring and Managing Batch User Operations

Viewing Batch User Details

  1. Table View: The main interface displays all uploaded batch files with:

    • File Name: Name of the uploaded CSV file containing user data

    • File Upload Status: Current processing status with color-coded labels

    • Date Created: File upload timestamp

    • Last Modified: Last update timestamp for the batch processing

    • Total Tasks: Number of user creation requests in the file

    • Tasks Progress: Visual progress bar showing completion status with green (success) and red (failed) indicators

    Batch Users - Table View
    Batch Users - Table View

  2. Detailed View: Click on any filename to access detailed information:

    • Batch Details Card: Shows comprehensive batch information including:

      • Batch ID: Unique identifier for the uploaded file (format: alphanumeric string)

      • Date Created and Date Updated timestamps

      • Current status with color-coded indicators matching main table

    • Progress Statistics: Individual task counts displayed as cards:

      • Total Users: Complete count of all user records in the batch

      • Total Accepted Users: Number of successfully processed user records

      • Total Pending Users: Number of user records currently being processed

      • Total Rejected Users: Number of user records that failed processing

      • Total Queued Users: Number of user records waiting for processing

    Batch Users - Detailed View
    Batch Users - Detailed View

Individual User Records View

  1. User Status Tabs: The detailed view includes tabs for:

    • User Created: Successfully created user accounts

    • User Not Created: Failed user creation attempts

  2. User Records Table: Displays individual user information with columns:

    • User Name: Username from the CSV file

    • Email Id: Email address from the CSV file

    • Full Name: Complete name from the CSV file

    • Order Status: Processing status (SUCCESS, FAILED, PENDING)

    • Role: Assigned role from the CSV file

    • Date Created: User account creation timestamp

    • Last Modified: Last update timestamp for the user record

    • Schedule Time: Processing schedule information

Search and Filter Capabilities

  1. File Name Search:

    • Use the "Search File Name" input field with search icon

    • Enter filename to filter results in the main table

    • Search supports partial matches and real-time filtering

    • Clear search results by clearing the input field

  2. Table Sorting:

    • Click column headers to sort data

    • Available sorting for: File Name, File Upload Status, Date Created, Last Modified, Total Tasks

    • Toggle between ascending and descending order

    • Sort indicators show current sort direction

Data Export and Download

Downloading Processed Data

  1. Access Download: Click the "Download Data" button in the batch details view.

  2. CSV Export: Downloads include:

    • All processed user data with complete status information

    • Individual user creation results

    • Processing timestamps and status details

    • Error information for failed user creation attempts

  3. File Format:

    • CSV format with comma-separated values

    • Includes header row with column names

    • Comprehensive data export for audit and reporting purposes

CSV File Upload Specifications

CSV Field Requirements

Scroll inside to view more
Field Name
Mandatory/Optional
Data Type
Description
Sample Value
Validation Rules
userName
Mandatory
String
Unique username for the user account
"john.doe"
Must be a valid string, cannot be empty, must be unique
emailId
Mandatory
String
Email address for the user account
"john.doe@company.com"
Must be valid email format, cannot be empty
fullName
Mandatory
String
Complete name of the user
"John Doe"
Must be a valid string, cannot be empty
role
Mandatory
String
Role assignment for the user
"ALL ACL"
Must be a valid system role, cannot be empty

User Creation Validation Rules

Username Requirements:

  • Format: Must be a valid string identifier

  • Uniqueness: Username must be unique across the system

  • Length: Should follow standard username conventions

  • Characters: Alphanumeric characters and common symbols allowed

  • Existence: System checks for existing usernames to prevent duplicates

Email Requirements:

  • Format: Must follow valid email format (user@domain.com)

  • Uniqueness: Email address must be unique across the system

  • Domain Validation: Email domain must be valid and accessible

  • Length: Standard email length limitations apply

  • Existence: System checks for existing email addresses

Full Name Requirements:

  • Format: Must be a valid string with proper name formatting

  • Length: Reasonable length limitations for name fields

  • Characters: Alphabetic characters and common name symbols

  • Completeness: Should represent a complete user name

Role Requirements:

  • Validation: Role must exist in the system's role configuration

  • Permissions: Role assignment must be valid for the user context

  • Access Control: Role determines user access levels and permissions

  • Format: Must match exact role names as configured in the system

User Creation Processing Logic

Eligibility Criteria:

  • Unique Identifiers: Username and email must be unique in the system

  • Role Availability: Assigned role must be available and properly configured

  • System Capacity: User creation depends on system capacity and limitations

  • Access Permissions: User creation permissions must be available

Processing Sequence:

  1. Validation: Verify all mandatory fields and data format compliance

  2. Uniqueness Check: Validate username and email uniqueness

  3. Role Verification: Confirm role exists and is assignable

  4. Queue Management: Add user creation requests to processing queue

  5. Account Creation: Create user account with specified credentials and role

  6. Status Update: Update user creation status based on processing result

  7. Activation: Activate user account for system access

User Creation Behavior:

  • Account Setup: Complete user account creation with all specified details

  • Role Assignment: Assign specified role with appropriate permissions

  • Access Activation: Enable user access to system based on role permissions

  • Notification: System may send account creation notifications to users

CSV Format Examples

Complete CSV Format with Sample Data:

CSV Format with Different Role Scenarios:

File Upload Constraints

  • Maximum Rows: 1000 entries per CSV file

  • File Format: CSV (Comma Separated Values) only with .csv extension

  • Encoding: UTF-8 encoding recommended

  • File Size: Standard file size limitations apply

  • Column Order: Must match the specified header format (userName, emailId, fullName, role)

  • Required Fields: All four fields are mandatory and cannot be empty

  • Data Consistency: All entries must follow the same data format standards

  • Duplicate Prevention: Avoid duplicate userName or emailId entries within the same file

Use Cases

New Employee Onboarding

  1. Export new employee data from HR systems with required user information

  2. Prepare CSV file with usernames, email addresses, full names, and appropriate roles

  3. Upload file through Batch Users Onboarding interface for immediate processing

  4. Monitor user creation status and download results for HR confirmation and system access setup

Department-Wide User Provisioning

  1. Identify users that need system access for new department or project initiatives

  2. Compile list of affected users with specific role assignments and access requirements

  3. Upload user creation file with defined role assignments and access levels

  4. Track individual user creation status and automatic account activation

System Migration User Setup

  1. Prepare CSV with user information for system migration or platform transition

  2. Include user details and role mappings for new system environment

  3. Process bulk user creation with defined access permissions and role assignments

  4. Use downloaded user creation data for migration confirmation and access verification

Troubleshooting

File Upload Validation Errors:

  • "Invalid file format": Ensure file is in CSV format with .csv extension and proper comma separation

  • "Missing mandatory fields": Verify that userName, emailId, fullName, and role columns are present and not empty

  • "Row limit exceeded": Reduce file size to maximum 1000 entries per upload

  • "Invalid data type": Check that all fields contain appropriate string values in correct format

  • "Invalid email format": Ensure emailId field follows valid email format (user@domain.com)

  • "Username already exists": Verify that usernames are unique and not already present in the system

  • "Email already exists": Ensure email addresses are unique and not already registered in the system

  • "Invalid role assignment": Check that role values match available system roles exactly

Permissions and Roles

Access to the Batch Users Onboarding module is controlled by the following permissions:

  • Users Module Access: Required for accessing the batch users onboarding interface (ACL: users)

  • Batch Create Users Permission: Required for creating and uploading batch user files (ACL: batch_create_users)

  • Combined Permission Requirement: System requires both users and batch_create_users permissions for full functionality access

  • User Creation Access: Required for performing bulk user creation operations (ACL: batch_create_users)

  • User Management Permission: Required for viewing user creation status and downloading processed data (ACL: users)

Last updated 2 months ago