Oracle® Supply Chain Management APIs and Open Interfaces

1680 Pages·2012·3.95 MB·English

Oracle® Supply Chain Management APIs and Open
Interfaces
Guide
Release 12
Part No. B40113-02
September 2007
Oracle Supply Chain Management APIs and Open Interfaces Guide, Release 12
Part No. B40113-02
Copyright © 1996, 2007, Oracle. All rights reserved.
Primary Author:     Debani Banerjee
The Programs (which include both the software and documentation) contain proprietary information; they
are provided under a license agreement containing restrictions on use and disclosure and are also protected
by copyright, patent, and other intellectual and industrial property laws. Reverse engineering, disassembly, or
decompilation of the Programs, except to the extent required to obtain interoperability with other
independently created software or as specified by law, is prohibited.
The information contained in this document is subject to change without notice. If you find any problems in
the documentation, please report them to us in writing. This document is not warranted to be error-free.
Except as may be expressly permitted in your license agreement for these Programs, no part of these
Programs may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any
purpose.
If the Programs are delivered to the United States Government or anyone licensing or using the Programs on
behalf of the United States Government, the following notice is applicable:
U.S. GOVERNMENT RIGHTS
Programs, software, databases, and related documentation and technical data delivered to U.S. Government
customers are "commercial computer software" or "commercial technical data" pursuant to the applicable
Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication,
disclosure, modification, and adaptation of the Programs, including documentation and technical data, shall
be subject to the licensing restrictions set forth in the applicable Oracle license agreement, and, to the extent
applicable, the additional rights set forth in FAR 52.227-19, Commercial Computer Software--Restricted
Rights (June 1987). Oracle Corporation, 500 Oracle Parkway, Redwood City, CA 94065.
The Programs are not intended for use in any nuclear, aviation, mass transit, medical, or other inherently
dangerous applications. It shall be the licensee's responsibility to take all appropriate fail-safe, backup,
redundancy and other measures to ensure the safe use of such applications if the Programs are used for such
purposes, and we disclaim liability for any damages caused by such use of the Programs.
The Programs may provide links to Web sites and access to content, products, and services from third parties.
Oracle is not responsible for the availability of, or any content provided on, third-party Web sites. You bear all
risks associated with the use of such content. If you choose to purchase any products or services from a third
party, the relationship is directly between you and the third party. Oracle is not responsible for: (a) the quality
of third-party products or services; or (b) fulfilling any of the terms of the agreement with the third party,
including delivery of products or services and warranty obligations related to purchased products or services.
Oracle is not responsible for any loss or damage of any sort that you may incur from dealing with any third
party.
Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks
of their respective owners.
Contents
Send Us Your Comments
Preface
1 Integrating Your Systems
Overview................................................................................................................................... 1-1
OverviewofOracleSupplyChainManagementAPIsandOpenInterfaces..........................1-1
2 Oracle ASCP and Oracle Global ATP Server Open Interfaces - Part 1
ODSLoadAPIFeatures............................................................................................................ 2-2
FunctionalOverview.................................................................................................................2-6
SettingUptheODSLoadAPI.................................................................................................. 2-7
ParameterDescriptions.............................................................................................................2-7
MSC_ST_ASSIGNMENT_SETS.............................................................................................. 2-7
MSC_ST_ATP_RULES............................................................................................................2-10
MSC_ST_BILL_OF_RESOURCES..........................................................................................2-18
MSC_ST_BIS_BUSINESS_PLANS.........................................................................................2-21
MSC_ST_BIS_PERIODS.........................................................................................................2-24
MSC_ST_BIS_PFMC_MEASURES.........................................................................................2-28
MSC_ST_BIS_TARGETS........................................................................................................2-31
MSC_ST_BIS_TARGET_LEVELS.......................................................................................... 2-37
MSC_ST_BOMS......................................................................................................................2-42
MSC_ST_BOM_COMPONENTS...........................................................................................2-45
MSC_ST_BOR_REQUIREMENTS.........................................................................................2-51
MSC_ST_CALENDAR_DATES..............................................................................................2-56
MSC_ST_CALENDAR_SHIFTS.............................................................................................2-59
    iii
