Batch Cotrol Processing

Purpose of Document

This document discusses all the batch header related business functions in EnterpriseOne. This document does not cover a specific application and its set up.

Table of contents:

• Overview
• What is Batch Control?
• B0000012 - GetBatchTypeConstant (Get Batch Type Constant)
• N0000001 - BatchOpenBatchControlProcessing (Batch Open - Batch Control Processing)
• N0000001 - BatchControlProcessing (Batch Control Processing)
• B0000004 - BatchOpenOnInitialization (F0011 Write Batch Header)
• B0000042 - FSOpenBatch (F0011 Open Batch) [Obsolete]
• B0000042 - FSCloseBatch (F0011 Close Batch) [Obsolete]
• B0000008 - BatchRevisonOnExit (F0011 Update on Exit)
• B0000003 - GetF0011BatchHeaderInfo (Get F0011 Batch Header Info)
• B0000007 - BatchReviseOnTransactionCommit (F0011 Update on Transaction Commitment)
• Pre-defined Batch Type in EnterpriseOne based on 9.1 Release
• Pre-defined Batch Status

Overview - Brief explanation on business function

What is Batch Control?

When users create a batch of documents using an interactive application such as Journal Entries,they may want to enter the total number of documents and total amount expected for each batch. Batch Control allows users to verify the total amount expected against the total amount entered immediately after the batch is created. Batch Control is enabled by checking the Batch Control Required check box in the General Accounting Constants. With batch control enabled, as you enter your application the batch control form will display and allow you to enter the expected amounts. As you exit the application, the batch control form will again display and allow you to compare the expected amounts to actual amounts.

B0000012 - GetBatchTypeConstant (Get Batch Type Constant)

• Purpose: To determine whether "Batch Control Required" and "Manager Approval Input" are required flags based on the input batch type. (Refer to the table below).
• Parameters
• Data Structure: D0000012 - Get Batch Control Constant

• Detail Routine:
• Refer Batch Status information
• Refer <Pre-defined Batch Type in EnterpriseOne based on 9.1 Release> at the bottom of this document which explains how to read F0009 or F41001 based on the batch type indicated

N0000001 - BatchOpenBatchControlProcessing (Batch Open - Batch Control Processing)

• Purpose: Important: This Business Function is a Client-Only Interpretive Named Event Rule(NER) which will be run as Java serialized object code. This business function cannot be run through CallObject Kernel on the server because, business functions running through CallObject Kernel cannot call any Interactive Application. Thus, this business function is set as a Client-Only Interpretive NER and will be run as a Java Serialized object on the web server. This business function will call an interactive application P0011.

• History:

  The Batch Control Processing functionality has been removed from B0000004 (F0011 Write Batch Header). A new Interpretive Named ER (client-only NER), N0000001 - Batch Open - Batch Control Processing, was created to handle the Batch Control processing. Due to this change, applications and business functions that use Batch Control need to be modified to use N0000001 instead. To minimize the impact of this change, other functionality in B0000004 was kept intact. From this point forward, we recommend to use B0000004 in UBEs and business functions where Batch Control is not needed and use N0000001 in applications or NERs where Batch Control is needed.

  This change will have an impact on applications and business functions that are using Batch Control. For applications, the calls to any Open Batch business functions (i.e. B0000004 and B0000042) should be replaced with the new business function N0000001. Applications that use B0000010 to call batch control directly should be modified to use a Form Interconnect. For business functions, to keep the Batch Control functionality, they should be re-written in NERs.

  In order to minimize the impact of the business function changes, the data structure (D0000004) used by B0000004 is not changed. However a couple of parameters are obsolete from B9 onwards. The data structure (D0000017) used by N0000001 are the same as D0000004. So the parameter mappings can be kept the same when replacing B0000004 with N0000001.

• Parameters
• Data Structure: D0000017 - - Batch Open - Batch Control Processing

