Scout Suite Administration Guide

Scout™
Scout Suite
Administration
Guide
Release 4.7
This document is confidential.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636

100 Innovation Place • Lexington SC 29072 USA
avtecinc.com
Scout Suite Administration Guide | October 2018 | Release 4.7
Copyright © 2018 by Avtec, Inc. All rights reserved.
This document contains proprietary information that is protected by copyright. No

part of this document may be reproduced, stored in a retrieval system, or
transmitted in any form or any means electronic, mechanical, photocopying,
recording or otherwise, without the prior written consent of Avtec, Inc.
Scout™, VPGate™, Outpost™, Frontier™, Audio Bridge™, Avtec SIP Proxy™,

ScoutLink™, DSPatch, DSPatchNET, and CommScape™ are trademarks of Avtec, Inc.
All other brands and their products are trademarks or registered trademarks of
their respective holders and should be noted as such.
Copyright © 2003 GoAhead Software, Inc. All rights reserved.
The material in this document is for information only and is subject to change
without notice. While reasonable efforts have been made in the preparation of
this document to assure its accuracy, Avtec, Inc. assumes no liability resulting
from errors or omissions in this document, or from the use of the information
contained herein. Avtec, Inc. reserves the right to make changes in the product
design without reservation and without notification to its users.
COMPANY INFORMATION Avtec, Inc.

100 Innovation Place
Lexington, SC 29072
USA
Release Release 4.7
Release Date October 2018
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 ii

avtecinc.com • sales@avtecinc.com
Contents
Overview 1
DMS Database Backup and Recovery 3
Overview – Scout Data Store Database Backup and Restore 5
Best Practices 5
Backup Options 5
Requirements 6
Creating a Backup Job 6
Initiating a Backup 9
Restoring a Backup 9
Automatic Database Maintenance Backups 12
Restore Backup Using SQL Restore 12
DMS Database Recovery 14
Using Import and Export 14
Export the Current Configuration 15
Import a Previously Exported Configuration 15
SCD Statistical Reports Export API 19
SCD Statistical Reports Export API – Overview 19
Service Descriptions 19
Retrieval of Data 19
Purging of Data 20
Web Service Metadata: Web Services Description Language (WSDL) 20
IDataExportService API Reference 20
ExportDispatcherActivity 20
Request Parmeters 20
Response Fields 21
DispatcherActivity 21
ExportEndpointActivity 21
Response Fields 22
EndpointActivity 23
ExportCalls 23
Response Fields 24
Call 24
Call Owner 25
PurgeDispatcherActivities 26
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 iii

Response Field 26
PurgeEndpointActivities 26
Response Field 27
PurgeCalls 27
Response Field 27
Examples: XML Request and Response 28
ExportDispatcherActivity 28
Request 28
Response 28
ExportEndpointActivity 29
Request 29
Response 29
ExportCalls 30
Request 30
Response 31
PurgeDispatcherActivities 32
Request 32
Response 32
PurgeEndpointActivities 32
Request 32
Response 33
PurgeCalls 33
Request 33
Response 33
Example: Simple Object Access Protocol (SOAP) 35
Creating a SoapUI Test Project 35
Moving an Active DMS to Another Computer Overview 37
Verify DMS Message Queue Status 37
Exit Scout Manager 37
Stop the Message Queue Service 38
Stop the DMS Application Pool 38
Back Up the DMS Database 38
Back Up Using SQL Backup Master 38
Back Up Using Query Express 38
Install DMS and All Prerequisites on the New DMS Computer 40
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 iv

Restore the DMS Database on the SQL Computer 41

Restore Using SQL Backup Master 41
Restore Using Query Express 42
Run the User Recovery Scripts on the Restored DMS Database 43
Example Using QueryExpress 44
Recycle the DMS Application Pool on the DMS Computer 44
Start the Message Queue Service 45
Start Scout Manager for the DMS Computer 45
Verify the Address for SCD in Scout Manager 45
Deploy the Project via Deployments View 46
Uninstall DMS from the Original Computer 47
Migrating from SQL Express to SQL Server Standard or Enterprise 49
Verify DMS Message Queue Status 49
Exit Scout Manager 49
Enable MSDTC on Local and Remote Systems 50
Upgrade Scout 51
Create a SQL Instance 51
Stop the Message Queue Service 51
Stop the DMS Application Pool 51
Back Up the DMS Database 52
Back Up Using SQL Backup Master 52
Back Up Using Query Express 52
Restore the DMS Database on the SQL Computer 54
Restore Using SQL Backup Master 54
Restore Using Query Express 55
Creating a SQL Login for a SQL User 56
Edit web.config on the DMS Machine 57
Start the DMS Application Pool 58
Start the Message Queue Service 58
Start Scout Manager for the DMS Computer 58
Verify the Address for SCD in Scout Manager 58
Deploy the Project via Deployments View 59
Avtec's Local Application Pool Account 61
IIS User Group: IIS_IUSRS 61
Replacing the Avtec Account within the Application Pool 62
Setting up DMS Folder Permissions 62
Resolving File Permission Issues for Reports 62
Setting Up MSMQ Permissions 63
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 v

Setting up the IIS Application Pool Account 63

DMS Web Configuration Settings 65
Uncommented Settings 65
Commented Settings 69
Troubleshooting 73
MSMQ Messages Fail to Reach DMS 73
DMS Timeout Limit 73
Modifying Registry Setting ServicePipeTimeout 73
Incorrect Install Fail Message 74
SQL Service not Running 75
Working with SNMP 77
Understanding SNMP Traps for Alarms and Events 77
Scout MIBs 77
Configuring Access to SNMP Managers 77
Showing or Hiding Inactive SNMP Managers 78
Understanding SNMP Data 79
Downloading Scout and Avtec Mibs 79
Identifying Scout MIB Variables 80
Alarms and Events 83
Common Alarms and Events 83
Audio Bridge Alarms and Events 84
Avtec Routing Controller (ARC) Alarms and Events 85
Avtec SIP Proxy Alarms and Events 86
Call Voter Alarms and Events 87
Console Alarms and Events 87
Diagnostics Alarms and Events 90
DMS Alarms and Events 90
Encryption Key Manager Alarms and Events 92
Frontier Alarms and Events 95
Scout Manager Alarms and Events 97
ScoutLink Alarms and Events 97
Trunking Gateway Alarms and Events 98
VPGate Alarms and Events 99
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 vi

OVERVIEW
The Scout Suite Administration Guide contains information for Scout administrators about maintaining the Scout
system. This guide contains information and procedures discussing database backup and recovery, moving an active
DMS database to another computer, and migrating from SQL Server Express to SQL Server Standard or Enterprise.
It also includes information on using the statistical reports export API and working with the Avtec local application
pool account. All Scout system alarms and events are described, along with information about using Scout MIBs and
SNMP Managers. A troubleshooting section is also included.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 1

DMS DATABASE BACKUP AND RECOVERY

Database backups are an important part of any disaster recovery strategy. A valid, restorable database backup is
crucial when the moment comes to execute a real disaster recovery scenario.
Avtec offers numerous mechanisms for safeguarding the DMS database. The following table discusses the options
for backing up and restoring the database:
Database Backup When Backup What Gets

Considerations
Mechanism Occurs Backed Up
l Can perform backups on demand.
l Can schedule backups to perform

On demand or automatic automatically.
Backup using SQL Backup
scheduling using SQL Backup
Master or other third-party Full database backup* Can save multiple backups for
Master or other third-party l
tool
tool historical purposes (daily, weekly,
etc.).
l Can back up to a different system.

l Saved to same physical system.
Scout generated automatic l Keeps two days worth.
Database maintenance nightly backup at time set in
Full database backup*
backups Database Maintenance Run l Applies only when choosing Default
Time
installation option during
installation.
Scout generated automatic l Can use to restore upon accidental
Backup during DMS uninstall backup when DMS is Full database backup*
uninstalled uninstallation.
l Can use to back up project before

an upgrade.
SCD configuration and
SCD Import and Export utility Manually, on demand project component l Does not include alarms and
data events, report information, or
component XML configuration
data.
*Full database backup includes Scout project data, alarms and events, and reporting activity.
See the following topics for details on the above backup options:
l Scout Data Store Database Backup and Restore
l Automatic Database Maintenance Backups
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 3

l DMS Database Recovery
l Scout Central Distributor Import and Export
Refer to the Scout Suite Installation and Upgrade Guide for information on backup and recovery of individual
component configuration information.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 4

Overview – Scout Data Store Database Backup and Restore

This section offers guidance in using third-party software to schedule regular, automatic backups that occur without
stopping data collection, and to restore backups with minimal data loss.
Avtec has tested database backup and recovery using SQL Backup Master, the free SQL database backup software
downloaded from http://www.sqlbackupmaster.com/. SQL Backup Master creates and compresses backups of
SQL Server databases, including SQL Server Express. Backups can be stored locally, to a cloud storage service, or to
an FTP server.
NOTE
Scout Data Store is expected to be compatible with other database backup and recovery tools that support SQL
database backups.
The following high-level tasks provide details for performing a full backup using SQL Backup Master:
l "Creating a Backup Job" on Page 6
l "Initiating a Backup" on Page 9
l "Restoring a Backup" on Page 9
Best Practices
Avtec recommends the following best practices when implementing a Scout Data Store database backup and
recovery plan:
l Store backups in a physical location or drive separate from the production database files so that these
backups are available if your physical drive fails. Placing the data and backups on separate devices also
enhances the input/output (I/O) performance for writing backups and for production use of the database.
l Do not create logical volumes or partitions from your physical disk drive for backup media.
l Establish a proper backup schedule based on application needs and business requirements.
o 1 to 10 GB database: Perform a complete database backup every night; perform differential backups
every four hours during an off-peak time of the day; perform transactional log backups every 60
minutes.
o 500 MB to 1 GB database: Perform a complete database backup every night during a non-operational
window or when data traffic is at a minimum.
l Perform a restore of a backup on a test server to verify the restore with all the options and conditions
necessary during planned or unplanned downtime.
Backup Options
Most third-party database backup tools support three backup types: full, differential, and transaction log.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 5

