CreateOBLabelAdditionalData

Create XAPI Outbound Label Message

Minor Business Rule

Object Name: N4601380

Parent DLL: CWARE

Location: Client/Server

Language: NER

Functional Description

Purpose
This function reads the cache created by F40R31 Addtional Label Data (B40R0710).  The cache data is
loaded to the XAPI data structure for outbound label additional data.

Additional label data is user defined data that can be outbound.  It is associated with outbound
label demand/SO detail or child carton detail.  Ten values are loaded to the data structure at a time.  If
more than ten values have been setup, multiple additional label data rows will exist.

Setup Notes and Prerequisites
Required parameters are:
• XAPI call ID.  The XAPI call ID should have been assigned in a previous call to XAPI Initialize
(B4601440).
• Cache job number
• Short item number
• Sold to
• Ship to
• Demand ID if using demand scheduling.

Special Logic
• If the XAPI API call fails, an error will be returned in the XAPI Error Message ID and the XAPI
message will not be sent.

Parameter Name	Data Item	Data Type	Req/Opt	I/O/Both
cSuppressErrorMessage	SUPPS	char	OPT	INPUT
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	OUTPUT
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.
szXAPIErrorMessageID	DTAI	char	OPT	OUTPUT
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.
cErrorCode	ERR	char	OPT	OUTPUT
The Data Field Error Code field is simply a generic data field to pass an error condition flag. This field is one of the fields that make up the external parameter data structure of the Data Dictionary Server.
idXAPICallID	GENLNG	ID	REQ	INPUT
General purpose ID variable.
mnCacheJobNumber	JOBS	MATH_NUMERIC	REQ	INPUT
The job number (work station ID) which executed the particular job.
mnShortItemNumber	ITM	MATH_NUMERIC	OPT	INPUT
An inventory item number. The system provides three separate item numbers plus an extensive cross-reference capability to other item numbers (see data item XRT) to accommodate substitute item numbers, replacements, bar codes, customer numbers, supplier numbers, and so forth. The item numbers are as follows: o Item Number (short) - An eight-digit, computer-assigned item number o 2nd Item Number - The 25-digit, free-form, user defined alphanumeric item number o 3rd Item Number - Another 25-digit, free-form, user defined alphanumeric item number
szBranchPlant	MCU	char	OPT	INPUT
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.
mnSoldTo	AN8	MATH_NUMERIC	OPT	INPUT
A number that identifies an entry in the Address Book system, such as employee, applicant, participant, customer, supplier, tenant, or location.
mnShipTo	SHAN	MATH_NUMERIC	OPT	INPUT
The address number of the location to which you want to ship this order. The address book provides default values for customer address, including street, city, state, zip code, and country.
mnDemandID	DEID	MATH_NUMERIC	OPT	INPUT
A system-generated number that identifies a demand record.

Data Structure

D4601380E - Create Outbound Label Additional Data

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

cSuppressErrorMessage SUPPS char OPT INPUT

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 OUTPUT

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.

szXAPIErrorMessageID DTAI char OPT OUTPUT

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.

cErrorCode ERR char OPT OUTPUT

The Data Field Error Code field is simply a generic data field to pass an error condition flag.  This field is one of the fields that make up the
external parameter data structure of the Data Dictionary Server.

idXAPICallID GENLNG ID REQ INPUT

General purpose ID variable.

mnCacheJobNumber JOBS MATH_NUMERIC REQ INPUT

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

mnShortItemNumber ITM MATH_NUMERIC OPT INPUT

An inventory item number. The system provides three separate item numbers plus an extensive cross-reference capability to other item
numbers (see data item XRT) to accommodate substitute item numbers, replacements, bar codes, customer numbers, supplier numbers, and
so forth. The item numbers are as follows:   o Item Number (short) - An eight-digit, computer-assigned item number     o 2nd Item Number - The
25-digit, free-form, user defined alphanumeric item number     o 3rd Item Number - Another 25-digit, free-form, user defined alphanumeric item
number

