BATCH

The BATCH table stores batch instances that are used to view and update batches throughout the system.

Primary Key

Primary Key Field Type
ID uniqueidentifier

Fields

Field Field Type Null Notes Description
BATCHNUMBER nvarchar(100) Default = '' The unique number of a given batch.
DESCRIPTION nvarchar(1000) Default = ''
PROJECTEDNUMBEROFRECORDS int Default = 0 The projected number of records in this batch.
PROJECTEDTOTALAMOUNT money Default = 0 The projected total amount for records in this batch.
STATUSCODE tinyint Default = 0 0=Uncommitted, 1=Committed, 2=Deleted, 3=Committing
DATECOMMITTED datetime yes The date that the batch was committed.
COMMENTS nvarchar(2000) Default = ''
CREATEOUTPUTIDSET bit Default = 0 Designates whether or not an ID set should be created as a result of the batch commit process.
OUTPUTIDSETNAME nvarchar(100) Default = '' The name of the output ID set to be created by the batch commit process.
OVERWRITEOUTPUTIDSET bit Default = 0 Designates whether or not to overwrite the output ID set if one with the same name already exists.
CREATEEXCEPTIONBATCH bit Default = 0 Indicates whether a batch should be created for exceptions during the commit process.
EXCEPTIONBATCHNAME nvarchar(60) Default = '' The name to use when creating an exception batch.
PURGEBATCH bit Default = 0 Indicates whether or not to delete the batch data and mark the batch as deleted after the commit process.
CREATECONTROLREPORT bit Default = 0 Indicates whether or not to generate data for a control report.
EFTFILECREATED bit Default = 0 Indicates whether or not an EFT transmission file has been created for this batch.
DATEADDED datetime Default = getdate() Indicates the date this record was added.
DATECHANGED datetime Default = getdate() Indicates the date this record was last changed.
TS timestamp Timestamp.
TSLONG bigint (Computed) yes CONVERT(bigint, TS) Numeric representation of the timestamp.
FORMDEFINITIONXML xml yes Stores the field defaults for a batch.
VALIDATEBATCH bit Default = 0 Indicates whether or not to validate the batch before the commit process runs. Only a successful validate will allow the batch to be committed.
CHECKFORDUPLICATERECORDS bit Default = 1 Indicates whether or not to check for duplicate records in the batch.
USEPROJECTEDTOTALS bit Default = 1 Indicates whether or not the projected totals values should be used in validation.
AUTOSAVEONROWCHANGE bit Default = 0 Indicates whether or not the batch should auto save on each row change.
OVERRIDE bit Default = 0 Indicates whether a exception batch number is overridden with a user defined value.
STATUS nvarchar(11) (Computed) yes CASE [STATUSCODE] WHEN 0 THEN N'Uncommitted' WHEN 1 THEN N'Committed' WHEN 2 THEN N'Deleted' WHEN 3 THEN N'Committing' END Provides a translation for the 'STATUSCODE' field.
AUTOMATCHTHRESHOLD decimal(20, 4) Default = 0
OVERALLMATCHTHRESHOLD decimal(20, 4) Default = 0
PARAMETERSXML xml yes
DISABLEADDNEWROW bit Default = 0

Foreign Keys

Foreign Key Field Type Null Notes Description
BATCHTEMPLATEID uniqueidentifier BATCHTEMPLATE.ID FK to BATCHTEMPLATE
APPUSERID uniqueidentifier yes APPUSER.ID FK to APPUSER
BATCHWORKFLOWSTATEID uniqueidentifier BATCHWORKFLOWSTATE.ID FK to BATCHWORKFLOWSTATE
ORIGINATINGBATCHID uniqueidentifier yes BATCH.ID FK to BATCH
ADDEDBYID uniqueidentifier CHANGEAGENT.ID FK to CHANGEAGENT.
CHANGEDBYID uniqueidentifier CHANGEAGENT.ID FK to CHANGEAGENT.

Indexes

Index Name Fields Unique Primary Clustered
IX_BATCH_BATCHTEMPLATEID BATCHTEMPLATEID
IX_BATCH_DATEADDED DATEADDED yes
IX_BATCH_DATECHANGED DATECHANGED
IX_BATCH_ID_APPUSERID ID, APPUSERID
IX_BATCH_ORIGINATINGBATCHID ORIGINATINGBATCHID
IX_BATCH_STATUSCODE_APPUSERID STATUSCODE, APPUSERID
PK_BATCH ID yes yes
UIX_BATCH_BATCHNUMBER_BATCHTEMPLATEID BATCHNUMBER, BATCHTEMPLATEID yes

