1         Introduction

Purpose of Document

The purpose of this document is to guide how to use the KAIFA AMI system to complete the corresponding workflow.

Scope

This document includes KAIFA AMI system’s total function and method of application.

 

2         Construction

The overall architecture and functions of the system are involved as shown in the figure

Figure 1 AMI System Functional Architecture Diagram

①      Dashboard: This module shows all kinds of dashboard. You can see the information overview in this part.

②      Archive: This module is designed to manage all kinds of archives. It contains information about the meter, module, reader, meter statistics, meter point and shipment file. You can add or import the archive.

③      Device Control: This module is designed for remote control of devices. It contains information about valve, alarm, re-collect reading, remote configuration and RTC. You can control the device in this part. Once your data failed you can filling data in this module. More details about the features are described below.

④      Device monitoring: This module is designed for monitoring collection condition. It contains information about offline meter, abnormal registration, abnormal data and map view. It is used to watch for this information.

⑤      Event Management: This module is designed for manage the event. It contains information about leakage, reverse flow and event log. You can see the event name, meter number, time, and significance level.

⑥      Meter Reading: This module is designed for watching meter information. It contains lot of information. In addition to the basic information of the meter. It has the communication quality, the valve status and so on.

⑦      Report: You can see daily billing data and monthly billing data in the module.

⑧      Firmware Upgrade: This module is designed for managing firmware upgrades. Grouping firmware according to requirements facilitates the delivery of firmware upgrade tasks.

⑨      Interface Record: This module is shown the task list sent by the third-party interface.

⑩      WFM: This module is designed for managing the worker. It contains information about work order, work team, role and field worker. It makes it easier to distribute work orders and manage worker information.

⑪      System: This module is designed for the admin user to manage user.

 

3 Business Process

The following chapter is the whole process from how to import a file to install a watch to the end of the product life cycle, including the explanation of how to use each function of the system.

3.1 System initial installation

Environment requirements for the system: Google Chrome minimum version 64.0.3311.0

Network communication must be smooth.

Information Security Management: The system is deployed on the Amazon Cloud and maintained by the KAIFA team.

Technical support you can ask your sales support.

3.2 Asset achievement

Two sections focus on the import of file. One section is in ‘Install Meter’, Other section is in ‘Install Reader’. These two sections of file import will be covered separately in the following sections.

For ‘Install Meter’:

Access the Meter page (HES -> Archive -> Meter), and click the ‘Add’ button or ‘Import’ button to input or import the related meter information.

Figure 2 Meter Page

If you click the ‘Add’ button, you can see the following pop-up window. Input the related information and then click the ‘Submit’ button. This picture is an example. If you want to add more you can click the ‘Submit and continue’ button.

Figure 3 Pop-up 'Add' Window

When you submit this page will show the meter you have add.

Figure 4 After Submit Meter Page

If you click the ‘Import’ button, you can see three options from select element. click one type of meter you want to install.

Figure 5 Choose Import Meter Type

After you click the type, you can see the following pop-up window. And then click the ‘Download Template’ button to download the template.

Figure 6 Pop-up 'Import Meter' Window

The template file is as follows. You’ll need to input the information and save it. After that, back to the pop-up ‘Import’ window, click ‘Add Files’ to select the file and then click the ‘Upload Files’ button to upload it. This picture is an example.

Figure 7 Template for Importing the Meter

Import the module information. (Optional):

First access the ‘Module’ page (HES -> Archive -> Module) and click ‘Add’ button or ‘Import’ button to input or import the related module information.

Figure 8 Module Page

If you click the ‘Add’ button, you can see the following pop-up window. Input the related information and then click the ‘Submit’ button. This picture is an example.

Figure 9 Pop-up 'Add' Window

When you submit this page will show the module you have add.

Figure 10 After Submit Module Page

When you click the ‘Import’ button, you can see the following pop-up window and then click the ‘Download Template’ button to download the template.

Figure 11 Pop-up 'Import Module' Window

