The ExportPackage object is a property of the ExportPackages object and represents the current export package.
ExportPackage Object Properties
The ExportPackage object provides the following properties, some of which are read-only.
ContentIncluded Property
Gets or sets a value that indicates the types of document content contained in the current export package.
Syntax
ContentIncluded As Long
Return Values
One of the AS_EXPORTPACKAGE_CONTENTINCLUDED_VALUES constants that are available in the VBScript editor Object Browser.
Remarks
The package must be in the Open status to set the value.
Description Property
Gets or sets the description of the current package.
Syntax
Description As String
Remarks
The package must be in the Open status to set the value.
Destination Property
Gets or sets name of the publishing job assigned to the current export package.
Syntax
Destination As String
Remarks
The package must be in the Open status to set the value.
ID Property
Returns the ID of the current object. The value is unique within the current vault. For the ID value that is unique among all vaults, retrieve the GlobalID property value, if available. Read-only.
Syntax
ID As String
Name Property
Returns the name of the current object. Depending on the object type, this property returns the display name of the object or it returns the internal name and may be read-only.
Syntax
Name As String
Remarks
If the current object is a Package, it must be in the Open status to set the value.
If the current object is a User, this property is the short name of the user as stored in the user's Meridian account information and is read-only. This property can be used to specify the recipient's email address and either an empty string or no value set in the Address property. If an email address is specified in Name, it must be surrounded with carets (<>). When used with Microsoft Outlook, the Name property may contain the user's full name or last name and Outlook will attempt to resolve the name to the email address in the default address book.
PackageURL Property
Gets the URL of the Meridian Explorer page to show the current export package. Read-only.
Syntax
PackageURL As String
ProjectID Property
Gets the Meridian Portal project ID (GUID) of the current package. Only available after the Meridian Enterprise project has been linked to a Meridian Portal project. Read only.
Syntax
ProjectID As Long
Remarks
The ID is stored in the Meridian Enterprise folder property ProjectFolder PropertySet.ProjectID. The ID can be set by the SetProjectID method.
ProjectName Property
Gets the Meridian Enterprise project name of the current package. Read only.
Syntax
ProjectName As String
Recipient Property
Gets or sets the recipient of the current export package.
Syntax
Recipient As String
Remarks
The package must be in the Open status to set the value.
Status Property
Gets the status of the current export package. Read-only.
Syntax
Status As Long
Return Values
One of the AS_EXPORTPACKAGE_STATUS_VALUES constants that are available in the VBScript editor Object Browser.
ExportPackage Object Methods
The ExportPackage object methods affect the current export package.
Abort Method
Aborts sending the current export package.
Syntax
Abort()
Remarks
The package must be in the Failed or Pending status.
AddDocument Method
Adds the specified document to the current export package.
Syntax
AddDocument(DocGlobalID As String)
| Name | Description |
|---|---|
|
DocGlobalID |
The GlobalID value of the document to add. |
Remarks
Only supported for export packages in the Open status.
Close Method
Changes the status of the current export package to Closed.
Syntax
Close()
Remarks
The package must be in the Sent, Failed, or Open status.
GetDocuments Method
Gets the documents contained in the current package.
Syntax
GetDocuments() As Array
Return Value
Returns an array of GlobalID values for the documents.
Remarks
When the current package is an import package, returns an array only if the Status property of the package is AS_IPS_Imported.
IsDocumentInPackage Method
Gets a value that indicates whether the specified document is contained in the current export package.
Syntax
IsDocumentInPackage(DocGlobalID As String) As Boolean
| Name | Description |
|---|---|
|
DocGlobalID |
The GlobalID value of the document to check. |
Return Value
True if the export package contains the specified document, otherwise False.
IsDocumentOutdatedInPackage Method
Gets a value that indicates whether modification time of the specified document is later than the time when it was exported to the package.
Syntax
IsDocumentOutdatedInPackage(DocGlobalID As String) As Boolean
| Name | Description |
|---|---|
|
DocGlobalID |
The GlobalID value of the document to check. |
Return Value
True if the document in the export package is outdated, otherwise False.
RemoveDocument Method
Removes the specified document from the current export package.
Syntax
RemoveDocument(DocGlobalID As String)
| Name | Description |
|---|---|
|
DocGlobalID |
The GlobalID value of the document to remove. |
Remarks
Only supported for export packages in the Open status.
Reopen Method
Changes the status of the current export package from the Closed state to the Open state.
Syntax
Reopen()
Remarks
The package must be in the Sent or Closed status.
Send Method
Sends the current package to the destination specified in the publishing job.
Syntax
Send()
Remarks
The package must be in the Open status.
SetProjectID Method
Sets the Meridian Portal project ID (GUID) of the current package.
Syntax
SetProjectID (ProjectID as String)
Remarks
The ID can be retrieved by the ProjectID property.
Update Method
Saves the properties of the current package.
Syntax
Update()
Remarks
Invoke this method after setting all of the package property values and before adding documents and sending the package.