Batch Prcess in C# Excel

Transcription

1 isupprt Case Management Prject BSTL Batch Status Lg Design Specificatin Dcument BSTL Batch Status Lg January 4, 2016

2 BSTL Batch Status Lg Table f Cntents 1. INTRODUCTION SCREEN DETAILS... 3 Last Updated: January 4, 2016

3 BSTL Batch Status Lg 1. INTRODUCTION This screen design slutin dcument prvides detailed infrmatin abut a screen in the isupprt system. This dcument describes the cmplete functinality f the screen, and includes mckup screen shts f the prpsed screen layuts t augment the narrative. Page 2 Last Updated: January 5, 2016

4 BSTL Batch Status Lg 2. SCREEN DETAILS BSTL BSTL is an inquire nly screen used t review the batch executin lgs. The screen enables authrized wrkers t inquire and view the verall executin status f a particular batch prcess. The screen is als displays the specific recrd level errrs lgged during the executin f that batch prcess. SCREEN ID: SCREEN DESCRIPTION: BSTL Batch Status Lgs Batch Status Lg (BSTL) reprt prvides an nline way t review the batch executin lgs. This screen is used t view the status f the batch prcesses that were executed earlier. The wrker may chse t view the executin status f the entire batch prcess; review recrd level errrs that were encuntered during the batch run. Page 3 Last Updated: January 5, 2016

5 BSTL Batch Status Lg SCREEN DESIGN: Review Batch Status Lg Review Batch Status Lg ppup Page 4 Last Updated: January 5, 2016

6 BSTL Batch Status Lg View Batch Errrs Page 5 Last Updated: January 5, 2016

7 BSTL Batch Status Lg SCREEN PROCESS: BSTL will supprt the fllwing Functins by authrized wrkers: Review Batch Status Lgs BSTL is used t review the batch executin lgs. This screen will display the status f the batch prcesses that were executed earlier. Wrkers can search fr a batch by prviding Scheduled Batch Name and a date range. Wrker can ptinally further filter details by the Batch Status. View Batch Errrs This screen functin is used t view the errr/reject recrds in the batch. By accessing this screen functin, the wrker can view the cntrlled exceptins within a batch. Cntrlled exceptins are anticipated errrs, which the batch prgram is equipped t handle via builtin edits r validatins. DATA MANAGEMENT: INQUIRE MODE: Review Batch Status Lgs: The wrker can inquire by either entering the Frm Date r the Date Range (Frm Date and t Date). Optinally the wrker can select frm the list f Batch ID t filter the recrds such that nly the executin lgs that are assciated with the selected batch jb will be listed. Additinal select filters include Batch Name that crrespnds with the batch jb. Upn prviding all apprpriate select filters, the system ppulates the details grid. The details grid displays the list f all batch prgrams executed. The fllwing infrmatin is displayed in the detailed Grid: Prcess Date: The scheduled start date as captured in the Run Bk at the instance when the schedule has been initiated. Batch ID: The Batch ID assciated with the batch prgram run is displayed in this field. Batch Name: The Batch Name crrespnding t the batch prcess is displayed in this field. Start Time: Displays the start time f the batch End Time: Displays the cmpletin time fr the batch Batch Status: This field indicates the status f the batch prcess. The batch status is ABEND, Errr r Successful. After the details grid is ppulated, the wrker can duble click n any grid rw t invke the Batch Schedule details ppup. The Batch Schedule details ppup shws all available additinal infrmatin abut the batch run. Page 6 Last Updated: January 5, 2016

8 BSTL Batch Status Lg The fllwing infrmatin is displayed in the Batch Schedule Ppup fr each recrd selected by the wrker: Prcess Date: The scheduled start date as captured in the Run Bk at the instance when the schedule has been initiated. Batch ID: The Batch ID assciated with a specific batch prcess is displayed in this field. Batch Name: The Batch Name that crrespnds t the batch name is displayed in this field. Prcedure Name: Prcedure name fr the prcedures included in the Batch is displayed in this field. Batch Status: This field indicates whether the batch prcess executin was successful. Errr ID: The errr number is displayed in this field. Wrker: Identifies the name f the user running the batch. The value will primarily be Batch, but can als be a user. Cursr Lcatin: The last lcatin f the cursr is displayed in this field. Executin Lcatin: The Executin Lcatin r status is displayed in this field. Key Values: details related t the specific batch prcess. Fr example, if the batch abended, this field may display the details assciated with the ABEND. Errr Descriptin: The descriptin fr the errr is displayed in this field. Start Time: Displays the start time f the batch End Time: Displays the cmpletin time fr the batch Page 7 Last Updated: January 5, 2016