MSC_ST_CAL_WEEK_START_DATES................................................................................ 2-62
MSC_ST_CAL_YEAR_START_DATES.................................................................................2-65
MSC_ST_CATEGORY_SETS................................................................................................. 2-67
MSC_ST_COMPONENT_SUBSTITUTES.............................................................................2-70
MSC_ST_DEMANDS............................................................................................................. 2-73
MSC_ST_DEMAND_CLASSES............................................................................................. 2-83
MSC_ST_DEPARTMENT_RESOURCES...............................................................................2-88
MSC_ST_DESIGNATORS..................................................................................................... 2-96
MSC_ST_INTERORG_SHIP_METHODS...........................................................................2-101
3 Oracle ASCP and Oracle Global ATP Server Open Interfaces - Part 2
MSC_ST_ITEM_CATEGORIES............................................................................................... 3-2
MSC_ST_ITEM_SUPPLIERS....................................................................................................3-5
MSC_ST_LOCATION_ASSOCIATIONS..............................................................................3-10
MSC_ST_NET_RESOURCE_AVAIL......................................................................................3-13
MSC_ST_OPERATION_COMPONENTS..............................................................................3-16
MSC_ST_OPERATION_RESOURCES.................................................................................. 3-19
MSC_ST_OPERATION_RESOURCE_SEQS.........................................................................3-22
MSC_ST_PARAMETERS........................................................................................................3-25
MSC_ST_PARTNER_CONTACTS.........................................................................................3-31
MSC_ST_PERIOD_START_DATES......................................................................................3-34
MSC_ST_PLANNERS.............................................................................................................3-37
MSC_ST_PROCESS_EFFECTIVITY.......................................................................................3-42
MSC_ST_PROJECTS.............................................................................................................. 3-46
MSC_ST_PROJECT_TASKS...................................................................................................3-50
MSC_ST_RESERVATIONS....................................................................................................3-54
MSC_ST_RESOURCE_CHANGES........................................................................................ 3-58
MSC_ST_RESOURCE_GROUPS........................................................................................... 3-61
MSC_ST_RESOURCE_REQUIREMENTS.............................................................................3-66
MSC_ST_RESOURCE_SHIFTS..............................................................................................3-72
MSC_ST_ROUTINGS.............................................................................................................3-74
MSC_ST_ROUTING_OPERATIONS....................................................................................3-79
MSC_ST_SAFETY_STOCKS..................................................................................................3-84
MSC_ST_SALES_ORDERS....................................................................................................3-87
MSC_ST_SHIFT_DATES........................................................................................................3-93
4 Oracle ASCP and Oracle Global ATP Server Open Interfaces - Part 3
MSC_ST_SHIFT_EXCEPTIONS...............................................................................................4-1
MSC_ST_SHIFT_TIMES.......................................................................................................... 4-4
MSC_ST_SIMULATION_SETS............................................................................................... 4-7
iv
MSC_ST_SOURCING_HISTORY............................................................................................4-9
MSC_ST_SOURCING_RULES...............................................................................................4-13
MSC_ST_SR_ASSIGNMENTS...............................................................................................4-16
MSC_ST_SR_RECEIPT_ORG.................................................................................................4-20
MSC_ST_SR_SOURCE_ORG.................................................................................................4-23
MSC_ST_SUB_INVENTORIES..............................................................................................4-28
MSC_ST_SUPPLIER_CAPACITIES.......................................................................................4-31
MSC_ST_SUPPLIES................................................................................................................4-37
MSC_ST_SYSTEM_ITEMS.................................................................................................... 4-56
MSC_ST_TRADING_PARTNERS.........................................................................................4-72
MSC_ST_TRADING_PARTNER_SITES...............................................................................4-80
MSC_ST_UNITS_OF_MEASURE..........................................................................................4-83
MSC_ST_UOM_CLASS_CONVERSIONS............................................................................4-88
MSC_ST_UOM_CONVERSIONS..........................................................................................4-92
5 Oracle Master Scheduling/MRP and Oracle Supply Chain Planning Open
Interfaces and APIs
OpenForecastInterface.............................................................................................................5-2
Validation..................................................................................................................................5-6
ResolvingFailedOpenForecastInterfaceRows......................................................................5-7
OpenMasterScheduleInterface...............................................................................................5-8
Validation................................................................................................................................5-12
ResolvingFailedOpenMasterScheduleInterfaceRows......................................................5-13
OpenForecastEntriesApplicationProgramInterface...........................................................5-14
OpenForecastInterfaceDesignatorTableDescription.........................................................5-17
Validation................................................................................................................................5-19
UsingtheOpenForecastEntriesAPI......................................................................................5-21
SourcingRuleApplicationProgramInterface.......................................................................5-22
SettingUptheSourcingRule/BillofDistributionAPI.........................................................5-24
RecordParameterDescriptions...............................................................................................5-28
ValidationofSourcingRule/BillofDistributionAPI..........................................................5-41
SourcingRuleAssignmentAPIFeatures............................................................................... 5-43
SettingUptheSourcingRuleAssignmentAPI......................................................................5-44
RecordParameterDescriptions...............................................................................................5-47
ValidationofSourcingRuleAssignmentAPI....................................................................... 5-56
6 Bills of Material Open Interfaces
BillofMaterialsAPIOverview................................................................................................ 6-1
UsingtheBillsofMaterialsOpenInterfaces...........................................................................6-2
BillsofMaterialEntityDiagram.............................................................................................6-10
    v
