Co_ByCompletionsBeginDoc

Co_By Completions MBF

Master Business Function

Object Name: B3102080

Parent DLL: CMFGBASE

Location: Client/Server

Language: C

Business Function Specification

Source NameB3102080DesignerPH5732462

Data Structure D3102080ProgrammerPH5732462

Function NameCo_By Completions Master Business Function

System Code31

Function Category

Function Use




Revisions Log 

DateModifications bySAR NumberDescription

04/08/99P.Houtkooper  2998732Created



1.Functional Description


1.1Purpose
The purpose of this function is to separate the work order completions logic from B3100790.   This business function will process all cache records 

created by B3101570 to the F3111.  


1.2Setup Notes and Prerequisites

This business function will use the following structure to store global variables.


DSB3102080INTERNAL


This business function will use the following three cache structures.


DSB3102080CACHE 

DSB3102080WORKCACHE 



DSB3102080CACHEKEY 

Data Item IndexNotes

mnJobNumberRetrieved from Begin Doc - Cache Key

szComputerIDRetrieved from Begin Doc - Cache Key

mnLineNumberCache Row Counter - Cache Key



DSB3102080WORKCACHEKEY 

Data Item IndexNotes

mnJobNumberRetrieved from Begin Doc - Cache Key

szComputerIDRetrieved from Begin Doc - Cache Key



2.Technical Specifications


2.1Parameters: D3102080A - Co_By Completions Begin Doc

Data Item Data Structure DescriptionI/ORequiredNotes

JOBSmnJobNumberI/ONB3101570 JobNumber

EV01cSuppressErrorMessagesINBlank - Do not suppress errors '1' - Suppress errors

ERRCcErrorCodeON'1' - Warning '2' - Error 

DTAIszErrorMessageIDON

CTIDszComputerIDI/ON

PIDszProgramIDINDefault - "EP31115"

VERSszVersionINDefault - "ZJDE0001"

DOCOszDocumentOrderInvoiceEIYUse to retrieve WO data pointer


2.2Related Tables 

Table Table Description



2.3Related Business Functions

Source NameFunction Name

B9800181GetLocalComputerId

B3100330VerifyAndGetWorkOrderMaster

B9800100GetAuditInfo


2.4Processing 



Functional Outline:


Initialize Internal Structure 

Load Internal (lpVoid, lpBhvrcom, hUser, '85)


Get Job Number

Get Local Computer ID


Initialize B3102080 cache(Main)

Initialize WorkCache cache(Common Information)


Retrieve and Load Processing Options to WorkCache 

Retrieve and Load  Audit Information to WorkCache

Retrieve and Load WO Master Data to WorkCache  


Add WorkCache cache



Data Structure

D3102080A - Co_By Completions Begin Doc

Parameter NameData ItemData TypeReq/OptI/O/Both
mnJobnumberA_JOBSJOBSMATH_NUMERICOPTNONE

The job number (work station ID) which executed the particular job.

cSuppressErrorMessages_EV01EV01charOPTNONE

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

cErrorCode_ERRCERRCcharOPTNONE

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).

szErrorMessageID_DTAIDTAIcharOPTNONE

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.

szComputerID_CTIDCTIDcharOPTNONE

szProgramId_PIDPIDcharOPTNONE

The number that identifies the batch or interactive program (batch or interactive object). For example, the number of the Sales Order Entry 
interactive program is P4210, and the number of the Print Invoices batch process report is R42565. The program ID is a variable length value. 
It is assigned according to a structured syntax in the form TSSXXX, where: T The first character of the number is alphabetic and identifies the 
type, such as P for Program, R for Report, and so on. For example, the value P in the number P4210 indicates that the object is a 
program. SS The second and third characters of the number are numeric and identify the system code. For example, the value 42 in the number P4210 
indicates that this program belongs to system 42, which is the Sales Order Processing system. XXX The remaining characters of the numer are 
numeric and identify a unique program or report. For example, the value 10 in the number P4210 indicates that this is the Sales Order Entry 
program.

szVersion_VERSVERScharOPTNONE

A user-defined set of specifications that control how applications and reports run. You use versions to group and save a set of user-defined 
processing option values and data selection and sequencing options. Interactive versions are associated with applications (usually as a 
menu selection). Batch versions are associated with batch jobs or reports. To run a batch process, you must choose a version.

mnDocumentOrderInvoiceE_DOCODOCOMATH_NUMERICOPTNONE

