Marquee Manager Gateway for CIMPLICITY V9 - SeQent · Marquee Manager Gateway for CIMPLICITY V9.00...

42
Marquee Manager Gateway for CIMPLICITY V9.00 SeQent Corporate Office Suite 137 – 4500 Blakie Road London, ON, N6L 1G5 Canada Phone: +1.519.652.0401

Transcript of Marquee Manager Gateway for CIMPLICITY V9 - SeQent · Marquee Manager Gateway for CIMPLICITY V9.00...

Page 1: Marquee Manager Gateway for CIMPLICITY V9 - SeQent · Marquee Manager Gateway for CIMPLICITY V9.00 SeQent Corporate Office Suite 137 – 4500 Blakie Road London, ON, N6L 1G5 Canada

Marquee Manager Gateway for CIMPLICITY

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 CIMPLICITY V9 - SeQent · Marquee Manager Gateway for CIMPLICITY V9.00 SeQent Corporate Office Suite 137 – 4500 Blakie Road London, ON, N6L 1G5 Canada

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 ............................................................................................... 11

Prerequisites ............................................................................................... 11

Installing the Application .............................................................................. 12

Installing Marquee Manager Gateway for CIMPLICITY ....................................... 12

Adding Project Properties Options for Marquee Manager Gateway for CIMPLICITY 15

.3. Configuring Marquee Manager Gateway for CIMPLICITY ................................. 16

Configuring Key Components – Gateway Server .............................................. 16

Adding a Marquee Manager Gateway for CIMPLICITY Server .......................... 16

Enabling and Configuring Security ................................................................. 21

Configuring Marquee Manager Gateway for CIMPLICITY Options ........................ 24

Configuring the Gateway for CIMPLICITY options .......................................... 24

.4. Using Marquee Manager Gateway for CIMPLICITY .......................................... 26

Modifying and Deleting Tree View Items ......................................................... 27

Modifying ................................................................................................. 27

Page 3: Marquee Manager Gateway for CIMPLICITY V9 - SeQent · Marquee Manager Gateway for CIMPLICITY V9.00 SeQent Corporate Office Suite 137 – 4500 Blakie Road London, ON, N6L 1G5 Canada

Deleting .................................................................................................. 27

Creating Routing Rules ................................................................................. 28

Adding a Routing Rule ............................................................................... 28

Creating Marquee Defaults............................................................................ 36

Adding a Marquee Default .......................................................................... 36

Viewing the Log Files ................................................................................... 39

Glossary........................................................................................................ 40

Page 4: Marquee Manager Gateway for CIMPLICITY V9 - SeQent · Marquee Manager Gateway for CIMPLICITY V9.00 SeQent Corporate Office Suite 137 – 4500 Blakie Road London, ON, N6L 1G5 Canada

Page 4 of 42

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.

© 2011 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 CIMPLICITY V9 - SeQent · Marquee Manager Gateway for CIMPLICITY V9.00 SeQent Corporate Office Suite 137 – 4500 Blakie Road London, ON, N6L 1G5 Canada

Page 5 of 42

Version Information

Edits

Version Date Author Description

V9.00 January/2010 K. MacLennan Initial Document

Page 6: Marquee Manager Gateway for CIMPLICITY V9 - SeQent · Marquee Manager Gateway for CIMPLICITY V9.00 SeQent Corporate Office Suite 137 – 4500 Blakie Road London, ON, N6L 1G5 Canada

Page 6 of 42

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 CIMPLICITY V9 - SeQent · Marquee Manager Gateway for CIMPLICITY V9.00 SeQent Corporate Office Suite 137 – 4500 Blakie Road London, ON, N6L 1G5 Canada

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 42

.1. Product Overview

SeQent’s Marquee Manager Marquee Manager Gateway for CIMPLICITY is a marquee

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

Key Features:

o Local project configuration management

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 embedded point values in alarm messages

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

o Multiple CIMPLICITY projects can populate a shared Marquee Server.

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 CIMPLICITY will queue marquee requests until the server is back on-line.

o Support for multiple projects per machine (Version 6.1 or higher)

