CIM_HT021 Alarm Cast Configuration using SMTP (E

CIM_HT021 Alarm Cast Configuration using SMTP (E
CIM_HT021
Alarm Cast Configuration using SMTP (E-Mail)
Proficy CIMPLICITY HMI/SCADA
Overview
The purpose of this document is to explain the proper configuration of CIMPLICITY when using Alarm
Cast to send emails via a Simple Mail Transfer Protocol (SMTP) Server
For configuration using FirstPage with earlier versions of Proficy CIMPLICITY HMI/SCADA 7.5/8.0/8.1,
please use the appropriate FirstPage documentation.
Requirements
•
•
•
CIMPLICITY 8.2 (or newer)
Alarm Cast v9.06.05 (or newer)
Alarm Cast License
Note:
The latest version of the Alarm Cast software is available on the GE Intelligent Platforms
Support site as a download. Please contact your local distributor for a license.
1
Configuration: Adding Alarm Cast to the Project
1.
Download and install the latest version of the Alarm Cast software. This can be found on the
GE Intelligent Platforms website. When Alarm Cast is installed it should be installed as an
“Alarm Cast Server” installation. Each new/upgraded installation will require a reboot.
2.
Open a CIMPLICITY Project in the CIMPLICITY Workbench for Alarm Cast to be used with.
3.
In the CIMPLICITY Workbench, go to the Project->Properties->General tab and add “Alarm Cast
Gateway” under the “Options” list.
Fig 1 – Adding Alarm Cast Option
2
Configuration: Updating Databases
Fig 2 – Database Conversion Tool
Alarm Cast maintains its configuration settings in a series of Microsoft Access Databases that reside in
the Alarm Cast Install DATA folder. Each new install or update will require the existing or installed
databases to be upgraded to the new build. If this step is not performed, database connectivity from
the application may not occur resulting in application connectivity issues.
Follow the following steps to upgrade the database:
1.
Open the Database Conversion Application. This can be found in the windows start menu
under Programs > CIMPLICITY > Alarm Cast DB Conversion or by executing Convert.exe from
C:\Program Files (X86)\Proficy\Proficy CIMPLICITY\Alarmcast\EXE\
2.
A dialog will occur several times; each with a different title. Click Next, then start for each
database it finds that requires an update. Click close to continue. Click Next then close for
each database not requiring an update. No additional dialogs will occur once all databases
have been updated.
3
Fig 3 – Database requires update
a.
b.
c.
d.
e.
First Page Administrator Database Conversion
First Page Alarm Administrator Database Conversion
First Page Alarm Manager Gateway for CIMPLICITY Server Database Conversion
First Page Alarm Manager Server Database Conversion
First Page Server Database Conversion
4
Configuration: Configuring the Alarm Cast Server
1.
Open the Alarm Cast Administrator. This is found on the left hand pane under “Computer>Alarm Cast Administrator” in the CIMPLICITY Workbench.
2.
If an Alarm Cast server has never been configured on this system then a new Server must be
created. To do this click on the “New Server” button.
Fig 4 – New Alarm Cast Server
3.
A dialog will appear asking for a DSN to be selected. From the list of the pre-configured DSN’s
please choose “FPSERVER” as shown in Fig 4. This is the database to which the Alarm Cast
Server configuration will be saved.
4.
Once the Database is initialized a set of tabs will appear called “Details”, “Settings”, “Security”,
and “Administration”. Each of these tabs must be configured to continue.
5.
For the “Details” tab specify the following information (See Fig 5):
Host Name: LOCALHOST or COMPUTER NAME
Description: Alarm Cast Test Server
Path: C:\Program Files (x86)\Proficy\Proficy CIMPLICITY\ALARMCAST\LOGS
Note:
The “Path” must be filled in and cannot be left blank. The recommendation is to point to the
Alarm Cast installation LOGS sub-directory (as specified above). This path also must reside on
the local system.
5
Fig 5 – Details Tab of Alarm Cast Server Configuration
6
6.
Navigate to the “Settings” tab and fill in the following (See Fig 6):
Path: C:\Program Files (x86)\Proficy\Proficy CIMPLICITY\ALARMCAST\LOGS
Note:
The “Path” must be filled in and cannot be left blank. The recommendation is to point to the
Alarm Cast installation LOGS sub-directory (as specified above)
Fig 6 – Settings Tab of Alarm Cast Server Configuration
7
7.
Navigate to the “Security” tab and fill in the following (See Fig 7):
Mode: NONE
Fig 7 – Security Tab of Alarm Cast Server Configuration
8.
Everything on the “Administration” tab can be left at the default setting (See Fig 8).
Fig 8 – Administration Tab of Alarm Cast Server Configuration
9.
When done making the configuration changes, click on the “Save” button or go to File->Save.
8
10. At this point you may notice the service icon will indicate offline. The service at this point is
reinitializing. If you notice the Service icon maintains a red x, go to Windows Services and
restart the First Page Server Service.
Fig 9 – Windows Services showing the FirstPage Server Service
Configuration: Configuring the SMTP Device and Provider
1.
Using the Alarm Cast Administrator, on the left hand pane navigate to the Alarm Cast Server
listed under the Alarm Cast Servers->Alarm Cast Test Server (note that the name is the same
as was specified previously).
2.
Select the “Devices” folder
3.
Along the top toolbar click on “New Device” button. A “Details” tab will appear. This tab must
be configured to continue.
Fig 10 – New Device Selection in Alarm Cast Server Administrator
9
4.
Fill in the following information (See Fig 11):
Name: EMAIL
Type: TCP/IP
Fig 11 – Device Details in Alarm Cast Server
5. When done, click on the “Save” button, or go to “File->Save”.
6.
When the save is complete the device should be available under the “Alarm Cast Servers>Alarm Cast Test Server->Devices” list as “EMAIL”. Select it from this list.
7.
Now select the “Providers” folder.
10
8.
Along the top Menu choose the “New Provider” button. Four new tabs will appear named
“Details”, “Connection”, “Settings”, and “Notification”, and “Status”.
Fig 12 – New Provider in Alarm Cast Server Administrator
11
9.
Navigate to the “Details” tab and fill in the information (See Fig 13):
Name: TESTEMAIL
This field should be defined and must be unique. This is the name of the provider.
Coverage: THEWORLD
This field must be defined and must be unique. This is the name of the coverage area.
Device: EMAIL
Select the name of the device that you specified in Step 4.
Protocol: SMTP
This is the protocol to be used by the provider.
Note:
The Max Connections, Alpha Length, Max Transactions and Numeric Length should be left at
the default values.
Fig 13 – Provider ‘Details’ in Alarm Cast Server Administrator
12
10. Navigate to the “Connection” tab and fill in the information (See Fig 14):
Host [:Port]: MYEMAILPROVIDER.DOMAIN.COM
This is the full qualified path to the mail server:
Example: smtp.mailserver.com
Note: Most SMTP mail servers use TCP/IP port 25, and the Alarm Cast software will default to
this port. If the mail server is using an alternate port this must be suffixed onto the end.
Example: smtp.mailserver.com:26
User Name: johndoe
This is the username which will be used to authenticate to the SMTP mail server. For most
SMTP servers this is the username or the account which is to be sending the emails from.
Password: password
This is the password for the user specified in User Name”
From Address: JOHNDOE@DOMAIN.COM
This is the email address that will be used to send the emails from. Use the email address for
the username/password specified previously.
Note:
If sending emails to an SMS gateway some providers do not use the ‘From’ information. They
will use an internal phone number as to where the email came from. For example, TELUS
Mobility in Canada uses (999) 999 – 9999 as the “From” address.
Hello Domain: domain.com
This defines the domain where the email server resides. For this use the same definition of
host:port unless your I.T. department specifies otherwise.
Subject: TEST {MSG.NETID}
Specify the subject line for the emails that should be sent. In this example, “TEST
{MSG.NETID}”was used.
13
Fig 14 – Provider Connection Tab in Alarm Cast Server Administrator
11. For the “Settings”, “Notification”, and “Status” tabs, they can be left with their default values.
12. When complete, click on the “Save” button, or do a “File->Save”.
14
13. The next step is to create a new destination. When the Save has been completed the
Destinations folder will appear under “Alarm Cast Servers->Alarm Cast Test Server->Devices>EMAIL->Providers->TESTEMAIL : THEWORLD”.
Fig 15 – New Destination in Alarm Cast Server Administrator
14. Select the “Destinations” folder and click on the “New Destination” button along the top. Five
new tabs will appear: “Details”, “Aliases”, “Distribution Lists”, “Groups” “Schedules”.
15. Select the “Details” tab and fill in the following information (See Fig 16):
Name: JOHNDOEEMAIL
This is the name of the destination that will be visible in other areas of configuration.
Title: John Doe
This is the title of the user who the destination is going to, or anything meaningful.
Email: JOHNDOE@EMAIL.COM
This is the destination users email address to which the notification will be sent.
Type: Email
Provider: TESTEMAIL
Select the same provider that was configured previously.
Coverage: THEWORLD
Select the same coverage area that was configured previously.
Network ID: JOHNDOE@EMAIL.COM
This is the same as the email field and is the actual destination email address.
15
Fig 16 – Example Destination in Alarm Cast Server Administration
16. When complete click on the “Save” button, or do a “File->Save”.
17. The Alarm Cast Server must now load the new configuration. To do this select “Tools->Reload
Server”.
Configuration: Testing the Device/Provider/Destination
1.
2.
3.
Select the configured destination in the Alarm Cast Administrator.
Right click on the destination and choose “Send Test Message”
The software will show a dialog saying “Your test page was successfully sent.”. At this juncture
it is important to now check the email inbox of the destination to see whether or not the test
message was received.
Configuration: Configuring the Alarm Cast Gateway
1.
2.
3.
4.
5.
In the CIMPLICITY Workbench, perform a Configuration Update, and then start the project
After the project is started go to “Runtime->Process Control” and open it.
When the Process Control utility opens, click on the “Connect” button. If the software is set
properly, an “FPAMGATEWAY” process should be visible and running. In some cases, the
process may appear to not be running or additional processes may be seen as not started
such as FPAGE. If the process refuses to start or you notice this other process name, please
complete Appendix A: Gateway Process Fails to Start. Configuration can still take place if
the Gateway fails to start in process control.
In the CIMPLICITY Workbench navigate to “Project->Equipment->Alarm Cast Gateway>Administrator”
When the Alarm Cast Gateway Administrator opens there will be four tabs available: “Details”,
“Settings”, “Security”, “CIMPLICITY”. When the gateway configuration is open for the first time
it doesn’t make a connection with its database. This only occurs once a save has occurred for
the gateway. Any subsequent open after a save and if the project has not been started will
result in a failed to connect error which is normal.
16
6.
Navigate to the “Settings” tab and fill in the following (see Fig 17):
Server Port: 8070 (Default)
Host Name: CIM82ACAST
Server Port: 8001
Source Host: MYSERVER (This is a unique identifier name (case sensitive) that is used so Alarm
Cast can identify the collection of alarms for your CIMPLICITY Project. This identifier must be
kept the same in the Alarm manager and the CIMPLICITY Gateway. DO NOT confuse this value
with the computer name.)
Path: C:\Program Files (x86)\Proficy\Proficy CIMPLICITY\ALARMCAST\LOGS\PROJECTNAME
NOTE: The PROJECTNAME will be the name of the CIMPLICITY project that you are configuring.
Fig 17 – Settings Tab of CIMPLICITY Alarm Cast Gateway
7.
Navigate to the “Security” tab and fill in the following (See Fig. 16):
Mode: NONE
17
Fig 18 – Security Tab of CIMPLICITY Alarm Cast Gateway
8.
Navigate to the “CIMPLICITY” tab and fill in the following (See Fig. 19):
User Name: ADMINISTRATOR
Password: <enter password for user>
The user name and password fields are the CIMPLICITY Project user name and password for
the Alarm Cast Software to be able to log into the project to retrieve the alarms.
Fig 19 – CIMPLICITY Tab of CIMPLICITY Alarm Cast Gateway
18
9.
When done click on the “Save” button or go to File->Save in the menu.
10. Stop the CIMPLICITY Project and do a Configuration update
11. Restart the CIMPLICITY Project.
19
Configuration: Configuring the Alarm Cast Alarm Administrator
1.
In the CIMPLICITY Workbench, navigate to “Computer->Alarm Cast Alarm Administrator” and
start it.
2.
From the menu click on the “New Server” button.
Fig 20 – New Alarm Cast Alarm Server
3.
A dialog will appear prompting to choose a DSN. Choose the “FPAMSERVER” ODBC Data
Source from the list and click the “OK” button as shown in Fig 20.
4.
Five tabs will appear in the configuration dialog as follows: “Details”, “Settings”, “Alarm Cast
Servers”, “Agent Licenses”, and “Security”.
5.
Navigate to the “Details” tab and fill in the following (See Fig. 21):
Description: Enter the description (this is mandatory) Test CIM Alarms
Path: C:\Program Files (x86)\Proficy\Proficy CIMPLICITY\ALARMCAST\LOGS
NOTE: The “Path” must be filled in and cannot be left blank. The recommendation is to point to
the Alarm Cast installation LOGS sub-directory (as specified above).
20
Fig 21 – Details Tab of Alarm Cast Alarm Administrator
6.
Navigate to the “Settings” tab and fill in the following (See Fig. 22):
Server Port: 8001
Path: C:\Program Files (x86)\Proficy\Proficy CIMPLICITY\ALARMCAST\LOGS
NOTE: The “Path” must be filled in and cannot be left blank. The recommendation is to point to
the Alarm Cast installation LOGS sub-directory (as specified above).
Fig 22 – Settings Tab of Alarm Cast Alarm Administrator
7.
Navigate to the “Alarm Cast Servers” tab and fill in the following (See Fig. 21):
21
Port: 8003
Fig 23 – Alarm Cast Servers Tab in Alarm Cast Alarm Administrator
8.
Navigate to the “Security” tab and fill in the following (See Fig. 24):
Mode: NONE
Fig 24 – Security Tab in Alarm Cast Alarm Administrator
9.
Click on the “Save” button or do a “File->Save”.
10. Once the save is complete the “Test CIM Alarms (LOCALHOST)” will appear in the list of Alarm
Cast Servers on the left hand pane.
22
Fig 25 – New Escalation Scheme in Alarm Cast Alarm Administrator
11. Select the “Test CIM Alarms (LOCALHOST)->Escalation Schemes” folder.
12. Click on the “New Escalation Scheme” button along the toolbar. A “Details” tab will appear.
13. Configure the “Details” Tab as follows:
Name: HIGH
This is the name of the escalation scheme
Description: Test Escalation Scheme
This can be anything that is descriptive of the particular escalation scheme.
14. Click on the “Save” button or do a “File->Save”.
23
15. Under the Escalation Schemes folder the Escalation Scheme “HIGH” will now be visible. Select
the “Items” folder beneath it.
Fig 26 – New Escalation Item in Alarm Cast Alarm Administrator
16. Click on the “New Escalation Item” button on the toolbar. Two new tabs will appear: “Details”,
and “Destinations”.
17. Navigate to the “Details” tab and fill in the following (See Fig. 27):
Name: ITEM1
This is the name of the Escalation scheme item.
Fig 27 – Details Tab of Escalation item in Alarm Cast Alarm Administrator
24
18. Navigate to the “Destinations” tab and select the “JOHNDOEEMAIL” destination or the
destination you had created. (See Fig. 28)
Fig 28 – Destinations Tab of Escalation Item in Alarm Cast Alarm Administrator
19. When complete click on the “Save” button, or do a “File->Save”.
20. In the Alarm Cast Alarm Administrator navigate to the “Agents” folder underneath the “Test
CIM Alarms (LOCALHOST)” entry.
21. Click on the “New Agent” button along the top toolbar. Four tabs will appear as follows:
“Details”, “Connections”, “Event Throttling”, “Wildcard Exceptions”, and “Alarm Defaults”.
Fig 29 – New Agent in Alarm Cast Alarm Administrator
25
22. Navigate to the “Details” Tab and fill in the following (See Fig. 30):
Display Name: My Agent
Source Host: MYSERVER (This is a unique identifier name (case sensitive) that is used so Alarm
Cast can identify the collection of alarms for your CIMPLIICITY Project. This identifier must be
kept the same in the Alarm manager and the CIMPLICITY Gateway. DO NOT confuse this value
with the computer name.)
Project Name: ACAST (or whatever the name is of your CIMPLICITY Project)
Fig 30 – Details Tab of ‘Agent’ in Alarm Cast Alarm Administrator
23. Navigate to the “Connections” tab and fill in the following (see fig 29):
Host Name: CIM82ACAST
Port: 8070
26
Fig 31 – Connection Tab of ‘Agent’ in Alarm Cast Alarm Administrator
24. Navigate to the “Event Throttling” tab and leave it at the default settings.
Fig 31 – Event Throttling Defaults of ‘Agent’ in Alarm Cast Alarm Administrator
25. Navigate to the “Wildcard Exceptions” tab and leave it at the default settings.
27
Fig 32 – Wild Card Exception Defaults of ‘Agent’ in Alarm Cast Alarm Administrator
28
26. Navigate to the “Alarm Defaults” tab and leave it at the defaults.
Fig 33 – Alarm Defaults in ‘Agent’ of Alarm Cast Alarm Administrator
27. When complete click on the “Save” button or go to “File->Save”.
28. After the save is complete, the “My Agent” should be visible under the “Agents” folder.
29. Beneath the “My Agent” agent, select the “Message Template” folder.
30. On the toolbar select the “New Message Template” button. When complete a “Details” tab
should appear.
Fig 34 – New Message Template in Alarm Cast Alarm Administrator
29
31. Fill in the “Details” tab as follow (see fig 35):
Name: MessageTemplate1
Message: This is the alarms message: {USERTEXT.MESSAGE.CURR}
Fig 35 – Message Template in ‘Agent’ of Alarm Cast Alarm Administrator
32. When complete click on the “Save” button or do a “File->Save”.
33. Navigate to the “Alarm Cast Agent” and select the “Alarms” sub-folder.
34. On the toolbar select “New Alarm”. Four tabs will appear as follows: “Details”, “Message”,
“Wildcard Exceptions”, “Destination Exceptions”.
Fig 36 – New Alarms Selection in ‘Agent’ of Alarm Cast Alarm Administrator
30
35. Navigate to the “Details” tab and fill it in as follows (see Fig 37):
Resource: *
Alarm: *
Class: *
Message: *
Escalation Scheme: HIGH
The escalation scheme will be a list of the already configured escalation schemes.
NOTE: The fields Resource, Alarm, Class and Message are case sensitive. If an Alarm Message
was defined as “This Is an Alarm” but CIMPLICITY’s alarm message was “this is an alarm”,
Alarm Cast Alarm Administrator would not process this alarm if it was generated.
Fig 37 – Alarm item Configuration (* wildcard) – Alarm Cast Alarm Administrator
31
36. Navigate to the “Message” field and fill it in as follows (see fig 38):
Message Template: MessageTemplate1
The message template list will be a selection from one of the templates configured previously.
Fig 38– Message Tab showing Message Template Selection in Alarm Cast Alarm Administrator
32
37. Navigate to the “Destination Exceptions” tab and leave it at the default (no Destinations are
selected as in Fig 39)
Fig 39 – Destination Exception Tab in Alarm Cast Alarm Administrator
38. When complete click on the “Save” button or do a “File->Save”
39. Stop the CIMPLICITY Project, and do a configuration update.
40. Restart the First Page Alarm Server and First Page Server in windows services. Then start the
project.
41. At this point the configuration should be complete and alarms should be tested in the project
to confirm if they page out.
33
Appendix A – Gateway Process Fails to Start
In some cases, the Alarm Cast Gateway Application fails to startup when a CIMPLICITY project is run.
The FPGATEWAY process will appear ‘Failed’ in process control. This is because a project was not
upgraded properly and as a result, specific process names are left behind in the backend
configuration. This issue normally occurs with systems that either:
1.
Upgraded from First Page to AlarmCast, and did not remove the older First Page component
before the upgrade.
2.
Upgraded Alarm Cast from an older version of Alarm Cast to a newer version (<9.5.0) and did
not remove the Alarm Cast Gateway option from the project before the upgrade.
The following information will explain how to correct the issue for the above scenarios.
Upgrade from First Page to Alarm Cast
In some cases, a project may have been upgraded to a newer version but still has the First Page option
remaining in the project. As a result, FPAGE appears to fail in Process Control, with a missing option
error. This will not cause any problems but can be an annoyance.
To correct the issue, please see the white paper “Manual Removal of First Page Server After an
Upgrade to a Newer Version of CIMPLICITY”. Please note that the procedure is intended for advanced
users and GE Intelligent Platforms strongly recommends using an older project and removing the
option properly in Project Options.
Upgrade from Alarm Cast <9.5.0 to a newer revision > 9.5.0
Normally most upgrades are seem-less and don’t require re-configuration however, this issue is
caused due to a process name that existed in older versions that exceeded the 13 character limit. Our
vendor has corrected the issue, but older Alarm Cast installers still have this issue.
1.
Remove the Alarm Cast Gateway option from the project. Perform a configuration update
and close any open CIMPLICITY applications.
2.
Uninstall Alarm Cast from the CIMPLICITY Server.
3.
Download and install the latest version of the Alarm Cast software. This can be found on
the GE Intelligent Platforms website. When Alarm Cast is installed it should be installed as
an “Alarm Cast Server” installation.
4.
Reboot the system.
5.
Install Alarm Cast that was downloaded from step 3
6.
Open the CIMPLICITY project and re-add the Alarm Cast Gateway to the project.
7.
Perform a configuration update
8.
This will make sure the proper process naming convention used in CIMPLICITY is set.
34
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertising