Configuration
- Michael Standal
AMP application configuration uses a combination of database and web configuration file settings to control options and features.
Portal Administrators
At this time there is no interface to manage which users have administrative access to the portal. Using a database management tool to make table entries and modifications is the only way. Refer to the schema table below for guidance on making modifications to this table.
It is not necessary to make entries for users not being granted these roles.
ConfigurationAdministrators Table Schema
Column Name | Data Type | Description |
|---|---|---|
Id | int | (Auto) Unique Id |
Username | varchar(200) | The username of the individual (with domain if used) who is assigned one or more configuration access roles. |
IsConfigurationAdministrator | bit | 1=true, 0=false. True allows this user to see and use ALL administration menus and pages as shown here. |
IsDeviceManager (This field is created incorrectly in v1.1 and previous versions. This field should be IsUserManager) | bit | 1=true, 0=false. True allows this user to see and use ONLY the Users administration menu item and page as shown here. |
Example Username with domain: ACME\ROADRUNNER
Example SQL to add a user (usermanager01) for User administration only:
USE [ACMMobilePortal]
GO
INSERT INTO [dbo].[ConfigurationAdministrators]
([Username]
,[IsConfigurationAdministrator]
,[IsDeviceManager])
VALUES
('usermanager01'
,0
,1)
GOAppSettings.json
This file is located in the root of the installation folder. Some sections are out scope and are not to be changed by the user. The sections relevant to application configuration are discussed below.
Example location: C:\inetpub\wwwroot\asiMobilePortal\appsettings.json
Example of complete file with correct formatting of the JSON:
{
"Logging": {
"LogLevel": {
"Default": "Information",
"Microsoft": "Warning",
"Microsoft.Hosting.Lifetime": "Information"
}
},
"AllowedHosts": "*",
"ConnectionStrings": {
"PortalDataBase": "Server=localhost\\SQLEXPRESS;Database=ACMMobilePortal;Trusted_Connection=yes;Persist Security Info=False;",
"ACMDataBase": ""
},
"LogToFile": {
"File": "C:\\ProgramData\\AutoSol\\Communication Manager\\7\\DataFiles\\Mobile\\Log.txt",
"Enabled": "True",
"ErrorsOnly": "False"
},
"ArchiveHistory": {
"Enabled": "True"
},
"Defaults": {
"DeviceSearchFilters": "Name,Description"
},
"ACMServerConfiguration": {
"HostAddress": "localhost",
"ConfigurationServicePort": 5330,
"CommandServicePort": 5331,
"ReportServicePort": 5333,
"ItemServicePort": 5334,
"ArchiveServicePort": 5336,
"LoggingServicePort": 5332
},
"ACMServerConfigurationProfiles": [
{
"Displayname": "Example1",
"DataBase": "",
"HostAddress": "localhost",
"ConfigurationServicePort": 5330,
"CommandServicePort": 5331,
"ReportServicePort": 5333,
"ItemServicePort": 5334,
"ArchiveServicePort": 5336,
"LoggingServicePort": 5332
},
{
"Displayname": "Example2",
"DataBase": "",
"HostAddress": "ExampleURL.com",
"ConfigurationServicePort": 5330,
"CommandServicePort": 5331,
"ReportServicePort": 5333,
"ItemServicePort": 5334,
"ArchiveServicePort": 5336,
"LoggingServicePort": 5332
}
]
}ConnectionStrings
The database connections are configured in the appsettings.json file. See above for details on the location of this file. The connections are part of a section of the file called ConnectionSettings. Two sub-entries determine the connections:
PortalDataBase
Default: Server=localhost\SQLEXPRESS;Database=ACMMobilePortal;Trusted_Connection=yes;Persist Security Info=False;
ACMDataBase
Default: Not specified.
Required ONLY IF AMP is installed and running on a different server than ACM and not using a Server Profile. This allows AMP to connect and retrieve the persisted item values for a device on the Device View. When AMP and ACM are running on the same server, AMP accesses the asiData.ini file to read and decode the encrypted connection string for accessing ACM. This encrypted string can be assigned to this value in order to allow AMP to access the ACM database when running on another server.
When ACM Server Profiles are used, the DataBase field in the Profile is checked BEFORE the ConnectionStrings to resolve the database to connect too and retrieve the persisted item values for a device.
LogToFile
This setting controls how log messages are output. Log messages can include task information messages, user task audit entries as well as errors and exceptions the application encounters while running. AMP does not make entries to the ACM logger. User Audit Activity logging is a separate feature and controlled by a Server setting.
Errors are logged to the Windows Application Event Log if the Enabled setting is false. This insures that critical errors are persisted for debugging.
File
Default: Server=C:\ProgramData\AutoSol\Communication Manager\7\DataFiles\Mobile\Log.txt.
This specifies the path and file name to write log messages to.
Enabled
Default: True.
When true, log messages will be written to the file specified in the File setting above. When false, entries will not be written to file.
ErrorsOnly
Default: False.
When true, only errors and exceptions the application encounters while running are logged.
ArchiveHistory
The setting to enable archive history is configured in the appsettings.json file. See above for details on the location of this file.
Enabled
Default: True.
When enabled, the additional application menu item Archive History is shown and navigation to the page is authorized for ALL logged in users.
ACMServerConfiguration
The setting group contains the host address and communication ports AMP needs to access ACM services for normal functions of the application. This is the default configuration used when ACMServerConfigurationProfiles are not present.
HostAddress
Default: localhost.
This value may change if AMP is running on a different server than ACM.
ConfigurationServicePort
Default: 5330.
CommandServicePort
Default: 5331.
ReportServicePort
Default: 5333.
ItemServicePort
Default: 5334.
ArchiveServicePort
Default: 5336.
LoggingServicePort
Default: 5332.
ACMServerConfigurationProfiles
(v1.3+) This optional setting group contains configurable profiles for ACM server connections allowing a user to select a Profile during login for the duration of the session. Using this feature, one AMP installation could be used to connect to more than one ACM Server installation. When 2 or more Profiles are present, a selection drop-down appears on the Login page. Each Profile contains the following fields:
Displayname
This is the descriptive name given to the Profile and is used for the Login selection listing. This name also appears on the Toolbar and session start audit entry for the user indicating what ACM Server the user is connected too.
DataBase
This is used to store the encrypted connection string to the ACM database used by this Profile’s ACM Server. This is used to retrieve the Persisted Items for a device.
HostAddress
The URL of the ACM Server to use for this Profile.
ConfigurationServicePort
Default: 5330.
CommandServicePort
Default: 5331.
ReportServicePort
Default: 5333.
ItemServicePort
Default: 5334.
ArchiveServicePort
Default: 5336.
LoggingServicePort
Default: 5332
Adding Profiles
Each Profile is separated by a comma excluding the last entry. Its recommended to copy an existing Profile and paste it, then change the values and make a unique Displayname.
Defaults
This setting group contains configurable application-wide defaults for settings.
DeviceSearchFilters
Default=Name,Description
This setting determines what Device Search filter options are enabled for all users when starting a session. Entries are separated by commas and must match the filter option names listed on the device search filter.
