companion/facilitator opc server user's guide

Table of Contents Companion/Facilitator OPC Server User’s Guide

Chapter 1 Using This Guide .......................................................1-1

Introduction...................................................................................................... 1-1

Key Concepts................................................................................................... 1-3

Chapter Organization .....................................................................................................1-3 Online Help ....................................................................................................................1-3

Chapter 2 Getting Started ....................................................................2-1

Introduction...................................................................................................... 2-1

Key Concepts................................................................................................... 2-2

Configurations ................................................................................................................2-2 CF Connect ....................................................................................................................2-3 CF Terminal ...................................................................................................................2-4 Mouse Capabilities.........................................................................................................2-5 Printing ...........................................................................................................................2-5 Site Phone Book ............................................................................................................2-6

Password....................................................................................................... 2-6

Procedure Overview........................................................................................ 2-7

Detailed Procedures........................................................................................ 2-8

Setting Up Your Modem for the M3 Workstation............................................................2-8 Defining Communication Settings ..................................................................................2-9

© January, 2001 Johnson Controls, Inc. www.johnsoncontrols.com

2 CF OPC Server User’s Guide

Connecting and Logging In to a Direct Connect Site ...................................................2-10 Connecting and Logging In to a Dial-up Site................................................................2-11 Disconnecting from a Site ............................................................................................2-12 Adding a Site Entry ......................................................................................................2-12 Editing a Site Entry.......................................................................................................2-15 Deleting a Site Entry ....................................................................................................2-16

Troubleshooting ............................................................................................ 2-17

CF Connect Troubleshooting .......................................................................................2-17

Chapter 3 Transferring Panel Unit Databases ...................................3-1

Introduction...................................................................................................... 3-1

Key Concepts................................................................................................... 3-2

Panel Database Transfer ...............................................................................................3-2



Receiving a Panel Unit Database ..................................................................................3-4 Sending a Panel Unit Database .....................................................................................3-5

Chapter 4 Archiving Trend Logs.........................................................4-1

Introduction...................................................................................................... 4-1

Key Concepts................................................................................................... 4-2

Trend Logs .....................................................................................................................4-2 Archiving Trend Logs .....................................................................................................4-2 Trend Collection Log File (trndcoll.log) ..........................................................................4-3 ODBC.............................................................................................................................4-3 Historian Database.........................................................................................................4-3



Archiving Trend Logs Automatically According to a Schedule.......................................4-6 Archiving Trend Logs Manually......................................................................................4-7

Table of Contents 3

Appendix A Available OPC Attributes for Companion/Facilitator Points .......................................................................................... A-1

Introduction..................................................................................................... A-1

Key Concepts.................................................................................................. A-2

Companion/Facilitator Points Mapping ......................................................................... A-2 Companion/Facilitator OPC Attributes .......................................................................... A-2 Companion/Facilitator OPC Attribute Tables ................................................................ A-5 Commands.................................................................................................................... A-8

M-Series Workstation with Companion/Facilitator Manual 1-1

Chapter 1 Using This Guide

Introduction The Companion/Facilitator OPC Server is a Windows® 98 SE and Windows NT® software application suite used in a Building Automation System (BAS) with Metasys® Companion™ or Facilitator™ panels (referred to as Panel unit) at Release 6.03 or greater. Two applications, CF Connect and CF Terminal provide specific software tools that are integrated into the user interface of an M-Series Workstation. This manual contains specific information on how to use M-Series Workstation software with Companion/Facilitator panels. The CF Connect application provides a user interface for configuring the OPC Server, utilities for transferring data including the controller archive and trend log buffers, and a scheduled trend collection mechanism. CF Terminal provides a VT100 Terminal emulation to the user interface in the currently connected panel. The design of the Companion/Facilitator OPC Server application suite allows data from the Panel units to be used with the general purpose client applications of the M-Series Workstation.

© January, 2001 Johnson Controls, Inc. www.johnsoncontrols.com Code No. LIT-11531110

CF OPC Server User’s Guide 1-2

Table 1-1: Related Literature For Information On Refer To M-Alarm Component Managing Alarms section of the M3 Workstation

User’s Guide (LIT-1153200) and M-Alarm User’s Guide (LIT-1153750) in the M3 Workstation Manual (FAN 1153)

M-Trend Component M-Trend User’s Manual (FAN 645.0) M-Graphics Component M-Graphics User’s Manual (FAN 644.0) M-Explorer/M-Inspector Component

M-Explorer User’s Guide (LIT-1153400) in the M3 Workstation Manual (FAN 1153)

System architecture, installation, and commissioning

M3 Workstation System Overview Technical Bulletin (LIT-1153050) and Installing the M3 Workstation Technical Bulletin (1153100) in the M3 Workstation Manual (FAN 1153)

Using workspaces M3 Workstation User’s Guide (LIT-1153200) in the M3 Workstation Manual (FAN 1153)

