VerifyAndGetWOTimeTransactions

Verify And Get WO Time Transactions

Minor Business Rule

Object Name: B3100580

Parent DLL: CMFGBASE

Location: Client/Server

Language: C

1.Functional Description
The Functional Description section is to be cut from the Word document and pasted into the Notes
section of the Business Function.

1.1Purpose
This business function verifies that the WO Time Transactions (F31122) record exists and returns a
pointer to the WO Time Transactions Record. You can retrieve a record from F31122 using one of six
different indexes.

1.2Setup Notes and Prerequisites

• If a pointer to the record is returned, this pointer must be cleared in the application using the
BSFN FreePtrtoDataStructure.
• The user passes to the business function the number of the index they want to use and the number of
key fields within that index that will be used.

List of Indexes:
1. YST, AN8, DGL -(Index 1, Keys 3)
2. YST, USER, UPMJ, PBDT -(Index 2, Keys 4)
3. YST, DOCO, DGL, OPSQ, TYR-(Index 3, Keys 5)
4. PRTR, YST, TYR-(Index 4, Keys 3)
5. YST, SUMR, DOCO, DCTO, OPSQ, TYR-(Index 5, Keys 6)
6. UKID-(Index 6, Key 1)

• The returned error message will display automatically on the message line and the appropriate field
(if any) will be highlighted. This can be suppressed by turning on the "Suppress Error Message" flag.
• Turn on the "Return Pointer" flag to have the business function return a pointer to the record.
• Set the "Call Type" flag to a "1" to have the business function verify that the record exists. Set
it to "2" to have the business function verify that the record does not exist (ie. it returns an error
if a record is found).

1.3Special Logic
None.

2.Technical Specifications

2.4Processing

Initialize the DS F31122Pointer to NULL.
Fetch the Shop Floor Control WO Time Transactions Record corresponding to the index and keys entered
by the user.

If DS Call Type is equal to '1', return error messages.

Assign DS Error Message ID = '0002' (Record Invalid).
If DS Suppress Error Message is not equal to '1', SetGBRError where error message is '0002' ( Record
Invalid ).

If Fetch is successful, return pointer and messages.

If DS Call Type is equal to '2', return error messages.

Assign DS Error Message ID = '2463'. (Record Exists)
If DS Suppress Error Message is not equal to '1', SetGBRError where error message is '2463'
(Record Exists) and the first field in the index is highlighted.

If DS Call Type is not equal to '2', return the WO Time Transactions information.

If DS Call Type is not equal to '2' and DS Return Pointer is equal to '1', return pointer to the WO
Time Transactions Record.

Allocate memory for the WO Time Transactions Record.
If Memory Allocation is successful, Assign DS F31122 Pointer = Address of WO Time Transactions
Record.
If Memory Allocation is not successful, return error messages.

Assign DS Error Message ID = '4365' (No Memory).
If DS Suppress Error Message is not equal to '1', SetGBRError where error message is
'4365'.

List of Indexes:
1. YST, AN8, DGL -(Index 1, Keys 3)
2. YST, USER, UPMJ, PBDT -(Index 2, Keys 4)
3. YST, DOCO, DGL, OPSQ, TYR-(Index 3, Keys 5)
4. PRTR, YST, TYR-(Index 4, Keys 3)
5. YST, SUMR, DOCO, DCTO, OPSQ, TYR-(Index 5, Keys 6)
6. UKID-(Index 6, Key 1)

Returns:
If Call Type is equal to '1' and the fetch fails, return Error Message ID '0002' (Record Invalid).
If Call Type is equal to '2' and the fetch is successful, return Error Message ID '2463'.
If Return Pointer is equal to '1', the fetch is successful, and the memory allocation is successful,
return the pointer to the data structure.

^

Data Structure

D3100580 - Verify And Get WO Time Transactions

Parameter Name	Data Item	Data Type	Req/Opt	I/O/Both
cReturnPointerFlag	EV01	char	NONE	NONE
An option that specifies the type of processing for an event.
cCallType	EV01	char	NONE	NONE
An option that specifies the type of processing for an event.
cSuppressErrorMessages	EV01	char	NONE	NONE
An option that specifies the type of processing for an event.
szIndex	DTAI	char	NONE	NONE
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.
szKeys	DTAI	char	NONE	NONE
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.
szErrorMessageID	DTAI	char	NONE	NONE
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.
idF31122Pointer	GENLNG	ID	NONE	NONE
General purpose ID variable.
cProcessedCode	YST	char	NONE	NONE
A code used to indicate whether a payroll transaction has been processed through the payroll cycle. This value is held within various files within the payroll system. Valid values are: Blank Unprocessed. 1 Processed. P Processed and checks have been printed (F07350 Only). ************************************************************ The F07351 contains values as they relate to the printed payment. For the F07351, valid values are: Blank Not Printed. I Interim Printed. 1 Non-Interim Printed.
mnAddressNumber	AN8	MATH_NUMERIC	NONE	NONE
A number that identifies an entry in the Address Book system, such as employee, applicant, participant, customer, supplier, tenant, or location.
jdWorkOrderDate	DGL	JDEDATE	NONE	NONE
A date that identifies the financial period to which the transaction is to be posted. The company constants specify the date range for each financial period. You can have as many as 14 periods. Generally, period 14 is used for audit adjustments. The system validates this field for PBCO (posted before cutoff), PYEB (prior year ending balance), PACO (post after cutoff), and WACO (post way after cutoff) messages.
szUserID	USER	char	NONE	NONE
The code that identifies a user profile.
jdDateUpdated	UPMJ	JDEDATE	NONE	NONE
The date that specifies the last update to the file record.
jdDateTimeClockStart	PBDT	JDEDATE	NONE	NONE
Date associated with the time clock start time. The date associated with the ending clock time is the work date.
mnWorkOrderNumber	DOCO	MATH_NUMERIC	NONE	NONE
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.
mnOperationSequence	OPSQ	MATH_NUMERIC	NONE	NONE
A number used to indicate an order of succession. In routing instructions, a number that sequences the fabrication or assembly steps in the manufacture of an item. You can track costs and charge time by operation. In bills of material, a number that designates the routing step in the fabrication or assembly process that requires a specified component part. You define the operation sequence after you create the routing instructions for the item. The Shop Floor Management system uses this number in the backflush/preflush by operation process. In engineering change orders, a number that sequences the assembly steps for the engineering change. For repetitive manufacturing, a number that identifies the sequence in which an item is scheduled to be produced. Skip To fields allow you to enter an operation sequence that you want to begin the display of information. You can use decimals to add steps between existing steps. For example, use 12.5 to add a step between steps 12 and 13.
cTypeOfHours	TYR	char	NONE	NONE
A code that indicates the type of time entered. Valid values are: 1 Run Labor Hours 2 Setup Labor Hours 3 Machine Hours 4 Quantities Completed 5 Quantities Scrapped 9 Miscellaneous (such as piece rate bonus)
mnTransactionNumber	PRTR	MATH_NUMERIC	NONE	NONE
A unique number that the system assigns to each timecard. You can use this field in the Time Entry By Job program to retrieve a specific timecard for display. This field is also used to tie a timecard to each Actual Burden audit record created for the timecard during the Actual Burden Journaling process.
cSummaryRecord	SUMR	char	NONE	NONE
Identifies records containing summarized detail information.
szOrderType	DCTO	char	NONE	NONE
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
mnUniqueKeyID	UKID	MATH_NUMERIC	NONE	NONE
This field is a unique number used to identify a record in a file.

Related Functions

B4000460 Free Ptr To Data Structure

Related Tables

F31122 Work Order Time Transactions