Vyom Admin User Guide
Vyom Admin User Guide
User Manual
SECURI TY SOL UTI ON S
COSEC
Admin Management Portal
System Manual
Documentation Disclaimer
Matrix Comsec reserves the right to make changes in the design or components of the product as engineering and
manufacturing may warrant. Specifications are subject to change without notice.
This is a general documentation for all variants of the product. The product may not support all the features and
facilities described in the documentation.
Information in this documentation may change from time to time. Matrix Comsec reserves the right to revise
information in this publication for any reason without prior notice. Matrix Comsec makes no warranties with respect
to this documentation and disclaims any implied warranties. While every precaution has been taken in the
preparation of this system manual, Matrix Comsec assumes no responsibility for errors or omissions. Neither is any
liability assumed for damages resulting from the use of the information contained herein.
Neither Matrix Comsec nor its affiliates shall be liable to the buyer of this product or third parties for damages,
losses, costs or expenses incurred by the buyer or third parties as a result of: accident, misuse or abuse of this
product or unauthorized modifications, repairs or alterations to this product or failure to strictly comply with Matrix
Comsec operating and maintenance instructions.
Warranty
For product registration and warranty related details visit us at:
http://www.matrixcomsec.com/product-registration-form.html
Copyright
All rights reserved. No part of this system manual may be copied or reproduced in any form or by any means
without the prior written consent of Matrix Comsec.
Version 13
Release date: December 26, 2017
Contents
Introduction..................................................................................................................................................... 1
Software Installation....................................................................................................................................... 4
Getting Started with Portal ................................................................................................................................ 13
Company Configuration............................................................................................................................... 16
Profile ................................................................................................................................................................ 17
License and Services ........................................................................................................................................ 20
Monitor Configuration ........................................................................................................................................ 22
Table of Contents v
CHAPTER 1 Introduction
Welcome
Thank you for choosing the Matrix COSEC Time Attendance and Access Control System! We are sure you will be
able to make optimum use of this feature rich, Integrated Access Control and Time and Attendance system. Please
read this document carefully to get acquainted with the product before installing and operating it.
• Know Your COSEC Admin Portal - describes the roles and functioning of Admin Portal for managing
companies (clients) in COSEC.
• Software Installation - gives step-by-step instructions for installation and configuration of Admin portal.
• Getting Started - provides information about configuration of Database server and COSEC Services.
This System Manual is presented in a manner that will help you find the information you need easily and quickly.
You may use the table of contents and the Index to navigate through this document to the relevant topic or
information you want to look up.
• Instructions
The instructions in this document are written in a step-by-step format, as follows. Each step, its outcome
and indication/notification, wherever applicable, have been described.
• Notices
The following symbols have been used for notices to draw your attention to important items.
Caution: to indicate an action or condition that is likely to result in malfunction or damage to the
system or your property.
Warning: to indicate a hazard or an action that will cause damage to the system and or cause
bodily harm to the user.
Tip: to indicate a helpful hint giving you an alternative way to operate the system or carry out a
procedure, or use a feature more efficiently.
Getting Help
Our online help will provide you with immediate and context-related help. Click on the Help button, found in all the
system windows. A help file will open up which enables the user to navigate to the relevant topic of interest. To get
a more focused and context sensitive help click on the “?” symbol located on the upper right half of the web page.
Technical Support
If you cannot find the answer to your question in this manual or in the Help files, we recommend you contact your
system installer. Your installer is familiar with your system configuration and should be able to answer any of your
questions.
If you need additional information or technical assistance with the COSEC system and other Matrix products,
contact our Technical Support Help desk, Monday to Saturday 9:00 AM to 6:00 PM (GMT +5:30) except company
holidays.
Internet www.MatrixComSec.com
E-mail Support@MatrixComSec.com
COSEC Admin Portal allows the user to configure its Company profile. For each Company there will be different
database. The Company can create or connect to the database while creating the profile
All the applications would have their own Services and separated instance/session/thread are initiated for each
Company. Session stays active until session expires or application is closed/logged off
Browser Requirement
The COSEC Admin Management Portal is best viewed in
• Internet Explorer- Version 9.0 and above,
• Mozilla Firefox- Version 24.0 and above
• Google Chrome- Version 30.0 and above
This is a new service of COSEC VYOM Application which is responsible for Communicating with Master Service
and starting the Admin Portal Service.
Admin Portal Service will be active and running only if Master service is running.
To disable FIPS Algorithm policy go to Registry Editor by typing regedit from the start menu of your computer.
Now you can disable the FIPS Algorithm policy. Then Reset IIS Server and install the setup.
• To start with the installation procedure, double click on Setup file and the following page will appear.
• Read and accept the COSEC User License Agreement, and then click Next.
To install only COSEC Admin Management Portal and its services, click on the “Custom” type of installation.
This step in custom installation appears only when “COSEC Master Service” component is selected in the
previous step.
• Enter the required Company Details. Select the License Verification Mode as “Service Based” or “Device
Based”.
• For Device based: License will be verified from the dongle connected to the COSEC device.This device
will communicate with Master Service so that Master Service can fetch the license key from the dongle and
all of the COSEC services will function.
Only Vega direct door and Panel lite V2 in server mode can be used for Device based license verification.
•You must ensure that Vega and Panel lite V2 is in CENTRA connection mode.
• Click Install to confirm and the installation of the VYOM Admin Management Portal and its Services.
After the successful installation of COSEC Admin Management Portal, “Installation Complete” window will be
shown as below. Then close the window by clicking on Exit button.
Also you can start the COSEC Admin Service Application by browsing the folder from All Programs> Matrix >
COSEC > COSEC Admin Portal Service.
When the Admin Service is started, an icon will be visible in the system tray as shown below. Then Right click on
icon to configure the settings and start the service.
If the service entry is not available on general settings page, then service will self-register itself.
Master Service Address: Enter the IP Address or URL of the Master Service.
On Changing / Updating the Master Service Address, connection should be tested with the master service on click
of Test Connection button. Eg: net.tcp://www.server01.matrix.cosecfr:15003/MasterService/
Enter the Port number, Secure Port number at which the master service is accessible.
Web Access Port Number: This is the port number of the computer at which VYOM Web can access the VYOM
Admin Service.
Secured Web Access Port Number: This is the port number of the computer at which VYOM Web can access the
VYOM Admin Service on SSL mode.
Currently COSEC is installed in client's intranet and accessible locally. The system can be improved by hosting the
application in a remote site accessible to all of the clients with valid credentials (multi tenancy) from anywhere.
COSEC applications can be hosted on the Cloud(or data center or a high configuration server). The multiple clients
can use the application as per their own requirement.
To access the Admin Management Portal, type the following link in your browser.
http://localhost/COSECADMIN
If the network where portal is installed and the PC from where the Portal is being used are in different network then
make sure that “Alternate DNS server” is configured with the IP address where you have installed the Portal.
LOGIN
The Login page appears as shown below.
The default login ID is “sa” and default password is blank. You can create your password.
You can select “Remember Me” option which will remember the password during future login sessions.
If you change the password then the cookie will still have older password and same will be loaded by
default on login page. To update the password; browser cookies must be cleared. And again “Remember
me” can be enabled.
Enter the Master Service URL to connect with the database and click Connect. The Admin Portal will get
connected with its database through the Master service.
Now the Login page appears. Enter the Login ID and Password.
If you forget the login password, then you can click on Forgot Password to get new one time password.
Now click “Send OTP” to get the password on registered Email ID and/or registered mobile number of the login
user. To get the OTP on SMS and Email, you have to configure the Alert Settings.
The Email ID and Contact number of the user is registered on System Accounts page.
For eg: SA user will get OTP on Email ID: shruti.patki@matrixrd.org and Contact number: 9762482611
Now click Login to access the Admin Management Portal. The home page will appear as shown below:
Company here, is the client as well as the end-user who will be using COSEC for Access Control/Time and
Attendance solutions. Profile page allows the Admin portal to view/modify/ the Company details.
The COSEC License assignment as per the requirement of company is done from the License section of the
Company Configuration. The license key can also be updated by providing enhanced features to the Company.
The assignment of services such as Alert Service, Enroll Service and Monitor Service is also done from Services
section of Company Configuration. COSEC Devices connect to the assigned monitor service of the company which
is used for the Time and Attendance functionality and Access Control solution.
“Profile”
“License and Services”
“Monitor Configuration”
In the Company configuration, Profile page allows the user to view or modify the company details. The details which
are available on this page are Contact Details, Address Details and Database configuration related details.
Company are the clients who use COSEC web application. Once the Premise based setup for COSEC is installed,
Profile will be created automatically with the configurations as defined during the installation of setup.
Select the user from the right panel to edit or modify the following details on the Profile page:
Name: This field displays or allows to modify the name of the profile in the COSEC Admin portal.
Active: Enabling the Active check box will activate the client’s profile access to COSEC.
Time Zone: You can select the time zone according to the location of the Company.
License Verification Mode: Two modes for License Verification are: Server Based and Device Based.
• Server Based: If the licensing mode is set to Server based, then dongle must be inserted in the PC where
Master service is installed.
• Device Based: If the licensing mode is set to Device Based, then license key shall be fetched from the
dongle connected to the device.
Only Vega direct door and Panel lite V2 in server mode can be used for Device based license verification.
You must ensure that Vega and Panel lite V2 is in CENTRA connection mode.
Once dongle is connected to the device (Vega or Panel lite V2); enter the License server URL (Default is
192.168.50.100) and License server Port (Default is 15025) in Server Settings from device or its webpage.
Contact Details
Email ID: Enter the Email ID of 1st contact person to which the Web URL and Company user name will be sent.
You can enter Email ID of other 2 contacts as well.This Email-ID will be used when the Company (SA user) forgets
password.
Eg: sheetal.raval@matrixrd.org
Contact Number: Enter the Contact number of the Company. This Contact Number will be used when the user (SA
user) forgets password.
Address Details
Permanent Address: If the permanent address is same as billing address, then select Same as Above or else
enter the permanent address of the Company.
Database Configuration
Server: Enter the server address from where the COSEC database is to be accessed.
• For SQL authentication, specify the server where the database is to be created or accessed.
Eg: 192.168.104.12\sqlexpress
• User Name: Specify the user name as created during sql server instance. Eg: sa
• Password: Specify the password as created during sql server instance. Eg: matrix_1
• For Windows authentication, specify the server where the database is to be created or accessed. The
Username and Password will be disabled in this mode.
Connection Time-Out: Enter the duration in seconds for database connection time out.
Command Time-Out: Enter the duration in seconds for session time out.
Test Connection: Click Test connection to establish connection with the configured SQL database.
“License and Services” allows management of company’s license and services. From here the management can
modify/reassign License Key and COSEC Services to the Company.
If License Key is changed then previous license key will get free and added to the license inventory.
License Key
Click on Update to update company’s License Key with the new one.That is adding new features to existing license
key by keeping the COSEC License Platform (Serial No.) as it is.
There should be provision to assign Alert Service, Enroll Service, Visitor Service and multiple Monitor Services.
Monitor Service can be one or more as per client's device requirements. By default 1st Monitor Service will be
marked as default.
Whenever any Monitor Service is deleted then on save, all the devices assigned to this service will be
moved to the default Monitor Service.
Alert Service: Select the Alert service from the picklist to be assigned to the selected Company.
Enroll Services: Select the Enroll service from the picklist to be assigned to the selected Company.
Visitor Service: Select the Visitor service from the picklist to be assigned to the selected Company.
Monitor Service: Select one or more Monitor service from the picklist to be assigned to the selected Company.
The Management team of the Company has to ensure the proper device assignment to Monitors. They can assign/
re-assign devices among the monitor services assigned to the Company.
Once the device is configured by user, it gets assigned to the monitor which is marked as 'Default Monitor'.
The Admin Management team must Identify if new monitor service has to be created to serve the
company’s devices or any of the existing monitor service can accommodate all devices of the Company.
Depending on this, new monitor service is created and then assigned to the Company.
Company: It displays the company profile name. The monitor services assigned to the company will appear in the
grid on right side.
To assign Monitor Service to a company See “License and Services” on page 20.
Optional Parameters
• Standby Monitor: Select the standby monitors from the dropdown list which acts as standby to the
monitor configured with IP and MAC Address.
• Export Events: Select the Export events from the dropdown list to be exported to third party application.
• Specify the IP and Port Number where the events are to be exported.
• Re-Try Count: Specify the re-try count upto which system should try exporting events and if not sent
within this count then that event should be skipped. Later the event can be obtained through API.
• Polling Interval(Seconds): Specify the polling interval in seconds. It is the perid for which COSEC
Monitor will wait in idle state (the state in which no event is being sent to server). It is 30 seconds by
default. Thus if no event is sent for 30 seconds, a polling request is used to keep the connection with the
server alive in idle period.
Assign Devices
You can assign a device to this monitor by selecting from the Device picklist.The devices assigned to the monitor
service will be displayed in the grid.
If this monitor service is set as default from “License and Services”, then newly added device will be directly added
in the grid.
Example: 10 devices of ClientA are served by default monitor. But as the service gets slow, new monitor service
can be assigned to some or all of the 10 devices of ClientA.
Then access the respective monitor service's UI, change server settings of the respective devices with monitor
service IP to which it's going to be re-assigned.
Later, access the respective Company profile and monitor service in COSEC VYOM and user can re-assign
devices from one service to another service
On save, devices will communicate to the newly assigned/re-assigned monitor service.
1. Open the Webpage of PVR Door by accessing Door’s IP address (192.168.104.108) in browser. Configure the
Gateway and DNS settings as shown below.
3. Select Network Interface as Ethernet. Enter the Host Name as 192.168.102.115 and the Port as 15025 where
the Master service is hosted. This Port is Master Service Device Listening port.
The Door PVR will get added in Device List in COSEC Web accessing through Tenant 2 URL. Ensure that Tenant
2 is assigned the Monitor service running on 192.168.104.13.
Standby Monitor: Select the Standby Monitor from the drop down options which will act as standby to the monitor
configured with IP and MAC address.
When main monitor fails working, then standby monitor takes over and starts serving the devices which the main
monitor was serving.
Example: The Tenant management portal at Vadodara is having main monitor1 with its standby monitor as
monitor2. Monitor1 is serving devices of Client A(Tenant) at Mumbai. When Monitor 1 fails to serve, then Monitor 2
which is standby monitor serves the devices of Client A.
The COSEC Utilities such as Enrollment, Monitoring of Devices, Visitor Management, Alert notifications are
managed by dedicated services. These services are installed from the COSEC application Setup.
Once the services are started and running, it will automatically get assigned to the company.
• Alert Service
• Enroll Service
• Monitor Service
• Visitor Service
MAC address: Enter the MAC address of the computer where the Enroll service is installed.
IP Address: Enter the IP address of the computer on which the Enroll service is accessible.
Domain Name: Enter any name as the domain name to assign with the Enroll service. While creating new service,
the domain name as set on “General Settings” page will be fetched here.
The valid characters are A-Z, a-z,0-9, -, _ and .
Port Number: This shows the port number at which device will communicate with Enroll Service. This port number
is entered from Enroll Service Settings.
Secure Port Number: This shows the port number at which device will communicate with Enroll Service on SSL
mode. This port number is entered from Enroll Service Settings.
MAC address: Enter the MAC address of the computer where the Alert service is installed.
IP Address: Enter the IP address of the computer on which the Alert service is accessible.
Domain Name: Enter any name as the domain name to assign with the Alert service. The valid characters are A-Z,
a-z,0-9, -, _ and .
Web Access Port Number: This shows the port number of the computer at which COSEC Web can access the
Alert Service. This port number is entered from Alert Service Settings.
Secured Web Access Port Number: This shows the port number of the computer at which COSEC Web can
access the Alert Service on SSL mode. This port number is entered from Alert Service Settings.
When client is situated in a time zone other than Alert Service's time zone; Alert Service will take company's time
zone into consideration while processing scheduled tasks or generating scheduled reports.
“The time of execution for any task = Schedule Time + (Portal's Time Zone - Company's Time Zone)
Example:
Company's Time Zone = GMT - 05:30
Portal's Time Zone = GMT + 05:30
Suppose a task has been scheduled to run every day at 10:00 hours
So this task should be executed everyday by Alert Service as per it's time zone difference at
[10:00 + (GMT + 05:30) - (GMT - 05:30)]
= 21:00 hours
MAC address: Enter the MAC address of the computer where the Monitor service is installed.
IP Address: Enter the IP address of the computer on which the Monitor service is accessible.
Domain Name: Specify a domain name to assign with the Monitor service. While creating new service, the domain
name as set on “General Settings” page will be fetched here. The valid characters are A-Z, a-z,0-9, -, _ and .
Web Access Port Number: This shows the port number of the computer at which COSEC Web can access the
Monitor Service. This port number is entered from Monitor Service Settings.
Secured Web Access Port Number: This shows the port number of the computer at which COSEC Web can
access the Monitor Service on SSL mode. This port number is entered from Monitor Service Settings.
Device Port Number: This shows the port number at which device will communicate with Monitor Service. This
port number is entered from Monitor Service Settings.
Secured Device Port Number: This shows the port number at which device will communicate with Monitor Service
on SSL mode. This port number is entered from Monitor Service Settings.
Assigned Devices: This shows the number of devices assigned to the selected Monitor Service. It will be
displayed once device is added from COSEC Web.
MAC address: Enter the MAC address of the computer where the Visitor service is installed.
IP Address: Enter the IP address of the computer on which the Visitor service is accessible.
Domain Name: Specify a domain name to assign with the Visitor service. While creating new service, the domain
name as set on “General Settings” page will be fetched here. The valid characters are A-Z, a-z,0-9, -, _ and .
Port Number: This shows the port number at which service is accessible.
Secured Port Number: This shows the port number at which service is accessible on SSL mode.
The requests for database management activities like post/retrieve are processed by the Admin portal service. The
service processes the requests and update status for the same in company's COSEC database.
Every time a new post/retrieve request is submitted from COSEC Web, system will trigger Admin Portal Service
about adding up the same in the process queue.
Admin Portal Service maintains the COSEC Database location for company against the submitted task.
Admin Portal Service then take up the request one by one and process the same. It will also update task's status
accordingly in the Company's COSEC Database > Post/Retrieve Table.
The Company administrator can take backup of company’s database. See“Database Backup”.
The Company administrator can upgrade the company’s database. See “Database Upgrade” .
The Company Management team can take backup of the Company's COSEC Database through Admin portal.
Company: It displays the company profile name whose database backup is to be taken.
The Database Server and Database Name of Company is displayed as shown above.
Backup Path: Enter the path where the backup of COSEC database is to be created.
The company management team can upgrade the Company's COSEC Database through Admin Portal.
Select Company: You can select the option as All or Select Randomly depending on the upgradation required.
When option is selected as “Select Randomly”, then select the Company profile from the picklist whose database
is to be upgraded.
After selecting the company, the profile will be displayed in the grid. Click on Upgrade button.
A Warning appears as shown below.You can take backup of database before upgrading. Click No and take the
backup of existing database from “Database Backup”. If backup is not required; then click Yes to continue upgrade.
The database upgrade will be started and the status will be displayed as In Progress.
System Configuration enables you to configure Maintenance schedule and inform the Company so they can
manage the work accordingly.
The Secured connection can be established between the Company and the Server after configuring Security
settings.
The SMS notification and Email notification can be sent after setting SMS and Email Configurations.
Using General Settings the Company management administrator can specify the Master Service URL, Port, Utility
download URL and other important connection end points which will be used by the company for accessing
COSEC Web application.
“Maintenance Configuration”
“Security”
“SMS Configuration”
“Email Configuration”
“General Settings”
“Multi-Language Configuration”
The COSEC System requires maintenance time during upgradation of versions. During this time the company may
not access COSEC application so the Maintenance duration can be configured from here which can be informed to
the company.
To configure the maintenance information click on the option System Configuration from the admin menu.
Maintenance Start Date-Time: Select the date and specify the time at which maintenance will be started.
Maintenance End Date-Time: Select the date and specify the time at which maintenance will end.
Enable SMS check box to send SMS to all active company’s contact number.
Enable Email check box to send Email to all active company’s Email ID.
On the basis of this Mail is sent to the company informing the maintenance alert. Mail is to be updated considering
individual company's time zone as well.
Click Save & Send to save the configuration and send SMS/Email to the company.
The company/user will get scheduled maintenance message on login page about 2 days prior to Schedule
Start Date.
To configure the Secure Communication settings click on the option System Configuration from the admin menu.
SSL or Secure Sockets Layer is a security protocol that enables to have secured communication between Client
and Server by making use of asymmetric keys. These keys are defined in pairs of public-private key. Public key is
available to all clients while private key is only available with the server owning the SSL certificate. There keys have
following properties:
• Data encrypted by client using public key can only be decrypted by server using the private key.
• Data encrypted by server's private key can only be decrypted by using the public key.
• Enable Secure Communication: Select to enable secure communication using SSL encryption.
• Upload SSL Certificate(.pfx): Click to browse the file through your system and select the SSL certificate
to be uploaded as a *.pfx file. Click Upload.
• Password: Enter the password required to access the uploaded SSL Certificate.
• Certificate Friendly Name: Enter a friendly name for the SSL Certificate. This will be used internally by IIS
during certificate configurations.
Some pre-defined ports do not support SSL communication. If the user configures SSL on such a port,
settings will be saved successfully, but he/she will fail to access COSEC. In such a case, the user should
manually change this Port setting in IIS and thereafter COSEC can be accessed.
The initial communication just after enabling SSL communication will be insecure. Later on, as soon as it is
found from DB that SSL has been enabled, the communications made thereafter will be on SSL basis.
For SMS configuration settings click on the option System Configuration from the admin menu.
If SA user forgets his password, then his OTP can be retrieved on his Mobile number if the SMS Configuration is
done from this page.
For getting OTP on Mobile, the Contact number must be available in “System Accounts” Detail.
The user needs to ensure that the COSEC ALERTS computer has an internet connection for this
functionality to work.
Select the Service provider from the drop down list. The service providers already supported are:
• SMSGatewayCenter
• SMSLane
• BusinessSMS
• BulkSMS
• SNOWEBS
To add new service provider See “New Service Provider” on page 41.
Enter the Username, Password, and the registered Sender ID in the respective fields as shown above.
The username, password and registered sender ID for different service providers can be found from
Support Data or administrator.
Alert Cycle: Specify the time in seconds between successive send attempts when the system tries to send the
pending messages.
Retry Count: Specify the number of times the system needs to retry.
Active Days: Specify the number of days for which the pending messages will be treated as active in the event of
the Alert service being temporarily stopped.
Disable Sending SMS: Check this box for temporarily disabling the SMS sending functionality.
Test Message:
Enter a phone number in the field provided and send a test message to test the settings. The user may now start
the alert service to send the SMS.
To add a new service provider, click the button. The API Configuration window appears on your screen.
Enter the new service provider’s name (e.g. “way2sms”) and URL i.e. the actual service provider website used for
registration etc. (e.g. “www.way2sms.in”).
Service Provider Name: Enter the new SMS service provider’s name (e.g. “way2sms”)
Service Provider URL: Enter the URL of the service provider.This url is displayed on the main SMS Setting
page as shown in the screen below.
Now add the API arguments by clicking on Add button as shown below.
• API Argument: Enter the API argument name specified in the API document of the service provider.
• Argument Value: Select the argument value from the dropdown list which is to be associated with the API
argument. Eg: Select the Argument value one by one from the drop down options. Eg: Select Argument
value as “User Name” and specify API Argument as “uname” which will be used in the API argument.
One can also click Delete button, if any argument is to be removed. Further, one can also edit any argument by
clicking on it, editing the argument and then clicking the Update button.
• Argument Separator: Enter the argument separator to be used for firing a command. Example.: “&” or “;”.
• Request Method: Select the method for sending the message via sms. The options are: post and web. If
post is selected, you can send long messages without any limitation. If Web is selected, you can send only
short messages.
• Request Preview: Displays the preview of the url with arguments as shown in the screen below.
• Balance Check: Select to allow balance check, if the service provider needs to use it.
• API Response: Enter the API Response to be used for the selected COSEC Response from the
dropdown list. Click Add button and the response gets displayed in the grid.
Click Save button to save the above API configurations. The new service provider will be created and will appear in
drop down options of Service Provider.
To edit API configuration for a user-defined service provider, on the SMS Setting page, select a service
For Email configuration settings click on the option System Configuration from the admin menu.
If SA user forgets his password, then his OTP can be retrieved on his Email ID if the Email Configuration is done
from this page.
For getting OTP on Email, the Email ID must be available in “System Accounts” Detail.
The user needs to ensure that an SMTP Server has been set up on the network. The E-mail setting parameters
need to be configured as described here.
SMTP Server: Enter the IP address or name of the configured SMTP server. Check the server availability with your
network administrator.
SMTP Port Number: Specify the TCP port for the SMTP service as set on the SMTP server.
POP3/IMAP Server: Specify the IP address or name of the configured POP3 or IMAP server.
POP3/IMAP Port Number: Specify the appropriate incoming port for the SMTP service as set on the SMTP server.
Sender Display Name: Specify the user name as to be displayed in the emails.
User Name: Specify the user name as set in the outlook account on the Alert PC.
Alert Cycle: Specify the time in seconds between successive send attempts when the system tries to send the
pending messages.
Retry Count: Specify the number of times the system needs to retry to send the same Email message in the event
of an unsuccessful attempt.
Active Days: Specify the number of days the system needs to keep the unsent messages active in the event of the
service being stopped.
Enable SSL: Select the check box, if the communication via email is to be made secured using SSL (Secure
Socket Layer).
Example: In the event of using an external SMTP server like gmail, the enable SSL option needs to be enabled.
Disable Sending Mail: Check this box for temporarily disabling the mail sending functionality.
Delete Mail from server: Check this box for deleting all mails from the server as soon as they are downloaded to
the client.
Test Mail
• E-mail ID: Specify the email id on which the test mail can be sent. Click Send Mail button to send the test
mail.
General Settings allow the Company management administrator to specify the Master Service URL, Admin Portal
Service URL and Utility download URL.
Once the service URLs are entered, then the fields shown below will be non-editable.
For General settings click on the option System Configuration from the admin menu.
When the Master service and Admin Portal service are self-registering, then the URLs of services will be fetched
and displayed here.
Master Service URL: This is the URL to access the system where master service is hosted or installed.
Master Service Secured URL: This is the secured URL to access the system where master service is hosted or
installed.
Master Service Device Listening Port Number: This is the port number at which device will communicate with
Master service.
The device will request to the Master service. The Master service will serve the device either on port 15005 or
15025. So according to the communication between device and master service, the “Master Service Device
Listening Port” in General Settings will be updated and displayed in General Settings.
Admin Portal Service URL: This is the URL where the Admin Portal service is installed/hosted.
Admin Portal Secured Service URL: This is the secured URL where the Admin Portal service is installed/hosted.
The Client accessing COSEC Web does the communication with Admin Portal (say for Licensing purpose) on this
Admin Portal web access port number.
The COSEC Web will request to the Company Port Service. The Admin Portal Service will serve the Web on port
14000 or 14009. So according to the communication between Web and Admin Portal, the “Admin Portal Web
Access Port Number” port will be updated and displayed in General Settings.
This port can be configured from “Admin Portal Service Settings” as shown below.
COSEC Web URL: Specify the URL for accessing COSEC Web application. Once this URL is entered during
installation of setup, then the COSEC Web URL will automatically appear here.
Portal Time Zone: It is the time zone of the location where Admin Portal Service is running.
When client (company) is situated in a time zone other than Alert Service's time zone; Alert Service will
take company's time zone into consideration while processing scheduled tasks or generating scheduled
reports.
Central NTP Server: Specify the NTP server for the clock synchronization between the systems.
General Settings allow the Company management administrator to specify the Master Service URL, Admin Portal
Service URL and Utility download URL.
Once the service URLs are entered, then the fields shown below will be non-editable.
For configuration of Multi-language click on the option System Configuration from the admin menu.
Support Multi-language Input: The users around the world can use COSEC system in their regional languages.
So check this box to enable the multi-language input functionality which will enable you to enter the input in your
own language.
Data input and storing the same in database will support UTF-8 characters.
Input From: Select the orientation of multi-language input data from “Left to right” or “Right to left”. E.g. If “Right to
Left” option is selected, then the input is entered from right side of the textbox and goes to left.
"The list of invalid characters is as follows:
#%^='"{}|;<>?&*
The COSEC System requires maintenance time during upgradation of versions. During this time the company may
not access COSEC application so the Maintenance duration can be configured from here which can be informed to
the company.
To configure the maintenance information click on the option System Configuration from the admin menu.
Maintenance Start Date-Time: Select the date and specify the time at which maintenance will be started.
Maintenance End Date-Time: Select the date and specify the time at which maintenance will end.
Enable SMS check box to send SMS to all active company’s contact number.
Enable Email check box to send Email to all active company’s Email ID.
On the basis of this Mail is sent to the company informing the maintenance alert. Mail is to be updated considering
individual company's time zone as well.
Click Save & Send to save the configuration and send SMS/Email to the company.
The company/user will get scheduled maintenance message on login page about 2 days prior to Schedule
Start Date.
To configure the Secure Communication settings click on the option System Configuration from the admin menu.
SSL or Secure Sockets Layer is a security protocol that enables to have secured communication between Client
and Server by making use of asymmetric keys. These keys are defined in pairs of public-private key. Public key is
available to all clients while private key is only available with the server owning the SSL certificate. There keys have
following properties:
• Data encrypted by client using public key can only be decrypted by server using the private key.
• Data encrypted by server's private key can only be decrypted by using the public key.
• Enable Secure Communication: Select to enable secure communication using SSL encryption.
• Upload SSL Certificate(.pfx): Click to browse the file through your system and select the SSL certificate
to be uploaded as a *.pfx file. Click Upload.
• Password: Enter the password required to access the uploaded SSL Certificate.
• Certificate Friendly Name: Enter a friendly name for the SSL Certificate. This will be used internally by IIS
during certificate configurations.
Some pre-defined ports do not support SSL communication. If the user configures SSL on such a port,
settings will be saved successfully, but he/she will fail to access COSEC. In such a case, the user should
manually change this Port setting in IIS and thereafter COSEC can be accessed.
The initial communication just after enabling SSL communication will be insecure. Later on, as soon as it is
found from DB that SSL has been enabled, the communications made thereafter will be on SSL basis.
When Security mode is switched from Non-SSL to SSL or vice versa then all the services will be restarted.
•Restarting Master Service will only be possible when Master Service is accessible from Admin
Management Portal Web Server. If not then user has to restart it manually.
•Restarting any COSEC Service will only be possible when it is accessible from Master Service. If not then
user has to restart it manually.
•There can be scenarios when the service is stopped and started. However by the time starting is
attempted the ports are not freed. In such cases the service will stop giving reason as port unavailability.
So user has to start it manually.
For SMS configuration settings click on the option System Configuration from the admin menu.
If SA user forgets his password, then his OTP can be retrieved on his Mobile number if the SMS Configuration is
done from this page.
For getting OTP on Mobile, the Contact number must be available in “System Accounts” Detail.
The user needs to ensure that the COSEC ALERTS computer has an internet connection for this
functionality to work.
Select the Service provider from the drop down list. The service providers already supported are:
• SMSGatewayCenter
• SMSLane
• BusinessSMS
• BulkSMS
• SNOWEBS
To add new service provider See “New Service Provider” on page 54.
Enter the Username, Password, and the registered Sender ID in the respective fields as shown above.
The username, password and registered sender ID for different service providers can be found from
Support Data or administrator.
Alert Cycle: Specify the time in seconds between successive send attempts when the system tries to send the
pending messages.
Retry Count: Specify the number of times the system needs to retry.
Active Days: Specify the number of days for which the pending messages will be treated as active in the event of
the Alert service being temporarily stopped.
Disable Sending SMS: Check this box for temporarily disabling the SMS sending functionality.
Test Message:
Enter a phone number in the field provided and send a test message to test the settings. The user may now start
the alert service to send the SMS.
To add a new service provider, click the button. The API Configuration window appears on your screen.
Enter the new service provider’s name (e.g. “way2sms”) and URL i.e. the actual service provider website used for
registration etc. (e.g. “www.way2sms.in”).
Service Provider Name: Enter the new SMS service provider’s name (e.g. “way2sms”)
Service Provider URL: Enter the URL of the service provider.This url is displayed on the main SMS Setting
page as shown in the screen below.
Now add the API arguments by clicking on Add button as shown below.
• API Argument: Enter the API argument name specified in the API document of the service provider.
• Argument Value: Select the argument value from the dropdown list which is to be associated with the API
argument. Eg: Select the Argument value one by one from the drop down options. Eg: Select Argument
value as “User Name” and specify API Argument as “uname” which will be used in the API argument.
One can also click Delete button, if any argument is to be removed. Further, one can also edit any argument by
clicking on it, editing the argument and then clicking the Update button.
• Argument Separator: Enter the argument separator to be used for firing a command. Example.: “&” or
“;”.
• Request Method: Select the method for sending the message via sms. The options are: post and web. If
post is selected, you can send long messages without any limitation. If Web is selected, you can send only
short messages.
• Request Preview: Displays the preview of the url with arguments as shown in the screen below.
• Balance Check: Select to allow balance check, if the service provider needs to use it.
E.g. If “1” API Response is specified for the “Success” COSEC Response, then if the message is sent
successfully then API will respond with 1 value and COSEC will respond withe value success.
Click Save button to save the above API configurations. The new service provider will be created and will appear in
drop down options of Service Provider.
To edit API configuration for a user-defined service provider, on the SMS Setting page, select a service
For Email configuration settings click on the option System Configuration from the admin menu.
If SA user forgets his password, then his OTP can be retrieved on his Email ID if the Email Configuration is done
from this page.
For getting OTP on Email, the Email ID must be available in “System Accounts” Detail.
The user needs to ensure that an SMTP Server has been set up on the network. The E-mail setting parameters
need to be configured as described here.
SMTP Server: Enter the IP address or name of the configured SMTP server. Check the server availability with your
network administrator.
SMTP Port Number: Specify the TCP port for the SMTP service as set on the SMTP server.
POP3/IMAP Server: Specify the IP address or name of the configured POP3 or IMAP server.
POP3/IMAP Port Number: Specify the appropriate incoming port for the SMTP service as set on the SMTP server.
Sender Display Name: Specify the user name as to be displayed in the emails.
User Name: Specify the user name as set in the outlook account on the Alert PC.
Alert Cycle: Specify the time in seconds between successive send attempts when the system tries to send the
pending messages.
Retry Count: Specify the number of times the system needs to retry to send the same Email message in the event
of an unsuccessful attempt.
Active Days: Specify the number of days the system needs to keep the unsent messages active in the event of the
service being stopped.
Enable SSL: Select the check box, if the communication via email is to be made secured using SSL (Secure
Socket Layer).
Example: In the event of using an external SMTP server like gmail, the enable SSL option needs to be enabled.
Disable Sending Mail: Check this box for temporarily disabling the mail sending functionality.
Delete Mail from server: Check this box for deleting all mails from the server as soon as they are downloaded to
the client.
Test Mail
• E-mail ID: Specify the email id on which the test mail can be sent. Click Send Mail button to send the test
mail.
General Settings allow the Company management administrator to specify the Master Service URL, Admin Portal
Service URL and Utility download URL.
Once the service URLs are entered, then the fields shown below will be non-editable.
For General settings click on the option System Configuration from the admin menu.
When the Master service and Admin Portal service are self-registering, then the URLs of services will be fetched
and displayed here.
Master Service URL: This is the URL to access the system where master service is hosted or installed.
Master Service Secured URL: This is the secured URL to access the system where master service is hosted or
installed.
Master Service Device Listening Port Number: This is the port number at which device will communicate with
Master service.
The device will request to the Master service. The Master service will serve the device either on port 15005 or
15025. So according to the communication between device and master service, the “Master Service Device
Listening Port” in General Settings will be updated and displayed in General Settings.
Admin Portal Service URL: This is the URL where the Admin portal service is installed/hosted.
Admin Portal Secured Service URL: This is the secured URL where the Admin portal service is installed/hosted.
The Client accessing COSEC Web does the communication with Admin Portal (say for Licensing purpose) on this
Admin portal web access port number.
The COSEC Web will request to the Admin Port Service. The Admin Portal Service will serve the Web on port
14000 or 14009. So according to the communication between Web and Admin Portal, the “Admin Portal Web
Access Port Number” port will be updated and displayed in General Settings.
This port can be configured from “Admin Portal Service Settings” as shown below.
COSEC Web URL: Specify the URL for accessing COSEC Web application. Once this URL is entered during
installation of setup, then the COSEC Web URL will automatically appear here.
Portal Time Zone: It is the time zone of the location where Admin Portal Service is running.
When client (company) is situated in a time zone other than Alert Service's time zone; Alert Service will
take company's time zone into consideration while processing scheduled tasks or generating scheduled
reports.
Central NTP Server: Specify the NTP server for the clock synchronization between the systems.
General Settings allow the Company management administrator to specify the Master Service URL, Admin Portal
Service URL and Utility download URL.
Once the service URLs are entered, then the fields shown below will be non-editable.
For configuration of Multi-language click on the option System Configuration from the admin menu.
Support Multi-language Input: The users around the world can use COSEC system in their regional languages.
So check this box to enable the multi-language input functionality which will enable you to enter the input in your
own language.
Data input and storing the same in database will support UTF-8 characters.
Input From: Select the orientation of multi-language input data from “Left to right” or “Right to left”. E.g. If “Right to
Left” option is selected, then the input is entered from right side of the textbox and goes to left.
"The list of invalid characters is as follows:
#%^='"{}|;<>?&*
To create the system account users click on the option System Accounts from the admin menu.
To change the login password of Admin Portal click on the option Change Password from the admin menu
MATRIX COMSEC
Head Office:
394-GIDC, Makarpura, Vadodara - 390010, India.
Ph:+91 265 2630555, +91 8511173344
E-mail: Support@MatrixComSec.com
www.MatrixSecuSol.com