IT Planning Manual. Fleet Maintenance Software. Version 6.6

Transcription

1 Fleet Maintenance Software IT Planning Manual Version Terri Lane, Suite 700 Burlington, NJ (609) Fax (609) Dossier@dossiersystemsinc.com

2 Copyright Dossier Systems - All Rights Reserved Microsoft, Windows, and Excel are registered trademarks of Microsoft Corporation in the United States and/or other countries. Intel and Pentium are trademarks of Intel Corporation in the U.S. and other countries. Avery is a trademark of Avery Dennison Corporation. LoadMaster is a registered trademark of McLeod Software. Networkfleet is a registered trademark of Networkfleet, Inc. NAPA is a trademark of the National Automotive Parts Association. The GMC trademark and design are registered trademarks of GMC. Zonar and EVIR are registered trademarks of Zonar Systems. All other registered and unregistered trademarks are the property of their respective owners.

3 Contents Introduction 1 Dossier Software Components 1 Dossier Client Software (Required) 1 Dossier Services (Required) 1 Integrated Components (Optional) 2 McLeod LoadMaster Enterprise Integration 2 Active Alerts 2 Tire Probe 2 Database Server (Required) 2 Reporting Server (Required) 2 Remote Desktop/Terminal Services (Optional) 3 Active Directory (Optional) 3 Microsoft Message Queue (Required) 3 SMTP Server (Optional) 3 Firewalls 4 Dossier Network Architecture 5 Individual User (or Several Users Sharing a Computer) 5 Small Workgroup 5 Small- to Mid-Sized Workgroup 5 Large Workgroup 5 Corporation 5 Dossier Client Software 6 Hardware Requirements 6 Security Considerations 6 Dossier Services 7 Event Broker 7 Security Considerations (Dossier Services) 7 Dossier Data Exchange (API) 8 Hardware Requirements 8 Security Considerations 8 Firewall Requirements 8 Integrated Components (Optional) 8 Dossier IT Planning Manual iii

4 Dossier Cloud Services (DCloud) 8 Hardware Requirements 8 Firewall Requirements 9 Active Alerts 9 Hardware Requirements 9 Firewall Requirements 9 McLeod LoadMaster Enterprise Integration 9 Hardware Requirements 9 Security Considerations 10 Firewall Requirements 10 Tire Probe 10 Hardware Requirements 10 Security Considerations 10 Firewall Requirements 10 Database Server - SQL Server 10 Versions/Editions Supported 10 Hardware Requirements 11 Microsoft SQL Server Licensing Requirements 11 Database Maintenance 12 Disaster Recovery 12 Security Considerations 12 Firewall Requirements 13 SQL Server Reporting Services 13 Versions/Editions Supported 13 Hardware Requirements 13 Microsoft Licensing Requirements (Server and User) 14 Security Considerations 14 Firewall Requirements 14 Microsoft Message Queue (MSMQ) 15 Versions/Editions Supported 15 Security Considerations 15 Firewall Requirements 15 SMTP Server 15 Security Considerations 16 Firewall Requirements 16 iv Contents

5 Appendix 17 System Requirements 17 Desktop System Requirements 17 Server, Network, and Router Requirements 18 Dossier IT Planning Manual v

6

7 Introduction The Dossier Fleet Management software has been designed to support a wide diversity of use cases, from the single user running on one computer with limited fleet assets to hundreds of concurrent users and tens of thousands of fleet assets. To support this diverse set of operating requirements, Dossier is designed to be very scalable. Properly planning your computing infrastructure will directly impact your successful utilization of Dossier. Dossier utilizes many different technologies. This manual is not designed as a training document for the various underlying technologies. Its goal is to help you decide how to best utilize these technologies as they apply to Dossier and your use case. Dossier Software Components Prior to a discussion of the various infrastructures Dossier supports, it is necessary to understand the components of Dossier and the underlying technologies they utilize. It is important to remember that while there are a number of supported components and technologies, all of them can be run on a single computer for smaller installations. Dossier Client Software (Required) Dossier requires user interface and logic components that constitute the Dossier Fleet Management Software client application. This application generally runs on the users desktop computers and is the primary interface between users and the application. Although it is comprised of several different components, this is generally what users perceive as Dossier. Dossier Services (Required) Dossier Cloud Services (DCloud) DCloud is a technology that allows the Dossier application to take advantage of Dossier Systems cloud services. For example, it provides users with the ability to remotely enter meter readings and work pending requests via a web page or mobile devices such as phones and tablets. It is also used for integrations to third-party products, such as telematics providers Dossier Event Broker Dossier Event Broker is an enabling technology that triggers other components on a schedule or in response to events within Dossier. Dossier Data Exchange The Dossier Data Exchange component [also referred to as Dossier Application Programming Interface (API)] is a component of Dossier that allows access to Dossier logic and data from external software applications. Software applications that utilize Dossier Data Exchange to connect to, extract data from, or enhance Dossier are called conduits (see "Integrated Components (Optional)" on page 2). Dossier IT Planning Manual 1

