send feedback

❮ Previous Next ❯

Release Entire Order interface for JD Edwards

About the Release an Entire Order interface

You can use his interface to release and entire order and keep all the released lines on the same order.

Prior to this interface we had an order release that released an order one line at a time. The name of that function is dcLINKReleaseBlankets. In order to release an entire order, a standard application or mobile application would have to loop through an order and call this function for each line. Because of caching, the net result for a twenty line order would be twenty new orders of one line.

So, in order to quickly release an entire order and keep all the released lines on the same order, this function was created. This interface releases the entire open quantity. Do not use this interface if you want to specify the amount to release.

Name	Function name	Description
DD3N0111		dcLINK Interface Release Entire Order
ND3N0111	dcLINKInterfaceReleaseOrder	dcLINK Interface Release Entire Order

The full name of this interface is ND3N0111 Release Entire Order

This interface guide applies to the following JDE versions.

EnterpriseOne Xe through 9.1

Corresponding EnterpriseOne application

In EnterpriseOne, the application you would run to release orders is P420111. The user would have to select all the lines on a sales order if they wanted to release all lines.

Input data structure

Input data structure for DD3N0111

Name	Default value	R/O	Alias	Notes
cdcLINKActionCode_EV01	0	X	EV01	Always defaults to a 0. No different action takes place based on this code.
cActionCode_ACTION	A	X	ACTION	A = add a phone number for the address book. C = change an existing phone number. D = delete an existing phone number.
jdDateUpdated_UPMJ	Current Date	X	UPMJ	Retrieved from GetAuditInfo.
mnTimeUpdated_UPMT	Current Time	X	UPMT	Retrieved from GetAuditInfo.
szUserId_USER	Current User	X	USER	Retrieved from GetAuditInfo.
szWorkStationId_JOBN	Current Workstation	X	JOBN	Retrieved from GetAuditInfo.
mnJobNumber_JOBS		O	JOBS
szProgramId_PID	ND3N4109	X	PID	Defaulted in program if not passed in.
szVersion_VERS	ZJDE0001	X	VERS	Defaulted in program if not passed in.
cSuppressErrorMessage_EV01		O	EV01
cErrorCode_ERRC	Blanks	X	ERRC	Defaulted in program
szErrorMessageKey_EKEY	Blanks	X	EKEY	Defaulted in program.
iDebugLevel_INT01		O	INT01	Displays M&D Debug statements if the value is greater than 0.
mnOrderNumber_DOCO		R	DOCO	The order number of the order to be released.
szOrderCompanyNo_KCOO		O	KCOO	The company number of the order to be released. This is not used by this interface.
mnLIneNumber_LNID		O	LNID	The line number in the sales order that will be released. This is not used by this interface.
szOrderType_DCTO		X	DCTO	The document type of the order to be released. If not passed in the interface, an attempt will be made to get it from the processing options. If it isn't defined there an error will be returned.
szBranchPlant_MCU		O	MCU	The branch/plant of the order to be released. This is not used by this interface.
szItemNoUnknownFormat_UITM		O	UITM	The item number on the line that is to be released. This is not used by this interface.
mnNewOrderNumber_DOCO		O	DOCO	This is returned by the interface. It is the new order number for the released order.
szNewOrderType_DCTO		O	DCTO	This is returned by the interface. It is the document type of the new order.
mnReleaseQuantity_OPQT		O	OPQT	This is the quantity being released. For this interface, this quantity is calculated by the interface, and it is the amount that is open.
jdRequestDate_EXPJ		O	EXPJ	This is the requested date for the order being created. This is not used by this interface.
mnProcessID_PEID		O	PEID
mnTransactionID_TCID		O	TCID
szGuidApprover1_USR1		O, R	USR1	An entry in this field, or the Approver 2 field, will cause a signature capture record to be written. Signature capture records are part of the GUID processing and should not be used unless a GUID is being created by dcLINK. The value of this field is a User ID, not an address book entry. There must be a value passed in to either this field or the approver 2 field, otherwise it is an error.
szGuidFullName1_FULLNAME1		O	FULLNAME1	This field is the full name of the GUID Approver 1.
szGuidApprover2_USR2		O, R	USR2	GUID processing supports up to two approvers. If two approvers are required, this is the user ID of the second approver. There must be a value passed in to either this field, or the approver 1 field. Otherwise it is an error.
szGuidFullName2_FULLNAME2		O	FULLNAME2	This field is the full name of the GUID Approver 2.
mnGuidReasonCode1_REASON1		O, R	REASON1	If either of the approver fields contains a value, but no value is entered into one of the reason code fields, then an error will be returned. Reason codes must match the valid reason codes setup for GUID processing. Otherwise it is an error.
szGuidCommentField_COMMENTS		O	COMMENTS	This is a free form entry field that is used to further explain the reason code entered into the previous field.
mnGuidReasonCode2_REASON2		O, R	REASON2	If either of the approver fields contains a value, but no value is entered into one of the reason code fields, then an error will be returned. Reason codes must match the valid reason codes setup for GUID processing. Otherwise it is an error.
szGuidCommentField2_2COMMENTS		O	2COMMENTS	This is a free form entry field that is used to further explain the reason code entered in the previous field.
szGuidScriptID_FMNMVERS		O	FMNMVERS	In PeopleSoft, the screen IDC where the change was made is captured. dcLINK captures the script ID.
szGuidTextMessage_TEXTMES		O	TEXTMES	This is a free form entry field.
szGuidUniqueID_GUID	Automatically generated by dcLINK	O	CFRGUID	If generate GUIDs is turned on in the dcLINK configuration utility, this field will contain a GUID (guaranteed unique identifier). The GUID is used to tie database changes in PeopleSoft to the transactions that triggered those changes to occur.

R = Required

X = Required but will default in if not passed

O = Optional

Processing options

This business function only retrieves processing options if the document type is not passed in.

In order to read the F4211 file, both the order number and document type are required fields. So if no document type is passed in, then it retrieves the document type from the processing options.

Processing

This business function will retrieve processing options and process an entire order.

In order to process an entire order, this interface is expecting the order number and document type. If the order number is not passed, an error will be returned back. If the document type is not passed in and the document type from the processing options is blank, then an error will be returned.

The original interface that releases a line at a time will be used to actually do the release, so that we are not maintaining the same code in two different interfaces. This interface will loop through the F4211 file for all the lines on an order and, for each line that has an open quantity, will call dcLINKReleaseBlankets to release it.

Action codes

Action codes are all programmatically set, so no value needs to be passed in. The first line that gets called will have a dcLINKActionCode of “2”, which tells dcLINKReleaseBlankets to call a Begin Doc and Edit Line. Each subsequent line is called with a dcLINKActionCode of “3”, which only performs an Edit Line. After the last order line has been processed, dcLINKReleaseBlankets will be called one last time with a dcLINKActionCode of “5”. This performs an End Doc and clears the cache.

The very first call will return back the new order number and document type. These are passed in on the subsequent calls so that all lines being released end up on the same order.

Required fields

In order to release an order, the order number and document type must be supplied. If the order number is not passed in, an error will be returned. If the document type isn't passed in, this program will try to get one from the processing options. If the document type isn't defined in the processing options, then an error will be returned.

Determine quantity to release

This interface will determine the quantity to release by using the original transaction quantity, and subtracting the quantity shipped to date. If the result is greater than zero, then the interface will release this line. If the result is zero or less, then the line is skipped from processing and the next line is read. It is not possible to override the quantity calculated.

Verify the processing

Since the actual processing is being done by the line by line blanket release interface, refer to that usage guide to verify the processing.

Input data structure

Input data structure for DD3N0111

