Logbook


Widget size: 2 x 1, 2 x 2, 4 x1, 4 x 2

The Logbook widget can be used as a place to record events (in the form of text logs) that have or will have an impact on your system in some way.

It can be used to record items on an action plan that can be removed from the list once implemented.

Logbook entries can be initially stored against a site selected from the treeview but can also be stored against individual containers/points or multiple points if configured in the widget configuration.

The information in each column of the logbook can be sorted alphabetically by clicking on the column header.

To add a new logbook entry, press the green "+" icon to display the pop-up, window which allows you to add an entry against the selected site or stored container/point.

Adding a New Entry

  1. Click the Add New Entry icon.
  2. When the Logbook – New Entry dialog opens, click the calendar icon to choose a date then type the essential information in the Details field.
  3. In the Summary field, craft a short description that you will be able to spot and recognize easily when scanning the potentially lengthy table of entries that appear in the widget.
Note: Although the widget can be configured to display logbook entries from multiple points, the icon to add entries only appears when (via the dashboard navigation tree) these multiple points are filtered down to a single point.

Logbook entries against the container/point are added by entering the date, author, summary, and details. Entries against points are shown when one or more point ID is entered into the "POINT1" cell of the Properties configuration. Entries against containers are shown when a container ID is entered into the "Container ID" of the configuration. All entries in the logbook will then be against the configured container or point(s).

Entries may appear on Overlay charts or Engineering charts, when configured.

Clicking on a log entry will open a new pop-up to display the details of the entry. These can also be edited and saved if the user has editing rights.

When new logbook entries are created, the user will default to the currently logged in user.

Setting the widget configuration (Widget Specific = Yes), restricts the Logbook widget to contain only entries specific to the widget itself and to ignore any other entries within the organisation, region, point, etc.

Pressing the information icon will show the current logbook setting.

Click the delete (red cross) button beside an entry to open a confirmation pop-up. Click OK to remove the entry from the widget.

Deleting a Logbook

  1. To eliminate a logbook, open its properties dialog and click the Delete button.
  2. On the Confirmation pop-up, click OK to delete the logbook or click Cancel to close the pop-up and return to the Logbook properties dialog.

Customisation

  1. Unlock the widget configuration options and click the Quick Config icon.
  2. Enter a name in the Widget Heading field (Logbook is the default name).
  3. Select what will appear in your Links widget by expanding the Show Date, Summary, Details, etc. drop-downs and choosing the Yes or No option.
  4. To create additional columns, enter Custom Headings in the fields provided.
  5. Expand the Refresh Period drop-down and choose from the available options.
  6. Click the Save button.

The format of the logbook widget is very flexible in terms of columns displayed, and the choice can be daunting. However, when a new widget is created, the default settings will display only the following columns: Date, Author, Summary, Details, and Action.

Value Default Comment
Widget Heading Logbook Enter the name of the widget as it is to appear in the heading.
Show Date Column Yes Show or Hide Column
Show Author Column Yes Show or Hide Column
Show Summary Column Yes Show or Hide Column
Show Details Column Yes Show or Hide Column
ContainerID Site Enter the container ID to store the entries against.
Column x Heading (x4)   Edit respective Column Heading
Refresh Period No widget refresh Select a refresh period from the drop-down, between 15 seconds to 1 hour, or no refresh at all
Widget Specific No
  • Yes - Only show entries specific to the widget itself. Ignore any site selection, container, or point entries.
  • No - Show site selection, container or point entries, rather than widget specific entries.
Show Full Path No
  • Yes - Show the Full Path to the item to which the entry is attached.
  • No - Hide the Full Path column.
Show Date Created No
  • Yes - Show the date the logbook entry was created in a column with the heading: Created. If no created data can be found for the entry, the column will be blank.
  • No - Hide the Created column.
Show Date Modified No
  • Yes - Show the date the logbook entry was list modified (if at all) in a column with the heading: Modified. If no modified date can be found for the entry, the column will be blank.
  • No - Hide the Modified column.
Tree Level A Blank
  • Number 1 to 9 - The column will be filled from the name of the container 'n' levels up from the item to which this entry is attached (point or container). The name of this column is controlled by the 'Level A Heading' field described below.
  • Blank - This column will be hidden.
Tree Level B Blank
  • Number 1 to 9 - The column will be filled from the name of the container 'n' levels up from the item to which this entry is attached (point or container). The name of this column is controlled by the 'Level B Heading' field described below.
  • Blank - This column will be hidden.
Tree Level C Blank
  • Number 1 to 9 - The column will be filled from the name of the container 'n' levels up from the item to which this entry is attached (point or container). The name of this column is controlled by the 'Level C Heading' field described below.
  • Blank - This column will be hidden.
Level A Heading Tree Level A Provides a heading for the column filled with the name of the container selected in the 'Tree Level A' column above, if it is enabled.
Level B Heading Tree Level B Provides a heading for the column filled with the name of the container selected in the 'Tree Level B' column above, if it is enabled.
Level C Heading Tree Level C Provides a heading for the column filled with the name of the container selected in the 'Tree Level C' column above, if it is enabled.
Function Blank
  • Text entered in this field will specify a user-defined function that returns text to populate this column (e.g., udf_getNoteTreeLevelData). The widget will pass the database id of the logbook entry to the function, and it expects text in return. (Technically: Input: varchar(255), Return: varchar (8000)).
  • Blank - This column will be hidden.
Function Heading Blank A header label for the column that displays the results of the function specified above, if any.
Show Note Parent No
  • Yes - Show the name of the item to which the logbook entry is attached.
  • No - Hide the Note Parent column.
Note Parent Heading Point A header label for the column that shows the Note Parent item name, if it is enabled. The default is Point as entries are most commonly attached to points.
Period Selection disabled Dashboard/Report Selector is the available option.

Properties

Drag and drop the required point to link the logs to from the tree. Enter a point ID here to store entries against a specific point.