SAP API Structures
This appendix provides detailed structures of the SAP APIs used in the followingWindchill ESI functions. These APIs are listed in the order in which they are invoked for each of these functions:
• Create Part
• Change Part
• Create BOM
• Change BOM
• Create and Change Routings
• Create Document
• Change Document
• Create Change Notices (CNs)
• Create Standard Operation
• Change Standard Operation
• Check Standard Operation
• Allocate Control Characteristic (MIC) to Operation
• Allocate Control Characteristic (MIC) to Part (Material)
Windchill ESI assumes that your distribution target systems provide these APIs and they are characterized as described here. It also assumes these APIs accept the input described for each of the fields and do not require any additional fields to be populated with data.
 |
Windchill ESI may not work as designed unless any differences between these assumptions and your distribution targets are resolved through configuration or customization of Windchill ESI or of your production system or both.
|
The tables for each API list all of the data that is required to complete all the functions within the supported version of your production system. The actual data passed in each function would vary depending on the desired scenario and the global variable settings in theWindchill ESI EAI software components. Each of the following tables lists the types of data.
|
Type of Data
|
Description
|
|---|---|
|
Windchill Attribute Name
|
TheWindchill PDMLink attribute name. If listed, indicates the data exists in Windchill PDMLink.
|
|
API Segment
|
The API segment for which data is required.
|
|
Interface Table
|
The Interface Table for which data is required
|
|
API Field
|
The field in the API segment for which data is required.
|
|
API Field Description
|
A brief description of the API field.
|
|
Value if Default
|
The out-of-the-box (default) value that is set for the attribute by the EAI software components.
|
|
Source
|
The source of the values for each attribute. Possible values are:
Windchill Attribute is sent from Windchill PDMLink.
Default Attribute does not reside inWindchill PDMLink and is populated from a default value configuration file within the EAI software components. See Value (if Default used) column for the default value.
|
|
Transform
|
The transformations, if any, that need to be done by the EAI software components on data sent fromWindchill PDMLink to the distribution target. Includes one of the following values:
Cross Reference
The attribute value should be mapped to an equivalent production system value.
Substring
The attribute value should be truncated to remove extraneous information.
N/A
The attribute value does not need extra processing by the EAI software components; it can be sent directly to your production system as it has been received from Windchill PDMLink.
|