8 Integrated Components (Optional) McLeod LoadMaster Enterprise Integration McLeod LoadMaster Enterprise Integration is an optional component of Dossier that supports the integration of the McLeod LoadMaster Enterprise trucking dispatch operations management system with Dossier. LoadMaster Enterprise and Dossier exchange a subset of data that is common to both systems. LoadMaster Enterprise exports hub readings, fuel tickets, vendors, customers and payees, and mobile communication messages to Dossier. Dossier imports those items as meter readings, fuelings, vendors, customers, and work pendings, respectively, from LoadMaster Enterprise. Dossier exports units, PM status changes, repair orders, and inventory transactions to LoadMaster Enterprise as tractors and trailers, PM messages, vehicle maintenance journal entries, and Accounts Payable Vouchers. Active Alerts Active Alerts is an optional feature that allows event-driven messages to be sent via or text message to users. Some examples of Active Alerts are notifications sent when a repair order is closed, a unit's status is changed, or a preventive maintenance comes due. Tire Probe Dossier supports interfacing with a Pneu-Logic Tire Probe for tire pressure and tread depth readings. Database Server (Required) Dossier maintains a significant quantity of information about your fleet assets, their maintenance schedules, warranties, etc. Dossier utilizes Microsoft SQL Server to effectively store and access this information. Microsoft SQL Server is a scalable, enterpriseclass database server that is utilized in thousands of data centers around the globe. Microsoft SQL Server is available in several editions designed to meet your computing requirements and budget. For new installations, Dossier supports Microsoft SQL Server Standard edition and above. Support for Microsoft SQL Server Express editions is being deprecated for existing installations and will be removed in a future Dossier release. Reporting Server (Required) Dossier delivers numerous reports supporting thousands of users reporting on thousands of units, repair orders, etc. To effectively deliver this functionality, Dossier uses Microsoft SQL Server Reporting Services. Microsoft SQL Server Reporting Services is a component of Microsoft SQL Server and, therefore, supports the same editions as SQL Server. As with SQL Server, Dossier supports the Standard edition and above of Microsoft Reporting Services. 2

9 If Microsoft SQL Server Reporting Services are installed on the same computer as Microsoft SQL Server, it is recommended that the SQL Server memory is limited to minimize the impact to the performance of the reporting services. The amount to limit it to will depend on how much memory is available to the computer and what the expected SQL Server and reporting loads are. Remote Desktop/Terminal Services (Optional) Depending on your existing IT infrastructure and needs, larger installations of Dossier can benefit from the use of remote desktop servers. A remote desktop server or server farm can reduce the overhead of deploying and maintaining the Dossier client on your desktop computers. For customers with several hundred users, this can offer an appreciable benefit and savings. Dossier supports running in the full desktop mode of Microsoft Terminal Services, full desktop and RemoteApp modes of Microsoft Remote Desktop Services, and Citrix XenApp (Hosted Apps - Web or Desktop). Active Directory (Optional) Depending on your security requirements, Dossier supports two different access methods to the Microsoft SQL Server database: SQL Server Authentication and Windows Authentication (formerly Integrated Security). Dossier also supports the use of Active Directory for single login to Dossier, bypassing the need to enter credentials when starting Dossier. If you opt to use Windows Authentication for access to your Microsoft SQL Server Database or Dossier, you will use Microsoft Windows Server Active Directory to define your users and groups and their access to the Dossier database. This security model is supported only in networks that employ Active Directory. Dossier employs its own security mechanisms by default but can be configured to integrate with Active Directory or Windows user accounts. Although it is still necessary to create user accounts and manage permissions in Dossier, Windows or active directory accounts can be mapped to a Dossier user for the purpose of authentication. This is a system-level setting that allows for no integration, any account (Windows or Active Directory), or a domain-authenticated Active Directory account. A specific Active Directory domain can be specified for user authentication. Microsoft Message Queue (Required) Microsoft Message Queue (MSMQ) provides a framework for transferring messages between applications on the same or remote servers. Dossier Event Broker utilizes MSMQ to pass data back and forth as schedules trigger or Dossier data changes. SMTP Server (Optional) Dossier Active Alerts and certain reporting features require configuration of an accessible SMTP server to function. Microsoft SQL Server Reporting Services also requires Dossier IT Planning Manual 3

