Document Generic Events

The events that occur for the document generic commands are shown in the following lists in the sequence that they occur.

Change Document Type event sequence

Delete event sequence

Draft Print event sequence ¹

Issue New Filename event sequence

New Document event sequence⁴

Open in Application event sequence²

Prepare for Offline Work event sequence¹

Redline event sequence

Refresh Thumbnail event sequence¹

Rename event sequence

Replace Content event sequence¹

Notes

1. Does not occur in PowerWeb.

2. Occurs in PowerWeb when documents are downloaded.

3. Does not occur when new documents are created by the Document Import tool in PowerUser.

4. Does not occur when new documents are created by the Database Import Wizard in Configurator.

5. Occurs only if Client.Confirmation (AS_CONFIRM_NO_SELECTPROJECTWIZARD) = False and Document.ParentFolder is not a valid folder.

6. Occurs only if Client.Confirmation (AS_CONFIRM_NO_SELECTPROJECTWIZARD) = True and Document.ParentFolder is not a valid folder.

7. Does not occur if the Refresh thumbnail button on the Document page is clicked.

8. Occurs only if an expression is configured for the Calculate file name option of the document type.

Occurs after a reference between documents has been manually created by a user.

Syntax

DocGenericEvent_AfterCreateReference(Batch, RefType, TargetDocument, [RefDisplayName])

Occurs after a reference between documents has been manually deleted by a user.

Syntax

DocGenericEvent_AfterDeleteReference(Batch, RefType, TargetDocument, [RefDisplayName])

Remarks

If the Batch.Abort method was called in the DocGenericEvent_BeforeDeleteReference event from PowerWeb, the reference was not be deleted.

Occurs after documents are redlined by a user with the Meridian viewer.

Syntax

DocGenericEvent_AfterEditRedlines(Batch)

Occurs after a user replaces the content of documents.

Syntax

DocGenericEvent_AfterReplaceContent(Batch, SourceFile)

Occurs before a reference between documents is manually created by a user.

Syntax

DocGenericEvent_BeforeCreateReference(Batch, RefType, TargetDocument, [RefDisplayName])

Occurs before a reference between documents is manually deleted by a user.

Syntax

DocGenericEvent_BeforeDeleteReference(Batch, RefType, TargetDocument, [RefDisplayName])

Remarks

If the Batch.Abort method is called in this event from PowerWeb, the reference will not be deleted.

Occurs before documents are redlined by a user with the Meridian viewer.

Syntax

DocGenericEvent_BeforeEditRedlines(Batch)

Occurs before a user replaces the content of documents.

Syntax

DocGenericEvent_BeforeReplaceContent(Batch, SourceFile)

Remarks

Importing a document using drag and drop on a released document will create a new revision. Depending on your organization's business process for this action, the document might need to be placed in different workflow state, for example, for review before the new content can be released. We recommend that you do that in this event. If this event handler is not customized, an Access is denied error will result and the action will fail. If the document should remain in the released state after the import, this event handler should still be implemented to place the document in a different workflow state and then the document released in the DocGenericEvent_AfterNewDocument event handler.

By default, the redlines for the existing document content will be deleted when the content is replaced. If the redlines should be retained (to check that changes to the document have been done properly, for example), you can prevent the redlines from being deleted by setting the AS_CONFIRM_CLEANREDLINESONREPLACECONTENT constant to False in this event. The default is True.

Outputs the list of available document types to show the user based on the type of operation being carried out such as a new document or change the document type.

Syntax

DocGenericEvent_BeforeSelectDocumentType(Batch, DocTypeList)

Remarks

This functionality is only available in PowerWeb. On wizard pages, this event is fired once.

Occurs when the filename of a document is calculated by its document type.

Syntax

DocGenericEvent_*CalculateFilename(Batch)

Occurs when a user changes the document type of documents.

Syntax

DocGenericEvent_*ChangeDocumentType(Batch)

Occurs when documents or folders are deleted by a user.

Syntax

DocGenericEvent_*Delete(Batch)

Remarks

When a user deletes a folder, the Document object is Nothing. When a user deletes a document, the Document object is the document being deleted. When a user deletes a folder that contains one or more documents, the events occur once for each document and then once for the parent folder.

Example

Sub DocGenericEvent_BeforeDelete(Batch)
  If Not Document Is Nothing Then
    Batch.PrintDetails "Before delete " + Document.FileName
  ElseIf Not Folder Is Nothing Then
    Batch.PrintDetails "Before delete " + Folder.Name
  End If
End Sub

Occurs after the project folder selection dialog box has been shown to the user to select the destination folder for a new project copy document. Also shown to select a master document folder when releasing new project documents as new master documents.

The project folder selection dialog box can be controlled with the ProjectWorkflowEvent_PrepareBrowser, ProjectWorkflowEvent_InitializeExpandItem, and ProjectWorkflowEvent_BeforeExpandItem event procedures described in the Accruent Meridian Advanced Project Workflow Module Configuration Guide.

Syntax

DocGenericEvent_DocumentFolderSelected (Batch, SelectedFolder)

Remarks

