The option to map an entity reference is available when the object super type selected for the export is Asset, Classification, Entity, or Product. The only displayed entity reference types for mapping are those that match the selected super type. Publication-to-entity references are not available for output.
For information on selecting an object super type, refer to the following topics:
- For Export Manager, use the Export dropdown as described in the Export Manager - Select Objects topic here.
- For an event-based OIEP, use the object super type dropdown as described in the OIEP - Event-Based - Output Templates Section topic here.
- For a select objects OIEP, use the object super type dropdown as described in the OIEP - Select Objects - Output Templates Section topic here.
For example, consider details of various suppliers of a product, where suppliers are the entity object within STEP. The entity reference mapping would allow you to extract the list of suppliers for a product.
The user interface for the mapping step of the Export Manager tool and the outbound integration endpoint tool are not exactly the same. For Export Manager, mapping is described in the Export Manager - Map Data topic here. For OIEPs, mapping is handled in the Output Templates section under the Format parameter as described in the OIEP - Event-Based - Output Templates Section topic (here) or the OIEP - Select Objects - Output Templates Section topic (here).
For more information about the additional wizard steps, refer to the Creating a Data Export topic (here) or the Creating an Outbound Integration Endpoint topic (here).
After mapping, most output options can be altered using transformations. For more information, refer to the Outbound Map Data - Transform topic here.
Mapping Entity References
- Select the data to be exported for the output tool. For more information, refer to the Data Exchange topic here.
- On the Map Data step, in the left panel, select Entity References to expand the node.
- Select the desired entity reference type.
- In the right panel, click the top-most right arrow to add the selected entity reference type to the export file.
- Apply any transformations, which can change the output without changing the original data. Refer to the Outbound Map Data - Transform topic here.
- Complete any additional mappings and initiate the export.
Results
The output includes the entity reference type name as a header and the ID for each row.
When the object references multiple entities, the entity reference IDs are displayed in a semi-colon separated list.