10 configuration of an SMTP server to deliver scheduled reports via . Firewalls Although not directly used by Dossier, the use of firewall software can impact your Dossier installation. Microsoft SQL Server, Microsoft SQL Server Reporting Services, Microsoft Remote Desktop Services, Microsoft Message Queues, and SMTP servers all have their own requirements related to firewalls and ports access/availability. Please refer to the documentation for each of the servers mentioned for specific information. 4

11 Dossier Network Architecture In the case of the single user, all of the components of Dossier can run on a single computer. However, most installations will have a least a few users who will need shared access to the Dossier database. This is accomplished by running Dossier over a network infrastructure. Individual User (or Several Users Sharing a Computer) The Dossier client, database server, and reporting server all run on a single computer. No network connections or servers are required. However, as your need for access to your fleet information increases, different network configurations can be utilized to scale the application along with those needs. Small Workgroup The Dossier client, database server, and reporting server all run on a single computer. Additional desktop computers in the network run the Dossier client and connect to the first computer for access to the database server and report server. Although this configuration is supported, it is not recommended. If the computer running the database server and report server crashes or is rebooted, connection issues and possible data loss can result. Small- to Mid-Sized Workgroup The database server and reporting server run on a single server computer. Desktop computers in the network run the Dossier client and connect to the server for access to the database server and report server. Large Workgroup The database server and reporting server each run on their own server computer. Desktop computers in the network run the Dossier client and connect to both the database and report servers. Corporation The Dossier transaction database runs on a single server. A copy(ies) of the transaction database runs on additional database servers for reporting use. SQL Server replication is utilized to synchronize the transaction and reporting database(s). Multiple Report servers are utilized. Ad-hoc and custom reports run from one report server. Microsoft Remote Desktop Services is used for the Dossier client and users utilize Remote Desktop Connection to access the Dossier client. Dossier IT Planning Manual 5

12 NOTE: Configuring replication for use with Dossier requires additional steps above and beyond typical replication configuration. Due to differences in environment, the process to establish and configure replication vary from customer to customer. Please contact Dossier Systems Customer Support at for a discussion on replication. Dossier Client Software Hardware Requirements Dossier client software hardware requirements vary depending on the network architecture employed (refer to "Dossier Network Architecture" on page 5). The requirements for running the Dossier client in the simplest configuration are greater than that of the other network configurations due to the fact that Dossier will be running on a computer alongside the database server and report server components. Please refer to the "Appendix" on page 17 for the minimum and recommended requirements. While the software will run with the defined minimum requirements, it is strongly recommended that a computer meeting the recommended requirements be used. When running the Dossier client software in other configurations, the desktop computer running the Dossier client requires a less capable hardware platform. Using a system that meets the minimum system requirements should suffice for a baseline desktop configuration. These recommendations are based on a computer running the minimum required operating system. The recommendation should be scaled up along with the operating system for later releases of Microsoft Windows. Dossier supports running within Microsoft Remote Desktop Services (formerly Terminal Server). Remote Desktop Services server hardware requirements differ from that of a standard desktop as multiple users can be connected and running Dossier simultaneously. Please refer to Microsoft s recommendations for Remote Desktop Services servers and for the desktops connecting to Remote Desktop Services servers. Dossier also supports Citrix XenApp. If you plan to operate Dossier within XenApp, please refer to the XenApp documentation for requirements and recommendations or contact Citrix. Security Considerations Dossier can be used to track information that can be considered sensitive, such as employee data, etc. Additionally, the data stored in Dossier can represent a significant amount of man hours to create. As such, planning security for the computer(s) on which Dossier runs is an important planning step and warrants thoughtful consideration. Dossier has its own integrated security model. Please refer to the Dossier Planning and Configuration Manual for further information. 6

