Send Engineering BOM Service

This service is in the WmOAMFG1227 package and has the following fully-qualified service name: engineering1227.fromOA.engineeringBOM:sendEngineeringBOM.

This service sends to the Integration Server information about the parent, component, and substitutes Engineering Bills of Material items as well as revisions.

Database Scripts

This service uses the following database scripts:

Script	Description
wm_install_from_engbom.sql	Runs the scripts listed below, except the uninstall script.
wm_from_engbom_vw.sql	Creates the following required view components for Engineering Bills of Material outbound transactions: WM_ENG_BOM_BILL_OF_MTLS_VW WM_ENG_BOM_ITEM_REVISIONS_VW WM_ENG_BOM_INVENTORY_COMPS_VW WM_ENG_BOM_SUBSTITUTE_COMPS_VW WM_ENG_BOM_REFERENCE_DESGS_VW WM_ENG_BOM_BILL_OF_MTLS_QRY_VW
wm_from_engbom_trg.sql	Create the following trigger components to be used for writing to the WM_TRACKCHANGES table to indicate a new or updated document: WM_ENG_BOM_BILL_OF_MTL_IUD_TRG WM_ENG_MTL_ITEM_REV_IUD_TRG WM_ENG_BOM_INV_COMPS_IUD_TRG WM_ENG_BOM_SUB_COMPS_IUD_TRG WM_ENG_BOM_REF_DESGS_IUD_TRG
wm_disable_from_engbom.sql	Disables the triggers installed by wm_from_engbom_trg.sql.
wm_enable_from_engbom.sql	Re-enables the triggers installed by wm_from_engbom_trg.sql.
wm_drop_from_engbom.sql	Uninstalls all components created by wm_install_from_engbom.sql.

For more information about using database scripts, see Database Scripts.

Supporting Transaction Definitions

This service was built from the configured services defined in the following transaction definition:

getEngineeringBOMTxn1227.txp

For information about using the transaction definition files to customize this service, see Transaction Definitions.

Flow Control

The main flow sendEngineeringBOM executes as follows:

specifyDefaultSettings specifies the default parameter settings required for service execution. You should change these settings accordingly.
lockTxnCtrl determines whether the sendEngineeringBOM service is ready for execution. That is, it determines whether there is no other instance of this service already in process.
- If lockTxnCtrl service returns False, it means that another instance of this service is already in process. The service exits and waits for next scheduled execution.
- If lockTxnCtrl service returns True, it means that the service is ready to execute, the Engineering BOM row in the control table is locked and updated, and the status is changed to INPROCESS. This prevents any other Engineering BOM service from executing.
getEngineeringBOMTxn queries the Oracle Applications database for any Engineering BOM Transaction to be processed. The number of records returned depends on the parameter value specified in the above map.
processBizDoc is the customizable step that sends the business document to a trading partner. You must customize this step to receive a Success or an Error status of the document transfer. If an error occurs in a particular business document transfer, then the error information is sent back to the calling service (sendEngineeringBOM). The error information passed back should have the document identifiers. If a particular document is transferred successfully to the trading partner, no information needs to be sent back to the calling program (sendEngineeringBOM).
Based on the Debug Mode specified during execution, it either purges or updates the records in the WM_TRACKCHANGES custom table.
- If the Debug Mode is TRUE, then based on the purge criteria, the records in the WM_TRACKCHANGES table are updated, and the PROCESSED_FLAG is set to Y. This ensures that the same set of records is not picked up during next polling interval. The updateTrackChanges service updates the PROCESSED_FLAG in the WM_TRACKCHANGES table to Y so that same information is not picked up again during next polling instance.
- If the Debug Mode is FALSE, then based on the purge criteria, the records in the WM_TRACKCHANGES table are deleted; purgeTrackChanges purges the records from the WM_TRACKCHANGES table.
If an error occurs when transferring the business document, the insertTransferERRInfo service inserts a new record in the WM_TRACKCHANGES table so that same document can be picked up during the next polling interval.
Any document that is created and deleted in between two successive polling operations will not be delivered. Such records are not selected by getEngineeringBOMTxn service; thus they are not updated as processed or purged in the WM_TRACKCHANGES table.
- If the Debug Mode is TRUE, then updateUnqualifiedRec service recognizes such records and updates the corresponding PROCESSED_FLAG to Y.
- If the Debug Mode is FALSE, then purgeUnqualifiedRec service recognizes such records and deletes them from the WM_TRACKCHANGES table.
unlockTxnCtrl releases the lock on the Custom Control table so that next polling instance of sendEngineeringBOM service can begin.
If the document transfer is successful, the flow exits.

