User Manual

Health and Production

Information Server
Certiq

Original Instructions
2020-11-11 | No: TIS0003929.002 en-US
Health and Production Information Server Table of Contents

Table of Contents
1 Overview................................................................................................................. 5
1.1 Acronyms and Definitions ....................................................................................................... 5

2 Introduction to the HAPI Server ........................................................................... 7

2.1 HAPI Services............................................................................................................................ 9

3 Installation and Configuration of the HAPI Server Application....................... 11

3.1 System Requirements ............................................................................................................ 11
3.2 Download the HAPI Installer .................................................................................................. 11
3.3 Install the HAPI Server Application ....................................................................................... 12
3.4 Enable HAPI in Certiq Portal .................................................................................................. 16
3.5 CLS Sync Proxy Settings ....................................................................................................... 17

4 HAPI Diagnostics Application ............................................................................ 25

4.1 Register and Login ................................................................................................................. 27
4.2 Service Panel........................................................................................................................... 29
4.2.1 Show Logs............................................................................................................................ 30
4.2.2 Service Settings.................................................................................................................... 31
4.3 Machine Panel ......................................................................................................................... 34

iii No: TIS0003929.002 en-US

Health and Production Information Server Table of Contents

iv No: TIS0003929.002 en-US

Health and Production Information Server 1 Overview

1 Overview

This document is a user guide for Health and Production Information (HAPI) server.
The content of this document is structured as:
• Section 1 provides overview of this document.
• Section 2 provides introductory information of the HAPI server.
• Section 3 provides information on downloading, installing, and configuring the HAPI
server.
• Section 4 provides details of the HAPI Diagnostics application.

The purpose of this document is to assist the end user of the HAPI server.
For further information concerning the operation of the Certiq system and HAPI server,
contact the administrator.

1.1 Acronyms and Definitions

Abbreviation Definition

CCS Certiq Central Server is a computer present in a central location. It collects,

stores, and processes machine data. The machine data is then made available for
the end user to view in Certiq Portal.

HAPI Health and Production Information server is a software that is present locally at
the mine that collects and stores data from Epiroc machines. It filters and pro-
cesses the machine data and transmits it to the Certiq Central Server. The ma-
chine data, logs, and settings can be viewed on the Diagnostic Application.

MPUP Mobile Pick Up Point is a hand held computer that acquires data from the on
board computer installed on the machines. The data is stored in the MPUP and
later transmitted to the HAPI server.

WLAN Wireless Local Area Network according to the IEEE 802.11 b/g standards

API Application Program Interface

SQL Structured query language

5 No: TIS0003929.002 en-US

Health and Production Information Server 1 Overview

6 No: TIS0003929.002 en-US

Health and Production Information Server 2 Introduction to the HAPI Server

2 Introduction to the HAPI Server

Health and Production Information (HAPI) server is an onsite server (or local server) of
Epiroc. It is typically located at the customer site.

System Overview

The HAPI server is a part of Certiq system. Its purpose is to store machine data which is
collected from the Epiroc machines. The HAPI server stores machine data to local SQL
database. It is also synchronized with the Certiq Central Server (CCS) so that the machine
data can be pushed from the HAPI server to CCS. From there, the machine data is made
available to different applications such as Certiq portal.

The Epiroc machines can store around 20 to 30 days of data locally. Whereas the local
SQL database of HAPI server has a capacity to store 30 days of data. So, in total 50 days
of machine data can be stored locally after which the machine data can be lost. To prevent
this loss of data, the HAPI server must be synchronized with the CCS and the machine
data must be periodically pushed to CCS. If the HAPI server does not synchronize data
with CCS for last 30 days, it stops collecting new machine data until it is synchronized
again.

7 No: TIS0003929.002 en-US

Health and Production Information Server 2 Introduction to the HAPI Server

Network Layout

To transfer the machine data from Epiroc machines to the HAPI server, the data carriers
are used. Either the site network infrastructure or the Mobile Pick-up Point (MPUP) can be
used as the data carrier. In absence of the site network infrastructure, MPUP is used as a
data carrier.

NOTE: The MPUP must be set up properly to simulate network or machine settings
! must be changed to connect to the MPUP.

8 No: TIS0003929.002 en-US

Health and Production Information Server 2 Introduction to the HAPI Server

2.1 HAPI Services

Following are the typical services that are provided by the HAPI server:

Service Name Description

Epiroc.Service.Measure- Retrieves data from the NATS streaming server and writes it to the IN-
ments FLUX time series database.

Epiroc.Data.Influx Stores data in the INFLUX database.

Epiroc.APIGateway API to retrieve data from the streaming platform.

Epiroc.Data.NATS Streaming service that provides data in real time.

CLS API API to retrieve data from the local database (Certiq).

Epiroc.CLS.CLSSync Provides data synchronization between HAPI server and CCS.

Epiroc.Connector.Dasap Collects data from the machines.

Epiroc.Connector.Mirror Retrieves data from NATS streaming server and publishes it to cloud
through API management.

Epiroc.Connector.Certiq Retrieves data from SQL database and publishes it to NATS streaming
server.

9 No: TIS0003929.002 en-US

Health and Production Information Server 2 Introduction to the HAPI Server

10 No: TIS0003929.002 en-US

Health and Production Information Server 3 Installation and Configuration of the HAPI Server Application

3 Installation and Configuration of the

HAPI Server Application

To install and configure the HAPI server application, follow the instructions that are pro-
vided in this section.

3.1 System Requirements

The HAPI server application is installed on a physical server (computer) or a virtual server
with the following minimum specifications:

System Resource Minimum Specification

Processor Quad-core (4-core processor), 1 GHz or faster processor

RAM 4 GB (8 GB is recommended)

Hard Drive 15 GB of free space for installation, database, and log files

Network Port HAPI server requires port 80 for its installation and service.
Make sure that no other service is using port 80 on the computer.

The installation package is verified on the following operating systems:

• Windows Server 2019
• Windows 10 Pro / Enterprise, version 1909

The installation package is expected, but not verified, to work on the following operating
systems:
• Windows Server 2016
• Windows 10 Pro / Enterprise / Home, all versions

3.2 Download the HAPI Installer

HAPI installer can be downloaded from MRS Home. It is also provided by the Epiroc Cus-
tomer Center.
For more questions, contact the concerned team using the ordinary support channels.

11 No: TIS0003929.002 en-US

Health and Production Information Server 3 Installation and Configuration of the HAPI Server Application

3.3 Install the HAPI Server Application

After the HAPI installer is successfully downloaded, proceed with the installation procedure
as given below:

1. Log in to the server with the admin account if needed and run the installation file.
è The Installing HAPI window displays.

2. Click Install (A).

NOTE: If antivirus is blocking the installer, disable the antivirus

! and try the installation again. The antivirus can be enabled once
the installation is successfully completed.

NOTE: The HAPI server application can be installed without the

! internet connection.

12 No: TIS0003929.002 en-US

Health and Production Information Server 3 Installation and Configuration of the HAPI Server Application

è The User Terms For HAPI Server are displayed.

3. Read the legal license notice (B) and to accept the license agreement, select I ac-
cept the license agreement (D). To proceed, click Next (C).

4. Select the option With database and click Next (E) to proceed with the installation.

13 No: TIS0003929.002 en-US

Health and Production Information Server 3 Installation and Configuration of the HAPI Server Application

NOTE: The standard installation that is recommended for normal

users is With database option. User can select Without Data-
! base option to set up a database. The database setup can be
done using the HAPI diagnostics application.

è The installation begins and a progress window is displayed.

NOTE: The installation can take few minutes if it is neces-

! sary to install the Microsoft .NET framework package 4.7.2.

5. After the installation is complete, the computer may require a restart. The restart is
conditional depending on which software packages are installed from the installa-
tion package during the installation process.

NOTE: Sometimes this step is skipped and the installation dialog

! box can be closed.

14 No: TIS0003929.002 en-US

Health and Production Information Server 3 Installation and Configuration of the HAPI Server Application

è After the restart, all the software packages are installed and the installation is
successfully completed.

6. If the installation fails and the Setup Failed message is displayed after the installa-
tion is finished or after restarting computer, do the following steps:

a. Press Windows Key + R.

b. Enter %temp% in the address bar.

c. Copy all the log files that begin with Certiq_Local_Server_ and has a relevant
date.

d. Save the log files.

e. Send log files to your Certiq support at Epiroc.

15 No: TIS0003929.002 en-US

Health and Production Information Server 3 Installation and Configuration of the HAPI Server Application

3.4 Enable HAPI in Certiq Portal

HAPI must be enabled in Certiq Portal to appear for users and to show all the connected
machines.

1. Open a web browser on the computer and enter the following address to open the
HAPI diagnostics app.
http://localhost
Alternatively, click the shortcut on the desktop.

2. Click the settings icon (A) of the Epiroc.CLS.CLSSync service.

è The settings page displays. The CLS id (B) is visible at the top of the settings
page.

3. Copy CLS id and send it to Certiq support at Epiroc for enabling of HAPI in Certiq
Portal.

4. Once HAPI is enabled in Certiq portal, proper setup must be done by the Epiroc
Customer Center.

16 No: TIS0003929.002 en-US

Health and Production Information Server 3 Installation and Configuration of the HAPI Server Application

3.5 CLS Sync Proxy Settings

The CLS Sync is the program that transfers data from the local server to the central server.
It communicates with the central server via SOAP requests (http). If the HAPI server is be-
hind a proxy, some extra configuration is needed as described below:

1. Open a web browser on the computer and enter the following address to check if
the HAPI server is connected:
https://certiq-ls.epiroc.com/LBOSyncGateway.asmx
è If the LBOSyncGateway web server window displays, then the HAPI server
is connected. If it does not open, then contact the local IT.

17 No: TIS0003929.002 en-US

Health and Production Information Server 3 Installation and Configuration of the HAPI Server Application

2. To check if the web browser (internet explorer) is using a proxy, check the settings
as follows:

a. Click the settings icon (A) and select Internet options (B).

b. Click the Connections tab (C).

18 No: TIS0003929.002 en-US

Health and Production Information Server 3 Installation and Configuration of the HAPI Server Application

c. Click the LAN settings button (D).

19 No: TIS0003929.002 en-US

Health and Production Information Server 3 Installation and Configuration of the HAPI Server Application

è The Local Area Network (LAN) Settings window is displayed.

3. If the conditions under the Automatic Configuration (E) are selected in the win-
dow, then add the following proxy settings in the CLS Sync settings page in the
HAPI diagnostics application as mentioned below:

a. Open a web browser on the computer and enter the following address to open
the HAPI diagnostics app or click the shortcut on the desktop:
http://localhost

b. Click the settings icon (F) of the Epiroc.CLS.CLSSync service.

è The settings page is displayed.

20 No: TIS0003929.002 en-US

Health and Production Information Server 3 Installation and Configuration of the HAPI Server Application

c. Set Auto Detect to true (G) and click Submit.

4. Whereas, if the conditions under the Proxy server (K) are checked in the Local
Area Network (LAN) Settings window, then a proxy is in use. Make a note of the
Address (J) and Port (H).

! NOTE: For no proxy use, do not perform any proxy settings.

5. Get the IP address of the proxy server. Take the noted address and turn it to an IP-
address number.

6. Start a command prompt. Type <Win>+<R> cmd<Enter>.

21 No: TIS0003929.002 en-US

Health and Production Information Server 3 Installation and Configuration of the HAPI Server Application

7. Replace the address (L) with the address (J) from the proxy settings dialog box on
the Internet Explorer.

8. Ping the proxy address (M), and note down the IP number of the proxy.

9. Do as follows to add these proxy settings to the CLS Sync:

a. Open a web browser on the computer and enter the following address to open
the HAPI diagnostics application:
http://localhost

b. Open the setting page of the Epiroc.CLS.CLSSync service (refer step 3b).

c. Enter the IP address (R) from the ping command in the Proxy address bar.

d. Enter the port number (N) after the IP address in the Proxy address bar.

e. Set the Enabled to true (Q) and Use System Default to true (P) and the proxy
address as shown below.

10. Click Submit to restart the HAPI Sync service.

NOTE: This is needed for the service to re-read its configuration

! file.

11. Do as follows to check the CLS Sync log file.

a. Open a web browser on the computer and enter the following address to open
the HAPI diagnostics app:
http://localhost

22 No: TIS0003929.002 en-US

Health and Production Information Server 3 Installation and Configuration of the HAPI Server Application

b. Click the Show Logs button (S) for the CLS Sync.

c. Look at the top or search for any kind of error (T).

d. If the error shows, then the Expect 100 Continue tab (U) must be set to false.

12. Click Submit to restart the CLS Sync service again.

13. If it still does not work, do the following steps:

a. Check the CLS Sync log file again.

b. Check for any reference to an error like this: The request failed with
HTTP status 407: Proxy Authentication Required.

c. If the error shows, then set the Use Default Credentials tab (V) to true.

23 No: TIS0003929.002 en-US

Health and Production Information Server 3 Installation and Configuration of the HAPI Server Application

14. If this also fails, then set the Auto Detect tab (W) to true and click Submit to
restart the CLS Sync service.

24 No: TIS0003929.002 en-US

Health and Production Information Server 4 HAPI Diagnostics Application

4 HAPI Diagnostics Application

The HAPI diagnostics application can be used to monitor HAPI services. It also allows the
user to view machines that are communicating with HAPI server and their connection sta-
tus.

HAPI Diagnostics Application - Home Page

25 No: TIS0003929.002 en-US

Health and Production Information Server
The diagnostic application home page has the following components:
Callout Screen Component
A Settings
Login / Register / Re-
set
Certiq API
B Service
C Machines
4 HAPI Diagnostics Application
Description
Link to the settings page of HAPI diagnostics application. This set-
tings page consists of settings options that are common to all
HAPI services.
Platform Token: The platform token is an added layer of security.
It is required to access the services. The token will be provided by
Epiroc manually.
Connection String: Provides a connection string to the database.
If the HAPI server application is installed with database then a de-
fault connection string to the local database is displayed here.
Whereas if the application is installed without database, user can
setup a database using Create Database option and provide a
connection string to this database here.
Create Database: If the HAPI server application is installed with-
out database then user must create the database. Click Create
Database to create the database.
While accessing the HAPI diagnostics application on remote com-
puter, user must register (during first-time access) and login to this
application.
Login: Link to the log in page of HAPI diagnostics application.
Register: Link to the registration page of HAPI diagnostics appli-
cation.
Reset: Link to the password reset page of HAPI diagnostics appli-
cation.
For more details, refer to the Register and Login section.
Quick link to the Certiq API portal. It opens the Certiq API portal
page on next tab of the web browser.
The Service panel displays list of all HAPI services, currently run-
ning as well as expired. User can use this panel to monitor all ser-
vices.
For more details, refer to the Service Panel section.
The Machines panel displays list of all machines that are cur-
rently connected to the HAPI server. User can use this panel to
view the information regarding all the connected machines and
their communication status.
For more details, refer to the Machines Panel section.
26 No: TIS0003929.002 en-US
Health and Production Information Server 4 HAPI Diagnostics Application

4.1 Register and Login

To access the HAPI diagnostics application on remote computer user must log in to the ap-
plication. However, if the user is accessing the application on local computer, login to the
application is not required. User can create the login credentials by following the registra-
tion procedure as given below:

! NOTE: The login accounts can be created only from the local server.

1. To launch the HAPI diagnostic application, access the following url in web browser:
http://localhost
è The HAPI diagnostics application Login page is displayed.

2. To proceed with the registration, click Register (A) or Register as a new user (B)
link.
è The Register page is displayed.

3. To create new credentials, enter Username and Password. Repeat the password
in Confirm Password. To proceed, click Register.
è New credentials are created. These credentials can be used while accessing
the HAPI diagnostics application from remote computer.

After a successful registration (during first-time access), to log in to the application on re-
mote computer, follow the procedure as given below:

27 No: TIS0003929.002 en-US

Health and Production Information Server 4 HAPI Diagnostics Application

1. To launch the HAPI diagnostic application, access the following url in web browser:
http://localhost
è The HAPI diagnostics application Login page is displayed.

2. Enter Username and Password. To proceed, click Login.

è The HAPI diagnostics application home page is displayed.

To change the password for security reasons or if the password is lost, user can reset it.
To reset the password, follow the procedure as given below:

! NOTE: The reset password can be created only from the local server.

1. To launch the HAPI diagnostic application, access the following url in web browser:
http://localhost
è The HAPI diagnostics application Login page is displayed.

28 No: TIS0003929.002 en-US

Health and Production Information Server 4 HAPI Diagnostics Application

2. Click Reset (C) link.

è The Reset Password page is displayed.

3. To create new password, enter Username and new Password. Repeat the pass-
word in Confirm Password. To proceed, click Reset.
è New password is created.

4.2 Service Panel

HAPI Diagnostics Application - Service Panel

The Service panel of HAPI diagnostics application lists all the available HAPI services.
The panel displays all the currently running services (with green status) and old or expired
services (red in status). All the services and their connection details are provided in a tabu-
lar format as shown in the image above. User can use the Search feature to find any par-
ticular service from the list.

29 No: TIS0003929.002 en-US

Health and Production Information Server 4 HAPI Diagnostics Application

For each service, the following details are available:

Parameter Description

Name Displays the service name.

Reads This parameter is relevant only to the Epiroc.Connector.Dasap service. It

displays number of data (in bytes) read from the machine.

Writes This parameter is relevant only to the Epiroc.Connector.Dasap service. It

displays number of data (in bytes) written to the machine.

Start Displays timestamp of start event of the service.

Stop Displays timestamp of stop event of the service.

Last Contact Displays the heartbeat timestamp of the service.

Show Logs Displays log details of the service. For more details, refer to the Show Logs
section.

