COPELAND Connect+ Enterprise Management Software User Guide

User Guide for COPELAND models including: Connect Enterprise Management Software, Connect, Enterprise Management Software, Management Software, Software

Connect Food Quality Report

Copeland Products and Solutions

Copeland Global

Connect Food Quality Report

File Info : application/pdf, 20 Pages, 1.50MB

026-1028 Connect Food Quality Reports User Guide

Connect+
Food Quality Reports User Guide

USER GUIDE

TABLE OF CONTENTS
1. Food Quality Reports Overview ................................................................................................................................................................1 2. Get Started with FQR ....................................................................................................................................................................................2
2.1 Feature Activation.......................................................................................................................................................................................................................2 2.2 Full List of FQR Properties.......................................................................................................................................................................................................2 3. Configure Food Quality Report .................................................................................................................................................................4 4. FQR Data Gathering .....................................................................................................................................................................................7 4.1 Schedule FQR Data Gathering.............................................................................................................................................................................................7 4.2 Run FQR Data Gathering One Time ..................................................................................................................................................................................7 5. FQR Report Generator..................................................................................................................................................................................8 5.1 Report Generation Activity .....................................................................................................................................................................................................8 5.2 Food Quality Report for Yesterday .....................................................................................................................................................................................9 5.3 Reading the FQR Report....................................................................................................................................................................................................... 10 6. FQR Report Emailing ................................................................................................................................................................................. 12 6.1 FQR Full Report Email ............................................................................................................................................................................................................ 12 6.2 FQR Summary Email............................................................................................................................................................................................................... 14 6.3 FQR Exception Email.............................................................................................................................................................................................................. 16 7. Auto-Fix Previous Reports........................................................................................................................................................................ 17

026-1028 R2 Connect+ Food Quality Reports User Guide

1. Food Quality Reports Overview

Connect+ Food Quality Reports (FQR) help to detect if the case temperature is too high or too low and facilitate the automatic reporting for the purpose of keeping the food safe.
With Connect+ Food Quality Reports, user would have capability to:
· Configure the case High/Low limit.
· Generate FQR report for the site.
· Email the report to the right person.
This document serves as a guide for on-boarding new customers to Connect+ Food Quality Reports (FQR). The screens presented in this guide will help you identify the necessary changes to make and where to configure in FQR. Note that due to user permission settings, some screens may be hidden. The Connect+ user configuring FQR must have administrator access to the system and must log in to view the appropriate properties. The Food Quality Reports license must also be enabled to set up any configuration related to FQR. The FQR is generated based on the circuits in a site, including both Standard, Case Control, and XM Circuits. Currently, FQR is supported in E2 and Site Supervisor controllers.
These are the supported peripheral equipment types for each type of supported case controller:

Case Controller Name

Case Temp Supported

2nd Case Temp Supported

CC100-P (Liquid Pulse)

Yes

CC100-LS (Liquid Stepper)

Yes

CS 100

Yes

EC2-39X

Yes (called Air Temp

on this controller

type)

CCB Liquid Pulse

Yes

CCB Liquid Stepper

Yes

CCB Suction

Yes

Discharge Air Supported
Yes
Yes
Yes Yes (called Air In on this controller
type) Yes Yes Yes

Product Temp Supported
Yes
Yes
Yes No-Level 5 access
required (not supported)
No No No

2nd Value Kit Supported
Yes through Discharge Air
Support No
No
No
Yes No No

026-1028 R2 Connect+ Food Quality Reports User Guide

2. Get Started with FQR
2.1 Feature Activation
Contact Copeland Administrator to first activate the Feature Licensing for FQR. Click Top Menu > Admin Tools > Feature Activation to check the feature licensing is enabled.

Feature Licensing

2.2 Full List of FQR Properties
To enable FQR and configure certain functions, some properties must be set by the administrator in the Superuser property. Login with Superuser permissions, access the property page from Top Menu > Super User > Properties Editor.

