Integrate Meridian Enterprise with Meridian Portal

Meridian Cloud is a SaaS solution offered by Accruent that can be integrated with Meridian Enterprise. Meridian Cloud has three main modules: Portal, PowerWeb, and Explorer. The Cloud-based versions of PowerWeb and Explorer are similar to those offered in Meridian Enterprise.

Meridian Portal can be integrated with Meridian Enterprise so that documents can be sent from Meridian Enterprise project folders to Meridian Portal projects (standard projects, not packages-only projects) for revision, review, approval, and handover back to Meridian Enterprise. This workflow is shown in Workflow Actions. When documents are approved, they can be imported back into the Meridian Enterprise project folders. This can be done in one of two ways:

  1. Documents can be sent back to Meridian Enterprise by the Document Controller using the Send to Meridian issue reason. After this process is complete, the documents in the package have the status In Meridian and are locked in Portal.

    This process can be automated for documents submitted by a contractor.

  2. Released documents can be sent back to Meridian Enterprise by the Document Controller using the For Handover issue reason. After this process is complete, documents have the Released status and are locked in Portal.

To learn more about the capabilities of Meridian Portal, see the Meridian Portal documentation in the Technical Library.

ClosedWhat is Meridian Portal?

Meridian Portal is a web application for collaborating on engineering projects. Target users include document controllers, external engineering contractors, regulatory bodies, and other external end users.

Authorized tenant administrators maintain the configuration, and project owners create new projects and invite internal and external participants. The invited project members receive secure role-based access, and every participant has a personal landing page with an overview of “My Tasks,” “Received Packages,” and “Recent Projects.”

Within Meridian Portal, there is a personal dashboard with status reports on documents and the workflow progress of packages. Meridian Portal has a central repository for documents with text search and dynamic filtering to allow users to quickly find what they need. Views on document details can be adapted for internal and external use.

The key features of Meridian Portal include:

  • Internal and external collaboration in a secure cloud-based project portal

  • Easy-to-use task-based user interface for engineering contractors

  • Formal and informal exchange of information in work packages

  • Collaborative document review and approval processes

  • Automated document compliance and completeness checks

  • Full audit and history log on actions performed by internal and external participants

Learn more about which Meridian Enterprise features are supported in Meridian Portal.

ClosedPrerequisites for the Integration

The following section outlines requirements you must meet before implementing the Meridian Portal integration.

ClosedSubscription

Before you can configure the Meridian Portal integration, you must first purchase a paid subscription for Meridian Cloud. There are three subscription levels: Meridian Cloud Project, Meridian Cloud Business, and Meridian Cloud for Life Sciences.

Note:

The Meridian Cloud Project subscription level is sufficient for the Meridian Portal integration but may not include all the features you want to use in Cloud. Learn what is included with each subscription level.

After you have purchased a paid subscription, your Accruent representative will create a Meridian Cloud tenancy for you. Your tenancy is your specific instance of Meridian Cloud. Your Accruent representative will provide you with the information you need to configure your tenancy's integration with Meridian Enterprise.

Additionally, you must also have a Meridian Enterprise license for the Advanced Project Workflow Module. This module is not part of the base licenses for Meridian Enterprise.

Contact your Accruent representative if you are interested in purchasing a Meridian Cloud subscription, or if you need to purchase an additional license for the Advanced Project Workflow Module.

ClosedTechnical requirements

Additionally, you must meet the following technical requirements:

  1. You must be using a currently supported version of Meridian Enterprise.

  2. You must implement TLS 1.2.

ClosedSet up the Integration

This section outlines the minimum requirements necessary for enabling an integration with Meridian Portal.

Configure the Connection To Meridian Enterprise Server

Register the Meridian Enterprise Vault you want to integrate with Portal

ClosedVault Configuration

For each vault that will be connected with Meridian Portal, you must configure the following properties in the Administrator.

Vault properties required for integration

Tab

Setting

Value

Advanced Features

Enable Advanced Project Workflow Module

Enabled

Advanced Features

Enable Meridian Publisher extension

Enabled

Advanced Features

Enable packages support

Enabled

Advanced Features

Repository Name

Enter the name of the Meridian Explorer repository from which the packages are made. This option is required to enable the Export Packages and Import Packages pages in PowerWeb when it is integrated with Meridian Portal.

ClosedCreate a Folder Type and Project Definition to use with Portal

In the Configurator, create at least one folder type with the Can be linked to Meridian Portal projects setting enabled. After creating a folder type with this setting enabled, the ProjectFolderPropertySet property set is created automatically.

Once you have created your folder type, create a project definition that uses this folder type.

ClosedConfigure Scopes

Ensure that the Link to Meridian Portal and Send to Portal commands are enabled for the appropriate scopes. You can find these commands on the Command Filter tab.

Connect Meridian Cloud tenancy in Administration Console

ClosedRepository Settings

You must perform the following tasks related to repositories:

  1. Create an Explorer repository.

    Only documents synchronized to this repository will be available in Portal.

  2. Configure the repository.

  3. Set the following values in the Vault Overview Options in the Administration Console:

    • Document number property – Set this value to any custom property

    • Project number property – Set this value to ProjectFolderPropertySet.ProjectNumber

      Important!

      If there are multiple vaults registered in Enterprise Server, your vaults must be configured to ensure that the values of ProjectFolderPropertySet.ProjectNumber are unique across all your vaults.

      How project numbers are calculated depends on your configuration. Usually a VBscript function is used to calculate them.

      A simple way to keep project numbers unique is to give them a vault-specific prefix. For example, if you have a vault for Unit 1, Unit 2, and Unit 3, then the script used for Unit 1 can use U1- as a prefix.

      If this is not feasible, you can also use a central SQL database and use SQL queries to generate unique numbers.

      Another approach is to generate sequence numbers using Vault.Sequence (“MySeq”).Next in one of the vaults and use Vault.CallRemote in the other vaults to access this sequence.