szBranchPlant MCU char OPT INPUT

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.

mnSoldTo AN8 MATH_NUMERIC OPT INPUT

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

mnShipTo SHAN MATH_NUMERIC OPT INPUT

The address number of the location to which you want to ship this order. The address book provides default values for customer address,
including street, city, state, zip code, and country.

mnDemandID DEID MATH_NUMERIC OPT INPUT

A system-generated number that identifies a demand record.

Related Functions

None

Related Tables

None

CreateOBLabelCartonDtlChild
CreateOBLabelCartonDtlChild

Create XAPI Outbound Label Message

Minor Business Rule

Object Name: N4601380

Parent DLL: CWARE

Location: Client/Server

Language: NER

Functional Description

Purpose
This function creates the XAPI outbound label child detail.  The function gets demand scheduling and
sales order information from cache and loads the XAPI data structure.

Setup Notes and Prerequisites
Required parameters:
• XAPI call ID.  The XAPI call ID should have been assigned in a previous call to XAPI Initialize
(B4601440).
• X-Reference Cache Job Number
• Outbound Label Cache Job Number
• Order Number
• Order Type
• Order Company
• Order Line
• Order Suffix

Other fields in the data structure are optional.  The optional fields can come from Carton Detail
(F4620).  If an optional field is loaded it will be loaded to the XAPI data structure.

Special Logic
• If the XAPI API call fails, an error will be returned in the XAPI Error Message ID and the XAPI
message will not be sent.

Data Structure

D4601380C - Create Outbound Label Child Carton Detail

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

cSuppressErrorMessage SUPPS char OPT INPUT

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 OUTPUT

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.

szXAPIErrorMessageID DTAI char OPT OUTPUT

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.

cErrorCode ERR char OPT OUTPUT

The Data Field Error Code field is simply a generic data field to pass an error condition flag.  This field is one of the fields that make up the
external parameter data structure of the Data Dictionary Server.

idXAPICallID GENLNG ID REQ INPUT

General purpose ID variable.

cChildItemInformation EV01 char OPT INPUT

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

mnOrderNumber DOCO MATH_NUMERIC REQ INPUT

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.

szOrderCompany KCOO char REQ INPUT

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.

szOrderType DCTO char REQ INPUT

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

mnOrderLine LNID MATH_NUMERIC REQ INPUT

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.

szOrderSuffix SFXO char REQ INPUT

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.

mnCartonID CRID MATH_NUMERIC OPT INPUT

A system-assigned number that identifies each carton. The system uses this number for the picking, packing, and shipment processes.

szCartonCode EQTY char OPT INPUT

A code (46/EQ) that identifies a storage container or a shipping carton. A storage container can be an open container where items are
stored on the container (for example, a pallet), or a closed container where items are stored in the container (for example, a box). You use the
Container and Carton Codes program (P46091) to define storage containers.

mnShortItemNumber ITM MATH_NUMERIC OPT INPUT

An inventory item number. The system provides three separate item numbers plus an extensive cross-reference capability to other item
numbers (see data item XRT) to accommodate substitute item numbers, replacements, bar codes, customer numbers, supplier numbers, and
so forth. The item numbers are as follows:   o Item Number (short) - An eight-digit, computer-assigned item number     o 2nd Item Number - The
25-digit, free-form, user defined alphanumeric item number     o 3rd Item Number - Another 25-digit, free-form, user defined alphanumeric item
number

szItemLot LOT char OPT INPUT

A lot is a quantity of items that you want to group together because they have similar characteristics.

mnItemQuantity TQTY MATH_NUMERIC OPT INPUT

The total quantity of an item to be reworked or scrapped as a result of an ECO disposition.

szItemUOM UOM char OPT INPUT

A user defined code (00/UM) that indicates the quantity in which to express an inventory item, for example, CS (case) or BX (box).

mnItemWeight WEIT MATH_NUMERIC OPT INPUT

The weight of goods currently in a location. The system calculates this amount from the weight from the item/unit of measure profile and the
weight of the container if the level 1 unit of measure for this location detail has a storage container.

mnGrossWeight GRWT MATH_NUMERIC OPT INPUT

Essentially a memo field at present, this value is intended to reflect the fact that many inventory items are always packaged in the same
way for shipment to the customer.  This packaging in turn effectively adds to the shipment weight for the item.  Since much of the mainstream
freight calculations depend upon a weight basis for their accuracy, the ability to store a gross weight which reflects the estimated additional
weight of standard packaging was deemed to be a worthwhile enhancement. (Future Use)

szWeightUOM UWUM char OPT INPUT

A user defined code (00/UM) that identifies the unit of measure that the system uses to indicate weight for this item. You can specify ounces,
grams, kilograms, and so on, as weight standards. The system uses this unit of measure for the item or overrides it for an individual item or
container.

szPackagingCode PKCD char OPT INPUT

A code corresponding to one of the accepted values in the EDI X12 definition for data element 103. It is a combination of a Packaging Form
(3 chars) and a Packaging Material (2 digits).

szPackSerialNumber PAK char OPT INPUT

The pack level Serialized Shipping Container Code. Must conform to the UCC structure for SSCC numbers.

szTareSerialNumber PLT char OPT INPUT

The tare level Serialized Shipping Container Code. Must conform to the UCC structure for SSCC numbers.

szCustomerCartonId CEQT char OPT INPUT

A code that the customer uses to represent a carton in the system.

mnCartonItemNumber CTNI MATH_NUMERIC OPT INPUT

A number that identifies a carton as an item. When you specify an item number, the system creates a relationship between the item number
and the carton code for tracking and pricing purposes.

mnXRefCacheJobNumber JOBS MATH_NUMERIC REQ INPUT

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

mnOutboundCacheJobNumber JOBS MATH_NUMERIC REQ INPUT

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

mnSoldTo AN8 MATH_NUMERIC OPT OUTPUT

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

mnShipTo SHAN MATH_NUMERIC OPT OUTPUT

The address number of the location to which you want to ship this order. The address book provides default values for customer address,
including street, city, state, zip code, and country.

mnDemandID DEID MATH_NUMERIC OPT OUTPUT

A system-generated number that identifies a demand record.

mnShipmentShipTo SHAN MATH_NUMERIC OPT INPUT

The address number of the location to which you want to ship this order. The address book provides default values for customer address,
including street, city, state, zip code, and country.

szContainerSerial CTSN char OPT INPUT

A unique number that identifies a specific outbound shipping container.  The container serial number is normally created from a
standardized format.

szSerialNumberType SNTY char OPT INPUT

A value that identifies the type of serial number being used to identify an outbound shipping carton.  The values are based on UDC
46R/ST.

cRFIDAttached RFIDF char OPT INPUT

An option that defines whether an RFID tag is attached to this carton.

Related Functions

None

Related Tables

None

CreateOBLabelCartonDtlParent
CreateOBLabelCartonDtlParent

Create XAPI Outbound Label Message

Minor Business Rule

Object Name: N4601380

Parent DLL: CWARE

Location: Client/Server

Language: NER

Functional Description

Purpose
This function creates the XAPI outbound label parent data.  The function loads the XAPI data
structure and calls the XAPI API.  Data in the parent carton consists of carton code, customer carton ID and
gross weight.  A parent carton is a carton that contains other cartons or items.

Setup Notes and Prerequisites
Required parameters are:
• XAPI call ID.  The XAPI call ID should have been assigned in a previous call to XAPI Initialize
(B4601440).
• Carton ID.  The carton ID uniquely identifies a carton in Carton Detail (F4620).
• Carton Code.
• Gross Weight of the carton.
• Weight UOM.

Special Logic
• The function sets carton level to 1.  Carton level is an informational flag that identifies the
carton as a parent in the XAPI outbound label message.

• If the parent carton is the highest level (for example a pallet) set Master Label equal to '1'.
This flag is informational in the XAPI outbound label message and can be used to determine if a master
label should be printed.

• To include an error message (that occured in the calling function) in the outbound message, pass in
the error message ID.  The function will retrieve the description and move it to the message.

• If the XAPI API call fails, an error will be returned in the XAPI Error Message ID and the XAPI
message will not be sent.

Data Structure

D4601380B - Create Outbound Label Parent Carton Detail

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

cSuppressErrorMessage SUPPS char OPT INPUT

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 INPUT

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.

szXAPIErrorMessageID DTAI char OPT OUTPUT

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.

cErrorCode ERR char OPT OUTPUT

The Data Field Error Code field is simply a generic data field to pass an error condition flag.  This field is one of the fields that make up the
external parameter data structure of the Data Dictionary Server.

idXAPICallID GENLNG ID REQ INPUT

General purpose ID variable.

mnCartonID CRID MATH_NUMERIC REQ INPUT

A system-assigned number that identifies each carton. The system uses this number for the picking, packing, and shipment processes.

szCartonCode EQTY char REQ INPUT

A code (46/EQ) that identifies a storage container or a shipping carton. A storage container can be an open container where items are
stored on the container (for example, a pallet), or a closed container where items are stored in the container (for example, a box). You use the
Container and Carton Codes program (P46091) to define storage containers.

mnGrossWeight GWEI MATH_NUMERIC REQ INPUT

The gross weight of one unit of the item in this unit of measure, or the weight of an empty storage container or shipping carton. These values
default to the location detail (F4602) and the system uses the values in maximum weight calculations for specified locations during putaway.

szWeightUOM UWUM char REQ INPUT

A user defined code (00/UM) that identifies the unit of measure that the system uses to indicate weight for this item. You can specify ounces,
grams, kilograms, and so on, as weight standards. The system uses this unit of measure for the item or overrides it for an individual item or
container.

szPackSerialNumber PAK char OPT INPUT

The pack level Serialized Shipping Container Code. Must conform to the UCC structure for SSCC numbers.

szTareSerialNumber PLT char OPT INPUT

The tare level Serialized Shipping Container Code. Must conform to the UCC structure for SSCC numbers.

szPackagingCode PKCD char OPT INPUT

A code corresponding to one of the accepted values in the EDI X12 definition for data element 103. It is a combination of a Packaging Form
(3 chars) and a Packaging Material (2 digits).

szCustomerCartonID CEQT char OPT INPUT

A code that the customer uses to represent a carton in the system.

mnCartonItemNumber CTNI MATH_NUMERIC OPT INPUT

A number that identifies a carton as an item. When you specify an item number, the system creates a relationship between the item number
and the carton code for tracking and pricing purposes.

cMasterLabel MSTRLBL char OPT INPUT

A value that identifies the highest carton in the structure that will be labeled, such as a pallet.

szContainerSerial CTSN char OPT INPUT

A unique number that identifies a specific outbound shipping container.  The container serial number is normally created from a
standardized format.

mnCartonLabelJobNum JOBS MATH_NUMERIC OPT INPUT

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

szBranchPlant MCU char OPT INPUT

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.

mnSoldTo AN8 MATH_NUMERIC OPT INPUT

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

mnShipTo SHAN MATH_NUMERIC OPT INPUT

The address number of the location to which you want to ship this order. The address book provides default values for customer address,
including street, city, state, zip code, and country.

szSerialNumberType SNTY char OPT INPUT

A value that identifies the type of serial number being used to identify an outbound shipping carton.  The values are based on UDC
46R/ST.

cRFIDAttached RFIDF char OPT INPUT

An option that defines whether an RFID tag is attached to this carton.

Related Functions

None

Related Tables

None

CreateOBLabelDmdSODetail
CreateOBLabelDmdSODetail

Create XAPI Outbound Label Message

Minor Business Rule

Object Name: N4601380

Parent DLL: CWARE

Location: Client/Server

Language: NER

Functional Description