13 Dossier Services Microsoft Windows employs several features that allow you to enhance the security of the computers running Dossier. Windows screen savers should be set to initiate after a period of inactivity and to require a password upon waking up. Safeguard the Windows and Dossier credentials used for computer access, especially those accounts with administrative rights. Furthermore, ensure that the computer on which the Dossier database and software is stored is secure from network intrusion. Run a commercial firewall on any computers directly connected to the Internet. In addition to software and network security, you should consider the physical security of the computer. Provide a location that is secured from users who should not have access to the information stored within Dossier. It should be a location that is free from excessive dirt, dust, vibration, etc. Event Broker Dossier requires exactly one Event Broker service be installed. Although this can run on the same computer that the Dossier client software is installed, this is not recommended. In most installations, the Event Broker will be installed on the same computer as any integrated components (e.g., McLeod), although they can be run from separate computers if necessary. The Event Broker service requires that Microsoft Messaging Queue (MSMQ) be installed. This component is a part of Windows that is not installed by default. It will be necessary to add this feature in Windows prior to installing Event Broker. The Dossier installer automatically installs Event Broker when Dossier Data Exchange is selected. Event Broker requires valid Dossier full user account or System account credentials to run. This account is configured on the Dossier Database Settings tab of the Dossier Event Broker Configuration Manager utility when the Event Broker is set up. Security Considerations (Dossier Services) At a minimum, any computer running Event Broker should practice the same security protocols defined for the Dossier client software (refer to "Security Considerations" on page 6). In addition, if you plan to run Dossier Event Broker on one computer and Integration Components that consume Event Broker events on another, you will need to configure Dossier Event Broker to use a Windows domain account for both Event Broker service and the service for the consuming component instead of a local Windows account. Dossier IT Planning Manual 7

14 Dossier Data Exchange (API) Hardware Requirements A computer meeting the minimum requirements specified in the "Appendix" on page 17should be sufficient to run Dossier Services. Dossier Services allow execution of third-party applications (conduits) against Dossier data. These third-party applications might have additional hardware requirements. Please refer to the software manufacturer s documentation. Security Considerations At a minimum, any computer running Dossier Data Exchange should practice the same security protocols defined for the Dossier client software (refer to "Security Considerations" on page 6). Applications that use Dossier Data Exchange require a Dossier system user account. If the application also utilizes Event Broker, you might need to specify this per conduit or per instance of a schedule. When choosing an account to use, make sure that the account is a system user account and that it has sufficient permissions and site access within Dossier to perform the actions required by the consuming application. The typical use case utilizes a Dossier user account that is part of the Administrators user group. Firewall Requirements While the Dossier Data Exchange does not impose any requirements for firewalls, components and integrations that consume the API might. For example, if the API is consumed via a web service, that web service will have Firewall requirements (HTTPS/port 80, 443). In this scenario, it is highly recommended to only allow HTTPS/Port 443. Integrated Components (Optional) Dossier Cloud Services (DCloud) DCloud may be installed alongside Dossier Services. This component requires that Dossier Data Exchange be installed on the same computer. Refer to "Dossier Data Exchange (API)" on page 8. If DCloud is installed on a different computer than Event Broker, both computers will require that Microsoft Message Queue (MSMQ) be installed. MSMQ is a component of Windows that is not installed by default. This feature must be installed in Windows prior to installing Event Broker. Hardware Requirements A computer meeting the minimum requirements specified in the "Appendix" on page 17 should be sufficient to run DCloud. 8

