Top Banner
Marquee Manager Gateway for Activplant V9.00 SeQent Corporate Office Suite 137 4500 Blakie Road London, ON, N6L 1G5 Canada Phone: +1.519.652.0401
48

Marquee Manager Gateway for Activplant V9 - SeQent · Customer Service ... 35 Modifying and ... Marquee Manager Gateway for Activplant is another product in the Marquee Manager Suite

May 11, 2018

Download

Documents

duongnhu
Welcome message from author
This document is posted to help you gain knowledge. Please leave a comment to let me know what you think about it! Share it to your friends and learn new things together.
Transcript
Page 1: Marquee Manager Gateway for Activplant V9 - SeQent · Customer Service ... 35 Modifying and ... Marquee Manager Gateway for Activplant is another product in the Marquee Manager Suite

Marquee Manager Gateway for Activplant

V9.00

SeQent Corporate Office Suite 137 – 4500 Blakie Road London, ON, N6L 1G5 Canada Phone: +1.519.652.0401

Page 2: Marquee Manager Gateway for Activplant V9 - SeQent · Customer Service ... 35 Modifying and ... Marquee Manager Gateway for Activplant is another product in the Marquee Manager Suite

Table Of Contents

Terms of Use ................................................................................................... 4

Version Information .......................................................................................... 5

Edits ............................................................................................................ 5

Customer Service ............................................................................................. 6

Support Contracts ....................................................................................... 6

Location .................................................................................................... 6

.1. Product Overview ........................................................................................ 7

How it Works ................................................................................................ 8

.2. Installation ................................................................................................. 9

Prerequisites ................................................................................................. 9

Installing the Application .............................................................................. 10

Installing Remote Administrator - Set Up ........................................................ 12

Installing Remote Administrator - Install ........................................................ 19

.3. Configuration ............................................................................................ 21

Setting up the Application ............................................................................. 21

Configuring Key Components – Gateway Server .............................................. 22

Adding a Marquee Manager Gateway for Activplant Server ............................. 22

Enabling and Configuring Security ................................................................. 30

Configuring Marquee Manager Gateway for Activplant Options .......................... 33

Configuring the Gateway for Activplant options ............................................ 33

.4. Using Marquee Manager Gateway for Activplant ............................................ 35

Modifying and Deleting Tree View Items ......................................................... 36

Page 3: Marquee Manager Gateway for Activplant V9 - SeQent · Customer Service ... 35 Modifying and ... Marquee Manager Gateway for Activplant is another product in the Marquee Manager Suite

Modifying ................................................................................................. 36

Deleting .................................................................................................. 36

Creating Routing Rules ................................................................................. 37

Adding a Routing Rule ............................................................................... 37

Viewing the Log Files ................................................................................... 45

Glossary........................................................................................................ 46

Page 4: Marquee Manager Gateway for Activplant V9 - SeQent · Customer Service ... 35 Modifying and ... Marquee Manager Gateway for Activplant is another product in the Marquee Manager Suite

Page 4 of 48

Terms of Use

Information in this document is subject to change without notice and does not represent

a commitment on the part of SeQent. The software, which includes information contained in any databases, described in this document is furnished under a license agreement or nondisclosure agreement and may be used or copied only in accordance with the terms of the agreement. It is against the law to copy the software on any medium except as specifically allowed in the license or nondisclosure agreement. No part of this manual may be reproduced or transmitted in any form or by any means,

electronic or mechanical, including photocopying and recording, for any purpose without the express written permission of SeQent.

This software program and associated documentation are provided in an “as is” condition. In no event shall SeQent, its employees, directors or agents be liable for any loss or damage whatsoever (including, but not limited to, damages for loss of business

profits, business interruption, loss of business information, or other monetary loss)

arising out of the use of or the inability to use this software. By installing this software on your computer system you acknowledge that you have read and understood these terms and that you accept them.

© 2010 SeQent All rights reserved.

Printed in Canada

Marquee Manager is a trademark of SeQent. Other brand and product names are trademarks, or registered trademarks, of their respective holders.

Page 5: Marquee Manager Gateway for Activplant V9 - SeQent · Customer Service ... 35 Modifying and ... Marquee Manager Gateway for Activplant is another product in the Marquee Manager Suite

Page 5 of 48

Version Information

Edits

Version Date Author Description

V9.00 May/2010 K. MacLennan Initial Document

Page 6: Marquee Manager Gateway for Activplant V9 - SeQent · Customer Service ... 35 Modifying and ... Marquee Manager Gateway for Activplant is another product in the Marquee Manager Suite

Page 6 of 48

Customer Service

Support Contracts

You may purchase a support contract for any of our products. Support is free for product trials and for the first 30 days of product ownership.

To view the SeQent support options, go to our web site (www.SeQent.com). To contact SeQent‟s Customer Support department please use the following methods.

Urgent Issues:

Normal Business Hours (Weekdays 9AM-5PM EST):

1. Dial: +1.519.652.0401

2. Select: Option 1

If there is no answer then please leave a voice mail message with your

contact information and your call will be returned promptly.

After Hours (Weekdays 5PM-9AM EST, Weekends and Canadian Holidays):

1. Dial: +1.519.652.0401

2. Select: Option 1

3. Listen to the on-call phone number provided

4. Call the indicated after hours number

If there is no answer then please leave a voice mail message with your

contact information and your call will be returned promptly.

Non-Urgent Issues / Questions

Normal Business Hours (Weekdays 9AM-5PM EST):

1. E-Mail: [email protected]

2. Include the following information: - Contact Information - Product Name

- Version - Description of the problem being experienced

Location

Corporate Office 4500 Blakie Road, Suite 137 London, Ontario Canada N6L 1G5

Phone : +1.519.652.0401 Fax : +1.519.652.9275 Email: [email protected]

Page 7: Marquee Manager Gateway for Activplant V9 - SeQent · Customer Service ... 35 Modifying and ... Marquee Manager Gateway for Activplant is another product in the Marquee Manager Suite

c h a p t e r o n e – p r o d u c t o v e r v i e w

Page 7 of 48

.1. Product Overview

SeQent‟s Marquee Manager Marquee Manager Gateway for Activplant is a marquee

administration system that allows users to easily configure various routing rules that once triggered will display a message to a variety of different marquees, using a simple generic language.

Key Features:

o Support for both scrolling marquees and Andon type marquees

o Support for speaker and marquee on any alarm

o Hot reload of configuration information

o Default messages can be configured for display when no alarms are currently active on a marquee

o Support for alarm values to be inserted into the alarm message

o Wrapping of alarm text messages and defaults for message lengths - may be specified per individual marquee including word wrap rules

o If a Marquee Server connection is lost, the Gateway for Activplant will queue marquee requests until the server is back on-line.

Page 8: Marquee Manager Gateway for Activplant V9 - SeQent · Customer Service ... 35 Modifying and ... Marquee Manager Gateway for Activplant is another product in the Marquee Manager Suite

Marquee Manager GWAP V9

Page 8 of 48

How it Works

Marquee Manager Gateway for Activplant is another product in the Marquee Manager Suite of products and must reside on your Activplant Server.

The Marquee Manager Gateway for Activplant provides a bridge between Activplant project

alarms and your Marquee Manager Server. Various routing rules can be defined by selecting available Assets, Categories and Incidents that have been configured on your Activplant Server. When one of these rules is met, message text can be dispatched to your Marquee Manager Server, including embedding alarm and point values within the message text.

There are two valid alarm states that may be configured for each Routing Rule:

◦ Generate – the alarm becomes active by meeting the rules defined for that alarm on the Activplant Server

◦ Delete – the alarm has been deleted. The status for alarms that have been deleted cannot be changed, as this is the last opportunity the gateway will have to take the message down from the marquee or stop the speaker from playing a tune.

Page 9: Marquee Manager Gateway for Activplant V9 - SeQent · Customer Service ... 35 Modifying and ... Marquee Manager Gateway for Activplant is another product in the Marquee Manager Suite

c h a p t e r t w o – i n s t a l l a t i o n

Page 9 of 48

.2. Installation

Prerequisites

Before beginning the installation, it is important to determine the hardware and software requirements necessary for Marquee Manager Gateway for Activplant to run efficiently. Review the following prerequisite list before the software is installed.

Licensing General: Per server Licensing Options: Transaction prioritization

Product Requirements

Marquee Manager Server V9.x

Activplant v4.x, v5.x or v6.x

System Requirements

One of: Microsoft Win2K3 (SP1+) Microsoft WinXP (SP1a+)

Display: 800x600 Disk Space: 200MB RAM: 1GB

One or more of: Adaptive Micro Systems Displays

Allen-Bradley InView Displays Electro-Matic Displays MacDonald Humfrey Displays NETCON Unit Protocol Compatible Displays Nu-Media Display Systems Displays

Static Controls Corporation Displays UTICOR Displays

Drivers TCP/IP MDAC V2.7 (SP1+)

Page 10: Marquee Manager Gateway for Activplant V9 - SeQent · Customer Service ... 35 Modifying and ... Marquee Manager Gateway for Activplant is another product in the Marquee Manager Suite

Marquee Manager GWAP V9

Page 10 of 48

Installing the Application

Before installing Marquee Manager Gateway for Activplant for the first time, the

following information must be considered:

o Determine which disk drive/directory your Marquee Manager Gateway for Activplant software will reside on.

o Determine the Host name of the Marquee Manager Server you will be connecting to.

o Determine the location of the Activplant server as well as username and password required to access the database.

o The Marquee Manager Gateway for Activplant must be installed on the Activplant

Server, not the Activplant Collector.

Installing Marquee Manager Gateway for Activplant

1. Run Marquee Manager GWAP SETUP.EXE. Click Next.

2. After accepting the licensing agreement, select the installation destination directory.

Page 11: Marquee Manager Gateway for Activplant V9 - SeQent · Customer Service ... 35 Modifying and ... Marquee Manager Gateway for Activplant is another product in the Marquee Manager Suite

Installation

Page 11 of 48

3. Click Finish to complete the installation. The computer must be restarted before the

Marquee Manager Gateway for Activplant can be configured or operated.

Page 12: Marquee Manager Gateway for Activplant V9 - SeQent · Customer Service ... 35 Modifying and ... Marquee Manager Gateway for Activplant is another product in the Marquee Manager Suite

Marquee Manager GWAP V9

Page 12 of 48

Installing Remote Administrator - Set Up

The Marquee Manager Gateway for AP Administrator utility program is used to configure

and control the Marquee Manager Gateway for AP engine. System managers responsible for Marquee Manager are the intended users of Marquee Manager Gateway for AP Administrator.

The features and operations that can be performed with Marquee Manager Gateway for AP Administrator include adding, modifying, deleting, listing, printing database information, viewing logs and changing server configurations, etc.

The Marquee Manager Gateway for AP Administrator program can be accessed from any administrator workstation by purchasing the Marquee Manager Gateway for AP Administrator Kit.

Before installing and configuring Marquee Manager Gateway for AP Administrator, there

are two steps that must be completed. The first is to share the files on the server running Marquee Manager Gateway for AP Server. The second is creating a DSN on the computer where the Marquee Manager Gateway for AP Administrator will be installed.

If your database ODBC driver supports using Windows authentication to grant database access (such as SQLServer) you must either:

◦ Disable this feature and supply a valid username/password when defining your Device within the Gateway

◦ Change the Gateway service to run (Log On) under a domain/username which has the appropriate level of database access.

Sharing an Application Folder

1. In the Program Files folder, chose your Application folder – in this case, Marquee Manager. Expand the folder and chose the part of the application you would like to

share. In this example, Gateway for AP is the folder we want to share because it contains the data and log files.

Page 13: Marquee Manager Gateway for Activplant V9 - SeQent · Customer Service ... 35 Modifying and ... Marquee Manager Gateway for Activplant is another product in the Marquee Manager Suite

Installation

Page 13 of 48

2. Right click on the folder and choose Sharing and Security. On the Sharing tab, select "Share This Folder".

Page 14: Marquee Manager Gateway for Activplant V9 - SeQent · Customer Service ... 35 Modifying and ... Marquee Manager Gateway for Activplant is another product in the Marquee Manager Suite

Marquee Manager GWAP V9

Page 14 of 48

3. Click on the Permissions button and make sure Allow is selected under Permissions for Everyone. Click Apply.

Page 15: Marquee Manager Gateway for Activplant V9 - SeQent · Customer Service ... 35 Modifying and ... Marquee Manager Gateway for Activplant is another product in the Marquee Manager Suite

Installation

Page 15 of 48

4. In your tree view, the Marquee Manager Gateway for Activplant folder will now

appear as follows:

Creating a DSN

The next step is to create a DSN. This must be done on the computer where the

Marquee Manger Gateway for Activplant Administrator will be installed.

1. In Windows, go to Start >Control Panel> Administrative Tools > Data Sources (ODBC). Chose the System DSN tab and click on Add.

Page 16: Marquee Manager Gateway for Activplant V9 - SeQent · Customer Service ... 35 Modifying and ... Marquee Manager Gateway for Activplant is another product in the Marquee Manager Suite

Marquee Manager GWAP V9

Page 16 of 48

2. Double click on Microsoft Access Driver (*.mdb)

3. Enter the Data Source Name then click on Select to locate the associated database.

Page 17: Marquee Manager Gateway for Activplant V9 - SeQent · Customer Service ... 35 Modifying and ... Marquee Manager Gateway for Activplant is another product in the Marquee Manager Suite

Installation

Page 17 of 48

4. In the Database Name, type “\\”, the name of the computer the Server Application is installed on, “\” the share name, “\” data “\” and the name of the database file. An example would look like this: \\LAB1\MMGWAP\data\ A list of LAB1‟s .mdb's will appear.

5. Choose the MMGWAPServer.mdb and click OK.

Page 18: Marquee Manager Gateway for Activplant V9 - SeQent · Customer Service ... 35 Modifying and ... Marquee Manager Gateway for Activplant is another product in the Marquee Manager Suite

Marquee Manager GWAP V9

Page 18 of 48

6. Your new DSN name should appear.

Page 19: Marquee Manager Gateway for Activplant V9 - SeQent · Customer Service ... 35 Modifying and ... Marquee Manager Gateway for Activplant is another product in the Marquee Manager Suite

Installation

Page 19 of 48

Installing Remote Administrator - Install

1. Run SETUP.EXE and the following screen will appear:

2. After accepting the licensing agreement, you will be prompted for the installation destination directory.

3. Click Finish to complete the installation. The computer must be restarted before the

Marquee Manager Gateway for ODBC Administrator can be configured or operated.

Page 20: Marquee Manager Gateway for Activplant V9 - SeQent · Customer Service ... 35 Modifying and ... Marquee Manager Gateway for Activplant is another product in the Marquee Manager Suite

Marquee Manager GWAP V9

Page 20 of 48

Page 21: Marquee Manager Gateway for Activplant V9 - SeQent · Customer Service ... 35 Modifying and ... Marquee Manager Gateway for Activplant is another product in the Marquee Manager Suite

c h a p t e r t h r e e – c o n f i g u r a t i o n

Page 21 of 48

.3. Configuration

Setting up the Application

The Marquee Manager Gateway for Activplant user interface conveniently displays all information in a tree view that when expanded shows the current routing rules and the items associated with each.

If your administrator has enabled security in Marquee Manager Gateway for Activplant you will be prompted for a User ID/password and a valid Domain name before you can access the Gateway.