Introduction 1-3

Key Concepts Chapter Organization

Each chapter in the Companion/Facilitator OPC Server User’s Guide is divided into five main sections; however, each chapter may not contain all sections.

Table 1-2: Chapter Organization Section Description Introduction Briefly outlines the contents of the chapter. Key Concepts Describes background information necessary to

perform specific tasks. Procedure Overview Describes general steps for performing the tasks

described in the chapter. This section is geared toward users already experienced in using the M-Series Workstation.

Detailed Procedures Lists the steps needed to complete the tasks described within the chapter. This section is geared toward users who are new to the M-Series Workstation.

Troubleshooting Presents potential problems and how to solve them.

Online Help Online Help is provided with M-Series Workstation software applications. Help describes the basic procedures for performing functions within the selected application.


Chapter 2 Getting Started

Introduction This chapter describes how to:

• set up your modem for the M-Series Workstation

• define communication settings

• connect and log in to a site

• disconnect from a site

• add a site entry

• edit a site entry

• delete a site entry

© June, 2003 Johnson Controls, Inc. www.johnsoncontrols.com Code No. LIT-11531120


Key Concepts Configurations

Figure 2-1 shows a Building Automation System (BAS) with M3 Workstations and Companion/Facilitator Panel units.

N2 BusN2 Bus

M3 Workstation

Companion/Facilitator Panel Unit

Companion/Facilitator Panel Unit

Printer

Modemis insideenclosure.

Modemis insideenclosure.

DX 9100

UNT

AHU

DX 9100UNT

M3 Workstation

Panel unit

Modem

RS 232

Figure 2-1: BAS with M3 Workstation and Companion/Facilitator Panel Units

Getting Started 2-3

CF Connect The CF Connect application provides the user interface for configuring the OPC server, provides utilities for transferring data including the controller archive and trend log buffers, and drives the automatic trend collection feature from the Panel unit. Figure 2-2 shows the CF Connect window. Table 2-1 explains the CF Connect window options.

Figure 2-2: CF Connect Window

Table 2-1: CF Connect Window Options Toolbar Option Button Name Description

Open site Connects to a site using the Phone Book.

Close site Closes the open site.

Receive database Receives database from the panel.

Send database Sends a database to the panel.

Collect trend log Collects trend log data from the panel.

System Setup Views or modifies system options.

Help Shows Help topics.


CF Terminal CF Terminal is essentially a VT100 terminal emulator with various user interface enhancements including color and font manipulation and mouse capabilities. The CF Terminal works exclusively with Companion/Facilitator Panel units. When using the CF Terminal you have two options: standalone application or as an M3 Workstation workspace. The available menus have slight differences. Table 2-2 explains the M3 Workstation workspace menus. Refer to the Getting Started chapter of the CF Terminal User’s Guide (LIT-11531300) for information about the standalone application menus.

Figure 2-3: M3 Workstation with CF Terminal Workspace

Getting Started 2-5

Table 2-2: M3 Workstation Workspace Menu Bar Options Menu Command Description View Toolbar If checked, the Terminal toolbar appears. Change Colors Opens the Color dialog box allowing a user to change

the text, highlight, and background color. View Printer File Opens the printer file so the user can view the contents.

The application used to view the file depends on the file extension.

Set Printer Destination Opens a dialog box, where the user can either suppress printing or select the printer file name and location.

Clear Printer File Clears the contents of the printer file. Function Keys F1 Cancels the previous operation. F2 Save F3 More F4 Acknowledge Enter Enter Terminal New Option not available from this menu. Open Option not available from this menu. Save Option not available from this menu. Save As Option not available from this menu. Page Setup Option not available from this menu. Print Preview Option not available from this menu. Print Prints current Terminal contents.

Note: For information about the M3 Workstation HCI Container menus, refer to the Getting Started section in the M3 Workstation User’s Guide (LIT-1153200).

Mouse Capabilities The CF Terminal provides limited mouse functionality. When a string of characters that has the first character highlighted is clicked on, a simulated keystroke of the highlighted character is initiated. In this way, the Companion/Facilitator menus may be navigated completely with the mouse. A right-click anywhere in the CF Terminal workspace pops up a list of function keys (F1, F2, F3, F4, Enter), which simulate those keystrokes when selected. These keys are also available in the Function Keys menu option.

Printing The CF Terminal provides two printing options. The first is printing the contents of the screen to any Windows 98 or Windows NT supported printer. The second is printing the data from the Panel unit such as alarm messages or summaries (automatically, by operator command, or by scheduled command) to a printer file.


On both direct connect and dialup applications, leave the CF Terminal application running on an M-Series Workstation to capture any printer output destined for the VT100 printer. The application used to view and print the file depends on the file extension specified for the printer destination. For example, a .txt extension normally launches Notepad to view and print the file. Printing is only available in black and white.

Site Phone Book The Site Phone Book window (Figure 2-8) includes a list of defined sites and allows operators to select and open a connection to a site, and add, modify, or delete a site. All sites, dial up and direct connect, must be defined in the Phone Book. The site name must match the Building Name definition in the Dial-Up I/O definition in the Panel unit. As each site is selected, its definition parameters appear in the right side of the dialog. These are read-only until the Edit operation is selected.

Site Information The Phone Book saves the following information about each site:

• dialing information (telephone number, baud rate) for remote sites

• parameters (time, days) for automatic transfer of trend logs into the M-Historian database

• database directory that shows the location of data files associated with the site

• default password that is used whenever the Panel unit is connected

Site Database Information The following information is saved in the database directory for each site:

• last received Panel unit database (if any). The filename is COMPAN.DB by default.

• M-Historian database (trenddb.mdb) if trend data is collected on a per site basis

• Trend Collector Log file (trndcoll.log)

Password A password is required to complete the connection from an M-Series Workstation to the Panel unit. Normally, this is a system level password. User access limitations are managed through the M-Password feature of the M-Series Workstation.

Getting Started 2-7

Procedure Overview Table 2-3: Getting Started

To Do This Follow These Steps: Set Up Your Modem for the M-Series Workstation

On the Windows Start menu, select Programs > Johnson Controls > ModemPRO. Select M3 Workstation in the Choose Modem/Configuration list box. On the Commands menu, select Program Modem.

Define Communication Settings

On the Windows Start menu, point to Programs > Johnson Controls > Companion-Facilitator > CF-Connect. Click on the System Settings toolbar button. Enter a communications port. Enter a baud rate. Click OK.

Connect and Log In to a Direct Connect Site

On the Windows Start menu, point to Programs > Johnson Controls > Companion-Facilitator > CF-Connect. Select Site > Open or click the Open Site Book icon. Select the site to connect to from the list. Click Connect. Enter the four character alphanumeric site password. Click OK. On the Start menu, select Programs > Johnson Controls > Companion/Facilitator OPC Server > CF Terminal.

Connect and Log In to a Dial-Up Site

On the Windows Start menu, point to Programs > Johnson Controls > Companion-Facilitator > CF-Connect. Select Site > Open or click the Open Site Book icon. Select the site to connect to from the list. Click Connect. Enter the four character alphanumeric site password. Click OK. On the Start menu, select Programs > Johnson Controls > Companion/Facilitator OPC Server > CF Terminal.

Disconnect from a Site In CF Connect, click on the Close Site button. Add a Site Entry In CF Connect, select Site > Open. Click Add.

Fill in the fields. Click Apply. Click Close. Edit a Site Entry In CF Connect, select Site > Open. Select a

site. Click Edit. Change the fields. Click Save. Click Close.

Delete a Site Entry In CF Connect, click Site > Open. Select a site and click Delete in the Site Phone Book dialog box. Click Yes to delete the site. The site entry is deleted; however, the information in the directory is not deleted.


Detailed Procedures Setting Up Your Modem for the M3 Workstation

Notes: Skip this section if using a direct serial connection. The external modems used for Companion/Facilitator communication must be dedicated for this purpose. Due the unique configuration requirements of the modem, do not use the serial port and modem for other Windows applications.

To set up your modem for the M3 Workstation: 1. On the Windows Start menu, select Programs >

Johnson Controls > ModemPRO. Figure 2-4 appears.

Figure 2-4: ModemPRO Window 2. If using a Hayes® or Hayes-compatible modem, select

Hayes/M3 Workstation in the Choose Modem/Configuration list box. If using a modem from a different manufacturer, select the modem brand and name and the M3 Workstation configuration.

Note: For other modem configurations, see the ModemPRO online help.

Getting Started 2-9

3. On the Options menu, select Port Settings. The Communication Settings dialog box appears (Figure 2-5).

Figure 2-5: Communication Settings Dialog Box 4. Verify that the Comm Port selection matches the port to be used

for the M3 Workstation modem. The Baud Rate setting should match the Baud rate of the modem connected to the Panel unit. Click OK.

5. On the Commands menu, select Program Modem. The initialization strings are highlighted as the modem is programmed. A message appears when the programming is complete.

6. Close the ModemPRO application.

Defining Communication Settings To define communication settings: 1. On the Windows Start menu, point to Programs >

Johnson Controls > Companion-Facilitator > CF Connect. The CF Connect window appears (Figure 2-6).

Figure 2-6: CF Connect Window

2. Click on the System Settings toolbar button. The System Setup dialog box appears (Figure 2-7).


Figure 2-7: System Setup Dialog Box 3. Enter the number of the Communications Port. 4. Enter the baud rate. For dial applications, the baud rate should

match the baud rate of the connected modem. For direct serial applications, the baud rate should match the baud rate of the serial port on the Panel unit.

5. Click OK. Note: For more information refer about Trend Collection tab setup

refer to Archiving Trend Logs chapter in this document.

Connecting and Logging In to a Direct Connect Site Connection and login to direct connect sites is automatic. The site name must be entered correctly into the Site Phone Book and a valid password must be defined in the Site Parameters. On the Windows Start menu, point to Programs > Johnson Controls > Companion-Facilitator > CF-Connect. The CF Connect window appears. Other applications, such as CF Terminal or M-Graphics, also perform an automatic connection and login to the Panel unit. Note: Check the status line in the phone book dialog box for errors

that may occur during the automatic connection. Make any corrections to the site definition as indicated.

Getting Started 2-11

Connecting and Logging In to a Dial-up Site To connect and log in to a dial-up site: 1. On the Windows Start menu, point to Programs >

Johnson Controls > Companion-Facilitator > CF-Connect. CF Connect window appears (Figure 2-6).

2. Select Site > Open or click the Open site button. The Site Phone Book dialog box appears (Figure 2-8).

Figure 2-8: Site Phone Book Window 3. Select the site to connect to from the list. If you do not have any

sites defined, refer to Adding a Site Entry in this chapter. 4. Click Connect. The Site Login dialog box appears (Figure 2-9).

Figure 2-9: Site Login Dialog Box


5. Enter the four character alphanumeric site password. This password must match a password defined in the Panel unit and is case sensitive. The default used for the connection is the password defined in the Site Phone Book. Typing in a different password before connection overrides the default.

6. Click OK. 7. On the Start menu, select Programs > Johnson Controls >

Companion/Facilitator OPC Server > CF Terminal. The CF Terminal window appears.

Note: Connections may also be established through OPC client applications such as M-Explorer and M-Graphics.

Disconnecting from a Site

IMPORTANT: The modem may still be connected to the Companion or Facilitator™ panel when a user is logged out of M-Password. Be sure to manually disconnect from the modem by using CF Connect to disconnect the site before logging out of M-Password.

To disconnect from a site: In CF Connect, click the Close Site button.

Adding a Site Entry To add a site entry: 1. In CF Connect, select Site > Open. The Site Phone Book dialog

box appears (Figure 2-8). Note: To copy values from an existing site, select the site from the

site list and click Add in the Site Phone Book dialog box.

2. Click Add in the Site Phone Book dialog box (Figure 2-8). The Add Site Entry dialog box appears (Figure 2-10).


Figure 2-10: Add Site Entry Dialog Box

3. Fill in the fields using Table 2-6. Use the Browse button to open a browser of directories.

Note: If All days or Mon-Fri is checked, all individual day check boxes are grayed-out. Deselect All days or Mon-Fri to enable individual days.


Table 2-4: Add Site Entry Fields Field Description Site Name (24 character maximum)

This name identifies the site in the Phone Book list and appears in the main title bar of the User Interface application to identify the currently connected site. This name must match the Building Name definition in the Dial-Up I/O definition in the Panel unit to establish the connection. Whenever a connection is initiated from the Phone Book, a warning message appears if the Building Name stored in the Panel does not match the site name configured in the Phone Book database and the connection is dropped. If a panel initiates a connection and its Building Name doesn’t match any site names in the Phone Book database, the connection is dropped. Workstation functions are limited if either of these situations arise.

Data Base Directory The path used to maintain any files specific for a particular site. Each site must have a unique directory. Refer to Site Database Information in Key Concepts in this chapter for a complete list of files.

Telephone Number Telephone number of the modem connected to the panel dialed when this site is selected. Default is blank. If the Panel is direct connect, this value is ignored. Maximum of 50 characters.

Baud Rate Baud rate of the modem connected to the panel dialed when this site is selected. The default for this field is 9600 baud, the maximum baud rate supported by the Panel unit. If the Panel unit is direct connect, this value is ignored.

Password Four digit alphanumeric password. The default is blank. A password must be entered for direct connect and dial-in applications.

Trend Collector Days A selection of days of the week (Sun, Mon, Tue, Wed, Thu, Fri, Sat) on which trend data should be automatically uploaded by the Trend Collector. Default is no days selected.

Trend Collector Time of Day

The time at which the Trend Collector initiates the connection on the Trend Collector days. Default is midnight, 12:00. The time is ignored if no days are selected.

4. Click Apply for each site. When finished, click Close.


Editing a Site Entry To edit a site entry: Note: The Edit operation may not be used to change or correct the

name of the site. To change the name, delete and add the site again. Changing the database directory of the site does not move any data currently in the old database directory.

1. In CF Connect, select Site > Open. 2. Select a site and click Edit in the Site Phone Book dialog box

(Figure 2-8). The Edit Site Entry dialog box appears (Figure 2-11).

