Publishing And Rendering Options

When documents are registered by the source vault's VBScript event handlers, publishing options and rendering options can be specified that modify the publishing job. These options can be set using the RegisterDocument method described in RegisterDocument method.

The Meridian Enterprise system link supports the options described in the following table when the destination system is another Meridian Enterprise vault. The Microsoft SharePoint system link also supports publishing options, however they must be specified in a customized SharePoint workflow template. The publishing options are not supported by the Windows file system link.

Note:

If an option accepts a value and the value is empty, the publishing job settings are used. If the value is invalid (missing < or > characters), the job will fail.

Publishing options

Option

Description

_CDWF_
<WorkflowDefinitionName
;WorkflowStateName>_

The document is published to the destination system immediately into the specified workflow state.

_DATAONLY_

The document content is not transmitted, only the property values. This option is typically used together with the _NORENDER_ option.

_DELETE_

OR

_DELETE_<FileName>

The document is deleted from SharePoint libraries when the Meridian Enterprise source document is deleted. If the destination filename is not specified, the name of the document registered for publishing is used.

Due to the risk of accidental data loss, this option is only available if the EnableRemoveSharePointTarget option is set to true in the following file. Be certain that you want to use this option before enabling it.

C:\ProgramData\BlueCieloECM\EnterpriseServices\PublishingCapability.dat

_LIB_<Title>_

The title of the SharePoint library to publish to. If specified, the value replaces the Library option that is configured in the publishing job.

Note:

This option is supported by the SharePoint publishing module only.

_NOREDLINES_

Prevents the publishing of redlines.

_NORELEASE_

The document is not released in the destination vault after publishing.

_OVERWRITE_

If any revisions of the document exist in the destination system, they are deleted before the current revision from the source system is published.

Note:

This option is supported by the SharePoint publishing module only.

_PUBLISHONLY_<PropertySet.PropertyName;PropertyValue>_

A safeguard for certain configurations in which a document can be rendered and published before changes to the document are saved in the vault. This can result in an invalid rendition in the destination system.

Specify the name of a custom property for the source system link to check for a specified value before publishing the document. If the property does not contain the specified value, the document is not published by that attempt, the text Document is not ready for publishing is saved in the publishing log, and the property is rechecked on each retry.

Scripting is responsible for setting the value prior to publishing and resetting the value after publishing unless the value is unique for each document.

Copy
Sub DocWorkflowEvent_AfterChangeWFState(Batch, _
       SourceState, TargetState, Person, Comment)
    Dim PublishNo
           
    If (SourceState = AS_WF_UNDERCHANGE) And _
       (TargetState = AS_WF_RELEASED) Then
       
        'Set Property for _PublishOnly_ option
        Document.PublishNo = CreateGUID
        PublishNo = Document.PublishNo
        
        ' Send document to Publisher
        Set Publisher = New PublisherScriptObject 
        'Register current document for publishing
        Call Publisher.Queue.RegisterDocument("", _
          "398328B7", Document.ID, _
          , "_PUBLISHONLY_<Custom.PublishNo;" & _
          PublishNo & ">_" ,_
          , Vault.User.Name, , _
          "Custom.PublishStatus")
        'Release the script object.
        Set Publisher = Nothing                 
    End If
End Sub

We recommend setting the value to the document revision number using Document.VersionID, a vault sequence number using Vault.Sequence(Name), or a globally unique ID (GUID).

Following is an example of getting a GUID in VBScript:

Copy
Function CreateGUID
  Dim TypeLib
  Set TypeLib = CreateObject("Scriptlet.TypeLib")
  CreateGUID = Left(TypeLib.Guid, 38)
End Function

_RENDERLAYOUTS__<LayoutName1;LayoutName2;...LayoutNameN>_

Renders each of the specified layouts to a separate rendition. This option is supported for AutoCAD and Revit drawings rendered with the AutoCAD rendering module, and Teigha DWG rendering module only. Specify the layout names to render in a semicolon-delimited list. By default, the name of the rendition is a combination of the source file name and the layout name (<FileName_LayoutName>). You can specify a different name with a VBScript expression as the value of the Use property value from source document option of the job configuration.

Use the VBScript property Document.LayoutsNames to retrieve the layout names for the current document. The title block attribute or sheet property names must be configured in the appropriate application link settings of the vault configuration as described in the Application Integration section.

If the source document and the renditions reside in the same Meridian Enterprise vault, the rendition type Layout Rendition Reference (RTRenditionReference) will be created in the vault if it does not already exist. That rendition type will be used to create references between the source document and the renditions. The name of each reference is the layout name.

_RESERVE_

OR

_RESERVE_<FileName>

Checks the document out in the destination system, creating a new major or minor revision depending on the system configuration. The revision can be revoked and the new revision deleted by the _UNRESERVE_ option.

Note:
  • This option is supported by the SharePoint publishing module only.

  • If the destination filename is not specified, the name of the document registered for publishing is used.

  • The document will be checked out by the Meridian Enterprise system account.

  • Do not use with the _UNRESERVE_ or _DELETE_ options in the same operation or only the first option will be applied.

  • The Comment (workflow log) property is not updated by this option.

_RETIRE_

The document is not published to the destination system, but the existing document in the destination vault is retired.

_RETRY_<Count>_

If the job fails for any reason, restart the job in the queue <Count> times or until the job succeeds, whichever comes first.

This option overrides the Number of retries if publishing fails setting described in Configuring the Publishing Options.

_SITE_<URL>_

The URL of the SharePoint site and subsite (if applicable) to publish to. If specified, the value replaces both the Site address and the Subsite options that are configured in the publishing job.

Note:

This option is supported by the SharePoint publishing module only.

_UNRESERVE_

OR

_UNRESERVE_<FileName>

Revokes the checkout done by the _RESERVE_ option of the specified document in the destination system and deletes the unreleased revision.

Note:
  • This option is supported by the SharePoint publishing module only.

  • If the destination filename is not specified, the name of the document registered for publishing is used.

  • Do not use with the _UNRESERVE_ option in the same operation or only the first option will be applied.

The rendering modules support the options described in the following table.

Rendering options
Option Description

_NOPOSTRENDER_

Disables all rendition post-processing actions (for example, watermarks or signature pages).

_NORENDER_

Disables all document rendering and an empty file is published to the destination vault. This option is typically used together with the _DATA_ONLY_ option.

_PRINTING_QUALITY

Allows you to get and set the print quality to use with PDFTron. You can set a value between 1 and 15. Higher values result in higher quality, but takes longer to render. Values between 3 and 6 are suitable for most purposes. Beyond 6, quality increases by diminishing amounts. If no value is set, the default value of 1 is used. The property exists within the BCRenditionPropertySet. For example, Document.Property("BCRenditionPropertySet._PRINTING_QUALITY").

_REVITSETUP_<ExportSetupName>_

Uses the parameters configured in the specified export setup to render the Revit project instead of the options configured in the publishing job. If the export setup cannot be found, then the configured options will be used.

ExternalUpdateProperties

If you use the Teigha rendering engine, this setting allows Meridian to recover from attempting to render a corrupt or invalid document. If a third-party rendering component fails, we remove the document from the rendering queue. A message appears in the process log that informs the user that the process has failed, and then Meridian proceeds to the next document in the queue.

To enable this setting:

  1. Navigate to the following file:

    C:\ProgramData\BlueCieloECM\EnterpriseServices\PublishingCapability.dat
  2. Change the value of the ExternalUpdateProperties setting to true.

  3. Save the file.

2024