X4801EQEditLineModule

X4801 Equipment Module

Master Business Function

Object Name: B4800220

Parent DLL: CALLBSFN

Location: Client/Server

Language: C

Functional Description

Purpose

To perform all editing required for Equipment in regards to the X4801. Do not call these functions directly.  The information contained in this 

document is for debugging and X4801 setup purposes only.


Setup Notes and Prerequisites

These functions are called ONLY from X4801. 

• X4801 Edit Line calls X4801 EQ Edit Line Module to perform all equipment editing
• X4801 End Doc calls X4801 EQ End Doc Module to perform related table updates
• X4801 Clear Work File calls X4801 EQ Terminate Module to close all tables opened and cache created 
by B4800220


Special Logic




Technical Specification

Related Tables 

Table Table Description

F0006Cost Center Master

F4311Purchase Order Header




Related Business Functions

Source NameFunction Name

B1200070F1207 Get Rows

B1200080F1207 Update Rows

B1300180F1391 Map Category Code

B1300001F1300 Access 1300

B3100330F4801 Get Work Order Master (Parent WO processing)

B3100450F3112 Verify Routing

B3100470F3111 Verify Parts List

B4000880Verify and Get Address Book for OP

B4800090F4826 Retrieve Action Status Row

B4800120F48001 Get Row from Default Coding Table

X1202F1201 Verify Asset Number

X4801F4801 Work Order MBF - used for data structure definition only

X4101F4101 Item Master MBF

X4626F4626 Work Order Activity Rules

ICOLBUIs Column in Business Unit Table


2.4Processing 


X4801 EQ Edit Line Module Outline

Retrieve the Cache Data Structure address

This structure contains the original F4801 values if in update mode and 1st time processing
Else, it contains the F4801 Cache values retrieved in X4801

Retrieve the Input Data Structure address
This structure contains the X4801 Edit Line lpDS values

End If

If the processing options have not already been retrieved and the version is not blank

Retrieve P48011 processing options using user input version

End If

If the input Process Edits does not = NO EDITS

Validate Subsidiary Repair Code against the F0901

If the Parent Order Number is not blank

Validate Parent Order Number
Set default values if any fields are blank: 
Originator, Supervisor, Inspector, Manager, Assigned To, Customer. Distribution Rate, Category Codes 1 - 5, Reference, 
Pay Type, Business Unit, Priority, WO Type, Status, Status Comment, Start Date, and Planned Completion Date

End If

Set to Processing Option values if any of the following fields are blank:

Category Codes 1- 10, Customer, Order Type, Priority, and WO Type

If in Add Mode

Set Approval Type to Processing Option Value

End If

End Processing Option Defaults

Assign default values to Supervisor and Manger if still blank

If the Action Code = Update Mode

Assign an error if the Order Type or the WO Type has changed and Inventory has been issued

Validate/Assign the Status 

Validate Subledger if Subledger and Status have changed

End If

Validate Equipment Number

Assign a default value and validate the Cost Center

Validate Start, Requested, Completion, Planned Completion, Order Dates

Start, Requested, Completion and Planned Completion Dates cannot be less than Order Date

If Requested Date is < Start Date or Requested Date is blank

Requested Date = Start Date

End If

End Validate Dates

Edit Estimated Hours and Amount

Validate Inventory Item Number

Issue Error if Customer is blank and PO Require Customer = '1'

Issue Error if WO Description is blank

If the Order Date is blank or the Action Code = Add Mode

Order Date = System Date

End if

Validate that the Branch Plant is not blank

Set Qty Ordered = 1

Set Freeze Code = 'Y'

If Editing successful and X4801 Input Process Tool Editing = 1
Perform Data Dictionary Editing on the following fields:

Branch Plant, Business unit, Customer Number, Assigned To Address Number,

Order Type, WO Status, WO Type, and Priority
End If 

If X4801 Input Error Code does not = Edit Warning

Perform Warning Editing 

Validates the following:

If Action Code = Update Mode

