Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

How to Feed Enterprise Feeder Batch Files

The KFS Enterprise Feeder Batch File Upload allows you to upload flat file transactions from the external feeder systems.  The uploaded files are processed by the enterprise feeder job, which reconciles the totals as the minimum validation. The Scrubber and Poster jobs then process the accepted files to update the GL balances. Unlike the Collector Batch Upload, the Enterprise Feeder Batch Upload process is designed for a trusted source, processing the files faster and performing the minimum validation. They are most likely used by external feeder systems such as payroll and cashiering systems.

Documentation

https://test.kuali.org/confluence/display/KFSOLD/Enterprise+Feeder+Documentation

The distribution has a series of test files in the staging directory.

Overview

The Enterprise Feeder Batch process involves the following four steps:

1.      Creating the Feeder Files from your source system: Create a data file and a reconciliation file in the specified flat file format.

2.      Uploading the Enterprise Feeder Batch Files: Upload the above files to the KFS staging directory, using the delivered interface (or, transfer the files directly to the KFS staging directory).

3.      Executing the Enterprise Batch Job: Execute the batch job to insert rows into the Origin Group and Origin Entry tables.

4.      Executing the Scrubber and Poster Jobs: Processes the origin transactions and updates balance tables.

 ?

Step 1: Create Feeder Files from the Source System

Generate two flat files from your feeder system: data file and reconciliation file.  The reconciliation file serves as a batch control file to validate the number of transactions and total dollars contained in your file.  You should name the data file filenname.dataand filename.recon.

Filename.data File

 

The batch file format is identical to the files created by exporting an origin entry group from the GL Correction Process document. They are 187 character long flat file entries with each line corresponding to one origin entry.

Note that the Encumbrance Update Code (D=Document, R=Reference) is required for encumbrance transactions.  When the encumbrance update code is "R" (dis-encumbrance), additional three fields to reference the encumbering transactions are required.

 

Column Name

Length

Start

End

Comment

Fiscal Year

4

1

4


Chart Code

2

5

6


Account Number

7

7

13


Sub-account Number

5

14

18


Object Code

4

19

22


Sub-object Code

3

23

25


Balance Type Code

2

26

27


Object Type Code

2

28

29


Fiscal Period

2

30

31


Document Type

4

32

35


Origin Code

2

36

37


Document Number

14

38

51


Entry Seq Number

5

52

56


Description

40

57

96


Sign

1

97

97

+

Amount

20

98

117

Transaction Amount

Debit/Credit Code

1

118

118

D or C

Transaction Date

10

119

128

YYYY-MM-DD

Org Doc Number

10

129

138


Project Code

10

139

148


Org Ref Id

8

149

156


Ref Type Code

4

157

160

Original Encumbrance Balance Type Code required for Enc Update Code of 'R'

Ref Origin Code

2

161

162

Original Encumbrance Origin Code required for Enc Update Code of 'R'

Ref Doc Number

14

163

176

Original Encumbrance Document Number required for Enc Update Code of 'R'

Reversal Date

10

177

186

YYYY-MM-DD

Enc Update Code

1

187

187

D or R (Reversal)

 

Sample Transactions

