Importing Users

Version

Application Scenario

• Admins can import an organized user information table into the FineBI system at one time.

• Admins can import user information, departments, and roles multiple times.

• Admins can edit, disable, and delete imported user data.

• You want user data in the FineBI system to be a collection made from multiple datasets.

Function Description

• You can create a server dataset based on a user information table, and import the user information into the FineBI system. After importing user information, if you want to add or delete user data in the server dataset, you need to import the user information again. Platform users can be a collection made from multiple datasets.

• Previously added/imported user data will not be cleared if you do not switch encryption methods during dataset importing.

The user data to be imported comes from server datasets which support hierarchical and non-hierarchical department structures.

You can choose one type of data based on your user structure.

Non-Hierarchical Data Structure - SQL Dataset

This example uses a user information table where no hierarchical structures exist between departments and positions. The departments of the users to be imported are all listed in All Departments in parallel, as shown in the following figure.

Preparing the User Information Table

Prepare a user information table. The following figure shows the table structure.

Download the user information table: Importing User 1.xlsx

Note:

1. During user importing, Username, Name, and Password are required fields, and other information can be left blank.

2. Mobile supports mobile numbers in Mainland China, Taiwan (China), Hong Kong (China), Turkey, South Korea, Japan, Singapore, and Malaysia.

Mobile numbers in Mainland China do not require area codes (you can add the code if you want), while those in other regions do.

Creating a Server Dataset

You can use a third-party database management tool to import the above table into a database and establish a data connection between the FineBI system and the database. The following takes the FRDemo database as an example.

Log in to the FineBI system as the admin and choose System Management > Data Connection > Server Dataset > Create Dataset > SQL Dataset, as shown in the following figure.

Set Dataset Name to Importing Users 1, select FRDemo as Data from Data Connection, and enter the SQL statement:

SELECT * FROM Importing Users 1

Non-Hierarchical Structure - File Dataset

This example uses a user information table where no hierarchical structures exist between departments and positions. The departments of the users to be imported are all listed in All Departments in parallel, as shown in the following figure.

Preparing the User Information Table

Prepare a user information table. The following figure shows the table structure.

Download the user information table: Importing User 1.xlsx.

Note:

1. During user importing, Username, Name, and Password are required fields, and other information can be left blank.

2. Mobile supports mobile numbers in Mainland China, Taiwan (China), Hong Kong (China), Turkey, South Korea, Japan, Singapore, and Malaysia.

Mobile numbers in Mainland China do not require area codes (you can add the code if you want), while those in other regions do.

3. You can also use TXT/XML files. For details, see File Dataset.

Creating a Server Dataset

Save the table locally or upload it to the reportlets folder in the directory FineBI installation directory\webapps\webroot\WEB-INF.

Log in to the FineBI system as the admin, and choose System Management > Data Connection > Server Dataset > Create Dataset > File Dataset, as shown in the following figure.

Set Dataset Name to Importing Users-File, and select the table mentioned above.

Note:

1. If you select Server File, you need to select the file in the BI project path FineBI installation directory\webapps\webroot\WEB-INF\reportlets.

If you select Local File, after you upload the file, the file will be automatically saved to the report project path FineBI installation directory\webapps\webroot\WEB-INF\reportlets\excel.

2. You can also use TXT/XML/remote URL files, which support dataset parameter setting. For details, see File Dataset.

Hierarchical Structure - Tree Dataset

This example uses a user information table where a hierarchical structure exists between departments and positions. The following figure shows the departments of the imported users.

Preparing the User Information Table

Prepare a user information table. The following figure shows the table structure.

Click and download the user information table: Importing User 2.xls.

Note:

1. During user importing, Username, Name, and Password are required fields, and other information can be left blank.

2. Mobile supports mobile numbers in Mainland China, Taiwan (China), Hong Kong (China), Turkey, South Korea, Japan, Singapore, and Malaysia.

Mobile numbers in Mainland China do not require area codes (you can add the code if you want), while those in other regions do.

3. When you synchronize user datasets, if the server dataset is a tree dataset, the value of the parent organization of the top-level organization should be Null (rather than an empty value). For example, the fid field for Anna is Null, as shown in the following figure.

4. You can still generate a tree dataset and synchronize users even if no users exist in a department. For example, the headquarters only has subordinate departments without direct positions or users.

Creating a SQL Dataset

You can use a third-party database management tool to import the above table into a database and establish a data connection between the FineBI system and the database. The following takes the FRDemo database as an example.

Log in to the FineBI system as the admin and choose System Management > Data Connection > Server Dataset > Create Dataset > SQL Dataset, as shown in the following figure.

Set Dataset Name to Importing Users 2, set Data from Data Connection to FRDemo, and enter the SQL statement:

SELECT * FROM Importing Users 2

Creating a Tree Dataset

Log in to the FineBI system as the admin and choose System Management > Data Connection > Server Dataset > Tree Dataset, as shown in the following figure.

Set Dataset Name to Importing Users-Hierarchical Structures, and select Importing Users2 as Source Dataset. Set Creation Method to Create Tree Depending on Parent Tag Field of Selected Dataset, and select did as Original Tag Field and fid as Parent Tag Field, as shown in the following figure.

Note:

During user importing through tree datasets, only Create Tree Depending on Parent Tag Field of Selected Dataset is supported, and Create Tree Depending on Length of Selected Dataset's Tag Field is not supported.

Log in to the FineBI system as the admin and choose System Management > User Management > All Users > Import User to configure user information, as shown in the following figure.

The following table describes the specific setting items.

Info Reservation

Server Dataset

Select the server dataset corresponding to the user information.

Field Name

Username, Name, Password, Department Name, Position Name, Role Name, Mobile, and Mailbox are the field names in the corresponding server dataset.

Note:

1. User email information configured in User Management can be used under System Management > System Setting > Mailbox, where you can send emails to mailboxes of different platform users.

2. Configured departments and positions cannot be reverted to unselected states unless you delete and re-select them.

3. You can configure departments, but cannot configure positions.

Encryption Method

Note:

After users are imported, the login password is the password in the above downloaded user Information table, and not the encrypted password in the fine_user table.

You can select from two encryption methods: Built-in SHA Encryption and Custom Password Encryption.

1. Built-in SHA Encryption

The FineBI system adopts the SHA256 encryption to ensure password security.

After you customize and modify a password through an API, the password will be automatically encrypted by SHA256.

2. Custom Password Encryption

Custom Password Encryption refers to customizing a password encryption class where the encryption method is described. The CLASS file is saved in FineBI installation directory\webapps\webroot\WEB-INF\classes.

The FineBI system will perform a secondary SHA256 encryption on top of the user-defined encryption algorithms to ensure password security.

For details about custom encryption examples, see Password Encryption Settings in Import User.

Note:

1. Custom encryption algorithms need to inherit the AbstractPasswordValidator class.

2. The system will clear the data of the existing imported/added users, departments, positions, and roles, and reset the admin account if you change the encryption method, as shown in the following figure.

Admins can edit, disable, and delete imported users. For details, see sections "Editing User Information," "Disabling a User," and "Deleting a User" in Adding Users.