One moment please...
 
 
MAX   
 

MAX ETL Log Viewer Help

Background

Each MAX ETL extract and load operation generates a record of the operation results. When an ETL user first performs an extract or load, ETL saves that record as a log file, a file of the form tablename.log; where tablename represents the MAX data table from which data was extracted. Each subsequent load or unload operation appends to these log files, and adds an index reference that marks the operation time.

 

MAX ETL Log Files are essentially rich text files which any text reader application opens. For example, Windows Notepad displays the raw text of all MAX ETL Log Files. The MAX ETL Log File Viewer enhances MAX Log Files by marking specific blocks of text within each log file and displaying error and warning messages as colored text. The MAX ETL Log File Viewer simplifies navigating the text messages within MAX ETL log files that may assist MAX ETL users when validating data uploaded to MAX.

 

To view an ETL log file displayed in a MAX ETL Extract/Load dialog box, users have 3 options:

1)     Click the “View” button to the right of the Log File box, to open the log file using the ETL Log Viewer.

2)     Shift -Click the same “View” button to open the log file using Windows Notepad.

3)     Right -Click the same “View” button to choose a display application from a popup menu.

 

To open the MAX ETL Log Viewer independent of a specific log file, select the MAX ETL Options menu > choose Log Viewer.  The Log Viewer opens “clear”, pointed to no log file. To select and automatically parse a specific log file, click the Browse button to the right of the File box and then double click a log file name. This browser displays the default MAX ETL log file path; the MAX data file path. If MAX ETL log files have been saved to an alternate location, you must browse to that location manually.

 

ETL Log Viewer Navigation Features

The MAX Log File Viewer displays each log file’s descriptive text in the Log Viewer’s Rich Text Box, as time-stamped, indexed “blocks”. This allows users to navigate lengthy text using a drop down list box and scroll bars. The text also displays colored to indicate errors (in red), warnings (in gold) and business rule violations (in blue). The color references describe default values. See Color Rules for more information.

Using the drop down list box in the upper center of the Log Viewer, click the down arrow to display a list of Extract or Download text block titles in the Drop-Down box, then click a title to display the start of that block in the Rich Text Box.

To Select an Error, Warning, or Rule, use the colored scroll bars or their corresponding labels, displayed at the Log Viewer’s upper right.

Moving the cursor in the Rich Text Box updates the scroll bars and their labels to indicate the current index number.

The Scroll bars always display the index number of the Error, Warning, or Rule occurrence to which the cursor currently points.

Click the Index number displayed on each scroll bar to jump directly to that message/cursor location in the Rich Text Box.

Users may adjust the text size displayed in the Rich Text Box by selecting a Zoon value from 1.0 (approx. 10 point font) to a maximum of 3.0 (approx 30 point font).

Users can also find specific text using the Search feature.

  • Typing text in the Search box dynamically locates the next or previous occurrence of matching text in the Rich Text Box starting from the current cursor location.
  • Press the F3 function key to display the Next (or previous) occurrence to the text displayed in the Search box. Select the “Search Up” checkbox to find the previous occurrence; clear the “Search Up” checkbox to find the next occurrence.
  • Select the “Wrap Search” checkbox to continue searching at the text beginning when Search reaches the text end. Clear the “Wrap Search” checkbox to stop the Search function at the test file endpoint.

A small green box displays at the Rich Text Box’s left margin, aligned with the current cursor location.  If the cursor has been scrolled off-screen, the box displays at the top or bottom of the Rich Text Box.  Clicking this box automatically scrolls the cursor location into view.

After parsing, the box inherits the text color of the current cursor location. For example, if the cursor points to an error line, the box turns red (the default error color) or whatever color the user has chosen to display errors.

   

Parsing Log Files

The MAX ETL Log Viewer parses each MAX ETL log file automatically when it opens the file. The Log Viewer parses log files so that time-stamps, indexes and tags cause the text to display as indexed “blocks”, colored to indicate errors (in red), warnings (in gold) and business rule violations (in blue). This allows users to navigate lengthy text using the Log Viewer’s drop down list box, scroll bars and cursor/text marker features.

MAX ETL Log Viewer Color Rules

  • Indented log file text (i.e., line starts with <Tab>) displays colored according to the user’s choices (Colors Menu.).
  • Lines that start with “<Tab>Error” display the Error Color (default = red).
  • Lines that start with “<Tab>Warning” display the Warning Color (default = gold).
  • All other lines that start with “<Tab>” display  the Rule Color (default = blue).

  • “Error” lines indicate that a program error occurred during the Extract or Download process.
  • “Warning” lines advise that a non-standard record transferred.
  • “Rule” lines show a reason that a record did not transfer.

A Stop button displays above the Zoom box while parsing a log file.  Click the Stop button or press the Escape key to stop parsing.

A light blue progress bar draws across the top of the Rich Text Box during parsing.

