LOG MANAGEMENT Update Log Setup Screen Update Log Options Use Update Log to track edits, adds and deletes Accept List Cancel

Transcription

1 Log Management - Page 22-1 LOG MANAGEMENT There are various log options throughout ZonePro. A log file is a file that store information about changes that have been made while using ZonePro. Log files are essential to the operation of ZP Remote and ZP Web. Update Log Setup Screen Within ZonePro the option to log database changes can be turned on and off through the Update Log Setup Screen in Maintenance. This screen is accessed by the Update Log Options button on the Global Options tab of the Personalization Options Screen. More information on the Personalization Options Screen can be found in the Maintenance Options chapter. The Update Log Setup Screen determines whether ZonePro tracks edits, adds and deletes in the Update Log, and which databases it tracks those changes for. You must mark the Use Update Log to track edits, adds and deletes check box to turn on the logging function. Then use the database selection options in the middle of the screen to pick which databases you wish to track. (You can right-click on any given database choice to choose it and unselect all the other databases. You can right-click on the background border to select all of the databases.) The Update Log tracks all edits and adds made from the selected permit screens and tracks deletes when they are finalized. This option must be turned on to take advantage of ZP Web. The Update Log can be viewed from the Update Log Viewer Screen. After selecting your databases click on the Accept List button to save your choice. Click on Cancel to exit without saving any changes. When editing records in ZonePro, the Update Log can record values for all of the fields or just the fields that changed. Logging all of the fields makes it easier to troubleshoot problems. Logging only the fields that changed makes it easier to tell exactly what was changed. By default the Log only the fields that are changed check box is marked. This option makes for a smaller more efficient log file. Unless you are a ZP Web or ZP Remote customer, you should use the Update Log option sparingly. The Update Log adds a layer of overhead to ZonePro by creating an extra record for every change made in the system. The log file itself can become very large very quickly. It should only be used if you have a specific security or trouble shooting reason to justify it.

2 Page 22-2 Log Management When you use the F12 option from the Main Screen to check the version number, a second line displays the codes that tell which databases are currently being logged. Log Manager Screen The Log Manager Screen is a menu screen that provides access to the various log viewers available in ZonePro. Update Log Viewer Button This button launches the Update Log Viewer Screen. The Update Log is created by ZonePro. It keeps track of any changes made to the main ZonePro permit databases. When a permit record is added, edited or deleted an entry is created in the Update Log. External Log Viewer Button This button launches the External Log Viewer Screen. The External Log keeps a copy of all the changes passed to ZonePro from ZP Remote users. This option is only available if you license ZP Remote and have the ZP Local Application installed. External Error Log Viewer Button This button launches the External Error Viewer Screen. If there are any processing errors when changes are passed from ZP Remote to ZonePro those errors are recorded in the External Error Log. This option is only available if you license ZP Remote and have the ZP Local Application installed. Web Error Log Viewer Button This button launches the Web Error Viewer Screen. If there are any processing errors when updates are received from ZP Web those errors are recorded in the Web Error Log. This option is only available if you license the ZP Web service. ZP Laptop Log Viewer Button This button launches the Logbase Screen. When ZP Laptop users pass their changes back to ZonePro their individual log files are collected into a single log database. ZP Laptop is an earlier version of ZP Remote. This option is only available to users who still have ZP Laptop installed. Update Log Viewer Options Update Log Viewer Screen The Update Log Viewer Screen is accessed from the Update Log Viewer button on the Log Manager Screen. The Update Log Viewer Screen is used to view and run reports on the Update Log database. The Update Log keeps track of any changes made to the ZonePro permit databases. When a permit record is added, edited or deleted an entry is created in the Update Log. The Update Log tracks the date and time of the change, the database involved, the action taken, who made the change, and stores a command string that

3 Log Management - Page 22-3 can recreate the change. You decide which databases are monitored by setting your preferences in the Update Log Setup Screen. The Fields Database: This field shows in which database the change was made. ID: This field shows the ID number for the record changed. For the Property database the Property ID is shown. For the detail databases the Sub ID number is shown. For all other databases the ID Code is shown. Action: This field shows whether the change is an Edit, Add or Kill. A Kill action is created when deletions are finalized. Owner: This field shows which ZonePro user made the change. Add Date: This date shows when the change was created. Command: This field shows a command expression that can be used to recreate the change. Reviewing this command shows exactly what fields were changed. Special Control Buttons Jump This option closes the Update Log Viewer Screen and takes you to the record that the log fields reference. For example, if the current log record documents an edit that was made to a violation record, clicking on the Jump button takes you to that violation record. This option is not available for every database. Reports This option takes you to the Update Log Reports Screen where you can report on any records in the Update Log. Purge This option takes you to the Update Log Purge Screen where you can clear out old entries in the log database.