Table 1: List of FQR Properties

Property Name

FQRSystemConfigs

SendDetailsAsAttachment

FQRSystemConfigs FQRSystemConfigs

displayFQRSiteAddress label.summaryEmail.instanceName

FQRSystemConfigs

report.DisplayDefrostOnDischargeAir

FQRSystemConfigs

minimumDefrostMinutesAllow edInHour

Default Value false false
false 10 (mins)

Meaning
If there is too much information in the Detail Exception Email or if it is too large, set this to "true" and the information on the FQR Detail Summary Email will be sent as a separate attachment.
Enable this property to show the site address in the FQR report.
Enter a unique name that describes which instance the email is from. It will show in the report name.
Set to "true" if the customer wants to display defrost information on the report where the Discharge Air item is.
The minimum duration that defrost activities take. If it is less than the configuration, the report will not show defrost status.

026-1028 R2 Connect+ Food Quality Reports User Guide

Table 1: List of FQR Properties

FQRSystemConfigs FQRSystemConfigs *FQRSystemConfigs *FQRSystemConfigs *FQRSystemConfigs *FQRSystemConfigs FQRSystemConfigs FQRSystemConfigs *FQRSystemConfigs *FQRSystemConfigs *FQRSystemConfigs
FQRSystemConfigs
FQRSystemConfigs
FQRSystemConfigs

Property Name report.defrost.log.image report.defrost.value.image report.email.attachments.limit.maxKB report.email.exceptionsReports.recipients report.email.exceptionsReportsSummary. recipients report.email.from report.email.fullReports.default.recipient.emails report.email.fullReports.default.recipient.userIDs report.email.isEmailExceptionsReports
report.email.isEmailExceptionsReportsSummary
report.email.minNeedBeZippedReportsCount
report.row.label.prefix.caseTemp
report.row.label.prefix.dischargeAir
eport.row.label.prefix.productProbe

Default Value
3000
true true
4 case Disch Air Product

Meaning
Path to the image used on the report that will show for a logged defrost.
Path to the image used on the report for a scheduled defrost.
The maximum size (in KB) an attachment can be for reports. This is to conform to the email size restrictions that a server may have.
Detail Exception recipient email addresses, each separated by a comma.
Summary recipient email addresses, each separated by a comma.
The "From" email address for emails. Usually for Copeland hosted, this is set to: noreply@copeland.com
Email address(es) that will be the default recipients of the full reports email on the configuration page.
User ID of the user who will be the default recipient for full reports from the configuration page.
Set to "true" if the system should email the Detail Summary emails. If this is "false," no emails for Detail Summary will be sent.
Set to "true" if the system should email the Summary emails. If this is "false," no emails for Detail Summary will be sent.
If the number of reports is equal or more than this number, all of the reports will be zipped and sent as an attachment to the email.
Allows the label on the Food Quality Report itself to be changed for Case Temp. Note: The label will be reflected on the FQRs that are run after this change is made.
Allows the label on the Food Quality Report itself to be changed for Discharge Air. Note: The label will be reflected on the FQRs that are run after this change is made.
Allows the label on the Food Quality Report itself to be changed for Product Probes. Note: The label will be reflected on the FQRs that are run after this change is made

026-1028 R2 Connect+ Food Quality Reports User Guide

3. Configure Food Quality Report
There are defaults for all items in the FQR Configuration screen, but most likely, you will want to view and change some of the configurations. To navigate to the Food Quality Report Configuration page, right-click on one tree node from the Directory to the Application Instance level, select Food Quality > Configure Food Quality Report.
NOTE: The configuration menu on Standard, Case Control, XM Circuits and supported peripheral equipment types are only visible.

Configure Food Quality Report

026-1028 R2 Connect+ Food Quality Reports User Guide

Food Quality Report Configuration Screen
4