Page 8: Marquee Manager Gateway for CIMPLICITY V9 - SeQent · Marquee Manager Gateway for CIMPLICITY V9.00 SeQent Corporate Office Suite 137 – 4500 Blakie Road London, ON, N6L 1G5 Canada

Marquee Manager Gateway for CIMPLICITY V9

Page 8 of 42

How it Works

Marquee Manager Gateway for CIMPLICITY is another product in the Marquee Manager

Suite of products and may reside on your Marquee Manager Server or access a Marquee Manager Server over a LAN or WAN connection.

The Marquee Manager Gateway for CIMPLICITY provides a bridge between CIMPLICITY project alarms and your Marquee Manager Server. Various routing rules can be defined by selecting available Resources, Alarms, Classes and alarm message text that have been configured in your CIMPLICITY project. 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 four valid alarm states that may be configured for each Routing Rule:

o Generate – the alarm becomes active by meeting the rules defined in CIMPLICITY Workbench – Points on the Alarm tab

o Acknowledged – the alarm is Acknowledged by an operator with Alarm Viewer or the point is set up to Auto Ack in the Alarm Options of that point.

o Reset – the alarm is back within normal parameters or the point is set up to Auto Reset under the Alarm Options of that point.

o Delete – the alarm has met the rules under the Deletion Requirements in the Alarm Options.

Page 9: Marquee Manager Gateway for CIMPLICITY V9 - SeQent · Marquee Manager Gateway for CIMPLICITY V9.00 SeQent Corporate Office Suite 137 – 4500 Blakie Road London, ON, N6L 1G5 Canada

Product Overview

Page 9 of 42

Page 10: Marquee Manager Gateway for CIMPLICITY V9 - SeQent · Marquee Manager Gateway for CIMPLICITY V9.00 SeQent Corporate Office Suite 137 – 4500 Blakie Road London, ON, N6L 1G5 Canada

Marquee Manager Gateway for CIMPLICITY V9

Page 10 of 42

Page 11: Marquee Manager Gateway for CIMPLICITY V9 - SeQent · Marquee Manager Gateway for CIMPLICITY V9.00 SeQent Corporate Office Suite 137 – 4500 Blakie Road London, ON, N6L 1G5 Canada

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

Page 11 of 42

.2. Installation

Prerequisites

Before beginning the installation, it is important to determine the hardware and software requirements necessary for Marquee Manager Client 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

CIMPLICITY v6.x, v7.x, v8.x

System Requirements

One of: Microsoft Win2K (SP4+) Microsoft Win2K3 (SP1+)

Microsoft WinXP (SP1a+)

Display: 800x600 Disk Space: 200MB RAM: 128MB

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+)

CIMPLICITY Configuration

In order for Marquee Manager Gateway for CIMPLICITY to receive alarms from your CIMPLICITY project, all applicable alarms must be configured with valid resources. These resources must be attached to valid roles, which are in turn attached to valid users. If all pieces of this setup are not in place, the Gateway will not be able to receive these alarms. As a general rule of thumb, if an alarm is not captured by CIMPLICITY’s internal alarm viewer tool, the Gateway will not receive it

Page 12: Marquee Manager Gateway for CIMPLICITY V9 - SeQent · Marquee Manager Gateway for CIMPLICITY V9.00 SeQent Corporate Office Suite 137 – 4500 Blakie Road London, ON, N6L 1G5 Canada

Marquee Manager Gateway for CIMPLICITY V9

Page 12 of 42

Installing the Application

Before installing Marquee Manager for the first time, the following information must be considered:

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

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

o Determine the CIMPLICITY project name that will be utilized by the Gateway.

o Determine the CIMPLICITY alarm to marquee mapping.

Installing Marquee Manager Gateway for CIMPLICITY

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

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

Page 13: Marquee Manager Gateway for CIMPLICITY V9 - SeQent · Marquee Manager Gateway for CIMPLICITY V9.00 SeQent Corporate Office Suite 137 – 4500 Blakie Road London, ON, N6L 1G5 Canada

Installation

Page 13 of 42

3. Click Finish to complete the installation. The computer must be restarted before the Marquee Manager Gateway for CIMPLICITY can be configured or operated.

4. Prior to installing the Gateway for CIMPLICITY, you must create a client for the

CIMPLICITY server within the project. You will be prompted for your machine name. Enter the Computer name and hit OK.

