Graphic Hub Administrator Guide

Version 3.1 | Published July 11, 2018 ©

Journal Panel

From the Journal panel it is possible to search for journal entries and view their details. Journal entries are log files created according to various alert levels.

images/download/attachments/27015142/manager_workbench_journal2.png
The Journal is a good place to start for troubleshooting problems encountered in Graphic Hub.

The Journal records all server activities. When faced with troubleshooting scenarios, the journal is a good place to search for clues. The activities logged in the journal are the creation, modification and deletion of objects in Viz Artist, as well as other information messages, warnings, errors and deploy task information.

This section contains the following topics:

Journal Tool Bar

images/download/attachments/27015142/manager_workbench_journal2_annos.png
The Journal tool bar (1) has these options:

images/download/attachments/27015142/manager_workbench_journaltoolbar.png

  • images/download/attachments/27015142/manager_workbench_journal_search_icon.png Search: Search for journal entries based on the preferences defined in the Journal Filter frame

  • images/download/attachments/27015142/manager_workbench_journal_optimize_icon.png Optimize search for faster export: If enabled, backup files with a huge number of journal entries will be optimized for export, by not containing all available information about these entries

  • images/download/attachments/27015142/manager_workbench_journal_import_icon.png Import journal entries: Opens a dialog box, from where it is possible to select an XML journal backup file to import

  • images/download/attachments/27015142/manager_workbench_journal_export_icon.png Export selected entries: Allows you to export only the entries that you choose

  • images/download/attachments/27015142/manager_workbench_journal_backup_icon.png Backup task: Opens the Configure Journal Backup Task window

  • images/download/attachments/27015142/manager_workbench_journal_feed_icon.png Switch to feed mode: Allows you to receive journal updates in real time

  • images/download/attachments/27015142/manager_workbench_journal_show_hide_icon.png Show/hide entry properties: Shows/hides the Journal Properties frame

  • images/download/attachments/27015142/manager_workbench_journal_show_filter_icon.png Show filter: Shows/hides the Journal Filter frame

Search the Journal

To View the Journal

  • Click Server > Administer journal entries.

    images/download/attachments/27015142/task_workflow_journal1.png

To Search the Journal with Filter Settings

  1. Open the Journal panel.

  2. In the Journal filter, from the Server drop down box, select a server.

  3. Select an application. Your options are:

    • Any: Searches System and GH Deploy.

    • System: Graphic Hub Server. Any work done on Graphic Hub will be logged in the system.

    • GH Deploy: All Graphic Hub Deploy Agent tasks, successful or failed, plus warnings and other pertinent information, are logged in the journal.

  4. Optionally, enter a UUID of a folder or file.

    Note: Adding a UUID to the search criteria may provide hints toward finding and resolving corrupted files.

  5. From the Date drop down box, select one of the following options:

    • Anytime

    • From: Selecting this option will prompt you to also enter a beginning date and time

    • Until: Selecting this option will prompt you to also enter an ending date and time

    • Between: Selecting this option will prompt you to also enter a beginning and ending date and time

  6. In the Details Like field, enter free text like name of the task, name of the agent, or any description that may figure in the task.

  7. In the Details Unlike field, enter free text like name of the task, name of the agent, or any description that you want to exclude from the task search.

  8. Check the Alerts check box if you wish to filter by selected alerts.
    There are various Action Logs, information messages, warnings and errors to choose from.

  9. Optionally, click Optimize Search (2) for Faster Export button.

  10. In the Journal, click the Search (1) button.

    images/download/attachments/27015142/manager_workbench_journal2_annos.png

    The search results are shown in the panel below. When one is selected, the details are shown in the panel to the right.

To View a Live Feed of Server Activities

  1. Search in the Journal with Filter Settings.

  2. In the Journal tool bar, click the Feed button (1).

    images/download/attachments/27015142/task_workflow_journal3_annos.png

    The journal is now updated in real time.

  • Green: New journal entries

  • Yellow: Warnings

  • Red: Errors

  • Only the Level and Subject columns are colored in red or yellow when there are warnings and errors to report

Automatic Journal Backup

To automatically backup all Journal entries, Enable journal backup must be enabled in Journal/Logging Settings.

IMPORTANT! Once an automatic backup task has completed, all journal entries are deleted.

To Schedule Automatic Journal Backup

  1. Open the Journal panel:

    • Click Server > Administer journal entries.

      images/download/attachments/27015142/manager_workbench_journal_backup_annos.png
  2. Click the backup task (1) button.

    images/download/attachments/27015142/manager_workbench_journal5.png
  3. Set the Start time.

    Tip: Click the drop-down or highlight a date number and change it, to set the date. Click on the hour or minutes to change the time.

  4. Set a frequency Interval.

  5. In the Graphic Hub Terminal, check that Enable journal backup is enabled under Options -> Journal/Logging settings. This option is enabled by default.

  6. Click OK.

Export and Import of Journal Entries

With the export of journal entries select one, or as many as required, entries to be exported.

Exported journal entries can be imported by other users for help with troubleshooting.

To Export Selected Journal Entries

  1. Search in the Journal with Filter Settings.

  2. In the journal, select the entries to be exported.
    images/download/attachments/27015142/task_workflow_journal4.png

    Tip: Press <Ctrl+A> to select all entries.

  3. Export the selected entries by clicking the export button images/download/attachments/27015142/manager_workbench_journal_export_icon.png , or by right-clicking the selection and select Export Selected.

    Note: From the context menu, Export and Delete Selected can also be selected. This will free up disk space and increase performance.

  4. Select a location, optionally enter a file name.

  5. Click Save.

To Import Journal Entries

  1. Open the Journal panel:

    • Click Server > Administer journal entries.

  2. Click the images/download/attachments/27015142/manager_workbench_journal_import_icon.png (Import Journal Entries) button.

    images/download/attachments/27015142/task_workflow_import1.png
  3. Select the required file.

  4. Click Open. The file is loaded into the journal.