Documentation Center

IWriteMetadataPlugin - RaiseUnpublishEvent

Sends a unpublish event with the configured event type when the publication status is changed to 'Unpublish pending'.

Plugin Configuration

The following workset fields need to be configured:
Field NameField LevelDescription
FISHPUBSTATUSlngThe publication status is used to check if the new status is "Unpublish pending" (= VPUBSTATUSUNPUBLISHPENDING)
FISHPUBISDEPLOYEDlngFISHPUBISDEPLOYED is used to check that the publication is deployed and can be unpublished
The following parameter must be configured:
ParameterDescription
EventTypeConfiguration
The parameter contains a XML structure which supports multiple "eventtype" elements which can be used to start the unpublish event with a specific event type.
Out-of-the-box the parameter will contain only one event type DITADELIVERYUNPUBLISH which will unpublish a publication in Dynamic Delivery:
<configuration>
  <eventtype>DITADELIVERYUNPUBLISH</eventtype>
</configuration>

Plugin flow

  • Conditional publishing of write plugin configuration.

    When updating a publication output, the write plugin configuration is conditionally published, which will validate the ishcondition not only on the plugin but also within the "EventTypeConfiguration" parameter.

  • The plugin takes the first remaining event type
  • After checking if the status is "Unpublish pending" and the publication was deployed, the following event data is assembled:
    <data>
      <export-document-type>ISHPublication</export-document-type>
      <export-document-level>lng</export-document-level>
      <export-ishlngref>488896</export-ishlngref>
      <creationdate>20150126031904978</creationdate>
    </data>
    
  • The plugin adds the event to a queue.

Remarks