<Project Name> - SDM Batch Operations Manual

Last Update: <Insert Date>

BUREAU OF INFORMATION
SYSTEMS

SDM Batch Operations Manual Template

Page 1 of 12
<Project Name> - SDM Batch Operations Manual
Last Update: <Insert Date>

03/10/2016

SDM Batch Operations Manual Template

Page 2 of 12
 <Project Name> - SDM Batch Operations Manual
Last Update: <Insert Date>
Overview
Application Business Process
<Provide an overview of the business processes and goals for the application. Do not go
into details of the batch processes as this will be discussed in another section.>

Functionality of Batches
Process Description
<List all of the batch job
<Provide a brief description for each.>
processes

SDM Batch Operations Manual Template

Page 3 of 12
 <Project Name> - SDM Batch Operations Manual
Last Update: <Insert Date>
Batch Schedule Requirements
Expected
Job Post- Start Run Input Output Escalation
Description Pre-event Frequency Run Time Contact Person
ID event Time Days File File Process
(min.)
<List the <Provide a brief description of <Enter the Job <Enter the Job <Enter the <Enter the <Enter the <Enter the <Enter the <Enter the <Identify the tier <Identify the person or
unique the batch job. E.g. provider Id that occurs Id that occurs frequency of time the days that estimated name of name of level if the batch team necessary for
Batch maintenance, application before this after this batch the batch job. batch job the batch length of time the input the output needs to be contact>
file id or maintenance) batch job> job> E.g. daily, is to start> job is to the batch job file for the file for the escalated>
name> weekly, run in a will take to batch job, batch job,
monthly)> week. complete in if if
E.g. M, T, minutes> applicable applicable
W, Th, F, > >
S, Su>

SDM Batch Operations Manual Template

Page 4 of 12
 <Project Name> - SDM Batch Operations Manual
Last Update: <Insert Date>
Batch Dependency
<List all the batch jobs dependent on each other>

Job ID Description Pre-event Post-event

<List the <Provide a brief description of the batch job. <Enter the Job Id that occurs <Enter the Job Id that occurs
unique Batch E.g. provider maintenance, application before this batch job> after this batch job>
file id or maintenance)
name>

SDM Batch Operations Manual Template

Page 5 of 12
 <Project Name> - SDM Batch Operations Manual
Last Update: <Insert Date>
Directory Structure for Batch Files
<List the directory for the batch files for the input, output, and run files.>

Input
File Location on FTP Server
Production
Acceptance Test
System/Integration Test
Development
File Location for Database Server
Production
Acceptance Test
System/Integration Test
Development
File Location for Application Server
Production
Acceptance Test
System/Integration Test
Development
Run Files
File Location on FTP Server
Production
Acceptance Test
System/Integration Test
Development
File Location for Database Server
Production
Acceptance Test
System/Integration Test
Development
File Location for Application Server
Production
Acceptance Test
System/Integration Test
Development

SDM Batch Operations Manual Template

Page 6 of 12
 <Project Name> - SDM Batch Operations Manual
Last Update: <Insert Date>
Output
File Location on FTP Server
Production
Acceptance Test
System/Integration Test
Development
File Location for Database Server
Production
Acceptance Test
System/Integration Test
Development
File Location for Application Server
Production
Acceptance Test
System/Integration Test
Development

SDM Batch Operations Manual Template

Page 7 of 12
 <Project Name> - SDM Batch Operations Manual
Last Update: <Insert Date>
Log Files
Log Files Naming Convention

Log File Structure and Acceptable Return Codes

Log Files Naming Convention for Application Specific Logging

SDM Batch Operations Manual Template

Page 8 of 12
 <Project Name> - SDM Batch Operations Manual
Last Update: <Insert Date>
Batch Frequency
Job ID Frequency Run Days Start Time
<List the <Enter the frequency of the batch job. E.g. daily, <Enter the days that the batch <Enter the time the batch job
unique Batch weekly, monthly)> job is to run in a week or is to start>
file id or which specific days of the
name> month. E.g. M, T, W, Th, F,
S, Su>

SDM Batch Operations Manual Template

Page 9 of 12
 <Project Name> - SDM Batch Operations Manual
Last Update: <Insert Date>
Expected Run Time for Batches
Job ID Expected Run Time (min.)
<List the unique Batch <Enter the estimated length of time the batch job will take to complete in
file id or name> minutes>

SDM Batch Operations Manual Template

Page 10 of 12
 <Project Name> - SDM Batch Operations Manual
Last Update: <Insert Date>
Batch Failure Protocol
<List the steps for protocol if the batch fails. An example is provided below>

Steps Actions

BATCH FAILURE Application Team receives the failure notification via

1 NOTIFICATION the pager which is with the person who is on call.

CRITICALITY Application Team determines criticality by

2 DETERMINATION examining the nature of the error.

APP Team notifies Team lead with Estimated time

APPLICATION TEAM FIX
3 of completion of fix.
IDENTIFIED
Team lead notifies Application Manager

FIX Team lead contacts State individuals to enable

4 COMPLETED/DEPLOYMENT deployment PRD.

QA Update Application Manager will initiate QA request for

5
PRD deployment next AM.

SDM Batch Operations Manual Template

Page 11 of 12
 <Project Name> - SDM Batch Operations Manual
Last Update: <Insert Date>
Escalation Procedures
<Describe the escalation procedure in terms of tiers. Tiers are the levels at which escalation is
handled based on the criticality of the batch process.>

Tier 1
Job ID Actions to be Taken
<List the unique <Describe the actions to be performed for this batch job when escalated to this tier>
Batch file id or
name>

Tier 2
Job ID Actions to be Taken
<List the unique <Describe the actions to be performed for this batch job when escalated to this tier>
Batch file id or
name>

Work Alternate
Team Contact Person Email
Telephone Number

SDM Batch Operations Manual Template

Page 12 of 12