Purpose
This function creates the XAPI outbound label demand/SO detail.  The function:
• Retrieves item standard pack rules (F460131).
• Gets label next number (F4625) when the Label Preference parameter is set to '3'.
• Detemines deliever to for the label.

The information is loaded to the XAPI data structure along with demand scheduling (F40R11) or sales
order (F4211) data passed to the function.  Data in the demand/SO detail consists of carton code,
standard pack, number of labels, customer carton ID and deliver to address information.

Setup Notes and Prerequisites
Required parameters:
• XAPI call ID.  The XAPI call ID should have been assigned in a previous call to XAPI Initialize
(B4601440).
• Shipment ship to.  The ship to on the shipment.
• Sales order ship to.  The ship to on the sales order or in demand scheduling.
• Sold to
• Short item number
• Item quantity
• Item UOM

Other fields in the data structure are optional.  The optional fields can come from sales orders or
demand scheduling.  If an optional field is sent it will be loaded to the XAPI data structure.

Special Logic
• If customer sets are used the ship to on the shipment can be either the ship to or deliver to from
the sales order.

• If customer sets are not used, the ship to on the sales order and shipment will be the same.

• If the XAPI API call fails, an error will be returned in the XAPI Error Message ID and the XAPI
message will not be sent.

Data Structure

D4601380D - Create Outbound Label Dmd/SO Detail

If shipment ship to is blank copy sales order ship to to shipment ship to

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

cSuppressErrorMessage SUPPS char OPT INPUT

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 OUTPUT

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.

szXAPIErrorMessageID DTAI char OPT OUTPUT

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.

cErrorCode ERR char OPT OUTPUT

The Data Field Error Code field is simply a generic data field to pass an error condition flag.  This field is one of the fields that make up the
external parameter data structure of the Data Dictionary Server.

idXAPICallID GENLNG ID REQ INPUT

General purpose ID variable.

mnShipmentShipTo SHAN MATH_NUMERIC REQ INPUT

The address number of the location to which you want to ship this order. The address book provides default values for customer address,
including street, city, state, zip code, and country.

mnShipmentNumber SHPN MATH_NUMERIC OPT INPUT

A "next number" that uniquely identifies a shipment.

mnSalesOrderShipTo SHAN MATH_NUMERIC REQ INPUT

The address number of the location to which you want to ship this order. The address book provides default values for customer address,
including street, city, state, zip code, and country.

mnSalesOrderDeliverTo DVAN MATH_NUMERIC REQ INPUT

The address number of the person who receives the goods ordered. The delivered to address might differ from the ship to address when
ordered goods are processed through a distribution center (which is the delivered to address) before reaching their final destination (the ship
to address).

mnShortItemNumber ITM MATH_NUMERIC REQ INPUT

An inventory item number. The system provides three separate item numbers plus an extensive cross-reference capability to other item
numbers (see data item XRT) to accommodate substitute item numbers, replacements, bar codes, customer numbers, supplier numbers, and
so forth. The item numbers are as follows:   o Item Number (short) - An eight-digit, computer-assigned item number     o 2nd Item Number - The
25-digit, free-form, user defined alphanumeric item number     o 3rd Item Number - Another 25-digit, free-form, user defined alphanumeric item
number

szLot LOT char OPT INPUT

A lot is a quantity of items that you want to group together because they have similar characteristics.

szItemUOM UOM char REQ INPUT

A user defined code (00/UM) that indicates the quantity in which to express an inventory item, for example, CS (case) or BX (box).

mnDemandID DEID MATH_NUMERIC OPT INPUT

A system-generated number that identifies a demand record.

cCreateLabelSerialNumber CRTLBLSN char OPT INPUT

A code that indicates what type of serial number will be generated for cartons.  Valid values are: 1 Generate UCC-128 SSCC
Numbers. 2 Generate Label Next Numbers. 3 Generate Electronic Product Code. Blank Do not generate serial numbers for cartons.

szBranchPlant MCU char REQ INPUT

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.