ClosedCreate a Repository Synchronization Job

Next, you must create a repository synchronization job. A synchronization job reads data from the Meridian Enterprise source vault and exports it to one or more intermediate data (not document content) files.

Note:

If there is more than one repository synchronization job, the Send to Portal action may fail.

To create a repository synchronization job:

  1. Create a Publishing Job.

  2. Configure the Publishing Job.

  3. Configure the Synchronization Options.

ClosedCreate a Package Export Job

A Package Export job is a publishing job which defines a destination for exporting packages. There should be only one Package Export job per Explorer repository.

To create a package export job:

  1. Create a Publishing Job.

    • In step 3 of the Create a Publishing Job procedures, select Package Export as the job type.

    • In step 10 of the Create a Publishing Job procedures, select Meridian Portal as the destination system.

  2. Configure the Publishing Job.

ClosedCreate and Configure Import Profile

Next, you will need to create an import profile. The settings in the table below are specific to the integration.

Important!

There should only be one import profile that has the Use Meridian Portal setting enabled per vault.

Import Profile settings specific to integration

Group

Setting

Value

General

Use Meridian Portal

Enabled

Destination repository

Destination repository

The destination vault for the items that are imported from packages to which you assign this import profile. Only the projects in this vault are valid destinations.
Administrative Permissions

Import

Everyone

Administrative Permissions

Close, reopen, delete

Everyone

ClosedConfigure VBScript to Assign Document Numbers to New Documents

You can modify the following VBScript and add it to the Configurator to assign document numbers to new documents submitted in packages by external business partners. By default, the documents are assigned GUID values as temporary document numbers.

Copy
Sub ImportPackage_AfterImportedFromPortal()
                        Document.psGeneral_DocumentNr = Document.psGeneral_Discipline & Right ("00000" & Vault.Sequence (Document.psGeneral_Discipline).Next, 5)
                        Document.ApplyPropertyValues 'To save the update
                    End Sub

ClosedShow Export Package and Import Package Property Pages in PowerWeb

You can modify the following VBScript and add it to the Configurator to configure the display of the Export Package and Import Package property pages in PowerWeb.

Copy
Function ExportPackagesPage_IsVisible()
                        If Not Document Is Nothing Then
                        'Add your code for document objects
                        ExportPackagesPage_IsVisible = True
                        ElseIf Not Folder Is Nothing Then
                        'Add your code for folder objects
                        End If
                        End Function

                        Function ImportPackagesPage_IsVisible()
                        If Not Document Is Nothing Then
                        'Add your code for document objects
                        ImportPackagesPage_IsVisible = True
                        ElseIf Not Folder Is Nothing Then
                        'Add your code for folder objects
                        End If
                    End Function

ClosedConfigure Package Scanning Options

In the Change Tenancy Settings procedures linked to by the Connect Meridian Cloud tenancy in Administration Console heading above, there are two options related to package scanning.

  • Package scanning interval — The interval in minutes to scan for new packages. The default is 5 minutes. This option is only available after a Meridian Portal tenancy has been registered.

  • Import scanned packages — If enabled, packages that are successfully scanned are imported automatically and do not need to be imported manually as described in Import an Import Package. This option is intended for use with packages sent from Meridian Portal.

Learn how to configure these settings.

ClosedSave Temporary Package Files

To save temporary package files:

  1. Navigate to C:\ProgramData\BlueCieloECM\EnterpriseServices\PublishingCapability.dat.

    Learn more about the settings in this file.

  2. Edit the file in a text editor.

  3. Set the KeepPackageTempFiles setting to true.

  4. Save your changes.

    Your import and export package files can now be viewed in the following folders:

    • C:\ProgramData\BlueCieloECM\EnterpriseServices\Meridian360\import

    • C:\ProgramData\BlueCieloECM\EnterpriseServices\Meridian360\Export

ClosedCloud Connector

The Meridian Cloud Connector is a set of components for use with the Meridian Cloud applications PowerWeb, Portal, and Explorer. The components manage a local workspace on your PC where files are downloaded when you update them.

Important!

Google does not support Google Authentication in Internet Explorer. If you want to use Google Authentication for the Cloud Connector, switch your default browser to Google Chrome or Microsoft Edge.

If you are a Meridian Cloud user who needs any of these benefits, then you should install the Meridian Cloud Connector:

  • View a document in the file's source application

  • Export documents or metadata

  • Work with batches of documents, referenced documents, hybrid parts, and redlines

  • Automatic title block synchronization and reference management

  • Access Meridian Cloud from within your desktop application

  • Use a Meridian site cache to access documents faster.

The Meridian Cloud Connector is convenient because it:

  • Fully supports application integration with the AutoCAD, MicroStation, and Office links. Optional settings are available in Cloud Connector Installation and through Meridian Power Settings.

  • Does not require administrator permissions on the PC to install (includes SQLite)

  • Automatically configures itself to connect to your Meridian Cloud account

You can download the Meridian Cloud Connector from the Meridian Cloud home page.

ClosedEnd-User Documentation

The following links point to the end-user documentation for the Meridian Portal integration.

Link Folders To Meridian Portal

Send Documents To Meridian Portal

2021 R2