Generate detailed reports on team folder membership, showing access patterns and member distribution
Please download the pre-compiled binary from Latest Release. If you are using Windows, please download the zip file like tbx-xx.x.xxx-win.zip
. Then, extract the archive and place tbx.exe
on the Desktop folder.
The watermint toolbox can run from any path in the system if allowed by the system. But the instruction samples are using the Desktop folder. Please replace the path if you placed the binary other than the Desktop folder.
This document uses the Desktop folder for command example.
Windows:
cd $HOME\Desktop
.\tbx.exe dropbox team insight report teamfoldermember -database /LOCAL/PATH/TO/database
macOS, Linux:
$HOME/Desktop/tbx dropbox team insight report teamfoldermember -database /LOCAL/PATH/TO/database
Note for macOS Catalina 10.15 or above: macOS verifies Developer identity. Currently, tbx
is not ready for it. Please select “Cancel” on the first dialogue. Then please proceed “System Preference”, then open “Security & Privacy”, select “General” tab.
You may find the message like:
“tbx” was blocked from use because it is not from an identified developer.
And you may find the button “Allow Anyway”. Please hit the button with your risk. At second run, please hit button “Open” on the dialogue.
DIRECT
if you want to skip setting proxy.Report file path will be displayed last line of the command line output. If you missed the command line output, please see path below. [job-id] will be the date/time of the run. Please see the latest job-id.
OS | Path pattern | Example |
---|---|---|
Windows | %HOMEPATH%\.toolbox\jobs\[job-id]\reports |
C:\Users\bob.toolbox\jobs\20190909-115959.597\reports |
macOS | $HOME/.toolbox/jobs/[job-id]/reports |
/Users/bob/.toolbox/jobs/20190909-115959.597/reports |
Linux | $HOME/.toolbox/jobs/[job-id]/reports |
/home/bob/.toolbox/jobs/20190909-115959.597/reports |
Team folder member
The command will generate a report in three different formats. entry.csv
, entry.json
, and entry.xlsx
.
Column | Description |
---|---|
team_folder_id | Team folder ID |
team_folder_name | Team folder name |
path_display | Display path |
access_type | Access type |
is_inherited | Inherited access |
member_type | Member type |
same_team | True if the member is in the same team |
group_id | Group ID |
group_name | Group name |
group_type | Group management type |
group_member_count | Group member count |
invitee_email | Invitee email |
user_team_member_id | User team member ID |
user_email | User email |
user_display_name | User display name |
user_account_id | User account ID |
If you run with -budget-memory low
option, the command will generate only JSON format report.
In case of a report becomes large, a report in .xlsx
format will be split into several chunks like follows; entry_0000.xlsx
, entry_0001.xlsx
, entry_0002.xlsx
, …