4 Page 22-4 Log Management Update Log Reports Screen The Update Log Reports Screen is used to report on the Update Log database. It is accessed from the Reports button on the Update Log Viewer Screen. Defining the Date Range The Update Log Viewer Screen uses the Add Date field to determine which records to show. You can select a specific date range by entering a new starting and ending date. The default date range is the last 30 days. You can use the Calendar buttons to create a new date range. See the Calendar Option section in the Shared Features & Functions chapter for further information. Report Choice Options When you enter this screen it automatically compiles a list of all the Update Log reports available. It creates this list by looking for report files created using the RUL_*.FRX naming scheme. All the files that are found are listed in alphabetical order in this drop-down box. ZonePro ships with a Basic report. You can use the Document Editor to add new reports to this screen. See the Customizing Documents chapter for more information. Sorting Options By default the information in the log is sorted by the Add Date. You can use the Sort By drop-down box to change the sort to the Database, Action, or Owner field. Report Filters Report filter options allow you to limit the selected records to those that meet certain criteria. The report filters on this screen are Database, Owner and Action. Each report filter has a drop-down box that lists all of the entries found for that field. The default option is to include all entries but you can limit a report to only include a specific entry. For example you can use the Action filter to report on only records that were deleted. The multiple filters work co-operatively such that any selected records must meet all filter conditions. For example, you could limit the report to records for Zoning permits that were deleted. Counting Records You can get a count of the number records that will be included in your report by clicking on the Count button. Any filters used will affect the total.

5 Log Management - Page 22-5 Update Log Purge Screen The Update Log Purge Screen is accessed from the Purge button on the Update Log Viewer Screen. The Update Log Archive Manager allows you to remove old records from the Update Log database. If you wish you can store a copy of the purged records in an XML file in the \ARCHIVE subfolder. Date Range Option You can determine which records to purge by choosing to include all records before a certain date. The date field defaults to the current date. You can type in a new date or use the Calendar button to select a new date. See the Calendar Option section in the Shared Features & Functions chapter for further information. Archive Option You have the option of creating a copy of the log files that are deleted. To do so mark the Create Archive of Update Log check box. When you enter this screen a unique filename is generated and shown in the field in the middle of the screen. The filename has the current date embedded in it. This is the name that will be given to the newly created archive file. Creating the Archive Click on the Purge button to create the archive. If you opted to create an archive then the stated XML file will be created in the \ARCHIVE subfolder. The archive is created as a XML file which is a special kind of text file that stores database information well. Once the archive file is created it no longer needs to be stored on the server. You can move it to CDs for safe-keeping. If needed the archive file can always be used to recreate events that happened in ZonePro in the past.

6 Page 22-6 Log Management External Log Options External Log Viewer Screen The External Log contains a copy of changes passed to ZonePro from ZP Remote users. This screen is accessed from the External Log Viewer button on the Log Manager Screen or from the View External Log button on the ZP Remote Manage screen. This option is only available if you have the ZP Remote Application installed. The Fields Database: This field shows which database the change is for ID: This field shows the ID number for the record changed. For the Property database the Property ID is shown. For the detail databases the Sub ID number is shown. For all other databases the ID Code is shown. Action: This field shows whether the change is an Edit or an Add. There is also a special Align action. Owner: This field shows which ZP Remote user made the change. Add Date: This date shows when the change was created in ZP Remote. Processed: This date shows when this change was processed by ZonePro. Command: This field shows the command expression used to apply the change to ZonePro. Reviewing this command shows exactly what fields were changed. Comments: This field shows any comments that were typed in by the ZP Remote user at the time of the change. MyProp: The Property ID associated with this change, if applicable. Align Records In addition to containing copies of the changes generated by ZP Remote users, the External Log may also contain "Align" records that were generated by ZonePro itself. An Align record accompanies each Add record. When ZP Remote users add a new record, a dummy value is used for the ID and the Permit number. The alignment process sets those values to their correct values as the records are added into ZonePro. The Align record is created by ZonePro so that the correct ID and Permit values are passed back to the originating ZP Remote user.

7 Log Management - Page 22-7 Special Control Buttons Jump This option closes the External Log Viewer Screen and takes you to the record that the log fields reference. For example, if the current log record documents an edit that was made to a violation record, clicking on the Jump button takes you to that violation record. This option is not available for every database. Reports This option takes you to the External Log Reports Screen where you can report on any records in the External Log. Purge This option takes you to the External Log Purge Screen where you can clear out old entries in the log database. External Log Reports Screen The External Log Reports Screen is used to run reports on the External Log database. This screen is accessed from the Reports button on the External Log Viewer Screen. Defining the Date Range This screen uses the Add Date field to determine which records to show. You can select a specific date range by entering a new starting and ending date. The default date range is the last 30 days. You can use the Calendar buttons to create a new date range. Report Choice Options When you enter this screen it automatically compiles a list of all the External Log reports available. It creates this list by looking for report files created using the "RXL_*.FRX" naming scheme. All the files that are found are listed in alphabetical order in this dropdown box. ZonePro ships with a "Basic" report. Sorting Options By default the information in the log is sorted by the Add Date field. You can use the Sort By drop-down box to change the sort to Database, Action or Comments field. Report Filters Report filter options allow you to limit the selected records to those that meet certain criteria. The report filters on this screen are Database, Owner and Action. Each report filter has a drop-down box that lists all of the entries found for that field. The default option is