mnSoldTo AN8 MATH_NUMERIC REQ INPUT

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

mnItemQty TQTY MATH_NUMERIC REQ INPUT

The total quantity of an item to be reworked or scrapped as a result of an ECO disposition.

jdRequestedShipDate RQSJ JDEDATE OPT INPUT

Requested ship date.

mnRequestedShipTime RSHT MATH_NUMERIC OPT INPUT

Requested Ship Time.

szCustomerPO CSTPO char OPT INPUT

A number that identifies the customer's purchase order.

szAssemblyLineFeed ASBLNFD char OPT INPUT

A value that is received from the customer's EDI set/message. This value identifies an actual receiving location on an automotive
assembly line for delivery of the product.

szDemandReference1 DMDREF1 char OPT INPUT

A number that identifies a demand entity.

szDemandReference2 DMDREF2 char OPT INPUT

A number that identifies a demand entity.

szDockID DKID char OPT INPUT

The dock location from which an outbound shipment is assigned to depart or at which an inbound shipment is assigned to arrive.

szCustomerItemNumber CITM char OPT INPUT

The cross-reference item number that the system assigns to an item number. A cross-reference number allows you to use a supplier's item
number if it is different from your own item number when you are processing an order or printing.

szCustomerItemRevLevel CIRV char OPT INPUT

A reference number used to identify the revision level of the customer's item.   In item cross-reference, translating a customer or supplier
external item number to the internal short item number, the customer's number only is not always sufficient. In some instances, the customer part
number must be used in conjunction with the item revision level. This combination will allow the system to uniquely identify the customer's
item.

szPartyID_1 PARTYID char OPT INPUT

A code that identifies the party in an EDI message. This code is typically the fourth element of the N1 segment of an X12 transaction set.

szPartyID_2 PARTYID char OPT INPUT

A code that identifies the party in an EDI message. This code is typically the fourth element of the N1 segment of an X12 transaction set.

szPullSignal PSIG char OPT INPUT

Future use. A code that might represent a DON (Delivery Order Number), RAN (Release Accounting Number), or KANBAN number to
trigger replenishment of material. Some customers using pull-based manufacturing practices to signal line-side replenishment of material.

szUNorNANumber UNNA char OPT INPUT

The UN or NA number assigned to hazardous goods.

szHazardClass HZDC char OPT INPUT

The hazard class of the item.

szHazardLabel HZDL char OPT INPUT

The hazard label used for the item.

mnFlashPointTemperature FPNT MATH_NUMERIC OPT INPUT

The flashpoint temperature of the hazardous item.

cTemperatureType STPU char OPT INPUT

A code used to identify the type of temperature. Valid values are:    F Fahrenheit    C Celsius

cCartonLabelPreference CLPP char OPT NONE

A code that indicates whether or not to use the Carton Label Preference. The preference can be used to distinguish which carton types are
eligible to be automatically assigned serial numbers (labels).  If serial numbers are being created and the preference is not being used, all
carton types are eligible.   Valid values are: Blank Do not use the Carton Label Preference. 1 Use the Carton Label Preference.

mnCacheJobNumber JOBS MATH_NUMERIC OPT NONE

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

Related Functions

None

Related Tables

None

CreateOBLabelShipmentHdr
CreateOBLabelShipmentHdr

Create XAPI Outbound Label Message

Minor Business Rule

Object Name: N4601380

Parent DLL: CWARE

Location: Client/Server

Language: NER

Functional Description

Purpose
This function creates the XAPI outbound label shipment header.  The function gets shipment
information, loads the XAPI data structure and calls the XAPI API.  Data in the shipment header consists of
shipment number, promised ship date and time, branch/plant, sold to, ship to and an error message ID and
text.  The header is created once for each shipment.  If there are errors retrieving the data the error
message ID and description are loaded to the XAPI message (i.e. "Invalid Shipment Number").

Setup Notes and Prerequisites
Pass in the Shipment Number (SHPN) to load both Shipment (F4915) and Address (F0101) information to
the shipment header.

