Viewing TIFF Documents

TIFF documents can be viewed via the provided TIFF viewer, which provides the following functionality:

Section Configuration provides details about the provided configuration options for the TIFF viewer in the Configuration Panel. The following sections describe the different areas and their functionality:

Details

The Details pane provides the following details about the TIFF document:


Figure: Details Pane

Thumbnails Window

The Pages tab in the toolbar opens a split window with a thumbnail image of each document page displayed in the order that they appear in the document. Each thumbnail is labeled with its page number.

The thumbnail Window is linked to the main viewer window. If an image is selected in the thumbnail window, this page is displayed in the main viewer window.

Thumbnail Window
Figure: Thumbnail Window

Thumbnail Toolbar Functions

The following options are available in the toolbar:

Icon Function Comments
Cut The Cut option provides the possibility to move individual pages or groups of pages by cutting and pasting. The Cut icon is enabled when one or more thumbnails are selected. .
Paste Enabled when one or more thumbnails have been "cut" by the Cut option. The Paste option moves the page or pages, which have been added to the buffer by the Cut option after the currently selected thumbnail. The new thumbnail page order is reflected immediately in the thumbnail tree.
Move Page Up Moves the currently selected page or pages up one position each time clicked. The icon is enabled unless the selected page is page one. The new thumbnail page order is reflected immediately in the thumbnail tree.
Move Page Down Moves the currently selected page or pages up down one position each time clicked. The icon is enabled unless the selected page is the last page. The new thumbnail page order is reflected immediately in the thumbnail tree.
Reverse Order Reverses the page order of the entire document.
New Bookmark Adds a new bookmark to the bookmark list based on the selected page or page range. The Bookmarks Window is brought forward and the page or page range for the new bookmark is prefilled with the selected page or pages. You must specify the name of the bookmark to finish adding it.

Bookmarks Window

Click the Bookmarks tab in the toolbar to open the Bookmarks window. This split window displays a list of bookmarks defined for the document. Each bookmark is displayed as a row in the list. It has a descriptive name and a page or page range listed.


Figure: Bookmark Window

Each bookmark is linked to the main viewer window so that when a bookmark is clicked, the first page in the defined page range is displayed in the main Viewer Window.

A bookmark can be marked as the "default" bookmark so that the document automatically opens to the first page defined in that bookmark.

Bookmark Toolbar

The following toolbar options are available in the Bookmarks window:

Icon Function Comments
New Bookmark Adds a new bookmark to the bookmark list. By default, new bookmarks are added to the bottom of the list, but you may first select a bookmark in the list and then click New Bookmark to add the new bookmark immediately after the selected bookmark. The name of the bookmark and a page range for each new bookmark have to be specified.
Edit Bookmark Changes the selected bookmark name and page range fields to editable state. You may modify these fields in place Disabled by default, it is enabled when a bookmark is selected.
Delete Bookmark Deletes the selected bookmark.
Default Bookmark Marks the bookmark as the default, thus the first page in the bookmark's defined range is displayed when the document is opened. The default bookmark is indicated with a icon.
Move Bookmark Up Moves the currently selected bookmark up one position each time clicked. The icon is enabled unless the selected bookmark is the first bookmark. The new bookmark order should be reflected immediately in the table.
Move Bookmark Down Moves the currently selected bookmark down one position each time clicked. The icon is enabled unless the selected bookmark is the last bookmark. The new bookmark order should be reflected immediately in the table.
Exit Edit Mode Leaves the edit mode and applies the entered bookmark data.
Extract Pages Launches the Extract Pages dialog. Page ranges of the bookmark will be reflected in extract pages dialog. Note that if the TIFF document is associated with a case process instance and you open the TIFF document, the Extract Pages button of the TIFF viewer is disabled.

Adding Bookmarks

Bookmarks are added via the New Bookmark icon from the Bookmark window or the Pages window. A new row for the new bookmark is added. The Bookmark entry field gets editable, where you can enter a name for the bookmark. Per default, the currently open page is entered in the From and To fields. These values can be changed. Click the Exit Edit Mode icon to apply the values of the entries.


Figure: Enter Values for a New Bookmark

Adding New BookMark Rows

To add a new row of bookmarks, click the Add Bookmark link below the bookmarks table.


Figure: Add Bookmark

A new row gets added to the bookmarks table in edit mode.


Figure: Added row with new bookmark

Editing Bookmarks

To edit an existing bookmark, select it in the list and click the Edit Bookmark icon . Enter the new values and apply by clicking the Exit Edit Mode icon .

Exit the Edit Mode
Figure: Exit the Edit Mode