• Detail Routine:
• Check input batch type and if it is blank then set error '0003'
• Check input batch number if the value is not zero
• Check batch status by getting F0011.IST and if the value is IN ('U', 'P') set error '0068'
• If the value is neither 'U' nor 'P' update it with 'U - In Use'
• Check whether it requires batch control and whether it is not to be suppressed then call Call( App:P0011 , Form:W0011F )
• If input batch number is zero then get it from NN (00|1) through business function X0010 - X0010GetNextNumber (X0010 - Get Next Number)
• And insert it into F0011 - Batch Header File (IMPORTANT: Creation of batch header is done by this NER and to trace it, review jasdebug.log not jdedebug.log)
• Error Detail:

N0000001 - BatchControlProcessing (Batch Control Processing)

• Purpose: This Business Function is a Client-Only Interpretive Named Event Rule(NER) which will be run as Java serialized object code. This business function cannot be run through CallObject Kernel on the server because, business functions running through CallObject Kernel cannot call any Interactive Application. Thus, this business function is set as a Client-Only Interpretive NER and will be run as a Java Serialized object on the web server. This business function will call an interactive application P0011. N0000001 - Batch Open - Batch Control Processing gets called in the beginning of transaction whereas this BatchControlProcessing (Batch Control Processing) gets called in the end of transaction in a certain interactive application.

• Parameters
• Data Structure: D0000001 - Batch Control Processing

• Detail Routine:
• This NER is to be called after B0000042 - FSCloseBatch (F0011 Close Batch)
• If Batch is still in processing this NER is calling Call( App:P0011 , Form:W0011B , Version: ZJDE0001 ) to indicate batch is still in processing in a certain interactive application
• When batch is processed then it calls Call( App:P0011 , Form:W0011F , Version: ZJDE0001 )

B0000004 - BatchOpenOnInitialization (F0011 Write Batch Header)

• Purpose: Tools API "Start Form Dynamic" currently used in a EnterpriseOne Business Function to handle the Batch Control form.This API is not supported in thin client environments ( i.e. HTML clients). Therefore, the Batch Control functionality was not supported for thin client environments. Simple rule is interactive application P0011 has to be called in presentation (JAS) layer so N0000001 replaces this function B0000004 in interactive applications.

• Parameters
• Data Structure: D0000004 - Batch - Open On Initialization

• Detail Routine:
• Detail routine is more or less same with N0000001 - Batch Open - Batch Control Processing
• Error detail:

B0000042 - FSOpenBatch (F0011 Open Batch) [Obsolete]

• Purpose: This function is to call B0000004 - BatchOpenOnInitialization
• Parameters
• Data Structure: D0000042A - Functional Server- Housekeeping/Open Batch module

• Detail Routine:
• Hand over same parameter defined in B0000004 - BatchOpenOnInitialization (BatchOpenOnInitialization)

B0000042 - FSCloseBatch (F0011 Close Batch) [Obsolete]

• Purpose: This function is to call B0000008 - BatchReviseOnExit (F0011 Update on Exit).
• Parameters
• Data Structure: D0000042B - Functional Server - Close Batch Module

• Detail Routine:
• Hand over same parameter defined in B0000008 - BatchReviseOnExit (F0011 Update on Exit)

B0000008 - BatchRevisonOnExit (F0011 Update on Exit)

• Purpose: This Business Function will close a batch header record and is designed to be executed when "Cancel" or "Close" button is pressed in either Add or Update Mode.
• Parameters
• Data Structure: D0000008 - Batch - Revise On Exit