If a shipment number does not exist yet, the following values may be sent in to load the supplier and
ship to address information to the shipment header:
• XAPI call ID.  The XAPI call ID should have been assigned in a previous call to XAPI Initialize
(B4601440).
• Branch/Plant (MCU)
• Ship To (SHAN)

Special Logic
• If the XAPI API call fails, an error will be returned in the XAPI Error Message ID and the XAPI
message will not be sent.

Data Structure

D4601380A - Create Outbound Label Shipment Header

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

cSuppressErrorMessage SUPPS char OPT INPUT

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 OUTPUT

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.

szXAPIErrorMessageID DTAI char OPT OUTPUT

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.

cErrorCode ERR char OPT OUTPUT

The Data Field Error Code field is simply a generic data field to pass an error condition flag.  This field is one of the fields that make up the
external parameter data structure of the Data Dictionary Server.

idXAPICAllID GENLNG ID OPT INPUT

General purpose ID variable.

mnShipmentNumber SHPN MATH_NUMERIC OPT INPUT

A "next number" that uniquely identifies a shipment.

szBranchPlant MCU char OPT BOTH

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.

mnSoldTo AN8 MATH_NUMERIC OPT BOTH

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

mnShipTo SHAN MATH_NUMERIC OPT BOTH

The address number of the location to which you want to ship this order. The address book provides default values for customer address,
including street, city, state, zip code, and country.

jdRequestedShipDate RQSJ JDEDATE OPT NONE

Requested ship date.

Related Functions

None

Related Tables

None

CreateOBLabelStandardCartonData
CreateOBLabelStandardCartonData

Create XAPI Outbound Label Message

Minor Business Rule

Object Name: N4601380

Parent DLL: CWARE

Location: Client/Server

Language: NER

Functional Description

Purpose
This function creates XAPI outbound data for a carton.  The function gets carton weight, packaging
code and loads the XAPI data structure.

Setup Notes and Prerequisites
Required parameters are:
• XAPI call ID.  The XAPI call ID should have been assigned in a previous call to XAPI Initialize
(B4601440).
• Branch/Plant
• Carton Code

Special Logic
• If the XAPI API call fails, an error will be returned in the XAPI Error Message ID and the XAPI
message will not be sent.

Data Structure

D4601380F - Create Outbound Label Standard Carton Data

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

cSuppressErrorMessage SUPPS char OPT INPUT

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 OUTPUT

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.

szXAPIErrorMessageID DTAI char OPT OUTPUT

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.

cErrorCode ERR char OPT OUTPUT

The Data Field Error Code field is simply a generic data field to pass an error condition flag.  This field is one of the fields that make up the
external parameter data structure of the Data Dictionary Server.

szBranchPlant MCU char REQ INPUT

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.

szCartonCode EQTY char REQ INPUT

A code (46/EQ) that identifies a storage container or a shipping carton. A storage container can be an open container where items are
stored on the container (for example, a pallet), or a closed container where items are stored in the container (for example, a box). You use the
Container and Carton Codes program (P46091) to define storage containers.

idXAPICallID GENLNG ID REQ INPUT

General purpose ID variable.

mnNumberofLabels NBRLBL MATH_NUMERIC OPT NONE

The number of labels that are needed for the item and quantity. The system calculates the number of labels by using the rules in the Item
Standard Packs application (P460131). If rules are not set up, the system uses the default value of 1 for standard pack; and the number of
labels equals the item quantity.

mnSoldTo AN8 MATH_NUMERIC OPT NONE

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

mnShipTo SHAN MATH_NUMERIC OPT NONE

The address number of the location to which you want to ship this order. The address book provides default values for customer address,
including street, city, state, zip code, and country.

jdRequestedShipDate RQSJ JDEDATE OPT NONE

Requested ship date.

mnShipmentNumber SHPN MATH_NUMERIC OPT NONE

A "next number" that uniquely identifies a shipment.

Related Functions

None

Related Tables

None