Installing the Meridian API Service
The Meridian API Service is the key to enabling the Meridian Mobile app. 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 R2 or higher server with the Meridian Enterprise server installation package described in Install the Server Components. The service can also be installed on Meridian Enterprise 2018 R2 or higher servers with a separate Windows Installer package as described below.
- For Meridian Enterprise versions prior to 2019 R1, download the Meridian API Service installation package from the Accruent Customer Portal.
- Uninstall any previous version of the API service.
- Verify that the following are installed on the Meridian Enterprise server:
- These components can be installed in advance:
- Microsoft .NET Framework 4.6.1
- Microsoft Internet Information Services
- BC Enterprise website component
- HTTPS must be configured with a SSL certificate issued to the domain where the service is installed. The API service will communicate over TLS 1.2.
- The Meridian Enterprise vault registered in the Meridian Enterprise Server configuration as described in Registering a Meridian Enterprise vault.
- A Meridian Explorer repository created in the Meridian Enterprise Server configuration as described in Creating a Meridian Explorer repository.
- A Meridian Explorer view configured for use by Meridian Mobile as described in Creating and editing repository views. The following options must be enabled:
- Accessible by the Meridian Explorer app for mobile devices option as described in Creating and editing repository views.
- Enable relational searches option as described in Configuring miscellaneous search options.
- For document and tag views, full-text search must configured as described in Configuring full-text indexing.
- A Meridian Explorer repository synchronization job configured and running without errors as described in Creating a publishing job.
- The service will be installed under the Default Web Site in a virtual folder M360.Meridian\api as an application with the name of the current version being installed (for example, v2, v3, and so on). The files will be installed at C:\Inetpub\wwwroot\M360.Meridian by default.
- Only the default API path of https://<ServerName>/m360.meridian/<api_version>/ is supported.
- Users of 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>
- Service logs for troubleshooting are located in the folder C:\Inetpub\wwwroot\M360.Meridian\api\<api_version>\Logs by default.
- Meridian Mobile requires Meridian Explorer Standard or Meridian Explorer Plus licenses be registered on the Meridian Enterprise License Server.
-
To allow access by Meridian Mobile users outside your organization's firewall, implement one of the following solutions:
- Install the Meridian API Service on a web server running IIS in your DMZ. The web server will communicate via DCOM with the Meridian application server inside the firewall.
-
Configure a VPN on the mobile devices to provide a secure connection through the firewall to the Meridian API Service installed on an internal web server running IIS.
To install the Meridian API Service interactively:
- On the Meridian EDM server, start M360MeridianApiServiceSetup.msi. The setup wizard welcome page appears.
- Click Next. The IIS Application Pool page appears.
- Click options or type values using the descriptions in the following table.
- Click Next. A progress page appears while the service is installed. When the installation is complete, the final page appears.
- Click Finish. The setup wizard closes.
| 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 (all versions):
-
Open the following URL in a browser:
https://<ServerName>/m360.meridian/api/<api_version>/checks/health
If the service is installed and working correctly, the service will return status: “Healthy”
The following table lists the available settings that can be configured by editing the application’s web.config file.
| 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. |
|
PageMaxLimit |
The maximum number of items to return per page when a call is made and the limit parameter specified is 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. |
