GetNumetrixInBoundControlInfo

Get/Set Numetrix Inbound Control Info

Minor Business Rule

Object Name: B34A0940

Parent DLL: CMFG

Location: Client/Server

Language: C

1.Functional Description

1.1Purpose
This business function will be used to retrieve status information from the inbound control file. The 
inbound control file contains status information about the last inbound data import from Numetrix to 

OneWorld. The control file is a one-line text file.


1.2Setup Notes and Prerequisites

The text file must have the fields in the order as shown in the data structure below, starting with 
batch number. The fields must be seperated with the field seperator as specified in the F34A10 record 

with key "34A". Any non-numeric fields (dates, strings, characters) must also be enclosed in the text 

qualifier from the F34A10 record.


2.Technical Specifications


2.4Processing 

1.Open tables F34A10 and F34A11. Exit with error if fail

2.Get Parameters

Use key "34A" to fetch F34A10 record  exit with error if fail.
Use field delimiter (FFDL) from F34A10 record

Use text qualifier (TC056) from F34A10 record

Use date format (FRMT) from F34A10 record to fetch  date format mask. Call 

GetDateStringOrMaskFromUDC. Exit with error if fail


Use input szF34A11Key to fetch F34A11 record  exit with error if fail. Use NFLF as flat file name.


3.Open the flat file from F34A11. Exit with error if fail


4.Parse Line from Text File

Fetch one line from text file.
Text file line should have fields in the order as specified in the data structure, beginning with 

batch number.

For each field in the text file, populate the corresponding data structure member.


5.Clean up
Close F34A10, F34A11, text file.
Set any applicable errors and return


^

Data Structure

D34A0940 - Get/Set Numetrix Inbound Control Info

Data Item    Data Structure Description    I/O    Required    Notes
KEY          szF34A11Key                   I/O                Key to F34A11 table used to find 

control file pathname

SUPPS        cSuppressErrorMessage         I/O                '1'  BSFN will not set errors, but will 

return error ID

ERRC         cErrorCode                    I/O                '1'  errors, check error ID

DTAI         szErrorMessageId              I/O                error code, if any

BN01         mnBatchNumberArray001         I/O                Control file batch number

EV01         cBatchErrorStatus             I/O                Control file error status

DTSE         jdDateSent                    I/O                Control file date sent

PBTM         mnTimeSentHhMmSs              I/O                Control file time sent

END          jdDateAcknowledged            I/O                Control file date acknowledged

PETM         mnTimeAcknowledgedHhMmSs      I/O                Control file time acknowledged

EV01         cMessagesSent                 I/O                Control file messages sent flag

MATH01       mnMessagesRecordCount         I/O                Control file messages record count

EV01         cForecastSent                 I/O                Control file forecast sent flag

MATH01       cForecastRecordCount          I/O                Control file forecast record count


^

Parameter NameData ItemData TypeReq/OptI/O/Both
cSuppressErrorMessageSUPPScharOPTINPUT

A flag indicating whether or not runtime error messaging will occur when an error message is issued from a business function.        0 = allow 
runtime error message handling.        1 = suppress runtime error message handling.

cErrorCodeERRCcharOPTOUTPUT

This error code indicates if any errors occurred during the creation of the Trip Document Detail (F4914) records by the Delivery Document 
Set Server program (XT4914).

szErrorMessageIdDTAIcharOPTOUTPUT

A code that identifies and defines a unit of information. It is an alphanumeric code up to 8 characters long that does not allow blanks or 
special characters such as %, &, or +. You create new data items using system codes 55-59. You cannot change the alias.

mnBatchNumberArray001BN01MATH_NUMERICOPTBOTH

A number that identifies a group of transactions that are processed and balanced as a unit. You can let the system assign this number 
through Next Numbers, or you can assign it yourself.

cBatchErrorStatusEV01charOPTBOTH

An option that specifies the type of processing for an event.

jdDateSentDTSEJDEDATEOPTBOTH

This is the date the information was sent from the source.

mnTimeSentHhMmSsPBTMMATH_NUMERICOPTBOTH

A field that is used to enter the beginning time of the operation sequence for the work center operation on the routing.

jdDateAcknowledgedENDJDEDATEOPTBOTH

The date when an asset was removed or returned from a particular location.

mnTimeAcknowledgedHhMmSsPETMMATH_NUMERICOPTBOTH

A field that is used to enter the ending time of the operation sequence for the work center operation on the routing.

mnMessagesRecordCountMATH01MATH_NUMERICOPTBOTH

- - - Good Performance Low Value. 

cMessagesSentEV01charOPTBOTH

An option that specifies the type of processing for an event.

szF34A11KeyKEYcharOPTINPUT

A pre-established index or number the system uses to retrieve data from a file.  For example, the keys to the Employee Master file might 
be:    1   Employee number,    2   Social Security number, or    3   Home Department

cForecastSentEV01charOPTBOTH

An option that specifies the type of processing for an event.

mnForecastRecordCountMATH01MATH_NUMERICOPTBOTH

- - - Good Performance Low Value. 

Related Functions

B34A1000 Format Date To String

Related Tables

F34A10 APS Integration Constants
F34A11 Numetrix Integration File Definition
SetNumetrixInBoundControlInfo

SetNumetrixInBoundControlInfo

