Contents

Carrier Trend Export v2 User's Manual PDF

1 of 17
1 of 17

Summary of Content for Carrier Trend Export v2 User's Manual PDF

Trend Export v2.5 for v8.0

Catalog No. 11-808-838-01

Rev. 2/16/2021

Important changes are listed in Document Revision History at the end of this document. All rights reserved throughout the world. All trademarks are the property of their respective owners. The content of this guide is furnished for informational use only and is subject to change without notice. Carrier assumes no responsibility or liability for any errors or inaccuracies that may appear in the informational content contained in this guide.

Contents What is the Trend Export add-on? ............................................................................................................. 1

Prerequisites .................................................................................................................................. 1 What's new in Trend Export 2.3.2? ................................................................................................. 2

Connecting to the Export Trends database ................................................................................................. 2 Working with groups ................................................................................................................................ 2

To view your groups ........................................................................................................................ 3 To view a group's export history ...................................................................................................... 3 To edit a group ............................................................................................................................... 4

Managing the system settings .................................................................................................................. 5 Scheduling groups for export .................................................................................................................... 5 Viewing which trend sources are configured for export ................................................................................ 6 Viewing the Trend Data Export History ....................................................................................................... 7 Appendix ................................................................................................................................................ 8

Index file ........................................................................................................................................ 8 RunParameters file ......................................................................................................................... 9 CSV files ...................................................................................................................................... 10 Uploading files to a remote user ................................................................................................... 12

Document revision history ...................................................................................................................... 14

All trademarks used herein are the property of their respective owners.

Trend Export v2.5 Proprietary and Confidential 2021 Carrier. All rights reserved. Rev. 2/16/2021 A Carrier Company 1

What is the Trend Export add-on?

The Trend Export add-on allows you to specify, manage, and export: trend source data to .csv files trend source data into zipped folders of multiple .csv files trend source data into an external database You can export the files on-demand at any time or at scheduled intervals allowing you to process or analyze trend data outside of your building automation system.

TIPS If exporting to a database, we recommend having access to a database administrator or someone

comfortable in setting up databases while setting up this add-on. To ensure a daily sample for all points that are sampling on COV, set the trend to collect a daily

midnight sample. Edit the setting on the driver's Properties page under Trend Sampling. If trend data is being exported for external consumption, verify at what frequency they are

expecting to receive the data. For example, if they expect the data every 15 minutes, set the trend interval for less than 15 minutes and write to Trend Historian every few samples.

CAUTION: If you are upgrading from a previous version of Trend Export and wish to avoid losing any data, you must uninstall the previous version while keeping the data. (See Installing an Add-on User Guide for more information.)

Prerequisites 1 If you want to use your existing v6.0 or earlier Trend database as the source database for the

