By configuring the PDX Outbound Integration Endpoint (OIEP), users are able to export metadata attributes on assets that are referenced by a product that is configured to be (or has already been) exported to PDX.
As shown in the graphic below, the asset 'Aspen Peaks,' of type 'Product Image,' is being referenced by the product 'Body Cleanse Soap - Aspen Peaks.' This topic will cover how the metadata for an asset referenced by a product is delivered to PDX.
For more information regarding linking assets to products, refer to the Linking Assets to Products topic in the Asset Maintenance documentation here.
Configuring the PDX Outbound Integration Endpoint for Exporting Asset Metadata
To export asset metadata referenced by a product in PDX, the PDX OIEP must be configured. In addition to this configuration, there is also an option to include specific metadata attributes of the asset that can be used to trigger the endpoint to be invoked. For information regarding enabling and invoking an endpoint, refer to the Running an Outbound Integration Endpoint topic in the Outbound Integration Endpoints documentation here. For information regarding event-based triggering definitions, refer to the OIEP - Event-Based - Event Triggering Definitions Tab topic in the Outbound Integration Endpoints documentation here.
As shown below, the 'Product Image' must be included as an Object-Eventtype for metadata of the asset to be exported to PDX. The 'PDX Outbound Preprocessor' Pre-Processor handles change events on reference assets, and forwards this information to the PDX product.
To use specific attributes to invoke the PDX OIEP and export any updated asset metadata to PDX, 'Product Image' must also be included as one of the Triggering Object Types. In addition, one or more attributes of the asset must be added to the Triggering Attributes list. In the example below, the attributes 'Finish', 'Keywords', and 'PicDescription' have been added as triggering attributes. Any changes to these attributes, once approved, will resend any updated changes to the asset metadata to PDX.
For more information regarding configuring the PDX Outbound Integration Endpoint, refer to the PDX Outbound Integration Endpoint Configuration topic in the Product Data Exchange documentation here.
Configuring the Advanced STEPXML Template for Asset Metadata Export
By configuring the Advanced STEPXML template, users can specify whether they want specific metadata attributes for assets to be exported, or all metadata attributes for assets to be exported. In the example below, three attributes on the asset and their values are highlighted.
Note: To quickly identify the attribute ID for the purpose of insertion into the XML template, hover over the attribute name. A popup will display with the attribute ID.
Using the 'Value AttributeID' tag, the corresponding Advanced STEPXML template has been configured to include those same attributes, identified by their IDs, within the <Values></Values> element.
When the PDX OIEP is invoked, the resulting JSON structure exported to PDX will display the specified metadata attribute values, as well as the assetID of the specific asset, as a composite attribute with the name 'ProductImage.' This composite attribute will be displayed on the product in PDX, not on the asset.
Note: In the example above, the ID of the asset reference type is 'ProductImage.'
For more information regarding Advanced STEPXML, refer to the Advanced STEPXML Format topic in the Data Formats documentation here.