How to Close open purchase order through N4301900

Purpose of Document

The purpose of this document is to explain as-is functionality of CancelPurchaseOrder (N4301900, Cancel Purchase Order). Currently there is no batch application which enable you to close/cancel multiple orders. If applicable, you can perform same action through business service processPurchasaeOrder with actionType = 3 (D, or Cancel).
 

CancelPurchaseOrderPurpose: the purpose of this document is to help user to understand the NER N4301900 (Cancel Purchase Order) which is a wrapper function to call F4311EditLine (XT4311Z1, F4311 Edit Line) with parameters for cancellation of existing order. In reality, XT4311Z1 does not handle cache/workfile for purchase order detail line(s) rather action routine is written in F4311EditLineInternalFunctions (XT4311Z2, F4311 Edit Line Internal Functions). So this document shall explain routine which is specific to cDetailActionCode = 'D - Cancel'.

Note that the wrapper function N4301900 does not commit cache/workfile updated through this routine, so user must click OK button to commit the change made through Edit Line routine. To commit the change made, you have to call F4311EndDoc explicitly to commit the data validated/defaulted via CancelPurchaseOrder.

Business Function

• CancelPurchaseOrder (N4301900, Cancel Purchase Order)
• F4311EditLine (XT4311Z2 - F4311 Edit Line)

CancelPurchaseOrder (N4301900, Cancel Purchase Order)

• Purpose: This function is used as wrapper function which calls F4311EditLine MBF to cancel out exiting order. This function can be useful when you need to close out old orders without hurting integrity with other related table(s).
• Parameter
• Data Structure: D4301900 - Cancel Purpose Order

Simplified routine for cancelling purchase order:

    1. CancelPurchaseOrder (N4301900, Cancel Purchase Order)
        2. F4311EditLine (XT4311Z1, F4311 Edit Line) --> Refer to below business function
            3. RetrieveProcessAndTransactionID (B0001060, Retrieve Process and Transaction IDs)
            3. GetPurchaseOrderHeader (B4300130, F4301 Get Purchase Order Header Row)
            3. F4311FSBeginDoc (F4311FSBeginDoc (XT4311Z1, F4311 Begin Document))
            3. CacheProcessPOHeaderCache (B4302180, Purchase Order Header Cache Function)
            3. CalculatePurchasePrice (B4500250, Calculate Purchase Price)
                ...
    1. F4311EditDoc (XT4311Z1, F4311 Edit Doc)
    1. F4311EndDoc (XT4311Z1, F4311 End Document):Record down Machine Name and Job Number returned by Edit Line and call this routine explicitly to commit change made to the database.




F4311EditLine (XT4311Z2 - F4311 Edit Line)

• Purpose: This function validates/defaults purchase order detail and stores it into cache or workfile depends on the parameter you have set. 
• Parameter:
• Data Structure: DF4311Z1B - F4311 Edit Line

• Detail routine for cDetailActionCode = 'D' or '3' (cf., 1/A for Add Mode, 2/C for Change Mode.)
  
• If in update or delete mode and header record already exists, then retrieve the existing purchase order header information from the PO header live file F4301 and pass them to begin doc to get a record written to the header work file i.e. F4301Z
• Even for cancellation, it goes through full edit of detail data.