Saving Bookmarks

Bookmarks are not saved until you explicitly save the document via the Save icon in the view specific toolbar. Saving creates a new document version and versions the bookmarks.

In case bookmarks are added, modified, or deleted, this is marked for the document. You will be prompted to save the document when closing the viewer or logging out of the Stardust Portal.

Extract Pages Dialog

From the Bookmarks window you have the option to extract pages and specify the process definition in which the new process should start via the Extract Pages dialog. You can preset the page range to be extracted by selecting one or more bookmarks prior to launching the Extract Pages dialog.

Note that this option is disabled in case you modified the document, e.g. via page rotation or bookmarks. It will be re-enabled after saving the changed document.

Note that the Extract Pages functionality requires spawnSubProcessInstance permission.

To open the dialog, click the Extract Pages icon.

Toolbar Options

Additional Columns

You have the option to add the following additional columns to be displayed in the Extract Pages table:

Adding Rows

Click the to add a row to the table. In case you invoked the extract pages option from selected bookmarks, these bookmarks will be provided as rows already, as in the following example:


Figure: Extract Pages Rows Provided via Bookmarks

Deleting Rows

To delete a row, select it in the table and click the Delete icon.

Delete a Row
Figure: Delete a Row

Extracting Pages Table

Extract Pages Dialog
Figure: Extract Pages Dialog

Extract Pages

In the Extract Pages column you can specify a range of pages to extract from the source document. This can be populated by selecting one or more bookmarks prior to launching the Extract Pages dialog. Make sure the From value is lower than To and the specified pages are valid. Otherwise a validation error is displayed and the operation cannot be performed.

Start Process

Select the process definition in which the new process should be started. A drop-down list is provided containing the process definitions in which the logged-in user has authorization to start new process instances and which supports process attachments or use process data.

Please refer to the section Process Attachments of chapter Working with Process Definitions of the Stardust Online Documentation - Modeling Guide Process Attachments of chapter Working with Process Definitions in the Modeling Guide for details on process attachments.


Figure: Select Process

Document Type

In a drop down list, all Document Types are listed that are referenced to in the selected process. If the process does support process attachments, the default Document Type as well as all document Types in the model are provided. In case the process does not support process attachments, the default Document Type as well as Document Types referenced by the Document Data being referenced (e.g. via datapaths, datamappings, triggers) by the process definition are listed.

Document Type
Figure: Select Document Type

Document Data

The drop down list offers the Document Data (IDs) that are linked to the Document Type in the selected Starting Process in the following way:

  1. In case the default Document Type is selected in the Document Type section: process attachments (if supported) and a list of document data in the process.
  2. If any other Document Type is selected:
    process attachments (if supported) and a list of document data of the selected Document.

Select Document Data
Figure: Select Document Data

Delete Pages

The option to delete pages after extraction is disabled by default. In case this option is enabled, pages specified in the Pages section will be physically removed from the document when extracted. You can specify if this column is present or not in the Enable Page Deletion option provided in the configuration panel.

Note that deleting all pages is not permitted. In case you select all pages and try to start to extract, an according error message is displayed.

When pages are deleted, a new document version is created. The document viewer gets refreshed and displays the new version of the document. You can configure, if prior document versions should be retained or deleted, as described in section Prior Versions Handling.

If you check the version history of the source document, the version comment appears as shown in the following screenshot:

Version Comment Format
Figure: Version Comment Format

Copy Annotations and Bookmarks

In the column Copy Annotations and Bookmarks you can determine if the annotations and bookmarks contained in the page range should be copied to the target document. Bookmarks that do not completely fall within the extracted page range will not be copied. Page ranges in the source document are adjusted when pages are deleted. This option is enabled by default.

Copy Process Data

With the option Copy Process Data you can determine if the source process data should be copied to the target process instance. Any type of data can be copied. Also, the data container for both source and target process should be same. If this option is disabled, no data is copied. By default, this checkbox is enabled and selectable.

Note that the checkbox will be disabled and deselected in case the context of the open document cannot be determined. For example, the document is referenced to multiple process instances and it is being accessed by Document Search.

Starting the Extracting Process

Clicking OK immediately extract pages, starts the new process, and creates new versions of the source and target documents. Click Cancel to close the dialog without extracting pages.

After clicking OK a confirmation dialog opens with a table of process instances that were successfully started. The table provided the process name, process OID and an action icon to view the document. In case you click this icon, the document opens in a new tiff document view.

Summary
Figure: Extract Pages Summary