Figure 2-11: Edit Site Entry Dialog Box 3. Edit the fields using Table 2-4 and click Save. Note: If All days or Mon-Fri is checked, all individual day

checkboxes are grayed out. Deselect All days or Mon-Fri to enable individual days.


Deleting a Site Entry To delete a site entry: 1. In CF Connect, click Site > Open. 2. Select a site and click Delete in the Site Phone Book dialog box

(Figure 2-8). A confirmation box appears. 3. Click Yes to delete the site. The site entry is deleted; however, the

information in the directory is not deleted.


Troubleshooting CF Connect Troubleshooting

Refer to Table 2-5 for troubleshooting information.

Table 2-5: CF Connect Troubleshooting Problem Cause Solution Direct connect Panel unit continues to cycle with the message Panel connection has been reset.

The site name is not in the Phone Book or the default password is incorrect.

Make sure that the Panel building name is in the Site Phone Book using the exact spelling. Make sure that a password was entered. The building name from the Panel will appear on the status line at the bottom of the Site Phone Book dialog box.

Dial site connection drops after modems connect.

The site name is not in the Phone Book or the default password is incorrect.

Make sure that the Panel building name is in the Phone Book using the exact spelling. Make sure that a password was entered. The building name from the Panel will appear on the status line at the bottom of the Site Phone Book dialog box.


Chapter 3 Transferring Panel Unit Databases

Introduction The CF Connect application provides an easy way to send and receive Panel unit databases. This chapter describes how to:

• receive a Panel unit database

• send a Panel unit database

© April, 2000 Johnson Controls, Inc. www.johnsoncontrols.com

Code No. LIT-11531130

Companion/Facilitator OPC Server User’s Guide 3-2

Key Concepts Panel Database Transfer

The Send Panel Database operation is only available if the password used to login has System level privileges (highest). The CF Connect application can initiate a receive or send database operation to the Panel unit. By default, the database from a site transferred with the receive option is stored in the predetermined Site subdirectory defined in the Site Phone Book. The Panel database is stored in a file with a .db extension. The Receive Panel Database option is used to provide a backup of the Panel unit database on the M-Series Workstation. You must perform this step one time during the commissioning phase. Note: Whenever a new site is added to the Site Phone Book, the

Panel unit database should be received at least one time to complete the commissioning phase. This operation supports the offline browsing for OPC tag names (used in M-Graphics) and also supplies information required for the automatic trend collector.

Transferring Panel Unit Databases 3-3

Procedure Overview Table 3-1: Transferring Panel Unit Databases To Do This Follow These Steps: Receive a Panel Unit Database On the CF Connect Tools menu, click Receive

Panel DB or click the Receive Database icon. Click OK to upload the file. The .db file is located in the Site subdirectory defined in the Phone Book. A Succeeded or Failed message appears at the end of the transfer.

Send a Panel Unit Database On the CF Connect Tools menu, click Send Panel DB or click the Send Database icon. Click OK to download the file. The .db file is located in the Site subdirectory defined in the Phone Book. A Succeeded or Failed message appears at the end of the transfer.


Detailed Procedures Receiving a Panel Unit Database

Note: You must be connected to a site with a monitor level password before you can receive a Panel unit database.

To receive a Panel unit database: 1. From the CF Connect dialog box, select Tools > Receive Panel

Database. The Receive Panel Database dialog box appears (Figure 3-1).

Figure 3-1: Receive Panel Database Dialog Box 2. The default database path is the directory defined in the Site

Phone Book for this site. The default filename is compan.db. To change the name of the file, click in the Database Path field and enter a filename or click Browse to search for a different .db file. The file is normally located in the Site subdirectory defined in the Phone Book.

3. Click OK to upload the file. Note: The current .db file is overwritten.

A Succeeded or Failed message appears at the end of the transfer and the Panel connection resets.

Transferring Panel Unit Databases 3-5

Sending a Panel Unit Database Note: You must be connected to a site with a System level

password before you can send a Panel unit database.

To send a Panel unit database: 1. From the CF Connect dialog box, select Tools > Send Panel

Database. The Send Panel Database dialog box appears (Figure 3-2).

Figure 3-2: Send Panel Database Dialog Box 2. Use the Browse button the find the .db file. The file is normally

located in the Site subdirectory defined in the Phone Book. 3. Click OK to download the file. A Succeeded or Failed message appears at the end of the transfer and the Panel connection resets.


Chapter 4 Archiving Trend Logs

Introduction The M-Series Workstation may archive trend logs collected from Panel units. Trend data is received from the Trend buffer on the Panel units and archived in M-Historian databases on the M-Series Workstation. This data may then be viewed graphically via M-Trend or another ODBC (Online Database Connectivity) compliant program. There are several methods for archiving Trend Logs from Panel units. This chapter describes how to archive Trend Log databases for use with the M-Trend. This chapter describes how to:

• archive Trend Logs automatically according to a schedule

• archive Trend Logs manually Note: Point information in Trend Logs is defined from the

CF Terminal. See the CF Terminal User’s Guide (LIT-11531300) for information about setting up Trend Logs. See the M-Trend User’s Manual (FAN 645.0) for information on viewing archived Trend Logs.




Key Concepts Trend Logs

Trend Logs are written to a Trend buffer in Random Access Memory (RAM) on Panel units. Since the logs are in RAM they are erased if the Panel unit loses power. Each Panel unit can have up to 32 Trend Logs. Four points may be trended per log and four pieces of information (a value and three status attributes) are tracked for each point. Individual samples are collected at a predetermined interval. The minimum interval is one minute. These logs hold 168 samples per point. Trend Logs are defined through the CF Terminal component and collected by the Panel units where they are defined. You may collect 168 samples per point, per Trend Log. See the CF Terminal User’s Guide (LIT-11531300) in this manual for details on setting up Trend Logs.

Archiving Trend Logs Archiving Trend Logs refers to retrieving data from the Trend Log buffer in a Panel unit. The data from these logs is added to a Historian database in the M-Series Workstation. The CF Connect application allows you to select whether to archive any or all of the information from the Trend Logs. Archiving all four pieces of information makes your database grow four times faster than just archiving the values. Trend Logs can be collected in two ways:

• automatically according to a preset schedule set up through the Phone Book

• manually from the Tools menu of the CF Connect application

Archiving Trend Logs 4-3

Trend Collection Log File (trndcoll.log) The Trend Collection Log records transactions regarding Trend archiving. It is created and saved to the site data directory the first time you log into a site to collect Trend samples. Each time you log into a site to collect Trend samples, information about the collection is added to the file. This log may be viewed in Windows Notepad, or any program that views ASCII text files. The information collected includes the date and time of the collection, the success or failure of the collection, how many Trend Logs were archived, and whether it was a manual or scheduled collection. If the collection was a scheduled collection, the log records the date and time it was scheduled for. The log also records whether a site was dialed multiple times or rescheduled. Finally, if there is a failure, a reason for the failure is recorded.

ODBC Online Database Connectivity (ODBC) provides an interface to allow the M-Trend Viewer (or other ODBC compliant programs such as Microsoft® Excel) to make a standard set of requests for data regardless of the actual database package used. In the case of the M3 Workstation, historical data is stored in the format used by Microsoft Access.

Historian Database Data file on the M-Series Workstation where the Trend Log data from a Panel unit is archived. The CF Connect System Setup dialog box has an option to use a separate Historian database for each site, or a single database for all sites.

Single Database Storage To store samples from all sites in a single database, the ODBC Data Source name must be configured in the CF Connect System Setup dialog box. The tag names in the file are prefixed with @<site name>: to ensure that each name in the database is unique.

Per Site Database Storage In this configuration, all Trend Log data for each site is stored in a separate database. The name of this data file is trenddb.mdb. In order to have separate databases for different sites, this file must be stored in different directories. If this file is deleted or renamed, an empty trenddb.mdb is copied into the site directory. Trend samples archived from this point on are saved in the new database file.


Procedure Overview Table 4-1: Trend Collection from CF Connect To Do This Follow These Steps: Archive Trend Logs Automatically According to a Schedule

From the CF Connect dialog box, select Site > Open. Select a site and click on Edit. Select the days and time you want to collect Trend Logs. Click Save.

Archive Trend Logs Manually From the CF Connect dialog box, select Tools > Archive Trend Logs.


Detailed Procedures Each of these methods append, or add, the Trend Samples from the Trend Log buffers to the current Historian database.

Figure 4-1: Trend Collecting Options in System Setup

Table 4-2: Trend Collection Options in System Setup Selection Result Single trend collection database (not per site)

Checking this box means that a single database is used for all sites.

ODBC Data Source Name (DSN) Enter the DSN. This is the name of the link to the Historian database. Values Checking this box means the Historian database collects the values

for each point in the Trend Log when you log into the site. Point Status Checking this box means the Historian database collects the point

status for each point in the Trend Log when you log into the site. Alarm Status Checking this box means the Historian database collects the Alarm

status for each point in the Trend Log when you log into the site. Analog Status Checking this box means the Historian database collects the Analog

Status for each point in the Trend Log when you log into the site. This feature is only used with analog points.

Feature Control Checking this box means the Historian database collects the Feature Control status for each point in the Trend Log when you log into the site. This feature is only used with Binary Output (BO) points.

Note: Seethe Appendix A Available OPC Attributes for Companion/Facilitator Points chapter for the numeric values for status and feature control that are recorded.


Archiving Trend Logs Automatically According to a Schedule Note: The following steps assume you are setting up a schedule for

an existing site. For information on adding a site to the Phone Book or for more details on use of the Phone Book in general, see the Getting Started chapter of this manual.

