GetF0011BatchHeaderInfo

Get F0011 Batch Header Info

Minor Business Rule

Object Name: B0000003

Parent DLL: CALLBSFN

Location: Client/Server

Language: C

Functional Description

Purpose

Setup Notes and Prerequisites

Special Logic



Technical Specification


Functional Description

Purpose

Setup Notes and Prerequisites

Special Logic



Technical Specification



Functional Description

Purpose

Setup Notes and Prerequisites

Special Logic


Technical Specification




Parameters





Related Tables





Related Functions





Processing


Functional Description

Purpose
This function is used to retrieve the columns stored in a record of the F0011 Batch Header Table.  If 
the batch is in use, an error will be set.

Setup Notes and Prerequisites

Special Logic
After passing in a Batch Type and Batch Number, this BSFN will return all of the values stored in the 
record.  An error will be set if the batch is "In Use".  To suppress all errors from being set, pass 
a "Y" or a "1" in the cSuppressAllErrorsFlag parameter.

Technical Specification

Main BSFN:
If Batch Type is blank
   Set Error
If Batch Number is "0"
   Set Error
Open F0011 table
Fetch Batch from F0011 table
If Batch does not exist
   Set Error
Else
   Load Returned Values
   If Batch Status = "P" or "U" AND Suppress Errors Flag != "Y"
      Set Error
Close F0011 table

Data Structure

D0000003 - Get F0011 Batch Header Info

This BSFN will return all of the columns in the F0011 table for a specific record (Batch 
Type/Number).  It will also set error "0068" if the batch is in use.  Pass a "Y" in the cSuppressAllErrorsFlag, if 
you do not want the error to be set.

Parameter NameData ItemData TypeReq/OptI/O/Both
szBatchTypeICUTcharREQBOTH

Special Input Expected
Pass in the Batch Type of the batch that you are checking the status of.
^

mnBatchNumberICUMATH_NUMERICREQBOTH

Special Input Expected
Pass in the Batch Number of the batch that you are checking the status of.
^

cBatchStatusISTcharOPTOUTPUT

Special Output Expected
The Batch Status will be passed back in this parameter.

cBatchApprovalStatusIAPPcharOPTOUTPUT

Special Output Expected
The Batch Approval Status will be passed back in this parameter.

^

jdBatchDateDICJJDEDATEOPTOUTPUT

Special Output Expected
The Batch Date will be passed back in this parameter.

^

mnDocumentsExpectedNDOMATH_NUMERICOPTOUTPUT

Special Output Expected
The Batch Number of Documents Expected will be passed back in this parameter.

^

mnBatchAmountExpectedAICUMATH_NUMERICOPTOUTPUT

Special Output Expected
The Batch Amount Expected will be passed back in this parameter.

^

mnDocumentsEnteredDOCNMATH_NUMERICOPTOUTPUT

Special Output Expected
The Batch Number of Documents Entered will be passed back in this parameter.
^

mnBatchAmountEnteredAMEMATH_NUMERICOPTOUTPUT

Special Output Expected
The Batch Amount Entered will be passed back in this parameter.
^

cBalancedDocumentsFlagBALcharOPTOUTPUT

Special Output Expected
The Balanced Documents Flag will be passed back in this parameter.
^

cBalancedJournalEntriesFlagBALJcharOPTOUTPUT

Special Output Expected
The Balanced Journal Entries Flag will be passed back in this parameter.
^

cPostOutOfBalanceFlagPOBcharOPTOUTPUT

Special Output Expected
The Post Out of Balance Flag will be passed back in this parameter.

^

cIncludeOnIntegrityFlagIBOIcharOPTOUTPUT

Special Output Expected
The Include Batch On Integrity Reports Flag will be passed back in this parameter.
^

szUserIDUSERcharOPTOUTPUT

Special Output Expected
The User ID will be passed back in this parameter.

^

szAuthorizedUserIDAUSRcharOPTOUTPUT

Special Output Expected
The Authorized User ID will be passed back in this parameter.

^

cSuppressAllErrorsFlagEV01charOPTINPUT

Special Input Expected
The BSFN will set an error if the batch is in use, if you would like to suppress any errors set, pass 
a "Y" or a "1" in this parameter.
^

Related Functions

None

Related Tables

F0011 Batch Control Records