The template file is as follows. You’ll need to input the information and save it. After that, back to the pop-up ‘Import’ window, click ‘Add Files’ to select the file and then click the ‘Upload Files’ button to upload it.

For ‘Install Reader’:

Access the reader page (HES -> Archive -> Reader), and click the ‘Add’ button or ‘Import’ button to input or import the related reader information.

Figure 12 Reader Page

If you click the ‘Add’ button, you can see the following pop-up window. Input the related information and then click the ‘Submit’ button.

Figure 13 Reader Add Page

If you click the ‘Import’ button, you can according to 2.1.1 Install Meter Step 1 to import the reader information.

When you submit this page will show the reader you have add.

Figure 14 After Submit Reader Page

If you click the ‘Import’ button you can ignore there, when you click the ‘Add’ button to add the reader information, you should add an reader meter after you add the reader. Just like install meter step, the only difference is choose the Read Meter Type.

Figure 15 Add Reader Meter Page

3.3 Installation process

3.3.1 Install Meter

This picture roughly shows how to install meter.

Figure 16 Install Meter Flow Chart

Step 1: Add or Import the metering point information.

Access the ‘Metering Point’ page (HES -> Archive -> Metering Point), and then click the ‘Add’ button or ‘Import’ button to add or import the metering point information.

 

Figure 17 Metering Point Page

If you click the ‘Add’ button, you can see the following pop-up window. Input the related information and then click the ‘Submit’ button. This picture is an example

Figure 18 Pop-up Window for ‘Add Metering Point’ function

When you submit this page will show the metering point you have add.

Figure 19 After Submit Metering Point Page

If you click the ‘Import’ button, you can see the pop-up window below. Click it to use corresponding template to import metering point information.                           

The template is as follows.

Step 2: Create the work order.

Access the ‘Work Order’ page (HES -> WFM -> Work Order), and hover the mouse over the ‘Create’ button and then click the ‘Install Meter’ pane.

Figure 20 Work Order Page

When you click the ‘Install Meter’ pane, you will see the following pop-up window. Select the meter you add and click the ‘Submit’ button to create a work order.

Figure 21 Pop-up Menu for Creating the Work Order about the Selected Meter

When you submit this page will show the work order you have create.

Figure 22 After Submit Work Order Page

Step 3: Assign the work order to a work team.

Select the work order you’ve just created, and then click the ‘Assign’ button to assign the work order to a work team.

Figure 23 Assign Function

When you finish the above operation, you will see the pop-up window below. Select a team and click the ‘Assign’ button to finish this step.

Figure 24 Pop-up Window for Assigning Work Order

Tips: How to create work team, work role and worker will be explained in the next section.

Step 4: Open the ‘SmartApp’ App.

The worker belonging to the work team logins the ‘SmartApp’ App and click the ‘Work Order’ pane.

The App interface is this picture.

Click the Work Order.

Figure 25 the Main Interface of SmartApp App

Step 5: Query Work Order in ‘SmartApp’ APP.

End the worker click the ‘Work Order’, click the right Account ,the app interface is this picture.

Figure 26 the Work Order Interface of SmartApp App

refer to Step1’s meter information to write the meter number, write the ‘Initial Reading’ and Locate the current position.

 

Figure 27 the Install Meter-Order Interface of SmartApp App

Step 6: Install Meter Offline.

 

Step 7: Submit Work Order.
When you finish last step, click ‘Submit’ button

Figure 28 the Install Meter-Order Interface of SmartApp App

Step 8: Press to Active.

Press the device button as picture shows.

Figure 29 the Install Meter-Photo Interface of SmartApp App

 

Step 9: Register Meter.

This Step will handle in system voluntarily.

Step 10: Take and Submit Photo.

Click the button and take photo. After finished, click ‘Submit’ button

Figure 30 the Install Meter-Photo Interface of SmartApp App

Install Meter Finished, we can see ‘Finished’ in WFM’s Work Order

Figure 31 Work Order Page

 

3.3.2 Install Reader

This picture roughly shows how to install reader.