If Client.Confirmation (AS_CONFIRM_NO_SELECTPROJECTWIZARD) is False after the DocGenericEvent_BeforeNewDocument event and Document.ParentFolder is not a valid folder at the time that the new document properties must be set, the folder selection dialog box is shown before the DocGenericEvent_OnProperties event in order to set the destination folder.

If Client.Confirmation (AS_CONFIRM_NO_SELECTPROJECTWIZARD) is True after the DocGenericEvent_OnProperties event and Document.ParentFolder is still not a valid folder, the folder selection dialog box is shown before the DocGenericEvent_AfterNewDocument event.

The selected folder is set as the Folder object in the DocGenericEvent_OnProperties and DocGenericEvent_AfterNewDocument events.

Occurs when documents are created by a user with any method (template, import, Application Integration). Also when a document is moved to a different folder or changed to a different document type.

Syntax

DocGenericEvent_*NewDocument(Batch, Action, SourceFile, DocType, DocTemplate)

Remarks

We recommend not setting any property values in the BeforeNewDocument event as this might cause the document to be created in a temporary parent folder before it is moved to its final destination, which might cause conflicts with existing documents.

The Before and After procedures are invoked when documents are imported with the Document Import tool. The Initialize and Terminate procedures are not invoked by the Document Import tool and are invoked only once per batch by the PowerWebImport Documents command. The FailCurrent and Abort methods of the Batch object are also available; however, the BatchIndex property will always be 1.

When documents are imported using drag-and-drop, the source of the files cannot be determined by Meridian so the value of the Client.ClientID property is AS_CID_POWERUSER regardless of the source of the documents. For your script to know where the documents originated from to perform validation or other processing, the users must use the file commands that are provided by the Meridian application links.

Example

You can test the value of the $$ICIMP_PropInvalid batch argument to determine if property validation failed while running the Document Import tool. If the validation failed, then you can prevent the import of the failed document using code similar to the following example.

Sub DocGenericEvent_BeforeNewDocument(Batch, Action, SourceFile, DocType, DocTemplate)
   If CBool(Batch.Argument("$$ICIMP_PropInvalid")) = True Then
       Batch.FailCurrent("Property validation failed")
   End If 
End Sub

Occurs when a user views or edits the property pages of a document or folder.

Syntax

DocGenericEvent_OnProperties(Command, Abort)

Remarks

This event occurs in the Meridian client applications when Command includes the constants indicated in the following table.

AS_PROP_CMD
constants

Constant	Action	PowerWeb	PowerUser
AS_PS_CMD_VIEW	The user started viewing the property page.
AS_PS_CMD_EDIT	The user clicked Edit to start property page (wizard) editing.
AS_PS_CMD_APPLY1	The user clicked Next to apply changes to the current page.
AS_PS_CMD_FINISH	The user clicked Finish to apply changes to the last page and stop property page (wizard) editing.
AS_PS_CMD_CANCEL	The user clicked Cancel to discard changes and stop property page (wizard) editing.

Use this event with much caution. In PowerUser, when Command includes AS_PS_CMD_VIEW, setting Abort to True will prevent display of all property pages. Attempting to set property values at that time can cause errors such as "The object is currently being edited by another session" and lost data.

We recommend that you not execute other actions, make modifications to the document content, invoke anything that takes a relatively long time, or invoke any user interface functions during this event. Such actions can have unexpected or unpredictable results.

Occurs when documents are opened by a user in their native application.

Syntax

DocGenericEvent_*OpenInApplication(Batch, AppName)

Occurs after a user selects a document command on the shortcut menu to act upon the selected document.

Syntax

DocGenericEvent_PrepareCommand(Batch, CmdID)

Remarks

Not available in PowerWeb. This event is intended to be used to set the Batch.ProcessAsBatch property to True before programmatically adding documents with the Batch.AddDocuments method to a batch in a custom command's Initialize event.

Occurs when a user prepares documents for offline mode operation.

Syntax

DocGenericEvent_*PrepareForOffline(Batch)

Occurs when documents are printed by a user from Meridian with the viewer. For information on configuring watermark printing with the Watermark properties, see the AccruentMeridian Enterprise Configuration Guide.

Syntax

DocGenericEvent_*Print(Batch)

Remarks

The DocGenericEvent_AfterPrint event does not occur in PowerWeb.

Occurs when documents or folders are renamed by a user.

Syntax

DocGenericEvent_*Rename(Batch, NewName)

Occurs when a new document is created by the Create New and Add Document commands. This event can be used to show the user a dialog box for folder, projects, or no dialog box.

Syntax

DocGenericEvent_SelectTarget (Batch, TargetFolder, DialogToShow)

Remarks

The Document object in this event is the new document. This event is equivalent to the AS_CONFIRM_NO_SELECTPROJECTWIZARD constant. For the corresponding event for copied documents, see DocCopyMoveEvent_SelectTarget event.

Occurs when a user updates the thumbnail images of documents manually.

Syntax

DocGenericEvent_*UpdateThumbnail(Batch)

Occurs when documents are printed by a user from Meridian Explorer with the viewer. For information on configuring watermark printing with the Watermark properties, see Configure Watermark Printing.

Syntax

DraftPrint_SetWatermark

The settings Enable draft print and Enable watermarks on draft print hardcopies must be set to True as described in Configure the Application Options.