8 Page 22-8 Log Management to include all entries but you can limit a report to only include a specific entry. For example you can use the Action filter to report on only records that were added. The multiple filters work co-operatively such that any selected records must meet all filter conditions. For example, you could limit the report to records for Violation permits that were added. Counting Records You can get a count of the number records that will be included in your report by clicking on the Count button. Any filters used will affect the total. External Log Purge Screen The External Log Purge Screen is accessed from the Purge button on the External Log Viewer Screen. It allows you to remove old records from the External Log database. If you wish you can store a copy of the purged records in an XML file in the \ARCHIVE subfolder. Date Range Option You can determine which records to purge by choosing to include all records before a certain date. The date field defaults to seven days earlier. You can type in a new date or use the Calendar button to select a new date. See the Calendar Option section in the Shared Features & Functions chapter for further information. Archive Option You have the option of creating a copy of the log files that are deleted. To do so mark the Create Archive of External Log check box. When you enter this screen a unique filename is generated and shown in the field in the middle of the screen. The filename has the current date embedded in it. This is the name that will be given to the newly created archive file. Creating the Archive Click on the Purge button to create the archive. If you opted to create an archive then the stated XML file will be created in the \ARCHIVE subfolder. The archive is created as a XML file which is a special kind of text file that stores database information well. Once the archive file is created it no longer needs to be stored on the server. You can move it to CDs for safe-keeping. If needed the archive file can always be used to recreate events that happened in ZonePro in the past.

9 Log Management - Page 22-9 External Error Log Options External Error Viewer Screen When ZP Remote users send changes to the server there may sometimes be errors processing those records. Accounts of those errors are store in the External Error Log database. That database can be reviewed from the External Error Viewer Screen to determine whether the errors require additional actions. This screen is accessed from the External Error Log Viewer button on the Log Manager Screen or the View External Errors button on the ZP Remote Manager Screen. The Fields Database: This field shows which database the change was for. ID: This field shows the ID number for the record changed. For the Property database the Property ID is shown. For the detail databases the Sub ID number is shown. For all other databases the ID Code is shown. Action: This field shows whether the change is an Edit or an Add. Owner: This field shows which ZP Remote user made the change. Add Date: This date shows when the change was created in ZP Remote. Command: This field shows the command expression used to apply the change to ZonePro. Reviewing this command shows exactly what fields were changed. Error: This field shows the error message generated by ZonePro. Minor errors can be safely ignored but other errors may warrant a consultation with ZP Systems. MyProp: The Property ID associated with this change, if applicable. Special Control Buttons Reports This option takes you to the External Error Log Reports Screen where you can report on any records in the External Error Log. Purge This option takes you to the External Error Log Purge Screen where you can clear out old entries in the error log database.

10 Page Log Management Retry The Retry button is for troubleshooting purposes. It allows you to retry executing the command that passes the update to the proper database. This option can be used in conjunction with the Browse right-click option which allows you to edit the command expression. If the retry is successful the record will be marked for deletion. External Log Reports Screen This screen is used to run reports on the External Error Log database. This screen is accessed from the Reports button on the External Error Viewer Screen. Defining the Date Range This screen uses the Add Date field to determine which records to show. You can select a specific date range by entering a new starting and ending date. The default date range is the last 30 days. You can use the Calendar buttons to create a new date range. Report Choice Options When you enter this screen it automatically compiles a list of all the External Error Log reports available. It creates this list by looking for report files created using the RXE_*.FRX naming scheme. All the files that are found are listed in alphabetical order in this drop-down box. ZonePro ships with a "Basic" report. Sorting Options By default the information in the log is sorted by the Add Date field. You can use the Sort By drop-down box to change the sort to the Database field. Report Filters Report filter options allow you to limit the selected records to those that meet certain criteria. The report filters on this screen are Database, Owner and Action. Each report filter has a drop-down box that lists all of the entries found for that field. The default option is to include all entries but you can limit a report to only include a specific entry. The multiple filters work co-operatively such that any selected records must meet all filter conditions. Counting Records You can get a count of the number records that will be included in your report by clicking on the Count button. Any filters used will affect the total.

11 Log Management - Page External Error Log Purge Screen Once you have determined the cause and severity of any errors in the External Error Log there is no reason to keep those records around. The External Error Log Purge Screen gives you an easy way to remove records from the database. This screen is accessed from the Purge button on the External Error Log Viewer Screen. Archive Option You have the option of copying all of the purged records to an archive xml file in the \ARCHIVE sub folder. When you enter this screen a unique filename is generated and shown in the field in the middle of the screen. The filename has the current date embedded in it. This is the name that will be given to the newly created archive file. You must mark the Create Archive of Error Log check box to use this option. Purging Records Click on the Purge button to delete old records from the External Error Log and optionally create an archive file of those records.