The configured values will be stored on the tree level from where the page was accessed (as indicated in the Item field). The values will then be used for any report items at the indicated level and the below levels, unless a specific set of values is set for a below level. The Food Quality Report Configuration page is divided into two sections. The top part of the page (above "OR") shows the default settings. The bottom part (below "OR") shows the customizable settings for the indicated level and below levels. Choose one of the two sections by enabling the appropriate radio button. The options available for the bottom section of the Configuration Page are below: · Use rules below for calculating High and Low Limit - Enable this checkbox to include the formula rules below for case
temperatures and Discharge Air (user-defined configured) instead of the rules above.
Formulas will allow the high and low boundaries on the Food Quality Report to "float" with the setpoint of the individual circuit.

· Copy Default Rules Now - Click this button to use the default rules from the default setting.
· Use Fixed Values For High and Low Limit (on case temperatures) - When this checkbox is selected, the formulas will be changed to fixed values. The high and low boundaries on the Food Quality Report will be fixed for this circuit regardless of the setpoint value of the circuit.

· Exclude from the Report Generation for FQR - When selected, the current level (usually application instance) will be excluded from the FQR.
· Exclude all Case Temperatures - Enabling this option will exclude all Case temperatures for all circuits, both Case Control, Standard and XM, from the Food Quality Report.

026-1028 R2 Connect+ Food Quality Reports User Guide

· Include Product Simulator Probes - Enable this checkbox to include product simulator probes in the Food Quality Report. Allows configuration of the Product Temp Probes.
· Include all Discharge Air configured - If this checkbox is enabled, the Discharge Air for Case Control devices will be included in the Food Quality Report.
· Exclude Related Case Temperatures - Enable this checkbox to exclude Case Temperatures in the Food Quality Report for which devices have Discharge Air. Note that Case Temperatures are included by default.
· Logo file - Logo file can be selected (optional). · Email full report from the current level and below to these users - Allows the selected users of this list to receive the
Food Quality Report each day by email from this current level and below. Usually, this is used when the Store Manager needs to get the reports each day.

· Include users who currently have report emailing from above this level - When this checkbox is enabled, all users listed at the top part of the page (above "OR") will also receive the report each day. When this checkbox is disabled, only the users who are selected in the "Users" list and those in the "Additional Email Addresses" list will receive an email of the report each day. This feature is beneficial, for example, when a Regional Manager wants to receive only some reports. This report will be added at a level above this one, but this check box should be enabled only to send this report to Store Managers.

After the configuration is done. Click the Save button.

026-1028 R2 Connect+ Food Quality Reports User Guide

4. FQR Data Gathering
Before the Food Quality report is generated, gather the data first. The activity can be scheduled set to execute on demand.
4.1 Schedule FQR Data Gathering
Go to Top Menu > Activity > Schedule Manager, choose Activity Type as FQR Data Gathering. Set the schedule detail of the activity (for example, when will the activity run for the first time, the starting and ending date and time of succeeding Smart Retries, and more). Choose the date range you want to gather, and click Save after the configuration is finished.

Schedule Manager Screen
If you need to generate the report right away once data gathering is completed, you can check Create Report PDF Files. An electronic copy of the report will be generated under the tomcat folder ...\webapps\copeland\vault\FQR-Reports in the server. If the activity is on-demand, it will automatically be downloaded as a compressed package or shown as PDF on a new tab for one day of a single site. (Verify your browser is set to allow pop-ups to open) once data gathering is completed.
4.2 Run FQR Data Gathering One Time
FQR Data Gathering can be run on demand. Right click on directory or site, select Food Quality > FQR Data Gathering.

026-1028 R2 Connect+ Food Quality Reports User Guide

5. FQR Report Generator
5.1 Report Generation Activity
Before report generation, verify the data have been retrieved in Connect+. You can generate FQR report for a directory or a site by schedule or demand. Choose FQR Report Generation in Schedule Manager type, or right-click on directory or site level, and select Food Quality > FQR Report Generation.

FQR Report Generation
Choose the date range or the number of days that you want the report to be generated.