Trend Export add-on, first replicate the database, then use the replica for Trend Export. 2 You have upgraded to v8.0 and installed the latest cumulative patch 3 You have downloaded trendexport.addon 4 You have purchased and downloaded the Trend Export license 5 You have adequate disk space available to store the exported files (see "Scheduling your groups

for export (page 5)") See "Installing an Add-on User Guide" for the following: Installing an add-on Applying a license Running an add-on Upgrading an add-on

All trademarks used herein are the property of their respective owners.

Trend Export v2.5 Proprietary and Confidential 2021 Carrier. All rights reserved. Rev. 2/16/2021 A Carrier Company 2

What's new in Trend Export 2.3.2? The 2.3.2 release of Trend Export contains the following enhancements: Ability to export to an external database. This database uses the pre-v6.5 schema. Ability to write the display path for each trend source into the CSV export files Ability to use your Dealer License now

Connecting to the Export Trends database

If you plan to export to a database, you must connect your newly created Trends database copy to the add-on. 1 Click Settings > Database Settings to enter the following information (see table below). 2 Click Test Connection to verify the database is communicating.

Main Database Connect String:

Database Type Select the type of database from the droplist used by your Trend Export database.

Server Type the name or IP address of the machine that the Export Trends database is on.

Port Type the port number the Export Trends database will use for communication.

Instance The name for your Export Trends database.

Database User:

Login Type your database user login name.

Password Type your database user password.

Trend Database Expiration:

Enable Trend Expiration

Check this checkbox to prevent the Trend Export database from becoming too large and enter a value in the Trend Expiration Interval Days field below.

Trend Expiration Interval Days

Type a value between 1 and 999 appropriate to the size of your database.

Working with groups

You can assign trend data sources to groups that allow you to collect the data and send it to .csv files or an external database on-demand or at scheduled times for a specified time range. You can create and manage your groups on the Manage Groups page.

All trademarks used herein are the property of their respective owners.

Trend Export v2.5 Proprietary and Confidential 2021 Carrier. All rights reserved. Rev. 2/16/2021 A Carrier Company 3

To view your groups Use the Trend Group Definitions table when managing your groups of trend data sources. 1 Click the Manage Groups tab. 2 View the list of groups in the list under Trend Group Definitions.

Use this button... to...

Copy copy an existing group to create a new one; then edit as needed.

Edit display the Edit Group Definition table; list appears below the Trend Group Definitions table. See Editing Group Definitions.

Delete delete the group from the list.

List display the list of trend sources configured for export; list appears below the Trend Group Definitions table.

History display the list of data collections already run; list appears below the Trend Group Definitions table. See Trend Data Export History (page 7).

limit the number of groups displayed in the table.

To view a group's export history Use the Trend Data Export History table on the Manage Groups tab to view the detailed history of each of your trend data runs for a single group.

To display the Export History table Click the Trend History button ( ) to the right of the group name.

All trademarks used herein are the property of their respective owners.

Trend Export v2.5 Proprietary and Confidential 2021 Carrier. All rights reserved. Rev. 2/16/2021 A Carrier Company 4

To edit a group Use the Edit Group Definitions table when managing your groups of trend data sources. 1 Click the Manage Groups tab.

2 Scroll through the list and select the group in the list or click Edit ( ) to the left of the entry. 3 Edit the fields as needed (see To create a new group for field information). 4 Click Update Data. NOTE If you decide not to save your changes, you can scroll up to the Trend Group Definitions table and click anywhere in the list before clicking Update Data.

All trademarks used herein are the property of their respective owners.

Trend Export v2.5 Proprietary and Confidential 2021 Carrier. All rights reserved. Rev. 2/16/2021 A Carrier Company 5

Managing the system settings

Use the System Settings tab to manage the export process settings and to view the definitions of the schedule types used by any of your groups.

To edit the system site settings 1 Click the System Settings tab to edit any of the following fields:

Field Description

Enable artifact auto-deletion Enable to delete any artifacts older than the number of days defined in the following field.

Delete artifacts on disk older than specified # of days

Automatically deletes artifacts older than the number of days entered; specify up to 180 days. Adjust this value if you find the file sizes too large.

Suspend export process Enable to immediately stop the export process for any groups actively being exported or ready to be exported.

Export artifact directory Name of the archive directory location within the trend export add-on folder.

Site identifier Unique name for the system site - this allows many systems or hierarchical systems to save archive files in a common shared directory without the potential for filename collisions.

Daily schedule start hour For daily run, select the hour of the day you want the export to start

Hourly schedule start minutes For hourly run, select the minute within the hour you want the export to start

Enable verbose logging Check this checkbox to log additional information as directed by Technical Support.

2 Click Save Settings.

To view the schedule type definitions Click the System Settings tab and view the definitions for Daily and Hourly exports.

Scheduling groups for export

You can export in two ways - on a set schedule or immediately:

Set up an export schedule Use this method to set up a schedule that always runs at a a specific time. You can set this up when you create your group on the Edit Group Definition page for the group. Or, the schedule can be edited any time later.

All trademarks used herein are the property of their respective owners.

Trend Export v2.5 Proprietary and Confidential 2021 Carrier. All rights reserved. Rev. 2/16/2021 A Carrier Company 6

Manually export immediately Use this method when you don't need the export performed on a set schedule. For example: when setting up a new group, you could manually export to determine the size of the file created. when you create a group that doesn't need to be run on a regular basis. Use the Manual Export button on the Manage Groups tab to export your groups as needed. Under

Manual Export, select the time range desired, then click the Manual Export button ( ) to the right of the group:

Viewing which trend sources are configured for export

Use the Edit Group Definitions table when managing your groups of trend data sources. 1 Click the Manage Groups tab. 2 Scroll through the list to verify which trend sources have been configured for export. 3 Click the arrows on the column headers to sort the list.

All trademarks used herein are the property of their respective owners.

Trend Export v2.5 Proprietary and Confidential 2021 Carrier. All rights reserved. Rev. 2/16/2021 A Carrier Company 7

Viewing the Trend Data Export History

Use the Trend Data Export History table on the Export History tab to view the detailed history of each of your trend data runs. NOTES Any failed items in the list are highlighted in red. Filter the list by entering a Group Name or by selecting an item from the Schedule or Status

droplist. Sort the list by clicking on any column header names that are followed by up or down arrows.

Download any of the history files by clicking the Download button ( ) to the left of the file you want to save or view.

Each time the trend data is collected, the following files are produced: When the export starts for each group, a folder is created in the webapps directory of the current

system. The artifact is uniquely named with the combination of GroupID, ScheduleID and the export timestamp.

A folder is converted to a .zip file on successful completion of the export process. The .zip file has details on run parameters, index file, and file description.

Multisource .csv files include individual trend IDs in the file description.

All trademarks used herein are the property of their respective owners.

Trend Export v2.5 Proprietary and Confidential 2021 Carrier. All rights reserved. Rev. 2/16/2021 A Carrier Company 8

Appendix

Index file The INDEX.json file is in the .zip file found in /webroot/system/webapp_public/trendexport/exportartifacts. The index file contains the table of contents of the .zip file which describe the format of the: CSV files (headers) Meta data describing the trend's source ID, display path, display name, and location (system

reference name) contained here. The trend's source ID value is very important, as it is used in the name of the single source CSV files stored as a peer to this file.

