RetrieveConfigWOCategoryCode

Retrieve Config WO Category Codes

Major Business Rule

Object Name: N3200880

Parent DLL: CMFG

Location: Client/Server

Language: NER

1.Functional Description

1.1Purpose
This function will setup the work order category codes based on values retrieved from the Segment Values Cache.

1.3Special Logic
There is no special logic within this function.

2.Technical Specifications

2.1Parameters:
Data Item Data Structure DescriptionI/ORequiredNotes LNIDmnLineNumberIY*Only in Batch Mode KCOOszCompanyKeyOrderNo)IY*Only in Batch
Mode DCTOszOrderTypeIY*Only in Batch Mode DOCOmnDocumentOrderInvoiceEIY*Only in Batch Mode SFXOszOrderSuffixIY*Only in Batch
Mode SYszProductCodeIY LNIXmnLineNumberXREFIYWork File Line Number JOBSmnJobnumberAIYCache Job Number WR01Category Code
01ON WR02Category Code 02ON WR03Category Code 03ON WR04Category Code 04ON WR05Category Code 05ON WR06Category Code
06ON WR07Category Code 07ON WR08Category Code 08ON WR09Category Code 09ON WR10Category Code 10ON EV01cSuppressErrorMessageIN1=Suppress runtime
error. DTAIszErrorMessageIDON

2.2Related Tables
Table Table Description F3291Configured Item Segments
2.3Related Business Functions
Source NameFunction Name B3200350Cache, Process Segment Values B9800420Get Data Dictionary Definition X0005Get
UDC B3201470CacheProcessConfigurationID B3201410GetMasterConfigurationIDNo

2.4Processing

If LNIX is > Zero
   Call B3201470 to get CFGID and CFGCID
Else
   If LNID > Zero
      Call B3201410 to get CFGID and CFGCID
   Else
      F3201 Fetch Single to get CFGID and CFGCID
   End If
End If

1.Initialize the category code output field in the data structure to spaces.

2.Read the first cache record (mode '1') by calling Cache, Process Segment Values (B3200350) with CFGID and CFGCID.

3.While cache records exist:

a)Read next cache record (mode '6') by calling Cache, Process Segment Values (B3200350).
b)Retrieve the Update Category Code (UPCC) from Configured Item Segments table (F3291) using key values retrieve from the segment values
cache (Item, Branch/Plant, Segment Number).
c)Retrieve the system code and record type values for the category code (UPCC) by calling Get Data Dictionary Definition (B9800420).
d)Validate the segment value (ATIV) using the retrieved system code and record type to call Get UDC (X0005).
e)If the segment value is a valid UDC value, move the segment value (ATIV) from the retrieved cache record to the appropriate category code
field, i.e. if the category code is WR01, move the value to the WR01 parameter in the data structure, if WR02, populate the WR02 data structure field,
etc.
f)If the segment value is not a valid UDC value, move spaces to the appropriate category code field, i.e. if the category code is WR01, move the
spaces to the WR01 parameter in the data structure, etc.

Data Structure

D3200880 - Retrieve Config WO Category Codes

Parameter Name Data Item Data Type Req/Opt I/O/Both

szProductCode SY char REQ NONE

A user defined code (98/SY) that identifies a system. Valid values include: 01 Address Book 03B Accounts Receivable 04 Accounts
Payable 09 General Accounting 11 Multicurrency

szCompanyKeyOrderNo KCOO char OPT NONE

A number that, along with order number and order type, uniquely identifies an order document (such as a purchase order, a contract, a
sales order, and so on). If you use the Next Numbers by Company/Fiscal Year facility, the Automatic Next Numbers program (X0010) uses the
order company to retrieve the correct next number for that company. If two or more order documents have the same order number and order
type, the order company lets you locate the desired document. If you use the regular Next Numbers facility, the order company is not used to
assign a next number. In this case, you probably would not use the order company to locate the document.

mnDocumentOrderInvoiceE DOCO MATH_NUMERIC OPT 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.

szOrderType DCTO char OPT 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

szOrderSuffix SFXO char OPT NONE

In the A/R and A/P systems, a code that corresponds to the pay item. In the Sales Order and Procurement systems, this code identifies
multiple transactions for an original order. For purchase orders, the code is always 000. For sales orders with multiple partial receipts against an
order, the first receiver used to record receipt has a suffix of 000, the next has a suffix of 001, the next 002, and so on.

mnLineNumber LNID MATH_NUMERIC OPT NONE

A number that identifies multiple occurrences, such as line numbers on a purchase order or other document. Generally, the system assigns
this number,but in some cases you can override it.

mnJobnumberA JOBS MATH_NUMERIC REQ NONE

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

szCategoriesWorkOrder001 WR01 char OPT NONE

A user defined code (00/W1) that indicates the current stage or phase of development for a work order. You can assign a work order to only
one phase code at a time. Note: Certain forms contain a processing option that allows you to enter a default value for this field. If you enter a
default value on a form for which you have set this processing option, the system displays the value in the appropriate fields on any work
orders that you create. The system also displays the value on the Project Setup form. You can either accept or override the default value.

szCategoriesWorkOrder002 WR02 char OPT NONE

A user defined code (00/W2) that indicates the type or category of a work order. Note: A processing option for some forms lets you enter a
default value for this field. The system enters the default value automatically in the appropriate fields on any work orders that you create on
those forms and on the Project Setup form. You can either accept or override the default value.

