Publishing Events
Publishing events occur in Meridian Enterprise vaults when they are configured as the source or destination document management system.
DocSync_Failed Event
Occurs for the source document after synchronization fails.
Syntax
Function DocSync_Failed()
Remarks
Use this event with the Enable separate options per document option and the Enable Meridian script events option of a repository synchronization job to control synchronization per document.
DocSync_Options Event
Occurs for the source document before synchronization starts.
Syntax
Function DocSync_Options()
Remarks
Use this event with the Enable separate options per document option and the Enable Meridian script events option of a repository synchronization job to control synchronization per document.
DocSync_Succeeded Event
Occurs for the source document after synchronization succeeds.
Syntax
Function DocSync_Succeeded()
Remarks
Use this event with the Enable separate options per document option and the Enable Meridian script events option of a repository synchronization job to control synchronization per document.
PublisherDestinationEvent_AfterPublish Event
Occurs in the destination vault after publishing has ended.
Syntax
PublisherDestinationEvent_AfterPublish (sourceType, sourceAddress, _ sourceDocId, publishOptions)
Parameter | Description |
---|---|
sourceType |
The name of the source system link, for example, BC Meridian or Windows file system. |
sourceAddress |
The address of the source system, for example, DataStoreName@MachineName for the AccruentMeridian Enterprise link. |
sourceDocId |
The ID of document in the source system. |
publishOptions |
The publishing options that were applied to the job. If the options were specified in the source system client application, they are passed in this parameter. If rendering fails with any rendering module and another attempt is configured, this parameter contains the text _RETRYRENDER_<ModuleName>_ . Your implementation of this event can then perform other actions in response to the failure, such as notify a System Administrator, set a property value for easy document location, and so on. |
Example
Public Sub PublisherDestinationEvent_AfterPublish(sourceType, sourceAddress, _ sourceDocId, publishOptions) Document.Log _ "Published: " & _ "From " & sourceType & " '" & sourceAddress & "'" & _ " document with ID '" & sourceDocId & "'" & _ " with options '" & publishOptions & "'" End Sub
PublisherDestinationEvent_HotspotUpdated Event
Syntax
PublisherDestinationEvent_HotspotsUpdated () CreateTags (Document.SaveToFile)
PublisherSourceEvent_BeforePublish Event
Occurs in the source vault before publishing starts.
Syntax
PublisherSourceEvent_BeforePublish (destType, destAddress, _ destDocId, destDocPath, destDocName, publishOptions)
Parameter | Description |
---|---|
destType |
The name of the destination system link, for example, BC Meridian or Windows file system. |
destAddress |
The address of the destination system as shown on the Destination page, for example, DataStoreName@MachineName for the Meridian Enterprise system link. |
destDocId |
The ID of the document in the destination system. Contains an empty value if the document does not yet exist in the destination system. |
destDocPath |
The path of the document in the destination system. |
destDocName |
The name of the document in the destination system. |
publishOptions |
The publishing options to apply to the job. If the options were specified in the source system client application, they are passed in this parameter. |
Return Value
An array of variants. The first element in the array is treated as a new value for DestDocID parameter.
Example
Function PublisherSourceEvent_BeforePublish (destType, destAddress, _ destDocId, destDocPath, destDocName, publishOptions) Document.Log _ "Started publishing: " & _ "to " & destType & " '" & destAddress & "'" & _ " document with ID '" & destDocId & "'" & _ " with options '" & publishOptions & "'" & _ " and path '" & destDocPath & "' and name '" & destDocName & "'" End Function
PublisherSourceEvent_AfterPublish Event
Occurs in the source vault after publishing has ended.
Syntax
PublisherSourceEvent_AfterPublish (destType, destAddress, _ destDocId, publishOptions)
Parameter | Description |
---|---|
destType |
The name of the destination system link, for example, BC Meridian or Windows file system. |
destAddress |
The address of the destination system as shown on the Destination page, for example, DataStoreName@MachineName for the AccruentMeridian Enterprise link. |
destDocId |
The ID of document in the destination system. Contains an empty value if the document does not yet exist in the destination system. |
publishOptions |
The publishing options to apply to the job. If the options were specified in the source system client application, they are passed in this parameter. If rendering fails with any rendering module and another attempt is configured, this parameter contains the text _RETRYRENDER_<ModuleName>_ . Your implementation of this event can then perform other actions in response to the failure, such as to notify a System Administrator, set a property value for easy document location, and so on. |
Example
Public Sub PublisherSourceEvent_AfterPublish (destType, destAddress, _ destDocId, publishOptions) Document.Log _ "Published: " & _ "to " & destType & " '" & destAddress & "'" & _ " document with ID '" & destDocId & "'" & _ " with options '" & publishOptions & "'" End Sub