NOTE If you move a piece of equipment within the tree, a new sourceId is assigned to it at the new location.

Where to find the INDEX file

What is in the INDEX file Code Fields Descriptions

sourceId Unique identifier for the trend source EXAMPLE: 0041F3A03F882A09Ba88B6B1AD51E4Db

displayPath Path to the trend source in the GEO tree EXAMPLE: BAS / OA Conditions / update stamp

displayName Name displayed for the trend source EXAMPLE: update stamp

locationId Location of the trend in the GEO tree If this changes, a new sourceId is assigned to the trend at the new location EXAMPLE: ABSPATH:1:#oa_conditions/update stamp_tn

All trademarks used herein are the property of their respective owners.

Trend Export v2.5 Proprietary and Confidential 2021 Carrier. All rights reserved. Rev. 2/16/2021 A Carrier Company 9

EXAMPLE: {

"description" : "Trend Export Source Index",

"combinedTidFileCsvHeaders" : [ "sourceId", "sampleTime", "sampleValue" ],

"separateTidFileCsvHeaders" : [ "sampleTime", "sampleValue" ],

"indexEntries" : [ {

"sourceId" : "0041F3A03F882A09BA88B6B1AD51E4DB",

"displayPath" : "BAS / OA Conditions / update stamp",

"displayName" : "update stamp",

"locationId" : "ABSPATH:1:#oa_conditions/update stamp_tn",

"error" : ""

}, {

"sourceId" : "01004E03A392A09BA88B6B1AD57F2894",

"displayPath" : "BAS / Zone Applications / VAV Terminal ZS / Heat",

"displayName" : "Heat",

"locationId" : "ABSPATH:1:#vav_terminal_zs_/heat_tn",

"error" : ""

}, {

"sourceId" : "00403F8827A1F3A14A392A09Ba88B6B1",

"displayPath" : "BAS / Zone Appilcations / VAV AHU / Sup Fan S/S",

"displayName" : "Sup Fan S/S",

"locationId" : "ABSPATH:1:#vav_ahu/sfan",

"error" : ""

}

RunParameters file The RUNPARAMETERS.json file is in the .zip file found in /webroot/system/webapp_public/trendexport/exportartifacts. This file contains runtime information from the export operation instance: Selection data range Schedule name Status Stats such as sample count, trend source count, start and end times

All trademarks used herein are the property of their respective owners.

Trend Export v2.5 Proprietary and Confidential 2021 Carrier. All rights reserved. Rev. 2/16/2021 A Carrier Company 10

EXAMPLE:

RUNPARAMETERS.json {

"description" : "Trend Export Runtime Parameters",

"groupName" : "MELGR25 AIBI",

"groupId" : "MELGR25AIBI",

"scheduleId" : "hourly",

"runStatus" : "@lang_Artifact_Success",

"totalSampleCount" : 14077602,

"trendSourceCount" : 1600,

"exportStartTime" : "Tue Sep 13 10:00:00 EDT 2016",

"exportStartTimeMs" : 1473775200062,

"exportEndTime" : "Tue Sep 13 10:01:17 EDT 2016",

"exportEndTimeMs" : 1473775277177,

"scheduledStartTime" : "Tue Sep 13 10:00:00 EDT 2016",

"scheduledStartTimeMs" : 1473775200000,

"artifactFileName" :

"F:\\BAS6.5_TESTING\\webroot\\de1627\\webapp_public\\trendexport\\exportartifacts\\MELGR25AIBI_hourly_SiteI

d_09-13-2016-10_00_00_AM_EDT.zip",

"exportDurationMs" : 77115,

"exportDurationStr" : "00:01:17",

"artifactLink" : "",

"artifactId" : "MELGR25AIBI_hourly_SiteId_09-13-2016-10_00_00_AM_EDT",

"failureCount" : 0

}

CSV files Depending on how each Trend Group was defined to be exported, the trend sample data is provided in one of the following file formats: A .zip file containing multiple.csv files per source - one for each source in the group.

Example: TrendData_0041F3A03F882A09Ba88B6B1AD51E4Db.csv A single combined .csv file containing data from all sources in the group.

Example: Combined.csv

CSV files per source

All trademarks used herein are the property of their respective owners.

Trend Export v2.5 Proprietary and Confidential 2021 Carrier. All rights reserved. Rev. 2/16/2021 A Carrier Company 11

EXAMPLE:

Combined.csv One .csv file for the group

EXAMPLE:

All trademarks used herein are the property of their respective owners.

Trend Export v2.5 Proprietary and Confidential 2021 Carrier. All rights reserved. Rev. 2/16/2021 A Carrier Company 12

Uploading files to a remote user If updated or newly created artifact files must be uploaded to a remote server, the process can be automated. While there are many ways to do this, below is one method to accomplish it in a Windows environment.

Tools required Use... to...

WinSCP - FTP client push or upload the artifact files. https://winscp.net/eng/index.php

Windows Task Scheduler automate the upload using the Microsoft Windows Scheduling tool found in the Control Panel.

In the example below, this task will run every five minutes, executing a script. The script will then synchronize the data, uploading any changed or newly created artifacts to the remote location.

Step 1: Set up FTP client 1 Verify that the remote location where the files will be pushed has already been defined and

configured. 2 Verify that the remote location has an FTP server listening for incoming files. 3 Set up the FTP client using a script. The script will open the FTP connection pointing to the remote

FTP server and upload the files. For more information regarding the FTP client, see the link above. Script.txt

open ftp://username:password@xxx.xxx.xxx.xxx/

synchronize -filemask="*.zip" remote c:\temp\artifacts\ /home/storedata

exit

The "synchronize" step in the script above is used to detect changes in the source folder. For additional information on the syntax of the script file including encryption options, see https://winscp.net/eng/docs/scriptcommand_synchronize#examples NOTE If you chose to use a different FTP client, it may not contain a synchronize feature similar to WinSCP. If it does not, you must implement an additional step, such as a batch file, that manually checks for file changes in the artifacts folder.

Step 2: Automate the upload process when modifications are present 1 Launch Task Scheduler from Control Panel > Administrative Tools. 2 Under Actions, click Create Task. 3 On the General tab:

a) Type a file name, such as ftp. b) Select Run whether user is logged on or not. c) Check Run with highest privileges.