PDF Report File Date

026-1028 R2 Connect+ Food Quality Reports User Guide

File Date

Once all configurations are done, click Go to start the report generation activity. The report will be generated as a PDF after the activity has completed. It is generated based on one site per day, if the reports you generated are for multiple sites or several days, they will be presented in a compressed package. When the user selects Today as the Number of Days Back or Date Range, which includes today's date, the FQR Data Gathering activity will be executed before the report is generated. This means that the report will not be generated as quickly.
5.2 Food Quality Report for Yesterday
If you want to quickly generate yesterday's FQR report for review, right-click on a Directory or Site, select Food Quality > FOOD QUALITY REPORT for Yesterday.
Food Quality Report for Yesterday A system job will gather FQR data every day at 1:00 AM by default, but the schedule time is configurable.
Schedule Assistant Screen

026-1028 R2 Connect+ Food Quality Reports User Guide

5.3 Reading the FQR Report
The report will be generated for one site per day. By default, it is named as <SiteName>_YYYYMMDD.pdf. If multiple reports are generated, usually for a directory or multiple day, all the reports will be zipped up into one file. Here is an example of the report:

Sample Report
1. Legend: Each report will have a legend displayed at the top of the page. Symbols and colors used in the report denote the status of a food case or circuit for a given hour.

· A cell with a white background denotes that the hourly average temperature of a case is within the High and Low limit range; the case/circuit temperature for that hour is "Normal."
· A cell with a blue background denotes the hourly average temperature of a case falls below the Low limit indicating the case/circuit was "too cold" for that certain hour.
· A cell with a red background denotes that the hourly average temperature of a case exceeds the High limit indicating the case/circuit was "too hot."
· The defrost icon denotes that defrost occurred during that hour.
· The scheduled defrost icon denotes that a scheduled defrost occurred for more than 10 minutes. · Dash lines (---) denote that no log data was retrieved for the corresponding hour, indicating that the data could be retrieved
later.
· The symbol indicates that errors in data were identified for the corresponding hour, indicating that the data in the controller is either invalid or non-existent.

026-1028 R2 Connect+ Food Quality Reports User Guide

2. Report name:

5. SEPT: It is the value of ACTIVE SETPT. If the ACTIVE SETPT configured with log, it will show the average data of the day, otherwise, it shows the real-time data of this point.

