Contents Diagrams Roles Schemas Tables Views Procedures Functions

Database Help Framework
for Microsoft SQL Server

Procedures

ProcedureDescription
doc.usp_translationsThis procedure is an Excel form to select and edit translations in all languages.
doc.usp_translations_changeThis procedure updates a database on cell changes of doc.usp_translations.
doc.xl_actions_database_documentationThis procedure generates the database documentation.
doc.xl_actions_set_role_permissionsThis procedure sets permissions for the doc_readers and doc_writers roles.
doc.xl_delete_help_columnThis procedure deletes a column help row.
doc.xl_delete_help_objectThis procedure deletes an object help row.
doc.xl_delete_help_parameterThis procedure deletes a parameter help row.
doc.xl_delete_help_rowThis procedure deletes a help row by id.
doc.xl_export_helpThis procedure exports help data.
doc.xl_export_settingsThis procedure exports Database Help Framework settings.
doc.xl_import_helpThis procedure imports a help row.
doc.xl_import_historyThis procedure imports a history row.
doc.xl_insert_help_diagramThis procedure inserts a diagram help row.
doc.xl_update_help_columnThis procedure updates a column help row.
doc.xl_update_help_diagramThis procedure updates a diagram help row.
doc.xl_update_help_objectThis procedure updates an object help row.
doc.xl_update_help_pageThis procedure updates a page help row.
doc.xl_update_help_parameterThis procedure updates a parameter help row.
doc.xl_validation_list_history_section_idThis procedure selects history sections to use as an Excel validation list source.

doc.usp_translations

This procedure is an Excel form to select and edit translations in all languages.

ParameterDataTypeModeComment
@fieldnvarchar(128)INThe source field of the doc.translations table: TRANSLATED_NAME, TRANSLATED_DESC, or TRANSLATED_COMMENT.

Editing data requires the SaveToDB Enterprise edition.

doc.usp_translations_change

This procedure updates a database on cell changes of doc.usp_translations.

ParameterDataTypeModeComment
@column_namenvarchar(128)INThe column name of the edited cell (expected doc.translations.LANGUAGE_NAME).
@cell_valuenvarchar(max)INA new value of the edited cell used to update for the source field.
@TABLE_SCHEMAnvarchar(128)INdoc.translations.TABLE_SCHEMA
@TABLE_NAMEnvarchar(128)INdoc.translations.TABLE_NAME
@COLUMNnvarchar(128)INdoc.translations.COLUMN_NAME
@fieldnvarchar(128)INThe source field of the xls.translations table: TRANSLATED_NAME, TRANSLATED_DESC, or TRANSLATED_COMMENT.

doc.xl_actions_database_documentation

This procedure generates the database documentation.

ParameterDataTypeModeComment
@languagechar(2)INdoc.help.LANGUAGE_NAME
@schemanvarchar(128)INPossible values:
- NULL (all schemas, default)
- Schema
- Schema mask like '%25' to select schemas like dbo25 and xls25
- 'x' to select all schemas except schemas of known frameworks

You may customize this procedure to generate the required HTML.

Note that the procedure uses words from the doc.translations table.
So, you may change the required terms in an easy way.

doc.xl_actions_set_role_permissions

This procedure sets permissions for the doc_readers and doc_writers roles.

Execute this procedure if you recreated any object of the doc schema.

doc.xl_delete_help_column

This procedure deletes a column help row.

ParameterDataTypeModeComment
@TABLE_SCHEMAnvarchar(128)INdoc.help.TABLE_SCHEMA
@TABLE_NAMEnvarchar(128)INdoc.help.TABLE_NAME
@COLUMN_NAMEnvarchar(255)INdoc.help.COLUMN_NAME
@LANGUAGE_NAMEchar(2)INdoc.help.LANGUAGE_NAME

See the configuration in the doc.objects table.

doc.xl_delete_help_object

This procedure deletes an object help row.

ParameterDataTypeModeComment
@SECTION_IDtinyintINdoc.help.SECTION_ID
@TABLE_SCHEMAnvarchar(128)INdoc.help.TABLE_SCHEMA
@TABLE_NAMEnvarchar(128)INdoc.help.TABLE_NAME
@LANGUAGE_NAMEchar(2)INdoc.help.LANGUAGE_NAME

