—

PPLib800xA 6.2

Functional Description
Reporting
—
PPLib800xA 6.2

Functional Description
Reporting

Document Number: 3BTG811796-3031

Document Revision: A
Release: May 2019
—
Notice
This document contains information about one or more ABB products and may include a description of or a
reference to one or more standards that may be generally relevant to the ABB products. The presence of any
such description of a standard or reference to a standard is not a representation that all of the ABB products
referenced in this document support all of the features of the described or referenced standard. In order to
determine the specific features supported by a particular ABB product, the reader should consult the product
specifications for the particular ABB product.
ABB may have one or more patents or pending patent applications protecting the intellectual property in the
ABB products described in this document.
The information in this document is subject to change without notice and should not be construed as a
commitment by ABB. ABB assumes no responsibility for any errors that may appear in this document.
Products described or referenced in this document are designed to be connected, and to communicate
information and data via a secure network. It is the sole responsibility of the system/product owner to provide
and continuously ensure a secure connection between the product and the system network and/or any other
networks that may be connected.
The system/product owners must establish and maintain appropriate measures, including, but not limited to,
the installation of firewalls, application of authentication measures, encryption of data, installation of antivirus
programs, and so on, to protect the system, its products and networks, against security breaches, unauthorized
access, interference, intrusion, leakage, and/or theft of data or information.
ABB verifies the function of released products and updates. However system/product owners are ultimately
responsible to ensure that any system update (including but not limited to code changes, configuration file
changes, third- party software updates or patches, hardware change out, and so on) is compatible with the
security measures implemented. The system/product owners must verify that the system and associated
products function as expected in the environment they are deployed.
In no event shall ABB be liable for direct, indirect, special, incidental or consequential damages of any nature or
kind arising from the use of this document, nor shall ABB be liable for incidental or consequential damages
arising from use of any software or hardware described in this document.
This document and parts thereof must not be reproduced or copied without written permission from ABB, and
the contents thereof must not be imparted to a third party nor used for any unauthorized purpose.
The software or hardware described in this document is furnished under a license and may be used, copied, or
disclosed only in accordance with the terms of such license. This product meets the requirements specified in
EMC Directive 2014/30/EU and in Low Voltage Directive 2014/35/EU.

—
Trademarks
All rights to copyrights, registered trademarks, and trademarks reside with their respective owners.
Copyright © 2019 by ABB.
All rights reserved.
 Table of Contents

INTRODUCTION ............................................................................................................................... 5
General .............................................................................................................................................. 5

FUNCTION BLOCK & DATA TYPES ................................................................................................ 7

Function Block ................................................................................................................................. 7
ReportConfig ............................................................................................................................... 7
ReportData01 .............................................................................................................................. 7
Data Types........................................................................................................................................ 8
ReportData01_InPar ................................................................................................................... 8
ReportData01_OutPar ............................................................................................................... 8
ReportsPar ................................................................................................................................... 8
ReportsValue ............................................................................................................................... 9
Permission ........................................................................................................................................ 9

FUNCTION .......................................................................................................................................11
Shift ..................................................................................................................................................11
Number of Shifts .......................................................................................................................11
ShiftStartTime ...........................................................................................................................11
DayStartTime .............................................................................................................................11
Error Code ...................................................................................................................................11
Function .......................................................................................................................................... 12
Integrator ................................................................................................................................... 12
Counter....................................................................................................................................... 12
Timer ........................................................................................................................................... 12
Control Utilization .................................................................................................................... 12
Reset ........................................................................................................................................... 12
Interaction Window ...................................................................................................................... 13
Text Configuration........................................................................................................................ 14

OPERATOR FUNCTION ................................................................................................................. 15

Process Display.............................................................................................................................. 15
Report Summary ........................................................................................................................... 15
Alarm & Event ................................................................................................................................. 15
Alarm & Event List..................................................................................................................... 15
Alarm & Event Message ........................................................................................................... 15
 INTRODUCTION

General
ReportData01 is a functional unit for reporting in ControlIT, to be operated from 800xA
System. A ReportData01 normally performs a complete function together with ReportConfig.
ReportData01 has the following functions and properties:
· Support up to 4 shifts
· Configurable shift start time
· Store last 3 days value
· Support 4 different type reporting

5
INTRODUCTION
General

6
 FUNCTION BLOCK & DATA TYPES

Function Block

ReportConfig
Name Data Type Direction Initial Value Description
Enable bool in true Enable object
Err bool out Error configuration
ErrNo dint out Error number
ReportsPar ReportsPar out Report parameter

ReportData01
Name Data Type Direction Initial Value Description
Name string in Object name
Description string in Object description
Enable bool in true Enable object
MV01 real in MV01 input
MV02 real in MV02 input
MV03 real in MV03 input
MV04 real in MV04 input
MV05 real in MV05 input
MV06 real in MV06 input
MV07 real in MV07 input
MV08 real in MV08 input
MV09 real in MV09 input
MV10 real in MV10 input
Reset bool in Reset
InPar ReportData01_InPar in Input parameter
ReportsPar ReportsPar in Report parameter
MV01Err bool out MV01 error
MV02Err bool out MV02 error
MV03Err bool out MV03 error
MV04Err bool out MV04 error
MV05Err bool out MV05 error
MV06Err bool out MV06 error
MV07Err bool out MV07 error
MV08Err bool out MV08 error
MV09Err bool out MV09 error
MV10Err bool out MV10 error
OutPar ReportData01_OutPa out Output parameter
r

7
 FUNCTION BLOCK & DATA TYPES
Data Types

Data Types

ReportData01_InPar
ReportData01_InPar data type contains all configuration parameter available in
ReportData01. Configuration can be entered by writing value to this structured data type and
connecting it to input InPar of ReportData01 function block.
Name Data Type Initial Value Description
Class dint cPPInit.Class AE class
Severity dint cPPInit.Severity AE severity
MV01 ReportsConfig MV01 report config
MV02 ReportsConfig MV02 report config
MV03 ReportsConfig MV03 report config
MV04 ReportsConfig MV04 report config
MV05 ReportsConfig MV05 report config
MV06 ReportsConfig MV06 report config
MV07 ReportsConfig MV07 report config
MV08 ReportsConfig MV08 report config
MV09 ReportsConfig MV09 report config
MV10 ReportsConfig MV10 report config
NOTE: Connecting a variable to InPar parameter which has been configured previously via
Interaction Window, will reset the values in Totalizer01_InPar to default value.

ReportData01_OutPar
ReportData01_OutPar data type contains all information on the object which not available on
the output parameter of the function block.
Name Data Type Initial Value Description
MV01 ReportsValue MV01 report value
MV02 ReportsValue MV02 report value
MV03 ReportsValue MV03 report value
MV04 ReportsValue MV04 report value
MV05 ReportsValue MV05 report value
MV06 ReportsValue MV06 report value
MV07 ReportsValue MV07 report value
MV08 ReportsValue MV08 report value
MV09 ReportsValue MV09 report value
MV10 ReportsValue MV10 report value

ReportsPar
ReportsPar data type contains connection between ReportConfig and ReportData01.
Name Data Type Initial Value Description
NoOfShift dint No of shift
D0Date date_and_time Date of today (D0)
D1Date date_and_time Date of yesterday (D-1)

8
 FUNCTION BLOCK & DATA TYPES
Permission

Name Data Type Initial Value Description

D2Date date_and_time Date of previous day (D-2)
StartNewDay bool Start new production day
StartNewShift bool Start new shift
Shift1 bool Shift 1 active
Shift2 bool Shift 2 active
Shift3 bool Shift 3 active
Shift4 bool Shift 4 active

ReportsValue
ReportsValue data type contains all report value from each data.
Name Data Type Initial Value Description
D0Shift1 real Shift1 today
D0Shift2 real Shift2 today
D0Shift3 real Shift3 today
D0Shift4 real Shift4 today
D0Total real Total today
D1Shift1 real Shift1 yesterday
D1Shift2 real Shift2 yesterday
D1Shift3 real Shift3 yesterday
D1Shift4 real Shift4 yesterday
D1Total real Total yesterday
D2Shift1 real Shift1 previous day
D2Shift2 real Shift2 previous day
D2Shift3 real Shift3 previous day
D2Shift4 real Shift4 previous day
D2Total real Total previous day

Permission
All variables in ReportData01_InPar data type are set with Configure permission in 800xA
system.
The variable permission can be configured according to the plant requirement. This can be
done by adding Property Attribute Override aspect for the object in Control Structure or for
the object type in Object Type Structure.

9
FUNCTION BLOCK & DATA TYPES
Permission

10
 FUNCTION

Shift

Number of Shifts
By default, ReportConfig supports 3 shifts. It can be configured to support maximum of 4
shifts. The configuration is stored in project constant cPPLib.Report.NoOfShift.