Issue warning if Order Type or WO Type has changed

End If

Assign a warning 

If the Equipment is under warranty
If the Business Unit does not = Associated Equipment MCU

If an open Purchase Order exists

If the PO Calculate Date = '1' Warnings

Validate that the Completion Date is not less than Start Date

Validate that the Start Date is not < the Order Date

Validate that the Requested Date is not < the Order Date

Validate that the Planned Completion Date is not < the Order Date

Validate that the Completion Date is not < the Order Date

End If

End Perform Warning Editing

End If

End If

If no Edit Errors or Status Errors 

Load Input to Cache Record

End If

Set X4801 Input Error Code = Work Error Code



Data Structure

D4800220 - X4801 Equipment Editing Module DS

Parameter NameData ItemData TypeReq/OptI/O/Both
idCacheStructurePointerGENLNGIDNONENONE

General purpose ID variable.

idF4801PointerGENLNGIDNONENONE

Currently, not used in Edit Line.  If updating a F4801 record on the 1st call to X4801, the original values to all fields are written to the Cache structure. 
^

idInputPointerGENLNGIDNONENONE

General purpose ID variable.

cErrorCodeERRCcharNONENONE

'0' = No Errors
'1`'= Warnings

'2' = Error

^

szErrorMessageIDDTAIcharNONENONE

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.

cProcessEditsEV01charNONENONE

'0'  No Edits
'1'  Full Edits

'2'  Partial Edits

^

cActionCodeACTNcharNONENONE

'A'  Add the record to the F4801
'U'- Update the record in the F4801

'D'  Delete the record in the F4801

^

mnJobNumberJOBSMATH_NUMERICNONENONE

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

szVersionVERScharNONENONE

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.

cSuppressErrorMessagesEV02charNONENONE

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

cInteractiveBatchFlagEV03charNONENONE

'I' = Interactive
'B' = Batch

Set to 'I' to check for substitutes

^

cProcessModuleFlagEV04charNONENONE

Flag set in X4801 to determine if Normal or Sales editing required.
^

szTypeTransactionTYTNcharNONENONE

Processing Option returned to X4801 to determine if F4801 record is to be written to F4801Z1 file.
(FUTURE) not used in equipment

^

mnOrderNumberDOCOMATH_NUMERICNONENONE

Used for P48011 Error Mapping purposes only. 
^

szOrderTypeDCTOcharNONENONE

A user defined code (00/DT) that identifies the type of document. This code also indicates the origin of the transaction. J.D. Edwards has 
reserved document type codes for vouchers, invoices, receipts, and time sheets, which create automatic offset entries during the post 
program. (These entries are not self-balancing when you originally enter them.) The following document types are defined by J.D. Edwards and 
should not be changed: P Accounts Payable documents   R Accounts Receivable documents   T Payroll documents   I Inventory documents  
O Purchase Order Processing documents   J General Accounting/Joint Interest Billing documents   S Sales Order Processing documents

szParentOrderNumberPARScharNONENONE

A number that identifies the parent work order. You can use this number to do the following:     o Enter default values for new work orders, 
such as Type, Priority, Status, and Manager     o Group work orders for project setup and reporting  

szWODescriptionDL01charNONENONE

A user defined name or remark.

szStatusCommentSTCMcharNONENONE

A brief description to explain the status of the work order.

cWOTypeTYPScharNONENONE

A user defined code (00/TY) that indicates the classification of a work order or engineering change order. You can use work order type as a 
selection criterion for work order approvals.

szWOStatusSRSTcharNONENONE

A user defined code (00/SS) that describes the status of a work order, rate schedule, or engineering change order. Any status change from 
90 through 99  triggers the system to automatically update the completion date.

cWOPriorityPRTScharNONENONE

A user defined code (00/PR) that indicates the relative priority of a work order or engineering change order in relation to other orders. A 
processing option for some forms lets you enter a default value for this field. The value then displays automatically in the appropriate fields on 
any work order you create on those forms and on the Project Setup form. You can either accept or override the default value.

