MeridianQueue Object

Begins collection of a batch of documents to register in the Publisher queue.

Syntax

Function BeginBatch (vaultId, commitSize)

Remarks

This method must be called in the _Initialize event procedure of a custom command, similar to the following examples. If this is not done, then the RegisterDocument method registers documents in the queue individually.

If any document is registered more than once, the Publisher configuration options described in Configure a Vault For Publisher will determine the disposition of the batch.

Example

The following examples demonstrate how to do batch publishing either in a server-side process (better performance and recommended) or a client-side process (if a client context is required).

Sub Publish_Batch_Execute(Batch)
	AddToBatch Batch, Document
End Sub

Sub Publish_Batch_Initialize(Batch)  
    BeginBatch(Batch)
End Sub

Sub Publish_Batch_Terminate(Batch)
  CommitBatch(Batch)	
  If Err.Number = 0 Then
	WinMsgBox ("Documents have been registered for publishing")
  End If    
  If Err.Number <> 0 Then  
	  WinMsgBox Err.Description
      Err.Clear       
  End If  
  
End Sub

Public Sub BeginBatch(Batch)   
  Dim QueueObject
  ' Server side batch. For client side batch, pass False instead
  Set QueueObject = AMCreateObject("BCPublisher.MeridianQueue", True)
  Batch.Argument("PublisherBatch") = QueueObject    
  QueueObject.BeginBatch  
End Sub
  
Public Sub CommitBatch(Batch)  
  On Error Resume Next
  Dim QueueObject
  Set QueueObject = Batch.Argument("PublisherBatch")
  Batch.Argument("PublisherBatch") = Nothing
  If Not (QueueObject Is Nothing) Then
    QueueObject.CommitBatch		
    QueueObject.Dispose()      
  End If
  
  If Err.Number <> 0 Then
    Err.Raise Err.Number, Err.Source, _
      "Failed to publish batch of documents: " + Err.Description
  End If 
End Sub 
  
Public Sub AddToBatch(Batch, Document)
  Dim QueueObject      
  Set QueueObject = Batch.Argument("PublisherBatch")
  If Not (QueueObject Is Nothing) Then    
    Call QueueObject.RegisterDocument("", "1B4423", Document.ID, , , , , ,"")    
  End If
End Sub 

Commits as one batch all documents that have been registered in the Publisher queue since the calling of the BeginBatch method.

Syntax

Function CommitBatch (vaultId)

Remarks

This method must be called in the _Terminate event procedure of a custom command, similar to the example shown in BeginBatch method. If this is not done, then the RegisterDocument method registers documents in the queue individually.

Registers a Meridian Enterprise document in the Publisher queue.

Syntax

Function RegisterDocument(vaultId, jobId, documentId, _
                          revisionId, publishOptions, renderOptions, _
                          userName, preventDuplicate, feedbackProperty,
                          customColumns)

Return Value

An integer value that uniquely identifies the registered document in the queue.

Remarks

Before calling a RegisterDocument from VBScript, you should create it with the AMCreateObject function and specify the ProgId of the object as described in AMCreateObject Function. To explicitly delete and release the object, call the Dispose method.

Instantiating a MeridianQueue object to publish documents can take longer than publishing the same document with the PowerUser extension.

Revokes all documents that have been registered in the Publisher queue since the calling of the BeginBatch method.

Syntax

Function RevokeBatch (vaultId)

Remarks

This method must be called in the _Terminate event procedure of a custom command, similar to the example shown in BeginBatch method. If this is not done, then the RegisterDocument method revokes documents in the queue individually.