This chapter includes these topics:
This chapter provides detailed information about the business interfaces that are available for the Purchase Orders business object.
This table lists all of the available interface components:
|
Note: You can find additional technical information about each type of business interface component. For additional descriptions of the information available, and instructions for finding this information, see Chapter 5, "Accessing Additional Information for Business Interface Components." |
The ProcurementManager web service (JP430000) manages the processing of procurement-related web service operations. This table includes a description of the procurement web service operations:
To access Javadoc for the Procurement Manager web service and its related operations, review these Javadoc packages:
JP430000 (ProcurementManager)
J4300010 (processPurchaseOrder)
J4300010 (processPurchaseOrderV2)
J4300020 (processPurchaseOrderAcknowledge)
J4300030 (getPurchaseOrder)
J4300030 (getPurchaseOrderV2)
Before using the Procurement Manager web service, or any of the related web service operations, you must install and configure the JD Edwards EnterpriseOne Procurement system.
See JD Edwards EnterpriseOne Applications Procurement Management Implementation Guide.
The processPurchaseOrder web service operation is an inbound transaction operation that enables consumers to process purchase order information within the JD Edwards EnterpriseOne system. The consumer can add, change or cancel a purchase order in the JD Edwards EnterpriseOne Procurement system.
If the operation is successful, the system returns a confirmation message which includes purchase order data to the consumer. If the operation fails, the system returns an error message to the consumer.
This section discusses the functionality that the processPurchaseOrder operation supports.
|
Note: If functionality is not explicitly documented as supported functionality, it is to be understood that the functionality is not supported by the integration solution. |
The processPurchaseOrder operation supports add, change or cancel of purchase orders, blanket orders, quote orders, requisition orders, and subcontracts. In Change mode the processPurchaseOrder operation supports add, change or cancel of detail lines for purchase orders, blanket orders, quote orders, requisition orders, and subcontracts.
(Release 9.1 Update) The processPurchaseOrder operation supports retrieval of the alternate tax rate/area assignment if the functionality is set up for the entities in a transaction.
See "Procurement" in the JD Edwards EnterpriseOne Applications Tax Processing Implementation Guide.
The processPurchaseOrder web service operation does not support:
Requisition self service.
Purchase order generation.
Suffix input at the header level.
Although the suffix field is supported at the header level and is part of the key in JD Edwards World, the value in the suffix field for purchase orders in JD Edwards EnterpriseOne is always 000. By preventing input of the suffix at the header level, the integration may not be compatible when integrating with JD Edwards World.
Before you use this operation, you can set business service properties to specify how the system processes purchase order information. This table includes information about the business service properties that the processPurchaseOrder web service operation uses:
| Group | Key | Description | Default Value |
|---|---|---|---|
| J4300010 | J4300010_PO_MBF_VERSION | Use this business service property to specify which version of the Purchase Orders program (P4310) the operation uses. | ZJDE0001 |
| J4300010 | J4300010_BYPASS_BSFN_WARNINGS | Use this business service property to specify whether the system ignores warnings during processing. | 1
Note: The system does not treat warnings as errors so the system keeps processing. |
| J4300010 | J4300010_PREFIX_1 | Use this business service property to specify the prefix value the operation uses for error messages on purchase order detail lines. | Line No. Sent in: |
The following table includes information that can help determine whether the processPurchaseOrder operation is functioning correctly:
| Question | Answer |
|---|---|
| How can I tell if the operation completes successfully? | If the operation completes successfully, the system returns a confirmation message to the consumer. The return message includes all the fields that are listed in the response interface for this operation. However, some of those fields can contain blank or zero values, depending on the data that exists in the JD Edwards EnterpriseOne system.
At a minimum, the system returns non-zero values for these fields:
If the operation completes successfully, the system returns the confirm value object and no exception is thrown. |
| If I encounter errors while processing a transaction, do I need to reverse the transaction? | This operation uses standard transaction processing. Therefore, if you encounter errors during processing, the system does not update any information in the JD Edwards EnterpriseOne system. No manual update is necessary. |
| Does this operation use record reservation? | This operation calls the PurchaseOrderInit business function (B4305320). This function reserves records in the JD Edwards EnterpriseOne system when the operation is changing or deleting existing data. |
Review the information in the processPurchaseOrder section of this chapter before using the processPurchaseOrderV2 web service operation. All of the information in the processPurchaseOrder section also applies to the processPurchaseOrderV2 operation.
The processPurchaseOrderV2 operation is a version of the processPurchaseOrder web service operation. This web service operation is used to add, update, and delete purchase order information along with associated GLNs. This version executes the processPurchaseOrder (J4300010) web service operation.
The processPurchaseOrderAcknowledge web service operation is an inbound transaction operation that enables consumers to process purchase order acknowledgements within the JD Edwards EnterpriseOne system. The consumer can synchronize sales orders in the source system to the corresponding purchase orders in the JD Edwards EnterpriseOne Procurement system.
If the operation is successful, the system returns a confirmation message which includes purchase order acknowledgement data to the consumer. If the operation fails, the system returns an error message to the consumer.
If the operation is successful, the system returns purchase order header and line keys to the caller through the ConfirmProcurementOrderAcknowledge web service operation. The system returns exceptions to the caller. The minimum required fields to acknowledge a purchase order in JD Edwards EnterpriseOne are:
Header
statusOrderCode
purchaseOrderKey
Detail (optional)
statusOrderCode
purchaseOrderLineKey
The processPurchaseOrderAcknowledge operation enables the consumer to specify the statusOrderCode at the header and detail level. The statusOrderCode indicates the type of operation that is being performed on the purchase order and is required. The status order codes are:
1: Accept
2: Accept with change
3: Pending
4: Product already shipped
5: Reject
This table includes information about the JD Edwards EnterpriseOne purchase order acknowledgement scenarios used by the processPurchaseOrderAcknowledge operation:
| Status Order Code in Header | Status Order Code in Detail | Comment | Result |
|---|---|---|---|
| 1 | 1 | Accept | Only the detail status is changed and no data is updated. |
| 1 | 2 | Accept | The detail status is changed and other data is updated. |
| 2 | 1 | Accept | Only the detail status is changed and the data in the header is updated. |
| 2 | 2 | Accept with change | The detail status is changed, and the header and detail data is updated. |
| 3 | 3 | Pending | The status is changed to Pending as set in the processing options. |
| 4 | 4 | Product already shipped | There is no change in the EnterpriseOne system. |
| 5 | 1, 2, 3, 4, 5 | Reject | All the lines are rejected. |
| 1 | 3 | The header is not updated, the status is changed to Pending as set in the processing options, and the VR01 field in the detail is changed. | |
| 2 | 3 | The header data is updated, the status is changed to Pending as set in the processing options, and the VR01 field in the detail is changed. | |
| 2 | 4 | The header data is updated but no fields in the detail are updated. | |
| 2 | 5 | The header data is updated and the status is changed. | |
| 3 | 2 | The header is not updated, the detail status is changed, and other data is updated. | |
| 4 | 5 | The data in the header is not updated and the status fields are changed. |
Before using the processPurchaseOrderAcknowledge web service operation, you must:
Set the 3. Acknowledged Order Status Code, 4. Acknowledged With Change Order Status Code, and 5. Pending Order Status Code processing options on the Order Statuses tab of the Purchase Order XPI program (P43XPI). See Section 83.2.4, "Setting Processing Options for Purchase Order XPI (P43XPI)."
Set the Order Type to OP and Line Type for stock, non-stock or service lines in the Order Activity Rules from the Procurement System Setup menu (G43A41).
This section discusses the functionality that the processPurchaseOrderAcknowledge operation supports.
|
Note: If functionality is not explicitly documented as supported functionality, it is to be understood that the functionality is not supported by the integration solution. |
The processPurchaseOrderAcknowledge operation enables a purchase order to be acknowledged, acknowledged and changed, appended, or rejected. The operation also supports sales order line splits. When the operation sends line split information to the JD Edwards EnterpriseOne system, it must be sent as an acknowledge with change so that a line is added to the purchase order. Two lines must be sent to split a line, both as an acknowledge with change. If a related sales order is not added, the operation performs a call in rejection mode and the corresponding JD Edwards EnterpriseOne purchase order is cancelled.
The processPurchaseOrderAcknowledge web service operation does not allow the status of cancelled lines to change.
Before you use this operation, you can set business service properties to specify how the system processes purchase order acknowledgment information. This table includes information about the business service properties used by the processPurchaseOrderAcknowledge operation:
| Group | Key | Description | Default Value |
|---|---|---|---|
| J4300020 | J4300020_PO_MBF_VERSION | Use this business service property to specify which version of the Purchase Orders program (P4310) the operation uses. | ZJDE0001 |
| J4300020 | J4300020_BYPASS_BSFN_WARNINGS | Use this business service property to specify whether the system ignores warnings during processing. | 1
The system does not treat warnings as errors so the system keeps processing. |
| J4300020 | J4300020_PREFIX_1 | Use this business service property to specify the prefix value the operation uses for error messages on purchase order detail lines. | Line No. Sent in: |
The following table includes information that can help determine whether the processPurchaseOrderAcknowledge operation is functioning correctly:
| Question | Answer |
|---|---|
| How can I tell if the operation completes successfully? | If the operation completes successfully, the system returns a confirmation message to the consumer. The return message includes all of the fields that are listed in the response interface for this operation. However, some of those fields can contain blank or zero values, depending on the data that exists in the JD Edwards EnterpriseOne system.
At a minimum, the system returns non-zero values for these fields:
If the operation completes successfully, the system returns the confirm value object and no exception is thrown. |
| If I encounter errors while processing a transaction, do I need to reverse the transaction? | This operation uses standard transaction processing. Therefore, if you encounter errors during processing, the system does not update any information in the JD Edwards EnterpriseOne system. No manual update is necessary. |
| Does this operation use record reservation? | This operation calls the PurchaseOrderAcknowledgeNotify business function (B4302190). This function reserves records in the JD Edwards EnterpriseOne system when the operation synchronizes sales orders in the source system with their corresponding purchase orders in the JD Edwards EnterpriseOne Procurement system. |
The getPurchaseOrder web service operation is a database query operation that enables consumers to query the JD Edwards EnterpriseOne Procurement system to retrieve existing purchase order information.
If the operation is successful, the system returns zero to many records to the consumer. You can specify the maximum number of records to return during a query using the Max Rows business service property. If the operation fails, the system returns an error message to the consumer.
The database query operation uses the V4301XPI business view which returns only the fields from the Purchase Order Header (F4301) and Purchase Order Detail File (F4311) tables that are needed for processing. Use of the business view allows retrieval of all required fields in a single optimized call.
Field retrieval is based on the selection criteria specified in the value object. The query published value object contains fields which filter the purchase order information retrieved by the JD Edwards EnterpriseOne operation.
This flow supports querying purchase order information in JD Edwards EnterpriseOne. The getPurchaseOrder web service operation enables source systems to query JD Edwards EnterpriseOne purchase order information in a real-time fashion. The selectPurchaseOrder adapter service is invoked to retrieve purchase order information from the V4301XPI business view in JD Edwards EnterpriseOne based on the selection criteria specified in the GetPurchaseOrder published interface document. Retrieved results are grouped together with header and detail information and mapped to the ShowPurchaseOrder published interface document and delivered back to the source application.
The query published interface contains fields that can be used to filter the purchase order information that is retrieved. At minimum, any of the purchase order keys (documentNumber, documentCompany, or documentType) or the item (short item number), or any combination of these fields, is required to process the getPurchaseOrder integration.
Optional fields to include in the filter are:
BusinessUnit
CurrencyCode
Buyer
Supplier
ShipTo
PaymentTermsCode
|
Note: Preceding spaces are already padded to the businessUnit value in the getPurchaseOrder web service operation. The JD Edwards EnterpriseOne date format is used to query purchase orders based on dates in the getPurchaseOrder operation. |
This section discusses the functionality that the getPurchaseOrder operation supports.
|
Note: If functionality is not explicitly documented as supported functionality, it is to be understood that the functionality is not supported by the integration solution. |
The getPurchaseOrder web service operation enables consumers to query the JD Edwards EnterpriseOne Procurement system to retrieve existing purchase order information.
The getPurchaseOrder operation does not support the wildcard (asterisk (*)) for search criteria.
Before you use this operation, you can set business service properties to specify how many records the system returns when you query the JD Edwards EnterpriseOne database. This table includes information about the business service properties used by the getPurchaseOrder operation:
| Group | Key | Description | Default Value |
|---|---|---|---|
| J4300030 | J4300030_MAX_ROWS | Use this business service property to define the maximum number of rows that the operation returns when querying the JD Edwards EnterpriseOne database. | 100 |
|
Note: It is strongly recommended that you set this business service property to a value other than 0 (zero). If you leave this value set to 0, the system returns all matching records. Additionally, it is recommended that you specify selection criteria when you query the JD Edwards EnterpriseOne database. The system returns an error if you perform a query with no selection criteria and this business service property is set to 0. |
The following table includes information that can help determine whether the getPurchaseOrder operation is functioning correctly:
| Question | Answer |
|---|---|
| How can I tell if the operation completes successfully? | If the operation completes successfully, the system returns records that match your search criteria. These records include all of the fields that are listed in the response interface for this operation. However, some of those fields can contain blank or zero values, depending on the data that exists in the JD Edwards EnterpriseOne system.
At a minimum, if the query finds matching records, the system returns non-zero values for these fields:
If a business service exception is not thrown, then the operation completed successfully. |
| If I encounter errors while processing a transaction, do I need to reverse the transaction? | This is a database query operation that does not perform transactions.
If you encounter errors during processing, review your search criteria and business service property settings and try your query again. If the operation does not return any records, verify that records matching your query exist in the JD Edwards EnterpriseOne database. |
| Does this operation use record reservation? | No. This operation does not reserve records that are returned in a query. |
Review the information in the getPurchaseOrder section of this chapter before using the getPurchaseOrderV2 web service operation. All of the information in the getPurchaseOrder section also applies to the getPurchaseOrderV2 operation.
The getPurchaseOrderV2 operation is a version of the getPurchaseOrder web service operation. This web service operation is used to query purchase order information along with associated GLNs. This version executes the getPurchaseOrder (J4300030) web service operation.
This section describes the available real-time events associated with the Purchase Orders business until, which include:
RTPOOUT2, which is a container event for:
*Note that RTPODIST is contained within this event, and also the RTPOOUT event. RTPODIST is documented under the RTPOOUT section of this chapter.
RTPOOUT is a container event used by the JD Edwards EnterpriseOne system that notifies third-party systems when purchase order information changes.
| Event Type | Event Description | Event Category | Event Aggregate | Product Code |
|---|---|---|---|---|
| RTPOOUT | Purchase Order | RTE | Container
Contains events for:
RTPODIST is included in RTPOOUT if the multiple accounts flag is selected for the order line. |
H43 |
Conceptual Approach
A new purchase order creates a new record in the Purchase Order Header table (F4301) and the Purchase Order Detail table (F4311). It also creates a new record in Purchase Order Multiple Accounts (F4316) file multiple account records are associated with the purchase order. A real-time notification is triggered whenever there is an insert in these tables. Also, this event is triggered whenever an exiting purchase order is updated and there is an update to the Purchase Order Header and Purchase Order Detail tables.
Objects that Can Initiate the Event
These objects can initiate the RTPOOUT event and the single events contained within the event:
N4301780 - Update Promised Date – Workflow
B4300330 - Update PO Next Status
B4302153 - Purchase Order Real Time Wrapper Function 3
B4302160 - Purchase Order External Publish Function
B4302590 - Update Order Status F4301 OSTS
B4305420 - Purchase Order Reject Approve
XT4311Z1 - Purchase Order Entry
P43081 - Purchase Order Approval
P4310 - Purchase Orders
P4312 - PO Receipts
P43360 - Release Open Quotations
R00993 - Create F43199 commitment Audit Trail
R11843 - Load Domestic currency codes - Procurement
R4317 - Encumbrance Rollover
R43960 - Close Text Lines
N4002540 - F4211 Direct Ship Order Integrity
B4300230 - Update PO Order Total
B4300360 - Update Purchase Blanket Order
B4301230 - F4311 Update Original PO Line
B4302152 - Purchase Order Real Time Wrapper Function 2
B4302154 - Purchase Order Real Time Wrapper Function 4
B4302155 - Purchase Order Real Time Wrapper Function 5
B4302640 - Receipts Blanket Order Processing
XT4312Z1 - Purchase Order Receipts
P4312 - PO Receipts
Special Setup
To activate the RTPOOUT event, these three important areas are required for data setup:
The Suppliers Correspondence Method (F0401.CRMD, sometimes called Send Method) must be set to 5.
The Document Type of the purchase order must be set up to publish externally. Use the P40040 application to inquire on a document type and select the publish externally check box on the Purchasing tab of the Document Type Revisions form.
Currently all procurement integrations that need processing options use the processing options for P43XPI-ZJDE0001. This event uses the first two processing options on the Order Statuses tab. With these options you can set the range of allowed order statuses that can be published externally. Order Status 999 is valid outside of the dictated range. The canonical has a grouping titled Miscellaneous, which is inside the Header grouping. Within this grouping there is an element named ExternalEvent. This element is set to 1 if these three conditions are met when the purchase order is being processed.
RTPOHDR is used by the JD Edwards EnterpriseOne system to notify third-party systems about purchase order changes.
| Event Type | Event Description | Event Category | Event Aggregate | Product Code | Data Structure | Event Relationship |
|---|---|---|---|---|---|---|
| RTPOHDR | Purchase Order Header | RTE | Single | H43 | D4302470A: Purchase Order Header | Included in container event RTPOOUT. |
Conceptual Approach
This real-time event is contained in the RTPOOUT event and is triggered whenever that event is triggered. The RTPOHDR event contains information from the Purchase Order Header table (F4301).
RTPODTL is used by the JD Edwards EnterpriseOne system to notify third-party systems about purchase order changes.
| Event Type | Event Description | Event Category | Event Aggregate | Product Code | Data Structure | Event Relationship |
|---|---|---|---|---|---|---|
| RTPODTL | Purchase Order Detail | RTE | Single | H43 | D4302470B: Purchase Order Detail | Included in container event RTPOOUT. |
Conceptual Approach
This real-time event is contained in the RTPOOUT event and is triggered whenever that event is triggered. The RTPOHDR event contains information from the Purchase Order Detail table (F4311).
RTPODIST is used by the JD Edwards EnterpriseOne system to notify third-party systems when purchase order header and detail information is created or changed.
| Event Type | Event Description | Event Category | Event Aggregate | Product Code | Data Structure | Event Relationship |
|---|---|---|---|---|---|---|
| RTPODIST | PO multiple accounts | RTE | Single | 43 | D4302470C: Purchase Order Multiple Accounts | Included in container event RTPOOUT. |
Conceptual Approach
This real-time event is contained in the RTPOOUT event and is triggered whenever that event is triggered. The RTPOHDR event contains information from the Purchase Order Multiple Accounts table (F4316).
RTPOOUT2 is a container event used by the JD Edwards EnterpriseOne system that notifies third-party systems when purchase order information changes.
| Event Type | Event Description | Event Category | Event Aggregate | Product Code |
|---|---|---|---|---|
| RTPOOUT2 | Purchase Order Version 2 | RTE | Container
Contains events for:
|
H43 |
Conceptual Approach
A new purchase order creates a new record in the Purchase Order Header table (F4301) and the Purchase Order Detail table (F4311). It also creates a new record in Purchase Order Multiple Accounts (F4316) file multiple account records are associated with the purchase order. A real-time notification is triggered whenever there is an insert in these tables. Also, this event is triggered whenever an exiting purchase order is updated and there is an update to the Purchase Order Header and Purchase Order Detail tables.
Objects that Can Initiate the Event
These objects can initiate the RTPOOUT2 event, and the single events contained within the event:
N4900570 - Update F4211 and F49211 with Shipment Number
N4900640 - F4215 UnApprove Shipment
N4900330 - F4215 Approve Shipment
B4300250 - Release Held Order
B4300330 - Update PO Next Status
B4302150 - Purchase Order Real Time Wrapper Function 0
B4302151 - Purchase Order Real Time Wrapper Function 1
B4302160 - Purchase Order External Publish Function
XT4311Z1 - Purchase Order Entry
XT4312Z1 - Purchase Order Receipts
P4310 - Purchase Orders
P4312 - PO Receipts
P4314 - Voucher match
P43360 - Release Open Quotations
R00993 - Create F43199 commitment Audit Trail
R11843 - Load Domestic currency codes – Procurement
R43500 – Purchase Order Print
R43510 – Purchase Receiver Print
R44H6008 – Print Purchase Order
R47021 – EDI Inbound P.O. Acknowledgement
R47132 – EDI Purchase Order Change Extraction
R47141 - EDI Inbound P.O. Change Acknowledgment
Special Setup
To activate the RTPOOUT2 event, these three important areas are required for data setup:
The Suppliers Correspondence Method (F0401.CRMD, sometimes called Send Method) must be set to 5.
The Document Type of the purchase order must be set up to publish externally. Use the P40040 application to inquire on a document type and select the publish externally check box on the Purchasing tab of the Document Type Revisions form.
Currently all procurement integrations that need processing options use the processing options for P43XPI-ZJDE0001. This event uses the first two processing options on the Order Statuses tab. With these options you can set the range of allowed order statuses that can be published externally. Order Status 999 is valid outside of the dictated range. The canonical has a grouping titled Miscellaneous, which is inside the Header grouping. Within this grouping there is an element named ExternalEvent. This element is set to 1 if these three conditions are met when the purchase order is being processed.
RTPOHDR2 is used by the JD Edwards EnterpriseOne system to notify third-party systems about purchase order changes.
| Event Type | Event Description | Event Category | Event Aggregate | Product Code | Data Structure | Event Relationship |
|---|---|---|---|---|---|---|
| RTPOHDR2 | PO Header Version 2 | RTE | Single | H43 | D4302471A: Purchase Order Header | Included in container event RTPOOUT. |
Conceptual Approach
This real-time event is contained in the RTPOOUT2 event and is triggered whenever that event is triggered. The RTPOHDR2 event contains information from the Purchase Order Header table (F4301).
RTPODTL2 is used by the JD Edwards EnterpriseOne system to notify third-party systems about purchase order changes.
| Event Type | Event Description | Event Category | Event Aggregate | Product Code | Data Structure | Event Relationship |
|---|---|---|---|---|---|---|
| RTPODTL2 | PO Detail Version 2 | RTE | Single | H43 | D4302471B: Purchase Order Detail | Included in container event RTPOOUT2. |
Conceptual Approach
This real-time event is contained in the RTPOOUT2 event and is triggered whenever that event is triggered. The RTPODTL2 event contains information from the Purchase Order Detail table (F4311).
RTPOHLDOUT is used by the JD Edwards EnterpriseOne system to notify third-party systems when a purchase order hold is released.
| Event Type | Event Description | Event Category | Event Aggregate | Product Code | Data Structure |
|---|---|---|---|---|---|
| RTPOHLDOUT | PO Hold Status | RTE | Single | 43 | D4302700B: PO Hold Status Real Time Event |
When a held purchase order is released from the Held Order Release application (P43070) in the JD Edwards EnterpriseOne system, the Release Held Order business function (B4300250) is called to removed the order hold code from the Purchase Order Header table (F4301) and the held order is released in the JD Edwards EnterpriseOne system. After the order hold code is removed from the F4301 table, the PO Hold Status Real Time Event Notification business function (B4302700) is called in B4300250 to generate a real-time notification event (PO Hold Status Real Time Event). This event contains purchase order key, PO business unit, and a hold status flag that indicates the held order is released.
You use batch import programs to import data from an external software system into the JD Edwards EnterpriseOne system, where it can then be processed by EnterpriseOne programs.
This table lists and describes the available batch import programs that are associated with the Purchase Orders business object:
You use batch export programs to retrieve and format data from the JD Edwards EnterpriseOne database so that it can be used by an external software system.
This table lists and describes the available batch export programs that are associated with the Purchase Orders business object: