Reporting Deleted Entities with a Generic XML OIEP

When Entities are deleted and approved in STEP, outbound integration endpoints (OIEPs) can pass deletion events when the OIEP is configured to listen for Delete events on the relevant objects. As a result, the downstream system is alerted to the deleted asset. Entities must have the Revisability field set to Workspace Revisable, not Global Revisable.

Object Type and Event Type Selection

On the OIEP, open the Configuration tab. Under the Output Templates section, click the Add configuration link.

Set the Object Types and Event Types.

For this example, Modify events are also included to demonstrate the available functionality.

Template

In the Output Template, click the ellipsis button (), and set the format to Generic XML.

Provide the following text in the Sample field.

Copy
<root>
   <Entities>
      <?Record?>
      <Entity EntityID="[?Target EntityId?]" DeletedStatus="[?Target DeletedStatus?]">
      <EntityName> <?Target?> </EntityName>
      </Entity>
   </Entities>
</root>   

Mapping

Results

Approve Deletion for an Entity in the Recycle Bin and/or Approve Object for modification of a Entity that is Workspace Revisable on the Tree triggers the OIEP.

Invoking the OIEP generates the following output:

For deleted Entities, the Deleted Status displays "IsDeleted". Only ID is retained for export on Delete events.

For modified Entities, the Deleted Status displays " ", which indicates the entity is not deleted. All mapped fields are exported for Create and Modify events.