mnCustomerNumberAN8MATH_NUMERICNONENONE

A number that identifies an entry in the Address Book system, such as employee, applicant, participant, customer, supplier, tenant, or 
location.

szBranchPlantMMCUcharNONENONE

A code that represents a high-level business unit. Use this code to refer to a branch or plant that might have departments or jobs, which 
represent lower-level business units, subordinate to it. For example:     o Branch/Plant (MMCU)     o Dept A (MCU)     o Dept B (MCU)     o Job 123 
(MCU) Business unit security is based on the higher-level business unit.

szBusinessUnitMCUcharNONENONE

An alphanumeric code that identifies a separate entity within a business for which you want to track costs. For example, a business unit 
might be a warehouse location, job, project, work center, branch, or plant. You can assign a business unit to a document, entity, or person for 
purposes of responsibility reporting. For example, the system provides reports of open accounts payable and accounts receivable by 
business unit to track equipment by responsible department. Business unit security might prevent you from viewing information about business units 
for which you have no authority.

szSubsidiaryRepairCodeSUBcharNONENONE

A subset of an object account. Subsidiary accounts include detailed records of the accounting activity for an object account.

jdOrderDateTRDJJDEDATENONENONE

The date that an order was entered into the system. This date determines which effective level the system uses for inventory pricing.

jdStartDateSTRTJDEDATENONENONE

The start date for the order. You can enter this date manually, or have the system calculate it using a backscheduling routine. The routine 
starts with the required date and offsets the total leadtime to calculate the appropriate start date.

jdPlannedCompletionDateDPLJDEDATENONENONE

The date that the work order or engineering change order is planned to be completed.

jdCompletionDateSTRXJDEDATENONENONE

The date that the work order or engineering change order is completed or canceled.

szItemNumberUnknownFormatUITMcharNONENONE

A number that the system assigns to an item. It can be in short, long, or third item number format.

szAssetNumberInputASIIcharNONENONE

An identification code that represents an asset. You enter the identification code in one of the following formats: 1 Asset number (a 
computer-assigned, 8-digit, numeric control number)   2 Unit number (a 12-character alphanumeric field)   3 Serial number (a 25-character alphanumeric 
field) Every asset has an asset number. You can use unit number and serial number to further identify assets. If this is a data entry field, the first 
character you enter indicates whether you are entering the primary (default) format that is defined for your system, or one of the other two 
formats. A special character (such as / or *) in the first position of this field indicates which asset number format you are using. You assign special 
characters to asset number formats on the fixed assets system constants form.

mnAssignedToAddressNumberANPMATH_NUMERICNONENONE

The address book number of the person assigned to do the work.

cSubledgerInactiveCodeSBLIcharNONENONE

An option that indicates whether a specific subledger is inactive. Examples of inactive subledgers are jobs that are closed, employees 
who have been terminated, or assets that have been disposed. Turn on this option to indicate that a subledger is inactive. If a subledger 
becomes active again, turn off this option. If you want to use subledger information in the tables for reports, but you want to prevent transactions 
from posting to the record in the Account Balances table (F0902), turn on this option. Valid values are: Off Subledger active On Subledger inactive

jdRequestedDateDRQJJDEDATENONENONE

The date that an item is scheduled to arrive or that an action is scheduled for completion.

mnNextAddressNumberNAN8MATH_NUMERICOPTNONE

An eight-position number used to identify each entry in the Address Book,e.g., employees, customers, suppliers, special mailing 
addresses, etc.

szCompanyCOcharOPTNONE

A code that identifies a specific organization, fund, or other reporting entity. The company code must already exist in the Company 
Constants table (F0010) and must identify a reporting entity that has a complete balance sheet. At this level, you can have intercompany 
transactions. Note: You can use company 00000 for default values such as dates and automatic accounting instructions. You cannot use company 00000 
for transaction entries.

szProgramIdPIDcharOPTNONE

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.

Related Functions

