#ANET2 Documentation
ANET2 is comprised of three major components: the Database, an Application server, and the User Interface.
-
DB: ANET2 uses a Microsoft SQLServer database to store all data, keep backups, provide consistency of relationships, and perform advanced search. ANET2 requires SQLServer 2014 or higher. More details on the Schema of the Database is available in the Developer Documentation.
-
Application Server: ANET2's primary server functions, business logic, and authorization is performed in a Web Application server written in Java on the Dropwizard Web-Application Framework. This server receives requests from users, determines if they are authorized and valid, and then performs the necessary fetching or manipulation of data in the Database. The application server runs over HTTP/HTTPS (port 80/443) and communicates with clients using standard JSON data formats. More detail about the APIs exposed from the application server is avaiable in the Developer Documentation. The application server requires Java version 17 to run.
-
User Interface: ANET2's user interface is a website that users will access using any modern web browser (Recommended: Google Chrome version XXX or greater, Required: IE version 11 or greater, Firefox version XXX or greater). There is no client software or special browser plugins that need to be installed to access and use the ANET2 platform.
ANET2 is built primarily using Open Source languages, frameworks, and libraries that are standard throughout the software industry. The only proprietary software that ANET2 depends on is Microsoft SQLServer. To successfully develop, build, run, and manage a deployment of ANET2, the following roles and skillsets are recommended:
-
DBA: Somebody needs to take care of your database, this role should be shared with other projects and does not need to dedicated to ANET2. Responsiblities include patching and upgrading the Database software, ensuring backups are taken and reliable, and advising on query performance/tuning.
-
Full-stack Software Engineer: This person/people will be the primary developer of new features on ANET2 and troubleshoot any bugs/issues that arise. This person should have a strong background in developing user-centric applications in an agile-development lifecycle and can react quickly to changing requirements. As the lead developer, this individual will work closely with users to understand needs and issues. This person will also work closely with the ANET2 Administrator and the Product Owner to determine the correct solution, then implement, test, and iterate on that solution. They should have a strong understanding, or willingness to learn, the following concepts/languages:
- SQL
- Java
- REST APIs
- HTTP servers
- Javascript, HTML, CSS
- React
- Git
-
System Administrator: Somebody needs to manage your Windows server, patches, and keep the service running. This role should be shared with other projects and does not need to be dedicated to ANET2. Responsiblities include patching and upgrade of the Server Operating Systems, providing support to release new versions of the ANET2 platform on a regular basis, and ensuring performance and uptime of the server environment.
-
ANET2 Administrator / Level-1 Support: This role provides the day-to-day management of the system, working with users on any issues, serving as the initial triage of incoming requests, performing management of top level data structures within the system (Organizations, Tasks). This person should have a basic understanding of, or willingness to learn, Databases, application servers, and websites. This role does not need to be overly technical in nature and should be focused on engaging with and supporting users of the platform.
-
Client: The client can be any users on the appropiate network with a modern web-browser. ANET uses HTTP/HTTPS (ports 80/443) to communicate between the client and server.
-
Application Server: The ANET2 Application Server can run on any Windows Server operating system. Recommended system configuration is: 300 GB HDD, 64 GB RAM, and 8x CPU cores. The Application server must be able to communicate with the Database server, the Windows Domain Controller for AD Authentication, and the SMTP server for outbound mail.
-
Database: ANET2 Requires at least a Microsoft SQL Server 2014 Database.
-
Backup: Backups should be taken daily from the SQL Database and transferred to a seperate file server for safe keeping. Database backups can be taken through any means that capture the full state of the database. The
application.ymlconfiguration file and audit logs should be backed up from the Web-Application Server. -
Authentication: User Authentication in production is done via Windows Domain Authentication.
-
Map Imagery Server: To enable the ANET2 maps, you will need a source of Map imagery. ANET2 supports local cached tiles, WMS servers, or ArcGIS servers with a REST API enabled.
-
Production vs Test Environments: It is recommended to have a seperate Production and Test environment that mirror each other as closely as possible. However, it is totally acceptable to have less resources for the Test environment.
This table lists the interaces produced and consumed by ANET on the network:
| Producer | Consumer | Protocol | Data Format | Purpose |
|---|---|---|---|---|
| ANET | User | HTTP/HTTPS | JSON/HTML/CSS | ANET Web User Interface |
| ANET | API users | HTTP/HTTPS | JSON | REST and GraphQL API |
| ANET | Mail Server | SMTP | text/HTML | Emails to users |
| Active Directory | ANET | NTLM / Kerberos | ||
| Tile Server (ArcGIS, iGeoSIT, etc) | Users | HTTP/HTTPS | JSON/ PNG | Map Tile Imagery |
See INSTALL.md
The recommended strategy for troubleshooting is to first identify where the error is occuring, either in the javascript in the browser, or an error on the application server. Start by opening the browser developer console and look at the network calls to look for any calls that are returning errors. If there are any errors on the network calls, look to the server side log files for more information. If no errors are being returned, look for any errors in the browser console for more information.
In the event there are still no errors, it might be necessary to troubleshoot the issue in a development environment that supports debugging breakpoints and variable watches. More information about how to setup and configure this environment can be found in the Developer Documentation below.
For any issues related to the Application Server, check the log file in logs\anet.log
[INCLUDE SOME DETAILS ON HOW TO READ THE ERROR LOGS]
For any issues related to the web-browser front-end check the browser console (found in the Developer Tools) in the browser.
Documentation for Developers is kept in README.md in the github repository.
ANET is configured primarily through the application.yml file. A description of the file format can be found in INSTALL.md