SentryOne Workbench

Workbench Features

After the SentryOne Workbench is installed, launching the SentryOne Workbench automatically directs you to the Workbench toolbar with the Feature Finder page selected. 

In the upper left corner of SentryOne Workbench is a toolbar buttonSentryOne  Workbench Toolbar button that allows you to minimize and maximize the Workbench toolbar. SentryOne  Workbench Feature Finder

 The Workbench toolbar contains six options that help you navigate to or configure the following features:

Toolbar OptionDescription
Feature FinderAllows you to navigate through the features in the SentryOne Workbench.
ActivitiesGives you an historical record of all actions taken across each product feature during the current session, and allows you to search activities that occurred in previous sessions.
OpenA way to open supported files. Selecting Open automatically opens the best feature for the selected file.
Open RecentGives you a list of recently opened files. Selecting Open Recent automatically opens the best feature for the selected file.
PreferencesDetails feature specific options, and allows you to customize the behavior of each feature as desired.
HelpAllows you to check for product updates, activate or deactivate licenses, and view product versions.

Tab Preview

While using the SentryOne Workbench, you can have several features open at same time. Display multiple features lined up side-by-side in tabs above your workspace. Hover over a tab to display a preview of that tab. 

SentryOne  Workbench Tab preview

Additionally, the SentryOne Workbench includes a Feature Switcher. The Feature Switcher makes switching between features much easier with a dedicated switching window that includes a preview window for each feature.                 

To open the Feature Switcher, enter Ctrl + Tab, which displays a pop up window, then release tab but continue to hold Ctrl. Enter tab to cycle through the currently open features. Once you've selected the desired feature, release Ctrl to navigate to that specific feature.

SentryOne  Workbench open Feature Switcher
SentryOne  Workbench Feature Switcher

Feature Finder

The Feature Finder allows you to navigate through the features in the SentryOne Workbench.

Sort the features by technology type, product family, a specific role, keywords, or use a combination of filters and/or keywords. These filters allow you to fine tune the SentryOne Workbench to your needs and make your frequently used features more readily available.

OptionDescriptionImage
TechnologyNarrow down the feature list by eliminating all features that are not associated with the selected technology.SentryOne  Workbench Filter Features by Technology
ProductNarrow down the feature list by eliminating all features that are not associated with the selected SentryOne Product.SentryOne  Workbench Filter Features by Product
RoleNarrow down the feature list by eliminating all features that are not associated with your role within your organization.SentryOne  Workbench Filter Features by Role
Keywords

Narrow down the feature list with the search toolbar by filtering out features that don't contain a specific keyword.

SentryOne  Workbench Filter Feature by Keyword

Activities

The Activities page gives you an historical record of all actions taken across each product feature during the current session, and allows you to search activities that occurred in previous sessions.

The Activities page also contains useful information regarding the activity's feature, title, information, status, date started or ended, and the activity log.

SentryOne  Workbench Activities

ComponentDescriptionImage
FeatureThe upper left corner of each activity contains the feature that generated the activity.SentryOne  Workbench Activity Monitor Feature
TitleOn the same line as the feature name separated by a colon (:), the title of the activity describes the action that occurred within the activity.SentryOne  Workbench Activity Monitor Title
InformationBelow the feature and activity title is a general description of the current status of the activitySentryOne  Workbench Activity Monitor Information
Date Started or EndedThe far right of the activity displays the date the activity started or ended depending on the current status of the activity.SentryOne  Workbench Activity Monitor Date
Activity LogDouble-click on an activity to view a more detailed activity log.SentryOne  Workbench Activity Monitor

Activity Status Legend

The background color of each activity visually describes the current status for the activity.

Color Description
RedActivity completed with at least one error.
GreenActivity completed successfully without errors
YellowActivity completed with warnings
BlueActivity is running, manually stopped, or completed with information.

Activity Search

The Activity window is a search tool that allows you to search through all activities (regardless of their session). Select the Search tab to begin searching for activities with specific search parameters. Selecting Search from within the Search tab opens the Search Activity Log window.

SentryOne  Workbench Activities Search tab
Activities Search Tab

SentryOne  Workbench Search Activity Log
Search Activity Log

The Search Activity Log contains five parameters to narrow down the search results by:

ParameterDescription
Finished AfterFilters all activities based on activities that finished after the start of a specific date parameter.
Finished BeforeFilters all activities based on activities that finished before the end of a specific date parameter.
Ending StatusFilters all activities based on the specific ending status of the activity.
Title ContainsFilters all activities based on the whether the title contains a specific string.
Message ContainsFilters all activities based on the whether the message contains a specific string.

Preferences

The Preferences page details feature specific options, and allows you to customize the behavior of each feature as desired. Including a general workbench section, each workbench product has its own preferences that can be used to customize the product's features individually. SentryOne  Workbench Preferences

Makes changes to the default key bindings for features and create custom keys by selecting Key bindings... at the bottom left of the Preferences window. SentryOne  Workbench Key Bindings

Workbench Preferences

Use Workbench Preferences to customize the behavior and properties of the SentryOne Workbench.

Appearance

SentryOne  Workbench Preferences Appearance

PreferenceDescription
Theme NameControls the theme used for Workbench colors.

Behavior

SentryOne  Workbench Preferences Behavior

PreferenceDescription
Selected ProductsControls the products to filter by when starting Workbench.
Selected RolesControls the roles to filter by when starting Workbench.
Selected TechnologiesControls the technologies to filter by when starting Workbench.
Show Feature FinderControls whether to show or hide the Feature Finder tool in the features list.
Show Works NewsControls whether to show or hide the Works latest news and messages. The latest product features, discounts, and tips will be shown here.
Start-up Plug-inControls the plug-in that loads when Workbench first starts.
Error ReportingControls whether to send anonymous error reporting information to Works.
Usage ReportingControls whether to periodically send anonymous feature usage reporting to Works.

DBA xPress Preferences

Use DBA xPress Preferences to customize the behavior and properties of Data Inspector, Data Space Analyzer, Data Surf, Schema Inspector, and Schema Surf:

Data Inspector

Comparison Defaults

SentryOne Workbench DBA xPress Preferences Data Inspector Comparison defaults

PreferenceDescription
Compare Intersecting IDENTITY Ranges OnlyControls whether segmented identity comparisons only consider the range of identity values that are covered in both databases.
Data Read TimeoutControls the timeout, in seconds, for opening the table data.
Default Index PreferenceControls the default index preference type.
Do not Compare Computed ColumnsControls whether computed columns that are not part of the key should be compared.
Ignore IDENTITY ValuesControls whether IDENTITY values should be ignored if they are not part of the key.
Ignore ROWGUIDCOL ColumnsControls whether ROWGUIDCOL columns should be ignored by default.
Ignore String CaseControls whether the case of strings should be ignored.
Ignore String Line EndingsControls whether differences in string line endings should be ignored.
Match Objects in any SchemaControls whether object matching should consider objects with the same name in other schemas.
Maximum Active ThreadsControls the maximum number of threads to use in threaded comparison mode.
Segmented Identity Compare Block SizeControls the number of rows in each segment for segmented identity comparisons.
Trim SpacesControls whether leading / trailing white spaces should be ignored when comparing strings.
Use Binary CLR Type ComparisonsControls whether CLR types should be compared using their binary, rather than their string representation.
Use Case Sensitive MatchingControls whether case-sensitive matching should be used to find or match object names.
Use Segmented Identity CompareControls whether segmented identity comparisons are used when the selected index is a single column index and the indexed column is an IDENTITY column.

General

SentryOne Workbench DBA xPress Preferences Data Inspector General

PreferenceDescription
Grid Viewer Row Count LimitSet the maximum number of rows to be viewable.
Start with deselected itemsData Inspector begins with deselected items.

Synchronization Defaults

SentryOne Workbench DBA xPress Preferences Data Inspector Synchronization defaults

PreferenceDescription
Batch SeparatorControls the batch separator used in between script portions.
Disable DML Triggers During SynchronizationControls whether DML triggers should be disabled during synchronization.
Disable Foreign Keys During SynchronizationControls whether foreign keys should be disabled during synchronization.
Max Rows per BatchControls the maximum number of rows per batch.
Only Update Compared ColumnsControls whether only the values selected at compare time should be updated when modifying existing rows.
Synchronize target DELETEsControls whether DELETEs on target are selected by default.
Synchronize target INSERTsControls whether INSERTs on target are selected by default.
Synchronize target UPDATEsControls whether UPDATEs on target are selected by default.
Use Transacted Modification SQLControls whether the data modification SQL should be transacted.

Data Space Analyzer