15 Firewall Requirements DCloud utilizes MSMQ internally on your network. Refer to "Firewall Requirements" on page 15 for a discussion on firewall settings. Additionally, DCloud utilizes HTTPS port 443 to connect to the dcloud.dossierondemand.com domain. If your firewall utilizes blacklist/whitelist functionality, you will need to whitelist this address/protocol. Active Alerts Active Alerts can be installed alongside Dossier Services. This component requires that Dossier Data Exchange be installed on the same computer. Refer to "Dossier Data Exchange (API)" on page 8. Active Alerts requires that Microsoft Message Queue (MSMQ) be installed on the computer where it is running. MSMQ is a component of Windows that is not installed by default. This feature must be installed in Windows prior to installing Active Alerts. Active Alerts requires access to an SMTP mail server, although the mail server does not need to reside on premises. If you intend to send mail outside of your domain, your mail server might have restrictions on and/or settings for message relaying. Hardware Requirements A computer meeting the minimum requirements specified in the "Appendix" on page 17 should be sufficient to run Active Alerts. Firewall Requirements Active Alerts utilizes MSMQ internally on your network. Refer to "Firewall Requirements" on page 15 for a discussion on firewall settings. Active Alerts must be able to connect to an SMTP mail server on a configurable TCP/IP port (defaults to port 25). McLeod LoadMaster Enterprise Integration McLeod LoadMaster Enterprise Integration may be installed alongside Dossier Services. This component requires that Dossier Data Exchange be installed on the same computer. However, installing the McLeod Loadmaster Enterprise Integration feature will automatically install Dossier Data Exchange. For more information, refer to "Dossier Data Exchange (API)" on page 8. If LoadMaster Enterprise is installed on a different computer than Event Broker. both computers will require that Microsoft Message Queue (MSMQ) be installed. MSMQ is a component of Windows that is not installed by default. It will be necessary to add this feature in Windows prior to installing Event Broker. Hardware Requirements A computer meeting the minimum requirements specified in the "Appendix" on page 17should be sufficient to run McLeod LoadMaster Enterprise Integration. Dossier IT Planning Manual 9

16 Security Considerations McLeod LoadMaster Enterprise Integration will require access to a folder shared with McLeod LoadMaster Enterprise to exchange data. Dossier installs the Dossier McLeod LoadMaster Enterprise Integration Service to use the local system account by default. If the folders shared with LoadMaster Enterprise reside on a different computer, you will need to configure the service with network credentials that have the privileges required to access this shared folder. Firewall Requirements McLeod LoadMaster Enterprise Integration utilizes MSMQ and requires firewall exceptions if it is not running on the same computer as Dossier Event Broker. MSMQ can use multiple TCP and UDP ports. Dossier only requires that the firewall be configured to allow traffic on TCP port Alternatively, you can allow TCP traffic to %systemroot%\system32\mqsvc.exe. Tire Probe Dossier must be installed locally and requires a computer with a Bluetooth receiver enabled for the Tire Probe to communicate with Dossier. To ensure that Dossier can detect the tire probe, make sure that the Bluetooth drivers that came with your Bluetooth receiver are installed. NOTE: The Bluetooth Tire Probe device does not function through Remote Desktop connections and will not work in environments deployed to use Terminal Services, Remote Desktop Services, or Citrix XenApp. Hardware Requirements A computer meeting the minimum requirements specified in the "Appendix" on page 17 should be sufficient to run Dossier and the Tire Probe. Security Considerations The Tire Probe solution should not have any impact on security. Firewall Requirements There should be no firewall configuration necessary to support the Tire Probe feature. Database Server - SQL Server Versions/Editions Supported Microsoft SQL Server ships in several editions designed to support various levels of scalability. It is important to note that Dossier is not tested against and does not support all SQL Server editions. For a list of the versions and editions supported for the current Dossier version, please refer to the "Appendix" on page

17 Hardware Requirements The specific hardware requirements for SQL Server vary dramatically based on the edition of SQL Server that you are using, the number of concurrent users, and their usage characteristics, and the size and composition of your Dossier database. Microsoft publishes minimum and recommended hardware and software requirements, which are available on their website at We recommend starting your hardware configuration with the recommended configuration for your SQL Server edition as a baseline and then scaling up as required. When planning your database server hardware configuration, there are several factors to consider. Microsoft SQL Server Reporting Services requires its own separate database to function. Its hardware requirements vary dramatically depending on your reporting needs. This can impact your hardware needs if your organization requires significant use of adhoc and/or scheduled reports. Also, consider that intelligent utilization of scheduled report delivery can off-load your reporting demands to non-peak hours and have a dramatic impact on your reporting needs and lower server requirements. Dossier can be configured to use a single database for both transactional data and reporting, or it can be configured to use one or more separate databases for reporting (for most reports). Although it supports running disparate transactional and reporting databases, Dossier does not manage the process of keeping the data synchronized. SQL Server Replication is a function of SQL Server used to manage replicating databases and can effectively maintain a near real-time copy of your transactional data for reporting purposes. Other database replication software can also be utilized as long as it supports Microsoft SQL Server. In any case, if you intend to separate transactional and reporting database activity, you should also plan for the overhead that replication adds. Microsoft SQL Server databases always consist of at least two files: one or more data files and a log file. In the case of Dossier there are three total files: one data file for Dossier transactional data, one data file for auditing data, and the SQL log file. It is possible to separate these three files onto two or three disks (or LUNs in the case of a SAN). In larger deployments this might be desirable so that the disk activity for each is isolated, allowing for better performance. In addition, certain SANs provide settings to optimize access for certain types of disk activity. This corresponds to SQL data vs. log files. If you do separate the log file and utilize a SAN, you might be able to exploit this ability. The retention time for auditing data stored in Dossier is configurable. Depending on the setting chosen, this data might grow to be substantial. You should balance the need to capture this information against the availability of/need for disk space within your environment. The ability to separate audit data can help in this regard as well. Microsoft SQL Server Licensing Requirements Each supported edition of Microsoft SQL Server imposes licensing requirements for the server running SQL Server and potentially each user connected to that server. The software license for Dossier does not include any licenses or fees for any edition of Microsoft SQL Server. Please contact Microsoft for questions concerning SQL Server licensing. Dossier IT Planning Manual 11

