How to Add/Import users and groups in bulk to Spotfire, using Administration Manager in Spotfire Analyst

How to Add/Import users and groups in bulk to Spotfire, using Administration Manager in Spotfire Analyst.

NOTE: This method is only applicable for the Database User Directory. Therefore, the userdomain value in your source data will be SPOTFIRE.

1. Prepare your user and group source data per the examples shown in the below sections A and B and C.

A). Bulk import of users. 
Populate your text file (source data) in the following semicolon separated format:

User name;Domain name;password; display name;email

Examples:
................................................................

1 ; SPOTFIRE ;Admin123; 1 ; 1@mydomain.com

Test ; SPOTFIRE ;Test123; Test ; Test@mydomain.com

Test1 ; SPOTFIRE ; spotfire123;Test1 ; Test1@mydomain.com

................................................................

The attachment (Filename: users.txt) contains the full set of these examples.

B). Bulk import of groups. 

Populate your text file (source data) in the following semicolon separated format:

Group name;Domain name;Display name;Group's Email;Member's user Id;Member domain name;Member type

Example: Create a Group G1

G1 ; SPOTFIRE ; G1 ;  ; ; ;

Example: Create a Group G2

G2 ; SPOTFIRE ; G2 ;  ; ; ;

C). Bulk import of group memberships. 

Example: Add a user to group G1 

G1 ; SPOTFIRE ;  ;  ; 1 ; userdomain ; user

Example: Add a group  G2 as a member of  group G1 

G1 ; SPOTFIRE ;  ;  ; G2 ; SPOTFIRE ; group

The attachment (Filename: group.txt) contains the full set of these examples.

................................................................

G1 ; SPOTFIRE ; G1 ;  ; ; ;

G2 ; SPOTFIRE ; G2 ;  ; ; ;

G1 ; SPOTFIRE ;  ;  ;1 ; SPOTFIRE ; user

G1 ; SPOTFIRE ;  ;  ; G2 ; SPOTFIRE ; group

................................................................

2. Log into Spotfire Analyst and click on the Tools > Administration Manager menu item.
3. Within the Administration Manager dialog go to the Import tab
4. Click the Browse button and navigate to your source file for Users or Groups
5. Click on ‘Import Users’ or ‘Import Groups’
6. Repeat as needed.

NOTE: Only existing users/groups can be added as a member to groups. First import your users and groups, and then import the memberships.

Alternatively, you can import your data from the Windows command line using command line arguments and Spotfire’s config.bat file.

NOTE: A scenario was reported where importing groups failed because Spotfire also expected the 'guid' as an additional column, third from the left in the above examples. If you do not want to specify this value when importing, then you can import from a command line and specify 'false' for the -g flag per the below article. CLI commands allow for higher flexibility and control than the Administration Manager.

1. Open a command line on your Spotfire server as an Administrator, per the below article:

https://docs.tibco.com/pub/spotfire_server/11.4.0/doc/html/TIB_sfire_server_tsas_admin_help/server/topics/executing_commands_on_the_command_line.html

2. Prepare your import-users and import-groups commands, per the below articles:

https://docs.tibco.com/pub/spotfire_server/11.4.0/doc/html/TIB_sfire_server_tsas_admin_help/server/topics/administration_commands.html

https://docs.tibco.com/pub/spotfire_server/11.4.0/doc/html/TIB_sfire_server_tsas_admin_help/server/topics/import-users.html

https://docs.tibco.com/pub/spotfire_server/11.4.0/doc/html/TIB_sfire_server_tsas_admin_help/server/topics/import-groups.html

3. Execute your commands from a command line, entering your Tool password as necessary. Examples:

config import-users <filename of source data>

config import-groups <filename of source data>