A number that identifies an original document. This document can be a voucher, a sales order, an invoice, unapplied cash, a journal entry, 
and so on.

Related Functions

B0000128 Retrieve Company Currency Code
B0000129 Retrieve Currency Decimals
B3100330 Verify and Get Work Order Master
B3100760 Update Work Order Status
B3100770 Work Order Completions MBF
B3101570 Cache Co/By Product Completion
B3102110 Cache Resource Percentage Index
B4000520 Get Item UoM Conversion Factor
B4100210 Check Item Branch
B4300570 Receipt Routing, Verify Receipt Routing Process
B4301260 F43092, Validate Negative Completion
B4301270 F43092, Perform Negative Completion
B9800100 Get Audit Information
B9800181 Environment List Business Functions
X0005 Get User Defined Codes
X3111 F3111 Process Master Data
X4101 Validate and Retrieve Item Master
X41LOT Assign Lot Number
X43091 Receipt Routing Initiator
XT4111Z1 Inventory Transactions

Related Tables

F3111 Work Order Parts List
F4101 Item Master
F4101T OBSOLETE - Item Master Tag File
F4102 Item Branch File
F4801 Work Order Master File
Co_ByCompletionsClearWorkFile

Co_ByCompletionsClearWorkFile

Co_By Completions MBF

Master Business Function

Object Name: B3102080

Parent DLL: CMFGBASE

Location: Client/Server

Language: C

Business Function Specification

Source NameB3102080DesignerPH5732462
Data Structure 
D3102080ProgrammerPH5732462
Function Name
Co_By Completions Master Business Function
System Code
31
Function Category

Function Use




Revisions Log 
DateModifications bySAR NumberDescription
04/08/99P.Houtkooper  2998732Created



1.Functional Description

1.1Purpose
The purpose of this function is to separate the work order completions logic from B3100790.   This business function will process all cache records 
created by B3101570 to the F3111.  


1.2Setup Notes and Prerequisites


This business function will use the following structure to store global variables.

DSB3102080INTERNAL


This business function will use the following three cache structures.


DSB3102080CACHE 

DSB3102080WORKCACHE 



DSB3102080CACHEKEY 

Data Item IndexNotes
mnJobNumberRetrieved from Begin Doc  Cache Key

szComputerIDRetrieved from Begin Doc  Cache Key

mnLineNumberCache Row Counter  Cache Key



DSB3102080WORKCACHEKEY 

Data Item IndexNotes
mnJobNumberRetrieved from Begin Doc  Cache Key

szComputerIDRetrieved from Begin Doc  Cache Key


2.Technical Specifications



5.1Parameters: D3102080D  Co_By Completions Clear Work File

Data Item Data Structure DescriptionI/ORequiredNotes
JOBSmnJobNumberI/OYRetrieved from Begin Doc

CTIDszComputerIDI/OYRetrieved from Begin Doc

EV01cSuppressErrorMessagesINBlank  Do not suppress errors '1'  Suppress errors

ERRCcErrorCodeON'1'  Warning '2'  Error 

DTAIszErrorMessageIDON


5.2Related Tables 

Table Table Description




5.3Related Business Functions

Source NameFunction Name
B3101570CacheCoByProductCompletion
XT4111Z1Inventory Transactions


5.4   Processing


Function Outline

Terminate B3102080 cache
Terminate Co/By cache

Terminate WorkCache cache

Terminate XT4111Z1 cache (F4111ClearDetailStack)






^

Data Structure

D3102080D - Co_By Completions Clear Work File

Parameter NameData ItemData TypeReq/OptI/O/Both
mnJobNumber_JOBSJOBSMATH_NUMERICOPTNONE

The job number (work station ID) which executed the particular job.

szComputerID_CTIDCTIDcharOPTNONE

cSuppressErrorMessages_EV01EV01charOPTNONE

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

cErrorCode_ERRCERRCcharOPTNONE

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).

szErrorMessageID_DTAIDTAIcharOPTNONE

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.

Related Functions

B0000128 Retrieve Company Currency Code
B0000129 Retrieve Currency Decimals
B3100330 Verify and Get Work Order Master
B3100760 Update Work Order Status
B3100770 Work Order Completions MBF
B3101570 Cache Co/By Product Completion
B3102110 Cache Resource Percentage Index
B4000520 Get Item UoM Conversion Factor
B4100210 Check Item Branch
B4300570 Receipt Routing, Verify Receipt Routing Process
B4301260 F43092, Validate Negative Completion
B4301270 F43092, Perform Negative Completion
B9800100 Get Audit Information
B9800181 Environment List Business Functions
X0005 Get User Defined Codes
X3111 F3111 Process Master Data
X4101 Validate and Retrieve Item Master
X41LOT Assign Lot Number
X43091 Receipt Routing Initiator
XT4111Z1 Inventory Transactions