See the configuration in the doc.objects table.

doc.xl_delete_help_parameter

This procedure deletes a parameter help row.

ParameterDataTypeModeComment
@ROUTINE_SCHEMAnvarchar(128)INdoc.help.TABLE_SCHEMA
@ROUTINE_NAMEnvarchar(128)INdoc.help.TABLE_NAME
@PARAMETER_NAMEnvarchar(255)INdoc.help.COLUMN_NAME
@LANGUAGE_NAMEchar(2)INdoc.help.LANGUAGE_NAME

See the configuration in the doc.objects table.

doc.xl_delete_help_row

This procedure deletes a help row by id.

ParameterDataTypeModeComment
@IDintINdoc.help.ID

See the configuration in the doc.objects table.

doc.xl_export_help

This procedure exports help data.

ParameterDataTypeModeComment
@languagechar(2)INTwo characters of the documentation language code like 'en' or 'fr'.
@schemanvarchar(128)INdoc.help.TABLE_SCHEMA

Use 'x' to export help for all schemas except doc, logs, and xls.

Exporting data using this procedure is a better choice.

It uses the doc.xl_import_help procedure to merge help topics correctly.

doc.xl_export_settings

This procedure exports Database Help Framework settings.

ParameterDataTypeModeComment
@parttinyintINNULL - all
1 - doc.objects
2 - doc.handlers
3 - doc.translations
4 - doc.formats
5 - doc.workbooks
6 - doc.sections
7 - doc.history_sections
@sort_by_namesbitIN1 - sort by names
0 - sort by id (default)
@languagechar(2)INdoc.help.LANGUAGE_NAME

You may use this procedure to export the framework settings, not the help.

doc.xl_import_help

This procedure imports a help row.

ParameterDataTypeModeComment
@SECTION_IDtinyintINdoc.help.SECTION_ID
@TABLE_SCHEMAnvarchar(128)INdoc.help.TABLE_SCHEMA
@TABLE_NAMEnvarchar(128)INdoc.help.TABLE_NAME
@COLUMN_NAMEnvarchar(255)INdoc.help.COLUMN_NAME
@LANGUAGE_NAMEchar(2)INdoc.help.LANGUAGE_NAME
@VERSIONnvarchar(50)INdoc.help.VERSION
@DESCRIPTIONnvarchar(1024)INdoc.help.DESCRIPTION
@COMMENTnvarchar(max)INdoc.help.COMMENT

The procedure is used in the scripts generated by the doc.xl_export_help procedure.

The procedure tries to update the record first. If the update fails, it inserts a new record.

doc.xl_import_history

This procedure imports a history row.

ParameterDataTypeModeComment
@TABLE_SCHEMAnvarchar(20)INdoc.history.TABLE_SCHEMA
@LANGUAGE_NAMEchar(2)INdoc.history.LANGUAGE_NAME
@VERSIONnvarchar(50)INdoc.history.VERSION
@SECTION_IDtinyintINdoc.history.SECTION_ID
@SORT_ORDERtinyintINdoc.history.SORT_ORDER
@DESCRIPTIONnvarchar(1024)INdoc.history.DESCRIPTION
@COMMENTnvarchar(1)INdoc.history.COMMENT

The procedure is used in the scripts generated by the doc.xl_export_help procedure.

The procedure tries to update the record first. If the update fails, it inserts a new record.

doc.xl_insert_help_diagram

This procedure inserts a diagram help row.

ParameterDataTypeModeComment
@DIAGRAM_SCHEMAnvarchar(128)INdoc.help.TABLE_SCHEMA
@DIAGRAM_NAMEnvarchar(128)INdoc.help.TABLE_NAME
@DIAGRAM_URLnvarchar(255)INdoc.help.COLUMN_NAME
@LANGUAGE_NAMEchar(2)INdoc.help.LANGUAGE_NAME
@VERSIONnvarchar(50)INdoc.help.VERSION
@TITLEnvarchar(1024)INdoc.help.DESCRIPTION
@COMMENTnvarchar(max)INdoc.help.COMMENT

