Configure & Use the Communications Module

This Help File Page was issued on 09/30/2017

<< Click to Display Table of Contents >>

Navigation:  Communications Module > Overview of the Communications Module >

Configure & Use the Communications Module

This Help File Page was issued on 09/30/2017

MKS now uses the MKS Connect Service for the services previously supported by the Communications Module

 

It is recommended that you create a Windows® Desktop Shortcuts folder to meet the needs of the user(s) actually running each workstation.

Because you will probably be using just a few MKMS related applications on the machine that runs the Communications Module, creating a special folder on your Windows® Desktop with Shortcuts for just those Micro Key Millennium Series programs that this workstation will be running provides a much easier interface for the user.

The Communications Module may be the only program that will be running on the workstation if Windows® Services are not being used to distribute and execute the features of the Communications Module.

 

HelpFilesMKMSCSApplicationIcon-MKMSCM

User created MKMS Desktop folder with Application Shortcuts - MKMSCM Icon

 

Once all of the data entry steps have been completed, start the MKMSCM application which should be located in the same folder as your other MKMS applications.

 

You will see the MKMS Communications Module Form (illustrated below).

 

HelpFilesCommunicationModuleDialog

Communications Module Form

 

Communications Module File menu options:

 

HelpFilesCommunicationModuleFileMenu

Communications Module Form - File menu

 

Configure - Select Configure to setup the way you want the MKMSCM application to run on the current computer.  

MKMSCM Engine tab - This tab allows you to define which of the functions provided by the Communications Module will be performed at this Workstation.

 

Note: Whether or not you will be using Windows® Services to distribute the workload of the Communications Module across the Network:

1.You must configure the Communications Module services that will be performed by each Workstation.

2.You must run MKMSCM at least once on each PC Workstation that will perform Communications Module related services to configure those services.

 

HelpFilesCommunicationModuleConfiguration

Communications Module Form - File menu - MKMSCM Configuration - General Configuration

 

Connect on startup - Check this box to have the MKMSCM Engine start running automatically as soon as the application is started.  By doing so, the User will not have to open the File Menu and Choose the Run option whenever the application is started.

Note: The Connect at startup option does not apply if you are implementing this module as a Windows® Service.

 

Select devices to be used by this workstation - Check those boxes for the Communications Module processes that are to function on this Workstation.

 

E-mail Processor tab - Define the specifications for E-Mail processing (an example of Email Processor configuration is shown below):

 

elpFilesCommunicationModuleEMailProcessor

Email Configuration - E-mail Processor - E-mail Processor

 

Email Engine - Use the Drop-Down Selection List provided and Choose the appropriate E-Mail Engine to be used to transmit these Email messages.

 

HelpFilesCommunicationModuleEMailProcessorOptions

Email Configuration - E-mail Processor - Email Engine options list

 

Host Email - Enter the Host E-Mail Address to which theses messages will be transmitted.

oBased on the Email Engine selected above, enter the address of your Email Host.

oThis should match the Email Host address entered in the Company tab of the User Options Form.

Host Port - This will default to the appropriate Number (e.g., 25).

Username - In some cases a Username must be entered.  

oThis field will only become available when needed, otherwise it is inaccessible.

Password - In some cases a Password must be entered.  

oThis field will only become available when needed, otherwise it is inaccessible.

Alternate Company Name - Enter the "From" name to be used (the default is that name entered in the Company tab of the User Options Form).

oThis field is only accessible for certain Email Engines.

 

Pager Processor tab - Define, from the Available Ports on this machine, the Serial Port that will be used for Paging.

 

HelpFilesCommunicationModulePagerProcessor

Pager Configuration Form - Pager Processor tab - TAP sub-tab

 

TAP - Select the TAP tab to define the required parameters for your TAPI connection.

Available Ports - Use the Drop-Down Selection List provided to Choose the Port to be used by the Pager Processor.

oBaud - Data - Stop - Parity - Enter these values as required.

Available Devices - Use the Drop-Down Selection List provided to Choose the Modem to be used by the Pager Processor.

 

HelpFilesCommunicationModulePagerProcessor-Digital

Pager Configuration Form - Pager Processor tab - Digital sub-tab

 

Digital - Select the Digital tab to define the required parameters for your Digital Paging.

oPre Dial - Start - End - Dash - Enter these values as required.

oWait Before Dial (sec) - Enter the number of seconds to wait prior to dialing.

 

SNPP Engine - Select the SNPP Engine tab and Choose the appropriate engine.

 

HelpFilesCommunicationModulePagerProcessor-SNPPInternet

Pager Configuration Form - Pager Processor tab - SNPP (Internet) sub-tab

 

SNPP Engine - Use the Drop-Down Selection List provided to Choose the SNPP Engine to be used by the Pager Processor.

 

Printer Processor tab - Select from the available Printers, the one that will be used for Printing Scheduled Reports.

 

HelpFilesCommunicationModulePagerProcessor-PrinterProcessor

Printer Configuration Form - Printer Processor sub-tab

 

 

Select the Print Processor - Use the Drop-Down Selection List provided to Choose the Printer to be used by the Printer Processor.

 

Note: Fax Processing Implementation - In lieu of Printing a document, you may select a Fax device as your "Printer Processor".

 

History - Select History to see a listing of all completed Communication Events displayed, as they occur, in the Event Messages dialog.

 

HelpFilesCommunicationModuleDialog

Communications Module - Events message listing

 

Update Log - Select Update Log to post the most recent Event Messages to the Communications Module's Log File.

 

HelpFilesCommunicationModuleLog

Communications Module Log File sample

 

Event Stack - Select this option to view the Event Stack which lists the Communication Events

Display - Use the Drop-Down Selection List to Choose the type of communication events that you want displayed.

 

HelpFilesCommunicationModuleEventTypes

 Event Stack - Select the Events to be displayed

 

Event Stack Maintenance - Provides a method to clear (purge) the Event Stack.

 

Run - Select Run to start the Communications Module Engine (to start actually processing events in the Event Stack on this machine).

 

Stop - Select Stop to halt the Communications Module Engine (from actually processing communication events in the Event Stack on this machine).

 

HelpFilesCommunicationModule-MustShutDownBeforeExiting

 

Exit - Select Exit to Close the Communications Module application.  

 

Windows® Services - The Communications Module may be run as a stand-alone program, or as a Windows® Service.

Why use Windows® Services? The advantage of assigning one or more of the Communications Module processes to a Windows® Service are:

The process runs in the background using less system resources.

Specific Communications Module functions may be assigned to various Workstations on the Network.

More than one Workstation may perform the same process to speed up delivery (the "next" task does not have to wait as long to be executed).

All Workstations access the central MKMS database for their instructions.

No separate Login is required.

If a Workstation must be restarted, the Service may be set to re-start automatically.

See Implementing Communications Module functions as a Service for detailed information on how to use this capability.

 

Communications Module Help menu option:

Contents - Click this option to display the Help Files, when implemented.

 

HelpFilesCommunicationsModule-NoHelpNow

 

About - Click this option to display the About box.

 

HelpFilesCommunicationsModule-About

 

03/20/2022