Related Tables

F3111 Work Order Parts List
F4101 Item Master
F4101T OBSOLETE - Item Master Tag File
F4102 Item Branch File
F4801 Work Order Master File
Co_ByCompletionsEditLine

Co_ByCompletionsEditLine

Co_By Completions MBF

Master Business Function

Object Name: B3102080

Parent DLL: CMFGBASE

Location: Client/Server

Language: C

Business Function Specification

Source NameB3102080DesignerPH5732462
Data Structure 
D3102080ProgrammerPH5732462
Function Name
Co_By Completions Master Business Function
System Code
31
Function Category

Function Use




Revisions Log 
DateModifications bySAR NumberDescription
04/08/99P.Houtkooper  2998732Created



1.Functional Description

1.1Purpose
The purpose of this function is to separate the work order completions logic from B3100790.   This business function will process all cache records 
created by B3101570 to the F3111.  


1.2Setup Notes and Prerequisites


This business function will use the following structure to store global variables.

DSB3102080INTERNAL


This business function will use the following three cache structures.


DSB3102080CACHE 

DSB3102080WORKCACHE 



DSB3102080CACHEKEY 

Data Item IndexNotes
mnJobNumberRetrieved from Begin Doc  Cache Key

szComputerIDRetrieved from Begin Doc  Cache Key

mnLineNumberCache Row Counter  Cache Key



DSB3102080WORKCACHEKEY 

Data Item IndexNotes
mnJobNumberRetrieved from Begin Doc  Cache Key

szComputerIDRetrieved from Begin Doc  Cache Key



2.Technical Specifications



3.1Parameters: D3102080B  Co_By Completions Edit Line

Data Item Data Structure DescriptionI/ORequiredNotes
JOBSmnJobNumberI/OYRetrieved from Begin Doc

CTIDszComputerIDI/OYRetrieved from Begin Doc

EV01cSuppressErrorMessagesINBlank  Do not suppress errors '1'  Suppress errors

ERRCcErrorCodeON'1'  Warning '2'  Error 

DTAIszErrorMessageIDON

MMEJjdExpirationDateINRequired for new Lot/Serial Numbers


3.2Related Tables 

Table Table Description
F31UI005Resource Percentage Index



3.3Related Business Functions

Source NameFunction Name
B3101570CacheCoByProductCompletion

X3111F3111ProcessMasterData

X4101GetItemMasterByShortItem

B4100210CheckItemBranch

X41LOTAssignLotNumber

B4000520GetItemUoMConversionFactor

B4301260ValidateNegativeCompletion

B4300570VerifyReceiptRoutingProcess

X0005GetUDC

XT4111Z1Inventory Transactions

B0000128RetrieveCompanyCurrencyCode

B0000129RetrieveCurrencyDecimals

B3102110CacheResourcePercentageIndex


3.4Processing


Functional Outline

Initialize B3102080 cache(Main)
Initialize Co/By cache(B3101570 cache) 

Initialize WorkCache cache(Common Information)

Initialize Internal cache(Common variables)


Retrieve Co/By Completion record


Determine if completion is unplanned  (Fetch F3111 Record)


While Co/By Completion records exist


Load Co/By cache values to B3102080 cache


Check Material Status for Advanced Warehouse ?

Load Item Master Information to B3102080 cache
Load Item/Branch Information to B3102080 cache



Retrieve Conversion Factors (unplanned vs. planned)

Initiate Receipt Routing or Validate Negative Completion

Calculate Parts List Quantities
Calculate Item Location Quantities


Load and call XT4111Z1 Edit Line
Load and Update B3102080 cache


Retrieve Co/By Completion record


Determine if completion is unplanned 

End While



Data Structure

D3102080B - Co_By Completions Edit Line

Parameter NameData ItemData TypeReq/OptI/O/Both
mnJobNumber_JOBSJOBSMATH_NUMERICOPTNONE

The job number (work station ID) which executed the particular job.

szComputerID_CTIDCTIDcharOPTNONE

cSuppressErrorMessages_EV01EV01charOPTNONE

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

cErrorCode_ERRCERRCcharOPTNONE

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).