Name	Default value	R/O	Alias	Notes
cdcLINKActionCode_EV01	0	X	EV01	Always defaults to a 0. No different action takes place based on this code.
cActionCode_ACTION	A	X	ACTION	A = add a phone number for the address book. C = change an existing phone number. D = delete an existing phone number.
jdDateUpdated_UPMJ	Current Date	X	UPMJ	Retrieved from GetAuditInfo.
mnTimeUpdated_UPMT	Current Time	X	UPMT	Retrieved from GetAuditInfo.
szUserId_USER	Current User	X	USER	Retrieved from GetAuditInfo.
szWorkStationId_JOBN	Current Workstation	X	JOBN	Retrieved from GetAuditInfo.
mnJobNumber_JOBS		O	JOBS
szProgramId_PID	ND3N4109	X	PID	Defaulted in program if not passed in.
szVersion_VERS	ZJDE0001	X	VERS	Defaulted in program if not passed in.
cSuppressErrorMessage_EV01		O	EV01
cErrorCode_ERRC	Blanks	X	ERRC	Defaulted in program
szErrorMessageKey_EKEY	Blanks	X	EKEY	Defaulted in program.
iDebugLevel_INT01		O	INT01	Displays M&D Debug statements if the value is greater than 0.
mnOrderNumber_DOCO		R	DOCO	The order number of the order to be released.
szOrderCompanyNo_KCOO		O	KCOO	The company number of the order to be released. This is not used by this interface.
mnLIneNumber_LNID		O	LNID	The line number in the sales order that will be released. This is not used by this interface.
szOrderType_DCTO		X	DCTO	The document type of the order to be released. If not passed in the interface, an attempt will be made to get it from the processing options. If it isn't defined there an error will be returned.
szBranchPlant_MCU		O	MCU	The branch/plant of the order to be released. This is not used by this interface.
szItemNoUnknownFormat_UITM		O	UITM	The item number on the line that is to be released. This is not used by this interface.
mnNewOrderNumber_DOCO		O	DOCO	This is returned by the interface. It is the new order number for the released order.
szNewOrderType_DCTO		O	DCTO	This is returned by the interface. It is the document type of the new order.
mnReleaseQuantity_OPQT		O	OPQT	This is the quantity being released. For this interface, this quantity is calculated by the interface, and it is the amount that is open.
jdRequestDate_EXPJ		O	EXPJ	This is the requested date for the order being created. This is not used by this interface.
mnProcessID_PEID		O	PEID
mnTransactionID_TCID		O	TCID
szGuidApprover1_USR1		O, R	USR1	An entry in this field, or the Approver 2 field, will cause a signature capture record to be written. Signature capture records are part of the GUID processing and should not be used unless a GUID is being created by dcLINK. The value of this field is a User ID, not an address book entry. There must be a value passed in to either this field or the approver 2 field, otherwise it is an error.
szGuidFullName1_FULLNAME1		O	FULLNAME1	This field is the full name of the GUID Approver 1.
szGuidApprover2_USR2		O, R	USR2	GUID processing supports up to two approvers. If two approvers are required, this is the user ID of the second approver. There must be a value passed in to either this field, or the approver 1 field. Otherwise it is an error.
szGuidFullName2_FULLNAME2		O	FULLNAME2	This field is the full name of the GUID Approver 2.
mnGuidReasonCode1_REASON1		O, R	REASON1	If either of the approver fields contains a value, but no value is entered into one of the reason code fields, then an error will be returned. Reason codes must match the valid reason codes setup for GUID processing. Otherwise it is an error.
szGuidCommentField_COMMENTS		O	COMMENTS	This is a free form entry field that is used to further explain the reason code entered into the previous field.
mnGuidReasonCode2_REASON2		O, R	REASON2	If either of the approver fields contains a value, but no value is entered into one of the reason code fields, then an error will be returned. Reason codes must match the valid reason codes setup for GUID processing. Otherwise it is an error.
szGuidCommentField2_2COMMENTS		O	2COMMENTS	This is a free form entry field that is used to further explain the reason code entered in the previous field.
szGuidScriptID_FMNMVERS		O	FMNMVERS	In PeopleSoft, the screen IDC where the change was made is captured. dcLINK captures the script ID.
szGuidTextMessage_TEXTMES		O	TEXTMES	This is a free form entry field.
szGuidUniqueID_GUID	Automatically generated by dcLINK	O	CFRGUID	If generate GUIDs is turned on in the dcLINK configuration utility, this field will contain a GUID (guaranteed unique identifier). The GUID is used to tie database changes in PeopleSoft to the transactions that triggered those changes to occur.

R = Required

X = Required but will default in if not passed

O = Optional

Transaction test scenarios

The following test scenarios demonstrate a variety of ways in which this interface could be used, and the fields that would be passed for each scenario.

The data structure fields are in the left column, and the corresponding values for each scenario are listed by column.

Field name	Pass both order and doc type	Pass only the order number
cdcLINKActionCode_EV01
cActionCode_ACTION
jdDateUpdated_UPMJ
mnTimeUpdated_UPMT
szUserId_USER	Elvis	Elvis
szWorkStationId_JOBN
mnJobNumber_JOBS
szProgramId_PID
szVersion_VERS	ZJDE001	ZJDE001
cSuppressErrorMessage_EV01
cErrorCode_ERRC
szErrorMessageKey_EKEY
iDebugLevel_INT01
mnOrderNumber_DOCO	257	258
szOrderCompanyNo_KCOO
mnLIneNumber_LNID
szOrderType_DCTO	SB
szBranchPlant_MCU
szItemNoUnknownFormat_UITM
mnNewOrderNumber_DOCO
szNewOrderType_DCTO
mnReleaseQuantity_OPQT
jdRequestDate_EXPJ
mnProcessID_PEID
mnTransactionID_TCID
szGuidApprover1_USR1
szGuidFullName1_FULLNAME1
szGuidApprover2_USR2
szGuidFullName2_FULLNAME2
mnGuidReasonCode1_REASON1
szGuidCommentField_COMMENTS
mnGuidReasonCode2_REASON2
szGuidCommentField2_2COMMENTS
szGuidScriptID_FMNMVERS
szGuidTextMessage_TEXTMES
szGuidUniqueID_GUID

Common error messages

The following are common error messages that can be generated by this BF, and what those error messages mean.

Error message	Meaning
4635	Order Number required. No value was passed in the parameter mnOrderNumber_DOCO. This is the order number that is to be released. It must be supplied.
4634	Order Type required. The order type must be supplied. It can be supplied in two ways: 1) It is passed in by the user 2) It is not passed in but retrieved from the processing options. If you are getting this error message, the order type was not passed in and there was no order type setup for the processing option version being used.
4205	No Records Selected. This interface will read each line for the order number supplied. Each line being read will have the quantity left open calculated. If that quantity is not greater than zero, the line is skipped. If no lines get selected because there is none with an open quantity, then this message will be returned.

There was a problem loading this topic

Mobile Enterprise Platform

Release Entire Order interface for JD Edwards

About the Release an Entire Order interface

Corresponding EnterpriseOne application

Input data structure

Processing options

Processing

Action codes

Required fields

Determine quantity to release

Verify the processing

Input data structure

Transaction test scenarios

Common error messages