Triggers

Trigger Name Description
TR_BATCH_AUDIT_UPDATE
TR_BATCH_AUDIT_DELETE

Referenced by

Referenced by Field
ADDRESSVALIDATION BATCHID
BATCHADDRESSVALIDATION BATCHID
BATCHAMPRODATA ID
BATCHAMPROIMPORT BATCHID
BATCHAUCTIONITEM BATCHID
BATCHBBNCDONATION BATCHID
BATCHBBNCEVENTREGISTRATION BATCHID
BATCHBBNCPROFILE BATCHID
BATCHBBNCSIGNUP BATCHID
BATCHCOAUPDATE BATCHID
BATCHCONSTITUENT BATCHID
BATCHCONSTITUENTADDRESSUPDATE BATCHID
BATCHCONSTITUENTUPDATE BATCHID
BATCHCURRENCYEXCHANGERATE BATCHID
BATCHDECEASEDFINDER BATCHID
BATCHDESIGNATIONLEVELFINANCIALINFO BATCHID
BATCHDIRECTDEBITRETURN BATCHID
BATCHDIRECTMARKETINGEFFORT BATCHID
BATCHEDUCATIONALHISTORYUPDATE BATCHID
BATCHEMAILFINDER BATCHID
BATCHEVENT BATCHID
BATCHEVENTREGISTRANT BATCHID
BATCHEVENTSPONSORSHIP BATCHID
BATCHGIVINGSUMMARYUPDATE BATCHID
BATCHIGNOREDUPLICATE BATCHID
BATCHINTERACTION BATCHID
BATCHMEMBERSHIP BATCHID
BATCHMEMBERSHIPDUES BATCHID
BATCHMERCHANDISEINVENTORY BATCHID
BATCHMODELINGANDPROPENSITY BATCHID
BATCHMODELINGANDPROPENSITYUPDATE BATCHID
BATCHPDACCOUNTSEGMENTMAPPING BATCHID
BATCHPEOPLEFINDER BATCHID
BATCHPHONEFINDER BATCHID
BATCHPLEDGEWRITEOFF BATCHID
BATCHRE7INTEGRATIONGIVINGSUMMARY BATCHID
BATCHREVENUE BATCHID
BATCHREVENUECONSTITUENTACCOUNT BATCHID
BATCHSPONSORSHIP BATCHID
BATCHSTATISTICS BATCHID
BATCHSTATUS PARAMETERSETID
BATCHSTEWARDSHIPPLANSTEPUPDATE BATCHID
BATCHTIMESHEET BATCHID
BATCHWORKFLOWSTATUS BATCHID
COAUPDATE BATCHID
CREDITCARDPROCESSING BATCHID
CREDITCARDPROCESSINGRETRYBATCH ID
CREDITCARDPROCESSINGRETRYBATCH PARENTBATCHID
CREDITCARDPROCESSINGSTATE BATCHID
DECEASEDFINDER BATCHID
DECEASEDFINDERGETPROCESSDATA BATCHID
DONATIONBATCH BATCHID
EMAILFINDER BATCHID
EVENTBATCH ID
EXCHANGECALENDARITEMBATCH BATCHID
EXCHANGECONTACTBATCH BATCHID
EXCHANGEEMAILBATCH BATCHID
FAFEVENTBATCH BATCHID
FINANCIALTRANSACTIONLINEITEM BATCHID
GENERATEBACSFILEPROCESS BATCHID
GENERATEEFTFILEPROCESS BATCHID
GLACCOUNTBATCH BATCHID
IMPORTPROCESSBATCH BATCHID
MERCHANDISEPRODUCTINSTANCEHISTORY BATCHID
NETCOMMUNITYMAPPINGRULEBATCH BATCHID
PEOPLEFINDER BATCHID
PHONEFINDER BATCHID
RECURRINGGIFTINSTALLMENTEVENT BATCHID
REGISTRANTBATCH BATCHID
UPDATEMULTIPLECONSTITUENTSFROMMFOBATCH BATCHID