All trademarks used herein are the property of their respective owners.

Trend Export v2.5 Proprietary and Confidential 2021 Carrier. All rights reserved. Rev. 2/16/2021 A Carrier Company 13

4 On the Triggers tab: a) Click New. b) Under Settings, select Daily. c) Under Advanced Settings, check Repeat task every; then select time increment such as every

5 minutes. d) Select Enabled. e) Click OK.

5 On the Actions tab: a) Click New. b) Under Settings, browse to WinSCP.exe:

C:\Program Files (x86)\WinSCP\WinSCP.exe c) In the Add arguments text field, type:

/log=C:\LogfileDir\WinSCP.log /script=C:\LogfileDir\script.txt d) Click OK.

6 Click OK.

All trademarks used herein are the property of their respective owners.

Trend Export v2.5 Proprietary and Confidential 2021 Carrier. All rights reserved. Rev. 2/16/2021 A Carrier Company 14

Document revision history

Important changes to this document are listed below. Minor changes

Manualsnet FAQs

If you want to find out how the Trend Export Carrier works, you can view and download the Carrier Trend Export v2 User's Manual on the Manualsnet website.

Yes, we have the User's Manual for Carrier Trend Export as well as other Carrier manuals. All you need to do is to use our search bar and find the user manual that you are looking for.

The User's Manual should include all the details that are needed to use a Carrier Trend Export. Full manuals and user guide PDFs can be downloaded from Manualsnet.com.

The best way to navigate the Carrier Trend Export v2 User's Manual is by checking the Table of Contents at the top of the page where available. This allows you to navigate a manual by jumping to the section you are looking for.

This Carrier Trend Export v2 User's Manual consists of sections like Table of Contents, to name a few. For easier navigation, use the Table of Contents in the upper left corner.

You can download Carrier Trend Export v2 User's Manual free of charge simply by clicking the “download” button in the upper right corner of any manuals page. This feature allows you to download any manual in a couple of seconds and is generally in PDF format. You can also save a manual for later by adding it to your saved documents in the user profile.

To be able to print Carrier Trend Export v2 User's Manual, simply download the document to your computer. Once downloaded, open the PDF file and print the Carrier Trend Export v2 User's Manual as you would any other document. This can usually be achieved by clicking on “File” and then “Print” from the menu bar.