Import CSV
The CSV importer allows you to import your own plain text files. However, it does require the zip file to be in a specific format for the importer to understand.
The Zip File
The zip file must be a flat zip, which means there can not be a "root" or "sub" folder in which the items reside in the zip file. The importer looks for the files
channels.csv and users.csv immediately inside the zip and not inside of any folder. If you have any questions about this, please ask in the #support channel on the Community server.The directmessages directory is a special directory name. Check the Direct Messages section below.
1
fileToImport.zip
2
├── channels.csv
3
├── users.csv
4
├── directmessages
5
│ ├── messages1.csv
6
│ ├── messages2.csv
7
│ └── messages3.csv
8
├── general
9
│ └── messages.csv
10
├── otherChannelName
11
│ ├── canBeAnyNameButHasToHave.csv
12
│ ├── theDotCSV.csv
13
│ └── asTheFileExt.csv
14
├── privateArea
15
│ └── messages.csv
16
└── random
17
├── dateTimeStamp1.csv
18
├── dateTimeStamp2.csv
19
└── dateTimeStamp3.csv
Copied!
channels.csv Format
Channels between 2 users (Direct Messages) should not be included on this file. See section Direct Messages for more information.
The
channels.csv requires a very specific structure and layout. Each line contains information about one channel. Each line must include the channel name, the creator, whether it is private or public, and the members in the channel separated by a semicolon ;. Quotes are required.- 1.Channel name
- 2.Username of the channel creator
- 3.Whether the channel is public or private. If the last argument is not
privateit is assumed the channel is public - 4.List of users in the channel, separated by semicolons. If only the creator is in the channel, then there must be empty quotes.
1
"general","bradley.hilton","public",""
2
"otherChannelName","billy.bob","public",""
3
"random","bradley.hilton","public","billy.bob;graywolf336"
4
"privateArea","bradley.hilton","private","graywolf336"
Copied!
users.csv Format
The
users.csv is a file that contains the user details, each line containing a new user, and the user details are:- 1.Username (must not contain @ and some other special characters)
- 2.Email
- 3.Name
1
bradley.hilton,[email protected],Bradley Hilton
2
billy.bob, [email protected], Billy Bob Jr.
3
graywolf336,[email protected],GrayWolf336
Copied!
Message Files
The message CSV files require a particular format. Each line contains a new message, every piece of information is required quotes to surround it, there cannot be any spaces between the commas. The details required are:
- 1.Username who sent the message
- 2.The timestamp in milliseconds
- 3.The message, quotes are highly recommended, especially if the message text contains a comma.
1
"bradley.hilton","1479162481336","this is a test message"
2
"billy.bob","1479162481654","this is another message, a test message"
Copied!
Direct Messages / Direct Channels
Direct Channels / Direct Messages are imported from a special directory named directmessages with a specific format based on the Message Files format. The details required are:
- 1.Username who sent the message
- 2.Username who received the message
- 3.The timestamp in milliseconds
- 4.The message, quotes are highly recommended, especially if the message text contains a comma.
It's required to keep conversations in distinct files; for example, a conversation between user A and B compose a file (
messages1.csv), and the conversation between user B and C compose another file (messages2.csv).1
"bradley.hilton","billy.bob","1479162481336","this is a test message"
2
"billy.bob","bradley.hilton","1479162481654","this is another message, a test message"
Copied!
Importing
Once you have that all set up and zipped, then you can start the import process.
- 1.Go to
https://[your_rocketchat]/admin/import/prepare/csv - 2.Choose your
.zipfile and wait until Rocket.Chat can read it (it can take a few minutes, depending on the size of the file) - 3.Deselect any items you don't want to import
- 4.At the top of the page, click on Start Importing
When you have problems during the Import, click on "View Logs" in the admin section to get the detailed error messages.
Last modified 1mo ago
Export as PDF
Copy link