ShiftStartTime
For each shift, the starting time can be adjusted following the working shift of the mill. The
configuration is stored in project constant cPPLib.Report.ShiftxStartTime, where x is the
shift number. It is a must to configure the shift time in ascending order (clockwise).
Shift start time is based on 24 hours timing. Therefore, Shift starting time cannot be less than
0 or greater than 23.
It is unnecessary to configure the shift start time if that shift is not used. Example: Shift4 start
time will be ignored if only 3 shifts are required.

DayStartTime
DayStartShift refers to the first shift of the day. By default, Shift1 is the first shift. When this
shift is started, the all the values will be transferred to previous day value and today’s value
will be reset.
The configuration is stored in project constant cPPLib.Report.DayStartShift.

Error Code
Any error in above configuration will set the output parameter Err of ReportConfig to True.
ErrNo can be used to trouble the configuration. Below is the error number and its description:
ErrNo Description
0 No err
1 No Shift is configured
2 Number of shifts are exceed the supported number
3 Starting time is less than 0
4 Starting time is more than 23
5 Shift1 and Shift2 have the same start time
6 Shift2 and Shift3 have the same start time
7 Shift3 and Shift4 have the same start time
8 Shift3 and Shift1 have the same start time
9 Shift4 and Shift1 have the same start time
10 Total Shift time is less than 24
11 Total Shift time is more than 24
12 Selected DayStartShift doesn't match with number of shifts

11
 FUNCTION
Function

Function
There are 4 available function can be used in ReportData01. Regardless which function is used,
the MV is in real datatype. Data type conversion from boolean to real may be required before
passing the value to MV.

Integrator
Setting the parameter Types to 1 means selected function is for Integrator.
The total value is calculated from the input MV. It will be incremented on each scan and also
depends on the parameter Scale and TI. The Scale parameter can be used to scale the output
value when there’s a need to convert to different unit. The input TI is used to define the
integration time and should follow the input unit.
For example, the input MV is in kg/h. The input TI shall be set to 1h. If the output is defined as
kg, then input Scale should be set to 1. If the output is defined as tons, then input Scale should
be set to 0.001.

Counter
Setting the parameter Types to 2 means selected function is for counter.
The total value is calculated from the input MV. It will be incremented when MV is changed
from 0 to 1.

Timer
Setting the parameter Types to 3 means selected function is for timer.
It will measure the total duration of how long MV value stay in 1. Timer will be hold when MV
goes to 0. It will resume back when MV is back to 1. Value is shown in minutes.

Control Utilization
Setting the parameter Types to 4 means selected function is for control utilization.
It will measure the total duration of how long MV value stay in 1. Timer will be hold when MV
goes to 0. It will resume back when MV is back to 1. This duration is the measured against the
duration of the shift at that point of time. The value is indicated in percentage.

Reset
Input parameter Reset of ReportData01 can be used to reset the report value.

12
 FUNCTION
Interaction Window

Interaction Window
Interaction Window is used to configure the object’s parameter
in the Control Builder. It is only accessible when Control Builder is
in Online mode by right clicking the function block.
The main Interaction Window shows the name and description of
the function block. The buttons are links to open the sub-window.

General Par
Name and Description can be entered from interaction window
or from the function block parameters directly. After performing
Name Uploader, these values will be used as Object Name and
Description and shown in faceplate.
Class defines the process section or area in which alarms are grouped. By utilizing Class, the
alarms can be filtered. Valid values are 1 - 9999. Severity defines the alarm priority for general
alarms. Valid values are 1 - 1000 where 1000 is the highest priority.

Order & Event Block, Init Mode

Types refers to the different function available for reporting.
Options available are:
1= Totalizer
2= Counter
3= Timer
4= Control Utilization
Scale and Integrator time are only applicable when Totalizer
function is selected.

13
 FUNCTION
Text Configuration

Text Configuration
Text Configuration aspect is used to define the text properties of the object, such as property
name and units. It is accessible in the Control Structure.
Unit is only applicable when Types selected is integrator.

14
 OPERATOR FUNCTION

Process Display
ReportData01 has the following graphic elements which can be inserted into graphic displays.

Report Summary
Report Summary contains the last 3 days value from each shift and total in a day.

Alarm & Event

Alarm & Event List

All alarm & event list aspect is configured to follow the templates defined in PP Library Alarm
& Event List Configurations in Library Structure.

Alarm & Event Message

The Message Description text is stored in PPLib800xA AE aspect which has NLS support. It
can be found in Library Structure > Preferences & Customizations > Pulp and Paper Library.

15