isupport case management project bstl – batch …...review the batch execution logs. this screen...

iSupport Case Management Project

BSTL – Batch Status Log Design Specification Document

BSTL –Batch Status Log

January 4, 2016

BSTL – Batch Status Log

Last Updated: January 4, 2016

Table of Contents

1. INTRODUCTION .................................................................................................................... 2 2. SCREEN DETAILS .................................................................................................................. 3


Page 2 Last Updated: January 5, 2016

1. INTRODUCTION This screen design solution document provides detailed information about a screen in the iSupport system. This document describes the complete functionality of the screen, and includes mock-up screen shots of the proposed screen layouts to augment the narrative.



2. SCREEN DETAILS BSTL - BSTL is an inquire only screen used to review the batch execution logs. The screen enables authorized workers to inquire and view the overall execution status of a particular batch process. The screen is also displays the specific record level errors logged during the execution of that batch process.

SCREEN ID: BSTL – Batch Status Logs

SCREEN DESCRIPTION: Batch Status Log (BSTL) report provides an online way to review the batch execution logs. This screen is used to view the status of the batch processes that were executed earlier. The worker may choose to view the execution status of the entire batch process; review record level errors that were encountered during the batch run.



SCREEN DESIGN:

Review Batch Status Log

Review Batch Status Log popup



View Batch Errors



SCREEN PROCESS: • BSTL will support the following Screen Functions by authorized workers:

o Review Batch Status Logs– BSTL is used to review the batch execution logs. This screen will display the status of the batch processes that were executed earlier. Workers can search for a batch by providing Scheduled Batch Name and a date range. Worker can optionally further filter details by the Batch Status.

o View Batch Errors – This screen function is used to view the error/reject records in the batch.

By accessing this screen function, the worker can view the controlled exceptions within a batch. Controlled exceptions are anticipated errors, which the batch program is equipped to handle via built-in edits or validations.

DATA MANAGEMENT: INQUIRE MODE: Review Batch Status Logs: • The worker can inquire by either entering the From Date or the Date Range (From Date and to

Date). Optionally the worker can select from the list of Batch ID to filter the records such that only the execution logs that are associated with the selected batch job will be listed. Additional select filters include Batch Name that corresponds with the batch job.

• Upon providing all appropriate select filters, the system populates the details grid. The details grid

displays the list of all batch programs executed. The following information is displayed in the detailed Grid:

o Process Date: The scheduled start date as captured in the Run Book at the instance when

the schedule has been initiated.

o Batch ID: The Batch ID associated with the batch program run is displayed in this field.

o Batch Name: The Batch Name corresponding to the batch process is displayed in this field.

o Start Time: Displays the start time of the batch

o End Time: Displays the completion time for the batch

o Batch Status: This field indicates the status of the batch process. The batch status is ABEND, Error or Successful.

• After the details grid is populated, the worker can double click on any grid row to invoke the ‘Batch

Schedule details’ popup. The ‘Batch Schedule details’ popup shows all available additional information about the batch run.



• The following information is displayed in the Batch Schedule Pop-up for each record selected by

the worker:

o Process Date: The scheduled start date as captured in the Run Book at the instance when the schedule has been initiated.

o Batch ID: The Batch ID associated with a specific batch process is displayed in this field.

o Batch Name: The Batch Name that corresponds to the batch name is displayed in this field.

o Procedure Name: Procedure name for the procedures included in the Batch is displayed

in this field. o Batch Status: This field indicates whether the batch process execution was successful.

o Error ID: The error number is displayed in this field.

o Worker: Identifies the name of the user running the batch. The value will primarily be

Batch, but can also be a user.

o Cursor Location: The last location of the cursor is displayed in this field.

o Execution Location: The Execution Location or status is displayed in this field.

o Key Values: This field displays details related to the specific batch process. For example, if the batch abended, this field may display the details associated with the ABEND.

o Error Description: The description for the error is displayed in this field.

o Start Time: Displays the start time of the batch

o End Time: Displays the completion time for the batch



View Batch Errors: • The worker can inquire by providing the Batch ID. Batch ID field has a lens icon which is used to

select the Batch ID associated with each batch procedure. To further filter the results the worker may choose to select the associated Batch Name and a date.

• The N name will be displayed along with the Batch ID in the selection list. Batch Name field lens

icon is used to select the name of the corresponding Batch. Process Date field is used to filter the records on the effective run date. The effective run date is the date on which the batch procedure was executed.

• Upon providing the appropriate select filters, the system will populate the details grid with the record

level errors for the selected batch job. • The details grid on the screen displays the list of all record level errors for the selected Batch ID

and the Batch. If a process date is specified, the errors listed will be limited to those logged on the process date provided by the worker.

• The following information is displayed in the detailed Grid:

o Process Date - This field displays the effective run date on which the batch procedure was executed.