For more details on send transactions, see Overview of Send Service Transaction Processing.

Business Document Structure

This service uses the following business document structure:

- 1.0. BOM_ENG_BILL_OF_MTLS
  - 1.1. MTL_ITEM_REVISIONS
  - - 1.2. BOM_ENG_INVENTORY_COMPS
    - 1.2.1. BOM_ENG_SUB_COMPS
    - 1.2.2. BOM_ENG_REF_DESGS

1.0 BOM_ENG_BILL_OF_MTLS

Document Field	Oracle Applications Table/View Name	Column Name	Description
WEB_ TRANSACTION_ID
DOCUMENT_ TYPE			ENGBOM will be populated in this field.
DOCUMENT_ STATUS			UPDATE or INSERT will be populated in this field.
BILL_ SEQUENCE_ID	BOM_BILL_ OF_MATERIALS	BILL_ SEQUENCE_ID	Unique identifier for bill.
ITEM_NUMBER	MTL_SYSTEM_ ITEMS_B_KFV	CONCATENATED_ SEGMENTS	Segmented item number.
ORGANIZATION_ NAME	HR_ALL_ ORGANIZATION_ UNITS	NAME
COMMON_ ITEM_ NUMBER	MTL_SYSTEM_ ITEMS_B_KFV	CONCATENATED_ SEGMENTS	Concatenated segments for the common bill item.
COMMON_ ORG_ NAME	HR_ALL_ ORGANIZATI ON_UNITS	NAME	Organization name for the common bill.
ALTERNATE_ BOM_DESIGNATOR	BOM_BILL_ OF_MATERIALS	ALTERNATE_ BOM_DESIGNATOR	Alternate Bill of Materials designator code.
SPECIFIC_ ASSEMBLY_ COMMENT	BOM_BILL_ OF_MATERIALS	SPECIFIC_ ASSEMBLY_COMMENT	Specific Bill of Materials comment.
PENDING_ FROM_ECN	BOM_BILL_ OF_MATERIALS	PENDING_ FROM_ECN	Engineering change notice that created this Bill of Materials.
ASSEMBLY_TYPE	BOM_BILL_ OF_MATERIALS	ASSEMBLY_TYPE
DEMAND_ SOURCE_LINE			Not used for Bills of Material outbound transactions.
SET_ID			Not used for Bills of Material outbound transactions.
DEMAND_ SOURCE_TYPE			Not used for Bills of Material outbound transactions.
DEMAND_SOURCE_ HEADER_ID			Not used for Bills of Material outbound transactions.
NEXT_EXPLODE_ DATE	BOM_BILL_ OF_MATERIALS	NEXT_EXPLODE_ DATE	Next date when pre- explosion will be refreshed.
TRANSACTION_ TYPE			Not used for Bills of Material outbound transactions.
UOM	MTL_UNITS_ OF_MEASURE_TL	UNIT_OF_MEASURE	Units of measure.
REVISION			Not used for Bills of Material outbound transactions.
IMPLEMENTATION_ DATE	BOM_BILL_ OF_MATERIALS	IMPLEMENTATION_ DATE	Implementation date.

1.1 MTL_ITEM_REVISIONS