To create a client for CIMPLICITY:

1. From the Security option in your Workbench, select the Advanced folder, then double click on Client.

2. This is case sensitive. You will then be prompted to enter in the Default User ID. Enter ADMINISTRATOR then select the Trusted option so you will not be prompted for a password.

Page 14: Marquee Manager Gateway for CIMPLICITY V9 - SeQent · Marquee Manager Gateway for CIMPLICITY V9.00 SeQent Corporate Office Suite 137 – 4500 Blakie Road London, ON, N6L 1G5 Canada

Marquee Manager Gateway for CIMPLICITY V9

Page 14 of 42

Page 15: Marquee Manager Gateway for CIMPLICITY V9 - SeQent · Marquee Manager Gateway for CIMPLICITY V9.00 SeQent Corporate Office Suite 137 – 4500 Blakie Road London, ON, N6L 1G5 Canada

Marquee Manager Gateway for CIMPLICITY V9

Page 15 of 42

Adding Project Properties Options for Marquee Manager Gateway for CIMPLICITY

Open your project in Workbench and select the Project menu in the toolbar, then select Properties. In the éi tab under Project Properties, make sure Marquee Manager Gateway option is checked as indicated on the following screen:

Page 16: Marquee Manager Gateway for CIMPLICITY V9 - SeQent · Marquee Manager Gateway for CIMPLICITY V9.00 SeQent Corporate Office Suite 137 – 4500 Blakie Road London, ON, N6L 1G5 Canada

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 16 of 42

.3. Configuring Marquee Manager Gateway for CIMPLICITY

Configuring Key Components – Gateway Server

From within your CIMPLICITY project Workbench, go to the Messaging Gateway

menu located under Equipment and select Administrator. The first time you start

the Administrator, you will be asked to specify the details of your gateway server.

Adding a Marquee Manager Gateway for CIMPLICITY Server

DETAILS TAB

Gateway Server

Project ID A project ID will automatically be assigned when the new server has been saved.

Project Name The Project Name is already added. This is the same name of the project that was opened in Workbench.

Connection

DSN This field will be populated when the server is saved.

User Name Optional

Password Optional

1. Once the Details tab has been configured, select the Settings Tab. The following

screen appears:

Page 17: Marquee Manager Gateway for CIMPLICITY V9 - SeQent · Marquee Manager Gateway for CIMPLICITY V9.00 SeQent Corporate Office Suite 137 – 4500 Blakie Road London, ON, N6L 1G5 Canada

Configuration

Page 17 of 42

SETTINGS TAB

Server

Server Port A default value of 8050 is already added in Server Port. Each project must have a unique port assigned to it. Keep the value the system assigns unless instructed by SeQent to do otherwise.

License Key The License Key is provided by GE with the install kit so defaults to CIMPLICITY Licensed.

Marquee Manager 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 Log 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.

2. Once the Settings have been defined, click the Security tab. The following screen is displayed:

Page 18: Marquee Manager Gateway for CIMPLICITY V9 - SeQent · Marquee Manager Gateway for CIMPLICITY V9.00 SeQent Corporate Office Suite 137 – 4500 Blakie Road London, ON, N6L 1G5 Canada

Marquee Manager Gateway for CIMPLICITY V9

Page 18 of 42

3. 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) For more detailed instructions on Security settings, see section entitled Enabling and

Configuring Security.

4. Select the CIMPLICITY tab to configure alarm states. These states are global to all

alarms within the project. The following is displayed:

Page 19: Marquee Manager Gateway for CIMPLICITY V9 - SeQent · Marquee Manager Gateway for CIMPLICITY V9.00 SeQent Corporate Office Suite 137 – 4500 Blakie Road London, ON, N6L 1G5 Canada

Configuration

Page 19 of 42

CIMPLICITY TAB

CIMPLICITY

Ignore Alarm ACK Select this option if the alarm does not need to be

acknowledged by an operator to suppress messaging even if ACK is required in the alarm’s configuration in CIMPLICITY.

Terminate between

state changes

This option will stop messaging from escalating further when

the alarm state changes. Messaging will commence at level one for that alarm on each state change.

ACK Terminate Alarms

If enabled when the engine receives an ACK it will terminate an alarm.

Suppress alarms at

startup

If enabled alarms found at the startup will not be initiated.

5. Click the Save icon in the toolbar to save changes to the new server.

6. At this point, you must restart Marquee Manager Gateway for CIMPLICITY. From the CIMPLICITY Workbench, select Process Control from the Runtime folder.

Page 20: Marquee Manager Gateway for CIMPLICITY V9 - SeQent · Marquee Manager Gateway for CIMPLICITY V9.00 SeQent Corporate Office Suite 137 – 4500 Blakie Road London, ON, N6L 1G5 Canada

Marquee Manager Gateway for CIMPLICITY V9

Page 20 of 42

7. Double click to open this then change the status of MMGWCIMP from ‘Halted’ by selecting Start Process then OK.

8. The new server is now displayed with an assigned Project ID:

Page 21: Marquee Manager Gateway for CIMPLICITY V9 - SeQent · Marquee Manager Gateway for CIMPLICITY V9.00 SeQent Corporate Office Suite 137 – 4500 Blakie Road London, ON, N6L 1G5 Canada

Marquee Manager Gateway for CIMPLICITY V9

Page 21 of 42

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. The following screen is displayed:

Page 22: Marquee Manager Gateway for CIMPLICITY V9 - SeQent · Marquee Manager Gateway for CIMPLICITY V9.00 SeQent Corporate Office Suite 137 – 4500 Blakie Road London, ON, N6L 1G5 Canada

Marquee Manager Gateway for CIMPLICITY V9

Page 22 of 42

USER 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 CIMPLICITY can be accessed.

Page 23: Marquee Manager Gateway for CIMPLICITY V9 - SeQent · Marquee Manager Gateway for CIMPLICITY V9.00 SeQent Corporate Office Suite 137 – 4500 Blakie Road London, ON, N6L 1G5 Canada

Configuration

Page 23 of 42

Page 24: Marquee Manager Gateway for CIMPLICITY V9 - SeQent · Marquee Manager Gateway for CIMPLICITY V9.00 SeQent Corporate Office Suite 137 – 4500 Blakie Road London, ON, N6L 1G5 Canada

Configuration

Page 24 of 42

Configuring Marquee Manager Gateway for CIMPLICITY Options

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

Configuring the Gateway for CIMPLICITY options

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

2. The install kit will default the Data Source to MMGWCIMPAdmin, pointing to your Gateway for CIMPLICITY database.

3. Select your Display options, specifying how the alarm rules will be displayed in the tree view.

An example of a typical tree view is to group by Resources, then Alarms, then Classes. In this sample, a typical Resource may be TANK, a typical Alarm may be LEVEL-OVERFLOW and Class may be HIGH. This information would be displayed in the tree view as:

Page 25: Marquee Manager Gateway for CIMPLICITY V9 - SeQent · Marquee Manager Gateway for CIMPLICITY V9.00 SeQent Corporate Office Suite 137 – 4500 Blakie Road London, ON, N6L 1G5 Canada

Marquee Manager Gateway for CIMPLICITY V9

Page 25 of 42

TANK (Resource)

LEVEL-OVERFLOW (Alarm)

HIGH (Class)

Display options may be changed at any time without affecting your current configuration.

4. The Server Reload option allows the user to select when they want a reload to server:

with every change, or only when requested.

Page 26: Marquee Manager Gateway for CIMPLICITY V9 - SeQent · Marquee Manager Gateway for CIMPLICITY V9.00 SeQent Corporate Office Suite 137 – 4500 Blakie Road London, ON, N6L 1G5 Canada

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 26 of 42

.4. Using Marquee Manager Gateway for CIMPLICITY

The Marquee Manager Gateway for CIMPLICITY user interface is conveniently displayed in a tree view. The Server, when expanded, shows a Resources folder that enables the user to select from resources that have been configured in the CIMPLICITY project.

It includes an Alarms folder and a Classes folder that enable the user to add various alarms and classes of alarms that once triggered, will route alarms to a marquee or a speaker that have been configured in Marquee Manager Administrator.

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

easier and more effective that include:

o Modifying and Deleting Tree View Items

o Creating Routing Rules