szErrorMessageID_DTAIDTAIcharOPTNONE

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.

jdExpirationDate_MMEJMMEJJDEDATEOPTNONE

The date on which a lot of items expires. The system automatically enters this date if you have specified the shelf life days for the item on 
Item Master Information or Item Branch/Plant Information. The system calculates the expiration date by adding the number of shelf life days to 
the date that you receive the item. You can commit inventory based on the lot expiration date for items. You choose how the system commits 
inventory for an item on Item Master Information or Item Branch/Plant Information.

cCalledFromSuperBackflushEV01charOPTNONE

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

Related Functions

B0000128 Retrieve Company Currency Code
B0000129 Retrieve Currency Decimals
B3100330 Verify and Get Work Order Master
B3100760 Update Work Order Status
B3100770 Work Order Completions MBF
B3101570 Cache Co/By Product Completion
B3102110 Cache Resource Percentage Index
B4000520 Get Item UoM Conversion Factor
B4100210 Check Item Branch
B4300570 Receipt Routing, Verify Receipt Routing Process
B4301260 F43092, Validate Negative Completion
B4301270 F43092, Perform Negative Completion
B9800100 Get Audit Information
B9800181 Environment List Business Functions
X0005 Get User Defined Codes
X3111 F3111 Process Master Data
X4101 Validate and Retrieve Item Master
X41LOT Assign Lot Number
X43091 Receipt Routing Initiator
XT4111Z1 Inventory Transactions

Related Tables

F3111 Work Order Parts List
F4101 Item Master
F4101T OBSOLETE - Item Master Tag File
F4102 Item Branch File
F4801 Work Order Master File
Co_ByCompletionsEndDoc

Co_ByCompletionsEndDoc

Co_By Completions MBF

Master Business Function

Object Name: B3102080

Parent DLL: CMFGBASE

Location: Client/Server

Language: C

Business Function Specification

Source NameB3102080DesignerPH5732462

Data Structure D3102080ProgrammerPH5732462

Function NameCo_By Completions Master Business Function

System Code31

Function Category

Function Use




Revisions Log 

DateModifications bySAR NumberDescription

04/08/99P.Houtkooper  2998732Created



1.Functional Description


1.1Purpose
The purpose of this function is to separate the work order completions logic from B3100790.   This business function will process all cache records 

created by B3101570 to the F3111.  


1.2Setup Notes and Prerequisites

This business function will use the following structure to store global variables.


DSB3102080INTERNAL


This business function will use the following three cache structures.


DSB3102080CACHE 

DSB3102080WORKCACHE 



DSB3102080CACHEKEY 

Data Item IndexNotes

mnJobNumberRetrieved from Begin Doc - Cache Key

szComputerIDRetrieved from Begin Doc - Cache Key

mnLineNumberCache Row Counter - Cache Key



DSB3102080WORKCACHEKEY 

Data Item IndexNotes

mnJobNumberRetrieved from Begin Doc - Cache Key

szComputerIDRetrieved from Begin Doc - Cache Key


2.Technical Specifications



4.1Parameters: D3102080C - Co_By Completions End Doc

Data Item Data Structure DescriptionI/ORequiredNotes

JOBSmnJobNumberI/OYRetrieved from Begin Doc

CTIDszComputerIDI/OYRetrieved from Begin Doc

EV01cSuppressErrorMessagesINBlank - Do not suppress errors '1' - Suppress errors

ERRCcErrorCodeON'1' - Warning '2' - Error 

DTAIszErrorMessageIDON

CPNTmnLastByProductLineNoIN  

CPNTmnLastCoProductLineNoIN


4.2Related Tables 

Table Table Description



4.3Related Business Functions

Source NameFunction Name

B3101570CacheCoByProductCompletion

X3111F3111ProcessMasterData

B3100760UpdateWorkOrderStatus

XT4111Z1Inventory Transactions

B4301270PerformNegativeCompletion

X43091ReceiptRoutingInitiator


4.4   Processing

Functional Outline


Initialize B3102080 cache(Main)

Initialize Co/By cache(B3101570 cache) 

Initialize WorkCache cache(Common Information)


Retrieve B3102080 cache record

While B3102080 cache records exist


Write or Update Parts List records
Perform Receipt Routing or Perform Negative Completion
Serial number processing


Retrieve B3102080 cache record

End While


Update WO Status

Call XT4111Z1 End Doc


Free lpF4801Pointer 


TerminateAll B3102080 cache

TerminateAll Co/By cache

