Logbook

The Logbook is a feature for your Stations, Datamaps, or Jobs. As the name suggests, it allows you to create log entries for the area. This can be extremely useful for keeping track of who made changes, what changes were made, and when they occurred. An important note: entries are not generated automatically; they must be created manually by a user.

A more detailed explanation will follow later in this article.

How to Access the Logbook:

Firstly, it is important to note that when you open a Station, you will see all log entries that are either directly linked to the Station itself or to any of its Datamaps or Jobs. When accessing the Logbook from within a Datamap, only log entries directly linked to that specific Datamap will be displayed. The same behavior applies when accessing the Logbook from a Job.

 

How to Open the Logbook for a Station:

Click on the Station for which you want to access the Logbook. After opening the Station, click the Logbook icon in the top right corner.

 

How to Open the Logbook for a Datamap:

To open the Logbook for a Datamap, you can either click Datamaps in the top navigation bar and select the Datamap for which you want to access the Logbook, or click the Pipeline in the bottom left corner and select a Datamap. If you choose this method, you will be required to select a Job context.

 

If you choose to click the Datamaps tab in the top navigation bar and then select a Datamap, you will see the Datamap view. To open the Logbook for the selected Datamap, click the Logbook icon in the top right corner.

 

If you choose to select a Datamap from the bottom Pipeline, you must first select your Job context. After that, you can open the Logbook in the same way as the other method by clicking the Logbook icon in the top right corner, as shown in the screenshot.

How to Open the Logbook for a Job:

To open the Logbook for a Job, you can either click Jobs in the top navigation bar and select the Job for which you want to access the Logbook, or click the Pipeline in the bottom left corner and select a Job. If you choose this method, you will be required to select a Job context.

 

If you choose to click the Jobs tab in the top navigation bar and then select a Job, you will see the Job view. To open the Logbook for the selected Job, click the Logbook icon in the top right corner.

 

If you choose to select a Job from the bottom Pipeline, you must first select your Job context. After that, you can open the Logbook in the same way as the other method by clicking the Logbook icon in the top right corner, as shown in the screenshot.

How to Navigate the Logbook:

After accessing the Logbook for your selected Station, Datamap, or Job, a new window the Logbook Window will open. The window will appear similar to the screenshot below. The following sections will explain how to use the Logbook.

To create a new entry, simply enter a message and, optionally, a reference, then click the Send Message button.

Logbook UI Overview:

Station Info:
In the top left corner, information about the selected Station, Datamap, or Job is displayed. In this example, a Station is selected.

Search Bar:
The search bar allows you to search across all log entries. Your input will be matched against messages, users, creation dates, and references. This makes it easy to quickly locate specific entries.

User:
This column shows the user who last interacted with the entry. For example, if you edit someone else’s log entry, the user will update to your account. Clicking the User header (as marked in the screenshot) allows you to sort the log entries by user.

Creation Date:
This column displays the date the entry was created. You can also filter by this column, which is the default sorting option.

Reference:
The Reference column can be used to link entries to external systems, such as tickets or versioning systems. This field is optional and can be left blank if not needed.

Message:
This column contains the log entry message. It should describe the change or action performed and provide context for other users.

Source:
The Source column shows where the log entry originated. For example, if you open the Logbook from a Station, some entries may come directly from the Station, while others may come from connected Datamaps.

Edit Button:
The edit button is represented by a pencil icon. Clicking it allows you to edit the message in the editor located at the top right corner of the window.

• To save your changes, click the Send button.

• To cancel editing, click the Cancel button or select the edit button of another entry.

• Always ensure you press Send to save any changes before switching to another entry.

Delete Button:
The Delete button removes the selected log entry. Its function is straightforward and permanent, so use it with caution.

Usage Button:
The Usage feature allows you to see where the source such as a Datamap is used. For example, in the screenshot, you can view which Jobs or other elements are linked to this Datamap. This button acts as a toggle; click it again to close the usage overview. The usage overview reflects the context at the time the entry was created. It cannot be modified or updated retrospectively.

Was this article helpful?

0 0

How can we improve this article?

Please submit the reason for your vote so that we can improve the article.

Name

Email

Submit