Try Studio 3T for Free
  1. Knowledge Base
  2. Job Automation & Scheduling
  3. Server 3T | Job Automation & Remote Scheduling Tool for MongoDB

Server 3T | Job Automation & Remote Scheduling Tool for MongoDB

Server 3T is a server-side job automation tool for MongoDB. When used with Studio 3T, it lets you run remote on-demand or scheduled MongoDB jobs directly on a Windows or Linux server.

It can be used with your existing SQL and MongoDB databases, whether on-prem or cloud-hosted (e.g. MongoDB Atlas clusters).

Users on a License Manager-based Studio 3T Core, Pro, or Enterprise license can immediately download and try Server 3T for free.

Users on a legacy license or the free Studio 3T 30-day trial can still contact us for a free custom trial.

Supported Server 3T tasks

The current version supports these tasks, with more to come in future releases:

Server 3T network diagram

How Server 3T works

Installation

Done with installation? Run your first export or migration

Windows

1. Download Server 3T here.

2. Unzip the Server 3T zip file to your preferred folder.

3. Only if using Windows Defender Firewall: Allow the OpenJDK Platform binary app.

Steps

1. Go to Control Panel > Windows Defender Firewall. Click on Allow an app or feature…
2. Go to wherever_server_3t_is_located\jre\bin\ and choose the java application file.

Open the Java file

3. OpenJDK Platform binary should appear in your list of allowed apps/features. Choose to allow it publicly or privately as needed, and click OK.

Allow OpenJDK Platform binary

4. Double-click the file initialize.bat in the Server 3T installation folder to generate a certificate request. Alternatively, run it from the Command Prompt.

In case you see a pop up warning when launching .bat files,  click Run anyway.

Windows warning when launching .bat files

After running initialize.bat, the certificate information will be stored in a file called server_req.pem.

5. Copy the generated certificate request. You will need to paste the entire text – including the lines —–BEGIN CERTIFICATE REQUEST—– and —–END CERTIFICATE REQUEST—– – into the License Manager.

Generated certificate request

6. Log into your License Manager account and click on Server 3T on the left sidebar.

Click on Server 3T on the left sidebar

7. Click on Register an instance.

8. Paste the certificate request into the text box and click on Register. The Server 3T instance will then be linked with your Studio 3T license, and the 512 MB credit will be applied automatically.

Paste your certificate request in the text box

If the Register button remains greyed out, make sure that you have also pasted the lines —–BEGIN CERTIFICATE REQUEST—– and —–END CERTIFICATE REQUEST—–.

9. To continue the setup, open server3t.ini.example (for first time installs) or server3t.ini from the directory into which you unzipped the Server 3T zip file, which contains default values and a comment describing each configuration value.

For first time installs, you need to rename server3t.ini.example to server3t.ini. Otherwise, a config file won’t be detected. You will see this error message and Server 3T will not launch.

server3t.ini error


The server3t.ini file

10. Change the values as needed.

For example, you’ll most likely change the listen address from 127.0.0.1 to something else, so not only your local machine has access to it. Configure the listen address according to your setup.

If you plan to connect to Oracle, IBM DB2, or Sybase, complete sub-steps 11-13.
Users who don’t need Oracle, IBM DB2, or Sybase can skip right to step 14.

11. For Oracle, IBM DB2, or Sybase users: You will need to download the official JDBC driver .jar files and put them in the drivers folder, which is already in your unzipped Server 3T folder.

Here are the links to the download files: Oracle, IBM DB2 and Sybase

12. Make changes as needed to the server3t.ini file.

Important fields in the server3t.ini file

  • The lines boxed in red need to be changed to enabled=true if working with that SQL database, otherwise it won’t work.
  • The lines boxed in green are the expected .jar file names in the drivers folder.Make sure the file names here in the server3t.ini file match those in the drivers folder.
  • The lines boxed in blue need to be adjusted if either the path or the file name differs. The ; in front of the jdbcDriver=…. would also need to be removed.

13. Configure your JDBC driver in Studio 3T by going to Studio 3T > Preferences > JDBC Drivers, then select the JAR file from your directory.