1         2         3         4        5         6          7         8         9        10        11        12        13        14        15        16        17        18        19       19
----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|
2010BL2336320-----5105---ACES04INVW013187          00006Writeoff for  3100.                     +00000000000000010.00D2009-10-09          ----------
2010BL1023200-----4100---EXEX04PO  013022          00001MK CORPORATION ACTIVE                   +00000000000000604.00D2009-10-09          ----------        PO  011008                    R
2010BL1023200-----9892---EXFB04PO  013022          00002TP Generated Offset                     +00000000000000604.00C2009-10-09          ----------        PO  011008
2010BL1023200-----4100---EXEX04PO  013046          00001MK CORPORATION ACTIVE                   +00000000000000604.00D2009-10-09          ----------        PO  011010                    R
2010BL1023200-----9892---EXFB04PO  013046          00002TP Generated Offset                     +00000000000000604.00C2009-10-09          ----------        PO  011010
2010BL1023200-----4100---EXEX04PO  013058          00001MK CORPORATION ACTIVE                   +00000000000000604.00D2009-10-09          ----------        PO  011011                    R
2010BL1023200-----9892---EXFB04PO  013058          00002TP Generated Offset                     +00000000000000604.00C2009-10-09          ----------        PO  011011
2010BL1023200-----4100---EXEX04PO  013066          00001MK CORPORATION ACTIVE                   +00000000000000604.00D2009-10-09          ----------        PO  011012                    R
2010BL1023200-----9892---EXFB04PO  013066          00002TP Generated Offset                     +00000000000000604.00C2009-10-09          ----------        PO  011012
2010BL1023200-----4100---EXEX04PO  013077          00001MK CORPORATION ACTIVE                   +00000000000000604.00D2009-10-09          ----------        PO  011013                    R
2010BL1023200-----9892---EXFB04PO  013077          00002TP Generated Offset                     +00000000000000604.00C2009-10-09          ----------        PO  011013
2010BL1023200-----4100---EXEX04PO  013087          00001MK CORPORATION ACTIVE                   +00000000000000604.00D2009-10-09          ----------        PO  011014                    R
2010BL1023200-----9892---EXFB04PO  013087          00002TP Generated Offset                     +00000000000000604.00C2009-10-09          ----------        PO  011014
2010BL1023200-----4100---EXEX04PO  013096          00001MK CORPORATION ACTIVE                   +00000000000000604.00D2009-10-09          ----------        PO  011015                    R
2010BL1023200-----9892---EXFB04PO  013096          00002TP Generated Offset                     +00000000000000604.00C2009-10-09          ----------        PO  011015
2010BL1023200-----4100---EXEX04PO  013102          00001MK CORPORATION ACTIVE                   +00000000000000604.00D2009-10-09          ----------        PO  011016                    R
2010BL1023200-----9892---EXFB04PO  013102          00002TP Generated Offset                     +00000000000000604.00C2009-10-09          ----------        PO  011016
2010BL1023200-----4100---EXEX04PO  013110          00001MK CORPORATION ACTIVE                   +00000000000000604.00D2009-10-09          ----------        PO  011017                    R
2010BL1023200-----9892---EXFB04PO  013110          00002TP Generated Offset                     +00000000000000604.00C2009-10-09          ----------        PO  011017
2010BL1023200-----4100---EXEX04PO  013119          00001MK CORPORATION ACTIVE                   +00000000000000604.00D2009-10-09          ----------        PO  011018                    R
2010BL1023200-----9892---EXFB04PO  013119          00002TP Generated Offset                     +00000000000000604.00C2009-10-09          ----------        PO  011018
2010BL1023200-----4100---EXEX04PO  013129          00001MK CORPORATION ACTIVE                   +00000000000000604.00D2009-10-09          ----------        PO  011019                    R
2010BL1023200-----9892---EXFB04PO  013129          00002TP Generated Offset                     +00000000000000604.00C2009-10-09          ----------        PO  011019

        

Filename.recon File

The standard format of the reconciliation file is:

C tableid row count ;

S field1  dollar amount ;

S field2  dollar amount ;

E checksum ;

  • A 'C' 'S' or 'E' must be the first character on a line unless the line is entirely white-space or a comment. The case of these three codes is not significant.
  • Semi-colons are required before any possible comments on C S or E lines.  Any amount of white-space delimits the elements of C, S and E lines. 
  • Row count must be a non-negative integer.
  • Fieldn is the technical fieldname(s) in the target database. -- Case *is* significant, since this must match the databasename(s) exactly.
  • Dollar amount may be negative; the check is significant to 4 decimal places: the origin entry transaction amounts are absolute amounts.
  • The check-sum on line E is the number of C and S lines.
  • A C line and a terminating E line are mandatory; S lines are optional.
  • There may be more than one C-E block per meta data file.

The example of the recon file:


c gl_entry_t 1;
S trn_ldgr_entr_amt 1;
e 02;

Step 2: Uploading Enterprise Feeder Files

Use the delivered interface from the Administration -> Enterprise Feed Upload menu.

Select the files you have created, enter the File Set Identifier, and click add.  The File Set Identifier must be unique for each upload.
When you click add, the Enterprise Feeder Batch Upload Process saves the files in the staging directory

Warning:  Unless you have modified the external.config.directory property or logs.directory property, you should be able to find your logs in /opt/logs/dev/kuali.  This page and the build.properties file should help you find this type of thing: https://test.kuali.org/confluence/display/KULDOC/Configuration+Properties+2

File Set Identifier

Upon successful upload, the staging directory will have three files identified by the File Set Identifier.

File

Physical Name

Explanation

Done File

entpBatchFile_UserName_FileSetID.done

0 byte file created by the Enterprise Feeder Batch Upload process

Data File

entpBatchFile_UserName_FileSetID.data

Your data file is uploaded and renamed

Reconciliation File

entpBatchFile_UserName_FileSetID.recon

Your reconciliation file is uploaded and renamed


The files in the staging directory can be viewed from the Administration Tab -> Batch File menu. Search for the files in the staging/enterprise feed directory.
?Warning: If you exceed the file size, you will experience the file upload limit error. In this case, you can FTP the files to staging directly. Make sure to create the done file manually.

Step 3:  Execute  enterpriseFeedJob

From the Administration Tab -> Schedule menu, execute the enterpriseFeedJob.
To manually execute the job, modify the unscheduled job, and click run.
Verify that the job has run successfully and review the log file.  Be aware that "Succeeded" does not always mean your data file has been accepted correctly – it only means that the job has completed. You need to verify the log file to determine if the rows were inserted into the Origin Table.

Staging Directory after the Feed

When the enterpriseFeedJobruns successfully, the done file is removed from the Staging directory. The File Set without the done file will not be processed when you submit the enterpriseFeedJob next time.

Step 4: Execute Scrubber and Poster

Just as any other batch processes, execute the Scrubber and Poster Jobs to process the origin transactions and update the GL Balance tables.

  • No labels