3. Logo: you can change the logo from Food Quality Report Configuration (Refer to Section 3 - "Configure Food Quality Report" on page 4).
4. Item: The items on the left hand side are names of circuits in alphabetical order.
· The Standard Circuit/Case Circuit/XM Circuit with Case Temp: Circuit name (case #)
· Standard Circuit/Case Circuit/XM Circuit with Product Temp: Circuit name (Product #)

6. Low/High: The High and Low limit boundaries are calculated based on the Setpoint (ACTIVE SETPT) and what the user wants the range variance to be (configured in Food Quality Configuration page). These boundaries are used in the right-hand hourly columns of the report to show if the item was too hot (red background) or too cold (blue background).

· If the Case Circuit associated with a device, the device with Case Temp will display the name as: Circuit name (Device name #)

7. Hourly Value: There will be 1 column on the right for each hour of the day (0-23). The value in each column for a given row is the average for that hour from the log data. If the point is not configured with a log, it is the real time data. The points from which the data is retrieved will correspond to the name found in the left column.

· If the Case Circuit associated with a device, the device with Product Temp will display the name as: Circuit name (Product: Device name)
· If the Standard Case Circuit associated with a device, the device with Discharge Air will display the name as: Circuit name (Discharge Air #: Device name)

The Defrost point log will be evaluated to determine if the defrost is present during hours of the day for the current day, and if the Defrost is present for a given
hour, the Defrost icon will show on the report. If the Defrost is configured as schedule, it will show a
scheduled defrost icon .
8. Address: To show your site address at the bottom of the report, enable the FQRSystemConfigs. displayFQRSiteAddress with administrator privileges. The address will be read from Site Configuration page. For example:

026-1028 R2 Connect+ Food Quality Reports User Guide

6. FQR Report Emailing

There are three types of FQR emails. Users can be configured to receive any of these emails depending on their roles and needs:
a. FQR Full Report Email - Sends an email with the corresponding FQRs for the site to which the user has been assigned. The FQRs are sent in PDF format as a separate files or a ZIP file (more than 3 files will combine with a ZIP file) attachment and is recommended for end-users without administrator responsibilities.
b. FQR Summary Email - Includes a table showing a summary of the reports that were run for the last seven (7) days and how many were completed successfully, as well as a table listing the sites that had exceptions for the last seven days. The information is in the body of the email without attachments and is recommended for system administrators who do not want to view entire reports and want to keep their Inbox to a minimum size.
c. FQR Exception Details Email - The same as FQR Summary email but with additional details about the type of errors for each site that had exceptions. It will also have the corresponding site reports with exceptions attached in PDF format as a ZIP file and is recommended for system administrators who want to review reports and detailed failures for each site.

The configuration procedures for these three types are described in the following sections:
6.1 FQR Full Report Email
The Full Report email will include all the reports that the user is allowed access to, attached as a PDF file or within a ZIP file. Please note that the attachment report ZIP is limited to the size property FQRSystemConfigs > report.email.attachments. limit.maxKB that is configured by the administrator. It can be changed to any value for that installation that the system or email server can handle. Before emailing, verify the below properties are configured by the administrator:
Table 2: Property Settings

Property Name Mail.smtp.host report.email.fullReports.default.recipient.e mails report.email.from

Set Property Value To <the server name that could send, receive the mail > <the email of the person who will receive all reports> <the from address as shown in the email for all FQR emails>

The report.email.fullReports.default.recipient.emails is configured for global, after it has been configured, it will display in the default section above "OR" in blue text in the FQR Configuration page, and will be inherit at directory level.

026-1028 R2 Connect+ Food Quality Reports User Guide

FQR Configuration Screen
12

If report emailing has already been configured for a directory, the names and email addresses of the users configured for report emailing will display in the default section above "OR" in blue text for the site. If configuring report emailing for the first time, this area will be blank. To configure this functionality, follow the steps below:
1. Enable the Enter values specifically for this item radio button (under the "OR" section) to configure report emailing for the navigation tree level you are on.
2. Enable the Email full report from the current level and below to these users by configuring the radio button to configure an email list. When the checkbox is selected, a Users box will display the names and email addresses of users configured in Connect+, and the Additional Email Addresses box will appear.
3. Configure an email list for the current level. · Under Users, enable the checkbox next to the username that you wish to add in the email list. Users will get reports only for
sites that they are given permission to access. If a user is selected from the list but does not have access to a given site, the user will not receive FQR emails for that site. · Additional email addresses may be entered into the Additional Email Addresses box. One or more email addresses can be entered. Use a comma (,) between email addresses to separate them.
4. (Optional) If accessing the page from a Site level and the Directory's email list needs to be added to the current Site's email list, enable the Include users who currently have report emailing from above this level checkbox. Enable this checkbox if the email address(es) above the current level should receive the report in addition to the users selected in the User box and the Additional Email Addresses box; otherwise, disable the checkbox to send the report only to the email addresses selected in the User and Additional Email Addresses boxes.
5. Click Save at the top of the page.
When FQR is run from this level and the report is generated, the reports will be sent out by email after a system job FQRReportEmailJob is executed.

FQRReportEmailJob Sample
The email recipients list will receive an email with the report attachment. If three or less reports were generated, individual reports (PDF) will be attached to the email. If more than three reports were generated, the reports will be attached to the email as a zipped file (ZIP). The report.email.from property must have a valid email-formatted address for emailing to be set up properly.

026-1028 R2 Connect+ Food Quality Reports User Guide

6.2 FQR Summary Email
The FQR Summary Email will include a table showing a summary of the reports that were run for the last seven (7) days and how many were completed successfully as well as a table listing the sites that had exceptions for the last seven days.

FQR Report Summary
For the Complete & Incomplete Report Counts table, each of the last seven days shows a column with the most current day appearing on the far right.

FQR Complete and Incomplete Report Counts
· The row for Completed Reports shows how many FQRs were completed without data gaps. · The row for Incomplete Reports shows how many FQRs had data gaps present. · The row for Percent Complete shows how complete the total was for that day.

026-1028 R2 Connect+ Food Quality Reports User Guide

For the Report Exception Counts table:

Report Exception Counts

· Yellow background = data gap for that day. · White background and a number greater than 0 = a minor exception for that day. · White background with a 0 = report was complete for that day.

One example is a defrost schedule or log was missing for that day. For the Error Message Definitions below, note that the numbers in each column represent the summation of error types, and also note that detailed error messages are only reflected in the FQR Exceptions Email:

Table 3: Error Message Definitions

Errors Related to Defrost

Defrost Log

Defrost Schedule

Yes but less than 10 minutes

Yes

Causes For Other Errors
Data gathering error - this may occur due to network connection or transmission error.
Data Error - the data is not valid .This occurs when a value other than OK is reflected in the retrieved log data. Types of possible errors detected are: · No Data · Failure on Point · Point is Inactive · Data is Missing · Not Applicable · Not Active · No Value

Error Message As It Appears On FQR Exceptions Emailed Report
Defrost Log Data Not Found Defrost Log Data Not Found Neither Defrost Log Nor Defrost Schedule Is Found Error Message As It Appears On FQR Exceptions Email Temperature Log Not Found
Invalid Temperature Log Data

026-1028 R2 Connect+ Food Quality Reports User Guide

Before sending the summary report, verify the below properties have been configured by the administrator. Table 4: Property Settings

Property Name report.email.isEmailExceptionReportsSummary
report.email.exceptionsReportsSummary.recipients

Set Property Value To
true
<the email addresses that will receive the report> (Note that these email addresses do not currently have to be
users in the Connect+ system.)

6.3 FQR Exception Email
The FQR Exception Details Email will include the same two tables as the FQR Summary Email with the additional detail of each site that had exceptions, as well as the type of exceptions. It will also have the corresponding site reports with exceptions attached in PDF format.

FQR Summary

026-1028 R2 Connect+ Food Quality Reports User Guide

7. Auto-Fix Previous Reports
When the FQR Generation job runs, it will automatically attempt to auto-repair any pending errors in reports generated on previous days. This is a default feature of the system and does not need to be enabled. If there are pending errors/exceptions: · The system will attempt to regenerate and auto-repair any reports with pending exceptions if missing data is found in the
most recent data logs retrieved. (The table will show a maximum of 7 days, but the system will continue to search back if there are pending errors farther back than 7 days). · Note that the system's ability to auto-repair any exceptions is limited by the controller's log memory setting. For example, if there is an error 21 days ago, but the controller is set to maintain only 2 weeks (14 days) of log data, the error cannot be auto-repaired past day 14, even if the condition causing the error (for example, a network communication problem) has been cleared.
FQR Summary

026-1028 R2 Connect+ Food Quality Reports User Guide

Visit our website at copeland.com/en-us/products/controls-monitoring-systems for the latest technical documentation and updates. For Technical Support call 833-409-7505 or email ColdChain.TechnicalServices@Copeland.com
The contents of this publication are presented for informational purposes only and they are not to be construed as warranties or guarantees, express or implied, regarding the products or services described herein or their use or applicability. Copeland reserves the right to modify the designs or specifications of such products at any time without notice. Responsibility for proper selection, use and maintenance of any product remains solely with the purchaser and enduser. ©2024 Copeland is a trademark of Copeland LP.
0261028 R2

References

Adobe PDF Library 17.0