Page 22: Marquee Manager Gateway for Activplant V9 - SeQent · Customer Service ... 35 Modifying and ... Marquee Manager Gateway for Activplant is another product in the Marquee Manager Suite

Marquee Manager GWAP V9

Page 22 of 48

Configuring Key Components – Gateway Server

Marquee Manager Gateway for AP includes one Administrator license key that allows the

addition of a single server. Additional licenses may be purchased that allow multiple servers to be added and maintained from the Marquee Manager Gateway for AP server.

Adding a Marquee Manager Gateway for Activplant Server

1. After installing and restarting your computer, select Start – Programs – Marquee

Manager – Gateway for Activplant – Administrator to launch Marquee Manager Gateway for Activplant.

2. Select the MMGWAP Servers icon in the tree view. Click the New Server icon in the

toolbar. You will be prompted to select an ODBC Machine Data Source. The installation kit has already created this DSN. Simply select the MMGWAPServer DSN and click OK.

If you are using an upgraded Marquee Manager Gateway for Activplant license key which supports multiple servers, the DSN entered here must be created via Administrative Tools, Data Sources in Control Panel and associated with the MMGWAP.MDB file to allow the

remote server to be maintained. First share the remote server’s Marquee Manager\Gateway for AP directory. On the machine running the remote Administrator, configure the DSN to use the server database: \\remoteservername\mmgwapshare\data\MMGWAPSERVER.MDB. It is a good idea to include the hostname in the DSN name to clarify the server being maintained. (ie. MMGWAP_SERVER1) One DSN must be created per server being maintained.

Page 23: Marquee Manager Gateway for Activplant V9 - SeQent · Customer Service ... 35 Modifying and ... Marquee Manager Gateway for Activplant is another product in the Marquee Manager Suite

Configuring the Gateway

Page 23 of 48

3. The Server configuration process includes a Details tab, a Settings tab and a Security tab. The Details tab defines the connection from the Marquee Manager Gateway for Activplant to the Marquee Manager Server allowing it to maintain a server.

Page 24: Marquee Manager Gateway for Activplant V9 - SeQent · Customer Service ... 35 Modifying and ... Marquee Manager Gateway for Activplant is another product in the Marquee Manager Suite

Marquee Manager GWAP V9

Page 24 of 48

DETAILS TAB

Server

Host Name A TCP/IP resolvable name for the machine running Marquee

Manager Gateway for AP. This will be in your DNS server or local host file and can be reached from the Administrator workstation.

Description Any text the administrator wishes to refer to the server as. This field is optional

Connection

DSN This field is already populated

User Name Optional

Password Optional

Logging

Path Enter or browse to the Log Path required to access the logs directory on the current Marquee Manager Server. In most cases, if the server is locally installed this path will be a drive

letter based directory specification (e.g.: C:\Program Files\Marquee Manager\Gateway for Activplant\Logs\). If the server being managed is not the local server then this path will most likely be a UNC path ( \\server\share\directory\), which provides access to the remote servers log directory. (e.g.: \\SERVER1\MMGWAP\logs\).

4. After completing the Details tab, click on the Settings tab to configure the server

options. If the server has never been configured before then the contents of the Settings tab contain defaults. If the server is already configured and operational, these fields will be populated.

Page 25: Marquee Manager Gateway for Activplant V9 - SeQent · Customer Service ... 35 Modifying and ... Marquee Manager Gateway for Activplant is another product in the Marquee Manager Suite

Configuring the Gateway

Page 25 of 48

SETTINGS TAB

Server

Server Port Port that connects to the Marquee Manager Gateway for

Activplant. Defaults to 8021.

License Key Enter a valid Marquee Manager Gateway for Activplant license key

Marquee Server

Host Name A TCP/IP resolvable name for the machine running Marquee

Manager Server.

Server Port Port that connects to the Marquee Manager Server. Defaults to 8011.

Logging

Log Days The number of days the log file will be kept before being purged. Defaults to 7 days.

Log Level The log Level field is for use at the request of SeQent. In the event of any problems, SeQent may request additional levels of logging to assist in problem solving. The default is 0.

Maximum Space To prevent the log files from consuming too much drive space,

you can specify how much space to allot to the log file in the Maximum Space field. Default is 50 MB.

Path The path specification, local to the actual Marquee Manager Server. It contains the directory where the Marquee Manager Server will store its log files.

5. To enable Security, you must select a Security Mode. Default selection is NONE.

Your choices include: - WINDOWS

Page 26: Marquee Manager Gateway for Activplant V9 - SeQent · Customer Service ... 35 Modifying and ... Marquee Manager Gateway for Activplant is another product in the Marquee Manager Suite

Marquee Manager GWAP V9

Page 26 of 48

- FORD (specific only to Ford users)

- CHRYSLER (specific only to Chrysler users) For more detailed instructions on Security settings, see next section entitled

“Enabling and Configuring Security”.

6. Click the Activplant tab to configure the Activplant Server options.

Page 27: Marquee Manager Gateway for Activplant V9 - SeQent · Customer Service ... 35 Modifying and ... Marquee Manager Gateway for Activplant is another product in the Marquee Manager Suite

Configuring the Gateway

Page 27 of 48

ACTIVPLANT TAB

Activplant Server

Data Source This is the data source where the Activplant database is located.

User Name Optional. Enter only if required to access the Activplant database.

Password Optional. Enter only if required to access the Activplant database.

OPC Server

Server Name Select the Activplant OPC Server, normally

Activplant.VpServer.1 or Activplant.APServer.1

7. Click on the Save icon to save your settings.

Sample New Marquee Gateway for Activplant Details tab

Page 28: Marquee Manager Gateway for Activplant V9 - SeQent · Customer Service ... 35 Modifying and ... Marquee Manager Gateway for Activplant is another product in the Marquee Manager Suite

Marquee Manager GWAP V9

Page 28 of 48

Sample New Marquee Gateway for Activplant Settings tab

Page 29: Marquee Manager Gateway for Activplant V9 - SeQent · Customer Service ... 35 Modifying and ... Marquee Manager Gateway for Activplant is another product in the Marquee Manager Suite

Configuring the Gateway

Page 29 of 48

Sample New Marquee Gateway for Activplant Activplant tab

REMOTE ADMINISTRATOR: If setting up Remote Administrator, the Settings Tab will already be populated.

Page 30: Marquee Manager Gateway for Activplant V9 - SeQent · Customer Service ... 35 Modifying and ... Marquee Manager Gateway for Activplant is another product in the Marquee Manager Suite

Marquee Manager GWAP V9

Page 30 of 48

Enabling and Configuring Security

1. To enable Security, you must select a Security Mode. Default selection is NONE.

Your choices include: - WINDOWS - FORD (specific only to Ford users) - CHRYSLER (specific only to Chrysler users) Once a mode is selected and saved, a Users folder appears under the Tools section of the tree view. The Users folder allows the administrator to add destinations with

limited access to various user applications.

2. Click on the Tools folder then select the Users folder. Right click and select New User or click the New icon in the toolbar.

Page 31: Marquee Manager Gateway for Activplant V9 - SeQent · Customer Service ... 35 Modifying and ... Marquee Manager Gateway for Activplant is another product in the Marquee Manager Suite

Configuring the Gateway

Page 31 of 48

DETAILS TAB

User Details

Username Enter the Username for this account. This must be the Windows login username.

Domain Select the Domain from the drop-down list of available domains

Password Enter a Password for this username then confirm password.

Confirm Confirm Password by retyping it.

Security Select the level of security this user will have. Admin access gives

users access to both Administrator and Client, if the application has both components. Default access gives users access to Client only.

Notes Optional field.

3. Save your changes. The next time you start up the application, you will be prompted for a User ID/password and a valid Domain name before you are allowed

access.

The first user entered must be an administrator with Admin security. The last user removed must also be an Admin.

4. The user will now be prompted for a UserID/password and a valid Domain name before the Marquee Manager Gateway for Activplant can be accessed.

Page 32: Marquee Manager Gateway for Activplant V9 - SeQent · Customer Service ... 35 Modifying and ... Marquee Manager Gateway for Activplant is another product in the Marquee Manager Suite

Marquee Manager GWAP V9

Page 32 of 48

Page 33: Marquee Manager Gateway for Activplant V9 - SeQent · Customer Service ... 35 Modifying and ... Marquee Manager Gateway for Activplant is another product in the Marquee Manager Suite

Configuring the Gateway

Page 33 of 48

Configuring Marquee Manager Gateway for Activplant Options

Before using Marquee Manager Gateway for Activplant, configure the various settings that control the interface to the gateway. The Options menu allows users to set Marquee Manager Gateway for Activplant details.

Configuring the Gateway for Activplant options

1. Click the Tools menu then select Options. The following screen is displayed:

2. The install kit will default the Data Source to MMGWAPAdmin, pointing to your

Gateway for Activplant database.

3. Select if the server is to be reloaded after every change, or only done when requested.

4. Select the Preferences tab to set Log File Path if different from the default.

Page 34: Marquee Manager Gateway for Activplant V9 - SeQent · Customer Service ... 35 Modifying and ... Marquee Manager Gateway for Activplant is another product in the Marquee Manager Suite

Marquee Manager GWAP V9

Page 34 of 48

Page 35: Marquee Manager Gateway for Activplant V9 - SeQent · Customer Service ... 35 Modifying and ... Marquee Manager Gateway for Activplant is another product in the Marquee Manager Suite

c h a p t e r f o u r – u s i n g t h e g a t e w a y

Page 35 of 48

.4. Using Marquee Manager Gateway for Activplant

The Marquee Manager Gateway for Activplant user interface is conveniently displayed in a tree view. The Server, when expanded, shows a Routing Rules folder that enables the user to browse to locate various groups, assets and incidents that are available on the Activplant server.

There are many features that make using Marquee Manager Gateway for Activplant

easier and more effective that include:

o Modifying and Deleting Tree View Items

o Creating Routing Rules

o Viewing the Log Files

Page 36: Marquee Manager Gateway for Activplant V9 - SeQent · Customer Service ... 35 Modifying and ... Marquee Manager Gateway for Activplant is another product in the Marquee Manager Suite

Marquee Manager GWAP V9

Page 36 of 48

Modifying and Deleting Tree View Items

Anything created on the tree view side of the screen (the left hand side) can be

modified or deleted at any time.

Modifying

