Contents Show
The Files screen is used to manage batch files such as recovering batch files, viewing and resetting batch sequence numbers, and viewing batch file transaction logs. It is a tabbed page on the EBT Management Utility screen.
Files screen
|
|
Unless otherwise stated below, all controls on the Files screen are visible and enabled when:
The screen is active.
If one or more special conditions exist that affect a control on the Files screen, the condition(s) are documented for that specific control below.
Complete the information in the Daily File Recovery group box.
This group box includes controls to recover batch files for a specific date. The title text of the group box is set to "Daily File Recovery". The following controls are included in the group box:
File drop-down list box
Select the file name to be recovered in this drop-down list box. It is populated with a descriptive file name that is associated with the actual file name. It is filled with a list of file descriptions from the REFERENCEDICTIONARY table where the category = "EBTDAILYFILENAMES".
File Date calendar control
Select or enter the date of the file in this calendar control.
It defaults to today's date.
The date selected or entered must be less than the current system date. If it is not, a standard error message (E0009) displays when the screen is processed.
Recover File button
Click the Recover File button to recover the batch file.
It has a mnemonic of "R".
A standard information message displays.
When the system has successfully recovered the batch file, a standard information message (I0029) displays.
When clicked, the system creates the file name for the given file/date combination and then runs the batch file import process for the file created. The import process deletes any records for the given file name and then imports the data.
Complete the information in the Batch File Sequence Numbers group box.
This group box includes controls to view and reset batch file sequence numbers. The title text of the group box is set to "Batch File Sequence Numbers". The following controls are included in the group box:
File drop-down list box
Select the file name for the batch sequence numbers in this drop-down list box. It is filled with a list of file descriptions from the REFERENCEDICTIONARY table where the category = "EBTBATCHFILENAMES".
Next Sequence Number text and value label
The text and value label displays the next sequential number in the batch sequence for the selected file in the File drop-down list box.
New Sequence Number text box
View, enter, or update the new sequence number for the selected file in the File drop-down list box in this text box. The text box allows the entry of numeric characters only. The maximum number of characters that can be entered in the text box is six (6) characters.
Reset Next Sequence Number button
Click the Reset Next Sequence Number button to reset the next sequence number to the value currently entered in the New Sequence Number text box.
It has a mnemonic of "N".
Resetting the sequence label or insert a new log row with the new value. Depending on if the new value is less or more than the existing new value.
The system resets the sequence number for the selected file by inserting a record to increase the next sequence number or deleting records to decrease the next sequence number. If records are deleted, they are stored in the EBTBATCHTRANSACTIONLOGHISTORY table to preserve the audit trail.
The OUTCOMETYPEID is 1111 to indicate a sequence number adjustment. This is consistent with current EBT Processor system's Return File Service functionality.
When the Reset Next Sequence Number button is clicked, the following occurs:
All log records equal to the new value or larger are deleted.
OR
A new log row with a new value is inserted.
AND
When the system successfully resets the next sequence number, a standard information message (I0030) displays.
Complete the information in the Batch File Logs group box.
This group box includes controls to search for and view the batch file transaction log. Logs can be viewed for a specific log file. The title text of the group box is set to "Batch File Logs". The following controls are included in the group box:
File drop-down list box
Select the file name for the batch log file in this drop-down list box. It is filled with a list of file descriptions from the REFERENCEDICTIONARY table where category="EBTBATCHFILENAMES".
Start Date calendar control
Select or enter the date starting the date range in this calendar control.
It defaults to yesterday's date.
The date selected or entered must be less than the end date. If it is not, a standard error message (E0069) displays when the screen is processed.
End Date calendar control
Select or enter the date ending of the date range in this calendar control.
It defaults to today's date.
The date selected or entered must be less than or equal to the current system date. If it is not, a standard error message (E0008) displays when the screen is processed.
Search button
Click the Search button to perform a search and filter the results displayed in the data grid based on the filter criteria specified.
When Search is clicked, the data grid refreshes and displays results that match the specified filter criteria.
It has a mnemonic of "S".
Export to Excel button
Click the Export to Excel button to export the contents of the data grid to an Excel file.
A Windows Save File As screen displays when the button is clicked.
The control is enabled when:
The data grid is populated with data.
It has a mnemonic of "E".
Batch File Logs data grid
View the information in the Batch File Logs data grid.
The data grid contains a row for each batch log file that matches the specified filter criteria. The title text of the data grid is set to "Batch File Logs". The records in the data grid are sorted in numeric order by the Sequence Number column.
The data grid consists of the following control(s):
Sequence Number column
This column displays the sequence number for the batch for each record displayed within the data grid.
The title of the column is set to "Sequence Number". The information displayed within the column is read-only.
User ID column
This column displays the user ID of the user who was logged for the batch sequence for each record displayed within the data grid.
The title of the column is set to "User ID". The information displayed within the column is read-only.
Begin Datetime column
This column displays the date and time when the batch began for each record displayed within the data grid.
The title of the column is set to "Begin Datetime". The information displayed within the column is read-only.
End Datetime column
This column displays the date and time when the batch ended for each record displayed within the data grid.
The title of the column is set to "End Datetime". The information displayed within the column is read-only.
Outcome column
This column displays the recorded outcome of the batch sequence for each record displayed within the data grid.
The title of the column is set to "Outcome". The information displayed within the column is read-only.
If data can be validated and saved on the screen, the following processes occur when the screen is processed:
A process to check for required controls as identified in the Data Map below is performed.
A process to check for valid entries as identified individually for each applicable control in Screen Elements above is performed.
A process to check for edits and cross edits as identified for each applicable control in Screen Elements above is performed.
If any checks or processes fail, a standard error message displays.
If no data can be validated and saved on the screen:
No cross edits are performed.
All values are considered legitimate.
No data is written to the database.
The Data Map defines the values saved for all controls on the screen. If available, any additional notes or comments are displayed in the Notes column.
Control Label |
Control Type |
Table. Column |
Notes |
Daily File Recovery |
group box |
· |
Contains controls to recover batch files for a specific date. |
File |
drop-down list box |
REFERENCEDICTIONARY. DESCRIPTION |
Where CATEGORY = EBTDAILYFILENAMES'. |
File Date |
calendar control |
· |
Defaults to today's date. |
Batch File Sequence Numbers |
group box |
· |
Contains controls to view and reset batch file sequence numbers. |
File |
drop-down list box |
REFERENCEDICTIONARY. DESCRIPTION |
Where CATEGORY = 'EBTBATCHFILENAMES' |
Next Sequence Number |
text and value label |
· |
Displays the largest UNIQUEMESSAGEID + 1 in the EBTBATCHTRANSACTIONLOG table for the batch type. SELECT MAX(convert(bigint, UNIQUEMESSAGEID)) + 1 from EBTBATCHTRANSACTIONLOG where BATCHTRANSACTIONTYPE = XXXXX where XXXXX = CNWVEN, CNWUPC, or CNWCSB for the case of Chickasaw |
New Sequence Number |
text box |
EBTBATCHTRANSACTIONLOG. UNIQUEMESSAGEID |
· |
Batch File Logs |
group box |
· |
Contains controls to search and view the batch file transaction log. |
File |
drop-down list box |
REFERENCEDICTIONARY. DESCRIPTION |
Where CATEGORY = 'EBTBATCHFILENAMES' |
Start Date |
calendar control |
· |
Defaults to the day before today's date. |
End Date |
calendar control |
· |
Defaults to today's date. |
Batch File Logs |
data grid |
· |
· |
Sequence Number |
data grid column |
EBTBATCHTRANSACTIONLOG. UNIQUEMESSAGEID |
· |
User ID |
data grid column |
EBTBATCHTRANSACTIONLOG. USERID |
· |
Begin Datetime |
data grid column |
EBTBATCHTRANSACTIONLOG. TRANSACTIONGBEGINDATE |
· |
End Datetime |
data grid column |
EBTBATCHTRANSACTIONLOG. TRANSACTIONENDDATE |
· |
Outcome |
data grid column |
EBTBATCHTRANSACTIONLOG. |
· |
~ Denotes a required control (if applicable). The process that checks for required controls does not occur on screens displayed in read-only or Details mode.
+ Denotes data written to the database when screen processing occurs (if applicable). The process that writes data to the database does not occur on screens displayed in read-only or Details mode.
|
Software Version: 2.40.00