The Build Log Package program is a troubleshooting tool that automates the gathering and grouping of RecTrac logs for transfer to Vermont Systems Support when you are experiencing issues. Once the program builds the log package, it can be exported to your Document Center or you can opt to FTP/sFTP it to a remote location, such as the Vermont Systems sFTP site. Log files that can be viewed and sent include WebSpeed, AppServer (VIC), AppServer (EVENT), AppServer (dbUtility). and local VIC logs. Screen options allow you to filter by Date, Time, Time range (+/- Minutes Around Issue), User, Session ID, etc. There is also an editor field into which you can enter important information related to the issue you are experiencing.
To Run the Build Log Package Program
- Fill out the Date and Time fields. Be as accurate as you can in order to limit the size of the files you will generate.
- Make a selection in the Log Type to Include field. Generally speaking, you will want to include all five (5) Log Types unless otherwise instructed by Vermont Systems.
- Enter any additional information regarding the issue you're experiencing in the Description of the Problem editor field. This is your opportunity to provide important details about the issue, its effects on your system, contact information and etc.
- Skip the Advanced group unless Vermont Systems Support specifically instructs you to make settings there.
- When you are ready, click Build Log Package at the bottom of the screen. The Log Viewer DataGrid will populate with results. Be patient as this process could take a few minutes.
- Determine whether you wish to FTP Log Package or Export Log Package to Document Center.
-
FTP Log Package - Expand the FTP Setting group and fill out the fields. Click FTP Log Package when ready.
Note: The FTP Group appears at the bottom of the screen; you may have to scroll down to see it.
- Export Log Package to Document Center - The system will bundle the log package into one file and export it to your Document Center. Go to the Document Center and search for --All Document Types--. The Log Package will be in the \Reports\ folder.
-
FTP Log Package - Expand the FTP Setting group and fill out the fields. Click FTP Log Package when ready.
- Exit the program when ready. The next time you enter it, the Log View DataGrid will be blank.
From the bottom of the screen….
Click Build Log Package to run the program. The Log Viewer DataGrid will populate with results. Be patient as this process could take a few minutes.
Click FTP Log Package to send your log package to a 3rd party FTP site, such as the Vermont Systems sFTP site (sftp://vermontsystems.com:22). Upon being FTP'd, the file is deleted from the system. To send another Log Package, you must click Build Log Package again.
Note: The FTP Group appears at the bottom of the screen; you may have to scroll down to see it.
Click Export Log Package to Document Center to have the system will bundle the log package into one file and export it to your Document Center. Within the Document Center, the Log Package will be in the \Reports\ folder. Upon being sent to the Document Center, the file is deleted from the system. To send another Log Package, you must click Build Log Package again.
To exit this program, click 'X' on the title bar. You will be returned to the Main Menu or the previous program.
LogFileViewer_Tab1
Date of Issue (LogFileViewer_LogDate)
Accept the default entry (Today's" Date) or click the Calendar icon to select an alternate date if needed. If preparing a Log Package for troubleshooting purposes the date you select should be the date on which the issue occurred.
DeleteApprox Time of Issue (LogFileViewer_StartTime)
Accept the default entry (the Time at which you entered this program) or click the Clock icon to select an alternate time, if needed. If preparing a Log Package for troubleshooting purposes, the time you select should be the time at which the issue occurred or a close approximation of it.
Delete+/- Minutes Around Issue (LogFileViewer_Minutes)
Accept the default entry (45 Minutes) or overwrite with an alternate value as desired. When preparing a Log Package, the system will compile all log entries for Time you selected in Approx Time of Issue plus or minus the number of minutes you enter here. For Example: You select 2:00pm as your Approx Time of Issue and enter 45" in this field. When preparing the Package the system will collect all log entries generated during the 90 minute period between 1:15pm and 2:45pm..
DeleteLog Type To Include (LogFileViewer_LogTypeToInclude)
Click the Combo Box icon to select the Log Types you want to include in the Package.
- WebSpeed - The WebSpeed log from your Server.
- AppServer (VIC) -The VIC AppServer log from your Server.
- AppServer (Event) -The Event AppServer log from your Server.
- AppServer (dbUtility) -The dbUtility AppServer log from your Server.
- VIC (Local) -The VIC logs from the workstation from which you are running this program.
Note: In addition to the Logs selected here the Log Package also includes:
- _ProblemDescripiton.txt - A text file containing the Date/Time/Description fields information as well as a list of the Logs included in the Package.
- Profiles.xml -A listing of all your profiles and their settings.
- ubroker.properties - The ubroker properties file from your Server.
Description of the Problem, Contact info, other details (LogFileViewer_IssueDescription)
Enter any additional information regarding the issue you're experiencing in this field. This is your opportunity to provide important details about the issue, its effects on your system, contact information and etc….
The text you enter in this field will be included in the ProblemDescription.txt file that gets created when you build the log package.
DeleteCurrent User or (LogFileViewer_CurrentUser)
VSI highly recommends leaving this field at its default setting unless you are instructed specifically to alter it.
Select this option to generate a log package for the Current User
OR
Deselect this option and enter an alternate User ID in the User field.
User (LogFileViewer_User)
VSI highly recommends leaving this field at its default setting unless you are instructed specifically to alter it.
IF you de-selected the Current User or option then click the Picklist icon to select the alternate User ID for whom you wish to generate a log package.
DeleteCurrent Session Only (LogFileViewer_ThisSessionOnly)
VSI highly recommends leaving this field at its default setting unless you are instructed specifically to alter it.
Select this option to gather logs for current sessions only that were active during your date and time range entered above.
De-select this option to gather logs for any sessions that are/were active during your date and time range entered above.
DeleteContains this Text (LogFileViewer_Contains)
VSI highly recommends leaving this field at its default setting unless you are instructed specifically to alter it.
Enter any specific text you want the system to search for when creating the Log Package. Only those log entries that contain the exact text you enter here will be included.
DeleteSkip Programs (LogFileViewer_SkipPrograms)
VSI highly recommends leaving this field at its default setting unless you are instructed specifically to alter it.
Click the Combo Box icon to skip specific programs when generating the logs.
DeletePID (LogFileViewer_PID)
VSI highly recommends leaving this field at its default setting unless you are instructed specifically to alter it.
Enter a Process ID Number (PID). Only those log entries that contain the exact PID you enter here will be included.
DeleteRequest Length Greater Than (Seconds) (LogFileViewer_RequestLength)
VSI highly recommends leaving this field at its default setting unless you are instructed specifically to alter it.
Enter a value in this field. That value equates to seconds. Only those log entries with a request length greater than the value you enter here will be included. Leave the field at 0 to include all logs since any log entry has a request length greater than 0 seconds.
DeleteInterface Type (LogFileViewer_InterfaceType)
VSI highly recommends leaving this field at its default setting unless you are instructed specifically to alter it.
Click the Combo Box icon to select the specific interfaces you wish to use when generating the logs. Leave this field blank to include all Interface types.
Delete(LogFileViewer_LogDataGrid)
The Log Viewer DataGrid is blank upon entry into this Program. Upon clicking Build Log Package, the DataGrid will populate with the list of log entries that meet your search criteria. These will be sorted into their proper file upon processing your export option (FTP or Document Center). Entries in this DataGrid cannot be accessed or modified in any way. This is a Read Only DataGrid.
DeleteFTP URL (LogFileViewer_FTPURL)
Accept the default entry in this field or overwrite with other information, if needed. The default entry is the VSI FTP pub" (public) directory/<Your VSI License ID> sub-directory.
Upon FTP'ing the Log Package to VSI a sub-directory with your License ID will be created in the VSI FTP public directory if one does not already exist. Your logs will be placed in that directory.
Note: You do NOT need to delete the " passive" text. The sub-directory will be created with or without it.
If you are FTP'ing your logs to a site other than the VSI FTP site you will need to enter an accurate FTP URL for that site.
DeleteFTP User ID (LogFileViewer_FTPUserID)
Accept the default entry in this field (vsiftp) or overwrite with other information, if needed. The default User ID has proper read/write access to VSI FTP site.
If you are FTP'ing your logs to a site other than the VSI FTP site, you will need to enter an accurate User ID for that site.
DeleteFTP Password (LogFileViewer_FTPPassword)
Enter the Password for the FTP site to which you will send your Log Package.
If using the VSI FTP site, you can obtain the current password by contacting VSI Support
OR
By using the VSI Online Knowledge Base. Knowledge Base Entry = 1516.