9 BSTL Batch Status Lg View Batch Errrs: The wrker can inquire by prviding the Batch ID. Batch ID field has a lens icn which is used t select the Batch ID assciated with each batch prcedure. T further filter the results the wrker may chse t select the assciated Batch Name and a date. The N name will be displayed alng with the Batch ID in the selectin list. Batch Name field lens icn is used t select the name f the crrespnding Batch. Prcess Date field is used t filter the recrds n the effective run date. The effective run date is the date n which the batch prcedure was executed. Upn prviding the apprpriate select filters, the system will ppulate the details grid with the recrd level errrs fr the selected batch jb. The details grid n the screen displays the list f all recrd level errrs fr the selected Batch ID and the Batch. If a prcess date is specified, the errrs listed will be limited t thse lgged n the prcess date prvided by the wrker. The fllwing infrmatin is displayed in the detailed Grid: Prcess Date the effective run date n which the batch prcedure was executed. Batch ID the Batch ID and the jb name fr each batch prcedure. Batch Name the name f the Batch crrespnding with the batch prcess. Errr Type the type f the errr ccurred while executing the jb. Create Date: the system date f the batch executin. Key Values Identifies the values that are passed t the input parameters. The success f the prgram executin depends n 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 Cursr Lcatin if the prcess terminated when the Input Table has been prcessed. Errr Descriptin If the errr is an identified SQL Errr, the crrespnding errr message will be displayed. If the errr is an exceptin that the batch prcess is prgrammed t handle, then a descriptive errr message utlining the prblem will be displayed. LIST OF VALUES (LOV) and DROP DOWNS: LOV r # FIELD NAME DROP DOWN 1. Batch Status Drp dwn 2. Errr Type Drp dwn REFM NAME A ABEND E ERROR S SUCCESSFUL E ERROR I INMATIONAL W WARNING VALUES Page 8 Last Updated: January 5, 2016

10 BSTL Batch Status Lg SCREEN MATRIX: SCREEN FUNCTIONS Review Batch Status Lgs View Batch Errrs Descriptin This screen functin is used t review the batch executin lgs. This screen functin is used t view the errr/reject recrds in the batch prcess. SIZE SELECT FILTERS VIEW BATCH STATUS LOGS Batch ID <LOV> Batch Name <LOV> Batch Status <Drp Dwn> This field is used t display the Batch identificatin number fr each batch prcedure. This field is used t display the name f the package assciated with the batch. This field is used t display the status f the batch. INQUIRE, 60 O INVALID VALUE 100 O INVALID VALUE Y VPARM ID_JOB VBSTL ID_JOB VPARM DESC_JOB Y VBSTL PACKAGE_NAME 74 O VBSTL CD_STATUS Page 9 Last Updated: January 4, 2016

11 BSTL Batch Status Lg Frm Date Descriptin This field is used t display the schedule start date. SIZE INQUIRE, 10 R ENTER REQUIRED FIELDS Y VREFM (BSTL/STAT) DESC_VALUE VBSTL DT_EFF_RUN INVALID DATE Y T Date This field is used t display the schedule end date. FUTURE DATE IS NOT ALLOWED 10 O INVALID DATE FUTURE DATE IS NOT ALLOWED Y Y Y VBSTL DT_EFF_RUN TO DATE MUST BE GREATER THAN OR EQUAL TO FROM DATE Y Page 10 Last Updated: January 4, 2016

12 BSTL Batch Status Lg Descriptin SIZE INQUIRE, GRID SECTION REVIEW BATCH STATUS LOGS Prcess Date the effective run date n which the batch prcedure was executed. Batch ID Batch Name Start Time End Time the jb identificatin number and jb name fr each batch prcedure. the name f the batch. the start date and time when this prcess started executin. the end date and time when this prcess finished executin. 10 D VBSTL DT_EFF_RUN 60 D VBSTL ID_JOB VPARM DESC_JOB 100 D VBSTL PACKAGE_NAME 27 D VBSTL TS_JOB_START 27 D VBSTL TS_JOB_END Page 11 Last Updated: January 4, 2016

13 BSTL Batch Status Lg Batch Status Descriptin the status f the batch. POP UP DETAILS VIEW BATCH STATUS LOGS Prcess Date the effective run date n which the batch prcedure is executed. Batch ID Batch Name Recrd Cunt Prcedure Name Batch Status the jb identificatin number and jb name fr each batch prcedure. the stred batch name. The number f recrds prcessed by the jb the stred prcedure name. the displays the status f the batch. SIZE INQUIRE, 74 D VBSTL CD_STATUS VREFM (BSTL/STAT) DESC_VALUE 10 D VBSTL DT _EFF_RUN 60 D VBSTL ID_JOB 100 D VBSTL TS_JOB_START 6 D VBSTL TS_JOB_END 100 D VBSTL TS_CREATE 74 D VBSTL PACKAGE_NAME Page 12 Last Updated: January 4, 2016