o Batch ID - This field displays the Batch ID and the job name for each batch procedure.

o Batch Name - This field displays the name of the Batch corresponding with the batch process.

o Error Type - This field displays the type of the error occurred while executing the job.

o Create Date: This field displays the system date of the batch execution.

o Key Values - Identifies the values that are passed to the input parameters. The success of the program execution depends on the key values received via the parameters. The field will include the table name and key data elements. The key value may be the same as Cursor Location if the process terminated when the Input Table has been processed.

o Error Description – If the error is an identified SQL Error, the corresponding error message will be displayed. If the error is an exception that the batch process is programmed to handle, then a descriptive error message outlining the problem will be displayed.

LIST OF VALUES (LOV) and DROP DOWNS:

# FIELD NAME

LOV or DROP DOWN

REFM NAME VALUES

1. Batch Status Drop down

A - ABEND E - ERROR S - SUCCESSFUL

2. Error Type Drop down

E – ERROR I – INFORMATIONAL W - WARNING


Page - 9 Last Updated: January 4, 2016

SCREEN ELEMENT MATRIX:

Screen ELEMENT Description SIZE

REQUIRED, OPTIONAL,

DISPLAY FOR

INQUIRE, ADD,

UPDATE, DELETE

EDITS FOR INQUIRE, ADD, UPDATE, DELETE DATA DICTIONARY LOOKUP

I A U D EDIT I A U D ERROR SCREEN FUNCTIONS Review Batch Status Logs

This screen function is used to review the batch execution logs.

View Batch Errors This screen function is used to view the error/reject records in the batch process.

SELECT FILTERS - VIEW BATCH STATUS LOGS Batch ID <LOV>

This field is used to display the Batch identification number for each batch procedure.

60 O - - - INVALID VALUE

Y - - - VPARM ID_JOB VBSTL ID_JOB VPARM DESC_JOB

Batch Name <LOV>

This field is used to display the name of the package associated with the batch.


Y - - - VBSTL PACKAGE_NAME

Batch Status <Drop Down>

This field is used to display the status of the batch.

74 O - - - - - - - - VBSTL CD_STATUS




REQUIRED, OPTIONAL,

DISPLAY FOR

INQUIRE, ADD,

UPDATE, DELETE


I A U D EDIT I A U D ERROR VREFM (BSTL/STAT) DESC_VALUE

From Date This field is used to display the schedule start date.

10 R - - - ENTER REQUIRED

FIELDS

INVALID DATE

FUTURE DATE IS NOT

ALLOWED

Y

Y

Y

- - -

- - -

- - -

VBSTL DT_EFF_RUN

To Date This field is used to display the schedule end date.

10 O - - - INVALID DATE

FUTURE DATE IS NOT

ALLOWED

TO DATE MUST BE GREATER THAN OR

EQUAL TO FROM DATE

Y

Y

Y

- - -

- - -

- - -

VBSTL DT_EFF_RUN




REQUIRED, OPTIONAL,

DISPLAY FOR

INQUIRE, ADD,

UPDATE, DELETE


I A U D EDIT I A U D ERROR

GRID SECTION -REVIEW BATCH STATUS LOGS Process Date This field displays

the effective run date on which the batch procedure was executed.

10 D - - - - - - - - VBSTL DT_EFF_RUN

Batch ID

This field displays the job identification number and job name for each batch procedure.

60 D - - - - - - - - VBSTL ID_JOB VPARM DESC_JOB

Batch Name

This field displays the name of the batch.

100 D - - - - - - - - VBSTL PACKAGE_NAME

Start Time This field displays the start date and time when this process started execution.

27 D - - - - - - - - VBSTL TS_JOB_START

End Time This field displays the end date and time when this process finished execution.

27 D - - - - - - - - VBSTL TS_JOB_END




REQUIRED, OPTIONAL,

DISPLAY FOR

INQUIRE, ADD,

UPDATE, DELETE


I A U D EDIT I A U D ERROR Batch Status

This field displays the status of the batch.

74 D - - - - - - - - VBSTL CD_STATUS VREFM (BSTL/STAT) DESC_VALUE

POP UP DETAILS FOR VIEW BATCH STATUS LOGS Process Date This field displays

the effective run date on which the batch procedure is executed.

10 D - - - - - - - - VBSTL DT _EFF_RUN

Batch ID


60 D - - - - - - - - VBSTL ID_JOB

Batch Name This field displays the stored batch name.

100 D - - - - - - - - VBSTL TS_JOB_START

Record Count The number of records processed by the job

6 D - - - - - - - - VBSTL TS_JOB_END

Procedure Name This field displays the stored procedure name.

100 D - - - - - - - - VBSTL TS_CREATE

Batch Status This field displays the displays the status of the batch.

74 D - - - - - - - - VBSTL PACKAGE_NAME




REQUIRED, OPTIONAL,

