Connection Class

BlueCielo Meridian Connection API 2013 Reference Guide | BlueCielo ECM Solutions

Represents an object that can be used either from BC-Meridian VBScript or from other applications. The object implements a number of useful operations with folders and documents withing an BC-Meridian vault.

When it is called from VBScript without the vault specified in the parameters, the work is done in the same vault where the script operates. If called from an application other than BC-Meridian client, the vault should be defined in the vaultidentifier parameter.

A vault identifier is a string that specifies the unique location of a vault. The vault identifier is used by the ConnectionAPI to determine the vault to work with. The vault identifier has the syntax \\server\vault, where server is the server computer name and vault is the internal name of the vault on the specified server. Alternatively, the datastore and section names can be specified, which are often identical, and they can be found in the BlueCielo Meridian Enterprise Administrator utility.

Examples of vault identifiers:

\\meridiansvr\Htrieve1

\\meridiansvr\Mechanical\Mechanical

Note: A vault identifier may consist of only a vault name, and the computer’s default server, if set, will be assumed.

Inheritance Hierarchy

System Object
BCScriptCallableObject
ICMeridianAPI Connection

Namespace: ICMeridianAPI
Assembly: ICMeridianAPI (in ICMeridianAPI.dll) Version: 1.0.6.0 (1.0.6.0)

Syntax

C++

Copy to Clipboard Print

public class Connection : BCScriptCallableObject, IAMImportHost2, 
	IAMClientApp

public class Connection : BCScriptCallableObject, IAMImportHost2, 
	IAMClientApp

Public Class Connection _
	Inherits BCScriptCallableObject _
	Implements IAMImportHost2, IAMClientApp

Public Class Connection _
	Inherits BCScriptCallableObject _
	Implements IAMImportHost2, IAMClientApp

public ref class Connection : public BCScriptCallableObject, 
	IAMImportHost2, IAMClientApp

public ref class Connection : public BCScriptCallableObject, 
	IAMImportHost2, IAMClientApp

Remarks

Before calling a method of the object from a VBScript you should create it with AMCreateObject function and specify the ProgId of the class. To explicitly delete/release the object call the Dispose method. For convenience the following pattern can be used:

Copy to Clipboard Print

 Class ConnectionAPI
Private underlyingObject

Private Sub Class_Initialize()
    underlyingObject = AMCreateObject("ICMeridianAPI.Connection", False)
End Sub

Private Sub Class_Terminate()
    underlyingObject.Dispose()
    underlyingObject = Nothing
End Sub

Public Function SafeObject()
    SafeObject = underlyingObject
End Function

End Class

Sub Wizardry_Execute(ByVal Batch)
    Dim api
    api = New ConnectionAPI
    Call api.SafeObject.ShowWizard(vaultid, Document.ID)
End Sub

 Class ConnectionAPI
Private underlyingObject

Private Sub Class_Initialize()
    underlyingObject = AMCreateObject("ICMeridianAPI.Connection", False)
End Sub

Private Sub Class_Terminate()
    underlyingObject.Dispose()
    underlyingObject = Nothing
End Sub

Public Function SafeObject()
    SafeObject = underlyingObject
End Function

End Class

Sub Wizardry_Execute(ByVal Batch)
    Dim api
    api = New ConnectionAPI
    Call api.SafeObject.ShowWizard(vaultid, Document.ID)
End Sub