o Creating Marquee Defaults

o Viewing the Log Files

Page 27: Marquee Manager Gateway for CIMPLICITY V9 - SeQent · Marquee Manager Gateway for CIMPLICITY V9.00 SeQent Corporate Office Suite 137 – 4500 Blakie Road London, ON, N6L 1G5 Canada

Marquee Manager Gateway for CIMPLICITY V9

Page 27 of 42

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 28: Marquee Manager Gateway for CIMPLICITY V9 - SeQent · Marquee Manager Gateway for CIMPLICITY V9.00 SeQent Corporate Office Suite 137 – 4500 Blakie Road London, ON, N6L 1G5 Canada

Using the Gateway

Page 28 of 42

Creating Routing Rules

The Routing Rules folder allows users to add and maintain rules on various CIMPLICITY Resources that may include devices, machines, or stations where work is being performed.

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 This should be a logical name to describe the data that will

be met with this rule. Click on the icon to load the

alarms from the CIMPLICITY server and populate the drop downs with the available Resources, Alarms, and Classes.

Resource/Alarm/Class Select a Resource, Alarm and Class from the drop down

menus. The drop down lists will contain resources, alarms and classes that have already been configured in the CIMPLICITY project.

Message Field allows the user to specify a portion of the message

text configured in the alarm details of point’s properties to narrow the alarms returned that will match the rule.

For example, to display only alarms with text including the word HIGH, you could customize the Message field to show *HIGH*. By default the Message field value is the wildcard *, effectively matching all messages.

Page 29: Marquee Manager Gateway for CIMPLICITY V9 - SeQent · Marquee Manager Gateway for CIMPLICITY V9.00 SeQent Corporate Office Suite 137 – 4500 Blakie Road London, ON, N6L 1G5 Canada

Using the Gateway

Page 29 of 42

The Gateway for CIMPLICITY supports CIMPLICITY wildcards for these fields where * matches multiple characters and ? matches single characters.

i.e. TANK* matches all tanks

TANK?0 matches only tanks ending with 0 (TANK10, TANK20, etc.)

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

2. Click the Generated tab to configure where the message will be displayed and

configuration details for that marquee/speaker. The following screen is displayed:

GENERATED TAB

Status

Marquee, Tune, Controller

Choose the action that will be taken when the rule is triggered. i.e. display a message on a marquee that has been configured in Marquee Manager, play a tune, or send a message to a Controller template. (See next section for further screens when each item is selected) Default is to only send a message to a marquee display.

All others are set to No Operation.

Configuration

Priority Priority determines the order that messages sent to the sign will be displayed. High priority messages are a priority of 1 and low priority message will be a priority of 9. Default Priority is set to 9.

Marquee,

Distribution List

A Routing Rule may be sent to a Marquee or a distribution list that

has been configured in Marquee Manager Administrator.

Page 30: Marquee Manager Gateway for CIMPLICITY V9 - SeQent · Marquee Manager Gateway for CIMPLICITY V9.00 SeQent Corporate Office Suite 137 – 4500 Blakie Road London, ON, N6L 1G5 Canada

Marquee Manager Gateway for CIMPLICITY V9

Page 30 of 42

Marquee Select the Marquee that you wish to send the message to from the Marquee: field.

Text The text that will be displayed on the Marquee/Dist list. (See table

below for a list of valid Values for the Text field.) Point values, alarm values and regular text are valid entries for this field. Point values may be inserted in the alarm text with the following syntax:

