RegisterDocument method


	BlueCielo Publisher 2012 Administrator's Guide \| BlueCielo ECM Solutions

You are here: VBScript reference > About the objects > About the MeridianQueue object > The MeridianQueue object methods > RegisterDocument method

RegisterDocument method

Registers a Meridian Enterprise document in the Publisher queue.

Syntax

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

Parameters
Name	Description
vaultId	A string that uniquely identifies the vault in which the document resides. Specify Nothing or an empty string to work in the same vault where the VBScript operates. The vault identifier has the syntax \\server\vault, where server is the name of the server computer and vault is the internal name of the vault or datastore. The vault identifier may consist of only a vault name, in which case the vault’s default server, if set, will be assumed.
jobId	A string that uniquely identifies the publishing job (Job Code).
documentId	A string that uniquely identifies the document to publish.
revisionId	A string that uniquely identifies the revision of the document. The default is Nothing.
publishOptions	A string that specifies the options for the system links. The default is Nothing.
renderOptions	A string that specifies the options for the rendering modules. The default is Nothing.
userName	The name of the user who initiated the task. If Nothing or an empty string, the name of the current user is used.
preventDuplicate	A Boolean value indicating whether to check for duplicate items before adding a new one. If any duplicates are found, the item will not be created. If Nothing, then the option set for the publishing job is used.
feedbackProperty	The name of the property where to store the result of the registration.

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 AMCreateObject function and specify the ProgId of the object as described in Registering programmatically without the Task Server. 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. This is described along with a workaround in Signed assemblies load slowly.

Related concepts

VBScript reference

Signed assemblies load slowly

Related information

JobCode property

DocumentID property

RevisionID property

PublishOptions property

RenderOptions property

UserName property

PreventDuplicate property

FeedbackProperty property