View
230
Download
0
Category
Preview:
Citation preview
Marquee Manager Gateway for MQ Series
V9.00
SeQent Corporate Office Suite 137 – 4500 Blakie Road London, ON, N6L 1G5 Canada Phone: +1.519.652.0401
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
Database Conversion ................................................................................................... 10
Installing the Application ........................................................................................... 11
Setting Logon Information ................................................................................... 12
Installing Remote Administrator - Setup ...................................................................... 13
Installing Remote Administrator – Install ..................................................................... 19
.3. Configuration ......................................................................................................... 20
Setting up the Application ......................................................................................... 20
Configuring Key Components - Server ......................................................................... 21
Adding a Server .................................................................................................... 21
Enabling and Configuring Security .............................................................................. 27
Configuring Key Components - Device ........................................................................ 30
Adding a Device .................................................................................................... 30
Configuring Key Components – Items and Item Groups................................................. 32
Adding a Data Access Type Item ............................................................................. 32
Item States on Start-up ......................................................................................... 33
Adding an Item Group ........................................................................................... 35
Configuring Key Components –Item Snapshots ............................................................ 37
Adding a Snapshot for a Device ............................................................................... 37
Configuring Key Components – Events & Event Groups ................................................. 39
Adding an Event .................................................................................................... 39
Adding an Event Group .......................................................................................... 52
Configuring Key Components – Timed Items & Groups .................................................. 54
Adding a Timed Item ............................................................................................. 54
Adding a Timed Item Group .................................................................................... 56
Configuring Key Components – Virtual Items & Groups ................................................. 58
Adding a Virtual Item ............................................................................................. 58
Adding a Virtual Item Group ................................................................................... 61
Configuring Key Components – Function Rules ............................................................. 63
Adding a Function Rule for Display .......................................................................... 63
Adding a Function Rule to Play a Tune ..................................................................... 68
.4. Using Marquee Manager Gateway for MQ Series ......................................................... 73
Modifying and Deleting Tree View Items ...................................................................... 74
Modifying ............................................................................................................. 74
Deleting ............................................................................................................... 74
Marquee Tools - Options............................................................................................ 75
Options ................................................................................................................ 75
Viewing the Log Files ................................................................................................ 76
Glossary ..................................................................................................................... 77
Page 4 of 81
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 of 81
Version Information
Edits
Version Date Author Description
V9.00 November, 2011 D. Labute Initial Document
Page 6 of 81
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: Support@SeQent.Com
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: info@SeQent.com
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 81
.1. Product Overview
SeQent’s Marquee Manager Gateway for MQ Series allows users to easily retrieve MQ
SERIES hosted data items, perform basic calculations on numeric items, and monitor the information for conditions. Once a data item is found to match the event’s test condition, marquees or Andon board messages may be displayed. Sounder devices
may also be triggered.
Key Features:
◦ Hot reload for any configuration changes/additions/deletions ◦ The gateway can connect to multiple MQ SERIES servers ◦ Supports 9 types of items:
BIT FLOAT
SIGNED BYTE SIGNED LONG SIGNED WORD
STRING UNSIGNED BYTE UNSIGNED LONG UNSIGNED WORD
Marquee Manager GWMQ SERIES V9
Page 8 of 81
How it Works
Marquee Manager Gateway for MQ Series 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 MQ Series provides a bridge between MQ SERIES supported servers and your Marquee Manager Server. Various event rules can be defined based on MQ SERIES Data Items or conditions. Once one of these trigger conditions is met, message text can be dispatched to your Marquee Manager Server, including providing values from MQ SERIES Data Items embedded within the message text.
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 81
.2. Installation
Prerequisites
Before beginning the installation, it is important to determine the hardware and software requirements necessary for Marquee Manager Gateway for MQ Series 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.x
System Requirements
Applications:
IBM MQ SERIES Server(s)
One of: Microsoft Win2K3 (SP1+) Microsoft WinXP (SP1a+)
Display: 800x600
Disk Space: 1G RAM: 1G
Drivers TCP/IP MDAC V2.7 (SP1+)
Marquee Manager GWMQ SERIES V9
Page 10 of 81
Database Conversion
If you are upgrading to a higher version of Marquee Manager Gateway for MQ Series,
you will need to run the Database Converter included in your kit. When starting the application for the first time after your upgrade, you will receive a message indicating an incompatible database. You will be instructed to run the Database Convertor.
The Database Convertor is found under: Start > All Programs > Marquee Manager
Gateway for MQ Series > Server > Database Conversion
The Conversion Wizard will display a summary of changes that will be made to your database, including the current version that is running and the target database. Click Start to run the converter. Conversion results will then be displayed.
Be sure to restart the Marquee Manager Gateway for MQ Series service after completing the database conversion.
Installation
Page 11 of 81
Installing the Application
Before installing Marquee Manager Gateway for MQ Series for the first time, the
following information must be considered:
o Determine the Marquee Manager Server host name you will be connecting to
o Determine which disk drive/directory your Marquee Manager Gateway for MQ Series software will reside on
To Install Marquee Manager Gateway for MQ Series:
1. Run Marquee Manager Gateway for MQ Series SETUP.EXE. Click Next.
2. After accepting the licensing agreement, you will be prompted for the installation destination directory.
Marquee Manager GWMQ SERIES V9
Page 12 of 81
3. Click Finish to complete the installation. The computer must be restarted before the
Marquee Manager Gateway for MQ Series can be configured or operated.
4. Marquee Manager Gateway for MQ Series allows users to connect to remote MQ
SERIES Servers; servers that are not located on the same machine that is running the Gateway for MQ Series.
5. If remote MQ SERIES Servers are being used, prior to launching the Gateway for MQ Series application, you must first set logon information to enable MM Gateway for MQ Series to use DCOM to connect to the remote MQ SERIES Servers. You must also install the MQ SERIES Client files required to connect to an MQS mailbox.
Setting Logon Information
To set logon information for the MQ SERIES Service:
1. From Control Panel, Administrative Tools, Services, double click the MM Gateway for MQ Series service.
2. Change the logon for the service to a valid user account, trusted between both the MM
GWMQ SERIES server machine and all remote MQ SERIES Servers.
The remote MQ SERIES Server and the machine trying to access it must be on the same domain.
Installation
Page 13 of 81
Installing Remote Administrator - Setup
The Marquee Manager Gateway for MQ Series Administrator utility program is used to
configure and control the Marquee Manager Gateway for MQ Series engine. System managers responsible for Marquee Manager are the intended users of Marquee Manager Gateway for MQ Series Administrator.
The features and operations that can be performed with Marquee Manager Gateway for MQ Series Administrator include adding, modifying, deleting, listing, printing database information, viewing logs and changing server configurations, etc.
The Marquee Manager Gateway for MQ Series Administrator program can be accessed from any administrator workstation by purchasing the Marquee Manager Gateway for MQ Series Administrator Kit.
Before installing and configuring Marquee Manager Gateway for MQ Series
Administrator, there are two steps that must be completed. The first is to share the files on the server running Marquee Manager Gateway for MQ Series Server. The second is creating a DSN on the computer where the Marquee Manager Gateway for MQ Series Administrator will be installed.
Sharing an Application Folder
This step must be done on the computer where the Marquee Manger Gateway for MQ
Series Administrator will be installed.
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 MQ Series is the folder we want to share because it contains the data and log files.
2. Right click on the folder and choose Sharing and Security. On the Sharing tab, select "Share This Folder". In Windows Vista and later, right click on the folder and
Marquee Manager GWMQ SERIES V9
Page 14 of 81
choose Properties, and then choose the Sharing tab of the properties window.
3. Click on the Permissions button and make sure Allow is selected under Permissions for Everyone. Click Apply.
Installation
Page 15 of 81
4. In your tree view, the Marquee Manager Gateway for MQ Series 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 MQ Series Administrator will be installed.
1. In Windows, go to Start >Control Panel> Administrative Tools > Data Sources (MQ SERIES). Chose the System DSN tab and click on Add.
In 64 bit environments, this ODBC Data Source Administrator should be accessed
via C:\WINDOWS\SysWOW64\odbcad32.exe
Marquee Manager GWMQ SERIES V9
Page 16 of 81
2. Double click on Microsoft Access Driver (*.mdb)
3. Enter the Data Source Name then click on Select to locate the associated database.
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: \\SBURNSNB5\MMGWMQSERIES\data\ A list of SBURNSNB5’s .mdb's will appear.
Installation
Page 17 of 81
5. Choose the MMGWMQSERIESServer.mdb and click OK.
6. Your new DSN name should appear.
Marquee Manager GWMQ SERIES V9
Page 18 of 81
Installation
Page 19 of 81
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 MQ Series Administrator can be configured or
operated.
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 20 of 81
.3. Configuration
Setting up the Application
Before you can begin using Marquee Manager Gateway for MQ Series Administrator, you must add at least one Server to the administrator. Once the Server is added, various settings that control the interface to the Server must be configured. The steps required include:
1. Adding a Server
2. Adding a Device
3. Adding an Item and Item Snapshots
4. Adding an Event
5. Adding Timed Items
6. Adding Virtual Items
7. Adding Functions
Marquee Manager GWMQ SERIES V9
Page 21 of 81
Configuring Key Components - Server
Adding a Server
Marquee Manager Gateway for MQ Series 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 your Marquee Manager Gateway for
MQ Series server.
New Server Steps
1. After installing and restarting your computer, select Start – Programs – Marquee Manager – Gateway for MQ Series – Administrator to launch Marquee Manager Gateway for MQ Series.
2. Select the MMGWMQ Servers icon in the tree view. Click the New Server icon in the toolbar. You will be prompted to select an MQ SERIES Machine Data Source. The installation kit has already created this DSN. Simply select the
MMGWMQSERIESServer DSN and click OK.
If you are using an upgraded Marquee Manager Gateway for MQ Series 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 MMGWMQSERIESServer.MDB file to allow the remote server to be maintained. First share the remote server’s Marquee Manager\Gateway for MQ Series directory. On the machine running the remote Administrator, configure the DSN to use the server database: \\remoteservername\mmgwMQSERIESshare\data\MMGWMQSERIESSERVER.MDB. It is a good idea to include the hostname in the DSN name to clarify the server being maintained. (ie. MMGWMQ SERIES_SERVER1) One DSN must be created per server being maintained.
Marquee Manager GWMQ SERIES V9
Page 22 of 81
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 MQ Series to the IBM MQ Series Server allowing it to connect to a server.
Marquee Manager GWMQ SERIES V9
Page 23 of 81
DETAILS TAB
Server
Host Name A TCP/IP resolvable name for the machine running Marquee Manager Gateway for MQ Series. 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\GatewayforMQ
SERIES\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.: \\LAB1\MMGWMQ SERIES\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.
Configuration
Page 24 of 81
SETTINGS TAB
Server
Server Port Port that connects to the Marquee Manager Gateway for MQ Series. Defaults to 8016.
License Key Enter a valid Marquee Manager Gateway for MQ Series license key
Marquee Manager
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 - FORD (specific only to Ford users) - CHRYSLER (specific only to Chrysler users)
For more detailed instructions on Security settings, see “Enabling and Configuring
Security”.
Configuration
Page 25 of 81
6. Click on the Save icon to save your settings.
Sample New Marquee Gateway for MQ Series Details
Configuration
Page 26 of 81
Sample New Marquee Gateway for MQ Series Settings
REMOTE ADMINISTRATOR: If setting up Remote Administrator, the Settings Tab will already be populated and will be locked as these values should only changed from the server.
Marquee Manager GWMQ SERIES V9
Page 27 of 81
Enabling and Configuring Security
1. To enable Security, you must select a Security Mode. Default selection is NONE.
Your choices include: - NONE - 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.
It is important to note that changing the security mode will cause all user table entries to be deleted.
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.
Marquee Manager GWMQ SERIES V9
Page 28 of 81
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. Click on the Security tab. The following screen is displayed:
Configuration
Page 29 of 81
SECURITY TAB
Security
Level 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.
4. Save your changes. The next time the application is started, you will be prompted
for a User ID/password and a valid Domain name before access is given.
The first user entered must be an administrator with Admin security. The last user
removed must also be an Admin.
5. The user will now be prompted for a UserID/password and a valid Domain name before the Marquee Manager Gateway for MQ Series can be accessed.
Marquee Manager GWMQ SERIES V9
Page 30 of 81
Configuring Key Components - Device
Adding a Device
Marquee Manager Gateway for MQ Series Devices folder allows you to add and maintain devices and device related information such as the DSN name. Devices are the database servers to which the server will connect to retrieve item values.
New Device Steps
1. Click the Devices folder then select New Device from the toolbar or right click and select New Device.
Configuration
Page 31 of 81
DETAILS TAB
Configuration
Name This is a logical name utilized by the administrator to refer to this device. (Max Length 50)
Queue This field specifies the name of the MQ Series Queue
that the administrator will receive messages from. Values can range from 100 to 5000ms and defaults to 1000ms.
Polling Interval This value determines how often the administrator will check the specified queue for new messages.
Queue Manager Name
The name of the MQ Series Queue Manager to read
messages from.
Connection Machine name where the MQ SERIES Server is running.
Channel Name of the MQ Series Channel to read messages
from.
Note Enter in an optional note to describe this server.
2. Click the Save icon in the toolbar to save the new Device.
Configuration
Page 32 of 81
Configuring Key Components – Items and Item Groups
Adding a Data Access Type Item
Item information also referred to as Items, can now be added to the configured Device(s). Items are values collected from a database via a query, which return a single row and column value.
New MQ Item Steps:
1. Expand the Devices folder and select the device connected to the database to be queried. Select the Items folder, then click New Item in the toolbar. The following screen is displayed:
DETAILS TAB
Configuration
Name This is a name utilized by the administrator to refer to this item. This should be a logical name to describe the data the item is polling. (Max Length 50)
Item This is the MQ SERIES Item name that was configured in the MQ SERIES Server.
Type Defaults to UNSIGNED WORD (See table below for a list of supported Item types)
Threshold The point at which the collected values roll over. i.e. when
a value reach 100, they will rollover to 0 and begin again. By entering a correct rollover value for the threshold Gateway for MQ Series will be able to determine the number
Configuration
Page 33 of 81
of times this counter has rolled over and provide you with
correct values regardless of the number of rollovers.
Honor Quality A state reported from the MQ SERIES messages. If the data
integrity of the data collected by the server is questionable then the items quality will be set to bad. If the Honor Quality item is selected then this item will report quality issues.
Note Enter in an optional note to describe this Item.
Item Type Description
BIT Individual binary value 0 or 1
FLOAT Decimal numeric value
SIGNED BYTE Integer value between –127 and 127
SIGNED LONG Integer value between –2,147,483,647 to 2,147,483,647
SIGNED WORD Integer value between –32,767 to 32,767
STRING Characters value
UNSIGNED BYTE Integer value between 0 and 255
UNSIGNED LONG Integer value between 0 to 4,294,967,295
UNSIGNED WORD Integer value between 0 to 65,535
2. Click the Save icon in the toolbar to save changes.
Item States on Start-up
The engine has a clearly defined state and output of items while the engine is starting up and when items are in an unexpected state. The states are as follows:
Item State Online/Offline/Unknown Status Substituted Text
LOAD UNKNOWN *NOT-POPD*
INIT OFFLINE *ITEM-INIT*
CONN UNKNOWN /OFFLINE *NOT-POPD*
POPD ONLINE (Item Value)
BQTY OFFLINE *BAD-QUAL*
Configuration
Page 34 of 81
Lifecycle of an Item
LOAD
INITOFFLINE
CONN
POPDONLINE
BTQYOFFLINE
1
2
3
4
5
6
7
8
Initially, the items are all in LOAD state and an UNKNOWN status. When the MQ SERIES component tries to connect to the item, the item is set to a CONN state. If successful it
remains as UNKNOWN status [2]. Otherwise it is set to INIT and the status is OFFLINE [1].
The status for the INIT state can be either OFFLINE or no state. If item goes from LOAD
(which has no status, the item isn't ON or OFFLINE) then the state remains UNKNOWN. If the item goes from INIT as offline to CONN, it will remain OFFLINE [3].
Once the first valid value is received for the item, it is set to POPD state and an online status [4]. If a bad quality value is received, and honour quality is true for the item, then the state is changed to BQTY, and goes OFFLINE [5] If, while in POPD or BQTY state, something happens with the connection to the MQ SERIES server, then the state is
changed to INIT and goes OFFLINE. While in BQTY, a good value will return it to POPD and ONLINE status [8].
If the switch to INIT happened from POPD, then the item will go OFFLINE [6]. If the switch to INIT happened from BQTY state, then the item remains OFFLINE [7].
Marquee Manager GWMQ SERIES V9
Page 35 of 81
Adding an Item Group
Gateway for MQ Series allows for the organization of MQ SERIES items more efficiently by allowing the creation of Item Groups. This provides a logical way to organize related data.
To add an Item Group:
1. Expand the Devices folder and select the MQ SERIES Device that will be edited. Select the Items folder, then right click and select New Item Group, or select the New button drop down on the toolbar and select Item Group. The following screen is displayed:
GROUP DETAILS TAB
Configuration
Name This is a name utilized by the administrator to refer to this Item Group.
Description Further description utilized by the administrator to refer to this Item Group. This field is optional.
In the following example, an Item Group has been created for the Station in each of
two Lines in Body. If one line goes down, the user can easily disable all items in that Item Group without having to search the tree view for the items associated with that
line.
Configuration
Page 36 of 81
Sample Item Group
2. Click on the Save icon in the toolbar to save the Item Group.
Marquee Manager GWMQ SERIES V9
Page 37 of 81
Configuring Key Components –Item Snapshots
Adding a Snapshot for a Device
Gateway for MQ Series allows the user to take a picture, or a snapshot of the current tag value for a given time. You can specify at what time and how often this snapshot will be taken. This is available for Data Access type devices only.
Snapshots can be displayed in marquee messages, or used when calculating virtual tags. An example of the use of snapshots is to record a press cycle count at the beginning of a
shift. This value can then be used to calculate the number of parts produced by the press at some period within the shift. A virtual tag could then be created which maintains the number of parts built at the current time by using the calculation:
BUILTSOFAR = {MQ_ITEM.CYCLECOUNT.CUMUL}-{MQ_ITEM.CYCLECOUNT.SHIFTSTART.CUMUL}
The virtual tag BUILTSOFAR will contain the number of parts produced at the current time during the shift.
New Snapshot Steps:
1. Select a Device then expand the tree view and select the Snapshots folder. Click the New icon in the toolbar. The following screen is displayed:
Configuration
Page 38 of 81
DETAILS TAB
Configuration
Name This is a name utilized by the administrator to refer to
this Snapshot.
Start Time Enter the time that this snapshot will be taken.
Defaults to current system time.
Interval (seconds) This field indicates how often the snapshot will be
taken, in seconds. 86400 = daily. 3600 = hourly, 28800 = 8 hours etc. etc.
Note Add any additional notes. This field is optional.
2. Click the Save icon in the toolbar to save the new Snapshot.
Sample Snapshot
In this example the SHIFT1_START snapshot will be taken every 86400 seconds or every day starting at 07:00 a.m.
Marquee Manager GWMQ SERIES V9
Page 39 of 81
Configuring Key Components – Events & Event Groups
Adding an Event
Gateway for MQ Series allows users to configure events containing rules that when true, will display items and virtual items to a specified marquee or play a selected speaker tune.
New Event Steps:
1. Select the Events folder from the treeview then select New Event from the toolbar, or right click on the Events folder and select New Event. The following screen is displayed:
DETAILS TAB
Event Details
Name This is a name utilized by the administrator to refer to
this Event. This name should reflect the rule being implemented by this event. i.e. SHIFT1_PROD to provide production values for shift one to date.
Item Type This Item Type will be monitored to determine the event’s state: MQ item, Virtual Item, Timed Item
Trigger Item This is the Item that the Event will monitor. This field is
filtered to display the available items based on the Item Type selected.
For an Event utilizing an Item type of
UNSIGNED/SIGNED WORD, BIT, BYTE or LONG, an additional field of Bit appears. Select the specific Bit from the UNSIGNED/SIGNED WORD that you wish to
Marquee Manager GWMQ SERIES V9
Page 40 of 81
evaluate, or ALL to evaluate the data as an integer.
Test Select the Test type that will be performed on this event. The interface updates the available fields based on Test type. (See table below for a list of the available
bit options and what fields are available to the user when various tests are selected)
Bit Test Fields Enabled
ALL = Value
ALL < Value
ALL > Value
ALL <> Value
ALL change Precision
ALL range Minimum, Maximum
ALL offline
0-x = Value
0-x <> Value
0-x change Precision (defaults to 1)
Bit values range from 0-x where x is 0 for an item type of Bit, 7 for an item type of Byte, 15 for an item type of Unsigned/Signed Word and 31 for an item type of Unsigned/Signed Long.
If an MQ SERIES collected item is offline then the event test against that item will be false and an action won’t be taken, unless the test is offline.
2. When a connection is lost between your MQ SERIES Client and the MQ Server:
◦ If you have selected “Honor Quality” when configuring your Item, the tag
is reported as bad quality.
◦ If you have left “Honor Quality” unselected, the tag is reported as good. The last value collected before the item went offline, will be shown.
When the item is configured incorrectly (ie. misspelled):
◦ If “Honor Quality” is selected, the tag is reported as bad quality.
◦ If “Honor Quality” is unselected, the tag is still reported as bad quality, as it was never able to make the initial connection.
3. Click on the Actions tab to configure the actions that will occur when this event is
triggered. The following screen is displayed:
Configuration
Page 41 of 81
ACTION TAB
Status
Marquee, Tune,
Virtual, Controller
Choose the action that will be taken when the event is
triggered. i.e. display a message on a marquee that has been configured in Marquee Manager, play a tune, manipulate text in a virtual item 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
An Event action may be sent to a Marquee or a distribution list that has been configured in Marquee Manager Administrator
Text The text that will be displayed on the Marquee/Dist list.
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.
Marquee Manager GWMQ SERIES V9
Page 42 of 81
The message can be right-aligned, left-aligned, or centered on
the marquee.
4. Click the Save icon in the toolbar to save the new Event. Sample Event Details
Sample Event Action
Marquee Manager GWMQ SERIES V9
Page 43 of 81
Marquee Display
The following are steps required if the selected Action is to Change Display:
Marquee – Change Display
1. Select the Priority for the message. The Priority is the Marquee Manager Server
message priority that 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.
2. Select the Marquee where the message will be displayed. The list of available
marquees, are those marquees that have been configured in Marquee Manager Administrator. You may also send the message to a Group that has been configured
in Marquee Manager Administrator by selecting the Groups option to display a list of available groups.
3. The Text: field may contain regular text as well as MQ Items, Timed Items and Virtual Items. To obtain a list of the configured Items, enter { which opens up a drop down list of available Item Types.
4. This first pop-up menu allows you to select which Item type you wish to retrieve:
MQ_ITEM, TIMED_ITEM, VIRTUAL_ITEM, FUNCTION rule, TYPECONV, MATH, DTIME, STRING or EVENT variables. Selecting the Item Type will open another pop-up menu to select the trigger item. The final menu allows you to select the cumulative, current or previous values of the selected item.
5. The following is a list of data elements and options available for each Item Type:
Item Type Data Elements Options
MQ_ITEM Configured MQ Items Cumulative, Current,
Previous Snapshots
FUNCTION Configured Function Rules N/A
TIMED_ITEM Configured Timed Items Current
VIRTUAL_ITEM Configured Virtual Items Current
TYPECONV STRFLT Returns the specified string data as a float
MATH ROUND Rounds the specified item
to the specified number of digits
DTIME FMTSEC Returns a string representing the seconds contained in the item as a string in the specified
format
STRING STRTKN Pulls a string portion from a larger string that is
using a delimiter such as a space, or other symbol
such as ‘/’, ‘#’ etc. (See example below)
EVENT START DATE – 2010/01/30 (yyy/mm/dd) TIME – hh:mm (does not insert a.m. or p.m.)
TIME24 – hh:mm in 24
Marquee Manager GWMQ SERIES V9
Page 44 of 81
hour format
TIMESEC – hh:mm:ss (does not insert a.m. or
p.m.) TIME24SEChh:mm:ss in 24 hr
Ex. {EVENT.START.DATE} displays as 2010/01/30
EVENT ACTIVE HR - hh MIN - mm SEC - ss HRMIN- hh:mm MINSEC – mm:ss HRMINSEC – hh:mm:ss
Ex. {EVENT.ACTIVE.HRMINSEC} displays as 4:23:45
If an Item has been misconfigured or does not exist, the message will display *NOT_FOUND*
for that item. If the quality of an item is “Not Good”, any item triggered by the event should be turned off and any virtual items should be invalidated if it uses the item.
6. Select the display attributes that the message will be displayed with including Foreground Color, Background Color, Font, Justification, Scroll, and Mode. If only one attribute is available (i.e. only Color Red available on the selected marquee) the field will default to this. All other fields will display {Default}.
7. 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.
8. Click the Save icon in the toolbar to save changes.
Marquee Manager Gateway for MQ Series allows you to configure additional insertion items to
the default message. See Appendix A – Insertion Tags for a list of currently available tags. The insertion items must be included in brackets and must be all upper case.
Sample STRING Function Usage
The STRING function uses the following syntax:
{STRING.STRTKN[<VALUE>,<INDEX>,<TOKEN>]}
Where:
<VALUE> = an Item of type String
<INDEX> = string portion that will be pulled from the Item String
<TOKEN> = the delimiter which can be a space, multiple spaces or any
character(s) such as /,or # and must be in double quotes. If the delimiter does not match or the index is outside the string range, than a NULL string will be returned.
Marquee Manager GWMQ SERIES V9
Page 45 of 81
Example:
{STRING.STRTKN[“This is a number 12.34 with a string”,5,” “]}
Would return:
“12.34” as a string value
{STRING.STRTKN[“This is a number 12.34 with a string”,12,” “]}
Would return:
(NULL string) as a string value as 12 is outside the range of items in the specified string.
Configuration
Page 46 of 81
Change a Tune
The following are steps required if the selected Action is to Change a Tune:
Tune – Change Tune
1. If you choose to change a tune, select the Change Tune option then click on the
speaker icon . The following screen is displayed:
2. Select the Priority that the tune will be played with. The Priority is the Marquee Manager Server message priority that determines the order that the tune will be played. High priority tunes are a threshold of one and low priority tunes will be a threshold of nine. Default Priority is set to nine.
3. Select the Speaker that the tune will play on. The list contains all speakers that have
been configured in Marquee Manager Administrator. You may also play the tune on a group of speakers that have been configured in Marquee Manager Administrator by selecting the Groups option to display a list of available groups.
4. Select the tune to be played from the Tune #: field. You may choose to play the tune
continuously or to play for any duration of time by selecting the Play for option and entering in the number of seconds that the tune will be played for.
You may also select “Function” and use a Function Rule set up under Tools. This is covered later on in this chapter under “Configuring Function Rules”.
Marquee Manager GWMQ SERIES V9
Page 47 of 81
Populate Text
The following are steps required if the selected Action is to Populate Text:
Virtual – Populate Text
1. If you choose to populate text, select the Populate Text option then click on the text
icon . The following screen is displayed:
2. Select the Item that you wish to populate. This Item must be a Virtual Item created with a type of Event Text. Use this feature to string the multiple results of your Virtual Item on a marquee.
See section in this chapter entitled “Adding a Virtual Item” for details on creating a Virtual Item of type Event Text.
Configuration
Page 48 of 81
Sample Event Detail to Populate Text to a Virtual Item
Sample Event Action to Populate Text to a Virtual Item
3. The events CHECK_W1_ROD, CHECK_W2_ROD and CHECK_W3_ROD monitor if the welder states are not equal to 0 (require welding rod).
4. In the example above, three events have been created to monitor the state for each of three welders. The Text field on the Actions tab includes the message that will be added to the event text virtual item if the welder state = 1, thus requires a rod.
Configuration
Page 49 of 81
5. A Virtual Item of WELDROD_NEEDED has been created to contain the list of welders
that require a welding rod, else it will display the default message of NO ROD REQUIRED.
6. An Event of SHOW_ROD_NEEDED has been created to monitor any changes to the
Virtual Item, thus any changes to each of the three Welder States and display the current state on the marquee selected.
Sample Event Detail Monitoring an Event Text
The Event SHOW_ROD_NEEDED monitors the Virtual Item WELDROD_NEEDED for any changes to the states of the three welders.
Configuration
Page 50 of 81
Sample Event Action Monitoring an Event Text
Marquee Manager GWMQ SERIES V9
Page 51 of 81
Display a Template
The following are steps required if the selected Action is to display a Controller template:
Controller - Template
1. If you choose to populate text, select the Populate Text option then click on the text
icon . The following screen is displayed:
2. Select if you wish to display a template or a cycle. The drop down will update based on which option is selected. Available Templates and Cycles are those that have been configured in Marquee Manager Administrator.
Configuration
Page 52 of 81
Adding an Event Group
Gateway for MQ Series allows you to organize your Events more efficiently by allowing the creation of Event Groups. This provides a logical way to group events for various machines, stations or other components of the lines.
New Event Group Steps:
1. Expand the Event folder and select an event that you wish to add an Event Group to, then right click and select New Event Group. You may also select the New button drop down on the toolbar and select Event Group. The following screen is displayed:
2. Enter a Name and Description of the Group. Event Groups appear as their own level in the tree view allowing you to easily locate an event.
Marquee Manager GWMQ SERIES V9
Page 53 of 81
In this example, Event Groups called LINE1, LINE2 and LINE3 have been created to
easily locate count information for each line in the Event Group called COUNT_EVENTS.
Configuration
Page 54 of 81
Configuring Key Components – Timed Items & Groups
Adding a Timed Item
Gateway for MQ Series allows the user to configure Items referred to as Timed Items which allow the user to enter in a schedule of configured items to be utilized based on time of day. This provides functionality that enables you to perform calculation using
historical values such as a constantly incrementing counter value at the beginning of a shift.
New Timed Item Steps:
1. Click on the Timed Items folder in the tree view and click the New icon in the toolbar. The following screen is displayed:
2. Enter in the Name of the Timed Item. This name should reflect the items being scheduled by this timed item. i.e. LINE1_STATES_MORNING to provide machine states for Line 1 in the morning shift.
3. On the Details tab, click on the New button to add timed elements to this item. The
following screen is displayed:
Configuration
Page 55 of 81
The Item: drop down includes all configured MQ Items and Virtual Items. Only like datatype items may be added. i.e. the first item selected is an MQ item with Type of UNSIGNED WORD. The next datatype item added to this Timed Item must also be an item of Type UNSIGNED WORD. The drop down will be filtered to list only the remaining items of Type UNSIGNED WORD.
Enter in the Start Time and End Time that this Timed Item member will be returned
and click OK to return to the Timed Item Details screen. You may continue to add additional elements to the Timed Item by clicking the New button.
4. Click the Save icon in the toolbar to save the Timed Item.
Timed Item members Start and End times may not overlap in any way.
Configuration
Page 56 of 81
Adding a Timed Item Group
Gateway for MQ Series allows you to organize your Timed Items more efficiently by allowing the creation of Timed Item Groups. This provides a logical way to group timed items.
New Timed Item Group Steps:
1. Expand the Timed Items folder and select the Timed Item that you wish to add a Timed Item Group to. Then right click and select New Timed Item Group. You may also select the New button drop down on the toolbar and select Timed Item Group. The following screen is displayed:
2. Enter a Name and Description of your Group. Timed Item Groups appear as their own level in the tree view allowing you to easily locate a Timed Item.
Configuration
Page 57 of 81
3. In this example, a Timed Item Group called WELD_STATES has been created to easily locate information for each welder.
Configuration
Page 58 of 81
Configuring Key Components – Virtual Items & Groups
Adding a Virtual Item
Gateway for MQ Series allows the user to configure Items referred to as Virtual Items which provide a calculated value of data from the item rather than the current item value.
New Virtual Item Steps:
1. Select the Virtual Items folder in the tree view and click the New icon in the toolbar. The following screen is displayed:
DETAILS TAB
Configuration
Virtual Item Enter the name of the Virtual Item. This should be a logical name to describe the value that is being calculated.
Type The Type field can be BIT, EVENT TEXT, FLOAT, SIGNED BYTE, SIGNED LONG, SIGNED WORD, STRING, UNSIGNED BYTE, UNSIGNED LONG or UNSIGNED WORD.
Formula Enter the Formula that the virtual item will calculate. This field may include regular text and configured MQ Items, Timed Items or Virtual Items. The Formula field label for an Event Text virtual item
changes to Default, allowing you to enter in a default message to be used as an optional default value for the item when no event has populated it. Any configured items such as MQ_ITEM, VIRTUAL_ITEM, TIMED_ITEM, FUNCTION, STRING, TYPECONV, MATH, or DTIME, may be added to the Formula field.
Note Add any additional notes. This field is optional.
2. To obtain a list of the configured Items, enter { which opens up a drop down list of
available Items. This first pop-up menu allows you to select which Item type you wish
Configuration
Page 59 of 81
to retrieve: MQ_ITEM, VIRTUAL_ITEM, TIMED_ITEM, FUNCTION rule, TYPECONV,
MATH, or DTIME variables. Selecting the Item Type will open another pop-up menu to select the trigger item. The final menu allows you to select the cumulative or current values of the selected item.
Various calculations may be performed here as in the example below.
3. Selecting an Item from the list will provide other values to include in the calculation such as Cumulative value, Current value, as well as current and cumulative values on all snapshots.
4. The calculation operations that can be used are outlined in the following table:
Function Operator(s) Example
Addition + 1+1
Associativity () (6+2)/2
Bitwise AND & 1&3
Bitwise Exclusive OR ^ 4^3
Bitwise Inclusive OR | 3|1
Division / 6/2
Modulo % 7%2
Multiplication * 6*3
One's Compliment ~ ~8
Shift Left << 8<<2
Shift Right >> 4>>5
Subtraction - 6-1
Marquee Manager GWMQ SERIES V9
Page 60 of 81
5. The Access Mode: field defaults to READ.Enter in an applicable note in the Note: field.
This field is optional.
6. Click the Save icon in the toolbar to save changes.
The above table of operators is in precedence order. All operators associate from left to right.
If the event in your devisor = 0, it will be forced to create a value of 1 and will be documented in your log file.
Marquee Manager GWMQ SERIES V9
Page 61 of 81
Adding a Virtual Item Group
Gateway for MQ Series allows you to organize your Virtual Items more efficiently by allowing the creation of Virtual Item Groups. This provides a logical way to group virtual items.
New Virtual Item Group Steps:
1. Click on the Virtual Items folder. Then right click and select New Virtual Item Group or select the New button drop down on the toolbar and select Virtual Item Group. The following screen is displayed:
2. Enter the Name and Description of your group. Virtual Item Groups appear as their own level in the tree view allowing you to easily locate a Virtual Item.
Marquee Manager GWMQ SERIES V9
Page 62 of 81
3. In this example, a Virtual Item Groups called STATION1, STATION2, and STATION3 have been created to easily locate information on each station.
4. Once the folder is created, you can drag and drop the applicable Virtual Items into the
folder you have just created.
Marquee Manager GWMQ SERIES V9
Page 63 of 81
Configuring Key Components – Function Rules
Adding a Function Rule for Display
Marquee Manager Gateway for MQ Series allows you to configure various function rules to define user text that will be displayed on your marquees. Any change in the bit values defined in the rule for configured MQ SERIES items will be sent to the selected marquee or play the selected tune.
FUNCTION is a reserved word similar to MQ_ITEM, etc.
New Function Rule to Display Steps:
1. Select the Tools folder from the tree view then expand the Functions folder. You may set a function to display a value to a marquee or to play a tune on a selected tune device.
2. Select the Display folder then click the New button in the toolbar to display the following screen:
3. Enter in the Name and Description of the Function in the respective fields.
4. The Function Type can be either Bit or Integer.
5. If Function Type is Bit, click the New button to add a new rule. The following screen is displayed:
Configuration
Page 64 of 81
6. Select the Foreground color, Background color, Mode and Font that the message will be displayed with on the marquee.
7. Enter in the User Text that will be displayed on the marquee when this bit value changes.
8. Select the bit positions that must be on/high in order for this rule to be implemented, sending the User Text to the marquee.
Function Rul{e Sample:
Marquee Manager GWMQ SERIES V9
Page 65 of 81
Be sure to place multi-bit rules at the top of the Function Details screen by using the order buttons to the left of the rule details. This is necessary as rules are processed from top to bottom.
The Bit Mask Value may be set to 0 so that if none of the bits change (i.e. the value of the bit is 0), a message may be displayed to notify that everything is running correctly.
9. If Function Type is Integer, click the New button to add a new rule. The following screen is displayed:
10. Select the Foreground color, Background color, Mode and Font that the message will be displayed with on the marquee.
11. Enter the User Text that will be displayed on the device when this bit value changes.
12. Enter an Integer Value that when found, will implement this rule.
The multi-bit rule order does not apply to a Function type of Integer as it is an exact match.
The Bit Mask Value may be set to 0 so that if none of the bits change (i.e. the value of the bit is 0), a message may be displayed to notify that everything is running correctly.
13. You may utilize this function rule in an event by including the function rule with the event details. The following format must be used in the Text field: {FUNCTION.functionname[{xx_ITEM.itemname.CURR}]}
Marquee Manager GWMQ SERIES V9
Page 66 of 81
In the example above, the Display Function called WELDERSTATE_HIGH will be used
with the Virtual Item called WELDERSTATES. Remember this Virtual Item was created so that a change to any of the welder states will be sent to the marquee via the SHOW_WELDER_STATE Event.
Marquee Manager GWMQ SERIES V9
Page 67 of 81
Sample Event Using Function
Configuration
Page 68 of 81
Adding a Function Rule to Play a Tune
New Function Rule to Play a Tune Steps:
1. To play a tune when a bit value changes, select the Tune folder then click the New button in the toolbar to display the following screen:
2. Enter in the Name and Description of the Function in the respective fields.
3. The Function Type can be either Bit or Integer.
4. If Function Type is Bit, click the New button to add a new rule. The following screen is displayed:
Configuration
Page 69 of 81
5. Select the Tune # that will be played when the bit value changes. You may elect to play the tune continuously or for a set duration of time.
6. Select the bit positions that must be on/high in order for this rule to be implemented, causing the selected tune # to play.
Function Rule Sample:
In this example, if bit 6, 5, or 2 changes, Tune #1 will be played on the selected tune device for that Event.
Be sure to place multi-bit rules at the top of the Function Details screen by using the order buttons to the left of the rule details. This is necessary as rules are processed from top to bottom.
The Bit Mask Value may be set to 0 so that if none of the bits change (i.e. the value of the bit is 0), a tune may be played to notify that everything is running correctly.
7. If Function Type is Integer, click the New button to add a new rule. The following screen is displayed:
Marquee Manager GWMQ SERIES V9
Page 70 of 81
8. Select the Foreground color, Background color, Mode and Font that the message will be displayed with on the marquee.
9. Enter the User Text that will be displayed on the device when this bit value changes.
10. Enter an Integer Value that when found, will implement this rule.
The multi-bit rule order does not apply to a Function type of Integer as it is an exact match.
The Bit Mask Value may be set to 0 so that if none of the bits change (i.e. the value of the bit is 0), a message may be displayed to notify that everything is running correctly.
11. You may utilize this function rule in an event by including the function rule with the event details.
Marquee Manager GWMQ SERIES V9
Page 71 of 81
Sample Function Rule to Play a Tune
12. On the Actions tab for the Event this Function Rule will be configured to, select Function option. The dropdown will give you the options of Functions you have set up under Tools. In this case, it is Sales Amounts.
Sample Event Action using Function Rule
Marquee Manager GWMQ SERIES V9
Page 72 of 81
13. In the Parameter field, type { to give you a list of options of Items
14. In the example above, the Tune Function called WELDERSTATE_LOW will be used with the Virtual Item called WELDERSTATES.
c h a p t e r f o u r - u s i n g g a t e w a y f o r o p c
Page 73 of 81
.4. Using Marquee Manager Gateway for MQ Series
The Marquee Manager Gateway for MQ Series user interface is conveniently displayed in a tree view that shows a Devices folder that enables the user to add information about the IBM MQ Series Message Queues that the gateway will communicate with.
It includes an Events folder, Timed Items folder and a Virtual Items folder that enable you to add various events that once triggered, will display information to a marquee that has been configured in Marquee Manager Administrator.
There are many features that make using Marquee Manager easier and more effective
that include:
o Modifying and Deleting Tree View Items
o Gateway Tools
o Viewing the Log Files
Marquee Manager GWMQ SERIES V9
Page 74 of 81
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. You can also change the state to disable.
Modifying
Select the item you wish to alter. The information regarding it will show up on the right hand side of the screen. At this point, you can change the name along with any other variables attached to it i.e. configuration settings etc. When you save your changes, they will appear in the tree view. 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 anything on the tree view side of your screen. By selecting the item 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.
Using the Gateway
Page 75 of 81
Marquee Tools - Options
Options
The Options menu allows users to set Marquee Manager Gateway for MQ Series details.
1. Click the Tools menu then select Options. The following screen is displayed:
2. The General tab displays the Data Source name as well as the Administrator
license key. This key determines the number of servers that can be configured.
3. Marquee Manager Gateway for MQ Series gives you the option to reload the server with any additions, edits or deletions automatically or when requested by the user. Select if you would like the server to automatically reload after every change or to perform the reload only when requested.
4. If you choose to reload with every change, the reload will take place when the
Save button is clicked. If you choose to reload only when requested, you will be informed that there are data changes the server needs to be notified about and have the option to either send the reload before closing or close the system without reloading the changes.
Marquee Manager GWMQ SERIES V9
Page 76 of 81
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 View Server and 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.
Glossary
Page 77 of 81
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 FirstPAGE Administrator.
This administrator allows you to maintain the FirstPAGE 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.
Client
A client component utilizes the facilities of a standard SeQent server. Typically a GUI application, this component provides a user-friendly interface of the available services
offered by the server engine. An example of a client tool would be FirstPAGE Client, which presents the user with a list of known messaging destinations and allows them to send messages to one or more destinations.
Cumulative Values
Calculated values from the MQ SERIES server that can be obtained as follows: Threshold – Start time + Rollover x Threshold. Cumulative values are available for Data Access Items and are referenced via the .CUMUL extension.
Current Values
Values that currently exist in the MQ SERIES Server. i.e. a item pulling TANKLEVEL.CURR values would display the current tank level value
MQ Item
Database Query item which refers to the current data available in the MQ SERIES Server
Device
A Marquee Manager Gateway for MQ Series device is a name assigned to a physical connection point on the server, which will be used to establish a connection with a
marquee.
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. Engines are administered via Administrator components and are utilized by clients, gateways or user written components.
Marquee Manager GWMQ SERIES V9
Page 78 of 81
Event
A condition that contains a rule that when true, will display text, items, timed items and virtual items to a specified marquee or play a tune to a specified speaker.
Event Text
A virtual item type that has been created to display a message based on a string of multiple events.
Gateway
A gateway component creates a bridge between a third party product and a standard SeQent server. Typically an engine, this component provides a conduit for forwarding events from the third party product into a SeQent 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 ActivPlant. This gateway forwards ActivPlant incidents to Marquee Manager.
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.
MQ SERIES Item An MQ SERIES tag that has been configured in the MQ SERIES Server.
MQ SERIES Server
A standard mechanism for communicating to numerous data sources, either devices on the factory floor, or a database in a control room.
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 FirstPAGE Server. This kit contains the FirstPAGE engine, administrator
and client.
Glossary
Page 79 of 81
Snapshot
A picture of the current item value for a given time. You can specify at what time and how often this picture will be taken.
Timed Item
A schedule of configured datatype elements that determine which items will be utilized based on time of day.
Virtual Item
A calculated value derived from a formula consisting of items, numeric integer constants and the operators ‘+’, ‘-‘, -*’ and ‘/’
a p p e n d i x a – i n s e r t i o n t a g s
Page 80 of 81
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
Recommended