{POINT.nameofpoint}. You can type the text manually, using the values shown in the table below, or chose from the drop down menu that appears when you use the { symbol. Text field can also include insertion tags, adding with the < symbol. (See Appendix A for a list of available tags)

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.

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.

Scrolling Scrolling options are Default, No Scrolling, Slow Speed, Medium Speed, or Fast Speed.

Font The Font options are Default and Small.

Mode The drop-down contains the choices of Static, Flashing, Fast Flashing, Strobe, Reverse, Reverse Flash and Reverse Fast 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.

Marquee Manager Gateway for CIMPLICITY allows the configuration of additional insertion tags to the default message. Please section in this chapter entitled

“Insertion Tags” for more details.

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

VALUE RESULT

{ALARM.NAME} Alarm name

{POINT.XXX} Point name where XXX is the point

name that must be entered by the user.

{ALARM.RESOURCE} Associated resource name for alarms

{ALARM.CLASS} Associated alarm class

Page 31: Marquee Manager Gateway for CIMPLICITY V9 - SeQent · Marquee Manager Gateway for CIMPLICITY V9.00 SeQent Corporate Office Suite 137 – 4500 Blakie Road London, ON, N6L 1G5 Canada

Using the Gateway

Page 31 of 42

{ALARM.MESSAGE} Alarm message text from the Alarm

tab in the alarm’s configuration

{ALARM.STATE} One of GEN, RST, ACK or DEL

3. 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 Point value. The

valid range for this maximum length parameter is 0 to 1024 and is optional.

i.e. {ALARM.RESOURCE:6} will only show 6 characters of the alarm resource point value.

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 that group, the drop down

will default to that. {Default} will also be available to default these attributes to that of the manufacturer.

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.

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

Page 32: Marquee Manager Gateway for CIMPLICITY V9 - SeQent · Marquee Manager Gateway for CIMPLICITY V9.00 SeQent Corporate Office Suite 137 – 4500 Blakie Road London, ON, N6L 1G5 Canada

Marquee Manager Gateway for CIMPLICITY V9

Page 32 of 42

5. 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.

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:

6. 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.

7. Select the Speaker from the drop down. This will include all sounder models that have

been configured in Marquee Manager Administrator.

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

9. 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.

10. Select the Template icon to configure the template that will play. The following

configuration screen is displayed:

Page 33: Marquee Manager Gateway for CIMPLICITY V9 - SeQent · Marquee Manager Gateway for CIMPLICITY V9.00 SeQent Corporate Office Suite 137 – 4500 Blakie Road London, ON, N6L 1G5 Canada

Using the Gateway

Page 33 of 42

11. Select the Controller and Template from the drop downs. These have already been

configured in Marquee Manager Administrator.

12. Select the Acknowledged tab to configure details for the alarms that have been acknowledged. The following screen is displayed:

13. The acknowledged status defaults to No Operation for both Marquees and Tunes.

Follow the steps listed above for configuring the Generated tab to set the display attributes on alarms that have been acknowledged.

Page 34: Marquee Manager Gateway for CIMPLICITY V9 - SeQent · Marquee Manager Gateway for CIMPLICITY V9.00 SeQent Corporate Office Suite 137 – 4500 Blakie Road London, ON, N6L 1G5 Canada

Marquee Manager Gateway for CIMPLICITY V9

Page 34 of 42

The Change Display feature for acknowledged alarms could be used for example, to

change the message from Red to Yellow to indicate it was acknowledged.

14. Select the Reset tab to configure details for the alarms that have been reset. The

following screen is displayed:

15. The reset status defaults to No Operation for both Marquees and Tunes. Follow the steps listed above for configuring the Generated tab to set the display attributes on alarms that have been reset.

16. Select the Deleted tab to configure details for the alarms that have been deleted. The

following screen is displayed:

Page 35: Marquee Manager Gateway for CIMPLICITY V9 - SeQent · Marquee Manager Gateway for CIMPLICITY V9.00 SeQent Corporate Office Suite 137 – 4500 Blakie Road London, ON, N6L 1G5 Canada

Using the Gateway

Page 35 of 42

17. The deleted status defaults to Clear Display and Clear Tune for both Marquees and

Tunes. 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.

18. Click the Save icon in the toolbar to save your new routing rule.

Page 36: Marquee Manager Gateway for CIMPLICITY V9 - SeQent · Marquee Manager Gateway for CIMPLICITY V9.00 SeQent Corporate Office Suite 137 – 4500 Blakie Road London, ON, N6L 1G5 Canada

Marquee Manager Gateway for CIMPLICITY V9

Page 36 of 42

Creating Marquee Defaults

The Marquees folder allows users to add and maintain default messages on each marquee that has been configured in Marquee Manager Administrator.

The default configuration allows you to set word wrapping details for multiple line marquees, taking long messages values such as {ALARM.MESSAGE} and wrapping them across multiple lines.

Adding a Marquee Default

1. Expand the Marquees folder and select a configured marquee that you would like to

send a default message to. The following screen is displayed:

MARQUEE DETAILS TAB

Configuration

Line Length Select the Line Length to define how long the display lines to

determine when to wrap the message onto the next line.

Word Wrap

Length Select the Word Wrap length to determine at what point in the

word, to wrap to the next line if it is equal to or shorter than this value. Any words longer than this value will be broken with a “-“

and the remaining portion wrapped to the next line. (See Note

below for additional details)

Default Message

Text Enter in the Text for the default message in the Text: field. If no

alarms are coming from the Gateway for CIMPLICITY for a specific marquee, the default message for that marquee will be displayed. You can insert point values in the default message via the syntax {POINT.nameofpoint}.

Page 37: Marquee Manager Gateway for CIMPLICITY V9 - SeQent · Marquee Manager Gateway for CIMPLICITY V9.00 SeQent Corporate Office Suite 137 – 4500 Blakie Road London, ON, N6L 1G5 Canada

Using the Gateway

Page 37 of 42

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.

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.

Scrolling Scrolling options are Default, No Scrolling, Slow Speed, Medium Speed, or Fast Speed.

Mode The Font options are Default and Small.

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

Flashing, Strobe, Reverse, Reverse Flash and Reverse Fast 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.

Note:

If the last word on line 1 will be broken with a “-“ as it exceeds the Word Wrap length, the whole word will be wrapped to the next line based on what is configured in the Word Wrap Length field.

ie. The message to be displayed is “My MMSGWCIMP Test Message”

with Line Length set to 20 and Word Wrap set to 6. Normally ‘Message’ would be broken with a “-“ as it is longer than 6 characters, however, as the break would leave less than 4 characters on line 1, the whole word ‘Message’ will get bumped to the next line.

2. If a marquee is configured in the Gateway with a default message, then it is removed

from Marquee Manager Server, it will show up in the tree view under the Marquees folder with an X. The Gateway will then allow this marquee to be deleted.

Page 38: Marquee Manager Gateway for CIMPLICITY V9 - SeQent · Marquee Manager Gateway for CIMPLICITY V9.00 SeQent Corporate Office Suite 137 – 4500 Blakie Road London, ON, N6L 1G5 Canada

Using the Gateway

Page 38 of 42

If you are using MMGWCIMP version 9.0 or higher, a Groups folder will appear

in the tree view under the Marquee folder, if Distribution Lists are configured in

Marquee Manager. When an item is selected in Groups, there is an option to configure the Line Length and Word Wrap Length as shown in the following screen:

Page 39: Marquee Manager Gateway for CIMPLICITY V9 - SeQent · Marquee Manager Gateway for CIMPLICITY V9.00 SeQent Corporate Office Suite 137 – 4500 Blakie Road London, ON, N6L 1G5 Canada

Marquee Manager Gateway for CIMPLICITY V9

Page 39 of 42

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 40: Marquee Manager Gateway for CIMPLICITY V9 - SeQent · Marquee Manager Gateway for CIMPLICITY V9.00 SeQent Corporate Office Suite 137 – 4500 Blakie Road London, ON, N6L 1G5 Canada

Glossary

Page 40 of 42

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.

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 CIMPLICITY 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.

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.

Point

Data that can be collected from various devices such as programmable controllers. Point

configuration defines where a point originates, how the data is collected, and what constitutes an alarm state.

Page 41: Marquee Manager Gateway for CIMPLICITY V9 - SeQent · Marquee Manager Gateway for CIMPLICITY V9.00 SeQent Corporate Office Suite 137 – 4500 Blakie Road London, ON, N6L 1G5 Canada

Page 41 of 42

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.

Resource

The physical or conceptual units that comprise your facility and can be anything from devices and machines to stations where work is performed.

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 42: Marquee Manager Gateway for CIMPLICITY V9 - SeQent · Marquee Manager Gateway for CIMPLICITY V9.00 SeQent Corporate Office Suite 137 – 4500 Blakie Road London, ON, N6L 1G5 Canada

a p p e n d i x a - i n s e r t i o n t a g s

Page 42 of 42

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

<DATE-DDD>

<DATE-DDDD>

TIME Time 12 24 TIME