| Description | Query Product Design Version Hierarchy Information |
| Name | ProductEngineeringFoundationProductDesignVersionHierarchyInformationRequestingIn |
| Namespace | http://sap.com/xi/AP/PC/ProductEngineeringFoundation/Global |
| Product | SAP Business ByDesign |
| Process component | Product Engineering |
| Process component namespace | http://sap.com/xi/AP/PC/ProductEngineeringFoundation/Global |
| Deployment unit | Foundation |
| Endpoint Activation | By Communication Arrangement | Operations |
|
| Release Status | Released |
| Technical documentation on the SAP API Business Hub | Query Product Design Version Hierarchy Information |
| General web service documentation | A2X Web Services (SOAP) |
An interface to provide information on product design version hierarchy.
The web service interface II_PEF_PDVH_INF_REQ_IB enables you to connect external applications to your SAP Business ByDesign system and to create and edit accounts and their assigned contacts in your system. The web service interface II_PEF_PDVH_INF_REQ_IB is relevant if your company wants to access and manage business partner data from external applications.
The web service interface II_PEF_PDVH_INF_REQ_IB offers the operation PROVIDE.
Here is a sample XML for the webservice request:
<n0:ProductDesignVersionHierarchyByElementsQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <MessageHeader> <CreationDateTime>2012-08-07T03:55:58.4227220Z</CreationDateTime> <SenderBusinessSystemID>PS01</SenderBusinessSystemID> <RecipientBusinessSystemID>AGP_1000</RecipientBusinessSystemID> <BusinessScope> <TypeCode listID="" listVersionID="" listAgencyID="" listAgencySchemeID="" listAgencySchemeAgencyID="">3</TypeCode> <ID schemeID="" schemeAgencyID="">229</ID> </BusinessScope> </MessageHeader> <ProductDesignVersionHierarchySelectionByElements> <SelectionByProductDesignVersionHierarchyElements> <ProductDesignID schemeID="" schemeVersionID="" schemeAgencyID="">KAR_050712_002_MSG_1</ProductDesignID> <ProductDesignVersionID>1</ProductDesignVersionID> <MaximumHierarchyLevelOrdinalNumberValue>3548</MaximumHierarchyLevelOrdinalNumberValue> </SelectionByProductDesignVersionHierarchyElements> <RequestedDetailLevel MaximumExplosionRequiredIndicator="true" RetrieveAttachmentDataIndicator="true" RetrieveTextCollectionIndicator="true" RetrieveProductAssignmentIndicator="true" RetrieveProductionBillOfMaterialVariantHandoverIndicator="true"> <LanguageCode>EN</LanguageCode> </RequestedDetailLevel> </ProductDesignVersionHierarchySelectionByElements> </n0:ProductDesignVersionHierarchyByElementsQuery_sync>
Creation of Product Design:
For getting information on the product design version hierarchy , the product design and its version must be created first.
The structure of the response message consists of four parts:
Message Header
PDVH (Product Design Version Hierarchy) that contains the basic information about the product design version hierarchy
Product Design that contains information about the product design
Log that contains system messages including errors, warnings, and information messages raised by the system during processing of the web service request
- <nm:ProductDesignVersionHierarchyByElementsResponse_sync xmlns:nm="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:ASL:/1SAI/TASA370712C309D3E9CDAFA:804"> - <MessageHeader> <ID>00163E0286381ED1B88DB2773B5F4CE4</ID> <CreationDateTime>2012-08-07T08:55:03.772556Z</CreationDateTime> </MessageHeader> - <ProductDesignVersionHierarchy> <UUID>00163e02-8638-1ed1-b88d-b2773b5bcce4</UUID> <ProductDesignVersionUUID>00163e02-870c-1ee1-b888-79713ef8cd25</ProductDesignVersionUUID> <ProductDesignID>KAR_050712_002_MSG_1</ProductDesignID> <ProductDesignVersionID>1</ProductDesignVersionID> <EngineeringDesignBusinessSystemID>CAD1</EngineeringDesignBusinessSystemID> <EngineeringDesignInternalID>KAR_050712_002_MSG_1</EngineeringDesignInternalID> <EngineeringDesignVersionInternalID>VersA</EngineeringDesignVersionInternalID> - <Component> <UUID>00163e02-8638-1ed1-b88d-b2773b5bece4</UUID> <ProductDesignUUID>00163e02-870c-1ee1-b888-79713ef88d25</ProductDesignUUID> <ProductDesignVersionUUID>00163e02-870c-1ee1-b888-79713ef8cd25</ProductDesignVersionUUID> <Quantity unitCode="EA">1.0</Quantity> </Component> - <Component> <UUID>00163e02-8638-1ed1-b88d-b2773b5c0ce4</UUID> <ParentComponentUUID>00163e02-8638-1ed1-b88d-b2773b5bece4</ParentComponentUUID> <Quantity unitCode="EA">2.0</Quantity> <ProductDesignVersionComponentID>30</ProductDesignVersionComponentID> </Component> - <Component> <UUID>00163e02-8638-1ed1-b88d-b2773b5c2ce4</UUID> <ParentComponentUUID>00163e02-8638-1ed1-b88d-b2773b5bece4</ParentComponentUUID> <Quantity unitCode="EA">2.0</Quantity> <ProductDesignVersionComponentID>20</ProductDesignVersionComponentID> </Component> - <Component> <UUID>00163e02-8638-1ed1-b88d-b2773b5c4ce4</UUID> <ParentComponentUUID>00163e02-8638-1ed1-b88d-b2773b5bece4</ParentComponentUUID> <Quantity unitCode="EA">2.0</Quantity> <ProductDesignVersionComponentID>10</ProductDesignVersionComponentID> </Component> <Log /> </ProductDesignVersionHierarchy> - <ProductDesign> <UUID>00163e02-870c-1ee1-b888-79713ef88d25</UUID> <ID>KAR_050712_002_MSG_1</ID> <CategoryCode>1</CategoryCode> <CategoryName>Mechanics</CategoryName> - <EngineeringDesignIdentification> <EngineeringDesignBusinessSystemID>CAD1</EngineeringDesignBusinessSystemID> <EngineeringDesignBusinessSystemName>MyCADSystem</EngineeringDesignBusinessSystemName> <EngineeringDesignID>KAR_050712_002_MSG_1</EngineeringDesignID> <EngineeringDesignInternalID>KAR_050712_002_MSG_1</EngineeringDesignInternalID> </EngineeringDesignIdentification> <MostRecentlyCreatedVersionUUID>00163e02-870c-1ee1-b888-79713ef8cd25</MostRecentlyCreatedVersionUUID> - <SystemAdministrativeData> <CreationDateTime>2012-08-07T03:55:58.422722Z</CreationDateTime> <CreationIdentityUUID>00163e02-870c-1ee1-9ce8-486c317665e6</CreationIdentityUUID> <LastChangeDateTime>2012-08-07T03:55:58.422722Z</LastChangeDateTime> <LastChangeIdentityUUID>00163e02-870c-1ee1-9ce8-486c317665e6</LastChangeIdentityUUID> </SystemAdministrativeData> - <CreationIdentity> <PersonNameGivenName /> <PersonNameFamilyName /> </CreationIdentity> - <Description> <Description languageCode="EN">KAR_050712_002_MSG_1 -- Top Level Design</Description> </Description> - <LastChangeIdentity> <PersonNameGivenName /> <PersonNameFamilyName /> </LastChangeIdentity> - <Version> <UUID>00163e02-870c-1ee1-b888-79713ef8cd25</UUID> <ID>1</ID> <Name>VersA</Name> - <EngineeringDesignVersionIdentification> <EngineeringDesignVersionID>VersA</EngineeringDesignVersionID> <EngineeringDesignVersionInternalID>VersA</EngineeringDesignVersionInternalID> </EngineeringDesignVersionIdentification> <AssemblyIndicator>true</AssemblyIndicator> <BaseQuantity unitCode="EA">1.0</BaseQuantity> <BaseQuantityTypeCode>EA</BaseQuantityTypeCode> <BaseQuantityTypeName>each</BaseQuantityTypeName> <EngineeringDesignVersionStatusName>Released by Engineering department</EngineeringDesignVersionStatusName> <EngineeringDesignVersionReleaseDate>2010-03-01</EngineeringDesignVersionReleaseDate> <EngineeringDesignVersionResponsibleEngineerPersonGivenName>Erin</EngineeringDesignVersionResponsibleEngineerPersonGivenName> <EngineeringDesignVersionResponsibleEngineerPersonFamilyName>Eycken</EngineeringDesignVersionResponsibleEngineerPersonFamilyName> <EngineeringDesignVersionPrimaryViewableCreationDateTime>2010-03-01T12:33:00Z</EngineeringDesignVersionPrimaryViewableCreationDateTime> <ApplicationLogUUID>00163e02-870c-1ee1-b888-79713efaad25</ApplicationLogUUID> <EngineeringDesignVersionCreationDateTime>2010-03-01T12:33:00Z</EngineeringDesignVersionCreationDateTime> <EngineeringDesignVersionLastChangeDateTime>2010-03-01T17:12:44Z</EngineeringDesignVersionLastChangeDateTime> - <SystemAdministrativeData> <CreationDateTime>2012-08-07T03:55:58.422722Z</CreationDateTime> <CreationIdentityUUID>00163e02-870c-1ee1-9ce8-486c317665e6</CreationIdentityUUID> <LastChangeDateTime>2012-08-07T03:55:58.422722Z</LastChangeDateTime> <LastChangeIdentityUUID>00163e02-870c-1ee1-9ce8-486c317665e6</LastChangeIdentityUUID> </SystemAdministrativeData> - <Status> <LifeCycleStatusCode>1</LifeCycleStatusCode> <LifeCycleStatusName>In Preparation</LifeCycleStatusName> <ObsolescenceStatusCode>1</ObsolescenceStatusCode> <ObsolescenceStatusName>Not Obsolete</ObsolescenceStatusName> <BlockingStatusCode>1</BlockingStatusCode> <BlockingStatusName>Not Blocked</BlockingStatusName> <ReviewProcessingStatusCode>1</ReviewProcessingStatusCode> <ReviewProcessingStatusName>Not Started</ReviewProcessingStatusName> <ActivationStatusCode>2</ActivationStatusCode> <ActivationStatusName>Inactive</ActivationStatusName> <EngineeringDesignVersionReleaseStatusCode>3</EngineeringDesignVersionReleaseStatusCode> <EngineeringDesignVersionReleaseStatusName>Released</EngineeringDesignVersionReleaseStatusName> <ConsistencyStatusCode>2</ConsistencyStatusCode> <ConsistencyStatusName>Inconsistent</ConsistencyStatusName> </Status> - <Component> <UUID>00163e02-870c-1ee1-b888-79713ef8ed25</UUID> <ProductDesignComponentID>10</ProductDesignComponentID> <BaseQuantity unitCode="EA">2.0</BaseQuantity> <BaseQuantityTypeCode>EA</BaseQuantityTypeCode> <BaseQuantityTypeName /> <ProductDesignUUID /> <ProductDesignID /> - <ProductDesignEngineeringDesignIdentification> <EngineeringDesignBusinessSystemID>CAD1</EngineeringDesignBusinessSystemID> <EngineeringDesignBusinessSystemName>MyCADSystem</EngineeringDesignBusinessSystemName> <EngineeringDesignID>KAR_050712_002_MSG_11</EngineeringDesignID> <EngineeringDesignInternalID>KAR_050712_002_MSG_11</EngineeringDesignInternalID> </ProductDesignEngineeringDesignIdentification> <ProductDesignVersionUUID /> <ProductDesignVersionID /> - <ProductDesignVersionEngineeringDesignVersionIdentification> <EngineeringDesignVersionID>VersA</EngineeringDesignVersionID> <EngineeringDesignVersionInternalID>VersA</EngineeringDesignVersionInternalID> </ProductDesignVersionEngineeringDesignVersionIdentification> </Component> - <Component> <UUID>00163e02-870c-1ee1-b888-79713ef90d25</UUID> <ProductDesignComponentID>20</ProductDesignComponentID> <BaseQuantity unitCode="EA">2.0</BaseQuantity> <BaseQuantityTypeCode>EA</BaseQuantityTypeCode> <BaseQuantityTypeName /> <ProductDesignUUID /> <ProductDesignID /> - <ProductDesignEngineeringDesignIdentification> <EngineeringDesignBusinessSystemID>CAD1</EngineeringDesignBusinessSystemID> <EngineeringDesignBusinessSystemName>MyCADSystem</EngineeringDesignBusinessSystemName> <EngineeringDesignID>KAR_050712_002_MSG_12</EngineeringDesignID> <EngineeringDesignInternalID>KAR_050712_002_MSG_12</EngineeringDesignInternalID> </ProductDesignEngineeringDesignIdentification> <ProductDesignVersionUUID /> <ProductDesignVersionID /> - <ProductDesignVersionEngineeringDesignVersionIdentification> <EngineeringDesignVersionID>VersA</EngineeringDesignVersionID> <EngineeringDesignVersionInternalID>VersA</EngineeringDesignVersionInternalID> </ProductDesignVersionEngineeringDesignVersionIdentification> </Component> - <Component> <UUID>00163e02-870c-1ee1-b888-79713ef92d25</UUID> <ProductDesignComponentID>30</ProductDesignComponentID> <BaseQuantity unitCode="EA">2.0</BaseQuantity> <BaseQuantityTypeCode>EA</BaseQuantityTypeCode> <BaseQuantityTypeName /> <ProductDesignUUID /> <ProductDesignID /> - <ProductDesignEngineeringDesignIdentification> <EngineeringDesignBusinessSystemID>CAD1</EngineeringDesignBusinessSystemID> <EngineeringDesignBusinessSystemName>MyCADSystem</EngineeringDesignBusinessSystemName> <EngineeringDesignID>KAR_050712_002_MSG_13</EngineeringDesignID> <EngineeringDesignInternalID>KAR_050712_002_MSG_13</EngineeringDesignInternalID> </ProductDesignEngineeringDesignIdentification> <ProductDesignVersionUUID /> <ProductDesignVersionID /> - <ProductDesignVersionEngineeringDesignVersionIdentification> <EngineeringDesignVersionID>VersA</EngineeringDesignVersionID> <EngineeringDesignVersionInternalID>VersA</EngineeringDesignVersionInternalID> </ProductDesignVersionEngineeringDesignVersionIdentification> </Component> - <Description> <Description languageCode="EN">First version</Description> </Description> </Version> </ProductDesign> <Log /> </nm:ProductDesignVersionHierarchyByElementsResponse_sync>
You can find general information about Web services, their structure and consumption in the Web Services documentation. Please open the Web Services document in a new window.
| Description | Find product design version hierarchy information |
| Name | Provide |
| Synchronous | yes |
| Release Status | Released |
To provide information about product design version hierarchy.
The response message of the operation PROVIDE provides basic information about the product design version hierarchy and the component product designs. Log that contains system messages including errors, warnings, and information messages raised by the system during processing of the web service request
The following table shows the list of attributes for the request message header:
| Parameters | Remarks |
|---|---|
| ID | Identification |
| UUID | Universally Unique Identification |
| ReferenceID | Reference Identification |
| ReferenceUUID | Reference UUID |
| CreationDateTime | Global Date Time |
| TestDataIndicator | Indicates if the business data contained in the message is test data or not |
| ReconciliationIndicator | Indicates if the message is a reconciliation message or not. This element is optional |
| SenderBusinessSystemID | Identifier of the business system that sent a Business Document |
| RecipientBusinessSystemID | Identifier of the business system that receives a Business Document |
| SenderParty | Party that creates and sends the Business Document at business application level |
| RecipientParty | Party that receives and processes the Business Document at business application level |
The following table shows the list of attributes for the PDVHSelectionByElements node:
| Parameters | Remarks |
|---|---|
| SelByPDVHEle | Selection By Product Design Version Hierarchy Elements |
| RequestedDetailLevel | Requested Detail Level |
The following table shows the list of attributes for the SelectionByProductDesignVersionHierarchyElements node:
| Parameters | Remarks |
|---|---|
| ProductDesignVersionUUID | Product Design Version UUID |
| ProductDesignID | Product Design ID |
| ProductDesignVersionID | Product Design Version ID |
| EngDsgnBusSystID | Engineering Design Business System ID |
| EngDsgnIntID | Engineering Design Internal ID |
| EngDsgnVersIntID | Engineering Design Version Internal ID |
| Quantity | Quantity |
| ExplosionDate | Date |
| MaxHierarchyLevel | Maximum Hierarchy Level Ordinal Number Value |
| VersionDeterminationCode | Version Determination Code |
The following table shows the list of attributes for the RequestedDetailLevel node:
| Parameters | Remarks |
|---|---|
| MaxExplosionRequiredInd | Used to indicate the Maximum Explosion of Product Design Version Hierarchy |
| RetrieveAttachmentDataInd | Used to indicate whether the Attachment data should be in the response view or not |
| RetrieveTextCollectionInd | Used to indicate whether the Text Collections should be in response view or not |
| RetrieveProductionBOMInd | Used to indicate whether the ProductionBillOfMaterialVariantHandover node details in Product Design business object should be in the response view or not |
| LanguageCode | If specified, the description is retrieved based on the Language Code, otherwise Logon Language Code is used |
The response contains the information about the product design version hierarchy and log items.
The following table shows the list of attributes for the PDVH node:
| Parameters | Remarks |
|---|---|
| UUID | Product Design UUID |
| PDVersionUUID | Product Design Version UUID |
| ProductDesignID | Product Design ID |
| ProductDesignVersionID | Product Design Version ID |
| EngDsgnBusSystID | Engineering Design Business System ID |
| EngDsgnVersIntID | Engineering Design Version Internal ID |
| Component | Component |
| Log | Log |
The following table shows the list of attributes for the ProductDesign node:
| Parameters | Remarks |
|---|---|
| UUID | UUID |
| ID | Product Design ID |
| CategoryCode | A coded representation of a Product Design Category |
| CategoryName | Category Name |
| RespEmployeeUUID | Responsible Employee UUID |
| RespEmployeeID | Responsible Employee ID |
| EngDsgnIdn | Engineering Design Identification |
| MostRecentlyCRVersUUID | Most Recently Created Version UUID |
| SystemAdministrativeData | System Administrative Data |
| CreationIdentity | Creation Identity |
| Description | Description |
| LastChangeIdentity | Last Change Identity |
| PBOMVarHO | Production Bill Of Material Variant Handover |
| RespEmployee | Responsible Employee |
| Version | PDVH version |
| AttachmentFolder | Access Attachment Folder |
| TextCollection | Access Text Collection |
The following table shows the list of attributes for the CreationIdentity node:
| Parameters | Remarks |
|---|---|
| PersonNameGivenName | Person's First Name |
| PersonNameFamilyName | Person's Last Name |
The following table shows the list of attributes for the Version node:
| Parameters | Remarks |
|---|---|
| UUID | Version UUID |
| ID | Version ID |
| Name | Version Name |
| EngDsgnVersIdn | Engineering Design Version Identification |
| ManuallyCreatedInd | Manually Created Indicator |
| AssemblyInd | Assembly Indicator |
| PrdcssrVersUUID | Predecessor Version UUID |
| PrdcssrVersEngDsgnVersIdn | Predecessor Version Engineering Design Version Identification |
| BaseQuantity | Base Quantity |
| BaseQuantityTypeCode | Base Quantity Type Code |
| BaseQuantityTypeName | Base Quantity Type Name |
| ProposedProcurementMethodCode | Proposed Procurement Method Code |
| ProposedProcurementMethodName | Proposed Procurement Method Name |
| ValidityStartDate | Validity Start Date |
| ActivationDate | Activation Date |
| ActivationTime | Activation Time |
| EngDsgnVersStatusName | Engineering Design Version Status Name |
| EngDsgnVersRelDate | Engineering Design Version Release Date |
| EngDsgnChangeOrderID | Engineering Design Change Order ID |
| ApplicationLogUUID | Application Log UUID |
| SystemAdministrativeData | System Administrative Data |
| Status | Status |
The following table shows the list of attributes for the Status node:
| Parameters | Remarks |
|---|---|
| LifeCycleStatus | A coded representation of the Life Cycle Status of a Version of a Product Design |
| ObsolescenceStatus | A coded representation of an Obsolescence Status |
| BlockingStatus | Can be used in cases where no partial block is possible |
| ReviewProcessingStatusCode | A coded representation of a Processing Status |
| ActivationStatusCode | Can be used in cases where no partial activation is possible |
| EngDsgnVersRelStatus | A coded representation of the Status of the Release of an Engineering Design Version |
| ConsistencyStatus | A coded representation of the Consistency Status of an object |
The Product Design can be created or updated by the asynchronous service Product Design Replication Request. In most cases, there will be a corresponding object in the engineering system. In the service definition and in this document, the corresponding object of the engineering system is called Engineering Design. In concrete systems, this object would be called differently, for example, Engineering BOM, Assembly, Part, or Item.
The logical communication takes place between the objects Engineering Design and Product Design. In SAP Business ByDesign, materials can be assigned to Product Designs, and Product Designs can be converted into Production Bills of Material Variants. Production Bills of Material Variants are not created directly using the inbound interface, but require additional steps on the SAP Business ByDesign side.
An Engineering Design cannot be assigned to more than one Product Design. In addition, one Product Design can refer to only one Engineering Design.
If an Engineering Design is not assigned to a Product Design, this means that the Engineering Design has not been replicated in SAP Business ByDesign. The second Engineering Design is assigned to a Product Design in SAP Business ByDesign. This assignment cannot be changed later, and the Engineering Design cannot be assigned to another Product Design. The last Product Design has no reference to an Engineering Design, which means that this Product Design has been created manually in SAP Business ByDesign.
Besides the mapping between an Engineering Design and a Product Design, there is also the mapping between an Engineering Design Version and a Product Design Version. In existing engineering systems Engineering Design Version may represent a version, a revision or another entity. Once a Product Design Version has been assigned to an Engineering Design Version via the CAD-integration interface, the assignment cannot be changed any longer.
Each Product Design must have at least one version in order to be displayed in the UI. Similar to the mapping between Engineering Design and Product Design, a version of an Engineering Design can be assigned at maximum to one version of a Product Design and vice versa.
Not all versions of an Engineering Design need to be replicated in SAP Business ByDesign. On the other hand, it is possible to manually create a version for a Product Design that refers to an Engineering Design.
Show full documentation
Show full documentation