Document Field	Oracle Applications Table/View Name	Column Name	Description
BILL_ SEQUENCE_ID	BOM_ INVENT ORY_ COMPO NENTS	BILL_ SEQUENCE_ID	Unique bill identifier.
ITEM_NUMBER	MTL_ SYSTEM_ ITEMS_B_KFV	CONCATENATED_ SEGMENTS	Segmented item number.
ORGANIZATION_ NAME	HR_ALL_ ORGAN IZATION_ UNITS	NAME
REVISION	MTL_ITEM_ REVISIONS	REVISION	Item revision code.
CHANGE_NOTICE	MTL_ITEM_ REVISIONS	CHANGE_NOTICE	Engineering change order number.
ECN_INITIATION_ DATE	MTL_ITEM_ REVISIONS	ECN_ INITIATION_ DATE	Engineering change order initiation date.
IMPLEMENTATION_ DATE	MTL_ITEM_ REVISIONS	IMPLEMENTATION_ DATE	Engineering change order implementation date.
EFFECTIVITY_DATE	MTL_ITEM_ REVISIONS	EFFECTIVITY_DATE	Revision effective date.
REVISED_ITEM_ SEQUENCE_ID	MTL_ITEM_ REVISIONS	REVISED_ ITEM_ SEQUENCE_ID	Revised item sequence ID.
TRANSACTION_TYPE			Not used for Bills of Material outbound transactions.
REVISION_LABEL	MTL_ITEM_ REVISION	REVISION_LABEL	Revision label. (This field is in the table but not shown in the Designer; it is for future use.)
REVISION_REASON	MTL_ITEM_ REVISION	REVISION_REASON	Revision reason. (This field is in the table but not shown in the Designer; it is for future use.)

1.2 BOM_ENG_INVENTORY_COMPS