14 BSTL Batch Status Lg Start Time End Time Errr ID Wrker Cursr Lcatin Descriptin the start date and time when this prcess started executin the end date and time when this prcess finished executin. the unique recrd number assigned when the new recrd is created. This field identifies the name f the user running the batch. The value will be primarily a batch but can als be a user. This field identifies where in the prcedure the data failed. It cntains the number f recrds frm the input table prcessed befre SIZE INQUIRE, 27 D VBSTL PROCEDURE_NAME 27 D VBSTL CD_STATUS VREFM (BSTL/STAT) DESC_VALUE 10 D VBSTL SEQ_BATCH_LOG 30 D VBSTL ID_USER 200 D VBSTL CURSOR_LOCATION Page 13 Last Updated: January 4, 2016

15 BSTL Batch Status Lg Executin Lcatin Key Values Descriptin the errr ccurred. It als has key infrmatin fr the recrd that caused the errr in the input table. When the input is nt a data table, but if driver table is a flat file, it will input recrd identifying data frm the flat file. This field identifies where the jb abended. The field cntains the last successful statement executed. This field identifies the kind f data at the pint in time that the field is exhibited. The field has the table name and key infrmatin. This may be the same as the cursr lcatin if the prcess caused SIZE INQUIRE, 100 D VBSTL EXEC_LOCATION 1000 D VBSTL LIST_KEY Page 14 Last Updated: January 4, 2016

16 BSTL Batch Status Lg Errr Descriptin Descriptin an errr when the input table was prcessed. This field identifies the SQL errr with a statement. EXAMPLE: "N Data Fund". SELECT FILTERS VIEW BATCH ERRORS Batch ID <LOV> Batch Name <LOV> Errr Type <Drp Dwn> This field is used t display the jb identificatin number and jb name fr each batch prcedure. This field is used t display the name f the package assciated with the batch. This field is used t display the list f errr types that ccurred while executing the batch prcedure. SIZE INQUIRE, 4000 D VBSTL DESC_ERROR 60 O INVALID VALUE 100 O INVALID VALUE Y VBATE ID_JOB VPARM DESC_JOB Y VBATE PACKAGE_NAME 74 O VBATE CD_TYPE_ERROR Page 15 Last Updated: January 4, 2016

17 BSTL Batch Status Lg Prcess Date Descriptin the effective run date n which the batch prcedure was executed. SIZE INQUIRE, 10 R ENTER Y REQUIRED FIELDS INVALID DATE Y VBATE DT _EFF_RUN Case Number Ntice Untitled (Ntice) Excel <Buttn> the unique sequence number that is assigned by the system t a particular case. If there are mre Case IDs, then the drpdwn displays. the unique identificatin number that is assigned t the ntice. the name f the ntice. This buttn is used t exprt all the FUTURE DATE IS NOT ALLOWED 6 O INVALID CASE NUMBER 8 O INVALID VALUE Y VCASE ID_CASE Y VNREF ID_NOTICE 100 D VNREF DESC_NOTICE Page 16 Last Updated: January 4, 2016

18 BSTL Batch Status Lg Descriptin batch errrs fr the file criteria t an Excel spread sheet. SIZE INQUIRE, GRID SECTION VIEW BATCH ERRORS Prcess Date the effective run date n which the batch prcedure was executed. Batch ID the jb identificatin number and jb name fr each batch prcedure. Batch Name the name f the batch. Errr Type the type f the errr that ccurred while executing the jb. Create Date the date when this recrd was created. 10 D VBATE DT_EFF_RUN 60 D VBATE ID_JOB VPARM DESC_JOB 100 D VBATE PACKAGE_NAME 74 D VBATE CD_TYPE_ERROR VREFM(EMSG/EMSG) DESC_VALUE 27 D VBATE TS_CREATE Page 17 Last Updated: January 4, 2016

19 BSTL Batch Status Lg Descriptin DETAIL SECTION VIEW BATCH ERRORS Key Values This field identifies the kind f data at the pint in time that the field is exhibited. It has the table name and key infrmatin. This may be the same as the cursr lcatin if the prcess creates errrs when the input table was prcessed. Errr Descriptin <Text Area> This field identifies the SQL errr with a statement. EXAMPLE: "N Data Fund". SIZE INQUIRE, 1000 D VBATE LIST_KEY 4000 D VBATE DESC_ERROR Page 18 Last Updated: January 4, 2016