Parsing is complete when the bar displays the same width as the Rich Text Box, then the bar disappears.

MAX ETL Log Viewer Messages

The MAX ETL Log Viewer displays, to the right of the Search box, text messages that describe file processing status and/or results.

Parsing large files requires more time, so text blocks greater than 50,000 characters do not parse automatically. In this case, a message displays that informs the user that a large file has not been parsed. Header information which includes time stamps and indices, does parse so that users may specify, and then parse, blocks manually. Select Edit > Parse Region to selectively color the text block which contains the cursor.

For example, loading a file with a “.rtf” extension which is not a valid rich text file displays the following message and loads the file as plain text. 

This message disappears after 3 seconds.

Messages also disappear when a user

  • clicks the message
  • parses the indicated region
  • selects a menu, or
  • loads a new file

MAX ETL Log Viewer Menu Descriptions

File Menu

File > Refresh - reloads and recolors the current file.

File > Open - shows a file browser dialog set to allow .log, .txt, and .rtf files.  The Browse ( ... ) button does the same thing.

File > Save As - allows save of the document in Plain Text or Rich Text format.

File > Save Empty - clears the document and saves it with the approval of the user.

File > Delete File - deletes the file with the approval of the user.

File > Close - closes the Log Viewer.

Edit Menu

Edit > Copy - copies the selected text from the document to the Clipboard.  The menu item is disabled if there is no text selected.

A Copy menu will pop up with a Right-Click in the document.  The menu item is disabled if there is no text selected.

Edit > Find - brings focus to the Search box.

Edit > Find Next - locates the next search result (same as using Function Key F3).

Edit > Parse Region - selectively colors the block which contains the cursor.

Colors Menu

Colors > Error Color - opens a Color Dialog to choose a color to use to indicate Error lines.

Colors > Warning Color - opens a Color Dialog to choose a color to use to indicate Warning lines.

Colors > Rule Color - opens a Color Dialog to choose a color to use to indicate Rule lines.

Colors > Background Color - opens a Color Dialog to choose a color to use as the Background of the Rich Text Box.

Colors > Restore Default Colors - restores Red for Errors, Dark Goldenrod for Warnings, and Blue for Rules.

*Use File > Refresh to re-color the document or Edit > Parse Region to recolor the selected region.

Options Menu

Options > Save Settings, - if checked (default), saves the color preferences, Zoom factor, and window size and position when the dialog is closed.

Options > Color Rules - if checked (default), allows the Rule lines to be colored while parsing .

Help Menu

Help > Show Help - opens the ETL Help document.

Help > Lite Help - shows a Message Box with a few hints.

MAX ETL Short-Cut Key Combinations

The following shortcut keys are used by the Log Viewer:

  • Escape                   Stop parsing.
  • + (Plus)                  Increments the Zoom factor.
  • - (Minus)                 Decrements the Zoom factor.  If the Zoom box has focus, the Zoom factor becomes 1.0.

  • Alt-C                      Drops down the "Colors" menu.
  • Alt-D                      Brings focus to the "Downloads/Extracts" drop-down box.
  • Alt-E                      Drops down the "Edit" menu.
  • Alt-F                      Drops down the "File" menu.
  • Alt-H                      Drops down the "Help" menu.
  • Alt-L                      Brings focus to the "File" text box.
  • Alt-O                      Drops down the "Options" menu.
  • Alt-. (period)           Activates the Browse ("...") button.
  • Alt-U                      Checks or clears the "Search Up" checkbox.
  • Alt-W                     Checks or clears the "Wrap Search" checkbox.
  • Alt-Z                      Brings focus to the "Zoom" box.

  • Control- -(Minus)      Decrements the Zoom factor.
  • Control-C                Copies the selected text from the RichText Box.
  • Control-F                Brings focus to the "Find" box.
  • Control-E                Locates the next Error or the final one if there are none following.
  • Control-Shift-E         Locates the previous Error or the first one if there are none preceding.
  • Control-O                Activates the Browse ("...") button.
  • Control-P                Parses (colors) the current region.
  • Control-R                Locates the next Rule or the final one if there are none following.
  • Control-Shift-R         Locates the previous Rule or the first one if there are none preceding.
  • Control-W               Locates the next Warning or the final one if there are none following.
  • Control-Shift-W        Locates the previous Warning or the first one if there are none preceding.

  • Function Key F1       Shows ETL Help.
  • Function Key Shift-F1         Shows the Log Viewer Help message box (“Lite Help”).
  • Function Key F3       Searches for the next or previous occurrence of the search text.
  • Function Key Alt-F4  Closes the window.
  • Function Key F5       Refreshes (reloads) the file.

 

     
 Main Category: Support Product Know How  Document Type: Knowledge base other
 Category: On-line help files  Security  level: All - 0
 Sub category: Details  Document ID: 10.274.162
 Assortment: MAX  Date: 28-04-2005
 Release:  Attachment:
 Disclaimer