Configure the Oracle and IBM DB2 JDBC drivers under Preferences

14. Save the changes you’ve made to the server3t.inifile.

15. Run launch.bat by double-clicking on the file in the Server 3T installation folder. It should show a similar message:

Server 3T running

Server 3T runs in the cmd window, so closing this window will shut down Server 3T.

Alternative: Run Server 3T as a system service

1. Run install_service.bat from the Server 3T installation folder as administrator.

Run install_service_bat as administrator

Note that the script requires administrator permissions, otherwise you will see this screen.

You will see this prompt after running install_service_bat

2. If successfully run as administrator, you should see a confirmation that the Server 3T system service has been installed.

You can then also choose to edit settings by typing Y when prompted.

Edit service settings
This will allow you to edit the default settings through the NSSM service editor.

NSSM service editor

4. Go to Services – or do a search for it on your machine.

Open Services on your Windows machine
5. Choose Server 3T from the list and click on Start.

Click on Start to run Server 3T as a service

16. Finish the configuration by opening Studio 3T, clicking on the Server 3T icon in the global toolbar, and selecting Connection settings.

Configure connection settings in Server 3T

17. Enter your port and host name or address (from which you can reach the server within your network) and configure the other sections (e.g. SSL, proxy, protocol) as needed.

Regarding SSL settings:

  • If you’re using the default certificate from Step 4, please make sure to check the “Accept any server SSL certificate” box.
  • If you’d like to use a certificate issued by your organization or an otherwise signed certificate, you can replace the ssl_key.pem and ssl_cert.pem files generated by the script, or adjust the server3t.ini file to point to your custom key pair. This means you do not have to check the “Accept any server SSL certificate” box.

18. Click on Test Connection and apply configuration and debug as needed.