18 Database Maintenance All database server programs require some amount of database maintenance to continue to run optimally. SQL Server is no exception. A maintenance plan should be developed, executed, and monitored to ensure that these activities are performed on a routine basis. For further information, refer to Microsoft SQL Server documentation or contact Dossier Systems Customer Support at Disaster Recovery It is extremely important to employ a backup plan for Dossier. Your options and plan for backing up your Dossier database will vary depending on the version of SQL Server deployed, your usage characteristics, and how much time and effort you are willing to risk. A backup plan requires time, effort, and an investment in hardware and software. As you increase the backup frequency, reliability, and level of protection, you increase those investments. You should balance the cost of losing the information you store in Dossier against the investment in backup solutions. At a bare minimum you should manually perform a backup of Dossier once a week to external computer media (such as a USB drive or external hard disk), and keep a copy offsite. For further information regarding SQL Server database backups, please refer to the Dossier Installation Manual and to Microsoft s documentation and website ( Security Considerations During installation of the Dossier Essentials edition, the installer creates two SQL Server user accounts (D32admin and dossier_admin) and two SQL Server roles (dossier and dossier_admin). The D32admin account is assigned the Dossier role and the dossier_admin user is assigned the dossier_admin role. Other Dossier editions will create the D32admin user and both the D32admin and dossier_admin roles but does not create the dossier_ admin user. If installing the Professional edition, you will need to manually configure either a SQL user or an Active Directory user to be a member of the dossier_admin role. This account will be used when configuring the Event Broker component of Dossier as it requires more rights than the normal Dossier database role allows. By default, Dossier uses the D32admin account to connect to SQL Server and perform all its operations. Dossier s default configuration is generally sufficient for most customers. However, if your organization requires a greater level of security, Dossier also fully supports the Windows Authentication SQL Server security mechanism (formerly called Integrated Security). Windows Authentication allows you to specify database permissions based on the user logged into Windows on the machine where Dossier is running. Using this model of security, it is typical practice to utilize user groups to administer permissions and assign individual users to the appropriate user group. You should assign the dossier role to user accounts or groups that require access to run Dossier. For further information regarding 12

19 SQL Server security, please refer to the Microsoft SQL Server documentation and website ( Firewall Requirements In its default configuration, Microsoft SQL Server requires TCP port 1433 to communicate. Although it is not recommended to run, SQL Server browser requires UDP Port Please refer to Microsoft knowledge base article and the MSDN article at for further information on SQL Server and firewall requirements. SQL Server Reporting Services Dossier uses at least one Microsoft SQL Server Reporting Services instance to provide reporting capabilities. The Dossier Installer can setup and configure a SQL Server Reporting Services instance running alongside Dossier and SQL Server. This installation is sufficient for small customers with a relatively low amount of usage. Midsize and large customers as well as small customers with heavy Dossier usage should consider installing SQL Reporting Services on a separate server. For all but the largest customers, a server housing both SQL Server and SQL Server Reporting Services should suffice as long as the hardware is scaled sufficiently to accommodate both. However, customers with a large number of users or heavy Dossier utilization should consider running at least one separate server for SQL Server Reporting Services. Although scheduled and user-defined reports must run from a common server, Dossier supports an unlimited number of ad-hoc report servers. Versions/Editions Supported As part of the Microsoft SQL Server product offering, Microsoft SQL Server Reporting Services (SSRS) is included in and scales with the various editions as SQL Server. As with SQL Server, Dossier is not tested against and does not support all SQL Server Reporting Services editions. For a list of the versions and editions supported for the current Dossier version, please refer to the "Appendix" on page 17. Hardware Requirements The specific hardware requirements for SQL Server Reporting Services vary depending on the edition of SQL Server that you have licensed and your reporting usage. Microsoft publishes minimum and recommended hardware and software requirements, which are available on their website at We recommend sizing your hardware with the recommended configuration for your SQL Server edition as a baseline and sizing up as required. Dossier IT Planning Manual 13

20 Microsoft Licensing Requirements (Server and User) Although it ships as a component of Microsoft SQL Server product, a single license for SQL Server allows you to run SQL Server and SSRS on a single machine only. If your plans include running SSRS on an isolated server, a separate license will be required to do so. The software license for Dossier does not include any licenses or fees for any edition of Microsoft SQL Server, including SQL Server Reporting Services. Please contact Microsoft for questions concerning SQL Server licensing. Security Considerations By default, the Dossier server installation option creates a Windows user during the install process with a random password on the machine that is running Reporting Services. This is a privileged user in Reporting Services, with access to create, delete, run, and administer running reports. However, it is an underprivileged user account in Windows. Dossier also supports running using Trusted security. With Trusted security, the user account used to run reports is the user account with which the Dossier user is logged onto Windows. Utilizing this security model can provide a more secure operating environment at the cost of simplicity. You can manage Reporting Services security at a user level. However, in this configuration it is more common to employ user groups to manage Reporting Services security and assign users to those groups as required. Depending on your organization s security requirements, you might want to enforce security in this manner. With additional licensing, Dossier also supports creating and importing user-defined reports. It is possible to use user-defined reports for malicious purposes or to circumvent Dossier security. You should consider limiting the ability to author and inventory userdefined reports to a select group of trusted users. Never inventory or run a custom report that is from an unknown or untrusted source. Firewall Requirements SQL Server Reporting Services utilizes an HTML web service/site to deliver reports to end user desktops. Any firewall software should allow both HTTP (TCP port 80) and HTTPS (TCP Port 443) traffic. 14

21 Microsoft Message Queue (MSMQ) Dossier Event Broker uses MSMQ to notify other components of Dossier and interfaces to third-party software of scheduled activity and changes to Dossier data. MSMQ is not installed by default with Windows. You will need to install MSMQ prior to installing the Dossier Event Broker. MSMQ can run in Private or Public mode. Private mode involves only the machines on which Event Broker and the component that uses Event Broker are installed. Public mode is for Microsoft networks and uses Active Directory to store the messages. The advantage to this is durability. Even if the machine that houses the Event Broker subscriber crashes and is unrecoverable, the messages will still be available for processing when the system is replaced. Dossier Event Broker can be configured to use either mode. Versions/Editions Supported Dossier supports all versions of MSMQ that ship with supported operating systems. Security Considerations Although certain installations of MSMQ can require some security consideration, the typical Dossier installation uses MSMQ in a manner that this should be unnecessary. Dossier does not utilize RPC and does not require that RPC ports be open through the firewall. Firewall Requirements SMTP Server MSMQ can use multiple TCP and UDP ports. Dossier only requires that the firewall be configured to allow traffic on TCP port Alternatively, you can allow TCP traffic to %systemroot%\system32\mqsvc.exe. Access to an server is required for certain functionality within Dossier, such as Active Alerts, AD-Hoc reporting, and scheduled report delivery. Dossier does not require any specific server software. Dossier can utilize any server that implements SMTP. Dossier is known to function correctly when utilizing Microsoft Exchange Server and hmailserver. If user authentication is required by the SMTP server, Dossier and Microsoft SQL Server Reporting Services must be configured to use a security account with sufficient rights to send using the specified SMTP server. Depending on your server, additional configuration might be required if is being sent beyond the local domain (SMTP relay). Dossier IT Planning Manual 15

22 Dossier supports either clear text connections or secure connections to SMTP servers utilizing TLS (but not SSL). The default TCP/IP port for TLS access to SMTP is 587, although Dossier also supports non-default SMTP ports with or without TLS. When ing ad-hoc reports, Dossier supports configuring globally and on each Dossier site. When an ad-hoc is sent from within Dossier, the Site settings for the site for which the user is configured override the Setup options configured globally. A hybrid of settings can also be utilized (e.g., the Reply To address is configured at the site but all other settings are pulled from global Setup options). For further Dossier configuration information, refer to the Dossier Planning and Configuration Manual. For further configuration information about Microsoft SQL Server Reporting Services, refer to Microsoft documentation or contact your SQL Server administrator. NOTE: Depending on Active Alerts configuration and the size and implementation of Dossier, a substantial amount of messages can be generated. Use caution when configuring Active Alerts. Security Considerations Dossier can be configured with credentials to use when connecting to an SMTP Server. It is highly recommended to require credentials in conjunction with relaying on the SMTP server. Alternatively, most server software allows specification of an IP address that is permitted to relay messages. Beyond message relaying, a discussion of security as it relates to SMTP and servers in general is beyond the scope of this document. Firewall Requirements The SMTP TCP/IP port that Dossier uses to communicate with the server is configurable within Dossier. The default port for SMTP is 25 (clear text). Any firewall must be configured to support the desired port. 16

23 Appendix System Requirements Dossier will operate on a stand-alone PC or over a network with multiple users. It can also be run in an application server environment using Citrix or Microsoft Remote Desktop Services. The following are general requirements. More detailed specifications can be developed based on your specific needs (functionality, optional features, fleet size, network topology, number of users, etc.). Operating Systems and SQL Database should use the latest Service Pack level available from Microsoft. Desktop System Requirements CPU Operating System RAM Memory Minimum Intel Core I3 or equivalent Intel Xeon E3 or equivalent Windows 7 Professional (32-bit) 1 Windows 7 Professional (64-bit) 1 Windows 8.1 Professional (32-bit) Windows 8.1 Professional (64-bit) Windows 10 Professional (32-bit) Windows 10 Professional (64-bit) Windows Server 2008 (32-bit) 1 Windows Server 2008 (64-bit) 1 Windows Server 2008 R2 (64-bit) 1 Windows Server 2012 (64-bit) 4 GB on 32-bit operating systems 8 GB on 64-bit operating systems Recommended Intel Core i5 or better Intel Xeon E5 or better Windows 7 Professional (64-bit) Windows 8.1 Professional (64-bit) Windows 10 Professional (64-bit) Windows Server 2012 R2 (64-bit) 16 GB on 64-bit operating systems Disk Memory 20 GB Free Space 20 GB Free Space 2 Video 1024 x x 1024 (or greater) Network 1 Gbps wired network connection 3 Database Standard 4 editions of : Microsoft SQL Server Microsoft SQL Server 2008 R2 1 Microsoft SQL Server 2012 with SP1 Microsoft SQL Server 2014 Microsoft SQL Server 2016 Microsoft SQL Server 2012 with Sp1 Microsoft SQL Server 2014 Microsoft SQL Server Support for SQL Server 2008, SQL Server 2008 R2, Windows Server 2008, and Windows Dossier IT Planning Manual 17

24 Server 2008 R2 will be deprecated in a forthcoming Dossier release. For new Dossier implementations, we highly recommend newer server operating systems. 2 This represents the space required for the Dossier client and does not account for database size. Database size can vary dramatically depending on your use of the product. 3 A network connection is required when running the Dossier client on multiple computers. A wired connection is required when/if the Dossier client is installed locally and accessing Microsoft SQL Server on a remote server. In instances where Dossier is accessed via a Remote Desktop Server or similar technology, a network connection is required but does not need to meet the minimum specifications noted above as long as it meets the requirements for the remote desktop connection. However, note that the Remote Desktop Server itself should meet the minimum requirements and might require significant scaling depending on the number of users and workload. 4 SQL Server Standard is not provided as part of Dossier and must be supplied by the customer. While SQL Server Express Editions were supported in the past, they are no longer supported for new installations. Additionally, support for SQL Server Express editions will be deprecated for all customers in a forthcoming Dossier release. Server, Network, and Router Requirements As each installation s data server, topology, and network requirements are different, please contact Dossier Customer Support at or at Support@DossierSystemsInc.com for network deployment discussions. The only requirement that can be simply stated is that all interconnected Dossier nodes must have sustained communications throughput of 1 Gbps or greater. If this throughput cannot be achieved (typical of WAN installations), Dossier must be deployed using Citrix or Microsoft Remote Desktop Server technologies. For deployments where Dossier is run locally (not utilizing Remote Desktop Services or Citrix XenApp), a wired network connection is required. 18