Communication Service Settings
- Last UpdatedJun 06, 2024
- 5 minute read
AVEVA Work Tasks Communication Service makes use of communication service settings for the following activities:
-
Wait for E-mail: The workflow processes can be designed to be initiated or processed on receipt of email matching specified parameters. The Communication service monitors the specified port and IP for incoming emails that could be used in the Workflows.
-
Wait for SMS: The communication service can be setup to monitor incoming SMS.
-
Sending SMS: The workflows can send SMS through a Global System for Mobile communication (GSM) device. The Communication Service uses settings and configuration specified in this screen for sending SMS.
The various communication settings are:
-
Communication Server
-
Mail Server (The Mail Server setting feature is moved to Central Configuration. For more information, see Mail Server Setting.)
-
SMS Receiver
-
SMS Config
-
SMS Config Custom
-
SMS Send Action
Communication Server
The Communication Server settings provides the IP address and the port to be monitored by AVEVA Work Tasks's Communication Engine for incoming e-mails.
The following table provides description of the fields with their default values:
Communication Service Server
|
Field Name |
Default Value |
Description |
|---|---|---|
|
Listener IP Address |
- |
This field is used to enter the IP address to be monitored for incoming emails. This field defaults to the name of the logged in machine. |
|
Port |
8770 |
This field is used to enter the port number for the Listener IP Address. |
|
Wait Task Handler Path |
- |
This field is used to provide the assembly navigation path for handling timeouts and e-mail received. |
|
Wait Task Handler Class |
- |
This field is used to enter the Class name for handling timeout tasks and incoming emails. |
|
Block Mail Addresses |
- |
This field is used to enter e-mail addresses that should be blocked from processing. |
Enterprise Server Settings
|
Field Name |
Default Value |
Description |
|---|---|---|
|
Load Balanced |
False |
This field is used to set load balancing for AVEVA Work Tasks. This field is enabled only for the Load Balanced Server installation. To enable load balancing set the Load Balanced value to true. |
|
Load Balanced Server Port |
8853 |
This field denotes the port number used by Advance Server. This value must be modified if the default port value is in use. |
|
Load Balanced Client Port |
8864 |
This field is used to enter the port number for the Client. |
Mail Server
For configuring Mail Server, see Mail Server Setting.
SMS Receiver
The WaitForSMS Action works with the help of the Communication Engine Service. The Communication Engine checks the Phone device periodically for SMS.
|
Field Name |
Default Value |
Description |
|---|---|---|
|
Enable SMS Receiver |
False |
This field enables the Communication Engine to check for SMS. |
|
SMS Time Interval |
0.00:01:00 |
This field is used to specify the time interval at which the AVEVA Work Tasks Engine must check for SMS in the phone device. Example: 0.00:01:30 = 1 minute 30 secs |
|
Wait Task Handler Path |
- |
This field is used to provide the Assembly path for handling timeout actions and warnings. |
|
Wait Task Handler Class |
- |
This field is used to provide the class name for handling timeout actions and warnings. |
|
Provider Configuration |
- |
This field is used to enter the details specific to your service provider. AVEVA Work Tasks currently supports only GSM protocols for receiving SMS.
|
SMS Config
The SMS Send Action settings are used by the Notification Service to send SMS.
ProviderConfig: This is for Connection Type specific configuration settings. If you are using a provider other than the default provider specified here, you will have to add the details here. Currently five Connection
Types are supported:
-
SMSPatternMatch
-
GSM
-
SMSProvider
-
Hayes
-
EmailProvider.
Under each Connection Type, apart from their configuration details, two compulsory nodes, SMSMessengerAssembly and SMSMessengerClass, ave to be specified.
This is the class which sends SMS for each provider. This class should implement ISMSSender interface.
The following are some examples for setting ProviderConfig:
<GSM>
<SMSMessengerAssembly>C:\ Workflow.NET.SMS.Messenger.dll</SMSMessengerAssembly> <SMSMessengerClass>Workflow.NET.SMS.Messenger.SMSSender</SMSMessengerClass>
<Device> Nokia 6310i Modem </Device>
</GSM>
Note: As an alternative, "Nokia 6310i Modem" can be replaced by "COM 1", provided the Nokia phone is connected on COM1.
<SMSProvider>
<SMSMessengerAssembly>C:\ Workflow.NET.SMS.Messenger.dll</SMSMessengerAssembly> <SMSMessengerClass>Workflow.NET.SMS.Messenger.SMSSender</SMSMessengerClass>
<Device> Standard 19200 bps Modem </Device>
<DeviceSpeed> 1200 </DeviceSpeed>
<DeviceSettings> "8, n, 1" </DeviceSettings>
<ProviderDialString> "02012345678" </ProviderDialString>
<ProviderType>1</ProviderType>
</SMSProvider>
Here are some details about values in the above example:
-
DeviceSettings - 8 databits, no parity, 1 stopbit
-
Provider type - Standard TAP provider
-
You can specify 0 for UCP Provider, 2?for TAP provider, no request for LineFeed, and 3 for TAP provider, no request for EOT
<Hayes>
<SMSMessengerAssembly>C:\Workflow.NET.SMS.Messenger.dll</SMSMessengerAssembly> <SMSMessengerClass>Workflow.NET.SMS.Messenger.SMSSender</SMSMessengerClass>
<Device> Standard 19200 bps Modem </Device>
</Hayes>
|
Field Name |
Description |
|---|---|
|
Connection Sequences |
The Connection Sequences is used to provide the sequence in which AVEVA Work Tasks Engine must choose the connection type for sending SMS. Connection Type: This column is used to list the various connection types such as GSM, SMSPatternMatch, EmailProvider, SMSServiceProvider, and Hayes. Sequence Number: This column is used to list the sequence of each connection type. |
|
|
This field is mapped to the connection sequence table for sending SMS. The fields are mapped in the user provider for sending SMS. The three fields - Email, Mobile Phone Provider, and SMS Number are required to be mapped to the table. Some providers allow SMS to be sent through email. Enter your email address in the email field to send SMS to these providers. |
|
Mobile Phone Provider |
This field is mapped to the table for sending SMS. Enter the name of the Mobile Phone Provider in this field. Example:Hutch |
|
SMS Number |
This field is mapped to the table for sending SMS. Enter the phone number to which the SMS has to be sent. |
The above settings can be directly used for AVEVA Work Tasks list provider to send SMS. No manual settings are required. However, if different providers are used, the appropriate values need to be set.
SMS Config Custom
To use a connection type other than the default supported, provide SMS Pattern Match information for SMS Messenger Assembly and Class.
|
Group Name |
Field Name |
Description |
|---|---|---|
|
SMS Pattern Match |
SMS Messenger Assembly |
This field is used to define an assembly which handles sending and receiving SMS. |
|
SMS Messenger Class |
This field is used to enter the class name which handles sending and receiving SMS. |
|
|
SMS Patterns |
- |
|
SMS Send Action
SMS Config Custom Settings enable use of a custom SMS provider.
|
Field Name |
Description |
|---|---|
|
Custom SMS Provider |
|
|
SMS Messenger Assembly |
This field is used to define an assembly which handles sending and receiving SMS. |
|
SMS Messenger Class |
This field is used to define a Class which handles sending and receiving SMS. |
|
Email Server |
Name of the e-mail server. |
|
Email Pattern |
|