Figure 32 Install Reader Flow Chart

 

Step 1: Add or Import the metering point information.

Access the metering point page (HES -> Archive -> Metering Point), and then click the ‘Add’ button or ‘Import’ button to add or import the metering point information.

Figure 33 Metering Point Page

If you click the ‘Add’ button, you can see the following pop-up window. Input the related information and then click the ‘Submit’ button.

Figure 34 Pop-up Window for ‘Add Metering Point’ function

If you click the ‘Import’ button, you can see the pop-up window below. Click it to use corresponding template to import metering point information.                           

The template is as follows.

Figure 35 Template of Import Metering Point

When you submit this page will show the metering point you have add.

Figure 36 After Submit Metering Point Page

Step 2: Create the work order.

Access the ‘Work Order’ page (HES -> WFM -> Work Order), and hover the mouse over the ‘Create’ button and then click the ‘Install Reader’ pane.

Figure 37 Work Order Page

When you click the ‘Install Reader’, you will see the following pop-up window. Select the reader and click ‘Submit’.

Figure 38 Pop-up Window for Installing Reader

When you submit this page will show the work order you have create.

Figure 39 After Submit Work Order Page

Step 3: Assign the work order.

Select the work order you’ve just created, and then click the ‘Assign’ button to assign the work order to a work team.

Figure 40 Assign Function

When you finish the above operation, you will see the pop-up window below. Select a team and click the ‘Submit’ button to finish this step.

Figure 41 Pop-up Window for Assigning Work Order

Step 4: Open the ‘SmartApp’ App.

The worker belonging to the work team logins the ‘SmartApp’ App and click the ‘Work Order’ pane.

The App interface is this picture.

Click the Work Order.

Figure 42 the Main Interface of SmartApp App

Step 5: Query Work Order in ‘SmartApp’ APP.

End the worker click the ‘Work Order’, click the right Account ,the app interface is this picture.

Figure 43 the Work Order Interface of SmartApp App

Step 6: Config Reader.

This step will be done partially when we add the reader ,now when we end up with last step, we can write the meter information and choose the base meter type.

Figure 44 the Install Reader-Gather Interface of SmartApp App

Click the ‘Pencil’ button ,and choose the right information for reader. Then turn on your phone's Bluetooth, click the ‘Connect Device’ button.

Figure 45 Connect Device Interface of SmartApp App

Step 7: Input Reader Information.

After you connect device successfully ,write the base meter reading and click the ‘pencil’ button again. If your interface like this picture, congratulated you input reader information successfully.

Figure 46 Input Reader Information

 

Step 8: Submit Work Order.

 

Click the ‘next’ button the whole information will show you, ensure no mistake, click the ‘submit’ button.

Figure 47 Submit Work Order

Step 9: Press to Active.

  Press the device button as picture shows.

Step 10: Register Reader.

This Step will handle in system voluntarily.

 

Figure 48 the Install Reader-Photo Interface of SmartApp App

Step 11: Take and Submit Photo.

Click the button and take photo. After finished, click ‘Upload’ button

Figure 49 the Install Reader-Photo Interface of SmartApp App

Install Reader Finished, we can see ‘Finished’ in WFM’s Work Order

Figure 50 Work Order Page

3.3.3 WFM

The WFM is used to manage the affairs related to workers and work orders. Such as create work team, create role, create field worker and create work order. How to create work order is already talk about. Here will show you how to use other functions.

Figure 51 WFM Flow Chart

Step 1: Create Work Team

Access the Work Team page (WFM -> Work Team), and click the ‘Add’ button

Figure 52 Work Team Page

If you click the ‘Add’ button, you can see the following pop-up window. Write your team name and choose work type for it, you can choose one type or any type you want ,then click the ‘Submit’ button.

Figure 53 Pop-up 'Add' Window

After you click the ‘Submit’ button there will show the team information you have created

Figure 54 After Submit Work Team Page

Step 2: Create Role

Access the Work Role page (WFM -> Role), and click the ‘Add’ button

0

Figure 55 Role Page

If you click the ‘Add’ button, you can see the following pop-up window. Input the related information and then click the ‘Submit’ button.

Figure 56 Pop-up 'Add' Window

After you click the ‘Submit’ button there will show the role information you have created

Figure 57 After Submit Role Page

Step 3: Create Field Worker

Access the Worker page (WFM ->Field Worker), and click the ‘Add’ button

 

Figure 58 Field Worker Page

If you click the ‘Add’ button, you can see the following pop-up window. Input the related information and then click the ‘Submit’ button.

Figure 59 Pop-up 'Add' Window

After you click the ‘Submit’ button there will show the worker information you have created

 

Figure 60 After Submit Field Work Page

Step 4: Log in ‘SmartApp’ App

Open the ‘SmartApp’ App and input the ‘UserName’, ’Password’ and ‘Tenant’.

Figure 61 Smart App Login Page

Figure 62 Smart App Login Page

After you input the right information click the ‘Login’ button

Figure 63 the Main Interface of SmartApp App

 

3.4 Operation Dashboard

3.4.1 Home

When you click the ‘Dashboard’ button, you can see five options. The following figure shows the ‘Home’ page information. There have seven parts to check.

Figure 64 Home Page

①     Valve Status: This part is about valve status. There are four sets of data in this section, you can click the data, then you can see the following pop-up window. It is a meter list about the status you click to check. If you want to deal with affairs, going to look ‘3.8 Open/Close Valve ’

②     Collection Today: This part is about the region’s today collection. There are two sets of data in this section, you can click the data to check just like in the last step. And the more detail is told in ‘3.4.2 Collection Status’

③     Event Status: There are three sets of data in this section, you can click the data to check just like in the first step, if you want to solve the events ‘3.6              Event Management’ will help you.

④     Device Status: There are six status of meter. Click the data you will see the following pop-up window to show the status you clicked. If you want to see more detail, just click the ‘Archive’ and click the ‘meter’.

⑤     Communication Quality: This part demonstrated the communication quality of meters. Once you click the data it will also pip up a window to show you a ‘Communication Quality’ list It is also mentioned in ‘3.9 Meter Reading’ section

⑥     Abnormal Information: Watch here you will see the abnormal information, same as above you can click data to see list. More detail is mentioned in ‘ 3.5 Device Monitoring’

⑦     Daily Usage Tendency: The graphic shows the usage tendency, click the ‘Daily’ button you can switch to the ’Monthly’ to see the ’Monthly Usage Tendency’. ‘3.4.4 Usage Statistics’ section had more detail.

3.4.2 Collection Status

Access the Collection Status page (HES -> Dashboard -> Collection Status), this page shows the meter collect rate.

Figure 65 Collection Status Page

①     Daily Data Collect: when you access this page, By default, you will see the daily collection rate curve for the region meters.

②     Hourly Data Collect: Click the ‘Hourly’ button you will switch to the hourly collection rate curve for the region meters.

③     You can see the day you want by choose the date and click ‘Search’ button.

3.4.3 Event Monitoring

Access the Event Monitoring page (HES -> Dashboard -> Event Monitoring), this page shows the general event monitoring. You can see the information about event.

Figure 66 Event Monitoring Page

①     Unmanaged Events: You can click the data, then it will show you a event list about the related information. ‘Unmanaged Meters’, ‘Today’s Events’, ’Today’s Meters’ both same like ‘Unmanaged Events’.

②Metrology Level: You can also click the ‘Metrology Level’ to see a event list about metrology level event.

In ‘3.6 Event Management’ section and ‘3.7 Monitor/Process the Event’, will show you how to manage event.

3.4.4 Usage Statistics

Access the Usage Statistics page (HES -> Dashboard -> Usage Statistics), this page shows the general usage statistics. Contained ‘Usage’, ‘Area Usage’, ‘Percentage Of Consumer Types’ and ‘Abnormal Data’. At the bottom of the page is ‘Daily Usage Tendency’ curve graph.

Figure 67 Usage Statistics Page