Select the rule you wish to modify. The rule details will show up on the right hand side of the screen. At this point, you can change the details along with any other variables attached to it i.e. configuration settings etc. Once the information has been saved, you cannot revert to the old information. The only way to retrieve it is to change it back to its original state.

Deleting

There are two ways of deleting rules on the tree view side of your screen. By selecting

the rule or group you wish to delete, you can choose Edit > Delete from the toolbar or simply click on the delete symbol (red "X"). By deleting it, you are unable to recover the

item or any information attached to it. You must recreate it.

In certain applications, if a particular item is being used in another part of the application, you will not be able to delete it at that level. You must go further down in the tree view to discern where it is being used, and delete it there first.

Page 37: Marquee Manager Gateway for Activplant V9 - SeQent · Customer Service ... 35 Modifying and ... Marquee Manager Gateway for Activplant is another product in the Marquee Manager Suite

Using the Gateway

Page 37 of 48

Creating Routing Rules

The Routing Rules folder allows users to add and maintain rules on various Activplant

Groups, Assets, Categories and Incidents. The Assets may include devices, machines, or any piece of equipment that is being monitored.

Adding a Routing Rule

1. Select the Routing Rules folder and click the New icon in the toolbar. The following screen is displayed:

DETAILS TAB

Routing Rule

Description Any text the administrator wishes to refer to the routing rule.

This should be a logical name to describe the data that will be

met with this rule. Click on the icon to browse the incidents in the Activplant server to populate the Asset,

Category and Incident.

Asset Include any piece of equipment that is being monitored. This has already been configured in the Activplant Server.

Category Include a collection of related incidents. This has already been configured in the Activplant Server.

Incident Include specific events for the selected Asset. This has already been configured in the Activplant Server.

2. Example: WeldLine#1.Loader.Alarms.Clutch/Brake Air Pressure High

WeldLine#1 = Group Loader = Asset Alarms = Category

Clutch/Brake Air Pressure High = the specific incident being monitored.

There may be one or more incidents per category and one or more categories

per asset.

Page 38: Marquee Manager Gateway for Activplant V9 - SeQent · Customer Service ... 35 Modifying and ... Marquee Manager Gateway for Activplant is another product in the Marquee Manager Suite

Marquee Manager GWAP V9

Page 38 of 48

3. The Gateway for Activplant supports wildcards for these fields where ** matches

multiple characters including periods, * matches multiple characters to the next delineating period, and ? matches a single character or number including periods.

i.e. PAINT.Robots.Robot1

PAINT.Robots.Robot2 PAINT.Booths.Area1.Robot1 PAINT.Booths.Area1.Robot2 PAINT.Booths.Area2.Robot1 PAINT.Booths.Area2.Robot2

If the following wildcards are used: Paint.**.Robot?, a match would be made on all examples above. If the following wildcards are used: Paint.*.Area1?, a match would be made on

PAINT.Booths.Area1.Robot1 PAINT.Booths.Area1.Robot2

Alarm states can send to a marquee, including Andon type boards, speaker or both. This may be edited in the Generated alarm state.

4. After completing the Details tab, click on the Generated tab to configure where the message will be displayed and configuration details for that marquee/speaker. The following screen is displayed:

Page 39: Marquee Manager Gateway for Activplant V9 - SeQent · Customer Service ... 35 Modifying and ... Marquee Manager Gateway for Activplant is another product in the Marquee Manager Suite

Using The Gateway

Page 39 of 48

GENERATED TAB

Status

Status Select if you would like to display the message to a marquee

display, to play a tune or to display a template. Default is to display to a marquee and No Operation on the Tune and Controller options.

Configuration

Priority The Priority determines the order that messages sent to the

marquee will be displayed. High priority messages are a

priority of one and low priority message will be a priority of nine. Default Priority is set to nine.

Marquee Select the Marquee that you wish to send the message to. The drop down includes all marquees that have been configured in

Marquee Manager Administrator.

Text Enter the Text that you would like displayed on the marquee in the Text: field. Assets, categories, incidents and regular text are valid entries for this field.

Foreground This field has two methods of choosing your color. You can

either chose a color from the drop-down list of predetermined colors, or you can click on the color swatch to the right of the drop-down list and create a custom color.

Scrolling Scrolling options are Default, No Scrolling, Slow Speed, Medium

Speed, or Fast Speed.

Font The Font options are Default and Small.

Background This field has two choices. You can either choose a color from the drop-down list of predetermined colors, or you can click on the color swatch to the right of the drop-down list and create a custom color.

Mode The drop-down contains the choices of Static, Flashing, Fast

Flashing, Strobe, Reverse, Reverse Flash and Reverse Fast

Page 40: Marquee Manager Gateway for Activplant V9 - SeQent · Customer Service ... 35 Modifying and ... Marquee Manager Gateway for Activplant is another product in the Marquee Manager Suite

Marquee Manager GWAP V9

Page 40 of 48

Flash. This establishes how your information will display on the

marquee.

Justification This determines the layout of your message on the marquee. The message can be right-aligned, left-aligned, or centered on the marquee.

You may choose to display the message to a Group or Distribution List that has been configured in Marquee Manager Administrator by selecting the Distribution List option to display a list of available groups.

When sending a message to a group, only the common colors, fonts, scrolling attributes and modes will be displayed in the drop down menus. If only one color, font, scrolling attribute or mode exists between all signs in the group, the drop down will default to that. {Default} will also be available to default these