To archive Trend Logs automatically according to a schedule: 1. Open the Site Phone Book by selecting Site > Open from the

CF Connect dialog box. The Site Phone Book window appears. 2. Select a site and click Edit in the Site Phone Book dialog box. The

Edit Site Entry dialog box appears (Figure 4-2). Select the day and time you want Trend Logs automatically collected for the site, and click Save.


Scheduled Trend collections are retried ten times at 5-minute intervals if the Panel unit does not answer the phone call. If the workstation is busy with another site, the scheduled Trend collections are rescheduled 5 minutes later. At midnight, any incomplete scheduled Trend collections are dropped. See trndcoll.log in the site subdirectory for the status of Trend collections.

Figure 4-2: Edit Site Entry Dialog Box

Archiving Trend Logs Manually To archive Trend Logs manually: From the CF Connect dialog box, select Tools > Archive Trend Logs. Note: The M-Collector application supplements the trend

collection available with the CF Connect application. The M-Collector allows snapshot reads of individual point values to be recorded on a scheduled basis, with no definition required in the Panel unit.

M-Series Workstation with Companion/Facilitator Manual A-1

Appendix A Available OPC Attributes for Companion/Facilitator Points

Introduction This appendix describes the available data values from the Companion/Facilitator points that can be used in M-Graphics, M-Collector, and viewed in M-Explorer.



Companion/Facilitator OPC Server User’s Guide A-2

Key Concepts Companion/Facilitator Points Mapping

Companion/Facilitator point numbers are used to uniquely identify points. Companion/Facilitator point names are not guaranteed to be unique. Therefore, Companion/Facilitator points are identified by their point number followed by a period and then the point name.

Companion/Facilitator OPC Attributes Companion/Facilitator OPC attributes are used in M-Graphics for binding and appear in M-Explorer for monitoring. In M-Graphics, when binding graphic properties such as text display, size, color, rotation, and location, the values from the Companion/Facilitator points can be used either directly or within expressions to create a visual display of the current state of the system. Tag bindings within the graphics are in the following form in the OPC Universal Tag Browser Window (Figure A-1):

• JC.CFOPC\@site name:{Point Number}.{Point Name}.{Data Value Name} or

• JC.CFOPC\@site name:{Point Number}.{Data Value Name}

Available OPC Attributes for Companion/Facilitator Points A-3

Figure A-1: OPC Universal Tag Browser Window Refer to the M-Explorer User’s Guide (LIT-1153400) for an example of the hierarchy in the Companion/Facilitator OPC Server.


Companion/Facilitator Mapping Status M-Explorer displays a status for each Companion/Facilitator point. The Status in M-Explorer is calculated using an If-Then-Else algorithm that combines the PointStatus, AlarmStatus, and AnalogStatus attributes from the Companion/Facilitator controllers. The M-Explorer application uses this status attribute for color coding. This attribute may also be used in M-Graphics displays or by M-Collector. Table A-1 lists the Companion attributes and associated values and descriptions used in the algorithm.

Table A-1: M-Explorer Status Attribute If Companion Attribute = Value Description Then M-Explorer

Status Value Description

PointStatus 1 Offline 100 Offline PointStatus 2 Override 90 Override AlarmStatus 4 Shutdown 85 Shutdown AI, AO, or AC Point Type and Analog Status

3 Overrange 80 Overrange

AlarmStatus 3 Trouble 50 Trouble Alarm Status 2 Abnormal 45 Alarm AI, AO, or AC Point Type and Analog Status

2 High Limit 41 High Limit

AI, AO, or AC Point Type and Analog Status

1 Low Limit 40 Low Limit

Otherwise 0 0 Normal


Table A-2: Companion/Facilitator Site Level Attributes Attribute Name Data Type Range Description String Default=site name Connected Status Integer 0=disconnected, 1=connecting, 2=authenticating, 3=connected,

4=remote connected, 5=disconnecting Object Type String Site Status Integer 0=normal, 85=shutdown, 100=offline Status Message String/Integer String or integer 1-4, integer is password capability Connect String Write only Disconnect String Write only Authenticate Boolean Display String Same as connected status

Notes: The connect and disconnect attributes are writeable and may be used to make or break remote site connections in dial applications. Site level attributes are referenced in the following form: JC.CFOPC\@<sitename>.{DataValueName} for example, JC.CFOPC\@GreenTreeSchool.ConnectedStatus

Companion/Facilitator OPC Attribute Tables

Table A-3: Available Analog Input (AI) OPC Attributes Attribute Name Data Type Range AlarmStatus Integer 0=normal, 1=unacknowledged, 2=abnormal, 3=trouble,