Status Indicates current connection status of the service. Following are the avail-
able status:
Green: indicates the active session of the service.
Red: indicates the older or expired session of the service.

Settings Displays the service settings. For more details, refer to the Service Settings
section.

4.2.1 Show Logs

To view log details of any service, click the Show Logs menu of that service. It displays
the log page of that particular service.

NOTE: Clicking Show Logs displays the logs that are applicable to the selected ses-
! sion of the service.

The log page contains list of all logged events along with the date and time of creation de-
tails of each log. This information is helpful during troubleshooting to locate any particular
error that may have occurred. User can use Search feature to find any particular event or
error that is listed on the log page.

30 No: TIS0003929.002 en-US

Health and Production Information Server 4 HAPI Diagnostics Application

Show Logs Page

The log page has the following controls:

Control Description

Info / Trace Toggle between the Info and Trace modes.

Info: this mode is used for normal logging.
Trace: this mode is used for fault searching.

Refresh Logs Updates the application logs page.

Download Logs The log list can be downloaded in plain text format.

4.2.2 Service Settings

To access the settings page of any particular service, click the Settings (cog-wheel) icon
next to that particular service on the service panel. The settings page is used to configure
the HAPI server to work with different network environments.

31 No: TIS0003929.002 en-US

Health and Production Information Server 4 HAPI Diagnostics Application

Service Settings Page (Sample)

As depicted in the sample image, the settings page has different settings parameters.
However, each service has unique settings parameters.
The following table describes all the parameter of each service:

Service Settings Parameter Description

Epiroc.CLS.CLSSync CLS Id Unique CLS ID that is used to identify the

HAPI server.

Sync Settings - CCS URL to get data to the Central Certiq Server
Gateway URL (CCS) and to the Certiq Portal.

Sync Settings - Batch This count can be lowered to send smaller

Count Max chunks of data when the internet connection
is weak in some mines.

Sync Settings - Idle This shows the data on how often the HAPI
seconds between synchronizes with CCS.
runs

Proxy Settings Parameters under Proxy Settings are used

to configure CLS Sync when HAPI server is
behind proxy server.

32 No: TIS0003929.002 en-US

Health and Production Information Server 4 HAPI Diagnostics Application

Service Settings Parameter Description

The configuration procedure of each of the

Proxy Settings parameter is described in
CLS Sync Proxy Settings section.

Windows Service Account details of the windows user that is

currently running the CLS sync service.

Epiroc.Connector.Mirror Settings - Target API URL to connect with the API Manager
URL (APIM).

Settings - APIM Token APIM token is required to connect with the

APIM to access data. The token is provided
manually by Epiroc.

Epiroc.Service.Measure- Windows Service Account details of the windows user that is

ments currently running the CLS sync service.

Epiroc.Data.Influx Windows Service Account details of the windows user that is

currently running the CLS sync service.

Epiroc.APIGateway Windows Service Account details of the windows user that is

currently running the CLS sync service.

Epiroc.Data.NATS Windows Service Account details of the windows user that is

currently running the CLS sync service.

CLS API Windows Service Account details of the windows user that is
currently running the CLS sync service.

Epiroc.Connector.Dasap Windows Service Account details of the windows user that is

currently running the CLS sync service.

Epiroc.Connector.Certiq Windows Service Account details of the windows user that is

currently running the CLS sync service.

The service settings page also has the following controls:

• Submit: click to apply the changes made on the page.
• Stop Service: click to stop the running service.
• Start Service: click to start the stopped service.

33 No: TIS0003929.002 en-US

Health and Production Information Server 4 HAPI Diagnostics Application

4.3 Machine Panel

HAPI Diagnostics Application - Machines Panel

The Machines panel of HAPI diagnostics application lists all the machines that are cur-
rently connected to HAPI server. All the machines and their connection details are provided
in a tabular format as shown in the image above. User can use the Search feature to find
any particular machine from the list.
For each machine, the following details are available:

Parameter Description

Machine Item Number Displays item number of the machine.

Description Displays the name given to the machine during commissioning of the Certiq
system.

Data Received Displays number of data (in bytes) read from the machine.

Data Synced Displays number of data (in bytes) written to the machine.

Last Contact Displays the heartbeat timestamp of the machine.

Last Data Received Displays the timestamp of latest data fetch event.

34 No: TIS0003929.002 en-US

Health and Production Information Server 4 HAPI Diagnostics Application

35 No: TIS0003929.002 en-US

 2020-11-11 | No: TIS0003929.002 en-US

epiroc.com