attributes to that of the manufacturer.

5. The text to be displayed on the marquee can be typed manually using the values shown in the table below, or chose from the drop down menu that appears when you

type { - as indicated in the following screen shots:

Page 41: Marquee Manager Gateway for Activplant V9 - SeQent · Customer Service ... 35 Modifying and ... Marquee Manager Gateway for Activplant is another product in the Marquee Manager Suite

Using The Gateway

Page 41 of 48

Marquee Manager Gateway for Activplant allows the configuration of additional insertion tags to the default message. Please see Appendix A entitled “Insertion Tags” for more details.

Alarm values may be inserted in alarm messages only. Valid values are as follows:

VALUE RESULT

{ASSET.FQNAME} The full name, root + name

{ASSET.CATEGORY} The category, not normally included

in any of the other names

{ASSET.NAME} Asset name

{ASSET.NAME[1]} Name, plus one level up in the

naming hierarchy

{ASSET.NAME[-x]} Where x is only the portion of the

fqname up to 5 levels up from the name

{ASSET.ROOT} Everything except the „name‟

{CATEGORY.NAME} Associated asset‟s category name

{INCIDENT.CATEGORY} Synonym for {CATEGORY.NAME}

The name of the incident category.

{INCIDENT.DESCRIPTION} Alias to .NAME

{INCIDENT.NAME} Associated asset’s incident name

Page 42: Marquee Manager Gateway for Activplant V9 - SeQent · Customer Service ... 35 Modifying and ... Marquee Manager Gateway for Activplant is another product in the Marquee Manager Suite

Marquee Manager GWAP V9

Page 42 of 48

{INCIDENT.STARTTIME} Start time of the incident

{INCIDENT.TIMESTAMP} Alias to .STARTTIME

{INCIDENT.TRIGGERVALUE} Value that caused the rule to become triggered

{RULE.DESCRIPTION} Alias for .NAME

{RULE.NAME} Name entered for the Routing Rule

6. A maximum length parameter in the format of {CLASS.XXX[:max-length]} allows you

to specify the number of characters that will be displayed for that rule value. The valid range for this maximum length parameter is 0 to 1024 and is optional.

i.e. {ASSET.NAME:6} will only show 6 characters of the alarm asset‟s name.

Depending on the marquee selected, the Preview section will display the available Lines that may be configured.

If a Group is added with marquees that contain one and two-line signs, the Preview will only have one line available for configuration. i.e. A Group that contains a two-line Numedia and a Static Controls 952 one-line. The preview will only display one line available for configuration.

See manual Marquee Manager Client v9.x for details on the attributes that are supported for each model of marquee.

7. The following is a sample configuration for alarms that have been Generated:

8. If a tune is to be played or a template played when an alarm is generated, click the Change Tune button and/or the Template button. This can be selected in addition to

displaying the message on the selected marquee.

Page 43: Marquee Manager Gateway for Activplant V9 - SeQent · Customer Service ... 35 Modifying and ... Marquee Manager Gateway for Activplant is another product in the Marquee Manager Suite

Using The Gateway

Page 43 of 48

Marquee, speaker and template buttons will then be available to toggle between

configurations.

Select the Speaker icon to configure the tune that will play. The following configuration screen is displayed:

9. Select the Priority for the tune to be played. The Priority determines the order that messages sent to the speaker will be displayed. High priority messages are a threshold of one and low priority message will be a threshold of nine. Default Priority is set to nine.

10. Select the Speaker from the drop down. This will include all sounder models that have been configured in Marquee Manager Administrator.

11. Select the Tune # to play from the Tune drop down.

12. You may then elect to play the tune continuously or to play for a specific duration of time by entering in the seconds the tune will play for.

13. If the message is to be sent to a Controller type marquee, select the Template icon to configure the template that will play. The following configuration screen is displayed:

Page 44: Marquee Manager Gateway for Activplant V9 - SeQent · Customer Service ... 35 Modifying and ... Marquee Manager Gateway for Activplant is another product in the Marquee Manager Suite

Marquee Manager GWAP V9

Page 44 of 48

14. Select the Controller and Template from the drop downs. To play a Cycle, select the Cycles option, then the cycle from the drop down menu. These template and cycles have already been configured in Marquee Manager Administrator.

15. The Deleted tab status defaults to Clear Display, and Clear Tune for Marquees, Tunes and Controllers. The status for alarms that have been deleted cannot be changed as this is the last opportunity the gateway will have to take the message down or stop

the speaker from playing a tune.

16. Click the Save icon in the toolbar to save your new Routing Rule.

Page 45: Marquee Manager Gateway for Activplant V9 - SeQent · Customer Service ... 35 Modifying and ... Marquee Manager Gateway for Activplant is another product in the Marquee Manager Suite

Using the Gateway

Page 45 of 48

Viewing the Log Files

In each application, you are able to view the log files associated with the various

components of the software. The log files contain an accurate history of every transaction and modification made to the database. Log files are important because they ensure the integrity of the data and provide a means of data recovery.

To View:

1. Select View to get the View Admin Log options.

2. Double-click the log entry for further information.

3. Click the Filters button and choose viewing options to display only the desired information.

4. The Events On: field defaults to the current day.

5. The Status Message field can be used to search for a portion of the message in the

log. Only certain characters may be used in this field. When matching the special characters left bracket ([), question mark (?), number sign (#), and asterisk (*), enclose them in brackets. i.e. To find all log items that start with [ enter in [[]* in the Status Message field. The common search characters are as follows:

Character Match Made Example

? Any single character Text in the log is ABC, DBC and

XYZ. If ?BC is used in the Status

Message field, only ABC and DBC

will be returned.

* Zero or more

characters

*Initiated* in the Status Message

field would return all log items

with the word „Initiated‟

# Any single digit (0-9) Text in the log is Device1,

Device5, Device8, Device10.

Keying in Device# in the Status

Message field, will return Device1,

Device5, and Device8.

6. Select the Automatic Refresh option to automatically refresh the log file based on

the seconds specified.

Page 46: Marquee Manager Gateway for Activplant V9 - SeQent · Customer Service ... 35 Modifying and ... Marquee Manager Gateway for Activplant is another product in the Marquee Manager Suite

Marquee Manager GWAP V9

Page 46 of 48

Glossary

Administrator

Typically a GUI application, this component facilitates configuration and monitoring of a

server engine. If changes are made to the server configuration the administrator notifies the engine to reload its running configuration either automatically or on user demand. An example of an administrator component is Marquee Manager Administrator.

This administrator allows you to maintain the Marquee Manager server's engine configuration.

Administrator Kit

An administrator kit contains the product's administration component only. After installing

this kit on a workstation you may utilize any of the features of the Administrator

component.

Alarm

Generates alarms for points that are in an alarm state. It can generate alarm messages about system events, such as device failures, and device statuses.

Alarm

Assets include any piece of equipment that is being monitored.

Category

A collection of related incidents on an asset.

Class

Alarm class is the order in which an alarm appears relative to other alarms. Alarms with similar characteristics are usually grouped by class.

Default Message

The message that has been configured in Marquee Manager Gateway for Activplant as the default, should the sign be cleared of all slots.

Distribution List

A Marquee Manager Server distribution list is a collection of marquees, which can be sent a message with a single transaction. Similar to an e-mail distribution list a client who

initiates a transaction with a distribution list will automatically send the same message to all associated marquees.

Engine

An engine component implements a unified interface to a set of common, related

protocols. The engine provides services to clients and gateways such that a

common interface may be used to manipulate many different types of devices.

Page 47: Marquee Manager Gateway for Activplant V9 - SeQent · Customer Service ... 35 Modifying and ... Marquee Manager Gateway for Activplant is another product in the Marquee Manager Suite

Glossary

Page 47 of 48

Engines are administered via Administrator components and are utilized by clients, gateways or use written components.

Gateway

A gateway component creates a bridge between a third party product and a standard

NETCON server. Typically an engine this component provides a conduit for forwarding events from the third party product into a NETCON standard server.

An example of a gateway would be an interface to an HMI or SCADA system forwarding events from that system to FirstPAGE Alarm Manager for processing. An example of a gateway is Marquee Manager Gateway for VisualPlant. This gateway forwards VisualPlant incidents to Marquee Manager.

Incident

Incidents include specific events for the selected Group.

Marquee

A sign display that serves as a visualization communication tool, providing the means to display time, date and message text such as production counts, and what areas of a plant are experiencing problems.

Priority

The importance or priority that can be placed on each message sent to the marquee sign, with one being the highest priority and nine being the lowest priority.

Routing Rule

Rules that can be created on various Groups, Assets, Categories or Incidents. When the rule is met, message text can be dispatched to your Marquee Manager Server.

Server Kit

A server kit typically contains the server engine and administrator components. In some

cases a client component is also included with this kit. The server kit is usually installed on a centralized host and is utilized by one or more clients or gateways. An example of a server kit is Marquee Manager Server. This kit contains the Marquee Manager engine, administrator and client.

Speaker

A device connected to the marquee display that allows a tune to be played for alarm states of Generate, Acknowledge, or Reset.

Page 48: Marquee Manager Gateway for Activplant V9 - SeQent · Customer Service ... 35 Modifying and ... Marquee Manager Gateway for Activplant is another product in the Marquee Manager Suite

Marquee Manager GWAP V9

Page 48 of 48

Appendix A – Insertion Tags

Tag Description Attributes available

COL Color AMB – Amber BLK – Black

BLU – Blue BRN – Brown DEF – Default GRN – Green LGR – Light green ORG – Orange

RED – Red WHI – White

YLW - Yellow

BCL Background color Same as COL

FNT Font DEF – Default SML – Small

JST Justification CEN – Center DEF – Default LEFT

RIGHT

MOD Mode DEF – Default FFL – Fast flash FL – Flash REV – Reverse RFF – Reverse fast flash

RFL – Reverse flash ST – Static

STR – Strobe

SCR Scrolling DEF – Default FAST MED

S – Static SLOW

DATE Date DATE DD/MM/YY DD/MM/YYYY

DD-MM-YY DD-MM-YYYY MM/DD/YY MM/DD/YYYY MM-DD-YY MM-DD-YYYY

YY/MM/DD

YY-MM-DD YYYY/MM/DD YYYY-MM-DD

TIME Time 12 24

TIME