Document Field	Oracle Applications Table/View Name	Column Name	Description
COMPONENT_ SEQUENCE_ ID	BOM_ INVENTORY_ COMPONENTS	COMPONENT_ SEQUENCE_ ID	Unique component identifier.
BILL_ SEQUENCE_ ID	BOM_ INVENTORY_ COMPONENTS	BILL_ SEQUENCE_ ID	Unique bill identifier.
ASSEMBLY_ ITEM_NUMBER	MTL_ SYSTEM_ ITEMS_B_ KFV	CONCATENATED_ SEGMENTS	Inventory item number of the assembly.
ALTERNATE_ BOM_ DESIGNATOR	BOM_BILL_ OF_MATERIALS	ALTERNATE_ BOM_ DESIGNATOR	Alternate Bill of Materials designator code.
ORGANIZATION_ NAME	HR_ALL_ ORGANIZATION_ UNITS	NAME
COMPONENT_ ITEM_ NUMBER	MTL_ SYSTEM_ ITEMS_B_ KFV	CONCATENATED_ SEGMENTS
OPERATION_ SEQ_NUM	BOM_ INVENTORY_ COMPONENTS	OPERATION_ SEQ_NUM	Operation sequence number.
EFFECTIVITY_ DATE	BOM_ INVENTORY_ COMPONENTS	EFFECTIVITY_ DATE	Effective date.
LOCATION_NAME	MTL_ITEM_ LOCATIONS	DESCRIPTION	Supply locator name.
SUBSTITUTE_ COMPONENT_ NUMBER			Not used for Bills of Material outbound transactions.
ITEM_NUM	BOM_ INVENTORY_ COMPONENTS	ITEM_NUM	Item sequence in Bill of Materials structure.
COMPONENT_ QUANTITY	BOM_ INVENTORY_ COMPONENTS	COMPONENT_ QUANTITY	Quantity of component in Bill of Materials.
COMPONENT_ YIELD_FACTOR	BOM_ INVENTORY_ COMPONENTS	COMPONENT_ YIELD_FACTOR	Multiply this factor with component quantity to find required component quantity.
COMPONENT_ REMARKS	BOM_ INVENTORY_ COMPONENTS	COMPONENT_ REMARKS	Component remarks.
CHANGE_NOTICE	BOM_ INVENTORY_ COMPONENTS	CHANGE_NOTICE	Engineering change order number.
IMPLEMENTATION_ DATE	BOM_ INVENTORY_ COMPONENTS	IMPLEMENTATION_ DATE	Date the engineering change order was implemented.
DISABLE_DATE	BOM_ INVENTORY_ COMPONENTS	DISABLE_DATE	Disable date.
PLANNING_ FACTOR	BOM_ INVENTORY_ COMPONENTS	PLANNING_ FACTOR	Multiply this factor with component quantity to find required planning quantity.
QUANTITY_ RELATED	BOM_ INVENTORY_ COMPONENTS	QUANTITY_ RELATED	Indicates whether this component has quantity- related reference designators.
SO_BASIS	BOM_ INVENTORY_ COMPONENTS	SO_BASIS	Oracle Order Management uses this quantity basis to determine how many units of the component to put on an order.
OPTIONAL	BOM_ INVENTORY_ COMPONENTS	OPTIONAL	Indicates if component is optional on a bill.
MUTUALLY_ EXCLUSIVE_ OPTIONS	BOM_ INVENTORY_ COMPONENTS	MUTUALLY_ EXCLUSIVE_ OPTIONS	Indicates if one or more children of component can be picked when taking an order.
INCLUDE_IN_ COST_ ROLLUP	BOM_ INVENTORY_ COMPONENTS	INCLUDE_IN_ COST_ ROLLUP	Indicates whether to use this component when rolling up costs.
CHECK_ATP	BOM_ INVENTORY_ COMPONENTS	CHECK_ATP	Indicates whether ATP check is required.
SHIPPING_ ALLOWED	BOM_ INVENTORY_ COMPONENTS	SHIPPING_ ALLOWED	Indicates whether component is allowed to ship.
REQUIRED_ TO_SHIP	BOM_ INVENTORY_ COMPONENTS	REQUIRED_ TO_SHIP	Indicates whether component is required to ship.
REQUIRED_ FOR_REVENUE	BOM_ INVENTORY_ COMPONENTS	REQUIRED_ FOR_REVENUE	Indicates whether component is required for revenue.
INCLUDE_ON_ SHIP_DOCS	BOM_ INVENTORY_ COMPONENTS	INCLUDE_ON_ SHIP_DOCS	Indicates whether component is displayed on shipping documents.
LOW_QUANTITY	BOM_ INVENTORY_ COMPONENTS	LOW_QUANTITY	Minimum quantity allowed on an order.
HIGH_QUANTITY	BOM_ INVENTORY_ COMPONENTS	HIGH_QUANTITY	Maximum quantity allowed on an order.
ACD_TYPE	BOM_ INVENTORY_ COMPONENTS	ACD_TYPE	Add, change, or disable the code for a component on an engineering change order.
REVISED_ ITEM_NUMBER	MTL_ SYSTEM_ ITEMS_B_ KFV	CONCATENATED_ SEGMENTS
REVISION	MTL_ITEM_ REVISIONS	REVISION
OLD_ OPERATION_ SEQ_NUM	BOM_ INVENTORY_ COMPONENTS	OPERATION_ SEQ_NUM	Operation sequence number in the original component record that an engineering change order affects.
OLD_ EFFECTIVITY_ DATE	BOM_ INVENTORY_ COMPONENTS	EFFECTIVITY_ DATE	Value of effective date in the original component record that an engineering change order affects.
WIP_SUPPLY_ TYPE	BOM_ INVENTORY_ COMPONENTS	WIP_SUPPLY_ TYPE	WIP supply type code.
SUPPLY_ SUBINVENTORY	BOM_ INVENTORY_ COMPONENTS	SUPPLY_ SUBINVENTORY
REFERENCE_ DESIGNATOR			Not used for Engineering Bills of Material outbound Transaction.
NEW_ OPERATION_ SEQ_NUM			Not used for Engineering Bills of Material outbound transactions.
NEW_ EFFECTIVITY_ DATE			Not used for Engineering Bills of Material outbound transactions.
BOM_ITEM_TYPE	BOM_ INVENTORY_ COMPONENTS	BOM_ITEM_TYPE	Type of item (de- normalized from BOM Item Type in MTL_SYSTEM_ITEMS).
OPERATION_ LEAD_TIME_ PERCENT	BOM_ INVENTORY_ COMPONENTS	OPERATION_ LEAD_TIME_ PERCENT	Operation offset from first operation in routing.
ASSEMBLY_TYPE	BOM_BILL_ OF_MATERIALS	ASSEMBLY_TYPE	Assembly type of the parent bill.
INTERFACE_ ENTITY_TYPE	BOM_BILL_ OF_MATERIALS	DECODE ( BOM.ASSEMBLY_ TYPE, 1,'BILL', 2, 'ECO', NULL)	Use Bill or ECO.
UOM	MTL_UNITS_ OF_MEASURE_ TL	UNIT_OF_ MEASURE
TRANSACTION_ TYPE			Not used for Engineering BOM outbound transactions.
AUTO_ REQUEST_ MATERIAL	BOM_ INVENTORY_ COMPONENTS	AUTO_ REQUEST_ MATERIAL	Auto request material (Y/N).

1.2.1 BOM_ENG_SUB_COMPS