DISPLAY FOR

INQUIRE, ADD,

UPDATE, DELETE


I A U D EDIT I A U D ERROR Start Time This field displays

the start date and time when this process started execution

27 D - - - - - - - - VBSTL PROCEDURE_NAME

End Time This field displays the end date and time when this process finished execution.

27 D - - - - - - - - VBSTL CD_STATUS VREFM (BSTL/STAT) DESC_VALUE

Error ID This field displays the unique record number assigned when the new record is created.

10 D - - - - - - - - VBSTL SEQ_BATCH_LOG

Worker This field identifies the name of the user running the batch. The value will be primarily a batch but can also be a user.

30 D - - - - - - - - VBSTL ID_USER

Cursor Location This field identifies where in the procedure the data failed. It contains the number of records from the input table processed before

200 D - - - - - - - - VBSTL CURSOR_LOCATION




REQUIRED, OPTIONAL,

DISPLAY FOR

INQUIRE, ADD,

UPDATE, DELETE


I A U D EDIT I A U D ERROR the error occurred. It also has key information for the record that caused the error in the input table. When the input is not a data table, but if driver table is a flat file, it will input record identifying data from the flat file.

Execution Location

This field identifies where the job abended. The field contains the last successful statement executed.

100 D - - - - - - - - VBSTL EXEC_LOCATION

Key Values This field identifies the kind of data at the point in time that the field is exhibited. The field has the table name and key information. This may be the same as the cursor location if the process caused

1000 D - - - - - - - - VBSTL LIST_KEY




REQUIRED, OPTIONAL,

DISPLAY FOR

INQUIRE, ADD,

UPDATE, DELETE


I A U D EDIT I A U D ERROR an error when the input table was processed.

Error Description This field identifies the SQL error with a statement. EXAMPLE: "No Data Found".

4000 D - - - - - - - - - VBSTL DESC_ERROR

SELECT FILTERS - VIEW BATCH ERRORS Batch ID <LOV>

This field is used to display the job identification number and job name for each batch procedure.


Y - - - VBATE ID_JOB VPARM DESC_JOB

Batch Name <LOV>

This field is used to display the name of the package associated with the batch.


Y - - - VBATE PACKAGE_NAME

Error Type <Drop Down>

This field is used to display the list of error types that occurred while executing the batch procedure.

74 O - - - - - - - - VBATE CD_TYPE_ERROR




REQUIRED, OPTIONAL,

DISPLAY FOR

INQUIRE, ADD,

UPDATE, DELETE


I A U D EDIT I A U D ERROR Process Date This field displays


10 R - - - ENTER REQUIRED

FIELDS

INVALID DATE

FUTURE DATE IS NOT

ALLOWED

Y

Y

Y

- - -

- - -

- - -

VBATE DT _EFF_RUN

Case Number

This field displays the unique sequence number that is assigned by the system to a particular case. If there are more Case IDs, then the drop-down displays.

6 O - - - INVALID CASE

NUMBER

- - - - VCASE ID_CASE

Notice This field displays the unique identification number that is assigned to the notice.


Y - - - VNREF ID_NOTICE

Untitled (Notice)

This field displays the name of the notice.

100 D - - - - - - - - VNREF DESC_NOTICE

Excel <Button>

This button is used to export all the

- - - - - - - - - -




REQUIRED, OPTIONAL,

DISPLAY FOR

INQUIRE, ADD,

UPDATE, DELETE


I A U D EDIT I A U D ERROR batch errors for the file criteria to an Excel spread sheet.

GRID SECTION – VIEW BATCH ERRORS Process Date This field displays


10 D - - - - - - - - VBATE DT_EFF_RUN

Batch ID


60 D - - - - - - - - VBATE ID_JOB VPARM DESC_JOB

Batch Name

This field displays the name of the batch.

100 D - - - - - - - - VBATE PACKAGE_NAME

Error Type This field displays the type of the error that occurred while executing the job.

74 D - - - - - - - - VBATE CD_TYPE_ERROR VREFM(EMSG/EMSG) DESC_VALUE

Create Date This field displays the date when this record was created.

27 D - - - - - - - - VBATE TS_CREATE




REQUIRED, OPTIONAL,

DISPLAY FOR

INQUIRE, ADD,

UPDATE, DELETE


I A U D EDIT I A U D ERROR DETAIL SECTION – VIEW BATCH ERRORS Key Values This field identifies

the kind of data at the point in time that the field is exhibited. It has the table name and key information. This may be the same as the cursor location if the process creates errors when the input table was processed.

1000 D - - - - - - - - VBATE LIST_KEY

Error Description <Text Area>

This field identifies the SQL error with a statement. EXAMPLE: "No Data Found".

4000 D - - - - - - - - - VBATE DESC_ERROR

isupport case management project bstl – batch …...review the batch execution logs. this screen...

Documents