SyncriTab User's Guide

Set up SyncriTab, administer it for your team, and query your databases from a web browser.

Draft. Every topic below has a placeholder page. Content will be added page by page.

Getting Started

Introduction: What SyncriTab is, its main features, and how it relates to WinSQL.
System Requirements: Supported platforms (Windows, Linux, and Docker), memory and disk space, web browsers, and network access.
Installing SyncriTab: Installing on Windows and Linux, running SyncriTab in Docker, starting and stopping SyncriTab, opening it for the first time, and uninstalling.
Initial Setup: The first-run wizard: creating the administrator account, registering your copy, and entering the serial number for your 30-day trial.
Signing In: Signing in and out, two-factor authentication, staying signed in, resetting a forgotten password, and fixing sign-in problems.
User Roles: What Administrators, DB Managers, and Developers can do, combining roles, and how roles affect licensing.

Administration

Dashboard: Server statistics for administrators and DB Managers: users, data sources, uptime, active sessions, memory and disk usage, and who is connected right now.
Server Configuration: HTTP and HTTPS ports, the preferred URL, the email server (basic authentication, client certificate, or OAuth), test emails, and security settings.
SSL Certificates: Turning on HTTPS with a self-signed, Let's Encrypt, imported, or CA-signed certificate, and renewing it.
User Management: Adding, editing, and deleting users, assigning roles, IP restrictions, MFA email addresses, and developers' data source access.
Security & Encryption: Mandatory two-factor authentication, IP blocking and restrictions, idle timeouts, alert recipients, encrypting data at rest, and a security checklist.
Updating & Restarting: Checking for and installing updates, installing a custom build from Synametrics Support, and restarting SyncriTab.

Data Source Management

Data Sources & Permissions: Creating, testing, editing, and deleting data sources, and choosing which developers can use each one.
JDBC Drivers: The drivers included with SyncriTab, and installing, updating, and deleting drivers from database vendors.
Reports: The Scheduled Task Activity, Query Activity, and Login Audit reports: who can see them and how long their data is kept.

Working with Databases

The Query Workspace: A tour of the developer's main screen: the app bar, menus, toolbar, catalog pane, tabs, SQL editor, results, and status bar.
Connecting to a Database: Connecting with your database account, manual commit, switching data sources, disconnecting, and fixing connection problems.
Browsing the Catalog: Selecting a database, schema, and object type; exploring tables, views, and procedures; browsing data; and the catalog right-click menu.
Writing SQL: The SQL editor, IntelliSense, commenting blocks, and find and replace.
Running Queries & Results: Running all or part of a script, multiple result sets, the Messages tab, the results grid and its right-click menu, and row limits.
Insert/Update Wizard: Adding a new row or editing an existing row with a form-based wizard: filling in field values, reading the generated SQL, and executing the change.
Query Pages, Scripts & Workbooks: Working with multiple query pages, and saving and opening scripts and workbooks.
Saved Sessions: How SyncriTab saves your query pages and results automatically, how to restore them, and the size limits that apply.
Query History: Finding, filtering, and re-running queries you ran earlier.
ER Diagrams: Viewing and managing table relationships as an entity-relationship diagram.
Exporting & Importing Data: Exporting query results and tables with the Export wizard, and importing data from text files.
Schema Diff: Comparing two database schemas and reviewing the differences.
Database Search: Finding tables, views, columns, procedures, and triggers whose names or definitions contain a search term.
Reverse Engineering: Generating a SQL script that recreates the tables, views, stored procedures, and triggers of an existing database.
Task Scheduler: Scheduling SQL scripts and data exports to run automatically, and reviewing results.
Options & Preferences: Your personal settings: row limits, the query terminator, auto-save, IntelliSense, and the results grid.
Keyboard Shortcuts: The default keyboard shortcuts, changing them, and the SQL editor's own keys.

Account & Support

Your Account: Changing your password and setting up two-factor authentication.
Licensing & Purchasing: How licenses are counted, trial limits, purchasing and renewing, and adding or removing developer licenses.
Getting Support: Sending a support request from within SyncriTab, attaching log files, and viewing previous tickets.
Backups: What SyncriTab backs up, the nightly schedule, where backup files are stored, running a backup manually, and restoring from a backup.
Troubleshooting: When SyncriTab won't start or can't be reached, is slow, doesn't send email, or no administrator can sign in, and where each feature's troubleshooting is.
Glossary: Definitions of terms used in this guide.