• Detail Routine:
• If the Suppress Delete Flag allows deleting an empty Batch Header Table (F0011) record and the number of document written in batch header is 0 then this batch header can be deleted.
• If input parameter cFLAGBatchStatus is '2' then IST ='E'
• If batch is Error and BatchType is "1" and cUseManagementApprovalFlag = 'N' set IAPP (Batch Approved for Posting) = 'A'
• If batch is Error and BatchType is "1" and cUseManagementApprovalFlag = 'Y' then set IAPP = 'P'
• If cFLAGBatchStatus is either 1 nor 2
• cUseManagementApprovalFlag = 'Y' then IST = ' ' (a space) and IAPP = 'P'
• cUserManagementApprovalFlag = 'N' then IAPP = 'A', IST ='A', DRSP =' ', 52PP = ' ' and CBP = ' '
• If entered amount is same with computed amount then set BAL = 'Y' otherwise set 'N'
• cFLAGTransactionInBalance ='1' OR cFLAGTransactionInBalance = 'Y' then set BALJ='Y' otherwise set 'N'
• Error detail:

• In custom code if this is implemented wrongly, there is chance of experiencing locking or deadlocking

B0000003 - GetF0011BatchHeaderInfo (Get F0011 Batch Header Info)

• Purpose: This function is to get batch header information through JDB_FetchKeyed() API and this can be used to determine the batch status from F0011 (Batch Header File)
• Parameters
• Data Structure: D0000003 - Get F0011 Batch Header Info

• Detail Routine:
• This function simply returns batch header information based on input batch type and batch number combination
• Error detail:

B0000007 - BatchReviseOnTransactionCommit (F0011 Update on Transaction Commitment)

• Purpose: This Business Function will update a batch header record and is designed to be executed when "OK" is pressed in either Add or Update Mode.
• Parameters
• Data Structure: D0000007 - Batch - Revise On Transaction Commitment

• Detail Routine:
• AME (Amount - Entered) is determined based on input cOverrideMode as below,
• V - Void: AME = AME + mnTransactionAmount
• C - Change/Update: AME = AME - mnTransactionAmountPrevious + mnTransactionAmount
• D - Delete/Cancel: AME = AME - + mnTransactionAmountPrevious
• DOCN (Total Number of Document) is computed as below,
• When input mnTotalNumberOfDocuments is not zero and cOverrideMode is 'A' then DOCN = DOCN + mnTotalNumberOfDocuments
• When input mnTotalNumberOfDocuments is not zero and cOverrideMode is 'D' then DOCN = DOCN - mnTotalNumberOfDocuments
• When input mnTotalNumberOfDocuments is zero and cOverrideMode is 'A' then DOCN = DOCN + 1
• When input mnTotalNumberOfDocuments is zero and cOverrideMode is 'D' then DOCN = DOCN - 1
• If closing the batch while updating it, then set various table column values of the Batch Header Table (F0011)
• cFLAGFormExitedOnAdd = 1 and DOCN = 0 then delete Batch Header
• cFlagBatchStatus is same with detail routine in BatchRevisonOnExit
• Error detail:

Pre-defined Batch Type in EnterpriseOne based on 9.1 Release
: UDC 98/IT or UDC 98/IT - Batch Type

• Codes reserved for clients implies it can be used when your custom routine needed. However this may not work for standard posting routine.
• Unless it is explicitly flag as Y - required, the value is considered as 'N - Not Required'.
• F41001.ICRI and F41001.IARI where SY='specific system code' for Manufacturing and Distribution Family.

In case a certain batch type goes to pending for approval, refer to constant files based on batch type. In EnterpriseOne batch types are hard coded as below,

• Table F0009 - General Constants file contains how to define these value as below:

• Above table belongs to Environment cache so to make change restart JDE services.
• Batch Control information A/R can be defined only through default company '00000'.

Pre-defined Batch Status
: UDC 98/IC or UDC 98/IC - Batch Status

• A certain batch can be accessed only when the batch status is A - Approved.
• Batch Status 'U - In Use' is to be updated as soon as batch is accessed. In this way other processes/users are not able to access the same batch till end of batch process. This can can help to avoid phantom read or dirty read of a certain transaction.
• Batch Header (F0011) is to be written as soon as monetary transaction is to be handled and this will be used till end of transaction.
• The batch type and batch number combination makes a set of transaction and determine how Account Ledger is to be handled in writing General Balance file (F0902).