BillofMaterialImportDescription........................................................................................6-12
BillofMaterialParameterDescriptions.................................................................................6-20
BillofMaterialPackageInteraction...................................................................................... 6-39
BillofMaterialImportErrorHandlingandMessaging........................................................6-41
BillofMaterialExportAPI..................................................................................................... 6-51
RoutingAPIOverview............................................................................................................6-55
RoutingImportDescription....................................................................................................6-59
RoutingParameterDescriptions.............................................................................................6-67
LaunchingtheRoutingImport............................................................................................... 6-93
RoutingPackageInteraction..................................................................................................6-98
RoutingImportErrorHandlingandMessaging..................................................................6-100
APIMessaging.......................................................................................................................6-105
7 Cost Management Open Interfaces
PeriodicCostOpenInterface....................................................................................................7-1
SettingUptheInterface............................................................................................................ 7-3
PeriodicCostOpenInterfaceRuntimeOptions.......................................................................7-3
InsertingintothePeriodicCostInterfaceTables.....................................................................7-3
Validation................................................................................................................................7-11
ReviewingFailedRows..........................................................................................................7-15
CostImportInterface.............................................................................................................. 7-18
SettingUptheCostImportInterface......................................................................................7-19
8 Engineering Open Interfaces
Overview................................................................................................................................... 8-1
Features......................................................................................................................................8-2
BusinessObjectAPIs................................................................................................................ 8-6
EntityProcessFlows................................................................................................................8-16
ECOHeaders........................................................................................................................... 8-16
ECORevisions.........................................................................................................................8-18
RevisedItems.......................................................................................................................... 8-20
RevisedComponents...............................................................................................................8-22
ReferenceDesignators.............................................................................................................8-26
SubstituteComponents...........................................................................................................8-28
NewAPIPackages...................................................................................................................8-29
LaunchingtheImport..............................................................................................................8-32
PackageInteraction................................................................................................................. 8-37
ImportErrorHandlingandMessaging.................................................................................. 8-48
APIMessaging.........................................................................................................................8-57
ErrorHandler...........................................................................................................................8-59
vi
9 Oracle Flow Manufacturing Open Interfaces and APIs
FlowScheduleAPI....................................................................................................................9-1
10 Oracle Shop Floor Management Open Interfaces
ImportLotJobsConcurrentProgram..................................................................................... 10-1
LotMoveTransactionsConcurrentProgram........................................................................10-46
ImportWIPLotTransactionsConcurrentProgram..............................................................10-72
InventoryLotTransactionsInterfaceConcurrentProgram...............................................10-150
LotAttributes.......................................................................................................................10-159
11 Oracle Quality Open Interfaces and APIs
CollectionImportInterface.....................................................................................................11-1
CollectionPlanViews...........................................................................................................11-20
OverviewoftheOracleQualityApplicationProgramInterfaces.......................................11-22
CreateSpecificationApplicationProgramInterface............................................................11-26
AddSpecificationElementApplicationProgramInterface.................................................11-32
CompleteSpecificationApplicationProgramInterface......................................................11-36
DeleteSpecificationApplicationProgramInterface........................................................... 11-39
DeleteSpecificationElementApplicationProgramInterface.............................................11-42
CopySpecificationApplicationProgramInterface............................................................. 11-45
UsingtheSpecificationAPIs................................................................................................ 11-49
CreateCollectionPlanApplicationProgramInterface........................................................11-53
AddCollectionPlanElementApplicationProgramInterface.............................................11-57
CompleteCollectionPlanProcessingApplicationProgramInterface................................11-62
DeleteCollectionPlanApplicationProgramInterface........................................................11-65
DeleteCollectionPlanElementApplicationProgramInterface.........................................11-69
CopyCollectionPlanApplicationProgramInterface..........................................................11-72
UsingtheCollectionPlanAPIs.............................................................................................11-76
12 Oracle Work in Process Open Interfaces
OpenMoveTransactionInterface.......................................................................................... 12-1
FunctionalOverview......................................................................................................... 12-2
SettingUptheMoveTransactionInterface........................................................................12-3
LaunchingtheMoveTransactionManager.................................................................12-3
InsertingRecordsintotheWIP_MOVE_TXN_INTERFACETable.............................12-4
ValidatingMoveTransactions...................................................................................12-14
ResolvingFailedRows.............................................................................................. 12-15
OpenResourceTransactionInterface...................................................................................12-16
    vii
