FileHold viewers - Custom preset annotations

Annotation property descriptions

The table below describes the available options for the annotation properties.

Managing annotation presets

Annotation presets are managed directly within the Microsoft SQL database. This section describes how to add, edit, and delete annotation presets. Each operation has its own stored procedure in the ch_librarymanager database.

Each operation in the database should be executed with an active transaction. Only data from successfully executed scripts is applied to the database. The example below describes how to execute a SQL query within a transaction.

BEGIN TRY 
   BEGIN TRANSACTION 
   -- <<< start of query to execute 

   -- write here some query 

   -- >>> end of query to execute 
   COMMIT 
END TRY 
BEGIN CATCH 
   IF @@TRANCOUNT > 0 ROLLBACK TRAN 
   DECLARE @error NVARCHAR(4000) = ERROR_MESSAGE() 
   RAISERROR( @error, 16, 1) 
END CATCH

Stored Procedures

The following are the stored procedures for annotation presets and their allowed parameters.

ch_AddViewerAnnotationPreset

Add an entry to the ViewerAnnotationPresets table.

ch_SetViewerAnnotationPresetValue

Add or edit annotation preset value (modifies ViewerAnnotationPresetValues table).

ch_UpdateViewerAnnotationPreset

Update annotation preset name.

ch_RemoveViewerAnnotationPreset

Remove annotation preset from the database.

Adding annotation presets

In order to add annotation preset, the following two stored procedures need to be executed:

• ch_AddViewerAnnotationPreset – Execute only once.
• ch_SetViewerAnnotationPresetValue – Execute zero or many times - repeat for each property.

Note: Since all default values for each annotation type is stored in the system database, there is no need to duplicate properties with default values in the annotation presets. In another words, annotation presets should consist of only the properties of which values are different that default ones.

For example, adding a rubber stamp annotation preset called “Edited in” that consists of following values:

• border color: #00FF00
• text size: 16
• text color: #00FF00
• text: “FileHold”

BEGIN TRY 
   BEGIN TRANSACTION 
   -- <<< start of query to execute 
   DECLARE @presetId INT 
   EXEC ch_AddViewerAnnotationPreset 0, 'Edited in', @presetId OUTPUT 
   EXEC ch_SetViewerAnnotationPresetValue @presetId, 'strokeColor', '#00FF00' 
   EXEC ch_SetViewerAnnotationPresetValue @presetId, 'fontSize', '16' 
   EXEC ch_SetViewerAnnotationPresetValue @presetId, 'foreColor', '#00FF00' 
   EXEC ch_SetViewerAnnotationPresetValue @presetId, 'text', 'FileHold' 
   -- >>> end of query to execute 
   COMMIT 
END TRY 
BEGIN CATCH 
   IF @@TRANCOUNT > 0 ROLLBACK TRAN 
   DECLARE @error NVARCHAR(4000) = ERROR_MESSAGE() 
   RAISERROR( @error, 16, 1) 
END CATCH

The stamp would appear as:

Image

Modifying annotation presets

In order to modify annotation presets, the following two stored procedures need to executed:

• ch_UpdateViewerAnnotationPreset – zero or once
• ch_SetViewerAnnotationPresetValue – zero or many times - repeat for each property

For example, changing the name of the annotation preset from “Edited by” to “Edited at” and set following properties:

• dash style: dash
• fill color: #FFFFFF
• text: “[[sys|now|yyyy-MM-dd HH:mm:ss]]” . This dynamic field will be automatically replaced with the current date and time. For a list of available tags, see Assemble document tags.
• border width: solid (0.08 inch)

BEGIN TRY 
   BEGIN TRANSACTION 
   -- <<< start of query to execute 
   DECLARE @presetId INT 
   SELECT @presetId = PresetId FROM ViewerAnnotationPresets WHERE PresetName like 'Edited in' 
   EXEC ch_UpdateViewerAnnotationPreset @presetId, 'Edited at' 
   EXEC ch_SetViewerAnnotationPresetValue @presetId, 'borderWidth', '0.08' 
   EXEC ch_SetViewerAnnotationPresetValue @presetId, 'dashStyle', '1' 
   EXEC ch_SetViewerAnnotationPresetValue @presetId, 'fill', 'true' 
   EXEC ch_SetViewerAnnotationPresetValue @presetId, 'fillColor', '#FFFFFF' 
   EXEC ch_SetViewerAnnotationPresetValue @presetId, 'text', '[[sys|now|yyyy-MM-dd HH:mm:ss]]' 
   -- >>> end of query to execute 
   COMMIT 
END TRY 
BEGIN CATCH 
   IF @@TRANCOUNT > 0 ROLLBACK TRAN 
   DECLARE @error NVARCHAR(4000) = ERROR_MESSAGE() 
   RAISERROR( @error, 16, 1) 
END CATCH

The stamp would appear as:

Image

Removing annotation presets

To delete annotation preset, execute following stored procedure:

• ch_RemoveViewerAnnotationPreset

The example below shows how to delete annotation preset with name “Edited at”. All property values associated with this preset will be removed automatically.

BEGIN TRY 
   BEGIN TRANSACTION 
   -- <<< start of query to execute 
   DECLARE @presetId INT 
   SELECT @presetId = PresetId FROM ViewerAnnotationPresets WHERE PresetName like 'Edited at' 
   EXEC ch_RemoveViewerAnnotationPreset @presetId 
   -- >>> end of query to execute 
   COMMIT 
END TRY 
BEGIN CATCH 
   IF @@TRANCOUNT > 0 ROLLBACK TRAN 
   DECLARE @error NVARCHAR(4000) = ERROR_MESSAGE() 
   RAISERROR( @error, 16, 1) 
END CATCH