TerminateAll WorkCache cache


Data Structure

D3102080C - Co_By Completions End Doc

Parameter NameData ItemData TypeReq/OptI/O/Both
mnJobNumber_JOBSJOBSMATH_NUMERICOPTNONE

The job number (work station ID) which executed the particular job.

szComputerID_CTIDCTIDcharOPTNONE

cSuppressErrorMessages_EV01EV01charOPTNONE

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

cErrorCode_ERRCERRCcharOPTNONE

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).

szErrorMessageID_DTAIDTAIcharOPTNONE

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.

mnLastCoProductLineNo_CPNBCPNBMATH_NUMERICOPTNONE

A number that specifies how the system displays the sequence of components on a single-level bill of material. This number initially 
indicates the sequence in which a component was added to the bill of material. You can modify this number to change the sequence in which the 
components appear.

mnLastByProductLineNo_CPNBCPNBMATH_NUMERICOPTNONE

A number that specifies how the system displays the sequence of components on a single-level bill of material. This number initially 
indicates the sequence in which a component was added to the bill of material. You can modify this number to change the sequence in which the 
components appear.

Related Functions

B0000128 Retrieve Company Currency Code
B0000129 Retrieve Currency Decimals
B3100330 Verify and Get Work Order Master
B3100760 Update Work Order Status
B3100770 Work Order Completions MBF
B3101570 Cache Co/By Product Completion
B3102110 Cache Resource Percentage Index
B4000520 Get Item UoM Conversion Factor
B4100210 Check Item Branch
B4300570 Receipt Routing, Verify Receipt Routing Process
B4301260 F43092, Validate Negative Completion
B4301270 F43092, Perform Negative Completion
B9800100 Get Audit Information
B9800181 Environment List Business Functions
X0005 Get User Defined Codes
X3111 F3111 Process Master Data
X4101 Validate and Retrieve Item Master
X41LOT Assign Lot Number
X43091 Receipt Routing Initiator
XT4111Z1 Inventory Transactions

Related Tables

F3111 Work Order Parts List
F4101 Item Master
F4101T OBSOLETE - Item Master Tag File
F4102 Item Branch File
F4801 Work Order Master File
: absolute; left: 0.500000in">ON'1'  Warning '2'  Error 

DTAIszErrorMessageIDON


5.2Related Tables 

Table Table Description




5.3Related Business Functions

Source NameFunction Name
B3101570CacheCoByProductCompletion
XT4111Z1Inventory Transactions


5.4   Processing


Function Outline

Terminate B3102080 cache
Terminate Co/By cache

Terminate WorkCache cache

Terminate XT4111Z1 cache (F4111ClearDetailStack)






^

Data Structure

D3102080D - Co_By Completions Clear Work File

Parameter NameData ItemData TypeReq/OptI/O/Both
mnJobNumber_JOBSJOBSMATH_NUMERICOPTNONE

The job number (work station ID) which executed the particular job.

szComputerID_CTIDCTIDcharOPTNONE

cSuppressErrorMessages_EV01EV01charOPTNONE

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

cErrorCode_ERRCERRCcharOPTNONE

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).

szErrorMessageID_DTAIDTAIcharOPTNONE

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.

Related Functions

B0000128 Retrieve Company Currency Code
B0000129 Retrieve Currency Decimals
B3100330 Verify and Get Work Order Master
B3100760 Update Work Order Status
B3100770 Work Order Completions MBF
B3101570 Cache Co/By Product Completion
B3102110 Cache Resource Percentage Index
B4000520 Get Item UoM Conversion Factor
B4100210 Check Item Branch
B4300570 Receipt Routing, Verify Receipt Routing Process
B4301260 F43092, Validate Negative Completion
B4301270 F43092, Perform Negative Completion
B9800100 Get Audit Information
B9800181 Environment List Business Functions
X0005 Get User Defined Codes
X3111 F3111 Process Master Data
X4101 Validate and Retrieve Item Master
X41LOT Assign Lot Number
X43091 Receipt Routing Initiator
XT4111Z1 Inventory Transactions

Related Tables

F3111 Work Order Parts List
F4101 Item Master
F4101T OBSOLETE - Item Master Tag File
F4102 Item Branch File
F4801 Work Order Master File
Co_ByCompletionsEditLine

Co_ByCompletionsEditLine

Co_By Completions MBF

Master Business Function

Object Name: B3102080

Parent DLL: CMFGBASE

Location: Client/Server

Language: C

Business Function Specification