FunctionalOverview....................................................................................................... 12-16
SettingUptheResourceTransactionInterface................................................................12-17
LaunchingtheCostManager.................................................................................... 12-17
InsertingRecordsintotheWIP_COST_TXN_INTERFACETable.............................12-17
ValidatingResourceTransactions.............................................................................12-24
ResolvingFailedRows.............................................................................................. 12-25
WorkOrderInterface............................................................................................................12-25
FunctionalOverview....................................................................................................... 12-27
SettingUptheWorkOrderInterface.........................................................................12-29
InsertingRecordsIntotheWorkOrderInterface......................................................12-29
WIP_JOB_SCHEDULE_INTERFACETable..............................................................12-31
WIP_JOB_DTLS_INTERFACETable..................................................................12-58
PrimaryandAlternateResources..............................................................................12-73
ValidatingWorkOrderInterfaceRecords.................................................................12-73
ResolvingFailedRows.............................................................................................. 12-74
13 Oracle Inventory Open Interfaces and APIs
OpenTransactionInterface.....................................................................................................13-2
SettingUptheTransactionInterface................................................................................13-12
InsertingintotheTransactionInterfaceTables................................................................13-14
TransactionLotsInterface................................................................................................13-31
SerialNumbersInterface................................................................................................. 13-44
CST_COMP_SNAP_INTERFACE....................................................................................13-55
Validation........................................................................................................................ 13-56
ResolvingFailedTransactionInterfaceRows..................................................................13-57
TransactionFlowApplicationProgramInterface................................................................13-57
OpenReplenishmentInterface.............................................................................................13-66
InsertingintotheReplenishmentInterfaceTables...........................................................13-67
ReplenishmentHeadersInterfaceTables.........................................................................13-68
Validation........................................................................................................................ 13-74
ViewingFailedTransactions............................................................................................13-75
FixingFailedTransactions...............................................................................................13-76
CycleCountEntriesInterface............................................................................................... 13-76
CycleCountEntriesInterfaceTable.................................................................................13-77
CycleCountInterfaceErrorsTable..................................................................................13-80
TableAdministrationandAuditTrail.............................................................................13-81
CycleCountApplicationProgramInterface........................................................................ 13-82
SettingUptheCycleCountAPI.......................................................................................13-82
ValidationofCycleCountAPI.........................................................................................13-84
KanbanApplicationProgramInterface................................................................................13-85
viii
ValidationofKanbanAPI................................................................................................13-87
LotApplicationProgramInterface....................................................................................... 13-88
SettingUptheLotAPI.....................................................................................................13-88
ValidationofLotAPI.....................................................................................................13-107
MaterialReservationApplicationProgramInterface........................................................13-108
SettingUptheMaterialReservationAPI.......................................................................13-109
ValidationofMaterialReservationAPI.........................................................................13-127
ReservationsManagerApplicationProgramInterface......................................................13-128
SettingUptheReservationsManagerAPI.....................................................................13-128
ValidationofReservationsManagerAPI.......................................................................13-130
SalesOrderApplicationProgramInterface....................................................................... 13-130
SettingUptheSalesOrderAPI......................................................................................13-131
ValidationofSalesOrderAPI........................................................................................13-134
MoveOrderApplicationProgramInterface.......................................................................13-135
SettingUptheMoveOrderAPI.....................................................................................13-136
ValidationofMoveOrderAPI.......................................................................................13-150
MoveOrderAdminAPI......................................................................................................13-151
Line_Details_pub................................................................................................................ 13-158
PickConfirmApplicationProgramInterface.....................................................................13-162
SettingUpthePickConfirmAPI...................................................................................13-162
ValidationofPickConfirmAPI.....................................................................................13-165
PickReleaseInterface.....................................................................................................13-166
QuantityTreeProgramInterface........................................................................................13-167
ProcedureName:UPDATE_QUANTITIES...................................................................13-173
ProcedureName:DO_CHECK......................................................................................13-179
ProcedureName:QUERY_QUANTITIES......................................................................13-181
ValidationofQuantityTreeAPI....................................................................................13-187
MaterialTransactionsApplicationsProgramInterface.....................................................13-187
SettingUpTransactionProcessingAPI......................................................................... 13-187
Inter-CompanyTransactionFlowApplicationProgramInterface....................................13-190
SettingUptheInter-CompanyTransactionFlowAPI...................................................13-191
ValidationofInter-CompanyTransactionFlowAPI.....................................................13-222
SerialNumberPublicApplicationProgramInterface.......................................................13-223
SettingUptheSerialNumberAPI.................................................................................13-223
ValidationofSerialNumber..........................................................................................13-231
UserDefinedSerialGenerationApplicationProgramInterface.......................................13-231
SettingUptheUserDefinedSerialGenerationAPI.......................................................13-231
ValidationofUserDefinedSerialGenerationAPI.........................................................13-234
    ix