l Full backup – Contains the entirety of the database at the point of backup.
l Differential backup – Contains only database information changed since the last full backup.
l Transaction log backup – Contains transaction logs.
While many combinations of these three types can be configured, Avtec recommends a simple model; SQL Backup
Master's "Daily Simple" plan in the Full Backup option. This backup plan is a snapshot in time and contains no
differential or transaction log backups. During this simple backup process, active data collection continues; however,
once backup begins, no data collection is sent to the backup. While this model requires the least administration, data
is recoverable only to the most recent full database backup.
IMPORTANT
The simple model is not the best choice for production systems where data loss of recent changes is
unacceptable. To minimize data loss, consider one of the more extensive differential backup schemes.
Requirements
The following are required prior to performing any backups.
l Installation of SQL Backup Master Version 1.0.118.0 or later (http://www.sqlbackupmaster.com/) on the

computer that hosts the SQL Server instance you wish to back up.
NOTE
Avtec has tested only the free edition of the product. Version 2.0.19.0 was used to create these
instructions.
l Connectivity to a remote drive location of SAN/NAS. If the production database resides on a SAN, Avtec
recommends that you store the backup on a different SAN. A raided SAN is recommended for backup data
integrity.
l The use of a domain or local administrator account for the target drive machine as well as the originating
server.
l A SQL username and password with rights to perform backups.
During installation, Avtec provides limited database access to perform backups with this user name and
password:
User name Password

DMS_Backup P@ssword1
Creating a Backup Job

Once the product (SQL Backup Master) is properly installed, create a backup job detailing a scheduled time,
originating database, and a destination target or backup location.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 6

1. In SQL Backup Master, select Create New Database Backup.
The Database Backup Editor dialog displays.
2. Under Source, select Choose SQL Server.
The Connect to SQL Server dialog displays.
a. Select Server name > (local)\AVTECDMS.
b. Select Connect using the following SQL Server account.
c. Enter the pre-installed Username: DMS_Backup; and Password: P@ssword1.
d. Click OK.
DMS displays in the Source column.
3. Under Source, select the DMS checkbox.
4. Under Destination, click Add.
The Choose Destination dialog displays.
a. Select Local or Network Folder and click Select.
The Folder Destination Settings dialog displays.
b. Specify a backup location and click OK.
NOTE
Choose a location on the network with either a mapped drive, IP and share address, or machine
name (Example: \\NetworkServer101\C$\Backups). For network servers, use an account
with write access to the network share. This can be a domain or local account.
c. Under Cleanup, select the number of days versions should be kept before deletion.
d. Click OK.
5. Under Configuration, click Not scheduled to establish scheduling.
The Backup Job Schedule dialog displays.
NOTE
For most installations, Avtec recommends a simple backup and restore procedure.
a. Click Load a Preset Backup Plan and select Daily Simple.
This sets the schedule to perform a full backup every 24 hours with no differential or transaction log
backup.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 7

NOTE
Adjust the 24-hour duration based on your needs.
b. Click Save.
6. To have the system notify you regarding backup operations, under Configuration, select the Email
Notifications link.
The Backup Job Settings dialog displays.
a. Select the checkbox next to Send Email Notifications.
b. Make your selections and fill in the required fields, then click Save.
NOTE
Avtec recommends enabling email for success or failure. Test the connection and setup by
sending a test email and verifying it arrives.
7. Under Configuration, enter a Backup Name and Description.
8. Click Save.
The backup configuration is complete.
NOTE
You can check the status of previously run backup and restore jobs at any time by selecting ‘View Database
Backup Log’ from the Backup and Restore tab. This displays successes, warnings, errors and debug information
regarding the selected database backup.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 8

Initiating a Backup
Your backup performs automatically based on the schedule in your backup configuration. You can also manually
initiate backups.
1. In SQL Backup Master, from the Backup and restore tab, select Back up now for your selected backup job,
or select Run all backups now.
Once the backup completes, your selected backup screen updates the Status, Summary, and Last Run
details, and if configured, you receive an email with the backup statistics.
2. Confirm the backup by checking the presence and size of the file at the backup destination you specified.
NOTE
Inbound data traffic from production calls continues during the backup process.
Restoring a Backup
Perform the following to restore your database from a backup.
NOTE
You can only restore the same version of the database that is currently installed. For example, you cannot
restore a 4.1 database to a Scout system running 4.2. If a non-matching version of the database is restored,
errors occur.
IMPORTANT
During the restore process of this simple database backup and recovery, data collection halts. This process only
replaces the corrupted database with the most recent database image. Changes that occur after the most
recent backup are not recoverable. Those changes must be made again.
1. Confirm that the backup that was created in the location specified in step 4b in "Creating a Backup Job" on
Page 6 has a file name structured similarly to the one selected in the example below.
2. In SQL Backup Master, from the Backup and restore tab, select Recover from your selected backup job.
The Database Backup Recovery Explorer dialog opens.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 9

3. Select the Backup Job and Destination.
Backup images that are not yet completed are not shown.
4. Click Recover.
The Recover Database dialog opens.
5. Click SQL Service instance.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 10

The Connect to SQL Server dialog displays.
6. Select Connect using Windows Authentication and click OK. The Target database field autofills with DMS in
the Recover Database dialog.
NOTE
Use an administrative account that enables both read and write access to the SQL instance and
destination folders. If you don't have administrative rights, your backup images may not display and you
may receive an authentication error.
7. In the Recover Database dialog, select Leave the database ready to use...RESTORE WITH RECOVERY. This
ensures pending transactions do not roll into the new database.
NOTE
This simple restore does not attempt to merge backup data with current customer records made after
the last backup. This restore process deletes all customer data created after the last valid backup
8. Click Begin Recovery.
A confirmation dialog displays, warning that all existing data will be replaced.
IMPORTANT
To mitigate data loss, if your most recent backup was not made immediately prior to this recovery
action, stop this process and create a backup now. Or, if that is not possible, take steps to identify
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 11

changes made after the most recent backup because those changes will need to be made again after
this recovery.
9. Click Yes to start the database restore.
10. After the database is restored, confirm you have access to the data in Scout Central Distributor.
NOTE
The Data Management Services (DMS) webpage displays Scout Central Distributor (SCD).
You can access it directly in a browser: http://SCD hostname or IP address/dms.
If you installed DMS on the same machine you are using, then specify your local host:
http://localhost/dms.
NOTE
If restoring the database on a different system, follow the instructions for restoring using the SQL
Restore tool.
Automatic Database Maintenance Backups

Every day, at the time set in Database Maintenance Start Time in SCD (Admin > Settings > Database), Scout
performs a 'behind the scenes' automatic backup of the DMS database.
These daily backups are part of a regular maintenance routine run by Scout and should not be used in place of a
formal database backup plan. See Scout Data Store Database Backup and Restore for instructions on using third-party
software to schedule regular, automatic backups that occur without stopping data collection, and to restore backups
with minimal data loss.
Restore Backup Using SQL Restore

If necessary, the data from Scout's automatic maintenance backup can be restored by performing the following:
1. Stop the DMS Application Pool on the new DMS server.
2. Open the SQL Restore Tool on the DMS server by running SlqRestore.exe located at C:\Program Files
(x86)\Avtec, Inc\DMS\Support.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 12

3. In the Source (From) section, select the Backup file (bak, zip). The default location is
C:\ProgramData\Avtec, Inc\DMS\DbBackups\DMS_SQLServerBackup_<day and
time>.bak.zip.
NOTE
Automatic backup files use a different file naming format than the SQL Backup Master file. Be sure you
select the correct file (DMS_SQLServerBackup_<day and time>.bak).
4. Connect to the DMS server.
a. In the Target (To) section, click Connect next to SQL Server.
The Connect to SQL Server dialog box displays.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 13

b. In Server Name, enter localhost\AVTECDMS.
c. Select Use Windows Authentication and click OK.
NOTE
Use an administrative account that enables both read and write access to the SQL instance and
destination folders. If you don't have administrative rights, your backup images may not display
and you may receive an authentication error.
5. Select DMS as the Target Database.
6. Click Restore.
A confirmation dialog displays.
7. Click Yes to start the database restore.
DMS Database Recovery

Using Import and Export
Use the Import/Export feature to back up and restore the Scout Central Distributor (SCD) configuration and project
component data generated by Scout Manager and stored in the Scout Data Store database. This includes:
l Installed Scout components that display on the Layout tab, including Sites, VPGates, and all installed
components.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 14

NOTE
This data does not include alarm data or the data stored in XML files configured on each component’s
Configuration page.
l All elements that display on the Configuration tab.
NOTE
SCD users with System Administrator permission can export the current configuration and import a previously
exported configuration file. Users with Scout Manager User permission can export the current configuration
but do not have access to import the configuration.
Avtec recommends that you first export the current configuration before importing an earlier version, so that if the
configuration you import is not satisfactory, you can import that most recent configuration to restore it. This is
included in the following procedures.
Export the Current Configuration

1. In SCD, select Admin > Import/Export.
The Import/Export page opens.
2. Click Export Current Configuration.
The Export dialog box opens.
3. Enter a file name in the Name field and click OK.
The export displays in the list on the Import / Export page.
NOTE
The .sxp configuration file is saved locally at this location: C:\ProgramData\Avtec,
Inc\DMS\Exports.
Import a Previously Exported Configuration

IMPORTANT
l You must be logged out of Scout Manager to import a project.
l You must access the DMS webpage to perform an import:
http://<ipaddress>/DMS
l When you import a configuration file, this warning displays before you proceed: "Please note you will
lose ALL data currently in your configuration if you continue."
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 15

1. Export the current configuration using the previous steps.
This configuration file can be re-imported if the import of an earlier configuration in the steps below is not
satisfactory.
2. Click the import icon in the Import column in the row of the previous configuration you want to import.
A dialog box displays informing you that "you will lose ALL data currently in your configuration if you
continue."
NOTE
If any user is logged in to Scout Manager, a message displays that the import cannot proceed.
3. Click OK.
Scout imports the file you selected, which is stored here: C:\ProgramData\Avtec, Inc\DMS\Exports.
"Import created successfully" displays.
NOTE
You must deploy the configuration for the changes to appear on the DMS webpage. In Scout Manager,
however, the new configuration loads when you log in.
4. Open and lock the project in Scout Manager and view the imported project files.
5. Access SCD from within Scout Manager.
6. Under System > Deployments, click Deploy to deploy the imported configuration.
The Select Deployment Locations dialog appears. By default all locations are selected.
7. Uncheck the locations you do not want to deploy to or select Select All to clear all choices and then select
the locations you want. You can also use the search bar to find the location(s).
NOTE
Only locations you have permissions to deploy to display.
8. Click Deploy.
The deployment begins, the donut graph updates, and an entry is added to the list in the Deployments
section. Status colors include:
l Green – Successfully deployed
l Red – Errors exist
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 16

l Blue – In progress
l Gray – Unknown, disconnected
You can confirm that the installed components reflect the expected configuration by viewing the System
View page in DMS.
If the configuration you imported is not satisfactory, you can import the most recent configuration you created in
Step 1 above.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 17

SCD STATISTICAL REPORTS EXPORT API

SCD Statistical Reports Export API – Overview
The Scout Central Distributor (SCD) includes a web service Application Program Interface (API). This interface
contains a set of methods that allow your IT staff to export data from the Scout Data Store (SDS). This section
summarizes this feature and provides guidance on its use and maintenance.
The SCD Export Web Services interface uses Simple Object Access Protocol (SOAP), an HTTP/HTTPS-based protocol
and XML encoding format. You can execute the client application from any computer with network access to the
SCD, which contains the SDS, as long as the client application communicates to the SCD over port 80.
NOTES
n The SCD Export Web Services interface is unsecure and unencrypted. Install Scout Manager only on
servers without public access to avoid exposing data to external sources.
n Avtec recommends scheduling exports and archiving data to an external reporting database or data
store.
The customer client code supports the use of many programming languages to export data, including the following:
JAVA, C++, Ruby, scripting languages such as Python and PHP, and any .NET framework compliant language.
The interface also allows the purging of data to maximize performance.
Service Descriptions
The API deals with the following types of data:
l Dispatcher activity — dispatcher logins and logouts
l Endpoint activity — changes in endpoint states, such as Select, Unselect, Patch, and Mute
l Calls — details of a call, such as start and stop time, type, endpoint, ANI, and the identity of the dispatcher
The SCD Web export interface allows for the retrieval and purging of data.
Retrieval of Data
All data or data from a particular date range or Key ID is retrievable. Data is sorted by Key ID in ascending order. The
number of returned rows displays in the ReturnedCount field. The retrieval function returns a maximum of 5000
rows. If 5000 or more rows return, continue to call the function until less than 5000 rows return to ensure retrieval
of all data.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 19

Purging of Data
All data or data from a particular date range can be purged. There is no row limit with the purging function. Purging
permanently deletes the selected data.
NOTE
Purging cannot be undone. Data not backed up is permanently lost.
Web Service Metadata: Web Services Description Language (WSDL)

Use a WSDL to build the necessary proxy classes. The Web service interfaces exposes a WSDL at
http://localhost/dms/svcs/dataexport.svc?singlewsdl.
NOTE
If calling this URL from a machine other than the DMS server, replace "localhost" with the name of the server.
IDataExportService API Reference

A detailed reference of the method calls in the export API follows.
ExportDispatcherActivity
DispatcherActivity contains basic information on the activities of dispatchers.
Request Parmeters
toTime
Type: DateTime
Optional: Yes
Only items at this time or later return. If this value is omitted, all items (up to the toTime, if included) return.
fromTime
Type: DateTime
Optional: Yes
Only items at this time or later return. If this value is omitted, all items (beginning with the from Time, if included)
return.
LastId
Type: Integer
Optional: Yes
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 20

Enter the value of the last returned item from the LastId field when 5000 rows return. This prevents duplicate rows
being returned on subsequent calls to the function.
Response Fields
ReturnCount
Type: Integer
The number of items returned.
LastId
Type: Integer
ID of the last returned item when 5000 rows return.
Items
Type: List of EndpointActivity Structures
Data that describe a dispatcher's session at a given console.
DispatcherActivity
Name Type Description
CommScape Name STRING Name of the CommScape (Communication Landscape)
ConsoleMachineName STRING Operating System machine name of console
ConsoleName STRING Name of console
DispatcherFullName STRING Full name of dispatcher
DurationSecs INTEGER Duration of the session in seconds
Id INTEGER Internal Identifier
LoginTime DATETIME Timestamp of dispatcher login
LogoutTime DATETIME Timestamp of dispatcher logout
LogoutType STRING No logout due to system malfunction
Region Id <Reserved for future use>
Region Name <Reserved for future use>
SiteId INTEGER Internal identifier of console's site
SiteName STRING Name of the site
UserName STRING User name of dispatcher
ExportEndpointActivity
EndpointActivity contains information on endpoints and state changes.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 21

Request Parmeters
toTime
Type: DateTime
Optional: Yes
fromTime
Type: DateTime
Optional: Yes
return.
LastId
Type: Integer
Optional: Yes
Response Fields
ReturnCount
Type: Integer
LastId
Type: Integer
Items
Type: List of EndpointActivity Structures
Data that describes activity on an endpoint. The activity can be either a transmit on/off, in which case the
ActivityType is Transmit, or a change of state of the endpoint, in which case the ActivityType is EndpointState.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 22

EndpointActivity
ActivityData STRING Any user action
Possible values:
ActivityState STRING ActivityType=Transmit: Transmit

ActivityType=EndpointState: Select, Unselect, Mute, Patch, Hold,
Disconnect, Gone
Possible values:
ActivityType STRING
Transmit
EndpointState
ConsoleMachineName STRING Operating System machine name of console
DurationSecs INTEGER Duration of the session in seconds
EndTime DATETIME Timestamp of end of endpoint's state
EndpointName STRING Name of the endpoint
EndpointProfile STRING Endpoint profile for this endpoint
StartTime DATETIME Timestamp of start of endpoint state
UserName STRING User name of dispatcher
ExportCalls
The Calls table contains information on calls and associated dispatchers
Request Parmeters
toTime
Type: DateTime
Optional: Yes
fromTime
Type: DateTime
Optional: Yes
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 23

return.
LastId
Type: Integer
Optional: Yes
Response Fields
ReturnCount
Type: Integer
LastId
Type: Integer
Items
Type: List of Call Structures
Data that describe a call.
Call
ANI STRING ANI of the call
ANIAlias STRING ANI alias of the call
Data decoded from an inbound Dual-tone multi-frequency signaling
CallData STRING
(DTMF) call
CallDirection STRING Inbound or outbound
CallDurationSecs INTEGER Duration of the call in seconds
CallId INTEGER Call identifier
CallOwners CALLOWNER LIST Collection of CallOwner structures (see below)
Role created during the remote transfer of a call: role of new outbound
CallRole STRING
call is "Destination" and role of original call is "Source"
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 24


CallState STRING State of the call (Ringing, InProgress, Hold, EndDeselect, Clear, HoldXfr)
CallType STRING Type of call (GroupNormal, UnitToUnit, UnitAlert, Unknown)
EmergencyState STRING States include Normal and Emergency
EndTime DATETIME Timestamp of call's end
EndpointProfile STRING Endpoint profile for this endpoint
Escalation Time DATETIME Time the call is escalated
InProgressDurSecs INTEGER Duration in seconds call is InProgress
InProgressTime DATETIME Time the call becomes InProgress
Identifies the vpgate and endpoint (an instance) that creates a call. The
InstanceId INTEGER instance ID, Endpoint Name, and Call ID uniquely identify an individual
call.
Machine Name STRING Computer name of the VPGate that receives the call
Progress of an outbound call. Options include DialRead, FieldRinging,
OutboundCallProgress FieldBusy, FieldFastBusy, Connected, InitWaiting, XfrCommitError, and
XfrCommitComplete.
Type of ring information VPGate presents to the console. Options include
RingModifier STRING
None, Repeat, Orphaned, Transferring, and Transferred.
RingTimeDurSecs INTEGER Duration of time in seconds prior to answering call
Signal to Noise Ratio Value used when multiple copies of a radio call are
SNData INTEGER received at different endpoints. The call voter selects the call with the
greatest S/N ratio.
StartTime DATETIME Timestamp of start of endpoint state
TransferTime STRING Time a call is transferred, if applicable.
VPGate Name STRING The Scout Manager "friendly" name for the VPGate instance
Call Owner
CallID INTEGER Call identifier
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 25


Identifies the VPGate and endpoint (an instance) that creates a call; the instance
InstanceID INTEGER
ID, Endpoint Name, and Call ID uniquely identify an individual call
MachineName STRING Operating System machine name of console
Specifies the reason that the call changed ownership; valid values include New,
Reason Code STRING
Answer, Transfer, or Orphaned
StartTime DATETIME Timestamp when dispatcher answers call
User Name STRING Name of the user
PurgeDispatcherActivities
Purges all data or data from a particular date range for DispatcherActivity .
Request Parmeters
toTime
Type: DateTime
Optional: Yes
fromTime
Type: DateTime
Optional: Yes
return.
Response Field
PurgeDispatcherActivitiesResult
Type: Integer
The number of items deleted.
PurgeEndpointActivities
Purges all data or data from a particular date range for EndpointActivity .
Request Parmeters
toTime
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 26

Type: DateTime
Optional: Yes
fromTime
Type: DateTime
Optional: Yes
return.
Response Field
PurgeEndpointActivitiesResult
Type: Integer
PurgeCalls
Purges all data or data from a particular date range for Call data and associated CallOwners .
Request Parmeters
toTime
Type: DateTime
Optional: Yes
fromTime
Type: DateTime
Optional: Yes
return.
Response Field
PurgeCallsResult
Type: Integer
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 27

Examples: XML Request and Response

ExportDispatcherActivity
Request
<soapenv:Envelope>
<soapenv:Header/>
<soapenv:Body>
<tem:ExportDispatcherActivity>
<tem:fromTime>2015-04-01T12:00:00</tem:fromTime>
<tem:toTime>2015-04-03T12:00:00</tem:toTime>
<tem:lastId>0</tem:lastId>
</tem:ExportDispatcherActivity>
<soapenv:Body>
</soapenv:Envelope>
Response
<s:Envelope>
<s:Body>
<ExportDispatcherActivityResponse>
<ExportDispatcherActivityResult>
<a:Items>
<b:DispatcherActivity>
<b:ConsoleMachineName>b1vsim200</b:ConsoleMachineName>
<b:ConsoleName>b1vsim200</b:ConsoleName>
<b:DispatcherFullName>Eddie Smith</b:DispatcherFullName>
<b:DurationSecs>33895.657</b:DurationSecs>
<b:Id>10</b:Id>
<b:LoginTime>2015-04-02T06:03:22.047</b:LoginTime>
<b:LogoutTime>2015-04-02T15:28:17.703</b:LogoutTime>
<b:LogoutType>User</b:LogoutType>
<b:RegionId>1</b:RegionId>
<b:RegionName>Region1</b:RegionName>
<b:SiteId>1</b:SiteId>
<b:SiteName>Site1</b:SiteName>
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 28

<b:UserName>Eddie</b:UserName>
</b:DispatcherActivity>
</a:Items>
<a:LastId>15</a:LastId>
<a:ReturnCount>6</a:ReturnCount>
</ExportDispatcherActivityResult>
</ExportDispatcherActivityResponse>
</s:Body>
</s:Envelope>
ExportEndpointActivity
Request
<soapenv:Envelope>
<soapenv:Header/>
<soapenv:Body>
<tem:ExportEndpointActivity>
</tem:ExportEndpointActivity>
<soapenv:Body>
</soapenv:Envelope>
Response
<s:Envelope>
<s:Body>
<ExportEndpointActivityResponse>
<ExportDispatcherActivityResult>
<a:Items>
<b:EndpointActivity>
<b:ActivityData i:nil="true"/>
<b:ActivityState>Select</b:ActivityState>
<b:ActivityType>EndpointState</b:ActivityType>
<b:ConsoleMachineName>console1</b:ConsoleMachineName>
<b:ConsoleName>console1</b:ConsoleName>
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 29

<b:DispatcherFullName>Shaun Smith</b:DispatcherFullName>
<b:DurationSecs>21.696</b:DurationSecs>
<b:EndTime>2015-04-01T12:00:42.117</b:EndTime>
<b:EndpointName>dsip_173</b:EndpointName>
<b:EndpointProfile>dsip_173_profile</b:EndpointProfile>
<b:Id>3099</b:Id>
<b:RegionName>Region 1</b:RegionName>
<b:StartTime>2015-04-01T12:00:20.42</b:StartTime>
<b:UserName>Shaun</b:UserName>
</b:EndpointActivity>
</a:Items>
</ExportEndpointActivityResult>
</ExportEndpointActivityResponse>
</s:Body>
</s:Envelope>
ExportCalls
Request
<soapenv:Envelope>
<soapenv:Header/>
<soapenv:Body>
<tem:ExportCalls>
</tem:ExportCalls>
<soapenv:Body>
</soapenv:Envelope>
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 30

Response
<s:Envelope>
<s:Body>
<ExportCallsResponse>
<ExportCallsResult>
<a:Items>
<b:Call>
<b:ANI>30c9f77d-d6ed-4</b:ANI>
<b:ANIAlias>f6d66e7d-0931-4</b:ANIAlias>
<b:CallData>a16cab63-a61a-4</b:CallData>
<b:CallDirection>Inbound</b:CallDirection>
<b:CallDurationSecs>1.000</b:CallDurationSecs>
<b:>CallId>10</b:CallId>
<b:CallRole>Remote Xfr Source</b:CallRole>
<b:CallState>Clear</b:CallState>
<b:CallType>Unit Alert</b:CallType>
<b:EmergencyState>Normal</b:EmergencyState>
<b:EndTime i:nil="true"/>
<b:EndpointName>VPGate_Endpoint10</b:EndpointName>
<b:EndpointProfile>VPGate_EPProfile10</b:EndpointProfile>
<b:EscalationTime i:nil="true"/>
<b:Id>10</b:Id>
<b:InProgressDurSecs i:nil="true"/>
<b:InProgressTime i:nil="true"/>
<b:InstanceId>10</b:InstanceId>
<b:OutboundCallProgress>Field
Busy<b:OutboundCallProgress>
<b:RegionName>Master</b:RegionName>
<b:RingModifier>None</b:RingModifier>
<b:RingTimeDurSecs i:nil="true"/>
<b:SNData>196</b:SNData>
<b:StartTime>2015-04-10T14:31:52.67</b:StartTime>
<b:TransferTime i:nil="true"/>
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 31

</b:Call>
</a:Items>
</ExportCallsResult>
</ExportCallsResponse>
</s:Body>
</s:Envelope>
PurgeDispatcherActivities
Request
<soapenv:Envelope>
<soapenv:Header/>
<soapenv:Body>
<tem:PurgeDispatcherActivities>
</tem:PurgeDispatcherActivities>
<soapenv:Body>
</soapenv:Envelope>
Response
<s:Envelope>
<s:Body>
<PurgeDispatcherActivitiesResponse xmlns="http://tempuri.org/">
<PurgeDispatcherActivitiesResult>6</PurgeDispatcherActivities
Result>
</PurgeDispatcherActivitiesResponse>
</s:Body>
</s:Envelope>
PurgeEndpointActivities
Request
<soapenv:Envelope>
<soapenv:Header/>
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 32

<soapenv:Body>
<tem:PurgeEndpointActivities>
</tem:PurgeEndpointActivities>
<soapenv:Body>
</soapenv:Envelope>
Response
<s:Envelope>
<s:Body>
<PurgeEndpointActivitiesResponse xmlns="http://tempuri.org>
<PurgeEndpointActivitiesResult>2164</PurgeEndpointActivities
Result>
</PurgeEndpointActivitiesResponse>
</s:Body>
</s:Envelope>
PurgeCalls
Request
<soapenv:Envelope>
<soapenv:Header/>
<soapenv:Body>
<tem:PurgeCalls>
</tem:PurgeCalls>
<soapenv:Body>
</soapenv:Envelope>
Response
<s:Envelope>
<s:Body>
<PurgeCallsResponse xmlns="http://tempuri.org/">
<PurgeCallsResult>20</PurgeCallsResult>
</PurgeCallsResponse>
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 33

</s:Body>
</s:Envelope>
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 34

Example: Simple Object Access Protocol (SOAP)

There are multiple development languages and tools for testing and evaluation of the API. The following instructions
describe how to use SoapUI, a free SOAP Client application. SoapUI allows you to set up calls to the API, make test
calls, and examine the response.
NOTE
SoapUI calls into the DMS server and permanently deletes rows when calling the purge methods.
Creating a SoapUI Test Project

1. Download SoapUI from http://sourceforge.net/projects/soapui/.
2. Install the application.
3. In SoapUI, select New SOAP Project.
The New SOAP Project window displays.
4. Complete the following fields:
Field Description
Project Name Enter a name for the project.
Enter http://localhost/DMS/Svcs/DataExport.svc?singleWsdl
Initial WSDL
Note: If SoapUI is not running on the SCD server, replace "localhost" with the name of server on
which SCD resides.
Create Requests Select the checkbox to create sample requests.
5. Click OK.
The new Project displays in the right panel with a list of service calls.
6. Expand Export Calls to display the sample request.
7. Double-click Request 1.
The SoapUI Started window displays.
8. The test results display.
9. Enter input arguments for the following:
l fromTime
l toTime
l lastId
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 35

Example of the format to use when entering timestamps:

NOTES
l Enter time according to the Coordinated Universal Time (UTC) standard.
l For empty values, remove the surrounding tags.
10. Click the green arrow at the top left of the Request 1 window to run the export.
The results display in XML format.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 36

MOVING AN ACTIVE DMS TO ANOTHER

COMPUTER OVERVIEW
If moving the active Data Management Services (DMS) instance from one computer to another, follow the specific
steps outlined in this procedure to maintain the integrity of the data and to minimize any noticeable interruption in
Scout's operation. DMS includes the Scout Central Distributor (SCD) and the Scout Data Store (SDS). During the
transition, the project configuration data becomes static and Scout holds other operational data so that it is not lost.
Data held includes items backed up in the components' outgoing dead letter queues (DLQ).
Verify DMS Message Queue Status

1. Access Scout Central Distributor (SCD) > Admin > Queues > Monitoring.
2. Review the Alarm, Report, and Log Queues.
NOTE
If the run time is on the same machine, you should also extend the run time.
3. If any of the graphs show messages in the Main or Retry Queues, reschedule the DMS move.
NOTE
Do not move the DMS when messages exist in the Main or Retry Queues.
4. If any of the graphs show messages in the Failed Queue, click the re-queue message button for the graph.
The resubmitted messages enter, and then exit the main or retry queues. Continue with the steps for
moving the DMS when all message queues are empty.
Exit Scout Manager

1. In Scout Manager, select File > Exit.
2. Repeat for all open instances of Scout Manager.
NOTE
If the run time is on the SQL Express, you should also exit the run time.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 37

Stop the Message Queue Service

1. On SQL Express, access Control Panel > Administrative Tools > Services.
2. Select the Message Queuing Service.
3. In the left window, select the Stop the Service option.
4. If the Stop Other Services warning window opens, select Yes to stop dependent services.
The Windows Message Queuing service as well as any dependent Scout services stop.
Stop the DMS Application Pool

1. On SQL Express, access Control Panel > Administrative Tools > Internet Information Services (IIS)
Manager.
2. In the left window, expand the selections under the computer name.
3. Click Application Pools.
4. In the center window, select the DMS application pool.
5. In the Actions window on the right, select Stop.
The DMS application pool stops and a "stopped" indication displays over the DMS Application Pool icon and
the status changes to Stopped.
Back Up the DMS Database

Use these methods to back up the DMS database.
Back Up Using SQL Backup Master

Follow the steps in "Overview – Scout Data Store Database Backup and Restore" on Page 5 to back up the
database fully.
Back Up Using Query Express

1. Open Query Express by running QueryExpress.exe located at C:\Program Files (x86)\Avtec,
Inc\DMS\Support.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 38

2. Connect to the original DMS server.
a. Enter localhost\AVTECDMS in the Server field.
b. Select the SQL Server Authentication radio button.
c. Enter DMS_Backup as the Login name and P@ssword1 as the Password.
d. Click Connect.
3. Enter the following commands in the Query Express window:

Use DMS;
backup database DMS to DISK = 'DMS.bak'
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 39

4. Select both lines and click on the green Execute arrow.
NOTE
This places the backup file in the Program Files Directory in the following location:
...\Microsoft SQL Server\MSSQLXX.AVTECDMS\MSSQL\Backup.
Install DMS and All Prerequisites on the New DMS Computer

Use the information that follows to install DMS and all prerequisites on the new computer.
IMPORTANT
Install DMS and Avtec prerequisites from the same installation media to ensure that the versions match.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 40

Data Management Services (DMS) contains the Scout components used for system configuration and deployment,
diagnostics, and statistical reporting. DMS consists of Scout Central Distributor (SCD), Scout Manager (SM), and Scout
Data Store (SDS).
NOTES
l Determine the computer on which to install the Scout Central Distributor (SCD).
l SCD must be installed on a computer with a 64-bit operating system.
l Upon installation of DMS, the SQL Server error log file size is set to 100 MB unless it was defined prior to
DMS installation. To change the SQL Server error log file size at any time, follow the instructions in
Microsoft's SQL Server documentation.
l The default setting for the DMS Host Port is 80. The DMS web application does not start if another
application is using the default port.
DMS installation creates a DMS database to store and retrieve structured information. The installation includes the
following applications:
l Scout Central Distributor
l Scout Migration Utility
Installation enables the following applications:
l Internet Information Services (IIS) 7.5
l Microsoft Message Queuing (MSMQ)
Restore the DMS Database on the SQL Computer

The following are two methods that can be used to restore the DMS database.
Restore Using SQL Backup Master

If you backed up the database using SQL Backup Master, follow the steps in this Scout Suite Administration Guide,
"Restoring a Backup" section, to restore the database on the new computer.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 41

Restore Using Query Express

If you backed up the database using Query Express, perform the following to restore the database on the new
computer.
1. Copy the Query Express backup file from the original DMS computer to the same database location on the
new DMS computer:
...\Microsoft SQL Server\MSSQLXX.AVTECDMS\MSSQL\Backup\DMS.bak
2. Copy the Query Express tool from the original DMS computer to the new database location.
3. Open Query Express on the new DMS database location by clicking QueryExpress.exe located at
C:\Program Files (x86)\Avtec, Inc\DMS\Support.
4. Connect to the new database location on the DMS server.
b. Select the Windows Authentication radio button.
c. Click Connect.
5. Select master in the Database dropdown on the left navigation pane.
6. Enter the following command in the Query Express window:

restore database DMS From DISK = 'DMS.bak' WITH REPLACE
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 42

7. Select the line and click on the green Execute arrow.
Run the User Recovery Scripts on the Restored DMS Database

Run the following SQL commands, in the order shown, against the new DMS database using Query Express or
another third-party SQL tool.
USE DMS;
ALTER USER DMS_App WITH LOGIN = DMS_App
ALTER USER DMS_Admin WITH LOGIN = DMS_Admin
ALTER USER DMS_Backup WITH LOGIN = DMS_Backup
UPDATE Region SET HostName= 'XXX'
UPDATE BgdProcessorConfig SET [Enabled] = 0, TracingEnabled = 0 WHERE Id IN
(SELECT Id FROM BgdProcessorConfig_DbSizeBgdProcConfig)
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 43

Inside the quotes in the command above, replace XXX with the IP address of the new DMS computer.
Example Using QueryExpress

NOTE
Make sure to select DMS from the Database dropdown.
Recycle the DMS Application Pool on the DMS Computer

1. Access Control Panel > Administrative Tools > Internet Information Services (IIS) Manager.
5. In the Actions window on the right, select Recycle.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 44

Start the Message Queue Service

1. Access Control Panel > Administrative Tools > Services.
3. In the left window, select the Start the Service option.
Start Scout Manager for the DMS Computer

When starting the new Scout Manager instance, make sure to point the instance to the DMS computer.
1. Open Scout Manager.
The login window displays.
2. Enter the login credentials.
3. Click OK.
If the login fails, a DMS connection settings window displays.
NOTE
If the DMS window does not automatically display when the login fails, press Ctrl+O to display the DMS
connection settings.
4. Enter the machine name or network address of the DMS computer.

5. Click OK.
Verify the Address for SCD in Scout Manager

To enter the Scout Central Distributor Network Address:
1. In Scout Manager, select File > Lock Project.
2. On the Layout tab, double-click Scout Central Distributor.
Properties for Distributor Settings display. If the Properties window does not open automatically, select View
> Properties.
3. In the Network Address field, enter (or verify) the IP address or the name of the computer on which SCD
resides, or the domain name if using a Domain Name System (DNS).
NOTE
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 45

By default, the Network Address field populates with "0.0.0.0." This entry must be changed to respond
to SCD.
4. Select File > Save Project.
5. Select File > Unlock Project.
Deploy the Project via Deployments View

To deploy the project:
1. Access Scout Central Distributor by one of the following methods:
l In Scout Manager, click the Layout tab, and double-click Scout Central Distributor
l Launch a web browser and enter localhost/dms in the URL field
The Scout Central Distributor webpage displays.
2. Select System > Deployments.
The Deployment webpage displays.
3. Above the Location section, click .
NOTE
Only locations you have permissions to deploy to are displayed.
5. Click Deploy.
You can check the status of deployment to each component and re-deploy to a single component if needed:
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 46

1. On the System View page, click a component to open the detail window for that component.
2. Review Deployment information:
l Deploy State, with time-stamp for when the last state was recorded
l Last Deploy Start, with time-stamp for when the last deployment was started
3. Click Reset Deploy State to re-deploy to the component if needed.
Uninstall DMS from the Original Computer

To uninstall DMS from the Start menu:
1. Click Start > All Programs > Avtec, Inc > DMS > Uninstall Scout Central Distributor.
The DMS maintenance screen displays.
2. Select Uninstall.
3. Click Next.
The component's Setup screen displays.
4. Click Next.
A confirmation message displays when the uninstallation completes.
5. Click Finish.
6. Re-enable the Default IIS Site.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 47

MIGRATING FROM SQL EXPRESS TO

SQL SERVER STANDARD OR ENTERPRISE
When migrating the active Data Management Services (DMS) instance from a computer using SQL Server Express to
another using SQL Server Standard/Enterprise, follow the specific steps outlined in this procedure to maintain the
integrity of the data and to minimize any noticeable interruption in Scout's operation.
DMS includes the Scout Central Distributor (SCD) and the Scout Data Store (SDS). During the transition, the project
configuration data becomes static and Scout holds other operational data so that it is not lost. Data held includes
items backed up in the components' outgoing dead letter queues (DLQ).
The following steps must occur to migrate DMS to SQL Server Standard/Enterprise.
Verify DMS Message Queue Status

1. Access Scout Central Distributor (SCD) > Admin > Queues > Monitoring.
2. Review the Alarm, Report, and Log Queues.
NOTE
If the run time is on the same machine, you should also extend the run time.
3. If any of the graphs show messages in the Main or Retry Queues, reschedule the DMS move.
NOTE
Do not move the DMS when messages exist in the Main or Retry Queues.
4. If any of the graphs show messages in the Failed Queue, click the re-queue message button for the graph.
The resubmitted messages enter, and then exit the main or retry queues. Continue with the steps for
moving the DMS when all message queues are empty.
Exit Scout Manager

1. In Scout Manager, select File > Exit.
2. Repeat for all open instances of Scout Manager.
NOTE
If the run time is on the SQL Express, you should also exit the run time.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 49

Enable MSDTC on Local and Remote Systems

When you use SQL Server on a computer other than where DMS is installed, verify that Microsoft Distributed
Transaction Coordinator (MSDTC) is enabled on both computers so that they can communicate with each other.
To enable MSDTC:
1. On the computer where you plan to install DMS, open Windows > Control Panel > Administrative Tools >
Component Services.
2. Click Computers > My Computer > Distributed Transaction Coordinator.
3. Right-click Local DTC and click Properties.
4. Click the Security tab and select the following options:
l Network DTC Access, Allow Remote Clients, Allow Remote Administration

l Allow Inbound, Allow Outbound, No Authentication
l Enable XA Transactions, Enable SNA LU 6.2 Transactions
5. Click OK and then Yes.

6. On the other computer where you plan to install SQL Server, repeat steps 1-5.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 50

NOTE
Be sure that each computer can resolve the other computer's IP address by machine name. For example,
when MSDTC is enabled correctly, opening a command prompt and entering Ping <machine name>
results in a reply that contains the machine's IP address.
Upgrade Scout
Upgrade Scout to the most current version. See "Upgrading Scout 4.x to Scout 4.y" in "Scout Suite Installation and
Upgrade Guide."
Create a SQL Instance

On the computer with SQL Standard/Enterprise installed, perform the following steps:
1. Create a SQL database instance named AVTECDMS.
A configuration window opens.
2. In the Authentication Mode section, select Mixed Mode (SQL Server authentication and Windows
authentication).
NOTE
Avtec recommends having a separate database instance for the DMS connection and installing a named
instance for Scout Central Distributor.
Stop the Message Queue Service

1. On SQL Express, access Control Panel > Administrative Tools > Services.
3. In the left window, select the Stop the Service option.
4. If the Stop Other Services warning window opens, select Yes to stop dependent services.
The Windows Message Queuing service as well as any dependent Scout services stop.
Stop the DMS Application Pool

1. On SQL Express, access Control Panel > Administrative Tools > Internet Information Services (IIS)
Manager.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 51

5. In the Actions window on the right, select Stop.
The DMS application pool stops and a "stopped" indication displays over the DMS Application Pool icon and
the status changes to Stopped.
Back Up the DMS Database

Use these methods to back up the DMS database.
Back Up Using SQL Backup Master

Follow the steps in "Overview – Scout Data Store Database Backup and Restore" on Page 5 to back up the
database fully.
Back Up Using Query Express

Inc\DMS\Support.
2. Connect to the original DMS server.
b. Select the SQL Server Authentication radio button.
c. Enter DMS_Backup as the Login name and P@ssword1 as the Password.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 52

d. Click Connect.
3. Enter the following commands in the Query Express window:

Use DMS;
backup database DMS to DISK = 'DMS.bak'
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 53

4. Select both lines and click on the green Execute arrow.
NOTE
This places the backup file in the Program Files Directory in the following location:
...\Microsoft SQL Server\MSSQLXX.AVTECDMS\MSSQL\Backup.
Restore the DMS Database on the SQL Computer

The following are two methods that can be used to restore the DMS database.
Restore Using SQL Backup Master

If you backed up the database using SQL Backup Master, follow the steps in this Scout Suite Administration Guide,
"Restoring a Backup" section, to restore the database on the new computer.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 54

Restore Using Query Express

If you backed up the database using Query Express, perform the following to restore the database on the new
computer.
1. Copy the Query Express backup file from the original DMS computer to the same database location on the
new DMS computer:
...\Microsoft SQL Server\MSSQLXX.AVTECDMS\MSSQL\Backup\DMS.bak
2. Copy the Query Express tool from the original DMS computer to the new database location.
3. Open Query Express on the new DMS database location by clicking QueryExpress.exe located at
C:\Program Files (x86)\Avtec, Inc\DMS\Support.
4. Connect to the new database location on the DMS server.
b. Select the Windows Authentication radio button.
c. Click Connect.
5. Select master in the Database dropdown on the left navigation pane.
6. Enter the following command in the Query Express window:

restore database DMS From DISK = 'DMS.bak' WITH REPLACE
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 55

7. Select the line and click on the green Execute arrow.
Creating a SQL Login for a SQL User

On the computer where SQL Standard/Enterprise is installed, set up a user account with DBO permissions. Or, run
the following SQL script to automatically do it for you.
NOTE
Replace <Password> with a password for the user account.
CREATE LOGIN DMS_Admin WITH PASSWORD = '<Password>', CHECK_POLICY = OFF, DEFAULT_DATABASE

= DMS;
CREATE LOGIN DMS_App WITH PASSWORD = '<Password>', CHECK_POLICY = OFF, DEFAULT_DATABASE =
DMS;
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 56

CREATE LOGIN DMS_Backup WITH PASSWORD = '<Password>', CHECK_POLICY = OFF, DEFAULT_

DATABASE = DMS;
USE DMS;
EXEC sp_change_users_login 'Update_One', 'DMS_Admin','DMS_Admin'
EXEC sp_change_users_login 'Update_One', 'DMS_App','DMS_App'
EXEC sp_change_users_login 'Update_One', 'DMS_Backup','DMS_Backup'
UPDATE BgdProcessorConfig SET [Enabled] = 0, TracingEnabled = 0 WHERE Id IN (SELECT Id
FROM BgdProcessorConfig_DbSizeBgdProcConfig)
Edit web.config on the DMS Machine

On the computer that has Scout Manager installed, update web.config with the path to the new database
instance.
1. In a text editor, open C:\ProgramData\Avtec, Inc\DMS\WEB\web.config.
2. Update the connection strings (highlighted in bold type below) to point to the correct SQL server and update
the user ID and password used to connect to the SQL instance.
NOTE
The DMS_App password must match the sql:Password tag.
The DMS_Admin password must match the Sql:AdminPassword.
<appSettings>
<add key="sql:ServerName" value="<IP Address>\AVTECDMS" />
<add key="sql:DatabaseName" value="DMS" />
<add key="sql:AuthenticationType" value="SQL" />
<add key="sql:UserName" value="DMS_App" />
<add key="sql:Password" value="<Password>" />
<add key="sql:AdminUserName" value="DMS_ADMIN" />
<add key="sql:AdminPassword" value="<Password>" />
<add key="sql:DatabaseType" value="External" />
...
</appSettings>
3. Save the file.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 57

Start the DMS Application Pool

2. In the left window, expand the selections under the computer name and click Application Pools.
4. In the Actions window on the right, select Start.
The DMS application pool starts and a "started" indication displays over the DMS Application Pool icon and
the status changes to Started.
Start the Message Queue Service

1. Access Control Panel > Administrative Tools > Services.
3. In the left window, select the Start the Service option.
Start Scout Manager for the DMS Computer

When starting the new Scout Manager instance, make sure to point the instance to the DMS computer.
1. Open Scout Manager.
The login window displays.
2. Enter the login credentials.
3. Click OK.
If the login fails, a DMS connection settings window displays.
NOTE
If the DMS window does not automatically display when the login fails, press Ctrl+O to display the DMS
connection settings.
4. Enter the machine name or network address of the DMS computer.

5. Click OK.
Verify the Address for SCD in Scout Manager

To enter the Scout Central Distributor Network Address:
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 58

1. In Scout Manager, select File > Lock Project.
2. On the Layout tab, double-click Scout Central Distributor.
Properties for Distributor Settings display. If the Properties window does not open automatically, select View
> Properties.
3. In the Network Address field, enter (or verify) the IP address or the name of the computer on which SCD
resides, or the domain name if using a Domain Name System (DNS).
NOTE
By default, the Network Address field populates with "0.0.0.0." This entry must be changed to respond
to SCD.
4. Select File > Save Project.
5. Select File > Unlock Project.
Deploy the Project via Deployments View

To deploy the project:
1. Access Scout Central Distributor by one of the following methods:
l In Scout Manager, click the Layout tab, and double-click Scout Central Distributor
l Launch a web browser and enter localhost/dms in the URL field
The Scout Central Distributor webpage displays.
2. Select System > Deployments.
The Deployment webpage displays.
3. Above the Location section, click .
NOTE
Only locations you have permissions to deploy to are displayed.
5. Click Deploy.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 59

You can check the status of deployment to each component and re-deploy to a single component if needed:
1. On the System View page, click a component to open the detail window for that component.
2. Review Deployment information:
l Deploy State, with time-stamp for when the last state was recorded
l Last Deploy Start, with time-stamp for when the last deployment was started
3. Click Reset Deploy State to re-deploy to the component if needed.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 60

AVTEC'S LOCAL APPLICATION POOL

ACCOUNT
In Scout versions 4.0.21 and later, Avtec introduces a local application pool account to the local system to address a
known Microsoft issue with Internet Information Services (IIS) (MSDN Article ID: 2545850). This account addresses
the issue with no direct impact on the customer and is created and implemented upon installation or upgrade of the
DMS system.
The Avtec application pool account has:
n Limited access to specific Avtec Folders only
n No administrative rights
n Complex unchangeable password that is not given to the customer
n A sole purpose to maintain the Avtec DMS application pool
IIS User Group: IIS_IUSRS

As of Scout Version 4.7, all Scout components operate using Microsoft's Internet Information Services (IIS). During
installation, IIS creates the IIS_IUSRS group for authentication. This built-in group has access to all the necessary file
and system resources so that an account, when added to this group, can act as an application pool identity.
IMPORTANT
Do not delete the IIS_IUSRS group. Deleting this group renders Scout unusable.
Follow these steps to see the group:
1. Click the Windows Start button and type gpedit.msc in the search bar.
2. Select gpedit.msc from the list of search results.
The Local Group Policy Editor window opens.
3. Access Computer Configuration > Windows Settings > Security Settings > Local Policies > User Rights
Assignment.
4. In the User Rights Assignment folder, locate Impersonate a client after authentication and double-click the
file.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 61

l The Impersonate a client after authentication Properties window opens to the Local Security Setting
tab.
l IIS_IUSRS displays in the list of Administrators.
Replacing the Avtec Account within the Application Pool

Clients with more robust security protocols may want to replace the Avtec application pool account with a custom
application pool account that they can manage. Creating the account requires permissions for the DMS folder and
for MSMQ. Use the instructions that follow to set up permissions for the DMS Folder and MSMQ and to set up the IIS
application pool account.
NOTE
Administrative rights to the local system should never be assigned to this account.
The user must be a member of the following Windows user groups:
l Performance Log Users

l Performance Monitor Users
Setting up DMS Folder Permissions

1. In Windows Explorer, locate the following folder: C:\ProgramData\Avtec,Inc\DMS.
2. Right-click the DMS folder and select Properties.
3. Select the Security tab.
4. Click the Edit button.
5. Click the Add button.
6. In the pop-up window that opens, enter the name of the custom Windows account being configured.
7. Click OK.
8. In the Permissions list, Full control row, select the Allow checkbox.
9. Click OK.
Resolving File Permission Issues for Reports

After the application pool has been changed, an error may occur when a new report is run in DMS. The error occurs
because the report service directory has permissions for the original application pool account that created it. To fix
this issue, delete the ReportService folder.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 62

1. In Windows Explorer, enter %TEMP%.
2. If folder ReportService exists, delete it and all of its sub-directories and files. If the folder does not exist, skip
to step 3.
3. Run a new report under the new account to regenerate the ReportService folder with the correct
permissions.
Setting Up MSMQ Permissions

1. In the Windows Control Panel, select Administrative Tools.
2. Select Computer Management.
3. In the left side tree view, expand Services and Applications.
4. Expand Message Queuing.
5. Expand Private Queues.
The following queues display: avtec.alarm, avtec.alarm.deadletter, avtec.alarm.retry, avtec.log,

avtec.log.deadletter, avtec.log.retry, avtec.report, avtec.report.deadletter, avtec.report.retry,
dms/svcs/alarm.svc, dms/svcs/log.svc, and dms/svcs/report.svc.
6. Perform the following steps for each queue:
a. Right-click the queue and select Properties.
b. Select the Security tab.
c. Click the Add button.
d. In the pop-up window that opens, enter the name of the custom Windows account being configured.
e. Click OK.
f. Highlight the account in the Group or user names window.
g. In the Permissions for ... window, Full Control row, select the Allow checkbox.
h. Click OK.
Setting up the IIS Application Pool Account

1. In the Windows Control Panel, select Administrative Tools.
2. Select Computer Management.
3. In the left side tree view, expand Services and Application.
4. Open Internet Information Services (IIS) Manager.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 63

5. In the Connections window, expand the server tree and select Application Pools.
The Application Pools page displays.
6. Right-click DMS and select Advanced Settings... within the pop-up menu.
7. In the Process Model category, select Identity.
8. Click Browse.
The Application Pool Identity window displays.
9. Select Custom account and click Set...
The Set Credentials window displays.
10. Enter your user name and password in the credential dialogue box and click OK.
NOTE
The User name and Password needs to be an existing user name and password within the Windows
system.
11. The Application Pool Identity window returns. Click OK.
12. In the Advance Settings window, set Load User Profile to True and click OK.
13. From the Internet Information Service (IIS) Manager Application, click File then Exit to close the window.
14. Open a Command Prompt (cmd.exe) and Run as administrator.
The Administrator:cmd window displays.
15. Type IISReset and press Enter.
16. Close the Command Prompt.
NOTE
Any IIS manual install or uninstall requires a DMS repair.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 64

DMS WEB CONFIGURATION SETTINGS

The DMS system— including the website, the background processing, MSMQ (message queuing) interfaces, and
database management interfaces —is an IIS application. For most small- to moderate-sized Scout installations, the
“out of the box” settings run DMS properly. However, for large and enterprise installations, users might need to
tune the configuration further.
The web.config file is an XML formatted file that contains the configuration data for an IIS application, in this case,
DMS. The configuration settings shown below originate from two places:
l Predetermined values included in the compiled code – The settings that are commented out (embedded
between  tags) have predetermined values that come from the code. However, to override the
predetermined values, remove the comment tags and the value from the web.config file takes precedence.
l Settings included in the web.config file (located in the C:\ProgramData\Avtec, Inc.\DMS\Web directory) –
The DMS configuration settings that are not commented out are only found in the web.config file (that is,
there are no predetermined values compiled into the code).
To tweak the DMS configuration, use the settings that are in the section wrapped in the following tags:
<appSettings></appSettings>. The following two tables identify the settings in the <appSettings>
section and provide the setting name, its description, the reason to change the setting, and the value or default
value for the setting. The first table shows uncommented settings. The second table shows the commented settings
and includes a column that shows the predetermined value.
Uncommented Settings
Setting Description Why Change? Value
sql:ServerName The server name for the Change if using an external .\AVTECDMS
SQL Server database. database or one that was
DMS should use a named pre-installed before NOTE: The “.” is a shortcut
instance for SQL Server. installing DMS. for “localhost.”
The server name is made
up of the machine name
and the instance name
(separated with a “\”).
sql:DatabaseName The name of the SQL Change if the database DMS
Server database that is name is not DMS.
used for DMS.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 65


sql:AuthenticationType SQL Server allows two Change if the SQL SQL
types of authentication. installation uses
DMS was written to use "Integrated" security.
SQL-based authentication.
If you need to use
integrated-based security,
you must have a DBA
work with Avtec to insure
appropriate security
settings.
sql:UserName The SQL user who makes Change if a different user DMS_App
the connection to SQL and ID (not DMS_App) is the
performs table selects, user ID that connects to the
inserts, updates, and DMS database.
deletes.
sql:AdminUserName The SQL administrator Change if an alternate user ""
user who ID (other than "SA") is the
creates/updates/deletes ID for handling database
database objects. By maintenance tasks invoked
default, this is the “SA” by DMS.
user.
sql:Password The password for the SQL Change if the password for P@ssword1
user referenced above. "sql:UserName" changed.
sql:AdminPassword The password for the SQL Change if the password for ""
administrator user "SA" user
referenced above. During ("sql:AdminUserName")
installation, Avtec sets changed.
the SA password for this
instance of SQL which is
why this is empty by
default
sql:DatabaseType Internal database Change this valaue to Internal
indicates that this is an "External" if the SQL
SQL Express database database is on a different
that was installed along machine from DMS or if
with the DMS software. SQL was installed
External database externally to the DMS
indicates that this is a installation software.
standalone version of SQL
that was installed by the
customer prior to
installing DMS.
dms:MasterHostName Used internally to identify Do not change this setting ""
the DMS to the various unless Avtec, Inc. requests
components. the change.
dms:MasterPort Used internally to allow Do not change this setting ""
communications between unless Avtec, Inc. requests
components and DMS. the change.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 66


dms:DeployerThreadCount The number of threads Change if you have multi- 0
used for deployment. This threaded cores and want to
number is computed take advantage of all
based on the number of logical cores.
physical CPUs in the
system (Number of CPUs
* .80). For example, if you
have four multi-threaded
CPUs the computation
allows three threads to be
created for deployments.
dms:SnmpThreadCount The number of threads If the DMS server has 5
reserved to process SNMP multi-threaded CPUs,
traffic. consider increasing this
value to allow more SNMP
processing to occur
simultaneously.
dms:DmsAuthModeOverrideInternal The DMS system handles Do not change this setting false
internal authorization via unless Avtec, Inc. requests
a proprietary method. the change.
dms:BgdProcessingEnabled DMS performs several Do not change this setting true
background processes unless Avtec, Inc. requests
(database backups, the change.
deployments, and so on).
If this is set to false, all
background processing
stops, basically disabling
DMS except for the web
pages.
dms:BgdTimerIntvlSecs The number of seconds Do not change this setting 5
between polling during unless Avtec, Inc. requests
which background the change.
services run.
dms:BgdTracingEnabled Enables very detailed Do not change this setting false
logging for background unless Avtec, Inc. requests
processes. the change.
dms:ScannerEnabled The Scanner is the Do not change this setting true
background process that unless Avtec, Inc. requests
allows DMS to determine the change.
the status of the
components.
dms:ScannerProcIntvlSecs The number of seconds Do not change this setting 10
between finishing one unless Avtec, Inc. requests
component scan and the change.
starting the next one.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 67


dms:DbMaintenanceEnabled This enables DMS to do When using an external true
several database database, set this value to
maintenance procedures "false."
such as backups,
archiving, and so on. If
using an external
database, a SQL Server
DBA should set up
procedures for backups
and archiving.
dms:DbMaintenanceProcIntvlSecs The number of seconds Do not change this setting 60
between polling for DB unless Avtec, Inc. requests
Maintenance routines to the change.
run.
dms:DbMaintenanceMaxDbSizeMb The maximum size to Do not change this setting 0
allow the database to unless Avtec, Inc. requests
grow before archiving the change.
older data. Because SQL
Express is limited to 10
GB, this value is set to 8
GB internally.
dms:ContactBatchSize The number of contacts to Do not change this setting 30000
process in a single batch. unless Avtec, Inc. requests
the change.
dms:ScoutMgrVersionCheckOverride This value forces DMS to Do not change this setting true
check the Scout Manager unless Avtec, Inc. requests
version for compatibility the change.
with DMS when a user
logs into Scout Manager.
webpages:Version For internal use only. Do not change this setting 3.0.0.0
unless Avtec, Inc. requests
the change.
webpages:Enabled For internal use only. Do not change this setting false
the change.
ClientValidationEnabled For internal use only. Do not change this setting true
the change.
UnobtrusiveJavaScriptEnabled For internal use only. Do not change this setting true
the change.
log4net.Internal.Debug The logger uses this Do not change this setting true
setting to log internal logs unless Avtec, Inc. requests
at the debug level. the change.
dms:ADSyncLogFilesMaxCount The maximum number of If you needed more/less 30
log files to keep before log files kept for AD (Active
deleting the oldest one. Directory) synchronization.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 68

Commented Settings
The following settings are commented out in the web.config file. To change these settings, remove the comments
and set an appropriate value.
Setting Description Why Change? Default Value

dms:AuthServerRetryIntervalSecs The number of seconds If the connection to AD is 300
between retrying to connect not stable or if the AD server
to the Active Directory (AD) is located on a WAN with
server if DMS is unable to high latency.
connect.
dms:TokenExpirationMins The number of minutes Set this if the customer has 10080 (7 days)
before the authorization a policy for authorization
token expires. tokens that is different from
a 1-week token.
dms:DeployWcfTimeoutSecs The number of seconds that Change this setting if you 5
DMS attempts to see the following error in
communicate with a the DMS log:
component before timing
out. On slower networks or CommunicationException
across WAN networks, creating WcfClientBuilder
change this setting to client for ….
reflect the slowness of the
network. Microsoft suggests starting
at 30 seconds and slowly
moving up to 300 seconds (5
minutes).
dms:ScannerWcfTimeoutSecs The number of seconds that Change if the customer’s 5
the background processor network experiences a lot of
attempts to communicate latency between
with a component before components and the DMS
timing out. server.
dms:KeepAliveExpirationSecs The number of seconds a Change if the customer’s 1200 (20 minutes)
logged-in user can remain corporate policy allows
idle. users to remain idle for
either longer than or less
than 20 minutes before the
system logs them out.
dms:AlarmQueue_ The number of minutes to Do not change this setting 5.0
RetryCycleDelayMins wait before retrying to unless Avtec, Inc. requests
receive an alarm message the change.
from the MSMQ message
handler.
dms:AlarmQueue_ The number of times DMS Do not change this setting 1440
MaxRetryCycles retries to get a message unless Avtec, Inc. requests
from the MSMQ alarm the change.
queue.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 69


dms:AlarmQueue_ The maximum number of Do not change this setting 22 (SQL Max Pool Size
MaxConcurrentCalls concurrent alarm queue unless Avtec, Inc. requests [default = 100] * 0.90 * Max
calls. the change. Concurrent Call Percent
[default = 0.25])
The default value (22)
comes from the calculation
shown in the Default Value
column. To override the
calculation, insert a value
for this setting.
dms:AlarmQueue_Disabled Set to true to disable the Do not change this setting false
alarm queue. unless Avtec, Inc. requests
the change.
dms:LogQueue_ The number of minutes to Do not change this setting 5.0
receive a log message from the change.
the MSMQ message
handler.
dms:LogQueue_MaxRetryCycles The number of times DMS Do not change this setting 1440
retries to get a message unless Avtec, Inc. requests
from the MSMQ log queue. the change.
dms:LogQueue_ The maximum number of Do not change this setting 22 (SQL Max Pool Size
MaxConcurrentCalls concurrent log queue calls. unless Avtec, Inc. requests [default = 100] * 0.90 * Max
the change. Concurrent Call Percent
The default value (22) [default = 0.25])
for this setting.
dms:LogQueue_Disabled Set to true to disable the Do not change this setting false
log queue. unless Avtec, Inc. requests
the change.
dms:ReportQueue_ The number of minutes to Do not change this setting 5.0
receive a report message the change.
from the MSMQ message
handler.
dms:ReportQueue_ The number of times DMS Do not change this setting 1440
MaxRetryCycles retries to get a message unless Avtec, Inc. requests
from the MSMQ report the change.
queue.
dms:ReportQueue_ The maximum number of Do not change this setting 22 (SQL Max Pool Size
MaxConcurrentCalls concurrent report queue unless Avtec, Inc. requests [default = 100] * 0.90 * Max
calls. the change. Concurrent Call Percent
[default = 0.25])
The default value (22)
for this setting.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 70


dms:ReportQueue_Disabled Set to true to disable the Do not change this setting false
report queue. unless Avtec, Inc. requests
the change.
sqlProvider:MaxPoolSize The number of When there are more than 100
simultaneous SQL Server 200 components, increase
connections. this value. Avtec uses a
value of 250 for 800
consoles.
NOTE: Works in conjunction

with these properties:
sqlProvider:MinPoolSize and
sqlProvider:Pooling.
According to Microsoft, the
three settings work as a
group.
sqlProvider:MinPoolSize The number of SQL Server Set this value when the 1
connections that DMS keeps sqlProvider:MaxPoolSize is
open continuously. set.
NOTE: Works in conjunction

sqlProvider:MaxPoolSize and
sqlProvider:Pooling.
group.
sqlProvider:Pooling Allows the SQL connections Set this value when the true
to be pooled. Setting this to sqlProvider:MaxPoolSize is
false is the equivalent of set.
setting the MaxPoolSize
to 1. NOTE: Works in conjunction
sqlProvider:MaxPoolSize and
sqlProvider:MinPoolSize.
group.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 71

TROUBLESHOOTING
MSMQ Messages Fail to Reach DMS
When Scout services stop, Scout generates alarms to DMS indicating that the services have stopped. In Scout
Versions 4.0 and later, alarms travel from Scout components to DMS via Microsoft Message Queuing (MSMQ). Even
if the MSMQ service is running and the proper port is opened by the service, the messages can fail to populate
Scout's database, SDS. This is caused by a known Microsoft issue; the issue has an available Microsoft hotfix.
Issue: MSMQ service might not send or receive messages after you restart a computer that is running Windows 7,
Windows Server 2008 R2, Windows Vista, or Windows Server 2008.
Symptoms: After you restart a computer that is running Windows 7, Windows Vista, Windows Server 2008, or
Windows Server 2008 R2, the Microsoft Message Queuing (MSMQ) service might be unable to send or receive
messages. Therefore, messages have a Waiting to connect state in the outgoing queue of the sending computers.
Cause: This issue occurs because the MSMQ service binds itself to the loopback address (127.0.0.1).
Resolution: See the following Microsoft support link for more information and to download the hotfix:
https://support.microsoft.com/en-us/kb/2554746.
DMS Timeout Limit

A Scout Manager project can only be logged into continuously for seven days. After the seventh day, DMS
disconnects from the project. User must restart Scout Manager.
Modifying Registry Setting ServicePipeTimeout

By default, Windows waits 30 seconds for a service to respond. In some cases, factors such as large configurations,
technical restrictions, or performance issues may require a longer wait time. To account for this potential time
increase, the default time-out value for all services in the registry can be increased.
Issue: During system startup, one or more Avtec Services may fail to start automatically.
Symptoms: Windows Event Log shows the following message: “Timeout (30000 milliseconds) waiting for the
{ServiceName} service to connect."
Cause: The Microsoft Windows Service Control Manager controls the state (i.e., started, stopped, paused, etc.) of all
installed Windows services. By default, the Service Control Manager waits 30000 milliseconds (30 seconds) for a
service to respond. However, certain configurations, technical restrictions, or performance issues may result in the
service taking longer than 30 seconds to start and report ready to the Service Control Manager.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 73

Resolution: Increase the ServicesPipeTimeout value in the registry.
NOTE
Avtec recommends making a registry backup before proceeding. Use caution and follow these steps exactly.
To modify the registry setting:
1. In Windows, click Start > Run, type regedit, and click OK.
2. Locate and click the following registry subkey:
l HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control
3. In the right pane, locate the ServicesPipeTimeout entry.
NOTE
If the ServicesPipeTimeout entry does not exist, you must create it. To do this, follow these steps:
1. On the Edit menu, point to New, and click DWORD Value.
2. Type ServicesPipeTimeout and press Enter.
4. Right-click ServicesPipeTimeout, and click Modify.
5. Click Decimal, type 60000, and click OK.
This value represents the time in milliseconds before a service times out.
6. Restart the computer.
If 60 seconds is not enough time, try 120000 (120s). If the service still does not start, contact Avtec Technical
Support.
Incorrect Install Fail Message

Issue: During a {Scout component} install, a recent change to a Microsoft security feature halts the installation
process with the following message:
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 74

Background: If there is a Scout component installation already running, this message is accurate. However, in this
newly discovered scenario, the message is returned but is not accurately defining the problem.
Cause: Microsoft Security Essentials on Windows 7 systems and Windows Defender on Windows 10 systems flags a
portion of our installation routine as a virus or potentially unwanted software. This change in behavior is a result of a
recent update (April 2017) to the Security Essentials and Windows Defender definitions that Microsoft updates
periodically.
Solution:Disable Microsoft Security Essentials on all Windows 7 systems and disable Windows Defender on all
Windows 10 systems to allow the Scout component installation to complete successfully.
SQL Service not Running

Issue: When attempting to log in to Scout Manager, a "Scout Manager failed the logon" error message displays.
Background: In some cases, the SQL Service might fail to initiate on the computer that has Scout Manager installed.
Solution: Perform the following to troubleshoot this issue on the computer that has Scout Manager installed:
1. Navigate to the DMS webpage and attempt to log in.

l If you can log in, proceed to Step 3.
l If you cannot log in using valid credentials, proceed to the next step.
NOTE
Access the DMS webpage directly in a browser: http://<SCD hostname or IP address>/dms. If
you installed DMS on the same machine you are using, then specify your local host:
http://localhost/dms.
2. Open Scout Manager, press Ctrl + O on the Scout Manager Login dialog box, and then verify that the DMS
Host Name value is accurate.
l If the value is accurate for the computer that has Scout Manager installed, continue to the next step.
l If the value is not accurate, update the values, click Ok, and then attempt to log in via the Scout
Manager Login dialog box. Continue to the next step if you still receive the error message after
updating these values.
4. In the left pane, expand the selections under the computer name.
5. Click Application Pools and then verify that the Status column displays Started for the DMS application pool.
l If the Status column displays Started, proceed to the next step.
l If the Status column displays any other status, select the DMS application pool, click Start from the
Actions pane on the right, and then attempt to open and log in to Scout Manager to confirm whether
this resolves the error. If the error still displays, proceed to the next step.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 75

6. Access Windows Task Manager > Services and verify that the Status column displays Running for the
MSSQL$AVTECDMS service.
l If the Status column displays Running, continue to the next step.
l If the Status column displays a value other than Running, right-click the MSSQL$AVTECDMS service,
select Start Service, and then attempt to open and log in to Scout Manager to confirm this resolves
the error. If the error still displays, proceed to the next step.
Inc\DMS\Support and verify that you can connect to the localhost\AVTECDMS database.
If you cannot access the DMS database in Query Express, contact Avtec Customer Support for further
assistance.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 76

WORKING WITH SNMP

Understanding SNMP Traps for Alarms and Events
Scout Manager can be configured to send SNMP (Simple Network Management Protocol) messages, called traps, for
its alarms and events. When the various Scout applications generate alarms and events, Scout Central Distributor
(SCD) catalogs them to aid Network Administrators who review messages using an integrated management console
for multiple types of equipment.
NOTE
Scout supports SNMP Version 2.
Scout MIBs
Avtec supplies the following Management Information Bases (MIBs) to provide management data variables for the
SNMP traps. Users with System Administrator permission can locate the MIBs in Scout Central Distributor (SCD) by
selecting Admin > SNMP.
l Avtec MIB – Formerly called the Avtec General MIB, the Avtec MIB is the enterprise-level MIB for Avtec, Inc.
As the top-level MIB for Avtec products, the Avtec MIB references definitions used by the Scout Product
Suite as well as those used by Avtec’s DSPatchNET product. For Scout, the products include the following:
Console, Call Voter, VPGate, Trunking Gateway, Frontier, Avtec Routing Controller (ARC), Avtec SIP Proxy, and
Scout Central Distributor (SCD). For DSPatchNET, the notification objects in the MIB can be used by any
platform under DSPatchNET.
l Avtec Scout MIB – The Avtec Scout MIB is the MIB module for the Scout Product Suite. The Scout Product
Suite includes the following applications: Console, Call Voter, VPGate, Trunking Gateway, Frontier, ARC, Avtec
SIP Proxy, and Scout Central Distributor (SCD).
Configuring Access to SNMP Managers

System administrators can configure SCD to send event and alarm details to third-party SNMP trap managers. Use
the SNMP Manager settings page in Scout Central Distributor (SCD) to configure SNMP managers and to download
MIB files. See Understanding SNMP Traps for Alarms and Events for more information.
NOTE
SCD users with System Administrator permission can access the SNMP Manager Settings page to configure up
to five SNMP managers with Scout to send traps for alarms and events.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 77

1. In SCD, click Admin > SNMP.
2. Click Add SNMP Manager.
The Add SNMP Manager dialog box displays.
3. Enter a Name to identify it.
4. Enter a Description.
5. In the Host Name (IP Address) field, enter the host name or IP address.
NOTE
Configure each SNMP manager with a unique IP address to prevent receiving duplicate alarms and
events.
6. Enter the Port where the SNMP manager is installed.
7. In the Active field, select true (SNMP manager receives alarms) or false (SNMP manager does not receive
alarms).
8. Configure the type of information that the SNMP manager receives by selecting the appropriate Filter
checkboxes. Choices include:
l Events
l Low Alarms
l Minor Alarms
l Major Alarms
NOTE
Select multiple checkboxes, as needed. Without filters selected, the SNMP manager does not receive
any events and alarms.
9. Click Save.
The SNMP manager is configured to receive data and displays in the list.
10. Click Edit to make changes or click Delete to delete the SNMP manager.
Scout Manager also provides easy access to download MIB files for use with your configured trap managers.
Showing or Hiding Inactive SNMP Managers

When Scout Manager includes configured SNMP managers that are designated inactive, follow this procedure to
toggle between showing or hiding inactive SNMP managers.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 78


2. Click Show Inactive Managers to show or hide any inactive SNMP managers.
NOTE
The button label always reads "Show Inactive Managers." When the button appears depressed, the inactive
managers show in the list.
Understanding SNMP Data

Scout Central Distributor provides easy access to the Scout and Avtec MIB files for use with the configured SNMP
trap managers.
NOTE
SCD users with System Administrator permission can access the SNMP Manager Settings page to configure up
to five SNMP Managers with Scout, to download traps for alarms and events.
Downloading Scout and Avtec Mibs

2. Click Download Scout MIB and Download Avtec MIB to download the files.
In each case, the File Download window displays the AvtecScout.mib file and the AvtecMib.mib file.
3. Click Save to save the files on your computer to use the information with configured SNMP managers.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 79

Identifying Scout MIB Variables

Scout events and alarms use an OID (object identifier) to map the event or alarm details from the Avtec Scout MIB
(Management Information Base) collection of hierarchical information to a third-party SNMP trap manager. As an
example, consider the OID 1.3.6.1.4.1.16591.3.2.5.1.0. Each section of the number represents a specific category of
information from the MIB.
n 1.3.6.1.4.1.16591.3.2.5.1.0
n 1 (iso) 3 (org) 6 (dod) 1 (Internet) 4 (private) 1 (enterprises) 16591 (avtecinc) 3 (scout) 2 (diagnostic logger) 5
(diagAlarmInfo) 1 (diagAlarmCode) 0 (index to this one piece of data)
The eleventh position in the OID is a variable, from 1 to 8, that provides details for the Scout alarm or event. (The
eleventh position shows in bold in the above example and in the OID numbers in the table below.) The table that
follows identifies the possible variables and their meanings.
Variable Variable
OID Variable Meaning and Description
Number Display
Alarm Code – The diagnostics numerical code that
defines the event or alarm for the Scout service
1 diagAlarmCode 1.3.6.1.4.1.16591.3.2.5.1.0 that created it. See Events and Alarms. Alarm
codes are sorted numerically within each Scout
service.
Scout Component – The name of the Scout service

2 diagProductName 1.3.6.1.4.1.16591.3.2.5.2.0 that reported the event or alarm. See Events and
Alarms and locate the Scout service.
Source ID – The name of the computer that

created the event or alarm. For VPGate alarms
the Source ID also shows the endpoint name. For
example, if the Source ID displays CS-LAB-
3 diagSourceId 1.3.6.1.4.1.16591.3.2.5.3.0 VPGate:cssi_unit100, CS-LAB-VPGate is the
Windows computer name and cssi_unit100 is the
endpoint name. The Alarm History page also uses
Source ID to identify the origin of an event or
alarm.
Date and Time – The date and time that the

computer set the event or alarm. The Alarm
4 diagAlarmSetDateTime 1.3.6.1.4.1.16591.3.2.5.4.0
History page also uses Date/Time to identify
when the computer set the event or alarm.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 80

Variable Variable
OID Variable Meaning and Description
Number Display
Type – The data that defines the incident as an
alarm or an event. For example, a lost connection
5 diagAlarmType 1.3.6.1.4.1.16591.3.2.5.5.0 to an endpoint is an alarm, while a dispatcher
logging out of a console is an event. See Events
and Alarms for incident type definitions.
Incident Action – The status of the event or alarm.

Events display the word "Event" while alarms
indicate one of three statuses: "Set," "Clear," or
6 diagAction 1.3.6.1.4.1.16591.3.2.5.6.0 "ACK." The Alarm History page also uses Incident
to define the status of an event or alarm. For
more information on statuses see the Alarm
History Report details.
Description – A brief explanation of the event or
7 diagAlarmCodeDescription 1.3.6.1.4.1.16591.3.2.5.7.0 alarm. See Events and Alarms and the Alarm
History page for descriptions of incidents.
Severity – The strength of the incident defined as
"Low," "Minor," or "Major." See Events and
8 diagAlarmCodeSeverity 1.3.6.1.4.1.16591.3.2.5.8.0
Alarms and the Alarm History page for severity
indications.
The image that follows shows an example SNMP trap from a third-party SNMP manager. Note that in this example
the OIDs do not display in order and that all information is not present.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 81

NOTE
When viewing the Avtec Scout MIB an additional OID identifies an alarm notification. The OID is
1.3.6.1.4.1.16591.3.2.6.1 and the last two digits represent 6 (diagNotifications) 1 (diagAlarmInfoNotification).
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 82

ALARMS AND EVENTS

The following tables summarize alarms and events by Scout Component that display in Scout Central Distributor on
the Alarms pages. Some corrective actions are included for troubleshooting.
To view alarms:
l In Scout Manager, on the Layout tab, double-click Scout Central Distributor.
l Click the Alarms tab to see new and active alarms and alarm history. Events display on the Alarm History
page.
NOTE
Common alarms and events are listed first and may apply to several components. Remaining tables display in
alphabetical order.
Common Alarms and Events

Alarm
Description Severity Detail Corrective Action
Code
Component generating alarm Configure the component or
990000 No configuration: {0} Major
not configured. remove it from the project.
Unexpected error for the
Internal error. Contact Avtec
990001 Unexpected error: {0} Major component generating this
Customer Support.
alarm.
Unable to connect to DMS Unable to connect to DMS Verify the IP address for the SCD
990002 Major
server at {0}. Error details: {1} server. in Scout Manager is correct.
Unspecified error while Confirm that two different DMS
990003 Error during initialization: {0} Major initializing the component systems are not deploying to the
generating this alarm. same component (IP Address).
Component unable to log in to A component's internal login Internal error. Contact Avtec
990004 Minor
DMS. mechanism failed at start up. Customer Support.
l Check IP address in
configuration for that
component.
A Scout component (console,
Scout Central Distributor is Check to see if component
VPGate, Frontier, etc.) is not l
990005 unable to contact this Major
responding to a poll from service is running.
component.
DMS.
l Check network
connectivity between DMS
and component.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 83

Event
Code
A software exception has Internal error. Contact Avtec
995000 Software exception. Low
occurred. Customer Support.
Logging setting turned off by Avtec recommends turning on
995001 Logging terminated by user. Low
user. logging.
Determine which third-party
995002 Port Conflict: {0}. Major A port conflict exists. application is causing the conflict
and reconfigure its port.
DMS host name changed from Confirm that Scout Manager
995003 Low DMS host changed by user.
{0} to {1}. reflects change and redeploy.
Audio Bridge Alarms and Events

Alarm
Code
An Audio Bridge license is not
available. The grace period
For a hardware key, verify that the
No license available; grace started for existing patches
130000 Minor key is inserted. Otherwise, connect
period started. and the Audio Bridge service
a license key as soon as possible.
will not create any new
patches.
The grace period expired and
Audio Bridge requests have For a hardware key, verify that the
all active patches expired and
130001 been terminated due to its Major key is inserted. Otherwise, connect
Audio Bridge will not create
grace period expiring. a license key as soon as possible.
any new patches.
The Audio Bridge service does
No license available; Audio not have a license key For a hardware key, verify that the
130002 Bridge cannot accept any Major available when the service key is inserted. Otherwise, connect
requests. starts. Audio Bridge will not a license key as soon as possible.
create patches.
Event
Code
135000 Audio Bridge service started. Low Audio Bridge service started. No corrective action necessary.
135001 Audio Bridge service stopped. Major Audio Bridge service stopped. Restart the service.
No license is available and a
Audio Bridge has a specific grace period started for the
amount of time left in its Audio Bridge service. The
135002 Major Obtain additional licenses.
grace period before it will end message shows the amount
all patches. of time left in the grace
period.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 84

A requested Audio Bridge

patch did not get built by
Audio Bridge server. The
message provides the IP
address for the VPGate server For each failure reason listed,
that hosts the patch endpoint, follow the suggested corrective
the names of the patch action:
participant endpoints, and the • Server Shutdown – Restart the
specific reason for the failure. Audio Bridge service.
Failure reasons include: • No Available License – Obtain
• Server Shutdown – Audio additional licenses.
Audio Bridge patch failure for Bridge service stopped
135003 a specific patch for a specific Low • Socket Disconnect – Verify the
reason. • No Available License – Lack network connection or verify the
of available Audio Bridge VPGate endpoint is in an active
licenses state.
• Socket Disconnect – • Endpoint Unavailable – Verify

Network issue or VPGate that the endpoint is in an active
endpoint enters Gone state state.
• Endpoint Unavailable – One • Internal Error – See the Scout

of the patch participant System Administrator.
endpoints is not available
• Internal Error – Out of

memory or out of sockets
The requested Audio Bridge
patch was created
successfully. The message
provides the IP address for
Audio Bridge patch creation
135004 Low the VPGate server that hosts No corrective action necessary.
success for a specific patch.
the patch endpoint, the
names of the patch
participant endpoints, and the
specific reason for the failure.
Avtec Routing Controller (ARC) Alarms and Events

Event
Code
RoutingController service
105000 Low ARC service started. No corrective action necessary.
Started.
RoutingController service
105001 Major ARC service stopped. Restart the service.
Stopped.
Endpoint registered: Name= Endpoint registered: Name={0}
105002 Low No corrective action necessary.
{0} Address={1} Info=[{2}] Address={1} Info=[{2}]
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 85

Endpoint de-registered: A VPGate MOTOTRBO™ Multi-

Restart VPGate or the VPGate
105003 Name={0} Address={1} Info= Low Site Capacity Plus endpoint has
endpoint.
[{2}] deregistered from the ARC.
A VPGate MOTOTRBO™ Multi-
Endpoint timeout: Name={0} Site Capacity Plus endpoint’s Ensure that the VPGate service is
105004 Major
Address={1} Info=[{2}] heartbeats are missing and running.
have timed out.
Connected to remote system: The Avtec Routing Controller
105005 ConnectionType={0} Address= Low has connected to master No corrective action necessary.
{1} repeater.
The Avtec Routing Controller
Connected to remote peer:
105006 Low has connected to a repeater No corrective action necessary.
PeerID={0} Address={1}
peer.
Ensure that the repeater peer is
The Avtec Routing Controller
Lost connection to remote up and running and that network
105007 Major has lost connection to a
peer: PeerID={0} Address={1} connectivity between the ARC
repeater peer.
service and the repeater is stable.
Ensure the remote system is up
Lost connection to remote The Avtec Routing Controller and running and that network
105008 system: ConnectionType={0} Major has lost connection to a connectivity between the ARC
Address={1} remote system. service and the remote system is
stable.
Avtec SIP Proxy Alarms and Events

Event
Code
115000 SIP Proxy connected Low Avtec SIP Proxy connected. No corrective action necessary.
The Avtec SIP Proxy logs the
event when an endpoint
115003 Endpoint registration Low No corrective action necessary.
registers successfully with the
proxy.
The Avtec SIP Proxy logs the
event when an endpoint de-
115004 Endpoint de-registration Low No corrective action necessary.
registers successfully with the
proxy.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 86

Call Voter Alarms and Events

Alarm
Code
The maximum number of Call
Voter connections, 1000, has
20000 Connection limit exceeded. Major been reached. Clients trying to No corrective action necessary.
connect beyond the maximum
do not have their calls voted.
Event
Code
25000 Call Voter connected. Low Call voter is connected. No corrective action necessary.
Cannot connect to voter driver.
The Call Voter has completed
a vote and wants to connect to
the VPGate Endpoint that won
25001 Cannot connect to voter driver. Low No corrective action necessary.
the vote. The Call Voter was
unable to make the connection
to the Endpoint Call Voter
driver.
Console Alarms and Events

Alarm
Code
Check console diagnostics and the
workstation status to find possible
The media workstation is issue. Check Ethernet connection,
down at the Console. This may IP configuration, serial connection,
40000 Workstation down. Minor indicate a problem with the IP serial configuration, power
connection, serial connection connection, front power
or the workstation itself. switch/light to make sure all are
connected, set, and working
correctly.
Check console diagnostics to
determine the issue with the
The Business Layer component Business Layer. The Business
40001 Business Layer is not running. Minor of the console is not running or Layer is implemented as a
has IP connection issues. Windows service and the service
may not be running. If this is the
case, start the service.
Check console diagnostics to
determine the issue with the
The Control Layer component Control Layer. The Control Layer is
40002 Control Layer is not running. Minor of the console is not running or implemented as a Windows
has IP connection issues. service and the service may not be
running. If this is the case, start
the service.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 87

If the Scout Runtime is expected

to be running, verify that the
application is running. If not, start
No User Interface is available
No User Interface is available to the console. The Business the Scout Runtime application.
40006 Major
to the console. Layer does not have a GUI
If a CAD client is expected to be
client connected.
connected to the Business Layer,
check the configuration and verify
the client is running.
1. Browse to Console webpage
and click Diagnostics from the tree
menu.
2. Check the service Diagram to

determine which service has
One or more of the console One or more of the console connection or is no longer running.
40007 Major
layers has failed. layers has failed.
3. If the service is running, but has
connection failures, restart the
service.
4. If the service is not running,

start the service.
Check the workstation. This may
The media workstation has
Workstation has exceeded require turning the workstation off
40008 Major exceeded its threshold
temperature threshold. and determining the cause of the
temperature.
problem.
Install the Software Media
Software Media Workstation Software Media Workstation
40009 Minor Workstation License key in any
License Key Removed. License Key has been removed.
USB port on the network.
The relay device for the
Software Media Workstation Software Media Workstation Plug in the Relay Device in any
40010 Minor
Relay Device Unplugged. is unplugged from the console USB port on the Console PC.
computer.
Business Layer has reported a The project has a corrupt or
40011 Major Redeploy the project.
corrupt project. missing file.
Verify that the SIP Proxy service(s)
is running. Check the network
connection between the Scout
The connection loss can be the console and the SIP Proxy. If the
No available global SIP Proxy result of a network issue or Avtec SIP Proxy is connected to
40013 Major
connection. the result of the SIP Proxy other consoles, verify in the log
service(s) stopping. files that the console without the
connection is using the correct IP
address to connect to the Avtec
SIP Proxy.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 88

Verify that the SIP Proxy service(s)

is running. Check the network
connection between the Scout
The connection loss can be the console and the SIP Proxy. If the
No available local SIP Proxy result of a network issue or Avtec SIP Proxy is connected to
40014 Major
connection. the result of the SIP Proxy other consoles, verify in the log
service(s) stopping. files that the console without the
connection is using the correct IP
address to connect to the Avtec
SIP Proxy.
No license is available and a
No license available, grace Obtain additional licenses or shut
40015 Minor grace period has started for
period started. down another console.
the console.
Console has been shut down Shut down another console and
The grace period for a console
40016 due to its grace period Major restart the console that has
has run out.
expiring. expired.
Event
Code
45000 Console connected Low Console connected. No corrective action necessary.
A User has logged into the A user has logged into the
Scout Console Scout Console.
A User has logged out of the A user has logged out of the
Scout Console Scout Console.
Call Forwarding to Console {0} A console has forwarded their
has been enabled calls to another console.
A console has taken back their
Call Forwarding has been
45005 Low previously forwarded calls No corrective action necessary.
disabled
from another console.
The Ethernet port connected to
the Scout Media Processor
Plus changed from ACTIVE to
BACKUP or vice versa. This
Hardware Media Workstation
45006 Low message occurs when the No corrective action necessary.
Ethernet port changed to {0}
Scout Media Processor Plus
reboots to indicate which port
is active and also any time the
active port changes.
Install the Software Media
Software Media Workstation The Software Media
45007 Minor Workstation License key in any
Unlicensed Workstation is not licensed.
USB port on the network.
A License key has been
Software Media Workstation
45008 Minor installed for the Software No corrective action necessary.
Licensed
Media Workstation.
There is an impairment within
Media Workstation
the Media Workstation. There
ERROR: Task {1}. {0}. Reset
45010 Major are 19 different impairments Reset the Media Workstation.
Media Workstation as soon as
within the media workstation
possible
that can cause this error.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 89

When a console enters a grace

period because of a missing
Console has {0} left in its license, this event occurs Replace the license key or verify
45011 grace period before it will Major that the console is communicating
automatically be shut down. periodically as a reminder of with the license server.
the remaining time in the
grace period.
Diagnostics Alarms and Events

Alarm
Code
The audible indication was
silenced for all alarms.
90000 All alarms silenced Minor Silencing the alarm No corrective action necessary.
notification does not clear the
alarm itself.
silenced for all major alarms.
90001 All major alarms silenced Minor Silencing the alarm No corrective action necessary.
alarm itself.
silenced for all minor alarms.
90002 All minor alarms silenced Minor Silencing the alarm No corrective action necessary.
alarm itself.
Event
Code
95000 Server connected Low Server connected. No corrective action necessary.
DMS Alarms and Events

Alarm
Code
Database space used has
The database is {0}MB. Data grown to over 8GB. This
will be lost if the database alarm is sent once every 12
Export and purge data to retain
30001 grows past 10240MB (10GB). Major hours until the database
database size at lower than 8GB.
It is recommended to export space used is below 8GB. If
and purge exported data. the space used grows past
10GB, data is lost.
Monitor queues in Admin > Queues
Queue threshold exceeded: MSMQ message threshold and make sure they are leaving the
30002 Major
{0} has exceeded its limit. queue. Adjust the Queue threshold
counts in Admin > Settings.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 90

The license key has been

The license key has been
removed, and the grace
30003 removed. Grace period Major Replace the license key.
period has started. The grace
started.
period is 96 hours.
Applies when you are using
Active Directory for logins.
After AD has been
configured in the DMS, it has
Check the configuration for AD in
Could not connect to Active to talk to the AD server to
30004 Major DMS: Admin > User Admin > Identity
Directory (AD) server. perform logins. If the DMS
Providers > Active Directory > Edit.
cannot connect to the AD
server that has been
configured, this alarm
occurs.
Start the MSMQ service, Message
The MSMQ service is not
30006 MSMQ service is not running. Major Queuing, in the Windows Service
running.
Manager.
Manually retry the archiving process
Audit archiving process The audit trail archiving
30007 Minor or wait until the next scheduled
failed. process has failed.
attempt.
Event
Code
The database is {0}MB.
The purge is going to run due
Oldest {1}MB of Scout
35001 Minor to reaching the database No corrective action necessary.
Events, Alarms and Logs will
limit.
be purged.
The grace period for a A 96-hour grace period has

35002 missing license key has Major expired since the license key Replace the license key.
expired. was removed.
Audit archiving process The audit trail data archiving
35003 Low No corrective action.
started. process has been initialized.
The audit trail data archiving
Audit archiving process
35004 Low process has finished and a No corrective action.
finished.
file has been created.
Manually retry the archiving process
or wait until the next scheduled
Audit archiving process was The audit trail data archiving attempt.
35005 Minor
unable to finish. process was unable to finish.
View C:\ProgramData\Avtec,
Inc\DMS\Config\Logs\dms.log
for error details.
Check the read/write permissions for
C:\ProgramData\Avtec,
Audit archiving process was
DMS does not have access to Inc\DMS\Archive\Audit.csv.
35006 unable to finish due to Minor
the audit archiving file. Be sure the DMS_App_Pool user
authorization problems.
account has read/write permissions
selected.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 91

Encryption Key Manager Alarms and Events

Alarm
Code
The KMF license key has been
80000 KMF license key removed Minor Put the key back on the computer.
removed.
The VPGate or Advanced Radio
VPGate or AdvRadio license license key is not present.
Insert the HASP Dongle that
key not present; encryption Encryption will not operate
80001 Minor contains the VPGate or Advanced
will not operate; no grace without a license key, and
Radio license key.
period there is no grace period for
this feature.
Event
Code
A user successfully logged in
85000 Login successful Low No corrective action necessary.
to Avtec Key Manager.
A log in failed. Five login
85001 Login failed Low attempts are allowed before Log in using a valid password.
this message is logged.
The stored password was
Password reset - all keys reset and all associated keys Create a new password and re-
85002 Low
cleared - login successful were deleted. The login was enter any keys necessary.
successful.
Encryption keys were exported
to a file. The file name is
85003 Keys exported: file={0} Low No corrective action necessary.
reported as part of the event
message.
Encryption keys were imported
from a file. The file name is
85004 Keys imported: file={0} Low No corrective action necessary.
reported as part of the event
message.
The password used when
attempting to import an
Transfer password invalid on encryption key file was not Use the correct password to
85005 Low
import: file={0} correct. Three attempts are import the file.
allowed before this message
is logged.
A key was added to an existing
keyset. The new key's RSI,
System ID/Keyset ID, SLN and
Key added: RSI={0}
key information are included in
85010 EncryptionId/KeysetId={1} Low No corrective action necessary.
the message. KeyInfo includes
SLN/CKR={2} KeyInfo={3}
the algorithm used (DES or
AES), the Key ID, and the key
name.
An existing encryption key was
Key modified: RSI={0}
changed. The key's RSI,
EncryptionId/KeysetId={1}
85011 Low System ID/Keyset ID, old and No corrective action necessary.
OldSLN/CKR={2}
new SLN, and key information
NewSLN/CKR={3} KeyInfo={4}
are included in the message.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 92

An existing key was deleted.

The key's RSI, System
Key deleted: RSI={0} ID/Keyset ID and SLN/CKR are
85012 EncryptionId/KeysetId={1} Low included in the message. No corrective action necessary.
SLN/CKR={2} KeyInfo includes the algorithm
used (DES or AES), the Key ID,
and the key name.
All existing keys have been
deleted from Key Manager
All Keys deleted: RSI={0}
85013 Low storage. The affected RSI and No corrective action necessary.
EncryptionId/KeysetId={1}
System ID/Keyset ID are
included in the message.
A new Encryption setting was
added to Key Manager
Encryption settings added:
storage. The Encryption ID,
85014 EncryptionId={0} Name={1} Low No corrective action necessary.
Entry Method, and Encryption
EntryMethod={2} Info={3}
setting name are reported in
the message.
An existing Encryption setting
was modified. The Encryption
Encryption settings modified:
setting's old and new
OldEncryptionId={0}
85015 Low Encryption ID is reported. The No corrective action necessary.
NewEncryptionId={1} Name=
Entry Method and Encryption
{2} EntryMethod={3} Info={4}
setting name are also
reported.
An Encryption setting was
Encryption settings deleted:
85016 Low deleted. The Encryption ID is No corrective action necessary.
EncryptionId={0}
All Encryption settings were
85017 All encryption settings deleted Low deleted from Key Manager No corrective action necessary.
storage.
A new KMF server was added
KMF server settings added: to Key Manager storage. The
85018 SettingsId={0} Type={1} Low KMF server ID, KMF server No corrective action necessary.
Name={2} Info={3} Type, and KMF server name
are also reported.
An existing KMF server was
modified. The KMF server's old
KMF server settings modified:
and new KMF server setting ID
85019 SettingsId={0} Type={1} Low No corrective action necessary.
is reported. The KMF server
Name={2} Info={3}
type and KMF server name are
also reported.
A KMF server was deleted. The
KMF server settings deleted:
85020 Low KMF server setting ID is No corrective action necessary.
SettingsId={0}
An existing key was deleted
(most likely by the KMF
Key deleted by id: RSI={0} server). The key's RSI,
EncryptionId={1} Alg={2} Id={3} Encryption ID, Algorithm, and
Key ID are included in the
message.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 93

A communication error
between the Encryption Key Restart the Avtec Encryption Key
Manager GUI and the Manager Service, and then try to
Service communication error:
85022 Minor Encryption Key Manager re- open the Avtec Key Manager
{0}
service has taken place. The application or retry the operation
system specific error is that failed.
included in this message.
The Avtec Encryption Key
85023 Service started Low No corrective action necessary.
Manager Service started.
85024 Service stopped Low No corrective action necessary.
Manager Service stopped.
The VPGate license key is
VPGate license key used for
85026 Low being used for cryptography on No corrective action necessary.
crypto
the system.
The Advanced Radio license
AdvRadio license key used for
85027 Low key is being used for No corrective action necessary.
crypto
cryptography on the system.
The KMF access license was
not present on the system
Insert the HASP Dongle that
during service startup, or 96
85028 KMF license key not present Low contains the KMF access license
hours has passed since the
key.
removal of the KMF license
key.
The KMF access license was
85029 KMF license key present Low present on the system during No corrective action necessary.
service startup.
Perform the following tasks:
1. Verify the KMF provisioning

keys are valid for the defined KMF
server ID.
Manager Service was not able 2. Verify the KMF server is
to register with the KMF functioning on the network and
KMF registration timeout: server due to a timeout being visible to the VPGate/Key
reached. Manager server.
85030 KMF={0}:{1} SettingsId={2} Minor
RSI={3} The KMF server IP address and 3. Verify that the KMF server
port, the settings ID, and the device corresponding to this RSI is
configured RSI are included in not misconfigured. (Run Tait KMF
the message. Device Diagnostics via the Tait
KMF GUI for the RSI displayed in
this message.)
Inspect the service log file for low

level diagnostic information.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 94


Manager Service registered
KMF registration success:
with the KMF server. The KMF
85031 KMF={0}:{1} SettingsId={2} Low No corrective action necessary.
server IP address and port, the
RSI={3}
settings id and the configured
RSI is included in the message.
Perform the following tasks:
1. Verify the file

C:\ProgramData\Avtec,
Inc\VPGate\Advanced Radio
Support\aksp3.bin exists.
Problem reading key storage There was a problem reading
85032 Major 2. If this file is corrupted, then
file: {0} the Key Storage file.
remove it and other files starting
with aksp in the same folder to
start with a new empty storage
file.
3. Restart the service.

Corrective action depends on the
A low level error has occurred nature of the exception. Examine
in the Encryption Manager log files to obtain more context
85033 Software exception in GUI: {0} Low
GUI. The system error text is for the error, and if necessary,
reported. contact Avtec Customer Support
for assistance.
Corrective action depends on the
A low level error has occurred nature of the exception. Examine
Software exception in Service: in the Encryption Manager log files to obtain more context
85034 Major
{0} service. The system error text for the error, and if necessary,
is reported. contact Avtec Customer Support
for assistance.
Frontier Alarms and Events

Alarm
Code
The Frontier Registrar lost
connection to one of the
Verify that the service is running on
remote Frontier peers. Alarm
the Frontier Peer. Verify that the
details the Frontier Registrar
Registrar - Loss of connection network connection between the
60000 Minor that reported the alarm as
to Peer Frontier Registrar and the
well as the IP address of the
disconnected Frontier Peer is
remote Frontier Peer to
operating.
which the connection was
lost.
Event
Code
65000 Frontier connected Low Frontier connected. No corrective action necessary.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 95

A Frontier configuration
change occurred. Change can
be to the General
65001 Configuration Update Low Configuration page, the No corrective action necessary.
Frontier Peers page, the Log
Settings page, or the
Network Settings page.
The active Frontier system is
65002 Active Node Low connected and is working No corrective action necessary.
properly.
A backup Frontier system is
65003 Backup Node Low connected and is working No corrective action necessary.
properly.
A Frontier peer has been
65004 Peer reset Low No corrective action necessary.
reset.
This Frontier has registered a
high number of endpoints.
The count is based on the
High Endpoint Registrations
65005 Low configured Maximum No corrective action necessary.
Reached
Endpoint Registrations
setting on the Frontier
Configuration webpage.
This Frontier has reached the
maximum number of
endpoint registrations by
Verify the configuration is correct,
Maximum Endpoint console. The maximum is
65006 Low or reduce the number of console
Registrations Reached configured on the Frontier
endpoint registrations.
Configuration webpage using
the Maximum Endpoint
Registrations setting.
This Frontier has reached a
High Endpoint Discoveries
65007 Low high number (1150) of No corrective action necessary.
Reached
endpoint discoveries.
This Frontier has reached the Reduce the number of endpoints
Maximum Endpoint
65008 Low maximum number (2000) of served up by VPGates on the local
Discoveries Reached
endpoint discoveries. network.
This Frontier has reached a
High Inbound Connections high number (375) of
Reached inbound connections from
peer Frontiers.
This Frontier has reached the Reduce the number of peer
Maximum Inbound
65010 Low maximum number (450) of Frontiers connecting to this
Connections Reached
inbound connections. Frontier.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 96

Scout Manager Alarms and Events

Event
Code
75000 Scout Manager connected Low Scout Manager is connected. No corrective action necessary.
Typically an invalid password was
75002 User login failed Low User login failed. entered. No corrective action
necessary.
75003 User login successful Low User login successful. No corrective action necessary.
75004 Closed Low Scout Manager closed. No corrective action necessary.
ScoutLink Alarms and Events

Alarm
Code
Verify that ScoutLink and the SIP
Server (Avtec SIP Proxy) are
ScoutLink failed to make a configured correctly and have
connection to the configured
No available SIP server SIP server. If configured for matching credentials.
120000 Major
connection redundancy, ScoutLink failed
Check the network connectivity
to connect to both configured
nodes. between ScoutLink and the
configured SIP server (Avtec SIP
Proxy).
Check network connectivity
between ScoutLink and VPGate.
Check network connectivity

A VPGate endpoint that one between VPGate and the endpoint.
Endpoint trying to be
or more ScoutLink callers is
120001 accessed by a ScoutLink caller Minor Verify that the endpoint is on and
trying to access is currently
is unavailable
unavailable. operational.
If connections are secure and

power is on, restart/reset the
endpoint.
A ScoutLink license is not
available. The grace period For a hardware key, verify that the
No license available; grace
120002 Minor started for existing calls and key is inserted. Otherwise, connect
period started
ScoutLink will not accept any license key as soon as possible.
new calls.
ScoutLink's license grace
ScoutLink calls have been period ended. Any existing For a hardware key, verify that the
120003 terminated due to its grace Major calls will be terminated and key is inserted. Otherwise, connect
period expiring ScoutLink will not accept any license key as soon as possible.
new calls.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 97

No license available; ScoutLink does not have a For a hardware key, verify that the
120004 ScoutLink cannot accept any Major license key available when key is inserted. Otherwise, connect
calls the service starts. license key as soon as possible.
Event
Code
ScoutLink started
125000 ScoutLink connected Low successfully and connected No corrective action necessary.
with SCD.
When ScoutLink enters a
grace period because of a
ScoutLink is in a grace period For a hardware key, verify that the
missing license, this event
125001 and it has a set amount of Major key is inserted. Otherwise, connect
occurs periodically as a
time before all calls end license key as soon as possible.
reminder of the remaining
time in the grace period.
Trunking Gateway Alarms and Events

Event
Code
The trunking gateway is
55000 P25 Gateway connected Low No corrective action necessary.
connected.
Primary Trunking Gateway is
55001 Primary Node Low No corrective action necessary.
connected
The new active node has taken
over for the former active
node. This takeover is
55002 Redundant Node takeover Low determined by the "Non- No corrective action necessary.
Preferred Delay" and "Polling
Failure" settings on the main
webpage.
A new CSSI endpoint has
55003 Endpoint registration: {0} Low registered with the Trunking No corrective action necessary.
Gateway.
A CSSI endpoint has de-
registered with the Trunking
55004 Endpoint deregistration: {0} Low No corrective action necessary.
Gateway (for example, an
endpoint is made Unavailable).
Secondary trunking gateway is
55006 Secondary Node Low No corrective action necessary.
connected.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 98

VPGate Alarms and Events

Alarm
Code
1. Check network connectivity
between VPGate and the Endpoint.
VPGate cannot make a 2. Make sure the Endpoint is
No connection to physical
10000 Major connection to the physical
endpoint powered on and is operational.
endpoint.
3. If all connections and power are
good, reset/restart the Endpoint.
The VPGate USB license key Insert the USB license key for
10001 USB license key removed Low
was removed. VPGate.
Check your VPGate and/or Registrar
device configuration settings if this
is a first time connection attempt. If
The connection between
No connection to SIP the connection was operational and
10002 Minor VPGate and the SIP Primary
Primary Identity then broke down, check the status
Registrar has been broken.
of the VPGate and/or Registrar
device and the network connection
between them.
Check your VPGate and/or Registrar
device configuration settings if this
is a first time connection attempt. If
The connection between
No connection to SIP the connection was operational and
10003 Minor VPGate and the SIP Secondary
Secondary Identity then broke down, check the status
Registrar has been lost.
of the VPGate and/or Registrar
device and the network connection
between them.
The trunking controller has gone
The Failsoft mode has been
10004 Failsoft mode activated Major down. Contact your system
activated.
administrator for assistance.
Verify the network connection to the
The connection with the
Loss of connection to endpoint is operational. Contact
10005 Major redundant controller endpoint
redundant controller your system administrator for
has been lost.
assistance.
An Outpost device connected to
this VPGate has exceeded its
Contact your system administrator
recommended internal high
for assistance. The alarm clears
temperature of 75 degrees
10006 Outpost Temperature Minor itself when the internal
Celsius. All endpoints
temperature goes down to 70
connected to this outpost
degrees Celsius.
display this alarm on the
diagnostic webpage.
The SIP endpoint has failed to
The system continues to attempt to
connect to configured DTMF
make the connection as configured
String when the line was taken
10007 SIP Autoconnect Failure Minor on the endpoint's SIP driver
off hook. The system continues
webpage in VPGate, or the line is
to retry to make the
placed on hook.
connection.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 99

VPGate has entered

10008 Maintenance Started Minor No corrective action necessary
maintenance mode.
Event
Code
15000 VPGate connected Low VPGate has connected. No corrective action necessary
Endpoint started and currently
Endpoint started in backup
15001 Low in backup mode for this No corrective action necessary.
mode
VPGate.
Internal endpoint watchdog Continue to observe this behavior. If
Internal endpoint watchdog expired. The VPGate Endpoint it continues to repeat, then report
15002 Low
expired has experienced an internal the issue to Avtec Customer
error. Support.
Endpoint promoted to
15003 Low The endpoint is now in control No corrective action necessary
primary mode
Endpoint timeout waiting on
console refresh. VPGate Check the Console connectivity and
Endpoint timeout waiting
15004 Low Endpoint was in an active state power connections. Verify the
on console refresh
and did not hear from the Console is operating normally.
controlling console.
USB license key not inserted. Insert the USB license key for
USB license key not
15005 Low VPGate was started without VPGate and restart the VPGate
inserted
the license key. service.
Verify that you have purchased the
Driver not licensed. VPGate correct license for the Endpoint. This
15006 Driver not licensed Low cannot find a valid license for may be dependent on the VPGate
the specified driver. driver that is configured for this
Endpoint.
For the endpoint to be available
again, change the endpoint setting
The endpoint is either from Unavailable to Available on
15007 Endpoint shutdown Low unavailable or has been the VPGate Configuration/Endpoint
deleted. webpage. If the endpoint is
unintentionally deleted, it needs to
be recreated.
The endpoint is unavailable due If you want the endpoint to be
to configuration changes that available again, change the
15008 Endpoint unavailable Low have been made on the VPGate endpoint setting from Unavailable
Configuration/Endpoint to Available on the VPGate
webpage. Configuration/Endpoint webpage.
The redundant controller has
switched from the preferred There should be no operational
controller endpoint to the impact during or after the
Switched redundant
15009 Low backup controller endpoint or switchover. If operations are
controller
has switched from the backup affected, contact your system
controller endpoint to the administrator for assistance.
preferred controller endpoint.
15010 Outpost Software Event Low Forwarded event from Outpost. No corrective action necessary.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 100

Endpoint added – An endpoint

was added to VPGate. VPGate
recognizes new endpoints and
For information only. In Scout
endpoints with new names as
Manager, verify that the endpoint
15011 Endpoint added Low an added endpoint. For
pads reflect the correct endpoint
example, when an endpoint is
setup.
renamed, VPGate removes the
old-name endpoint and adds
the new-name endpoint.
Endpoint removed – An
endpoint was removed from
VPGate. VPGate recognizes
deleted endpoints and
For information only. In Scout
endpoints whose names have
Manager, verify that the endpoint
15012 Endpoint removed Low been changed as deleted
pads reflect the correct endpoint
endpoints. For example, when
setup.
an endpoint is renamed,
VPGate removes the old -name
endpoint and adds the new-
name endpoint.
Input alert at bank {0} bit An input alert has become
15013 Low For information only.
{1} state changed to {2} active or the alert has cleared.
An input alert has been
acknowledged by a specific
logged in user; or if a console
does not require login, the
console's name replaces the
username in the event
Input alert at bank {0} bit message.
15014 Low For information only.
{1} ACKNOWLEDGED by {2}
The system has automatically
acknowledged an input alert
after an Auto Acknowledgment
timeout period has expired; or
the alert was acknowledged at
the same time the alert
cleared.
The graceful switchover is
15015 Switchover complete Low No corrective action necessary.
complete.
Phone: 1-803.358.3600 • Fax: 1-803.358.3636 101

Scout Suite Administration Guide

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Scout Suite Administration Guide

Uploaded by

Copyright:

Available Formats

Scout™

This document is confidential.

Phone: 1-803.358.3600 • Fax: 1-803.358.3636

Copyright © 2018 by Avtec, Inc. All rights reserved.

This document contains proprietary information that is protected by copyright. No

Scout™, VPGate™, Outpost™, Frontier™, Audio Bridge™, Avtec SIP Proxy™,

Copyright © 2003 GoAhead Software, Inc. All rights reserved.

COMPANY INFORMATION Avtec, Inc.

Release Release 4.7

Release Date October 2018

Phone: 1-803.358.3600 • Fax: 1-803.358.3636 ii

Phone: 1-803.358.3600 • Fax: 1-803.358.3636 iii

Phone: 1-803.358.3600 • Fax: 1-803.358.3636 iv

Restore the DMS Database on the SQL Computer 41

Phone: 1-803.358.3600 • Fax: 1-803.358.3636 v

Setting up the IIS Application Pool Account 63

Phone: 1-803.358.3600 • Fax: 1-803.358.3636 vi

Phone: 1-803.358.3600 • Fax: 1-803.358.3636 1

DMS DATABASE BACKUP AND RECOVERY

Database Backup When Backup What Gets

l Can schedule backups to perform

l Can back up to a different system.

l Can use to back up project before

l Scout Data Store Database Backup and Restore

l Automatic Database Maintenance Backups

Phone: 1-803.358.3600 • Fax: 1-803.358.3636 3

l DMS Database Recovery

l Scout Central Distributor Import and Export

Phone: 1-803.358.3600 • Fax: 1-803.358.3636 4

Overview – Scout Data Store Database Backup and Restore

l "Creating a Backup Job" on Page 6

l "Initiating a Backup" on Page 9

l "Restoring a Backup" on Page 9

Phone: 1-803.358.3600 • Fax: 1-803.358.3636 5

l Transaction log backup – Contains transaction logs.

l Installation of SQL Backup Master Version 1.0.118.0 or later (http://www.sqlbackupmaster.com/) on the

l A SQL username and password with rights to perform backups.

User name Password

Creating a Backup Job

Phone: 1-803.358.3600 • Fax: 1-803.358.3636 6

1. In SQL Backup Master, select Create New Database Backup.

The Database Backup Editor dialog displays.

2. Under Source, select Choose SQL Server.

The Connect to SQL Server dialog displays.

a. Select Server name > (local)\AVTECDMS.

b. Select Connect using the following SQL Server account.

c. Enter the pre-installed Username: DMS_Backup; and Password: P@ssword1.

DMS displays in the Source column.

3. Under Source, select the DMS checkbox.

4. Under Destination, click Add.

The Choose Destination dialog displays.

a. Select Local or Network Folder and click Select.

The Folder Destination Settings dialog displays.

b. Specify a backup location and click OK.

5. Under Configuration, click Not scheduled to establish scheduling.

The Backup Job Schedule dialog displays.

a. Click Load a Preset Backup Plan and select Daily Simple.

Phone: 1-803.358.3600 • Fax: 1-803.358.3636 7

The Backup Job Settings dialog displays.

a. Select the checkbox next to Send Email Notifications.

7. Under Configuration, enter a Backup Name and Description.

The backup configuration is complete.

Phone: 1-803.358.3600 • Fax: 1-803.358.3636 8