Plug-in Images (Pre vs. Post)

Images are snapshots of the entity’s attributes, before and after the core system operation. Following table shows when in the event pipeline different images are available:

MessageStagePre-ImagePost-Image
CreatePRENoNo
CreatePOSTNoYes
UpdatePREYesNo
UpdatePOSTYesYes
DeletePREYesNo
DeletePOSTYesNo

The benefits of images

  • One of the best uses for this is in update plug-ins. As mentioned before, update plug-in target entity only contains the updated attributes. However, often the plug-in will require information from other attributes as well. Instead of issuing a retrieve, the best practice is to push the required data in an image instead.
  • Comparison of data before and after. This allows for various audit-type plugins, that logs what the value was before and after, or calculating the time spent in a stage or status.

The next section of this chapter covers how to start developing a plug-in, plus some examples of plug-ins.