Download Users Credentials

The Download User Data screen allows administrators to view and download various user templates and employee details, including user credentials created through bulk creation.

Download Functionality:

  • Each listed file has a dedicated Download button to save the respective data locally.

  • Files are downloaded in .xlsx format.

Implementation of the files displayed :

The /project-factory/v1/data/_search will return all the files uploaded related to microplan.

API Details:

End Point

Method

Payload

/project-factory/v1/data/_search

POST

{"RequestInfo": {}, SearchCriteria: {tenantId: "mz", type: "user"}}

The API will return a ResourceDetails array containing all the filestore IDs related to the microplan. Each entry will include the fileStoreId, processedFilestoreId, and status

The results of the API are filtered based on whether item?.actions === 'create'
and item?.source === 'microplan'.

Status

The files are downloadable only if the status of the files are "completed",

if the status of the file is "invalid" in resouceDetails.status then the file is not downloadable.

Download Button:

Upon clicking the download button, the following Digit function is invoked using the file's .processedFilestoreId to enable the download functionality.

Digit.Utils.campaign.downloadExcelWithCustomName({ fileStoreId: item?.processedFilestoreId, customName: String(fileName) });

Once Downloaded:

The UserName and password are generated for each user in the downloaded sheet.

File Structure

The downloaded .xlsx files may include the following data fields:

  • Name: The full name of the user.

  • Contact Number: The user's phone number.

  • Email: The user's email address.

  • Roles: The designated role(s) for each user (e.g., Population Data Approver).

Navigation:

  • Use the Back button to exit the download screen.

Was this helpful?