Document Field	Oracle Applications Table/View Name	Column Name	Description
SUBSTITUTE_ COMP_ NUMBER	MTL_SYSTEM_ ITEMS_B_ KFV	CONCATENATED_ SEGMENTS	Substitute component number.
SUBSTITUTE_ ITEM_ QUANTITY	BOM_ SUBSTITUTE_ COMPONENTS	SUBSTITUTE_ ITEM_ QUANTITY	Substitute component quantity.
ACD_TYPE	BOM_ SUBSTITUTE_ COMPONENTS	ACD_TYPE	Type to indicate add or delete on an engineering change order.
CHANGE_NOTICE	BOM_ SUBSTITUTE_ COMPONENTS	CHANGE_NOTICE	Engineering Change Order (ECO) number.
ORGANIZATION_ NAME	HR_ALL_ ORGANIZATION_ UNITS	NAME
ASSEMBLY_ ITEM_ NUMBER	MTL_SYSTEM_ ITEMS_B_KFV	CONCATENATED_ SEGMENTS	Inventory item number of assembly.
ALTERNATE_ BOM_ DESIGNATOR	BOM_BILL_ OF_MATERIALS	ALTERNATE_ BOM_ DESIGNATOR	Alternate Engineering Bills of Material designator code.
COMPONENT_ ITEM_ NUMBER	MTL_SYSTEM_ ITEMS_B_ KFV	CONCATENATED_ SEGMENTS	Inventory item number of component.
OPERATION_ SEQ_NUM	BOM_ INVENTORY_ COMPONENTS	OPERATION_ SEQ_NUM	Manufacturing operation sequence number.
EFFECTIVITY_ DATE	BOM_ INVENTORY_ COMPONENTS	EFFECTIVITY_ DATE	Effective date.
NEW_SUB_ COMP_ NUMBER			Not used for Engineering BOM outbound transactions.
INTERFACE_ ENTITY_TYPE	BOM_BILL_ OF_MATERIALS	DECODE ( BOM.ASSEMBLY_ TYPE, 1,'BILL', 2, 'ECO', NULL)	Inventory item type.
UOM	MTL_UNITS_ OF_MEASURE_ TL	UNIT_OF_ MEASURE
TRANSACTION_ TYPE			Not used for Engineering BOM outbound transactions.

1.2.2 BOM_ENG_REF_DESGS

Document Field	Oracle Applications Table/View Name	Column Name	Description
COMPONENT_ REFERENCE _ DESIGNATOR	BOM_ REFERENCE_ DESIGNATOR	COMPONENT_ REFERENCE _ DESIGNATOR	Component reference designator.
ORGANIZATION_ NAME	HR_ALL_ ORGANIZATION_ UNITS	NAME
ASSEMBLY_ ITEM_NUMBER	MTL_SYSTEM_ ITEMS_B_KFV	CONCATENATED_ SEGMENTS
ALTERNATE_ BOM_ DESIGNATOR	BOM_BILL_OF_ MATERIALS	ALTERNATE_ BOM_ DESIGNATOR	Alternate Bill of Materials identifier.
COMPONENT_ ITEM_NUMBER	MTL_SYSTEM_ ITEMS_B_KFV	CONCATENATED_ SEGMENTS
OPERATION_ SEQ_NUM	BOM_ INVENTORY_ COMPONENTS	OPERATION_ SEQ_NUM	Manufacturing operation sequence number.
EFFECTIVITY_ DATE	BOM_ INVENTORY_ COMPONENTS	EFFECTIVITY_ DATE	Date when functionality will be enabled.
REF_ DESIGNATOR_ COMMENT	BOM_ REFERENCE_ DESIGNATOR	REF_ DESIGNATOR_ COMMENT	Reference designator comment.
CHANGE_NOTICE	BOM_ REFERENCE_ DESIGNATOR	CHANGE_NOTICE	Engineering change order number.
ACD_TYPE	BOM_ REFERENCE_ DESIGNATORS	ACD_TYPE	Add or delete code from an engineering change order.
NEW_ DESIGNATOR			Not used for Engineering BOM outbound transaction.
INTERFACE_ ENTITY_TYPE	BOM_BILL_ OF_MATERIALS	DECODE ( BOM.ASSEMBLY_ TYPE, 1,'BILL', 2, 'ECO', NULL)	Use Bill or ECO.
TRANSACTION_ TYPE			Not used for Engineering BOM outbound transaction.