Top right corner you can click the ‘Monthly’ button to switch.

 

3.4.5 Meter Overview

Access the Usage Statistics page (HES -> Dashboard -> Meter Overview), this page shows the life cycle of a meter and the information associated with the meter

Figure 68 Meter Overview Page

Top left corner you can search the ‘Meter No’ .

 

3.4.6 Meter Statistics

This page will show you the meter statistics, you can general see the whole meter status, meter type, meter model and service time. Also you can click the data to see a meter list about the data you clicked.

Figure 69 Meter Statistics Page

On left we can see the different options, we can see the archive in corresponding option.

3.5 Device Monitoring

Figure 70 Collection monitoring Functional Diagram

You can see collection event in the part. You can search the map by access the ‘Map’ page(HES -> Device Monitoring -> Map View).

Figure 71 Map View Page

Access the ‘Offline Meter’ page (HES -> Device monitoring -> Offline Meter). You can see the offline meter.

Figure 72 Offline Meter Page

Access the ‘Abnormal Archive’ page (HES -> Device monitoring -> Abnormal Registration). You can see the abnormal archive.

Figure 73 Abnormal Registration Page

Access the ‘Abnormal Data’ page (HES -> Device monitoring -> Abnormal Data). You can see the abnormal data.

Figure 74 Abnormal Data Page

3.6 Event Management

Figure 75 Event Management Functional Diagram

This part you can see event record. Access the ‘Event Statistics’ page (HES -> Event Management -> Event Statistics), and you can see an overview of the event.

Figure 76 Event Statistics Page

If you want to check the event record, Access the ‘Event Log’ page (HES -> Event Management -> Event Log). You can choose the event name, level or meter.

Figure 77 Event Log Page

You can click the meter to see the meter information more details.

Figure 78 Pop-up window for Meter Information

3.7 Monitor/Process the Event

Figure 79 Monitor/Process the Event Flow Chart

When an event occurs in the meter, the meter will push the alarm to the system. After that, the system will acquire the event information by analyzing the alarm.

 

There are two options. Option 1 can be used to monitor, view or process the event, while option 2 can only be used to process the event.

Option 1: ‘Event Monitoring’. You should follow the step below.

Step: Access the ‘Event Monitoring’ page. (HES -> Dashboard -> Event Monitoring). You can monitor, view or process the event in this page.

Figure 80 Event Monitoring Page

Click the ‘modify’ icon below the word ‘Action’ for viewing events occurring in this meter.

Figure 81 the Action to View or Process the Meter's Event

When you click the ‘modify’ icon, you will see all events occurring in this meter at a pop-up window. After you have already handled the event in the field successfully, you can click ‘submit’ to generate the task for clearing the alarm.

Figure 82 Pop-up Window for Event Processing

Option 2 : ‘Clear Alarm Task’. You should follow the step below.

Access the ‘Clear Alarm Task’ page. (HES -> Device Control -> Clear Alarm). After you have already handled the corresponding event of meters in the field successfully, you should click the ‘Add’ button.

Figure 83 Clear Alarm Task Page

When you click ‘Add’, you will see a pop-up window, select and input the corresponding information.

Figure 84 Pop-up Window for Adding the clearing alarm task

Figure 85 Pop-up Window for Adding the clearing alarm task

3.8 Open/Close Valve

Figure 86 Valve Control Flow Chart

Access the ‘Open/Close Valve’ page (HES -> Device Control -> Open/Close Valve), and then click the ‘Open Valve’ button or the ‘Close Valve’ button.

 

Figure 87 Open/Close Valve Page

When you click the ‘Open Valve’ button, you can see a pop-up window. Select the meter you want to open valve and click the ‘Next’ button.

Figure 88 Pop-up Window for Open Valve

You can see another pop-up window. Write the reason and click the ‘Submit’ button.

Figure 89 Pop-up Window for Open Valve

When you click the ‘Close Valve’ button, you can see a pop-up window. Select the meter you want to open valve and click the ‘Next Step’ button.