• • Call CacheProcessPOHeaderCache to create header cache F4301Z (issue error '0001' if no header record is found)
  • Set szBaseCurrencyCode (F4301.CRDC) and (when F4311.FRTH is blank but F4301.FRTH is not blank)
  • Call IXTF4311Z2_WorkWithEditLineBranchPlant: This internal function will retrieve the pointer to the F41001record (through GetBranchConstants) if it has not already been retrieved by the call to F4311Z1FSBeginDoc.
  • Call IXTF4311Z2_WorkWithDetailLineBranchPlant: If the branch plant in the detail line is blank then default in the branch plant from the header and validate that there is a company for that branch (i.e. validate that it exists) using business function RetrieveCompanyFromBusUnit (b0000130). Also check to see whether the currency for the detail branch is  the same as that of the header. If the detail line branch plant entered by the user is not equal to that in the header then retrieve a pointer to the f41001 record using GetBranchConstants (B4000150). For non- inventory items check the posting edit code of the detail line branch plant using the business function EditBUP (B0900038).
  • Call IXTF4311Z2_WorkWithEditLineLineType: If in add mode and the line type passed in is blank then assign the line type specified by the processing option.
    if blank but in update/ delete mode then assign the line type from the PO detail live file. Once in update mode and a line type has been passed in the user is not allowed to change the line type. If an item number has been entered and the line type passed in is blank the line type can be retrieved from the item master via the business function VerifyAndGetItemMaster (X4101) where the pointer to the F4101 record can be used to access the LNTY field. If this still does not work the use the jdeDDValidation API to default the line type from the data dictionary. The line type obtained from one of these methods must be validated using the business function GetLineTypeConstants (B4000260).
  • Call IXTF4311Z2_WorkWithNextAndLastStatus: If in add mode and the next and last status have been left blank the assign the respective values from the processing options set. If in delete mode then assign 999 to the next status and 980 to the last status. The last status code is verified by the business function VerifyActivityRuleStatusCode (B4000260). If the next status code is blank then default the value in from GetLineTypeConstants. If the next status had been entered by the user then validate it
    using the internal function VerifyOverrideNextStatusCode.
  • IXTF4311Z2_WorkWithEditLineShipToNumber: If avalue for the ship to number has not been entered and the branch plant in the detail line and the header are the same then default in the ship to address from header (F4301Z). If the branch plants are not the same then use the pointer to the Detail line branch record in the f41001 to get its corresponding ship to address. If the ship to addresses in the header and the detail are different then use the jdeDDValidation API to edit the ship to Address.
  • IXTF4311Z2_WorkWithEditLineItemNumber
  • IXTF4311Z2_WorkWithEditLineLocation
  • IXTF4311Z2_WorkWithEditLineBuyerNumber
  • IXTF4311Z2_WorkWithEditLineCarrierNumber
  • IXTF4311Z2_WorkWithEditLineAdjustmentSchedule
  • IXTF4311Z2_WorkWithEditLineGLOffset
  • IXTF4311Z2_WorkWithEditLineProjectInfo
  • IXTF4311Z2_WorkWithEditLinePMPNInfo
  • IXTF4311Z2_WorkWithEditLineGLAccount
  • IXTF4311Z2_SubledgerAndSubledgerType
  • IXTF4311Z2_EditLineGLPostEditCode
  • IXTF4311Z2_EditLineAssetID
  • IXTF4311Z2_EditLineDescription1And2
  • IXTF4311Z2_WorkWithEditLineDates: The dates processed in this internal function are further described below:-
    REQUESTED DATE
    -> if blank then default value in from the PO header work file
    -> Requested date cannot be before the date of transaction.
    PROMISED DATE
    -> if blank then default value on from the PO header file F4301Z
    -> the promised date cannot be before the transaction date.
    CANCEL DATE
    -> If a Cancel date has been entered it cannot be before the transaction date.
  • IXTF4311Z2_EditLineGLDateAndPeriod
  • IXTF4311Z2_EditLineCancelDate
  • IXTF4311Z2_EditLineUnitOfMeasure
  • IXTF4311Z2_EditLineQuantities: If the user when ading an order has left the quantity field blank for non GL related order (Inv. Interface of Y,D or N) initialize the Quantity orderes to 1. The sign of the quantity value is changed if the reverse sign parameter obtained from the GetLineTypeConstants indicates a Y. A test is performed to ensure that when in change mode a switch
    has not been made from quantity to lump sum processing. GetItemUoMConversionFactor is called to convert from to to
    conversion factors.
  • IXTF4311Z2_EditLineMultipleBlanketRelease
  • IXTF4311Z2_AgreementPriceSchedule
  • IXTF4311Z2_EditLineTaxInformation
  • IXTF4311Z2_EditLineOtherFields
  • IXTF4311Z2_ELAssignAndVerifySuffix
  • IXTF4311Z2_EditLineAssignLineNumber
  • IXTF4311Z2_CalcPurchasePrice: Purchase price sets to zero through CalcPurchasePrice
  • IXTF4311Z2_MaintainFreeGoodItems
  • IXT4311Z2_CheckPromoExclusivityForEL
  • IXT4311Z2_PerformReservationProcessing: In case routine gets called not through P4311/R4311Z1I.
  • IXT4311Z2_CancelMultipleAccountsLines
  • IXTF4311Z2_WorkWithCommodityCode
  • IXT4311Z2_ValidateUserDefinedFields
  • IXTF4311Z2_GovernmentContractJobType
  • IXT4311Z2_ValidateServiceUnits
  • IXTF4311Z2_MapDSToPODetailWF
  • IXTF4311Z2_WriteToDetailWorkFile: This internal function will be used to write a new record or update an existing record to the PO detail work file.