14 Oracle Items Open Interfaces and APIs
ItemOpenInterface................................................................................................................ 14-1
SettingUptheItemOpenInterface....................................................................................14-2
ItemOpenInterfaceRun-TimeOptions.............................................................................14-4
InsertingItemInformationintotheItemOpenInterfaceTable.........................................14-5
Validation........................................................................................................................ 14-17
ImportingAdditionalItemDetails.................................................................................. 14-18
ImportingItemCategoryAssignments............................................................................14-22
ItemCategoryAssignmentInterfaceRuntimeOptions...................................................14-22
InsertingItemCategoryInformationintotheItemCategoriesInterfaceTable...............14-23
UpdateExistingItems......................................................................................................14-23
DeterminingBatchSize....................................................................................................14-24
ResolvingFailedInterfaceRows......................................................................................14-25
MultithreadCapability(ParallelRunsoftheItemOpenInterface).................................14-27
CategoryApplicationProgramInterface..............................................................................14-30
ItemCategoryAssignmentAPI............................................................................................ 14-37
CustomerItemandCustomerItemCross-ReferenceOpenInterfaces................................14-41
InterfaceRun-TimeOptions.............................................................................................14-43
CustomerItemOpenInterfaceTable...............................................................................14-44
CustomerItemOpenInterface-DefiningaUniqueCustomerItem...............................14-47
CustomerItemOpenInterface-OtherFields..................................................................14-49
CustomerItemCross-ReferenceInterfaceTable..............................................................14-52
15 Oracle Warehouse Management Open Interfaces and APIs
ComplianceLabelApplicationProgramInterface.................................................................15-1
FunctionalOverview......................................................................................................... 15-2
DetailedDiscussionofParametersRequiredforEachLabelType....................................15-6
OracleWarehouseManagementDeviceIntegrationAPI......................................................15-7
DeviceConfirmationAPI...................................................................................................15-9
LocatorMaintenanceAPI......................................................................................................15-10
CreateLocatorAPI...........................................................................................................15-11
UpdateLocatorAPI.........................................................................................................15-16
CreateLocatorItemTieAPI.............................................................................................15-20
DeleteLocatorAPI...........................................................................................................15-22
ContainerAPI........................................................................................................................15-23
GenerateLPNAPI........................................................................................................... 15-23
CreateLPNAPI............................................................................................................... 15-28
ModifyLPNAPI..............................................................................................................15-32
OracleWarehouseManagementInstallationAPI................................................................15-34
x