Figure 90 Pop-up Window for Open Valve

You can see another pop-up window. Write the reason and click the ‘Submit’ button.

Figure 91 Pop-up Window for Open Valve

Back to ‘Operation Dashboard’

3.9 Meter Reading

Access the meter reading part (HES -> Meter Reading), you can see meter type, meter status, communication quality, valve status and last seen time

Figure 92 Meter Reading Page

Back to ‘Operation Dashboard’

4         More detail

4.1 Set RTC

The clock synchronization task will be automatically generated at 0am on the first day of the month. After that, wait the meter to ‘open window’.

Access the ‘Set RTC’ page (HES -> Device Control -> Set RTC), and click the ‘Set RTC’ button.

Figure 93 Set RTC Page

When you click the ‘Set RTC’ button, you will see a pop-up window below. Select the meter you want to set RTC, and click the ‘Submit’ button.

Figure 94 Pop-up Window for Set RTC Task

4.2 Remote Configuration

Access the ‘Remote Configuration’ page (HES -> Device Control -> Remote Configuration), and click the ‘Add’ button.

Figure 95 Remote Configuration Page

When you click ‘Add’, the pop-up window below will appear. Select the ‘Task Type’ and input the related information, and then click ‘Submit’ to generate the corresponding task.

Figure 96 Pop-up Window for Adding the 'Set Meter Configuration' Task

4.3 Report

Figure 97 Report Functional Diagram

Access the report part (HES -> Report), you have two options, ‘Daily Billing Data’ and ‘Monthly Billing Data’.

4.3.1 Daily Billing Data

If you click the ‘Daily Billing Data’ button. There will show you the meter daily billing data report. You can choose area, meter or date to check.

Figure 98 Daily Billing Data Page

4.3.2 Monthly Billing Data

If you click the ‘Monthly Billing Data’ button. There will show you the meter monthly billing data report. You can choose area, meter or date to check.

Figure 99 Monthly Billing Data Page

4.4 Firmware Upgrade

Figure 100 Firmware Upgrade Functional Diagram

You can see function about firmware upgrade in this part. You can multicast group in ‘Multicast Group’ (HES -> Firmware Upgrade).’Firmware Upgrade Schedule’ and ‘Firmware Upgrade Task’ are both in this function.

4.4.1 Multicast Group

Figure 101 Multicast Group Page

When you click the ‘Add’ button, you can see the following pop-up window. Input the related information and then click the ‘Submit’ button.

Figure 102 Multicast Group Add Page

4.4.2 Upgrade Schedule

If you want to Upgrade firmware you can add the schedule in this page.

Figure 103 Upgrade Schedule Page

When you click the ‘Add’ button you can see the following pop-up window. Input the related information and then click the ‘Submit’ button. Then you can click the ‘’ button to play the Schedule.

Figure 104 Firmware Upgrade Schedule Page

4.4.3 Upgrade Task

You can see the status of task that the last step you created.

Figure 105 Upgrade Task Page

4.5 Interface Record

Access the ‘Interface Record’ part (HES -> Interface Record). It contains three sections on third-party interfaces . ‘API Call Log’, ‘Real Time Transfer Record’ and ‘Timing Transfer Record’.

Figure 106 Interface Record Functional Diagram

4.5.1 API Call Log

You can see the log of the API call in ’API Call Log’ page,(HES -> Interface Record -> API Call Log)

Figure 107 API Call Log Page

4.5.2 Real Time Transfer Record

In ‘Real Time Transfer Record’ you can always check the latest transfer records .

Figure 108 Real Time Transfer Record Page

4.5.3 Timing Transfer Record

If you want to check your previous transfers. Access ‘Timing Transfer Record’.

Figure 109Timing Transfer Record Page

4.6 System

4.6.1 Release History

Access the ‘Release History’(System -> System Config -> Release History), you can see the version release history.

Figure 110 Release History Page

You can see detail by chick the ‘’ button, then the pop-up window will show the update information.

Figure 111 Pop-up Window for Release Detail