In this article, you will learn
- which functions are available in the PPD Tools Collection main menu for the File Analyzer and
- how and for what they can be used.
1. Introduction
This article describes the File Analyzer, which can be used to open log files and other text files and filter the contents according to specific criteria. Filtering displays only the relevant information from a file, making files easier to read and understand.
Figure 1: The main menu of the PPD Tool Collection with the File Analyzer
1.1. File Analyzer Menu Options and Interface
Open the File Analyzer using the corresponding button [1]. The user interface (see Figure 2) opens with the options described below:
- File [8] – all functions concerning the file. These are described in detail in point 2.
- Edit [9] – all the functions that affect editing. These are described in detail in point 3.
- Tools [10] – all functions concerning the tool functions. These are described in detail in point 4.
- Tabs [11], [2] – all the functions that affect the tabs. These are described in detail in point 5.
- Help [12] – links for help with the PPD Tools Collection.
- Path field with + and - button [3] – this is the base path for the loaded file. That means that all files of this base path can be selected and loaded in the File field. After a new installation, the local Workflow log folders of PMS or Zunicomm are selected in the Logfile Tabs. For the File Analyzer, the field remains empty until a file has been loaded. With the + button, a path can be saved and can be selected again the next time the program is started. The - button removes the selected entry from the list. When the Production Job Analyzer is used, paths beginning with CustomerLog will also appear in the Path list. These point to the log files of the exported job. Attention: If a CustomerLog entry is selected and the - button is activated, the exported production job will also be deleted!
-
File Feld, (Re) Load button, "<>" buttons and Fast View checkbox [13] – the file field lists all files in the base path (path field). If an entry is selected, the file is loaded. The buttons < and > can be used to load the previous or next log file in the list. With large log files, displaying them becomes quite tedious. That's why there is the Fast View option. Here only a part of the log file is loaded and reloaded if necessary.
- Advantage: Fast loading, the line numbers are displayed immediately.
- Disadvantage: The file is read-only and cannot be changed. Select all cannot be executed.
- LineCount [6] – number of lines in the file and file size. These are calculated when loading, changes in the file text field are not taken into account.
- "F" (Find) button and search panel [14] – this opens the search, replace and highlight panel. This panel refers to the last text field used (file or filter). The field used is displayed in the "Textbox" label. Clicking on the other box activates it in the search panel. "Highlight" can be used to highlight the characters in the Search field in the file or filter text field. "UnHighlight" sets the characters of the Search field back to black. The button next to "Search" and "Replace" copies the value from "Search" to "Replace".
- "J" button [17] – the "J" button acts like a manual "Auto Jump to Line" and works in both directions (file to filter and back).
- Analyze! [4] – starts the filter function. The result is displayed in the Filter text field.
-
Include Lines, Exclude Lines, "+" und "-" button [15] – the filters are set in this area.
- Include Lines with String: All strings defined here will be displayed when filtering.
- Exclude Lines with String: The result can be reduced if the filter result is still too extensive or confusing.
The filters can be linked using the following operators:
- "|" = OR
- "&" = AND
- The "+" button can be used to save individual filters and the "-" button to delete them from memory.
Below are two examples to illustrate these functions
- Include Lines with String: DecodeURLEncodedParts | verification | documents
The file is searched for the strings “DecodeURLEncodedParts”, “verification”, “documents”. The filter displays the lines from the file in which one or more of these strings are present.
- Include Lines with String: DecodeURLEncodedParts & verification | documents - Exclude Lines with String: processing
All lines of the file in which “DecodeURLEncodedParts” and “verification” or “documents” occur in one line are displayed, except for those in which “processing” occurs.
- Checkboxes Highlight, Auto Jump, Group Filter Result [5] – when Highlight File is activated, the filter character strings in the text field File are highlighted in color after Analyze! is selected. When "Auto Jump to Line" is activated, the cursor jumps to the line selected in the filter. When "Group Filter Result" is activated, the lines that are not connected are separated.
- Filter checkboxes [7] – the filter checkboxes are search strings that can be activated with a click. These are linked with the Or operator. Example: By activating the Preflight and Render checkboxes, all lines from the log that contain a preflight or render call are displayed in the filter result.
- Checkbox Show Request Ends if possible (only ZuniComm tab): this shows the start and end of the processing request in the filter box. If a request has been started but not ended, this is also shown. This behavior occurs primarily with ZuniComm crashes. The checkbox makes it easier to determine which job causes ZuniComm to crash.
- From Hour / To Hour [16] – this allows the filter result to be reduced to the set time span.
-
Buttons »P« and »Z« [18] – these buttons make it easier to find views and errors across log files. This is only possible if the PMS and ZuniComm log are from the same date and time period. As a result, views of PMS or ZuniComm can be found in the other log file.
- Button Z: The ZuniComm log file is filtered according to the timestamp of the current PMS filter line.
- Button P (ZuniComm Tab): The PMS log file is filtered according to the timestamp of the current ZuniComm filter line.
Figure 2: The File Analyzer menu options
2. File
The various functions of the File menu are listed below:
Open [19]: command to open files
Reload [20]: command to reload open files.
Save [21]: allows to save changes made to the file (File field).
Save as [22]: allows you to save changes made to the file (field File) in a new file.
Open Folder in Explorer [23]: command to open the folder from the “Path” field.
Open in External Editor [24]: command to open a file (field file) in the default editor.
Copy File to Clipboard [25]: command to save a file to the clipboard
Restart PPDTC as Admin [26]: this function restarts PPDTC as an administrator. With many installations, the password has to be entered each time administrative authorization is required, which can be annoying. Since almost all tasks required for service can be performed with PPDTC, the password entry is largely eliminated when ppdtc has been started as an administrator.
Quit [27]: command to close the window.
Figure 3: The File tab of the PPD Tools Collection with the Restart PPDTC as Admin command
3. Edit
- Find (STRG + F/F3) / REplace (F4) / Highlight (STRG + H) [28]: he search panel is opened as when clicking on F [13] in Figure 1.
- Jump to Line in File [29]: adds the "J" button, which works like a manual Auto Jump to Line and can be used in both directions (File <-> Filter).
- Jump to Line in Filter [30]: adds the "J" button, which works like a manual Auto Jump to Line and can be applied in both directions (File <-> Filter).
- Jump to Line Number [31]: jumps to the line number to be entered in the File field.
- Replace Lines in File (F5) [32]: allows you to edit the Filter text field. To apply the changes in the File text box, press the F5 key. This will replace either the line (Filter text box) in which the cursor is located or the lines marked in the Filter text box in the File text box. This is intended to speed up and simplify selective changes in, for example, json or xml files. This function can be used when simple search and replace is not sufficient. Example of use: Load File > filter the file for the keys / values to be changed and keywords (criteria for whether a key / value should be changed or not) > change the desired keys in the filter text field (based on the keywords, you can decide whether a key / value should be changed or not)
Figure 4: The File Analyzer's Edit menu item
4. Tools
This menu item is divided into nine function groups, which are described below.
Figure 5: The Tools tab of the PPD Tools Collection
Analyze
ZuniComm requests from the PMS log can be evaluated using Analyze [33]. Essentially, Analyze is a text editor with special filter, marking, and validation functions. With the log file analyzer (PMS and ZuniComm), log files can be loaded and filtered according to criteria. With the filtered data, errors should be able to be identified more quickly and easily. Furthermore, useful tools for the service are included.
Tail File
Open Tail File [34] to track and filter changes in a log file.
Validate
The Validate [35] settings area offers five validation options.
- XML / KFPX / LIC – checks whether the file is valid (the content is not checked). The result is displayed in the Filter field.
- JSON – checks whether the file is valid (the content is not checked). The result is displayed in the Filter field.
- Json Tool – tool for editing and analyzing JSON files
- Check TAU JDF References – this checks whether all the files referenced in a TAU JDF actually exist. This is particularly useful for large VDP jobs.
- CSV Formatter – loaded CSV files are displayed formatted in the File field. The CSV delimiter is set in the CSV Delimiter: field. This is also useful for evaluating RHO data files (DP*.txt).
Find Files with String
This tool [36] can be used to search for files containing a defined string. This is particularly useful when a log file is being searched for in which a particular job has been processed.
Open PMS / ZuniComm Log with Time Filter (P / Z)
This function [37] can be used to set a time filter using the P and Z buttons. This function is identical to description number [18].
Local Workflow Services
Two options [38] are offered in this settings area:
- DW Services Manager – all Workflow services can be started and stopped here. Furthermore, the various service frontends can be opened here. For debugging purposes, it is possible to start a service in the console here.
- Local Workflow Services – in addition to the DW Services Manager, the services can also be started and stopped directly from the menu:
- PMS Start, Stop, Restart
- ZuniComm Start, Stop, Restart
- SMC Start, Stop, Restart
- PostGres Start, Stop, Restart
Figure 6: The Tools dialog with the options included in Local Workflow Services
Open local Config Files and Special
The following is a brief overview of the main features of this settings area [39].
- PMS Config – used to open the PMS application.properties.
- ZuniComm Config – used to open the ZuniCommConfig.txt from ZuniComm.
- Special – open DW-Install Log, View DB-Deployment (reset DB Deployment Error), View DB-ZuniComm Log
Figure 7: The Tools tab of the PPD Tools Collection
Open
The following options are available in this settings area [36]:
- Open Swagger – open Swagger in the browser
- Open Workflow – open Workflow in the browser
- Open ZuniComm Frontend – open ZuniComm in the browser
- Open SMC Frontend – open Service Management Console in the browser
Ping Workstation
This function [37] is used to ping the entered workstation / IP. (the IP can be overwritten in the open window)
5. Tabs
One file can be opened per tab. Click + in the tab bar to open a new tab. This creates a new tab with the same type as the currently active tab. You can also open new tabs via the Tabs menu. Double-click (or middle mouse button) on a tab to close it.
To open a file for the respective tab, proceed as follows:
- Drag the file into the (log) file text field using the mouse or open a file with File -> Open File or click on the (Re)Load File button (an open file dialog appears if the file field is empty).
- If a file is constantly changing (e.g. log files), press the (Re)Load File button. If a file is changing, the button turns orange.
- If a file is selected in the file field, the file is loaded automatically.
Tab Types:
- Add ZuniComm Analyzer Tab [41] – used to analyze ZuniComm log files.
- Add PMS Analyzer Tab [42] – used to analyze PMS log files.
- Add File Analyzer Tab [43] – allows you to open log files and other text files and filter the content according to certain criteria. The filtering should only display what is really relevant from a file. This should make the files more readable and a little clearer overall. All text files can be opened (txt, log, xml, json...)
- Add PostGresql Tab [44] – the File Analyzer opens with a PostGres query window and is used to display PostGres queries.
Figure 8: The Tabs tab of the PPD Tools Collection with commands
Artikel update: 04/2024