You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Arbitrary number of "logbooks", configured in the service. A logbook entry is contained in one or several logbooks.
11
12
12
13
- Arbitrary number of "tags", configured in the service. A logbook entry may be associated with zero or several tags.
13
14
14
15
- Arbitrary number of "properties", configured on the service. A property is a named list of key/value pairs. The user may define values for the items in a property. A logbook entry is associated with zero or several properties.
15
16
16
17
- Arbitrary number of attachments, i.e. images or other file types.
17
-
18
+
18
19
- Markup as defined by the Commonmark specification (https://commonmark.org).
19
-
20
+
20
21
- Log entry editor invocation from context menu whereby context specific attachments or data are automatically appended to the log entry.
21
22
22
23
- Log entry viewers offer search capabilities based on meta data and content.
23
24
24
25
Launching the log entry editor
25
26
------------------------------
27
+
26
28
The log entry editor is launched as a non-modal window using one of the following methods:
27
29
28
30
- From the dedicated button in the application toolbar.
29
31
30
-
- From application menu Applications -> Utility -> Send to Logbook.
32
+
- From application menu :menuselection:`Applications --> Utility --> Send to Logbook`.
31
33
32
34
- Using the New Log Entry button in the log entry details view of the logbook application.
33
35
34
-
- Using the New Log Entry context menu item in the search result list view of the logbook application. This option also supports the keyboard combination CTRL+N.
36
+
- Using the New Log Entry context menu item in the search result list view of the logbook application.
37
+
This option also supports the keyboard combination :kbd:`CTRL-N`.
35
38
36
39
The log entry editor may also be launched from context menus, where applicable. For instance, with a right click on
37
40
the background of an OPI the launched context menu will include the Create Log item:
@@ -48,9 +51,9 @@ The log entry editor is a non-modal dialog:
48
51
Mandatory data are:
49
52
50
53
- Username and password, see also preferences_.
51
-
54
+
52
55
- Title
53
-
56
+
54
57
- At least one logbook, see also preferences_. Additional logbooks - configured in the service - can be added from a list shown when pressing the down button:
55
58
56
59
.. image:: images/LogbookSelection.png
@@ -67,19 +70,26 @@ Additional images (or other type of attachments) may be added by expanding the A
67
70
.. image:: images/Attachments.png
68
71
Here user may attach any number of files of arbitrary types:
69
72
70
-
- ``Add Files`` will launch the native file browser dialog from which user may select any number of files.
71
-
- ``Clipboard`` will attach the file - if any - currently copied to the host OS clipboard.
72
-
- ``CSS Window`` will attach an image of the current application window.
73
-
- ``Embed New`` will launch the dialog to embed an image to the log entry body, see below.
74
-
- ``Embed Selected`` will embed user selected image files previously added to the list of attachments.
73
+
- :guilabel:`Add Files` will launch the native file browser dialog from which user may select any number of files.
74
+
- :guilabel:`Clipboard` will attach the file - if any - currently copied to the host OS clipboard.
75
+
- :guilabel:`CSS Window` will attach an image of the current application window.
76
+
- :guilabel:`Embed New` will launch the dialog to embed an image to the log entry body, see below.
77
+
- :guilabel:`Embed Selected` will embed user selected image files previously added to the list of attachments.
75
78
76
-
**NOTE**: The Olog service will not accept upload of attachments larger than the configured limit of 50MB. The Olog service
77
-
can be configured to use a different limit, but users should keep in mind that download of large attachments to
78
-
the log viewer may incur delays in terms of UI updates.
79
+
.. note::
79
80
80
-
**NOTE**: Since iOS 11 the default camera image format is HEIC/HEIF (High-Efficiency Image Format). This type of
81
-
image file is not supported. Consequently upload of HEIC files is blocked by the application. Moreover, HEIC files converted to JPEG
82
-
in native Mac OS applications (e.g. Preview) may also fail to render and are also blocked from upload.
81
+
The Olog service will not accept upload of attachments larger than the configured limit of 50MB.
82
+
The Olog service can be configured to use a different limit,
83
+
but users should keep in mind that download of large attachments to the log viewer
84
+
may incur delays in terms of UI updates.
85
+
86
+
.. note::
87
+
88
+
Since iOS 11 the default camera image format is HEIC/HEIF (High-Efficiency Image Format).
89
+
This type of image file is not supported.
90
+
Consequently upload of HEIC files is blocked by the application.
91
+
Moreover, HEIC files converted to JPEG in native Mac OS applications (e.g. Preview)
92
+
may also fail to render and are also blocked from upload.
83
93
84
94
Embedded images
85
95
---------------
@@ -106,14 +116,15 @@ User may select what properties to include in the log entry, and edit the values
106
116
107
117
Log entry viewer
108
118
----------------
109
-
The menu item Applications -> Utility -> Log Entry Table will launch an application (in a new tab) in which the user may
110
-
search and view log entries:
119
+
120
+
The menu item :menuselection:`Applications --> Utility --> Log Entry Table` will launch an application (in a new tab)
121
+
in which the user may search and view log entries:
111
122
112
123
.. image:: images/LogEntryTable.png
113
124
114
125
User may choose to hide some details of each log entry in the list in order to fit more items in the view and to reduce the need
115
-
for scrolling. This can be done using the keyboard shortcut ``CTRL+SHIFT+D``, or by selecting the
116
-
``Show/Hide Details`` item from the context menu invoked through a right click in the table view. The choice
126
+
for scrolling. This can be done using the keyboard shortcut :kbd:`CTRL-SHIFT-D`, or by selecting the
127
+
:guilabel:`Show/Hide Details` item from the context menu invoked through a right click in the table view. The choice
117
128
to show or hide details is persisted between restarts of the application.
118
129
119
130
.. image:: images/ContextMenuLogEntryTable.png
@@ -174,8 +185,6 @@ The navigation buttons are not rendered if hit count less or equal to the page s
174
185
175
186
.. image:: images/pagination.png
176
187
177
-
.. _preferences:
178
-
179
188
Periodic Search
180
189
^^^^^^^^^^^^^^^
181
190
@@ -200,14 +209,16 @@ If user double-clicks on a OPI file attachment (.bob file), the application will
200
209
If user double-clicks on a Data Browser attachment (.plt file), the application will launch the Data Browser.
201
210
202
211
Preview of non-image files is not offered in the application. However, external viewers may be configured for
203
-
arbitrary file extensions, see preference_settings_ (framework.workbench) for more information.
212
+
arbitrary file extensions, see :prefs:pack:`org.phoebus.framework.workbench` preferences for more information.
204
213
205
214
Log Entry Grouping
206
215
------------------
207
216
208
-
The preference setting ``log_entry_groups_support`` - if set to ``true`` - will enable the "log entry grouping"
209
-
feature. With this users will be able to reply to individual log entries implicitly creating a group of log entries. To use this
210
-
feature user can choose to:
217
+
The preference setting :prefs:pref:`org.phoebus.logbook.olog.ui/log_entry_groups_support`,
218
+
if set to ``true``,
219
+
will enable the "log entry grouping" feature.
220
+
With this users will be able to reply to individual log entries implicitly creating a group of log entries.
221
+
To use this feature user can choose to:
211
222
212
223
- Press the Reply button shown in the log entry view:
213
224
@@ -225,10 +236,13 @@ In the log entry view, the "Show/Hide Group" button (see screen shot above) can
225
236
ordered on created date with oldest log entry on top. In this merged view attachments and properties are not shown.
226
237
Clicking on a header in the merged view will show that log entry in full.
227
238
228
-
**NOTE**: To be able to group log entries user must be authenticated in one of the following manners:
239
+
.. important::
229
240
230
-
* Use "credentials caching" through preference setting ``org.phoebus.logbook.olog.ui/save_credentials``. Once a log entry has been created, credentials will be reused when creating a group.
231
-
* Use the Credentials Management app to sign in to the logbook context.
241
+
To be able to group log entries user must be authenticated in one of the following manners:
242
+
243
+
* Use "credentials caching" through preference setting :prefs:pref:`org.phoebus.ui/save_credentials`.
244
+
Once a log entry has been created, credentials will be reused when creating a group.
245
+
* Use the Credentials Management app to sign in to the logbook context.
232
246
233
247
Limitations
234
248
^^^^^^^^^^^
@@ -240,25 +254,19 @@ Please consider the following limitations of the log entry group feature:
240
254
- There is no parent-child relation between log entries in a group, i.e. there is no internal structure of the log entries in a group.
241
255
- A log entry may be included in only one log entry group. It is hence not possible to create a new group of log entries if these are already contained in different groups.
242
256
257
+
.. _preferences:
258
+
243
259
Preferences
244
260
-----------
245
-
Preferences related to the electronic logbook are the following:
246
-
247
-
- ``org.phoebus.olog.es.api/olog_url``. This should be on the format ``http(s)://foo.com/Olog``, where the path element ``Olog`` may not be omitted.
248
-
249
-
- ``org.phoebus.logbook.olog.ui/default_logbooks``. This is a comma separated list of logbooks automatically associated with a new log entry.
250
-
251
-
- ``org.phoebus.logbook.olog.ui/level_field_name``. The text shown next to the drop-down below the password field. Sites may wish to customize this to override the default value "Level".
252
-
253
-
- ``org.phoebus.olog.es.api/levels``. List of items shown in the "Level" drop-down.
254
-
255
-
- ``org.phoebus.logbook.ui/save_credentials``. Indicates if user credentials should be cached. If ``true``, the user will
256
-
have to specify credentials only for the first new log entry after launch of CS Studio. The side effect of credentials caching is that all entries will be created with the same user (owner) identity.
257
-
258
-
- ``search_result_page_size``. The maximum number of hits per page to fetch and render in a search. User may override in the UI. Value must be 1 - 999, default is 30.
259
-
260
-
- ``log_entry_groups_support``. If true, user may reply to log entries and create a log entry group from a selection of existing log entries.
261
-
262
261
262
+
See the :prefs:pack:`org.phoebus.olog.es.api` and :prefs:pack:`org.phoebus.logbook.olog.ui` preference packages,
0 commit comments