If you like to view the activities spawned when the process instances were created, click Yes, otherwise No to close the dialog without viewing. In case you chose to view the spawned activities, a worklist view opens filtered to display these spawned activities.


Figure: Worklist of Spawned Activities

Please refer to chapter Spawning Processes for details on worklists of spawned processes.

Viewing Area

Selecting a page in the Thumbnails Window displays the content of this page in a document viewing area for displaying images. Note that it is not possible to edit the content of TIFF documents.

A toolbar is provided with controls for navigating and viewing images, and adding annotations. Section Viewer Toolbar Functions provides a table with all viewer toolbar functions and their description. The following sections describe some of these functions in detail:

To zoom a page in and out, you can also click on the page and use the mouse wheel. The page can be moved by dragging it via the mouse over the canvas.

For details on the annotations

Viewer Toolbar Functions

The following toolbar functions are available in the TIFF viewer:

Icon Function Comments
Jump to first page of a document Disabled when user is on first page of document
Jump to previous page of a document Disabled when user is on first page of document
Jump to next page. Disabled when user is on last page of document, or when displaying a single page TIFF
Jump to last page of a document Disabled when user is on last page of document or when displaying a single page TIFF
Zoom In Magnifies image 10% each time clicked
Zoom Out Shrinks image 10% each time clicked
Fit to Window Shrinks or enlarges the image to the largest size that will fit entirely within the window
Fit to Height Shrinks or enlarges the image so that it is the same height as the window
Fit to Width Shrinks or enlarges the image so that it is the same width as the window
Rotate Right Rotates the page 90 degree clockwise
Rotate Left Rotates the page 90 degree counterclockwise
Grayscale Converts the color to grayscale (temporary viewing tool; not saved as part of annotations)
Invert Inverts the color of the page (temporary viewing tool; not saved as part of annotations)
Sticky Note Adds Sticky Note Annotation
Highlight Enables highlighter tool
Stamp Enables the Stamp tool
  Selected Stamp Small thumbnail image of the selected stamp. The drop arrow next to the image of the selected stamp activates the Stamp Selection window when clicked.
Show/Hide Annotations Toggles the display of all added Annotations. Enabled (show) by default.

Page Rotation

The icons Rotate Right and Rotate Left allow rotating an image in the desired direction.


Figure: Rotate a Page 90 degree clockwise.

Grayscale

To convert the current page to grayscale, click the Grayscale icon .


Figure: Convert Page to Grayscale.

Note
Gray scale changes are not saved as part of annotations. They serve as temporary supporting tools while viewing the image.

Inverting the Color

Click the Invert icon to invert the color of the current page.


Figure: Invert Image Color.

Note
Inverting color changes are not saved as part of annotations. They serve as temporary supporting tools while viewing the image.

Notes

To add a note to the current page, click the Note icon in the toolbar and subsequently click a location on the page where you like to paste the note.

Add Note
Figure: Click to add a note.

A note field is added to the page. Double-click the field to make it editable.

Edit Note
Figure: Double-click to edit the note.

Now you can enter text.

Editing Note
Figure: Enter a text.

Highlighter

The Highlighter allows you to draw a semi-transparent rectangular overlay to highlight an area of the document.

To add a highlighter to the current page, click the Highlighter icon in the toolbar and subsequently click a location on the page where you like to paste the highlight.


Figure: Add a Highlighter to the document.

To resize the highlight area, click in the lower right corner and drag the rectangle accordingly.


Figure: Resize and drag the Highlighter.

Stamp Tool

The Stamp tool allows you to add predefined images onto the document as stamps. This might could be e.g. scanned signatures or stamps to mark sections as approved or rejected. All images, residing in the repository folders documents/stamps and realms/realm/users/users/documents/stamps, can be added as stamps to your document pages. You can upload them to your Document Repository. For details refer to chapter Viewing Document Repository Resources. For example:


Figure: Example repository containing uploaded stamps.

To select a stamp:

  1. Click on the Select Stamp entry in the viewer toolbar.



  2. A dialog opens with all available stamps.

    Stamp Dialog
  3. Select a stamp.
  4. The selected stamp is displayed in the toolbar.

To add a selected stamp to your page:

  1. Select the Stamps icon .
  2. Click on the page.
  3. Move the stamp to the desired location.
  4. Click the handle in the lower right corner and drag the stamp icon to a desired size.

    Resize Stamp

Annotations

An annotation is a small, sizeable, floating window that you can overlay onto a document. The annotation information is entered by you and it may contain information such as a reminder note to the next processor, the highlighting of a particular portion of the document, or a comment to indicate that the document is not in good processing order. These notes will not affect the original file in any way.