szCategoriesWorkOrder003 WR03 char OPT NONE

A user defined code (00/W3) that indicates the type or category of the work order. Note: A processing option for some forms allows you to
enter a default value for this field. The system enters the default value automatically in the appropriate fields on any work orders that you
create on those forms and on the Project Setup form. You can either accept or override the default value.

szCategoriesWorkOrder004 WR04 char OPT NONE

A user defined code (00/W4) that indicates the type or category of the work order.

szCategoriesWorkOrder005 WR05 char OPT NONE

A user defined code (00/W5) that indicates the type or category of the work order.

szCategoriesWorkOrder006 WR06 char OPT NONE

A user defined code (00/W6) that indicates the status of the work order.

szCategoriesWorkOrder007 WR07 char OPT NONE

A user defined code (00/W7) that indicates the service type for the work order.

szCategoriesWorkOrder008 WR08 char OPT NONE

A user defined code (00/W8) that indicates the type or category of the work order.

szCategoriesWorkOrder009 WR09 char OPT NONE

A user defined code (00/W9) that indicates the type or category of the work order.

szCategoriesWorkOrder010 WR10 char OPT NONE

A user defined code (00/W0) that indicates the type or category of the work order.

cSuppressErrorMessage SUPPS char OPT NONE

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.

szErrorMessageID DTAI char OPT 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.

mnLineNumberXREF LNIX MATH_NUMERIC REQ NONE

Related Functions

None

Related Tables

None

Parameter Name	Data Item	Data Type	Req/Opt	I/O/Both
szProductCode	SY	char	REQ	NONE
A user defined code (98/SY) that identifies a system. Valid values include: 01 Address Book 03B Accounts Receivable 04 Accounts Payable 09 General Accounting 11 Multicurrency
szCompanyKeyOrderNo	KCOO	char	OPT	NONE
A number that, along with order number and order type, uniquely identifies an order document (such as a purchase order, a contract, a sales order, and so on). If you use the Next Numbers by Company/Fiscal Year facility, the Automatic Next Numbers program (X0010) uses the order company to retrieve the correct next number for that company. If two or more order documents have the same order number and order type, the order company lets you locate the desired document. If you use the regular Next Numbers facility, the order company is not used to assign a next number. In this case, you probably would not use the order company to locate the document.
mnDocumentOrderInvoiceE	DOCO	MATH_NUMERIC	OPT	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.
szOrderType	DCTO	char	OPT	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
szOrderSuffix	SFXO	char	OPT	NONE
In the A/R and A/P systems, a code that corresponds to the pay item. In the Sales Order and Procurement systems, this code identifies multiple transactions for an original order. For purchase orders, the code is always 000. For sales orders with multiple partial receipts against an order, the first receiver used to record receipt has a suffix of 000, the next has a suffix of 001, the next 002, and so on.
mnLineNumber	LNID	MATH_NUMERIC	OPT	NONE
A number that identifies multiple occurrences, such as line numbers on a purchase order or other document. Generally, the system assigns this number,but in some cases you can override it.
mnJobnumberA	JOBS	MATH_NUMERIC	REQ	NONE
The job number (work station ID) which executed the particular job.
szCategoriesWorkOrder001	WR01	char	OPT	NONE
A user defined code (00/W1) that indicates the current stage or phase of development for a work order. You can assign a work order to only one phase code at a time. Note: Certain forms contain a processing option that allows you to enter a default value for this field. If you enter a default value on a form for which you have set this processing option, the system displays the value in the appropriate fields on any work orders that you create. The system also displays the value on the Project Setup form. You can either accept or override the default value.
szCategoriesWorkOrder002	WR02	char	OPT	NONE
A user defined code (00/W2) that indicates the type or category of a work order. Note: A processing option for some forms lets you enter a default value for this field. The system enters the default value automatically in the appropriate fields on any work orders that you create on those forms and on the Project Setup form. You can either accept or override the default value.
szCategoriesWorkOrder003	WR03	char	OPT	NONE
A user defined code (00/W3) that indicates the type or category of the work order. Note: A processing option for some forms allows you to enter a default value for this field. The system enters the default value automatically in the appropriate fields on any work orders that you create on those forms and on the Project Setup form. You can either accept or override the default value.
szCategoriesWorkOrder004	WR04	char	OPT	NONE
A user defined code (00/W4) that indicates the type or category of the work order.
szCategoriesWorkOrder005	WR05	char	OPT	NONE
A user defined code (00/W5) that indicates the type or category of the work order.
szCategoriesWorkOrder006	WR06	char	OPT	NONE
A user defined code (00/W6) that indicates the status of the work order.
szCategoriesWorkOrder007	WR07	char	OPT	NONE
A user defined code (00/W7) that indicates the service type for the work order.
szCategoriesWorkOrder008	WR08	char	OPT	NONE
A user defined code (00/W8) that indicates the type or category of the work order.
szCategoriesWorkOrder009	WR09	char	OPT	NONE
A user defined code (00/W9) that indicates the type or category of the work order.
szCategoriesWorkOrder010	WR10	char	OPT	NONE
A user defined code (00/W0) that indicates the type or category of the work order.
cSuppressErrorMessage	SUPPS	char	OPT	NONE
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.
szErrorMessageID	DTAI	char	OPT	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.
mnLineNumberXREF	LNIX	MATH_NUMERIC	REQ	NONE