Get/Set Numetrix Inbound Control Info

Minor Business Rule

Object Name: B34A0940

Parent DLL: CMFG

Location: Client/Server

Language: C

1.Functional Description

1.1Purpose
This business function will be used to create the inbound control file. The inbound control file 
contains status information about the last inbound data import from Numetrix to OneWorld. The control file 

is a one-line text file.


1.2Setup Notes and Prerequisites

The text file will be created with the fields in the order as shown in the data structure below, 
starting with batch number. The fields will be seperated with the field seperator as specified in the 

F34A10 record with key "34A". Any non-numeric fields (dates, strings, characters) will also be enclosed in 

the text qualifier from the F34A10 record.


2.Technical Specifications


2.4Processing 

1.Open tables F34A10 and F34A11. Exit with error if fail

2.Get Parameters

Use key "34A" to fetch F34A10 record  exit with error if fail.
Use field delimiter (FFDL) from F34A10 record

Use text qualifier (TC056) from F34A10 record

Use date format (FRMT) from F34A10 record to fetch  date format mask. Call 

GetDateStringOrMaskFromUDC. Exit with error if fail


Use input szF34A11Key to fetch F34A11 record  exit with error if fail. Use NFLF as flat file name.


3.Open the flat file from F34A11. Exit with error if fail.


4.Write Line to Text File

Write the line to the text file. Text file line should have fields in the order as specified in 
the data structure, beginning with batch number. For each field in the text file, use the 

corresponding data structure member. Non-numeric fields (dates, characters, strings) will be enclosed in the 

text qualifier, all fields will be seperated with the field seperator. Date fields should be 

converted to strings using the FormatDate API and the date format mask.


5.Clean up
Close F34A10, F34A11, text file.
Set any applicable errors and return


^

Data Structure

D34A0940 - Get/Set Numetrix Inbound Control Info

Data Item    Data Structure Description    I/O    Required    Notes
KEY          szF34A11Key                   I/O                Key to F34A11 table used to find 

control file pathname

SUPPS        cSuppressErrorMessage         I/O                '1'  BSFN will not set errors, but will 

return error ID

ERRC         cErrorCode                    I/O                '1'  errors, check error ID

DTAI         szErrorMessageId              I/O                error code, if any

BN01         mnBatchNumberArray001         I/O                Control file batch number

EV01         cBatchErrorStatus             I/O                Control file error status

DTSE         jdDateSent                    I/O                Control file date sent

PBTM         mnTimeSentHhMmSs              I/O                Control file time sent

END          jdDateAcknowledged            I/O                Control file date acknowledged

PETM         mnTimeAcknowledgedHhMmSs      I/O                Control file time acknowledged

EV01         cMessagesSent                 I/O                Control file messages sent flag

MATH01       mnMessagesRecordCount         I/O                Control file messages record count

EV01         cForecastSent                 I/O                Control file forecast sent flag

MATH01       cForecastRecordCount          I/O                Control file forecast record count


^

Parameter NameData ItemData TypeReq/OptI/O/Both
cSuppressErrorMessageSUPPScharOPTINPUT

A flag indicating whether or not runtime error messaging will occur when an error message is issued from a business function.        0 = allow 
runtime error message handling.        1 = suppress runtime error message handling.

cErrorCodeERRCcharOPTOUTPUT

This error code indicates if any errors occurred during the creation of the Trip Document Detail (F4914) records by the Delivery Document 
Set Server program (XT4914).

szErrorMessageIdDTAIcharOPTOUTPUT

A code that identifies and defines a unit of information. It is an alphanumeric code up to 8 characters long that does not allow blanks or 
special characters such as %, &, or +. You create new data items using system codes 55-59. You cannot change the alias.

mnBatchNumberArray001BN01MATH_NUMERICOPTBOTH

A number that identifies a group of transactions that are processed and balanced as a unit. You can let the system assign this number 
through Next Numbers, or you can assign it yourself.

cBatchErrorStatusEV01charOPTBOTH

An option that specifies the type of processing for an event.

jdDateSentDTSEJDEDATEOPTBOTH

This is the date the information was sent from the source.

mnTimeSentHhMmSsPBTMMATH_NUMERICOPTBOTH

A field that is used to enter the beginning time of the operation sequence for the work center operation on the routing.

jdDateAcknowledgedENDJDEDATEOPTBOTH

The date when an asset was removed or returned from a particular location.

mnTimeAcknowledgedHhMmSsPETMMATH_NUMERICOPTBOTH

A field that is used to enter the ending time of the operation sequence for the work center operation on the routing.

mnMessagesRecordCountMATH01MATH_NUMERICOPTBOTH

- - - Good Performance Low Value. 

cMessagesSentEV01charOPTBOTH

An option that specifies the type of processing for an event.

szF34A11KeyKEYcharOPTINPUT

A pre-established index or number the system uses to retrieve data from a file.  For example, the keys to the Employee Master file might 
be:    1   Employee number,    2   Social Security number, or    3   Home Department

cForecastSentEV01charOPTBOTH

An option that specifies the type of processing for an event.

mnForecastRecordCountMATH01MATH_NUMERICOPTBOTH

- - - Good Performance Low Value. 

Related Functions

B34A1000 Format Date To String

Related Tables

F34A10 APS Integration Constants
F34A11 Numetrix Integration File Definition