Annotations are added by selecting an annotation type from the toolbar and clicking the location on the image where the annotation should be displayed. Multiple annotations can be added to an image. This includes adding multiple annotation types or multiple annotations of the same type.

Annotation Types

The following annotation types are available:

The functionality of these annotations is described in the according viewing area toolbar sections.

Selecting Annotations

Annotations are selected by default when added to the image. Existing annotations may be selected by clicking on them. Please note to disengage an annotation mode in case one is selected, before selecting an annotation. Annotation selection is indicated by a blue bold border around the annotation.

Selected Annotation
Figure: Selected Annotation

Selection enables resizing and dragging handles and other controls for the annotation.

Showing and Hiding Annotations

Click the Show / Hide Annotations icon to switch between showing and hiding annotations overlayed on the image.


Figure: Showing and Hiding Annotations

When clicking on an annotation, the annotation menu appears in the upper right corner of the annotation.


Figure: Annotation Menu.

The following options are available:

Deleting an annotation

Select the bin icon to delete an annotation:


Figure: Delete the annotation.

Annotation settings

For some annotation types, a settings dialog is opened when selecting the tool icon. Depending on the annotation type, this dialog provides controls to set properties such as color and font size.


Figure: Select the tool icon to open the Settings Dialog.

Showing Annotation Information

To get information on the annotation, like the user who created or updated it and when it was last updated, click the info icon:


Figure: Click the Info Icon.

A small dialog opens in the right corner of the annotation containing these information.


Figure: Information about the Annotation.

Saving, Printing, Faxing or Emailing Documents with Annotations

Note that annotations do not save, print, fax, or e-mail with the document when using these options in the Stardust Portal. In case annotations were added, deleted, or modified, a document is marked as "changed" and you will be prompted to save the document when closing the viewer or logging out of the portal.


Figure: Message appearing when closing the viewer with unsaved document changes.

Saving Documents

Changes made to bookmarks, page order, page rotation, and annotations are not saved until you explicitly save the document via the Save icon in the view specific toolbar. Saving creates a new document version. It also versions the versions the bookmarks, page order, page rotation, annotations, document data, and document content. This allows to navigate back through previous revisions to see all changes made to the document.

In the Save Document Confirmation dialog, all changes performed on the document are selected. You have the option to choose not to save changes to these items by unmarking the corresponding save option(s).


Figure: Save Document Confirmation Dialog

To disregard the save process, click Close.

Viewer Configuration

In the Portal Configuration Panel, you have the option to change settings for the TIFF viewer. Open the Configuration Panel and select the Image Viewer entry.

Image Viewer Configuration
Figure: Image Viewer Configuration

It provides you with options for the following settings:

Image Viewer Configuration
Figure: Image Viewer Configuration Settings

Display Options

The Display Options part, provides the following options on how an image is displayed:

Annotations

The Annotations section allows the following settings for displaying annotations:

Annotations Settings
Figure: Annotations Settings

Select Stamp

Clicking the Select Stamp entry opens the editor, where all available standard stamps as well as custom stamps are listed with their images. Click on one of the images to make this the default stamp.

Select Stamps Editor
Figure: Select Stamps Editor

The selected stamp is then displayed in the tiff viewer configuration panel.

Default Stamp
Figure: Selected Default Stamp

It will also be displayed in the viewer toolbar as default stamp.

Default Stamp in Toolbar
Figure: Default Stamp displayed in the toolbar.

To change the default stamp and open the stamp selection editor again, click the icon of the default stamp in the annotation configuration.

Extract Pages

The Extract Pages section allows settings for:

Note that this section is only accessible by administrators.

Enable Extract Pages

The Extract Pages icon appears in the Tiff viewer if this checkbox is selected. By default, this option is selected.

Allow Extracted Pages to be Deleted from the Original

This checkbox is enabled when the Enable Extract Pages checkbox is selected. When the Allow Extracted Pages to be Deleted from the Original checkbox is selected, it enables the Delete Pages checkbox in the Extract Pages Dialog which allows the user to specify whether the extracted pages will be deleted from the original document. By default, this checkbox is selected.

Prior Versions Handling

This section is available in case the Allow Extracted Pages to be Deleted from the Original option is selected. By default, prior document versions are retained, if you choose Delete Pages in the Extract Pages Dialog to delete the pages that are extracted in the original document. In case the prior versions of the document sources should be deleted automatically with this option, select Delete Prior Versions from the drop-down list. You can use this option to prevent unauthorized users to view prior versions of the document.

Prior Versions Handling
Figure: Settings on how to behave with prior versions.