| BlueCielo Meridian Connection API 2012 Reference Guide | BlueCielo ECM Solutions |
You are here:
Namespaces > ICMeridianAPI > Connection
Connection ClassRepresents 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.
Declaration Syntax| C# | Visual Basic | Visual C++ |
public class Connection : BCScriptCallableObject, IAMImportHost2, IAMClientApp
Public Class Connection _ Inherits BCScriptCallableObject _ Implements IAMImportHost2, IAMClientApp
public ref class Connection : public BCScriptCallableObject, IAMImportHost2, IAMClientApp
Members| All Members | Constructors | Methods | |||
| Icon | Member | Description |
|---|---|---|
 | Connection()()()() | Initializes a new instance of the Connection class |
| AddHybridPart(String, String, String) |
Adds an empty hybrid part to a document.
|
| AssignRoles(String, String, Object, Object) | |
| CallVBScript(String, String, String, Object) |
Makes a call to a VBScript function
|
| ChangeDocumentType(String, String, String) |
Changes the document type of a document.
|
| ChangeFolderType(String, String, String) |
Changes the folder type of a folder.
|
| CheckinDocument(String, String, String) |
Transitions a document from the Under Change state to the Released state.
|
| CheckoutDocument(String, String, String, Boolean) |
Transitions the document to a state where it can be edited, either a QuickChange or UnderChange in workflow depending
on the optional quickchange parameter
|
| CreateNewDocument(String, String, String, String, String, Object, Object) |
Creates a new document in the vault and optionally sets its properties.
|
| CreateNewFolder(String, String, Object, Object) |
Makes sure the folder does exist in the vault and optionally updates its properties
|
| CreateReference(String, String, String, String) |
Creates a document reference between two documents inside the vault according to a defined reference
type. The destination document cannot be a new (unreleased) document unless the source document is new.
|
| DeleteDocument(String, String) |
Deletes a document
|
| DeleteFolder(String, String) |
Deletes a folder
|
| DeleteReference(String, String, String, String) |
Removes a document reference between two documents inside the vault according to a defined
reference type. Only one reference is deleted if the documents have been referenced multiple times using
the same reference type.
|
| DetachHybridPart(String, String, String) |
Detaches a hybrid part and turns it into a new individual document. The return value is the document ID
of the newly created document that was the hybrid part. The document will be in the Under Change state.
|
| DocumentExists(String, String) |
Check if a document exists in the vault
|
| EnumHybridParts(String, String) |
Enumerates all the hybrid parts of a document. The return value is a string array of the names of all the
hybrid parts. The variant will be empty if no hybrid parts can be found.
|
| FindDocuments(String, String, Object, Object, Object, Object) |
Searches for documents inside the vault. Returns a variant array of document identifiers matching the
find parameters.
|
| FolderExists(String, String) |
Check if a folder exists in the vault
|
| GetAllPropertyNames(String, String) |
Return an array of all property names of that document or folder as determined by the document or folder type.
|
| GetDocumentID(String, String) |
Returns the document identifier (docid) of a document given the vault identifier and the full path of the
document inside the vault.
|
| GetDocumentInformation(String, String, Object) |
Returns a variant array of values for the specified properties.
|
| GetDocumentLocation(String, String, Boolean) |
Returns a full path in UNC format or the relative path within the vault that can be used by any Windows
application to read from or write to a document.
The document needs to be in the Under Change state for it to be writable.
|
| GetDocumentVersionInformation(String, String, Object, Object) |
Returns a variant array of values for the specified properties for a given document version.
|
| GetDocumentVersionLocation(String, String, Object, Boolean) |
Returns a full path in UNC format or the relative path within the vault that can be used by any Windows
application to read the contents of the version of the document.
|
| GetDocumentVersions(String, String) |
Returns a variant array of version IDs for the specified document.
|
| GetFolderElements(String, String, Int32) |
Enumerate folder elements
|
| GetFolderID(String, String) |
Returns the unique identifier of a folder given the vault identifier and the full path of the
folder inside the vault.
|
| GetFolderInformation(String, String, Object) |
Returns a variant array of values for the specified properties.
|
| GetFolderNames(String, String) |
Returns a variant array of all subfolders names that are located under the specified folder path.
|
| GetHybridPartLocation(String, String, String) |
Returns a full path of a hybrid part in UNC format that can be passed to any Windows application.
|
| GetReferences(String, String, String, Boolean) |
Returns a variant array of object IDs for all references of a document according to a defined reference type.
|
| GetRoleAssignments(String, String, Boolean%) | |
| GetUniqueValues(String, String, String, Object, Object, Object, Object) |
Collect a set of unique non-empty values for a given custom property on a given set of documents.
|
| GetVaultName(String) |
Returns the display name of the vault. The method returns an error when a null string (“”) is passed and
no vault has been opened before.
|
| GetVersion()()()() | |
| InvokeEDMUICommand(String, String, Int64) |
Ask EdmUI to execute a certain command on the document
|
| IsDocumentCheckedOut(String, String) |
Returns True if the document is under change.
|
| IsUniqueValue(String, String, Object) |
Check if the specified value is unique for the specified property
|
| MigrateDocument(String, String, String, String, String, Object, String) |
Converts a document currently in document type workflow to a state in a workflow definition. This
method is only supported when Work Isolation Mode is turned off and the document itself is not
released. It can also be used to make a transition (reroute) from one state to another within the same
workflow definition and to make a transition to the Released state either by revoking the workflow (if it is in the
beginning state) or by releasing the document if it is in an end state.
|
| ResetRoleAssignments(String, String) | |
| ShowWizard(String, String) |
Shows wizard pages for the document
|
| SynchronizeLocalWorkspace(String, String, Object) |
Performs a titleblock update in which the properties of the document are updated with the titleblock
information of the document itself.
|
| SynchronizePropertiesFromFile(String, String) |
Performs a titleblock update in which the properties of the document are updated with the titleblock
information of the document itself.
|
| SynchronizePropertiesToFile(String, String) |
Performs a titleblock update where the titleblock of the document is updated with the property information
of the document stored in the vault.
|
| UndoCheckoutDocument(String, String) |
Revokes the working copy of a document and does a transition of the document from the Under Change state
back to its latest Released state.
|
| UpdateDocument(String, String, String, Object, Object) |
Updates the properties and/or content information of a document.
|
| UpdateHybridPart(String, String, String, String) |
Updates the contents of a hybrid part.
|
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:
CopyC#
CopyC# 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 Inheritance Hierarchy| Object | ||
 | BCScriptCallableObject | |
| Connection | |