B1200070 F1207 Get Rows
B1200080 F1207 Update Row
B1300001 F1300 Access
B1300180 F1391 Map Category Codes
B3100330 Verify and Get Work Order Master
B3100360 F3112 Update Hours And Dates
B3100450 Verify And Get Routing Instructions
B3100470 Verify And Get Parts List
B3100870 Get Routing Instructions For An Order Number
B4000880 Verify And Get Address Book for OP
B4800090 F4826 Get Row
B4800120 F48001 Get Row
ISCOLBU Is Business Unit in Business Unit Table
X1202 F1201 Validate Asset Number
X4101 Validate and Retrieve Item Master
X4801 X4801 Work Order Entry Master Business Function
X4826 F4826 Update Based on WO Activity Rules

Related Tables

F0006 Business Unit Master
F3111 Work Order Parts List
F4311 Purchase Order Detail File
X4801EQEndDocModule

X4801EQEndDocModule

X4801 Equipment Module

Master Business Function

Object Name: B4800220

Parent DLL: CALLBSFN

Location: Client/Server

Language: C

Functional Description

Purpose

To perform all editing required for Equipment in regards to the X4801. Do not call these functions directly.  The information contained in this 

document is for debugging and X4801 setup purposes only.


Setup Notes and Prerequisites

These functions are called ONLY from X4801. 

• X4801 Edit Line calls X4801 EQ Edit Line Module to perform all equipment editing
• X4801 End Doc calls X4801 EQ End Doc Module to perform related table updates
• X4801 Clear Work File calls X4801 EQ Terminate Module to close all tables opened and cache created 
by B4800220


Special Logic




Technical Specification

X4801 EQ End Doc Module Outline

If the input Process Edits does not = NO EDITS

Retrieve the Cache Data Structure address
Retrieve the X4801 Input End Doc Data Structure address

Retrieve the F4801 Data Structure address

If the input Action Code = Delete or Cancel Mode
Perform Related Table Deletes

If the Inclusion Version from the F1300 exists and a routing exists 
Launch EQ CRP UBE (R3382)

End If
Else

Perform End Doc Updates
If Cache Action Code = Add Mode

Zero Actual Amount

Next Status = blank

Call Work Order Activity Rules

Update Maintenance Schedule F1207 Assigned to Address

Else (Update Mode)

If the Status has changed 

Call Work Order Activity Rules

Else

If the Order Type and the Requested Date have changed

If the Inclusion Version from the F1300 exists and a routing exists for the Work Order
Launch EQ CRP UBE (R3382)

End If

End If 

If the Assigned to Address Number has changed

Update Maintenance Schedule F1207 Assigned to Address
End If

End If
If Requested Date has changed

If PO Routing Flag is set to '1'

Update the F3112 Requested Date
End If

If PO Parts List Flag is set to '1'

Update the F3111 Requested Date

End If

End If

If the Start Date has changed

If PO Routing Flag is set to '1'
Update the F3112 Start Date
End If

End If

End If - Update Mode
End Perform Updates

Load F4801 Cache values to F4801 data structure

End If




Data Structure

D4800220A - X4801 Equipment End Processing DS

Parameter NameData ItemData TypeReq/OptI/O/Both
idCacheStructurePointerGENLNGIDNONENONE

General purpose ID variable.

idF4801PointerGENLNGIDNONENONE

General purpose ID variable.

idInputPointerGENLNGIDNONENONE

General purpose ID variable.

cProcessEditsEV01charNONENONE

'0'  No Edits
'1'  Full Edits

'2'  Partial Edits

^

cActionCodeACTNcharNONENONE

A code that specifies the action that is performed. Valid values are: A Add C Change

cProcessModuleFlagEV02charNONENONE

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

mnJobNumberJOBSMATH_NUMERICNONENONE

Same Job Number retrieved in X4801 Begin Doc.  Required input since used to create unique name for this function's Work Cache.
^

szErrorMessageIDDTAIcharNONENONE

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.

szProgramIDPIDcharNONENONE

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.

szNameRemarkRMKcharOPTNONE

A generic field that you use for a remark, description, name, or address.

cCalledByPMAssoFlagEV01charOPTINPUT

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

Related Functions

B1200070 F1207 Get Rows
B1200080 F1207 Update Row
B1300001 F1300 Access
B1300180 F1391 Map Category Codes
B3100330 Verify and Get Work Order Master
B3100360 F3112 Update Hours And Dates
B3100450 Verify And Get Routing Instructions
B3100470 Verify And Get Parts List
B3100870 Get Routing Instructions For An Order Number
B4000880 Verify And Get Address Book for OP
B4800090 F4826 Get Row
B4800120 F48001 Get Row
ISCOLBU Is Business Unit in Business Unit Table
X1202 F1201 Validate Asset Number
X4101 Validate and Retrieve Item Master
X4801 X4801 Work Order Entry Master Business Function
X4826 F4826 Update Based on WO Activity Rules

Related Tables

F0006 Business Unit Master
F3111 Work Order Parts List
F4311 Purchase Order Detail File
X4801EQTerminateModule

X4801EQTerminateModule

X4801 Equipment Module

Master Business Function

Object Name: B4800220

Parent DLL: CALLBSFN

Location: Client/Server

Language: C

Functional Description

Purpose

To perform all editing required for Equipment in regards to the X4801. Do not call these functions directly.  The information contained in this document is 
for debugging and X4801 setup purposes only.


Setup Notes and Prerequisites

These functions are called ONLY from X4801. 

• X4801 Edit Line calls X4801 EQ Edit Line Module to perform all equipment editing
• X4801 End Doc calls X4801 EQ End Doc Module to perform related table updates
• X4801 Clear Work File calls X4801 EQ Terminate Module to close all tables opened and cache created 
by B4800220


Special Logic




Technical Specification

If the input Job Number is not blank
Destroy B4800220 Work Cache
End If




^

Data Structure

D4800220A - X4801 Equipment End Processing DS

Parameter NameData ItemData TypeReq/OptI/O/Both
idCacheStructurePointerGENLNGIDNONENONE

General purpose ID variable.

idF4801PointerGENLNGIDNONENONE

General purpose ID variable.

idInputPointerGENLNGIDNONENONE

General purpose ID variable.

cProcessEditsEV01charNONENONE

'0'  No Edits
'1'  Full Edits

'2'  Partial Edits

^

cActionCodeACTNcharNONENONE

A code that specifies the action that is performed. Valid values are: A Add C Change

cProcessModuleFlagEV02charNONENONE

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

mnJobNumberJOBSMATH_NUMERICNONENONE

Same Job Number retrieved in X4801 Begin Doc.  Required input since used to create unique name for this function's Work Cache.
^

szErrorMessageIDDTAIcharNONENONE

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.

szProgramIDPIDcharNONENONE

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.

szNameRemarkRMKcharOPTNONE

A generic field that you use for a remark, description, name, or address.

cCalledByPMAssoFlagEV01charOPTINPUT

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

Related Functions

B1200070 F1207 Get Rows
B1200080 F1207 Update Row
B1300001 F1300 Access
B1300180 F1391 Map Category Codes
B3100330 Verify and Get Work Order Master
B3100360 F3112 Update Hours And Dates
B3100450 Verify And Get Routing Instructions
B3100470 Verify And Get Parts List
B3100870 Get Routing Instructions For An Order Number
B4000880 Verify And Get Address Book for OP
B4800090 F4826 Get Row
B4800120 F48001 Get Row
ISCOLBU Is Business Unit in Business Unit Table
X1202 F1201 Validate Asset Number
X4101 Validate and Retrieve Item Master
X4801 X4801 Work Order Entry Master Business Function
X4826 F4826 Update Based on WO Activity Rules

Related Tables

F0006 Business Unit Master
F3111 Work Order Parts List
F4311 Purchase Order Detail File