Automate MongoDB tasks
Tasks help you automate repetitive MongoDB jobs by allowing you to configure, save, and schedule tasks and run them as needed.
After saving your frequently-run jobs, you can run them on-demand using Tasks, or run them automatically by scheduling them.
What you can automate or schedule with Tasks will depend on your Studio 3T edition.
- Import Wizard (Basic, Pro and Ultimate)
- Export Wizard (Basic, Pro and Ultimate)
- Data Compare & Sync (Pro and Ultimate only)
- Reschema (Pro and Ultimate only)
- Data Masking (Ultimate only)
- SQL Migration (Ultimate only)
- IntelliShell Script Tasks (Basic, Pro and Ultimate)
- Go to the Studio 3T global toolbar and click on the Tasks button.
- This will open up the Tasks dialog, which provides an overview of all previously-saved tasks.
Create a task
To create a task, click on the New Task button. This will open the New Task dialog:
The dialog displays all the possible types of tasks you can create:
Select the task type and click OK. This will close the current dialogs and trigger the appropriate tab – depending on the task type – where you can continue to configure and save the task.
Here are the links to the relevant documentation:
- Import Wizard
- SQL to MongoDB Migration
- MongoDB to SQL Migration
- Data Compare and Sync
- Export Wizard
- Data Masking
Save a task
On top of each task tab is a toolbar with three buttons:
- Save task – Saves the task with its current name, or prompts the user to name it if it wasn’t saved yet.
- Save task as – Prompts the user to name the task and save it.
- Load task – Load the current task with the configuration of an existing saved task.
- Schedule – Set a schedule for automated execution of the task.
- Run – Executes the current configuration.
After saving the task, it will be visible in the Task Overview dialog:
Execute a task
- Select any number of tasks in the Task Overview dialog.
- Click the Run button, or right-click on the task(s) and choose Run. Studio 3T will then execute the task with the saved configuration.
You can track the progress of import jobs in the Operations panel. For Data Compare & Sync jobs, a Comparison Results tab will automatically open.
Find a task
You can search for and filter your saved tasks in the Task Overview dialog using the search bar on top.
Edit a task
- Select any number of entries in the Task Overview dialog.
- Click the Edit button, or right-click on the task(s) and choose Edit. This will bring up the corresponding tab, filled with the saved configuration.
Clone a task
- Choose any number of entries in the Task Overview dialog.
- Click the Clone button, or right-click on the task(s) and select Clone. A copy will be created for each selected Task, under the name “Copy of <task name>”.
Delete a task
- Choose any number of tasks in the Task Overview dialog.
- Click on the Delete button, or right-click on the task(s) and press Delete. The user will asked to confirm the deletion, after which the tasks will be deleted.
Schedule MongoDB tasks
Tasks, can be run on demand, or you can schedule jobs to be executed automatically at specified times.
To schedule a task, open the Task Overview dialog.
Double-click in the Schedule cell of the target task. This cell is initially empty, meaning that the task hasn’t been scheduled.
This will open the Task schedule editor, which allows you to schedule the task.
Setting the Recurrence field allows you to select a range of scheduling options. Whatever you select in the editor will be explained in the Schedule Summary:
You can choose to run the task once at a set time in the future:
Daily at a specific time:
You can also optionally set a date for when this schedule stops being run.
Runs the task every number of minutes or hours specified in the time interval field.
You can also specify a date and time when this repeated execution starts and optionally a date and time when it stops.
Runs the task on specified days of the week (not just once a week) at a specified time of the day.
You can also specify a date when this weekly execution starts and optionally a date when it stops.
Runs tasks on specific days of the month (not just once a month) and at a particular time of the day.
You can also specify a date when this monthly schedule starts and optionally a date when it stops.
Combining all the above scheduling options, the Custom recurrence allows for executions on days of the week, or of the month, or both. When scheduled, the task can be run once or repeated at a particular hourly/minute rate over a period of time during that day.
The custom schedule can also be started on a specific date and optionally be stopped on a different date.
Configure the schedule as desired and click Save. The task is now scheduled to run: