Contents Diagrams Roles Schemas Tables Views Procedures Functions

Database Help Framework
for Microsoft SQL Server

Tables

TableDescription
doc.formatsThis application table contains Excel table formats of the database help framework objects.
doc.handlersThis application table contains Excel event handlers of the database help framework objects.
doc.helpThis user table contains database help.
doc.help_sectionsThis application table contains help sections.
doc.historyThis user table contains database change history.
doc.history_sectionsThis application table contains database change history sections.
doc.objectsThis application table contains the configuration of saving changes.
doc.translationsThis application table contains translations of the database help framework objects.
doc.workbooksThis application table contains workbook configuration for SaveToDB Application Workbooks wizard.

doc.formats

This application table contains Excel table formats of the database help framework objects.

ColumnDataTypeNullComment
IDintIdentity
TABLE_SCHEMAnvarchar(20)xls.formats.TABLE_SCHEMA
TABLE_NAMEnvarchar(128)xls.formats.TABLE_NAME
TABLE_EXCEL_FORMAT_XMLxmlxls.formats.TABLE_EXCEL_FORMAT_XML

This table is a copy of the xls.formats table of the SaveToDB Framework to avoid external dependency.

See Configuring Table Formats.

doc.handlers

This application table contains Excel event handlers of the database help framework objects.

ColumnDataTypeNullComment
IDintIdentity
TABLE_SCHEMAnvarchar(20)xls.handlers.TABLE_SCHEMA
TABLE_NAMEnvarchar(128)xls.handlers.TABLE_NAME
COLUMN_NAMEnvarchar(128)xls.handlers.COLUMN_NAME
EVENT_NAMEvarchar(25)xls.handlers.EVENT_NAME
HANDLER_SCHEMAnvarchar(20)xls.handlers.HANDLER_SCHEMA
HANDLER_NAMEnvarchar(128)xls.handlers.HANDLER_NAME
HANDLER_TYPEvarchar(25)xls.handlers.HANDLER_TYPE
HANDLER_CODEnvarchar(max)xls.handlers.HANDLER_CODE
TARGET_WORKSHEETnvarchar(128)xls.handlers.TARGET_WORKSHEET
MENU_ORDERintxls.handlers.MENU_ORDER
EDIT_PARAMETERSbitxls.handlers.EDIT_PARAMETERS

This table is a copy of the xls.handlers table of the SaveToDB Framework to avoid external dependency.

See Configuring Event Handlers.

doc.help

This user table contains database help.

ColumnDataTypeNullComment
IDintIdentity
SECTION_IDtinyintdoc.help_sections.ID

Help section:

1 - Objects
2 - Schemas
3 - Roles
4 - Diagrams
5 - Pages
6 - Properties
TABLE_SCHEMAnvarchar(20)Object schema or special keywords: Roles, Schemas
TABLE_NAMEnvarchar(128)Object name
COLUMN_NAMEnvarchar(255)Column or parameter name.

The field must contain NULL for help rows of database objects.
LANGUAGE_NAMEchar(2)Two characters of the description language code like 'en' or 'fr'.
VERSIONnvarchar(50)Database object version for informational purposes.

The field is not used for columns and parameters.
DESCRIPTIONnvarchar(1024)Database object, column or parameter description.
COMMENTnvarchar(max)Database object complete description.

The field is not used for columns and parameters.

The table contains help topics for different areas like objects, schemas, roles, etc.

These areas have different SECTION_ID values.

The application includes several views from different areas.
These views have specific edit procedures configured in the doc.objects table.

The table has a unique index that includes fields: SECTION_ID, TABLE_SCHEMA, TABLE_NAME, COLUMN_NAME, and LANGUAGE_NAME.

doc.help_sections

This application table contains help sections.

ColumnDataTypeNullComment
IDtinyintApplication-defined values (see below).

Do not change the values.
SECTIONnvarchar(50)Section of the doc.help table.

Values:

IDSECTION
1Objects
2Schemas
3Roles
4Diagrams
5Pages
6Properties

The application assigns and uses the sections programmatically.

doc.history

This user table contains database change history.

ColumnDataTypeNullComment
IDintIdentity
TABLE_SCHEMAnvarchar(20)Related database schema
LANGUAGE_NAMEchar(2)Two characters of the description language code like 'en' or 'fr'.
VERSIONnvarchar(50)Version of changes
SECTION_IDtinyintdoc.history_sections.ID

Section of changes:

1 - Version Title
2 - Announcements
3 - New Features
4 - Improvements
5 - Bug Fixes
SORT_ORDERtinyintSort order of the topic inside the section
DESCRIPTIONnvarchar(1024)Header line
COMMENTnvarchar(max)Change description

Use the doc.view_history view to edit data.

doc.history_sections

This application table contains database change history sections.

ColumnDataTypeNullComment
IDtinyintApplication defined values:

1 - Version title
2 - Announcements formatted as paragraphs
Other sections formatted as lists
SECTIONnvarchar(50)Name of the section of changes.

Use the doc.translations table to translate names.

Values:

IDSECTION
1Version Title
2Announcements
3New Features
4Improvements
5Bug Fixes

Use the doc.translations table to translate section names.

doc.objects

This application table contains the configuration of saving changes.

ColumnDataTypeNullComment
IDintIdentity
TABLE_SCHEMAnvarchar(20)xls.objects.TABLE_SCHEMA
TABLE_NAMEnvarchar(128)xls.objects.TABLE_NAME
TABLE_TYPEnvarchar(128)xls.objects.TABLE_TYPE
TABLE_CODEnvarchar(max)xls.objects.TABLE_CODE
INSERT_OBJECTnvarchar(max)xls.objects.INSERT_OBJECT
UPDATE_OBJECTnvarchar(max)xls.objects.UPDATE_OBJECT
DELETE_OBJECTnvarchar(max)xls.objects.DELETE_OBJECT

This table is a copy of the xls.objects table of the SaveToDB Framework to avoid external dependency.

See Configuring Query Lists.

doc.translations

This application table contains translations of the database help framework objects.

ColumnDataTypeNullComment
IDintIdentity
TABLE_SCHEMAnvarchar(20)xls.translations.TABLE_SCHEMA
TABLE_NAMEnvarchar(128)xls.translations.TABLE_NAME
COLUMN_NAMEnvarchar(128)xls.translations.COLUMN_NAME
LANGUAGE_NAMEchar(2)xls.translations.LANGUAGE_NAME
TRANSLATED_NAMEnvarchar(128)xls.translations.TRANSLATED_NAME
TRANSLATED_DESCnvarchar(1024)xls.translations.TRANSLATED_DESC
TRANSLATED_COMMENTnvarchar(2000)xls.translations.TRANSLATED_COMMENT

This table is a copy of the xls.translations table of the SaveToDB Framework to avoid external dependency.

You may edit the translation and add new translations for the required languages.

You may use the doc.usp_translations procedure to edit translation for multiple languages in a pivot table.

See Configuring Data Translation.

doc.workbooks

This application table contains workbook configuration for SaveToDB Application Workbooks wizard.

ColumnDataTypeNullComment
IDintIdentity
NAMEnvarchar(128)Workbook name
TEMPLATEnvarchar(255)Template workbook path or URL.

The template workbook is not necessary.
The add-in can create a workbook using the definition only.
However, you may supply the workbook to have special features.

You may use Wizards, Developer Wizard, Prepare Workbook for Distribution to remove sensitive data and passwords from the workbook.
DEFINITIONnvarchar(max)Workbook definition.

Use the Help, Workbook Information, Workbook Definition menu item to get the definition of any opened workbook.

The SaveToDB add-in allows generating workbooks using the Application Workbooks wizard.

The add-in loads the workbook configuration from this table.

This is an application table.
If you need to generate other application workbooks, use the xls.workbooks table.

See also Configuring Application Workbooks.

Contents

This website is using cookies. By continuing to browse, you give us your consent to our use of cookies as explained in our Cookie Policy.