SentryOne Workbench DBA xPress Preferences Data Space Analyzer

PreferenceDescription
Default Database ViewSet the default Database View that displays within Data Space Analyzer when first loaded.
Default Server ViewSet the default Server View within Data Space Analyzer that displays when first loaded.
Show Data LabelsControls whether data labels displays by default.
Use fast loading on 2005+Controls whether to use faster and less detailed data about space usage.

Data Surf

SentryOne Workbench DBA xPress Preferences Data Surf

PreferenceDescription
Color InheritanceControls whether new nodes inherit their node colors from their parent.
Default Layout StyleControls the layout style that's selected.
Default Node ColorControls the default color given to nodes.
Failed Node ColorControls the default color given to nodes that data failed to load.
Graph FontControls the font style used for displaying text within nodes.
Grid FontControls the font style used for displaying the data within the grid.
LimitControls the maximum number of nodes that can be created in a single operation.
Warning LevelControls the number of nodes above which a warning is generated for a single operation.

Schema Inspector

Comparison Defaults

SentryOne Workbench DBA xPress Preferences Schema Inspector Comparison defaults

PreferenceDescription
Find Constraints by SignatureControls whether, after searching for a constraint match by name, Schema Inspector searches for it by signature.
Ignore Key Index PropertiesControls whether key index (primary key, unique constraint, target of foreign key constraint) properties should be ignored.
Ignore PartitioningControls whether partitioning should be ignored.
Ignore Referential ActionsControls whether referential actions should be ignored.
Ignore WITH NOCHECKControls WITH NO CHECK should be ignored.
Ignore Full Text Catalog Default SelectionControls whether the default property of full text catalogs should be ignored.
Ignore Full Text Index Accent SensitivityControls whether full text index accent sensitivity should be ignored.
Ignore Full Text Index Change TrackingControls whether full text index change tracking states should be ignored.
Ignore Full Text Index StoplistsControls whether full text index stop lists should be ignored.
Find Object in any SchemaControls whether schema-scoped objects can be searched for in any schema, emitting an ALTER SCHEMA statement during synchronization.
Ignore Corrected Object NamesControls whether object names which have been corrected are ignored during comparison.
Ignore Object PrincipalsControls whether object principals should be ignored.
Ignore Principal LoginsControls whether principal login differences should be ignored.
Ignore XML Schema Collection PropertiesControls whether XML schema collection properties for columns should be ignored.
Use Case Sensitive MatchingControls whether case sensitive matching should be used to find / match object names.
Ignore Fill FactorControls whether fill factor properties should be ignored.
Ignore Index Column InclusionControls whether included column properties should be ignored.
Ignore Index PaddingControls whether index padding properties should be ignored.
Ignore Key AscendancyControls whether key sort order properties should be ignored.
Ignore IGNORE_DUP_KEYControls whether IGNORE_DUP_KEY properties should be ignored.
Ignore Lock AlwaysControls whether allow row lock / allow page lock properties should be ignored.
Ignore ANSI NULLSControls whether the SET ANSI NULLS option state should be ignored.
Ignore Encrypted Object DifferencesControls whether object encryption differences should be ignored.
Ignore NULL on NULL InputControls whether NULL or NULL Input properties should be ignored.
Ignore Object EXECUTE AS PrincipalsControls whether object EXECUTE AS principals should be ignored.
Ignore Permission SetsControls whether assembly permission sets should be ignored.
Ignore QUOTED IDENTIFIERControls whether the SET QUOTED IDENTIFIER state should be ignored.
Ignore Schema BindingsControls whether schema binding properties should be ignored.
Ignore SQL CaseControls whether cases in SQL definitions should be ignored.
Ignore SQL CommentsControls whether comments in SQL definitions should be ignored.
Ignore SQL White SpaceControls whether white space in SQL definitions should be ignored.
Ignore WITH CHECK OPTIONControls whether WITH CHECK OPTION properties should be ignored.
Ignore WITH RECOMPILEControls whether WITH RECOMPILE properties should be ignored.
Ignore Event Notification Broker InstancesControls whether event notification broker instances should be ignored.
Ignore Event Notification Service NamesControls whether event notification service names should be ignored.
Ignore Maximum Queue ReadersControls whether maximum queue readers property should be ignored.
Consider Column OrderControls whether column order for tables and table types will be considered.
Ignore Boundary Value AlignmentsControls whether boundary value alignments on partition functions should be ignored.
Ignore CollationsControls whether collations should be ignored computed column persistence should be ignored.
Ignore Column SparsityControls whether column sparsity should be ignored.
Ignore Computed Column PersistenceControls whether computed column persistence should be ignored.
Ignore Data Space Default SelectionsControls whether data space default selections should be ignored.
Ignore File Group AssignmentsControls whether file group assignments should be ignored.
Ignore IDENTITYControls whether IDENTITY properties should be ignored.
Ignore IDENTITY Seed and IncrementControls whether IDENTITY seed and increment values should be ignored.
Ignore Maximum LengthControls whether the maximum length property should be ignored.
Ignore NOT FOR REPLICATIONControls whether NOT FOR REPLICATION should be ignored.
Ignore NullabilityControls whether nullability should be ignored.
Ignore Precision and ScaleControls whether precision and scale properties should be ignored.
Ignore ROWGUIDCOLControls whether row GUID column properties should be ignored.