If you get an error, please make sure that your firewall is configured to allow connections to Server 3T (See installation step #3).

If you see such an error, refer back to installation step 3

19. Once successfully tested, click OK. Studio 3T is now configured to run with Server 3T.

Successful configuration of Server 3T

Linux

Prerequisite

Install libgtk-3-0 by running the following command in the terminal as root or using sudo:

apt install libgtk-3-0

Steps

1. Download Server 3T here.

2. From a terminal, run the following command to extract the .tar.gz file.

tar xf server3t-linux.tar.gz

3. Navigate to the extracted “server3t” installation folder and run the initialize.sh script to generate a certificate request.

 ./initialize.sh

After running initialize.sh, the certificate information will be stored in a file called server_req.pem.

4. Copy the generated certificate request. You will need to paste the entire text – including the lines —–BEGIN CERTIFICATE REQUEST—– and —–END CERTIFICATE REQUEST—– – into the License Manager.

5. Log into your License Manager account and click on Server 3T on the left sidebar.

Click on Server 3T on the left sidebar

6. Click on Register an instance.

7. Paste the certificate request into the text box and click on Register. The Server 3T instance will then be linked with your Studio 3T license.

Paste your certificate request in the text box

If the Register button remains greyed out, make sure that you have also pasted the lines —–BEGIN CERTIFICATE REQUEST—– and —–END CERTIFICATE REQUEST—–.

8. To continue the setup, open server3t.ini.example (for first time installs) or server3t.ini from the directory into which you unzipped the Server 3T zip file, which contains default values and a comment describing each configuration value.

For first time installs, you need to rename server3t.ini.example to server3t.ini. Otherwise, a config file won’t be detected. You will see this error message and Server 3T will not launch.

Server 3T error on Linux when missing the config file

9. Change the values as needed.

The server3t.ini file

For example, you’ll most likely change the listen address from 127.0.0.1 to something else, so not only your local machine has access to it. Configure the listen address according to your setup.

If you plan to connect to Oracle, IBM DB2, or Sybase, complete sub-steps 10-12.
Users who don’t need Oracle, IBM DB2, or Sybase can skip right to step 13.

10. For Oracle, IBM DB2, or Sybase users: You will need to download the official JDBC driver .jar files and put them in the drivers folder, which is already in your unzipped Server 3T folder.

Server 3T linux drivers folder

Here are the links to the download files: Oracle, IBM DB2 and Sybase

11. Make the necessary changes to the server3t.ini file.

Important fields in the server3t.ini file

  • The lines boxed in red need to be changed to enabled=true if working with that SQL database, otherwise it won’t work.
  • The lines boxed in green are the expected .jar file names in the drivers folder.Make sure the file names here in the server3t.ini file match those in the drivers folder.
  • The lines boxed in blue need to be adjusted if either the path or the file name differs. The ; in front of the jdbcDriver=…. would also need to be removed.

12. Configure your JDBC driver in Studio 3T by going to Studio 3T > Preferences > JDBC Drivers, then select the JAR file from your directory.

Configure the Oracle and IBM DB2 JDBC drivers under Preferences

13. Save the changes you’ve made to the server3t.ini file.

14. Run launch.sh – located in the Server 3T installation folder – from a terminal. It should show a similar message:

Running launch.sh on Linux

ERROR: java.nio.file.AccessDeniedException: /var/run/server3t.pid

If you run into this error, you would need to either:

  • Run the launch.sh script as root (e.g. using sudo), which is the more common solution, or
  • Change the pidFile path found in the [system] section of the server3t.ini file to something where you have write permissions.pidFile path on server3t.ini

Alternative: Run Server 3T as a system service

Run install_service.sh from the Server 3T installation folder.

Note that the script needs to be run as root, which can be done through sudo or by actually logging in as root.

When done successfully, you should see the following output:

Running Server 3T as a service on Linux

When not run as sudo or root, you will see the following error:

Running Server 3T as a service on Linux - error when not running as sudo/root

15. Finish the configuration by opening Studio 3T, clicking on the Server 3T icon in the global toolbar, and selecting Connection settings.

Configure connection settings in Server 3T

16. Enter your port and host name or address (from which you can reach the server within your network) and configure the other sections (e.g. SSL, proxy, protocol) as needed.

Regarding SSL settings:

  • If you’re using the default certificate from Step 3, please make sure to check the “Accept any server SSL certificate” box.
  • If you’d like to use a certificate issued by your organization or an otherwise signed certificate, you can replace the ssl_key.pem and ssl_cert.pem files generated by the script, or adjust the server3t.ini file to point to your custom key pair. This means you do not have to check the “Accept any server SSL certificate” box.

17. Click on Test Connection and apply configuration and debug as needed.

If you see such an error, refer back to installation step 3

18. Once successfully tested, click OK. Studio 3T is now configured to run with Server 3T.

Successful configuration of Server 3T

Run remote exports or migrations on the spot

New exports or migrations (unsaved tasks)

1. Set up any export or migration. Find the full list of supported tasks here.

2. Run the operation on Server 3T.

Exports

To run any export type, click on Execute and choose Execute on Server 3T.

Execute export on-demand on Server 3T

Migrations

To run an entire migration, click on Run migration and choose Run migration on Server 3T.

Run the SQL migration remotely

To run only a part of the migration, select the import units from the Overview tab. Click on Run selected units and choose Run selected units on Server 3T.


Run only selected units of a migration remotely

3. Name the operation. You can also save the task in Studio 3T by checking the box below. Click OK.

Name the operation

By saving the operation as a task, you will see it listed in your Task Manager where you can run, schedule, or unschedule it as needed.

Task Manager with newly-saved task

4. You should see a message confirming the operation will be run on Server 3T. Click OK to confirm.

Confirmation that task will be executed on Server 3T

5. You will be redirected to Server 3T’s Operation log tab where you can check the status of all Server 3T operations. Your recent job should appear on top. The Operations panel on the bottom-left corner will show only the status of your recently-run operation.

Server 3T Operation Log

Note on MongoDB to SQL migrations

Server 3T will always use the path supplied in the configuration file as the SQL target directory. To adjust the SQL target directory, update the configuration file.

Saved exports and migrations (saved tasks)

1. Click on Tasks in the global toolbar.

2. Under the Task list tab, choose a task from the list then click on Run on Server 3T.

Run task on Server 3T

3. You should see a message confirming the migration will be run on Server 3T. Click OK to start the migration.

Confirmation that task will be executed on Server 3T

4. You will be redirected to Server 3T’s Operation log tab where you can check the status of all Server 3T operations. Your recently-run job should appear on top. The Operations panel on the bottom-left corner will show only the status of your recently-run operation.

Server 3T Operation Log

Schedule exports and migrations on your server

If you’ve already saved the export or migration as a task, skip to Step 3.

1. Set up any export or migration. Find the full list of supported tasks here.

2. Save the operation as a task, name it, then click OK.

Save the migration as a task, then click OK

3. Click on Open Task Viewer to view your saved task(s). Alternatively, click on the Tasks button in the toolbar.

4. Under the Task list tab, choose the task you want to run on Server 3T then click Schedule.

Click on Schedule to schedule the task

Learn more about other supported tasks you can schedule through Task Scheduler.

5. Choose Server 3T as the execution target, schedule the task, then click Save.

Choose the date and time

Your task will then appear under the Scheduled Server 3T tasks tab.

Choose a task from the list to activate the Edit schedule to make changes to the schedule, and the Unschedule button to remove a task from the list.

Scheduled Server 3T tasks

7. The migration will run remotely on your server instance on the scheduled date and time. You can check its progress by clicking on Server 3T in the global toolbar and clicking on the Operation log tab.

Note on MongoDB to SQL migrations

If the user chooses to migrate to a SQL file instead of a SQL server, MongoDB to SQL migrations might produce output files. In such cases, the download link (Click here to download) becomes available under the “Output files” column.

Download export files

Click on the download link to save the export files

  1. Click on the Operation log tab.
  2. Choose the export operation whose file you would like to download. Under Output files, click on Click here to download.
  3. You will be prompted to open or save the file to your configured target location. Click OK.

Cancel selected operations

Cancel selected operations in Server 3T

  1. Go to the Operation log tab.
  2. Select the operations in progress to cancel.
  3. Click on Cancel selected operations.
  4. Click OK.

Remove finished operations from the log

Remove finished operations from the log

  1. Go to the Operation log tab.
  2. Choose the operations to remove from the log, including any jobs started by a “foreign instance” (e.g. other Studio 3T users/team members sharing the same Server 3T instance).
  3. Click on Remove selected finished operations.
  4. Click OK.

Save operation logs as .log or .csv files

Save logs as .log or .csv files

  1. Click on the Operation log.
  2. Select an operation to view its log details.
  3. Click on Save to save as a .log file, or click on Save as CSV to save as a .csv file. Note that you can only save the operation log as a file one task at a time.

FAQ

Is there a free Server 3T trial?

Yes. Users on a License Manager-based Studio 3T Core, Pro, or Enterprise license can download and install Server 3T, and claim their free 512 MB credit directly through the License Manager.

The 512 MB credit is granted per license. This means the credit will be split among all users, whether you have one seat or 15 seats on one license. There is also no trial time limit. The credit will remain valid for the duration of the license.

Interested users on a Studio 3T legacy license or the free 30-day trial can contact us for a custom trial.

Can we try Server 3T as a team? 

The Studio 3T license admin/owner first needs to configure the Server 3T instance.

Users need to be on the same Studio 3T license to access the same Server 3T instance. We will not support the case of users on License A being able to trial Server 3T through License B.

What happens after the free trial?

Once you run out of the free 512 MB credit, you will need to purchase Server 3T.

Server 3T can be purchased per core (or parallel execution unit) – not by quota.

How can I purchase Server 3T?

Server 3T only works with an active Studio 3T Core, Pro, or Enterprise license.


If you already have a compatible Studio 3T license

Server 3T can be purchased per core (or parallel execution unit). Each core costs $4,999 and is not limited by volume or number of users.

Purchasing one core means your team can run their scheduled exports and migrations sequentially. Purchasing two cores means you can run up to two jobs in parallel, and so on. The more cores you purchase, the more jobs you can run in parallel.

Contact our Sales team to purchase Server 3T.

Updated on March 16, 2021

Was this article helpful?

Related Articles

Leave a Comment