4=shutdown AnalogStatus Integer 0=normal, 1=low limit, 2=high limit, 3=overrange Auto N/A Write Only, any value accepted to send command Description String Same as Name Differential* Float Display String 12 character (value <space> EngUnits) EngUnits String 4 character HighLimit* Float LongDisplay String 39 character (Companion/Facilitator Point Information) LowLimit* Float Name String 16 character Object Type String AC Override Float Write Only PointNumber Integer 1-800 (1-200 with LTD version) PointStatus Integer 0=normal, 1=offline, 2=override Present Value Float Same as Value Status Integer See Table A-1. Value Float

* Attributes only refresh when a compan.db file is uploaded.


Table A-4: Available Analog Output (AO) OPC Attributes Attribute Name Data Type Range AlarmStatus Integer 0=normal, 1=unacknowledged, 2=abnormal, 3=trouble,

4=shutdown AnalogStatus Integer 0=normal, 1=low limit, 2=high limit, 3=overrange Auto N/A Write Only, any value accepted to send command Description String Same as Name Display String 12 character (Value<space>EngUnits) EngUnits String 4 character HighRangeLimit Float LongDisplay String 39 character (Companion/Facilitator Point Information) LowRangeLimit Float Name String 16 character Object Type String AO Override Float Write Only PresentValue Integer Same as Value PointStatus Integer 0=normal, 1=offline, 2=override Status Integer See Table A-1. Value Float Read/Write

Table A-5: Available Binary Input (BI) OPC Attributes Attribute Name Data Type Range AlarmStatus Integer 0=normal, 1=unacknowledged, 2=abnormal, 3=trouble,

4=shutdown Auto N/A Write Only, any value accepted to send command Description String 16 character Display String 12 character (Same as State) LongDisplay String 39 character (Companion/Facilitator Point Information) Name String 16 character Object Type String BI OverrideValue Boolean 0 or 1, Write Only OverrideState String Write Only, accepts stated text PointNumber Integer 1-800 (1-200 with LTD version) PointStatus Integer 0=normal, 1=offline, 2=override Present Value Boolean Same as Value State String 4 character, (either State 0 or State 1, shows current value in text) State0 String 4 character State1 String 4 character Status Integer See Table A-1. TotLimit* Long Integer TotType Integer 0=none, 1=cycle counts, 2=Runtime Min, 3=Runtime Hour TotValue Long Integer Value Boolean 0 or 1



Table A-6: Available Binary Output (BO) OPC Attributes Attribute Name Data Type Range AlarmStatus Integer 0=normal, 1=unacknowledged, 2=abnormal, 3=trouble,

4=shutdown Auto N/A Write Only, any value accepted to send command Description String Same as Name Display String 12 character Same as State EquipDelay* Integer FeatureControl Integer 0=none, 1=OV, 2=CL, 3=GD, 4=SS, 5=DL, 6=LR, 7=WS, 8=MC LongDisplay String 39 character (Companion/Facilitator Point Information) Name String 16 character Object Type String BO OverrideState String 4 character (either State 0 or State 1, Write only) OverrideValue Boolean Write Only PointNumber Integer 1-800 (1-200 with LTD version) PointStatus Integer 0=normal, 1=offline, 2=override Present Value Boolean Same as Value Release Boolean 0 or 1 Write Only State String 4 character, (either State 0 or State 1, Read/Write) State0 String 4 character State1 String 4 character Status Integer See Table A-1. TotLimit* Long Integer TotType Integer TotValue Long Integer Value Boolean 0 or 1 (Read/Write) = maximum



Table A-7: Available Accumulator (AC) OPC Attributes Attribute Name Data Type Range AlarmStatus Integer 0=normal, 1=unacknowledged, 2=abnormal, 3=trouble,

4=shutdown AnalogStatus Integer 0=normal, 1=low limit, 2=high limit, 3=overrange ConsumpEngUnits* String 4 character Description String Same as Name Display String 12 character (Rate<space>RateEngUnits) HighLimit* Float LongDisplay String 39 character (Companion/Facilitator Point Information) LowLimit* Float Name String 16 character Object Type String AC PointNumber Integer 1-800 (1-200 with LTD version) PointStatus Integer 0=normal, 1=offline, 2=override Present Value Float Same as Rate Rate Float RateEngUnits String 4 character Status Integer See Table A-1.


Commands Commands are sent by writing OPC attributes. The OPC attributes are Tag Names available for binding in M-Graphics. Note: Commands (modeled as OPC writes) are allowed for users

with a Command or higher password level.

Table A-8 lists the available tag names.

Table A-8: Available Tag Names Point Type Available Tag Names AI Auto, Override AO Auto, Override, Value AC N/A BI Auto, Override Value, Override State BO Auto, Value, State, Release, Override Value, Override State

Note: Override Value indicates that the value is numeric (0 or 1). Override Status indicates a string value based on State 0/State 1 defined strings (e.g., OFF/ON)

Refer to the CF Terminal User’s Manual (LIT-11531300) for details on rules for commanding points.

companion/facilitator opc server user's guide

Documents