How to install the Meridian API Service

The Meridian API Service is the key to enabling the Meridian Meridian Mobile. With it, users can find, view, and participate in document workflows from anywhere on your LAN with mobile devices.

The Meridian API Service can be installed on a Meridian Enterprise 2018 or higher web server with the Meridian Enterprise server installation package described in the Accruent Meridian Enterprise Administrator's Guide. The service can be installed on Meridian Enterprise 2014 through 2017 web servers with a separate Windows Installer package using the installation instructions in this article.

  • For Meridian Enterprise versions prior to 2018, download the installation package from our support site.
  • The service requires the following components be installed in advance:
    • Microsoft .NET Framework 4.5.2
    • Microsoft Internet Information Services
    • Accruent Meridian Enterprise EDM Server
Note:
  • The service will be installed under the Default Web Site as the application M360.Meridian. The files will be installed at C:\Inetpub\M360 Meridian API Service by default.
  • Users of the Meridian Meridian Mobile must enter their user name as either:
    • <UserName> (local computer account)
    • <DomainName>\<UserName> (Active Directory account)

    UPN format (<UserName>@<DomainName>, for example) is not supported.

    They must enter the server name as either:

    • <ServerName>
    • <ServerName>.<DomainName>
  • For use with HTTPS, the SSL certificate should be issued to the domain where the Meridian API is installed. Use a validated SSL certificate signed by a certificate authority (CA).
  • Service logs for troubleshooting are located in the folder C:\Inetpub\M360 Meridian API Service\Logs by default.
  • Meridian Mobile requires no additional licenses to be registered on the Meridian Enterprise License Server.

To install the Meridian API Service interactively:

  1. On the Meridian web server, start M360MeridianApiServiceSetup.msi. The setup wizard welcome page appears.
  2. Click Next. The IIS Application Pool page appears.
  3. Click options or type values using the descriptions in the following table.
  4. Click Next. A progress page appears while the service is installed. When the installation is complete, the final page appears.
  5. Click Finish. The setup wizard closes.
IIS Application Pool options
Option Description

User name

Type the name of a domain account to assign to the application pool M360.Meridian under which the service will run. This account must be the same account under which the Meridian EDM Server service runs. For more information about the requirements of this account, see Grant domain privileges with a service account.

Password

Type the password for the account

To install the Meridian API Service unattended:

  • Run the following command line with the correct values for your environment:

    msiexec /passive /i "M360MeridianApiServiceSetup.msi"
        APPPOOL_IDENTITY_NAME="<AccountName>"
        APPPOOL_IDENTITY_DOMAIN="<DomainName>"
        APPPOOL_IDENTITY_PWD="<Password>"
        INSTALLLOCATION="<Path>"

To test for successful installation:

  • Open the following URL in a browser:

    https://<ServerName>/m360.meridian/api/v1/checks/health

    If the service is installed and working correctly, it will return status: “Healthy”

The following table lists the available settings that can be configured by editing the application’s web.config file.

Meridian API Service settings
Option Description

Authorization.Issuer

Case-sensitive StringOrURI value that identifies the principal that issued the access token. Must be unique per on-premise installation.

Authorization.TokenTimeout

Access token timeout formatted as <Hours>:<Minutes>:<Seconds>. The default is 00:30:00 (30 minutes).

Authorization.Key

Key with which to sign the access token. Must be unique per on-premise installation. The length should be more than 16 characters.

Edm.ServerAddress

IP address of Meridian Enterprise server if separate from the computer where the service is installed. The default is blank (local computer).

PageMaxLimit

The maximum number of items to return per page when a call is made with the limit parameter specified as greater than 1000. The default is 1000.

PageDefaultLimit

The default number of items to return per page when a call is made with the offset parameter specified. The default is 100.