See the configuration in the doc.objects table.

doc.xl_update_help_column

This procedure updates a column help row.

ParameterDataTypeModeComment
@TABLE_SCHEMAnvarchar(128)INdoc.help.TABLE_SCHEMA
@TABLE_NAMEnvarchar(128)INdoc.help.TABLE_NAME
@COLUMN_NAMEnvarchar(255)INdoc.help.COLUMN_NAME
@LANGUAGE_NAMEchar(2)INdoc.help.LANGUAGE_NAME
@VERSIONnvarchar(50)INdoc.help.VERSION
@DESCRIPTIONnvarchar(1024)INdoc.help.DESCRIPTION
@COMMENTnvarchar(max)INdoc.help.COMMENT

See the configuration in the doc.objects table.

doc.xl_update_help_diagram

This procedure updates a diagram help row.

ParameterDataTypeModeComment
@IDintINdoc.help.ID
@DIAGRAM_SCHEMAnvarchar(128)INdoc.help.TABLE_SCHEMA
@DIAGRAM_NAMEnvarchar(128)INdoc.help.TABLE_NAME
@DIAGRAM_URLnvarchar(255)INdoc.help.COLUMN_NAME
@LANGUAGE_NAMEchar(2)INdoc.help.LANGUAGE_NAME
@VERSIONnvarchar(50)INdoc.help.VERSION
@TITLEnvarchar(1024)INdoc.help.DESCRIPTION
@COMMENTnvarchar(max)INdoc.help.COMMENT

See the configuration in the doc.objects table.

doc.xl_update_help_object

This procedure updates an object help row.

ParameterDataTypeModeComment
@SECTION_IDtinyintINdoc.help.SECTION_ID
@TABLE_SCHEMAnvarchar(128)INdoc.help.TABLE_SCHEMA
@TABLE_NAMEnvarchar(128)INdoc.help.TABLE_NAME
@LANGUAGE_NAMEchar(2)INdoc.help.LANGUAGE_NAME
@VERSIONnvarchar(50)INdoc.help.VERSION
@DESCRIPTIONnvarchar(1024)INdoc.help.DESCRIPTION
@COMMENTnvarchar(max)INdoc.help.COMMENT

See the configuration in the doc.objects table.

doc.xl_update_help_page

This procedure updates a page help row.

ParameterDataTypeModeComment
@TABLE_SCHEMAnvarchar(128)INdoc.help.TABLE_SCHEMA
@TABLE_NAMEnvarchar(128)INdoc.help.TABLE_NAME
@LANGUAGE_NAMEchar(2)INdoc.help.LANGUAGE_NAME
@VERSIONnvarchar(50)INdoc.help.VERSION
@DESCRIPTIONnvarchar(1024)INdoc.help.DESCRIPTION
@COMMENTnvarchar(max)INdoc.help.COMMENT

See the configuration in the doc.objects table.

doc.xl_update_help_parameter

This procedure updates a parameter help row.

ParameterDataTypeModeComment
@ROUTINE_SCHEMAnvarchar(128)INdoc.help.TABLE_SCHEMA
@ROUTINE_NAMEnvarchar(128)INdoc.help.TABLE_NAME
@PARAMETER_NAMEnvarchar(255)INdoc.help.COLUMN_NAME
@LANGUAGE_NAMEchar(2)INdoc.help.LANGUAGE_NAME
@VERSIONnvarchar(50)INdoc.help.VERSION
@DESCRIPTIONnvarchar(1024)INdoc.help.DESCRIPTION
@COMMENTnvarchar(max)INdoc.help.COMMENT

See the configuration in the doc.objects table.

doc.xl_validation_list_history_section_id

This procedure selects history sections to use as an Excel validation list source.

ParameterDataTypeModeComment
@data_languagechar(2)INThe SaveToDB add-in passes a data language selected in the SaveToDB Options dialog box.
This is a predefined parameter.

See the configuration in the doc.handlers table.

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.