Documentation

SentryOne Workbench DBA xPress Preferences Schema Inspector Documentation

PreferenceDescription
Default Report TypeControls the type of report generated by default.
Include Equivalent Objects in ComparisonControls whether to include details of objects that are equivalent while generating comparison documentation.
Include Modification DDL in SynchronizationControls whether to include the data definition language (DDL) script used while generating synchronization documentation.
Create New FolderControls whether to create a new folder when generating HTML reports.
Default Output FolderControls the default output folder for HTML reports.
Generate Page HeadersControls whether to generate page headers in the documentation.
Custom Style Sheet FileControls the location for a custom style sheet that will be used.
Use Collapsible Table of ContentsControls whether to use a collapsible table of contents containing JavaScript.
Use Default Style SheetControls whether to use the default Schema Inspector style sheet.
Comment ColorControls the color of comments.
Default Output FolderControls the default output folder for RTF reports.
Text ColorControls the color of text.
Function ColorControls the color of functions.
Identifier ColorControls the color of identifiers.
Keyword ColorControls the color of keywords.
Link ColorControls the color of links.
Number ColorControls the color of numbers.
Operator ColorControls the color of operators.
String ColorControls the color of strings.
Table Background ColorControls the color to use for table rows.
Table Header Background ColorControls the color to use for table headers.

General

SentryOne Workbench DBA xPress Preferences Schema Inspector General

PreferenceDescription
Group Comparison Results by TypesControls whether to group the results of the comparison by type.
Start with deselected itemsControls whether to start with items deselected when viewing comparison results.

Generation Defaults

SentryOne Workbench DBA xPress Schema Inspector Generation defaults

PreferenceDescription
Allow System Named ConstrainsControls whether system name constraints are emitted without names, to be named by the system on the target.
Always Load Definable Objects Direct from ServerControls whether definable object definitions should always be loaded direct from the server.
Always Specify CollationControls whether collation should always be specified, even if it is the same as the database default.
Auto Create Files for File GroupsControls whether, when creating file groups, files should be created in the same location as the first entry in sysfiles.
Batch SeparatorControls the batch separator used in between script portions.
Do not Warn About Unsafe AssembliesControls whether script generation warnings about unsafe assemblies should be suppressed.
Emit Generation Warnings in Output SQLControls whether warnings generated while generating SQL are emitted in the output.
Emit Table Constraints in LineControls whether table constrains are emitted with CREATE TABLE statements.
Fix Object Names in Definable ObjectsControls whether object names in definable objects should be corrected.
Keep Trigger OrderControls whether FIRST and LAST statements should be issued for triggers.
Replace User-defined SQL Types with Base TypesControls whether user defined SQL types should be replaced with base types in the target script.
Use Object Presence ChecksControls whether object presence checks should be emitted with generated SQL.
Use Online Index BuildingControls whether, if possible, the ONLINE ON clause should be emitted when creating indexes.
Use Store and Restore for CLR Type AlterationsControls whether table data should be stored in another table and restored again afterwards when altering CLR Types.
Use Transacted Schema Modification SQLControls whether generated SQL should be transacted.

Schema Surf

SentryOne Workbench DBA xPress Schema Surf

PreferenceDescription
Default Layout StyleControls the layout style that's selected.
Default Levels ShownControls the number of dependency levels to be shown.
Default Node ColorControls the color given to nodes.
Graph FontControls the font style used for displaying text within nodes.