CAFM Explorer Easy Install Guide

Contents

1 Introduction ................................................................... 3
1.1 Pre-Requisites ...................................................................................... 3
1.1.1 Database Server ................................................................................... 3
1.1.2 Application Server ................................................................................ 5
1.1.3 Client Machines .................................................................................... 6
1.2 PRE-INSTALLATION Tasks .................................................................... 6
1.3 Create a Fileshare ................................................................................ 6
1.4 Manual or Remote Deployment .............................................................. 7
1.5 Important Notes for Existing Customers ................................................. 7
1.6 Important Notes for ALL Customers ....................................................... 8
2 Installing CAFM Explorer with Easy Install ...................... 10
2.1 Installation Process – New Install......................................................... 10
2.1.1 First Time Installations .................................................................................... 10
2.1.2 Typical option ................................................................................................ 15
2.1.3 New Customer option ..................................................................................... 21
2.1.4 Custom option ................................................................................................ 28
2.2 Upgrading an existing Installation ........................................................ 40
2.2.1 CAFMCAD Drawing Migration........................................................................... 41
2.2.2 MINOR Release upgrade ................................................................................. 41
2.2.3 MAJOR Release upgrade ................................................................................. 44
2.3 Post Installation procedures ................................................................ 46
2.3.1 Typical Install ................................................................................................. 46
2.3.2 New Customer and Custom Install ................................................................... 50
2.3.3 Custom Install ................................................................................................ 71
2.4 Component Modify, Removal or Repair Process ..................................... 73
3 Licensing CAFM Explorer ............................................... 78
4 Appendices................................................................... 81
Appendix 1 – How to check and configure SQL Server Authentication Mode ........... 81
Appendix 2 – SQL Server version ....................................................................... 83
Appendix 3 – Health Check ................................................................................ 85
Appendix 4 – Windows 8, 8.1, 10 ....................................................................... 86
Appendix 5 – Microsoft .NET Framework............................................................. 86

Idox plc © CAFM Explorer - 11.0.0 Page 2 of 88

 CAFM Explorer Easy Install Guide

1 Introduction

1.1 PRE-R EQUISITES

There are certain components that must be in place on both Client and Server machines
before proceeding with an installation of the CAFM Explorer Product Suite.
1.1.1 D ATABASE S ERVER

IMPORTANT:
The documents ‘Hardware Software Specifications’ and ‘SQL Server Database
Prerequisites’ will contain the latest requirements and must be read, fully
understood and their contents adhered to before attempting to install, configure
and connect CAFM Explorer to a database.

The data used by the CAFM Explorer Application is held in a Database running on a Microsoft
SQL Server. CAFM Explorer Databases can only be installed on a Microsoft SQL Server
platform that meets the current specifications.
Please note that:
➢ For single User, Test Environments or very small implementations, it is possible to
install one of the Express or Developer editions on a Client machine and use this to
host the CAFM Databases.
➢ Express editions will also require installation of the SQL Management tools. Both
Applications are available as a free download from the Microsoft website.
➢ Express editions only support a maximum of five concurrent worker threads.
For larger deployments and Enterprise Solutions, it is recommended that the Databases are
hosted on a full version of the Microsoft SQL Server Application (Standard or Enterprise
editions) running on a Database Server within the Enterprise, with suitable solutions in place
for resilience, redundancy and an appropriate backup solution.

Important Notes.
Adding CAFM Explorer authenticated users
It is necessary to add two users to the Server before starting the Install Process. The process
is described below:
1. Open Microsoft SQL Server Management Studio
2. Connect to server
3. Navigate to the server, then double click on “Security” and then “Logins” as shown below
(This example uses SQL 2014, the screens may differ between versions):

Idox plc © CAFM Explorer - 11.0.0 Page 3 of 88

 CAFM Explorer Easy Install Guide

4. Right click over the Logins area of the screen and select “New Login”

5. Select SQL Server authentication

6. Enter the user name cafm_user in ‘Login name’ field
7. Enter cafm_user in the ‘Password’ field
8. Enter cafm_user in the ‘Confirm password’ field
9. Ensure ‘Enforce password security’ is not selected
10. Repeat this process for cafm_reader with a password of cafm_reader
These users will be given appropriate permissions when CAFM Data Source Builder is used
later, see Section 2.4.2.1.

Idox plc © CAFM Explorer - 11.0.0 Page 4 of 88

 CAFM Explorer Easy Install Guide

Acceptance of external connections

SQL Server Express and Developer editions are by default locked down to prevent
connections from other machines. For information on how to configure a locked down SQL
Server to accept external connections, see Appendix 2.
This guide assumes that you will be using SQL Server Authentication to connect to the CAFM
Databases and therefore, the SQL Server must be in Windows and SQL Authentication Mode.
If you intend to use Windows Authentication, please see Section 2.4.2.1.1. You may of
course contact the Idox Help Desk for further information.

SQL Server Configuration

The default installation setting for Microsoft SQL Server Authentication is ‘Windows Only’ but
the default configuration for the CAFM Explorer Applications is to use ‘SQL Authentication’.

If an attempt is made to connect to a CAFM Explorer Database using SQL Authentication but
with the SQL Server configured to use Windows Authentication only, the following message
will be displayed:

Login failed for user ‘cafm_user’. Reason: Not associated with a trusted SQL Server
connection

For information on how to check the SQL Server Authentication method currently being used
and how to change the Authentication Mode, see Appendix 1.
When building a new CAFM Explorer database using the CAFM Data Source Builder
application a check will be made on the Server mode and appropriate options provided.
Please see Section 2.4.2.

1.1.2 A PPLICATION SERVER

If there is a requirement to automatically generate reports, automate data imports/exports or

send automated messages from the CAFM Explorer Applications via email or fax etc, it will be
necessary to install the CAFM Services Manager. This should be installed on an Application
Server (which can be the same Server as the SQL Database Server) with the following pre-
requisite in place: -
Microsoft .Net Framework Version 4.5 only for CAFM versions from 2012.05.20 to
CAFM 9.2.3
Microsoft .Net Framework Version 4.6.2 certified for CAFM 9.3 onwards.
Microsoft .Net Framework Version 4.7.0 supported for CAFM 9.3.1 onwards.
Important Notes:
1. If CAFM Services are required there are various options.
a. CAFM Service Manager Classic – If legacy Mail Services are required then
this option should be chosen; this is only available in 32-bit.
b. CAFM Services Manager
This is now available in two flavours, 32-bit and 64-bit, both contain the
latest SMTP Email Service. In either case please see ‘Easy Install Guide -
CAFM Services Manager.pdf’

Idox plc © CAFM Explorer - 11.0.0 Page 5 of 88

 CAFM Explorer Easy Install Guide

i. If your server is 64-bit and you do not, or will not, use the People
Import Service then you may select the 64-bit installer.
ii. If your server is 64-bit and you do, or will, use the People Import
Service then you should select the 32-bit (X86) installer.
2. If the 32-bit (X86) option is selected in a 64-bit environment the SAP Crystal
Reports Runtime Engine will not be installed automatically and must be installed
manually. Please see Section 2.2.1 Step 2.). NB: The above statement only applies
for CAFM Explorer installations prior to CAFM 10.2; from CAFM 10.2, the SAP Crystal
Reports Runtime Engine must be installed manually before CAFM Explorer.

1.1.3 C LIENT MACHINES

Any Client Machine requiring the CAFM Explorer Applications will need to have the following
pre-requisites in place: -
MDAC 2.8 components
Microsoft .Net Framework Version 4.5 only for CAFM versions from 2012.05.20 to
CAFM 9.2.3.
Microsoft .Net Framework Version 4.6.2 certified from CAFM 9.3 onwards. NB:
this is also a pre-requisite if using AutoCAD 2017.
Microsoft .Net Framework Version 4.7.0 is supported for CAFM 9.3.1 onwards.
It is highly recommended that the Microsoft .Net Framework is installed prior to the
installation of CAFM Explorer. From version 11.7.1 onwards, during installation of the Product
Suite you can download and install it. A reboot of the PC may be required but the Product
Suite installation will continue from where it left off. See Section 2.2.
The appropriate SAP Crystal Reports Runtime Engine.

1.2 PRE-INSTALLATION TASKS

To ensure that the Installation Process runs smoothly and that you have the correct details to
enter at the various prompts throughout the Installation, it is recommended that the following
Pre-Installation tasks are carried out.

1.3 C REATE A FILESHARE

If you are installing for a single User or a Test/Development Environment, you may decide
that this step is not necessary.
The fileshare will contain all the common files used by the CAFM Applications and avoids the
need to replicate many files on each Users machine and/or the nominated Application Server.
It also greatly simplifies the task of upgrading any of these files as it will only need to be
performed in the one place and not on every Users machine.
This guide assumes that the fileshare created follows a format along the lines of: -
\\<Server Name>\CAFMShare\
With sub folders of: - Config
Dictionary
Help
QueueAttachments

Idox plc © CAFM Explorer - 11.0.0 Page 6 of 88

 CAFM Explorer Easy Install Guide

Reports
Templates
The Users of the CAFM Applications will require Modify permission to the CAFMShare file
structure. If any of the CAFM Services are required (see Section 2.1 for details of Services)
then the Account running the Service will also require Modify permission to this fileshare.

1.3.1 Create a Service Account

If you have decided that it is necessary to install any of the CAFM Services, it is
recommended that a dedicated Service account is created to run the Services under. If the
CAFM Database, fileshare and any CAFM Services are all running on a single machine or
Server, this account can be a Local Account. If any of these components are on a different
machine, it will normally be necessary to run the Services using a Domain Account.
The Service Account should be created with a password that never expires and typically
needs to be a member of the Power User or Administrators Group on the machine where the
CAFM Services are installed. The Account will also need to have permissions to the CAFM
Databases with Write & Delete permissions (typically assigned the role of DBO) and Modify
permission to the CAFM fileshare holding the CAFM Reports, Templates and Queue
Attachments.

1.4 M ANUAL OR R EMOTE D EPLOYMENT

If the Client Applications (CAFM Explorer and CAFM Report Explorer) are to be installed using
remote deployment tools such as SMS, Zenworks, Altiris, Etc, then contact Idox for
assistance. For all manual installations, the CAFM Explorer Product Suite Installer, also
referred to as the “Easy Install” product should be used.

1.5 I MPORTANT NOTES FOR EXISTING CUSTOMERS

➢ If you are an existing customer, you should undertake the upgrade process in
the following order:
1. Ensure you have the installation package used for the current working version
of CAFM Explorer available (see step 5).
2. Log in to CAFM Explorer as a System Administrator, open Tools > Maintain
User Accounts and, if not already set, edit the ‘migration’ user by granting it
access to ALL companies and allocate one company as the default Company.
Save the changes.
3. Backup the database (instructions on this are provided later).
4. If CAFM Data Source Builder is installed standalone on a server or client,
then uninstall it and reinstall it from the latest Software package. If not
installed standalone it will be necessary to uninstall one instance of CAFM
Explorer on a client PC and install the latest version together with CAFM Data
Source Builder using the ‘Custom’ option.
5. Carry out the database upgrade using the CAFM Data Source Builder.
a. If not successful, report the failure immediately to Idox then restore
the backed-up database to allow the remaining Client PCs to
continue working. If appropriate uninstall the software from the
Client PC used and install the earlier version (Step 1 above) to allow
this Client PC to continue working with the restored database.

Idox plc © CAFM Explorer - 11.0.0 Page 7 of 88

 CAFM Explorer Easy Install Guide

b. If successful, test the connection using the newly installed instance

of CAFM Explorer; be aware of the new Licensing
arrangements from CAFM Explorer 10.4 discussed later in
this document. If this step is successful, you may upgrade the
software on all remaining Client PCs.
6. CAFM Service Manager
a. Take a copy of the existing Configuration file
b. Uninstall
c. Reinstall using the ‘Custom’ option from the latest CAFM installer
d. Configure by referring to the copied Configuration file.
➢ Please read the associated Release Notes for the current version
before running the Easy Install particularly the pre-requisite that any
previous version of CAFM Explorer is uninstalled. If you are in any doubt,
please contact Idox for assistance.
1.6 I MPORTANT NOTES FOR ALL CUSTOMERS

➢ When using Easy Install from CAFM Explorer 9.2 onwards the files will, by
default, install to the following location: C:\Program Files\Idox Software\CAFM
Explorer Product Suite. If this location does not exist, it will be created
automatically.
Easy Install is started by selecting the appropriate .msi file within the Production
Release folder, dependent on whether the Operating System is 32-bit or 64-bit;
both options are provided.
Once you have this information then select the correct option, e.g. in a 64-bit
environment select Product Installation>x64>v4.6.2> Idox CAFM Explorer
>CAFMExplorer_x64.msi, i.e.:

It is essential the correct environmental options are selected before starting the
installation; fuller details can be found in the accompanying Release Notes.
➢ Please be aware of special requirements if CAFMCAD is to be installed
(Step 13c of Custom Install below).
o When installing CAFMCAD, standalone or as part of the Product Suite,
bitness must match the version of AutoCAD installed, e.g. If AutoCAD
2017 64-bit is already installed, then you must install CAFMCAD 64-bit.
o The following diagram confirms the supported AutoCAD versions at the time
of writing and the installation options that are available. NB: For details of
compatibility with AutoCAD Architecture (formerly ADT or Architectural
Desktop Edition) please see the Hardware and Software Specifications for the
current release version.

Idox plc © CAFM Explorer - 11.0.0 Page 8 of 88

 CAFM Explorer Easy Install Guide

CAFM Explorer 10.3.0 (10.03.00) and later

OS .Net AutoCAD Version

Framework 2012 2013 2014 2015 2016* 2017* 2018* 2019*
32-bit v4.5
64-bit v4.5
32- bit v4.7
64-bit v4.7
* Plus latest Service Packs

Certified

Supported

Unsupported

Please see respective Release Notes and Easy install Guide for previous versions
➢ Follow the onscreen prompts to install the Application for which there are
comprehensive instructions provided in Section 2.2 (New install) and 2.3
(Upgrading existing version). The latest Release Notes will also assist with this
process.
➢ If you have previously been provided with a Custom Report package please
discuss the upgrade with the Idox Help Desk before proceeding with the
installation.

Idox plc © CAFM Explorer - 11.0.0 Page 9 of 88

 CAFM Explorer Easy Install Guide

2 Installing CAFM Explorer with Easy Install

2.1 I NSTALLATION PROCESS – N EW INSTALL

2.1.1 First Time Installations

Step 1
Pre-requisites for the installation of the CAFM Explorer Product Suite are:
• The Microsoft .NET Framework
• SAP Crystal Reports runtime engine
The .NET Framework is dependent on the machine specification. Its download from the
Internet and its installation can take a considerable time and may demand a reboot. As such,
particularly in cases where the install is on a Server, it is strongly recommended that the
installation of Microsoft .NET Framework takes place prior to installation of CAFM
Explorer. The version of the Framework is discussed below. If you wish to check the
version currently installed, please see Appendix 5.
The SAP Crystal Reports runtime engine is available in the same folder as the CAFM Explorer
Product Suite, i.e.:

Double click the CRRuntime_64bit_13_0_10.msi (or 32bit equivalent if appropriate). The

following screen will be presented:

Press Next, select the ‘I accept the License Agreement’ radio button, press Next and follow
the wizard, press Finish on the last page to complete the installation.

Idox plc © CAFM Explorer - 11.0.0 Page 10 of 88

 CAFM Explorer Easy Install Guide

Step 2
The CAFM Explorer Easy Install is started from within the appropriate folder on the media
provided or from the folder where the Product Suite was downloaded; see Section 1.6 above.
Double click the CAFMExplorer_x64.msi file (or the 32 bit equivalent) to start the Setup
Wizard. If the current user does not have Administrator permissions, then this will need to be
“Run as Administrator”.
NB: In the event the ‘SAP Crystal Reports runtime engine for Microsoft .Net Framework 4’, is
not currently installed, a warning will be displayed. Press OK to the warning, press Finish to
abort the installation then revert to Step 1 and proceed again to this point.

Press Next to start the installation.

Step 3

Idox plc © CAFM Explorer - 11.0.0 Page 11 of 88

 CAFM Explorer Easy Install Guide

Select “I accept the terms of the license agreement” then press Next

Step 4

Accept the default installation location or select Change to provide an alternative location on
the Target Machine, then press Next.

Step 5
Three Installation options are displayed

Idox plc © CAFM Explorer - 11.0.0 Page 12 of 88

 CAFM Explorer Easy Install Guide

Typical
The Typical option within the easy install will install just the CAFM Explorer and CAFM Report
Explorer Client Applications on the Target Machine. Section 2.1.2 describes the Typical
option.
New Customer
If this option is selected, CAFM Explorer, CAFM Report Explorer and the CAFM Data Source
Builder will be installed. This will allow the User to create an empty CAFM Explorer Database
(also referred to as datastore) on an available instance of Microsoft SQL Server (see Section
1.1 for pre-requisites). Section 2.1.3 describes the New Customer option.
Custom
Section 2.1.4 describes the Custom option that allows the following additional optional
components to be installed:
Queue Monitor Allows CAFM Users to monitor outbound CAFM Email and
Fax traffic
CAFMCAD The interface between CAFM and AutoCAD
CAFM Today Standalone installation to allow ‘real-time’ monitoring of
CAFM Explorer
CAFM Data Source Builder CAFM Application used for the creation of an empty CAFM
Database and Queue database, upgrade of an existing CAFM
Database and Health Checks of existing CAFM databases.
CAFM Service Manager An application that allows configuration of various (optional)
Services. These Services are listed below and further details
can be found in Section 2.4.3.1.
Work Order Completion CAFM Service to automate closure of open Work Orders
Service generated from Room Booking Equipment or Service
Requests
People Import Service CAFM Service to automate the import of person records
from other Applications
Work Order by Email Service CAFM Service to create Reactive Work Orders from an Email
configured to work with a specific Standard Work Order
Document Control Service CAFM Service to synchronise documents between CAFM
Explorer and the Document Controller
Barcode Generation Service CAFM Service to generate Barcodes
IIS Keep Alive Service CAFM Service to keep IIS running by polling a page every ‘n’
minutes, effectively emulating a real person sending a page
request
Issue (formerly Planned) Work CAFM Service to automate the issue of Virtual Planned Work
Orders Orders
Labour Charge Completion CAFM Service to periodically process each "In Progress"
Service Labour Charge and, if the associated Trade Code is flagged
to automatically Complete Labour Charges, it will Complete
all those Labour Charges appropriately.
Report Runner Service CAFM Service to automate the processing of CAFM Reports
and delivery to selected recipients via the configured CAFM
Mail Service

Idox plc © CAFM Explorer - 11.0.0 Page 13 of 88

 CAFM Explorer Easy Install Guide

Room Booking Reminder CAFM Service to send reminders of bookings to a person

Service who has booked the Room/Facility
Work Order De-Schedule CAFM Service to remove Scheduled Work Orders from the
Service Work Planner if the work has not been started on the
selected Schedule Date
CockpitAlerter CAFM Service to alert when Budget spend exceeds
anticipated spend
SMTPEmailer CAFM Mail Service using SMTP protocols.
DO NOT activate this Service if the CAFM Service Manager
Classic version (below) is installed

CAFM Service Manager If the above Custom install is used but a legacy mail service
Classic is required, then this standalone Service can be installed
alongside.
SMTP Mail Service1 CAFM Mail Service using SMTP protocols
MAPI Service CAFM Mail Service using MAPI protocols
FaxMaker Service CAFM Service to send Faxes via Third Party Application,
called GFI FaxMaker

1 There should only be one Mail Service installed per CAFM System

Idox plc © CAFM Explorer - 11.0.0 Page 14 of 88

 CAFM Explorer Easy Install Guide

2.1.2 Typical option

Step 1
At the previous ‘Choose Setup Type’ screen, select the Typical button.

Either select the Standard option to configure the Client Applications to present each User
with a CAFM login box or select the Windows Authentication option (please see Section
2.4.2.1.1) to enable the recognised Users of the Client Applications to bypass the CAFM login
box then press Next.
For both options, the User login details will need to first be configured in the CAFM Explorer
Application. See Getting Started manual for this procedure.

Step 2
Select the location where the Datastores.xml file can be found by the Application.
For a single User scenario, the default folder on the local machine would typically be used.
For an Enterprise Solution, typically this will be in a folder on a fileshare (see Section 1.3). In
this event the ideal format would be a UNC (Universal Naming Convention) file path in the
format \\<servername>\<sharename>, see screenshot below for an example.

Idox plc © CAFM Explorer - 11.0.0 Page 15 of 88

 CAFM Explorer Easy Install Guide

Press Next.

Step 3
The Default connection is the Name given to the Connection String for the Database that the
CAFM Applications will default to using when they are first started.
Accept the default (unless you have changed the Connection String Name in the
datastores.xml file) then press Next.

Idox plc © CAFM Explorer - 11.0.0 Page 16 of 88

 CAFM Explorer Easy Install Guide

Screenshot showing a typical datastores.xml file. The Connection String name is highlighted.

Step 4
The Queue Attachment folder is where email attachments generated by the CAFM
Applications are stored before being picked up by the CAFM Email Service and sent to the
recipient.
For a single User scenario, the default folder on the local machine would typically be used.
For an Enterprise Solution, typically this will be a folder in a fileshare (See Section 1.3). The
ideal format would be a UNC (Universal Naming Convention) file path in the format
\\<servername>\<sharename>, see screenshot below for an example.

Press Next.

Idox plc © CAFM Explorer - 11.0.0 Page 17 of 88

 CAFM Explorer Easy Install Guide

Step 5
The CAFM Report files folder is where the Reports to be used by the CAFM Applications are
stored.
For a single User scenario, the default folder on the local machine would typically be used.
For an Enterprise Solution, typically this will be a folder in a fileshare (See Section 1.3). The
ideal format would be a UNC (Universal Naming Convention) file path in the format
\\<servername>\<sharename>, see screenshot below for an example.

Press Next.

Step 6
Select the required options for shortcut creation on the Target Machine.

Idox plc © CAFM Explorer - 11.0.0 Page 18 of 88

 CAFM Explorer Easy Install Guide

Press Next.

Step 7

Either press Back to make any changes or confirm your settings by pressing Install.

Step 8
A progress bar will be displayed to indicate how the installation is proceeding.

Idox plc © CAFM Explorer - 11.0.0 Page 19 of 88

 CAFM Explorer Easy Install Guide

Step 9
Upon completion, the following window will be displayed.

Select Finish to exit the installer.

Step 10
From CAFM Explorer 10.4, the arrangements for licensing CAFM Explorer have changed.
Please see Section 3.
It may now be necessary to perform some post installation tasks before the Applications can
be used. See Section 2.4 for further details.

Idox plc © CAFM Explorer - 11.0.0 Page 20 of 88

 CAFM Explorer Easy Install Guide

2.1.3 New Customer option

Step 1
The New Customer install should be used for the most basic (usually single User)
installation or for a Test/Development Environment. This option will install the CAFM Explorer,
CAFM Report Explorer and CAFM Data Source Builder Applications. The CAFM Data Source
Builder enables the User to create an empty CAFM Explorer Database on a Microsoft SQL
Server instance running on a Server or the local machine (see Section 1.1.1 of this document
for the SQL Server requirements).
Proceed as described in Section 2.2.1 above and select the New Customer option.

Press Next

Idox plc © CAFM Explorer - 11.0.0 Page 21 of 88

 CAFM Explorer Easy Install Guide

Select Cancel to quit the installation or, assuming you have read and understood the
conditions and wish to proceed, select the radio button ‘I have read the database
checklist’; this will enable the Next button.
Press Next.

Step 2
Either select the Standard option to configure the Client Applications to present each User
with a CAFM login box or select the Windows Authentication option (please see Section
2.4.2.1.1) to enable the recognised Users of the Client Applications to bypass the CAFM login
box then press Next.
For both options, the User login details will need to first be configured in the CAFM Explorer
Application. See Getting Started manual for this procedure.

Step 3
Select the location where the Datastores.xml file can be found by the Application.
For a single User scenario, the default folder on the local machine would typically be used.
For an Enterprise Solution, typically this will be in a folder on a fileshare (see Section 1.3). In
this event the ideal format would be a UNC (Universal Naming Convention) file path in the
format \\<servername>\<sharename>, see screenshot below for an example.

Idox plc © CAFM Explorer - 11.0.0 Page 22 of 88

 CAFM Explorer Easy Install Guide

Press Next.

Step 4
The Default connection is the Name given to the Connection String for the Database that the
CAFM Applications will default to using when they are first started.
Accept the default, unless you have changed the Connection String Name in the
datastores.xml file, then press Next.

Screenshot showing a typical datastores.xml file. The Connection String name is highlighted.

Idox plc © CAFM Explorer - 11.0.0 Page 23 of 88

 CAFM Explorer Easy Install Guide

Step 5
The Queue Attachment folder is where email attachments generated by the CAFM
Applications are stored before being picked up by the CAFM Email Service and sent to the
recipient.
For a single User scenario, the default folder on the local machine would typically be used.
For an Enterprise Solution, typically this will be a folder in a fileshare (See Section 1.3). The
ideal format would be a UNC (Universal Naming Convention) file path in the format
\\<servername>\<sharename>, see screenshot below for an example.

Press Next.

Step 6
The CAFM Report files folder is where the Reports to be used by the CAFM Applications are
stored.
For a single User scenario, the default folder on the local machine would typically be used.
For an Enterprise Solution, typically this will be a folder in a fileshare (See Section 1.3). The
ideal format would be a UNC (Universal Naming Convention) file path in the format
\\<servername>\<sharename>, see screenshot below for an example.

Idox plc © CAFM Explorer - 11.0.0 Page 24 of 88

 CAFM Explorer Easy Install Guide

Press Next.

Step 7

Select the required options for shortcut creation on the Target Machine.

Press Next.

Idox plc © CAFM Explorer - 11.0.0 Page 25 of 88

 CAFM Explorer Easy Install Guide

Step 8

Either press Back to make any changes or confirm your settings by pressing Install.

Step 9
A progress bar will be displayed to indicate how the installation is proceeding.

Step 10
Upon completion, the following window will be displayed.

Idox plc © CAFM Explorer - 11.0.0 Page 26 of 88

 CAFM Explorer Easy Install Guide

Select Finish to exit the installer.

Step 11
From CAFM Explorer 10.4, the arrangements for licensing CAFM Explorer have changed.
Please see Section 3.
It may now be necessary to perform some post installation tasks before the Applications can
be used. See Section 2.4 for further details.

Idox plc © CAFM Explorer - 11.0.0 Page 27 of 88

 CAFM Explorer Easy Install Guide

2.1.4 Custom option

Step 1
The Custom install allows the User to select from a choice of available Applications to install.
Depending upon the options selected, the following steps may or may not be encountered.
Proceed as described in Section 2.2.1 above and select the Custom option.

Step 2

Here you need to determine what you need to install; by default, nothing is selected.

Idox plc © CAFM Explorer - 11.0.0 Page 28 of 88

 CAFM Explorer Easy Install Guide

Firstly, expand each of the options by selecting the + buttons.

Step 3

Select the required options for the Applications to be installed by selecting the icon for
each item you need. You can do this for the whole ‘Client Products’ and/or ‘Server Products’
Groups or individually. The following screenshot shows an example of selecting CAFM Service
Manager only being installed locally:

Here is another example after everything, except Queue Monitor, is selected for install and
CAFMCAD being installed when required:

Idox plc © CAFM Explorer - 11.0.0 Page 29 of 88

 CAFM Explorer Easy Install Guide

When the decisions have been made press Next. NB: All future screenshots are based on all
the options being installed on the local hard drive.
NB: If Service Manager is selected then, if appropriate, a message will be displayed
recommending that any previously installed Services are removed. Press Yes to continue.

Step 4

Idox plc © CAFM Explorer - 11.0.0 Page 30 of 88

 CAFM Explorer Easy Install Guide

Select Cancel to quit the installation or, assuming you have read and understood the
conditions and wish to proceed, select the radio button ‘I have read the database
checklist’; this will enable the Next button.
Press Next.

Step 5

Either select the Standard option to configure the Client Applications to present each User
with a CAFM login box or select the Windows Authentication option to enable the
recognised Users of the Client Applications to bypass the CAFM login box (please see Section
2.4.2.1.1).
For both options, the User login details will need to first be configured in the CAFM Explorer
Application. See Getting Started manual for this procedure.

Press Next.

Step 6
If CAFMCAD was selected:
• Where AutoCAD is either not installed or an unsupported version is installed a warning
will be given.
• The following screen will be skipped if only one supported version of AutoCAD is found.
• When more than one supported version of AutoCAD is found a dropdown list will be
available and will display the various supported products, e.g.:

Idox plc © CAFM Explorer - 11.0.0 Page 31 of 88

 CAFM Explorer Easy Install Guide

Select the required version and press Next.

If Auto-Load is checked ON then the CAFMCAD Palette will be loaded automatically when
AutoCAD is launched. If Auto-Load is checked OFF the user will need to run a command line
parameter (NETLOAD) to load the CAFMCAD Palette manually each time AutoCAD is
launched.

Press Next.

Idox plc © CAFM Explorer - 11.0.0 Page 32 of 88

 CAFM Explorer Easy Install Guide

Step 7
If the Service Manager was installed, you will be prompted to enter the details for the SQL
Server name (and instance if applicable) and the CAFM Explorer Queue Database name
(created by the CAFM Data Source Builder).
NB: If you have not already created a Queue Database with the CAFM Data Source Builder
you should make a note of the Queue Database name specified here (e.g. CAFMDB_Queue)
and ensure that this is specified later when creating the CAFM Queue Database.

Press Next.

Step 8
Select the location where the Datastores.xml file can be found by the Application.
For a single User scenario, the default folder on the local machine would typically be used.
For an Enterprise Solution, typically this will be a folder on a fileshare (see Section 1.3). In
this event the ideal format would be a UNC (Universal Naming Convention) file path in the
format \\<servername>\<sharename>, see screenshot below for an example.

Idox plc © CAFM Explorer - 11.0.0 Page 33 of 88

 CAFM Explorer Easy Install Guide

Press Next.

Step 9
The Default connection is the Name given to the Connection String for the Database that the
CAFM Applications will default to using when they are first started.
Accept the default, unless you have changed the Connection String Name in the
datastores.xml file:

Press Next.

Idox plc © CAFM Explorer - 11.0.0 Page 34 of 88

 CAFM Explorer Easy Install Guide

Screenshot showing a typical datastores.xml file. The Connection String name is highlighted.

Step 10
The Queue Attachment folder is where email attachments generated by the CAFM
Applications are stored before being picked up by the CAFM Email Service and sent to the
recipient.
For a single User scenario, the default folder on the local machine would typically be used.
For an Enterprise Solution, typically this will be a folder in a fileshare (See Section 1.3). The
ideal format would be a UNC (Universal Naming Convention) file path in the format
\\<servername>\<sharename>, see screenshot below for an example.

Press Next.

Step 11
The CAFM Report files folder is where the Reports to be used by the CAFM Applications are
stored.
For a single User scenario, the default folder on the local machine would typically be used.
For an Enterprise Solution, typically this will be a folder in a fileshare (See Section 1.3). The
ideal format would be a UNC (Universal Naming Convention) file path in the format
\\<servername>\<sharename>, see screenshot below for an example.

Idox plc © CAFM Explorer - 11.0.0 Page 35 of 88

 CAFM Explorer Easy Install Guide

Press Next.

Step 12

If any of the CAFM Services have been selected to be installed, you will be prompted to select
either a Local Account or to specify (recommended) a User Account to run the service(s).

Select the required option then press Next.

Idox plc © CAFM Explorer - 11.0.0 Page 36 of 88

 CAFM Explorer Easy Install Guide

Step 13
If ‘Specify user’ is selected, you will be prompted to enter a valid Username and password to
be used to run the Services. (See Section 1.3.1). Enter valid details in both fields then tab out
to enable the Next button.

Press Next.

Step 14
Select the required options for shortcut creation on the Target Machine.

Press Next.

Idox plc © CAFM Explorer - 11.0.0 Page 37 of 88

 CAFM Explorer Easy Install Guide

Step 15

Either press Back to make any changes or confirm your settings by pressing Install.

Step 16
A progress bar will be displayed to indicate how the installation is proceeding.

Step 17
Upon completion, the following window will be displayed.

Idox plc © CAFM Explorer - 11.0.0 Page 38 of 88

 CAFM Explorer Easy Install Guide

Select Finish to exit the installer.

Step 18
From CAFM Explorer 10.4, the arrangements for licensing CAFM Explorer have changed.
Please see Section 3.
It may now be necessary, particularly if the CAFM Service Manager was installed, to perform
some post installation tasks before the Applications can be used. See Section 2.4 for further
details.

Idox plc © CAFM Explorer - 11.0.0 Page 39 of 88

 CAFM Explorer Easy Install Guide

2.2 U PGRADING AN EXISTING INSTALLATION

IMPORTANT:
If you have a distributed environment, e.g. where CAFM Explorer and CAFM Report Explorer
are installed on several Client PCs, the CAFM Database, Queue Database and CAFM Data
Source Builder are installed on a Database Server and CAFM Services and Queue Monitor
installed on an Application Server then, when carrying out an upgrade, please ensure
all machines are upgraded to the same version. It is not wise to have different
components scattered across your environment as that may, and probably will, cause
unexpected results.
The CAFM Database must be upgraded using the CAFM Data Source Builder from
that version.
The Queue Database is not validated and may, or may not, need to be changed
(CAFM 9.3 for example requires a new Queue database). Please always review
the Release Notes for the specific version you are upgrading to.
The screens displayed when upgrading CAFM Explorer to a later version differ dependent on
whether the upgrade is a Minor Release or Major Release. Please check the Release Notes
for the software version that you are installing to determine your answer; this is important.
Please also ensure you have read and followed the instructions in Section 1.5 and also
the following sub-sections.

• CAFM Explorer can be upgraded to CAFM 9.2 to CAFM 10.1 but is not recommended
because of the following situation and should ideally be uninstalled. After uninstalling,
the Installation folder should be opened and checked for any remaining components. If
any exist, they should be removed manually.
• CAFM Explorer 9.2 and later for new customers by default will be installed in
“C:\Program Files\Idox Software\CAFM Explorer Product Suite” for 64-bit installations
and for 32-bit installations into “C:\Program Files (x86)\Idox Software\CAFM Explorer
Product Suite”.
For existing customers, however, this will not be the case, the installation will by
default go to the existing McLaren Software folder. As this may cause future confusion,
it is recommended that the Idox Software folder be used and to achieve this there are
two alternatives:
Either
Change the path during installation (described earlier) to either “C:\Program
Files\Idox Software\CAFM Explorer Product Suite” or “C:\Program Files (x86)\Idox
Software\CAFM Explorer Product Suite” respectively. This is the simplest and
recommended method.
Or, only recommended for experienced users only, edit the Registry:
For Windows 7 (may be different for different OS) select Start button
Type regedit into the Search field
Press Enter key to display Registry Editor
For a 64-bit installation:
Navigate to Computer > HKEY_LOCAL_MACHINE > Software > Fmx Ltd >CAFM
Product Suite
Select right pane > InstallDir > right click and press Modify

Idox plc © CAFM Explorer - 11.0.0 Page 40 of 88

 CAFM Explorer Easy Install Guide

Change
“C:\Program Files\McLaren Software\CAFM Explorer Product Suite\” to
“C:\Program Files\Idox Software\CAFM Explorer Product Suite\”
Press OK
For a 32-bit installation on a 64-bit PC:
Navigate to Computer > HKEY_LOCAL_MACHINE > Software > Wow6432Node>
Fmx Ltd >CAFM Product Suite
Select right pane > InstallDir > right click and press Modify
Change
“C:\Program Files (x86)\McLaren Software\CAFM Explorer Product Suite\” to
“C:\Program Files (x86)\Idox Software\CAFM Explorer Product Suite\”
Press OK
Close the Registry
You are now able to proceed.

2.2.1 CAFMCAD Drawing Migration

Please see the version of this Document prior to CAFM 10.2 if information is required on this.

2.2.2 MINOR Release upgrade

Please see the Release Notes. It is not currently possible to upgrade CAFM Explorer 10.2 to a
later version successfully; CAFM Explorer 10.2, or any earlier version, must be
uninstalled first and the user will be warned accordingly.

As such the remainder of this Section has been struck through for the time being and will be
reinstated if the situation changes.
For example, updating CAFM Explorer 10.2 to CAFM Explorer 10.3
Step 1
If CAFM Explorer is already installed, then running the .msi will recognise this and generate
the following message:

Idox plc © CAFM Explorer - 11.0.0 Page 41 of 88

 CAFM Explorer Easy Install Guide

Press Next, accept the terms of the Licence Agreement and press Next
Step 2
The following window will be displayed

Press Update, the progress bar will animate until processing is completed

Step 3
On completion of processing the following is displayed:

Idox plc © CAFM Explorer - 11.0.0 Page 42 of 88

 CAFM Explorer Easy Install Guide

Press Finish to complete the process.

Idox plc © CAFM Explorer - 11.0.0 Page 43 of 88

 CAFM Explorer Easy Install Guide

2.2.3 MAJOR Release upgrade

PLEASE NOTE: This Section should be ignored for CAFM Explorer 10.4 and later for
the time being. The processes and screenshots are from versions prior to CAFM
Explorer 10.2; they will be replaced in the next appropriate version. The process
is unlikely to be any different, just how the screens look.

This section is only applicable if the Release Notes for the specific version allow it.
Step 1
If CAFM Explorer is already installed, then running the .msi will recognise this and generate
the following screen (See Section 1.5 above). NB: The following screens display an upgrade
from an earlier version. They will be replaced at an appropriate time when the latest version
can be upgraded as a Major Release:

If OK to proceed then press ‘Yes’ to display the Customer Information screen followed by the
options screen e.g.

Idox plc © CAFM Explorer - 11.0.0 Page 44 of 88

 CAFM Explorer Easy Install Guide

Do not change any of the options unless appropriate.

Press Next

Step 2
An animated Progress bar will be displayed until processing is completed

Step 3
On completion of processing press Finish to complete the process.

Idox plc © CAFM Explorer - 11.0.0 Page 45 of 88

 CAFM Explorer Easy Install Guide

2.3 POST INSTALLATION PROCEDURES

2.3.1 Typical Install

After completion of the Typical install, CAFM Explorer & CAFM Report Explorer components
will be in place on the Target Machine. When you first try and run either application the
system will check for:
• A valid Licence (Please see Section 3)
• The presence of the appropriate .NET Framework. If the pre-requisite (See Section
2.2) was not followed you will be warned and will need to download and install it
before proceeding.
If this was the first Client installation or if you have not already carried out the post
installation tasks, it will be necessary to carry out the tasks below, except for populating the
Report Path (see Section 2.4.1.3). If you have carried out the post installation tasks and you
correctly entered the details at each of the prompts during the installation, running either the
CAFM Explorer or CAFM Report Explorer Applications should result in the CAFM login prompt
or if using Windows Authentication, the Home screen for the selected Application.
Initial access to an empty CAFM Explorer Database should be achieved by using Username
administrator and a password of password, ensuring that the relevant datastore is
selected from the drop-down list. It is recommended that the CAFM Administrator password is
changed to something more appropriate and individual User Accounts are set up within the
CAFM Explorer Application prior to sending the CAFM System live. For details on how to do
this, see the Getting Started Manual.

2.3.1.1 Edit Datastores file

The Datastores.xml file tells the CAFM Explorer Applications the details of the SQL Database
Server hosting the CAFM Databases and the names of the available Databases for Users to
select from. There is no limit to the number of available Databases that can be configured,
however typically Users will only have one Live Database and possibly a Test or Training
Database.
A datastores.xml file will be installed with the Client Applications into the location specified in
Step 7 of the installation process section of this document. If you are installing a small CAFM
system or a test/development system, it is likely that this will be the correct location for the
datastores.xml file pointed to during the installation process at step 10a. If you specified an
alternative location in Step 10a, 11b or 19c, you should copy the datastores.xml file into the
location specified (i.e. \\<ServerName>\CAFMShare\Config).

Idox plc © CAFM Explorer - 11.0.0 Page 46 of 88

 CAFM Explorer Easy Install Guide

▪ To enter the details of the Microsoft SQL Server and CAFM Database(s) to connect to,
double click on the CAFM Explorer Application executable (CAFMExplorer.exe) or
available shortcut to display the logon screen above.
▪ Press the New button adjacent to the Log On To field.

Enter the relevant details where: -

Name is the name of the Connection String and should match the Default Datastore specified
for the chosen default Database, or a suitable alternative e.g. “Training” or “Test”, for any
additional Databases required. To continue to use the Connection String Name of Live, you
must ensure that you re-enter it exactly, using the same case for each letter as displayed in
the CAFM Explorer, CAFM Report Explorer or CAFMCAD log on dialogue boxes.
Server Name is the Name or IP Address (and instance where applicable) of the Microsoft
SQL Server hosting the CAFM Database(s).
Database Name is the Name of the CAFM Database typically as specified during its creation
on the Microsoft SQL Server (see Section 2.3.2.1).
User Name is the SQL User provided for Database access, typically cafm_user (created by
the CAFM Data Source Builder).
Password is the SQL User password for Database access, typically cafm_user (created by
the CAFM Data Source Builder).
Repeat this process for each additional Database.
NB: If you wish to use Windows Authentication or alternative SQL credentials, please see
Section 2.4.2.1.1, or you may wish to contact the Idox Help Desk for further assistance.

2.3.1.2 Copy common files to the Fileshare

If you are installing for a single User or a Test/Development Environment, you may decide
that this step is not necessary.
The fileshare should contain all the common files used by the CAFM Applications and avoids
the need to replicate many files on each Users machine and/or the nominated Application
Server. It also greatly simplifies the task of upgrading any of these files as it will only need to
be performed in the one place and not on every User’s machine.
The required files will be installed with the Client Applications into the location specified
during the installation process.
The relevant dictionary file (i.e. uk-english-v2-whole.dict) should be copied from the location
specified in Step 7 of the installation process section of this document, typically \CAFM
Explorer Product Suite to the relevant folder within the CAFM Fileshare (e.g.
\\<ServerName>\CAFMShare\Dictionary).
The relevant templates (.rpt files) should be copied from the location specified, typically
…\CAFM Explorer Product Suite\Templates to the relevant folder within the CAFM Fileshare
(e.g. \\<ServerName>\CAFMShare\Templates).
.

Idox plc © CAFM Explorer - 11.0.0 Page 47 of 88

 CAFM Explorer Easy Install Guide

The relevant report files (.rpt files) should be copied from the location specified, typically
...\CAFM Explorer Product Suite\Reports to the relevant folder within the CAFM Fileshare (e.g.
\\<ServerName>\CAFMShare\Reports).
.
IMPORTANT – If you upgraded CAFM Explorer it is possible the Templates and Reports may
have changed so ensure you copy the latest Templates and Reports installed during the
upgrade to the relevant folders in the CAFMShare overwriting the existing records.

2.3.1.3 Configure the CAFM Applications to use the common files

To use the common files copied to the Fileshare, it will be necessary to configure CAFM
Explorer to point to the specified locations.
▪ Open the CAFM Explorer Application and log in with suitable credentials as described
previously and connect to the relevant data store.
▪ Go to the Tools –> Options drop down menu.

▪ On the General Options tab, configure the Report path. This path will be used by all
users.

▪ On the General Options tab, configure the Dictionary location and select the file. This
file will be used by all users.

▪ On the Work Orders tab, configure the Work Order Template location and select the
file. This file will be used by all users.

Idox plc © CAFM Explorer - 11.0.0 Page 48 of 88

 CAFM Explorer Easy Install Guide

▪ On the Purchase Orders tab, configure the Purchase Order Template location and
select the file. This file will be used by all users.

▪ On the Room Bookings tab, configure the Room Booking Template location and select
the file. (You will need to have copied the file from the default location to this
fileshare). This file will be used by all users.

After you have added all the default Email settings you should now have completed all steps
to enable successful use of the installed CAFM Applications.

Idox plc © CAFM Explorer - 11.0.0 Page 49 of 88

 CAFM Explorer Easy Install Guide

2.3.2 New Customer and Custom Install

Using the New Customer Install option or by selecting CAFM Data Source Builder in the
Custom Install, the CAFM Data Source Builder is installed in addition to the CAFM Explorer
and CAFM Report Explorer Applications. The CAFM Data Source Builder is used to:
• Create an empty CAFM Explorer Database
• Upgrade an existing CAFM Explorer Database
• Create an empty Queue database
on an existing Microsoft SQL Server.
An additional option is also available to perform a Health Check on an existing database. See
Section 2.4.2.4 and the document referenced in Appendix 3 for more details.
NB: The ability to create a Tutorial database has been removed from Version
SP5.30. If you wish to continue to use an existing Tutorial database then you
must now upgrade it to the latest version by following the instructions on how to
upgrade a database discussed below.

2.3.2.1 Create a new CAFM Data store

Before initiating Database creation, first ensure that you have a Microsoft SQL Server
available for use that meets the pre-requisites detailed in Section 1.1.1 of this document.
IMPORTANT:
An assumption is made here that the customer is installing CAFM Explorer version 9.3
(or later) for any supported SQL Server version, including SQL Server 2016. It must be
emphasised that any earlier version of CAFM Data Source Builder does NOT support
the build of a new database in SQL Server 2016 or later. The workaround to this will
be to build the database using an earlier version of SQL Server and then backup, copy and
restore it to the later SQL Server version instance.

Step 1
To create an empty Database, navigate to the specified Installation Folder and run
CAFMDataSourceBuilder.exe.

Step 2
Select the option to ‘Create a new CAFM Explorer database using an existing SQL Server
installation’. Press Next.

Idox plc © CAFM Explorer - 11.0.0 Page 50 of 88

 CAFM Explorer Easy Install Guide

Step 3
Free type the SQL Server Name, if known, in the Server field. If not known, press the ellipsis
button to search for available Microsoft SQL Servers, select the required SQL Server and
press OK to populate the Server field.

Step 4
Select Windows or SQL Authentication, ‘Use Windows Authentication’ is the default.
NB: The Account you are using to run the CAFM Data Source Builder will need to have
Administrator rights on the target SQL Server.

Press Connect

Idox plc © CAFM Explorer - 11.0.0 Page 51 of 88

 CAFM Explorer Easy Install Guide

Press Next.

Step 5
The system checks and displays the SQL Server mode and allows the user to select to whom
permissions (i.e. EXECUTE, SELECT, etc.) will be granted. The following screen displays the
result for where the selected SQL Server in Mixed Mode (i.e. both Windows and SQL Server).

If the SQL Server is in WindowsOnly mode, the screen is the same, but the user is informed
that they must contact Idox if they have a need to select more than one login/user/group
from the list. CAFM Data Source Builder itself only supports the granting of rights to a single
login/user/group.
Use the dropdown to display a list of all SQL Logins/Users/Groups on the selected Server; this
will be populated according to the authentication mode of the SQL Server instance. The
screen above displays a user selected from the dropdown list. When the SQL Server is in
Mixed Mode then all types will be included, otherwise only Windows Users and Groups will be
listed. The exception to this rule is that “cafm_user” will always be in the list. The
“cafm_user” entry will be the default selection (this will ensure CAFM Data Source Builder
behaves exactly as it did in previous versions; granting permissions to the “cafm_user” login).
In most instances there should be no need to change this default setting.

Idox plc © CAFM Explorer - 11.0.0 Page 52 of 88

 CAFM Explorer Easy Install Guide

The user running CAFM Data Source Builder must have permission to Grant permissions to
the user or group selected here.
NB. Some permissions are always granted to the “cafm_reader” login, regardless of the user’s
selection.

Press Next.

Step 6
Enter the name for the CAFM Database you will create; the default is set to CAFMDB, the
following example shows an edited name.

NB: If Advanced File Options is left unchecked then defaults will be used for Logical Names,
File names and Paths, including the defaults configured for file locations within the target
Microsoft SQL Server. If you wish to specify alternative details check on Advanced File
Options to enable these fields and enter the details using the following format.

SQL Server path must be entered in both boxes and should be the full windows path on the
Server and will enable the Next button. You will see this also gives you the option to specify
initial file sizes. Please read the associated SQL Server Pre-requisites document for further
details.

Idox plc © CAFM Explorer - 11.0.0 Page 53 of 88

 CAFM Explorer Easy Install Guide

Press Next.

Step 7
Review the specified options. The following screen shows the situation if the Server is in
Mixed Mode and Advanced File Options is left unchecked.

Press Install.

Step 8
A Progress bar will be displayed to indicate how the Database creation is proceeding.

Step 9
Upon successful completion of the Database build, a message like the following will be
displayed. Viewing of the installation log is optional; there should be two options to view as a
text file or as an HTML file via a Web Browser, the latter is recommended. If, for any reason,
the build fails please report this to Idox immediately and provide the log file as it
provides detailed information of the failure.

Idox plc © CAFM Explorer - 11.0.0 Page 54 of 88

 CAFM Explorer Easy Install Guide

Press Exit.

2.3.2.1.1 Configure the CAFM Applications to use Windows Authentication

This sub-section discusses how to configure CAFM Explorer to operate with the database BUT
only where:
• Your SQL Server is configured for Windows Authentication
• You have installed CAFM Explorer to run with Windows Authentication
• You selected Windows Authentication when creating your database (See Section
2.4.2.1) and selected a single user or user group
You now need to carry out the following additional steps:
1. Using Windows Explorer, navigate to the specified Install location.
2. Locate the file called ‘CAFMExplorer.exe.config’ and open it using Notepad (or similar
text editor software). You will see Authentication mode is now set to
“CAFMWindows”.
3. From this file, identify the Location of the datastore file.

4. Navigate to this location and open Datastores.xml file using Notepad (or similar text
editor software).

Idox plc © CAFM Explorer - 11.0.0 Page 55 of 88

 CAFM Explorer Easy Install Guide

NB: if this file is on the local machine, then this process will need to be carried out for
every machine installed with CAFM Explorer applications. It is, however, generally
recommended that all machines point to a central copy of this file in a fileshare (see
earlier in this document). At this point the file will look like this:

• Edit the file:

o Replacing the string ‘user=cafm_user;password=<Encrypted Password>’ with
‘Integrated Security=SSPI’ where ever it appears in relation to the selected
Server. Ensure that this is typed in exactly as it appears here, including capital
letters where applicable.
NB: that if the Queue database is on a different server that is not
WindowsOnly the string would not be replaced.
o Replacing ‘EnterYourServerNameHere’ with the Server(\Instance) of the CAFM
Explorer database and the Queue database (see Sections 2.4.2.1 and 2.4.2.3)
respectively.
o Replacing the ‘initial catalog’ name with the physical name of the CAFM Explorer
database and Queue database.
Here is a sample of how the final file might look (in this instance the Queue database
is on a different server).

• Save and close the file.

• If using CAFM Report Explorer, ensure that the CAFMReportExplorer.exe.config file is
pointing to the same Datastores.xml file that CAFMExplorer.exe.config is using.
To test the changes, log in to the CAFM Explorer database as ‘administrator’ and create and
save the required user(s). Each User Name would be created in the format
[domain\username].

Idox plc © CAFM Explorer - 11.0.0 Page 56 of 88

 CAFM Explorer Easy Install Guide

If a Group name was selected earlier repeat this process for all users in that Group.
When any one of the created users then starts CAFM Explorer the login box is not presented
because the system authenticates the person from their Windows login.
The post installation processes for the Typical Install detailed in Section 2.4.1
should also now be followed.

Idox plc © CAFM Explorer - 11.0.0 Page 57 of 88

 CAFM Explorer Easy Install Guide

2.3.2.2 Upgrade an existing CAFM Data store

If you are an existing user of CAFM Explorer and have current databases, you will need to use
the CAFM Data Source Builder to upgrade those databases so that they work correctly with
the current version of the CAFM Explorer application.
Important Notes:
• If the current database is pre-Quantum or Quantum pre-SP2 then support will be
needed from Idox to upgrade it, before it is then upgraded to the latest Service Pack.
Any attempt to upgrade a pre-Quantum database will be prevented. Please check
the Release Notes for the software version you are installing for further information.
• If you have Custom Reports, then CAFM Data Source Builder can be used to upgrade
them to make them compatible with this latest version of CAFM Explorer. If the
required file has not already been provided, then please ask Idox for it.
• The supplied file needs to be placed in the following folder “{Install
Folder}\CAFMDB\Custom Reports” before you run CAFM Data Source Builder.

This folder also contains a small Readme file to remind you of this process. When
done your Custom Reports will be upgraded when CAFM Data Source Builder is run.
NB. This process is optional; it does not matter if it is skipped as it will still be
possible to run the separate Custom Reports Package supplied by Idox.
• If your current database is prior to version 2012.03 and contains Tenures and related
Rent records, then it is necessary to run one or more Pre-migration scripts to ensure
data is migrated correctly. Full details of this can be found in the accompanying
Release Notes. It is strongly recommended that the customer contacts Idox for
assistance.
• If your current database contains Stock data, please see the instructions in the
Release Notes for the appropriate version. If in any doubt, it is strongly
recommended that the customer contacts Idox for assistance.

Step 1
As previously described, run the CAFM Data Source Builder application but select the third
radio button option ‘Upgrade your existing CAFM Explorer database to a later version, Service
Pack or Hotfix’:

Idox plc © CAFM Explorer - 11.0.0 Page 58 of 88

 CAFM Explorer Easy Install Guide

Press Next

Step 2
Follow previous steps to nominate and connect to the SQL server containing your
database(s). Please note that only valid CAFM Explorer databases capable of upgrade will be
listed.

Press Next.

Step 3
The system checks and displays the SQL Server mode and allows the user to select to whom
permissions (i.e. EXECUTE, SELECT, etc.) will be granted. The following screen displays the
result; in this example the selected SQL Server is in Mixed Mode (i.e. both Windows and SQL
Server).

Idox plc © CAFM Explorer - 11.0.0 Page 59 of 88

 CAFM Explorer Easy Install Guide

The user is informed that they must contact Idox if they have a need to select more than one
login/user/group from the list. CAFM Data Source Builder itself only supports the granting of
rights to a single login/user/group.
Use the dropdown to display a list of all SQL Logins/Users/Groups on the selected Server; this
will be populated according to the authentication mode of the SQL Server instance.
When the SQL Server is in Mixed Mode then all types will be included, otherwise only
Windows Users and Groups will be listed. The exception to this rule is that “cafm_user” will
always be in the list. The “cafm_user” entry will be the default selection (this will ensure
CAFM Data Source Builder behaves exactly as it did in previous versions; granting permissions
to the “cafm_user” login). In most instances there should be no need to change this default
setting.
NB. Some permissions are always granted to the “cafm_reader” login, regardless of the user’s
selection.
Press Next.

Step 4
Please read and understand the instructions. Initially you will be unable to proceed until you
have answered Yes to the first two questions ‘Have all users been logged out of the
application?’ and ‘Has a full database backup been taken prior to running the upgrade?’ It is
the customer’s responsibility to take a backup of the database, this is a reminder to do so.
Do not answer YES to the second question if a backup has not been taken. Idox
cannot be held responsible if for any reason the upgrade fails and corrupts the database such
that it can no longer be used. Having a backup will allow you to restore and continue
working pending investigation of any failure.
The third question regarding ‘Tenure’ data (NB: This is only visible if your current database
version is prior to 2012.03) is a reminder only, you will be allowed to continue even if the
answer is left as ‘No’ (although the upgrade will fail immediately with a ‘Validation Failed’
message under appropriate circumstances). Please see the Release Notes for the action that
needs to be taken.

Idox plc © CAFM Explorer - 11.0.0 Page 60 of 88

 CAFM Explorer Easy Install Guide

After you are satisfied select ‘Yes’ to each.

Press Next.

Step 5
Confirm you are upgrading the correct database.

Press Upgrade.

Step 6
A Progress bar will be displayed to indicate how the Database upgrade is proceeding.

Idox plc © CAFM Explorer - 11.0.0 Page 61 of 88

 CAFM Explorer Easy Install Guide

Step 7
Upon completion of the Database upgrade, a message will be displayed.

To confirm the status of the upgrade press ‘View in Browser’ and click the word ‘Completion’;
a screen like the following will be displayed

If ‘Build Status’ displays ‘Completed’ then press Exit. You are now ready to work with your
upgraded database. If the Custom Reports process was followed you will also now need to
copy all the Report Files (*.rpt) to the local or Network Fileshare folder that contains your
CAFM Standard and Custom Reports.
Viewing of the installation log is optional if the build was successful. If, however, the
upgrade fails for any reason ‘Build Status’ will show ‘Unchanged’. In such circumstances:
• The failure must be reported to Idox immediately and the Log file provided as
it provides detailed information of the failure.
• The database backup must be restored and the required procedures followed to allow
your Users to continue working pending investigation of the problem.

Idox plc © CAFM Explorer - 11.0.0 Page 62 of 88

 CAFM Explorer Easy Install Guide

2.3.2.3 Create a Message Queue Database

A message Queue Database is required if the Email functionality included in CAFM Explorer is
to be used. The various CAFM Services will poll the Database as per the individual
configurations.
NB. If you are an existing Customer and are upgrading to CAFM Explorer 9.3 or
later a new Queue Database should be created in any event; the Message Queue
will not operate correctly otherwise.
In this case:
• Ensure all users are logged out of CAFM Explorer and CAFM Web.
• Ensure that all messages in the existing Queue database have been sent before
creating the new Queue database and upgrading the CAFM Service Manager and
starting it.
• If you wish to keep legacy data it will be necessary to rename the existing Queue
Database then follow the instructions to create a new Queue database with the
original name.

Please see the Release Notes for this version for further details.

Step 1
Select the fourth radio button option ‘Create a new Queue database using an existing SQL
Server installation’:

Press Next.

Idox plc © CAFM Explorer - 11.0.0 Page 63 of 88

 CAFM Explorer Easy Install Guide

Step 2
Free type the SQL Server Name, if known, in the Server field. If not known, press the ellipsis
button to search for available Microsoft SQL Servers, select the required SQL Server and
press OK to populate the Server field.

Step 3
Select Windows or SQL Authentication, ‘Use Windows Authentication’ is the default.
NB: The Account you are using to run the CAFM Data Source Builder will need to have
Administrator rights on the target SQL Server.

Press Connect

Press Next.

Idox plc © CAFM Explorer - 11.0.0 Page 64 of 88

 CAFM Explorer Easy Install Guide

Step 4
The system checks and displays the SQL Server mode and allows the user to select to whom
permissions (i.e. EXECUTE, SELECT, etc.) will be granted. The following screen displays the
result; in this example the selected SQL Server is in Mixed Mode (i.e. both Windows and SQL
Server).

The user is informed that they must contact Idox if they have a need to select more than one
login/user/group from the list. CAFM Data Source Builder itself only supports the granting of
rights to a single login/user/group.
Use the dropdown to display a list of all SQL Logins/Users/Groups on the selected Server; this
will be populated according to the authentication mode of the SQL Server instance.
When the SQL Server is in Mixed Mode then all types will be included, otherwise only
Windows Users and Groups will be listed. The exception to this rule is that “cafm_user” will
always be in the list. The “cafm_user” entry will be the default selection (this will ensure
CAFM Data Source Builder behaves exactly as it did in previous versions; granting permissions
to the “cafm_user” login). In most instances there should be no need to change this default
setting.
NB. Some permissions are always granted to the “cafm_reader” login, regardless of the user’s
selection.
Press Next.

Idox plc © CAFM Explorer - 11.0.0 Page 65 of 88

 CAFM Explorer Easy Install Guide

Step 5
Enter the name for the CAFM Database you will create; the default is set to QUEUE; this may
be changed but it is recommended it is left as the default.

NB: If Advanced File Options is left unchecked then defaults will be used for Logical Names,
File names and Paths. These include the defaults configured for file locations within SQL
Server Management Studio for the target Microsoft SQL Server. If you wish to specify
alternative details check on Advanced File Options to enable these fields and enter the details
using the following format.

The SQL Server path must be entered in both boxes and should be the full windows path on
the Server to enable the Next button. You will see this also gives you the option to specify
initial file sizes. Please read the associated SQL Server Pre-requisites document for further
details.
Press Next.

Idox plc © CAFM Explorer - 11.0.0 Page 66 of 88

 CAFM Explorer Easy Install Guide

Step 6
Review the specified options. The following screen shows the situation if Advanced File
Options is left unchecked.

Press Install.

Step 7
A Progress bar will be displayed to indicate how the Database creation is proceeding.

Step 8
Upon successful completion of the Database build, a message like the following will be
displayed. Viewing of the installation log is optional if the build was successful. Any failure,
however, must be reported to Idox immediately and the log provided as it provides
detailed information of the failure.

Idox plc © CAFM Explorer - 11.0.0 Page 67 of 88

 CAFM Explorer Easy Install Guide

Press Exit.
The Queue database is now ready for use with CAFM Explorer.

2.3.2.4 Perform Health Check on CAFM Explorer Database

The Health Check option is optional but is designed to highlight potentially redundant data
but can also be used in the event of a database upgrade failure to provide further details of
the problem. See Appendix 3.
Step 1
As previously described, run the CAFM Data Source Builder application and select the second
radio button option ‘Perform Health Check on CAFM Explorer Database’:

Press Next

Idox plc © CAFM Explorer - 11.0.0 Page 68 of 88

 CAFM Explorer Easy Install Guide

Step 2
Follow previous steps to nominate and connect to a SQL server and select the database to be
checked:

Press Next

Step 3
Confirm the database to be checked:

Press Next to display a Progress Bar and on completion a screen like the following will be
displayed.

Idox plc © CAFM Explorer - 11.0.0 Page 69 of 88

 CAFM Explorer Easy Install Guide

Step 4
Press View Log file button or View in Browser button to display a comprehensive report
on the state of the database. If there are any potentially serious issues these will be obvious,
all other data can be analysed by your Idox Project Manager who will be able to advise on
any action that might need to be taken, e.g. archiving/removal of redundant data.

Idox plc © CAFM Explorer - 11.0.0 Page 70 of 88

 CAFM Explorer Easy Install Guide

2.3.3 Custom Install

The post installation tasks following a Custom Install (see Section 2.1 for an overview of the
available components) will vary depending upon the component options selected; please also
read ‘Easy Install Guide - CAFM Services Manager.pdf’.

2.3.3.1 CAFM Explorer Services Manager

After the installation of the CAFM Explorer Services Manager, it will be necessary to configure
the various services; please see the separate Easy Install Guide for the CAFM Explorer
Services Manager for full details of this process and the pre-requisites. When done, access
the Services Management Console and start the CAFM Explorer Services Manager.

2.3.3.2 CAFM Help

From CAFM Explorer 8 onwards CAFM Help will no longer be available for selection during
Easy Install but the files are still available via the File Download Client available from the
CAFM Download Website.

Idox plc © CAFM Explorer - 11.0.0 Page 71 of 88

 CAFM Explorer Easy Install Guide

The files within Help.zip should be extracted to a suitable network Fileshare; please discuss
with Idox Help Desk if assistance is required. If CAFM Help is deployed it is necessary to
point the Client Application to these files.
▪ Open the CAFM Explorer Application, log in with suitable credentials and connect to
the relevant datastore as previously described.

▪ Go to the Tools drop down menu and select Options.

▪ On the User Options tab, configure the Help path.

NB: This is a User Option and hence needs to be configured by each User.
Please also note:
• For technical reasons CAFM Help is incompatible with Internet Explorer 11
Browser or later. It is, however, possible to run CAFM Help by emulating an earlier
version of Internet Explorer. To do this press F12 to display the following and select
Emulation tab as shown, dropdown Document Mode and select an earlier version:

• Help will not necessarily be updated with the latest functionality. If your particular
issue is not described please discuss with your Idox CAFM Account Manager.

Idox plc © CAFM Explorer - 11.0.0 Page 72 of 88

 CAFM Explorer Easy Install Guide

2.4 C OMPONENT MODIFY, R EMOVAL OR REPAIR PROCESS

To Uninstall, Change or Repair the Product Suite, using Windows 10 select Start > Control
Panel > Programs and Features and select the CAFM Explorer option. Other Windows
Operating Systems have a slightly different process to reach this point.

Uninstall – Method 1
The Uninstall option will uninstall the Product Suite. A prompt will be displayed requesting
confirmation to proceed with the selected option.

Press Yes to uninstall or No to cancel the command.

Uninstall – Method 2
The Change option allows an alternative method of uninstalling or allows for the removal or
addition of individual components.

Press Change

Idox plc © CAFM Explorer - 11.0.0 Page 73 of 88

 CAFM Explorer Easy Install Guide

Press Next.

Press Remove.

Idox plc © CAFM Explorer - 11.0.0 Page 74 of 88

 CAFM Explorer Easy Install Guide

NB. Using either method, after the CAFM Explorer Product Suite has been uninstalled all
CAFM and Third-Party Components will be removed from the installation folder, but it is
possible that some dynamic sub-folders will remain dependent on what was installed
originally (typically CAFMDB, Help and Tutorial Documents). Any documents, pictures etc.
that were created by the user will also remain. User created objects should be moved to a
more suitable location if they need to be kept but once done the master Idox Software
folder and its sub-folders can safely be deleted.

Change
The Change option lets you change the way features are installed.

Press Change

Idox plc © CAFM Explorer - 11.0.0 Page 75 of 88

 CAFM Explorer Easy Install Guide

Essentially, follow the earlier steps, i.e.:

To add a Component, expand it and select the required option.
To remove a Component, expand it and select the ‘X Entire feature will be unavailable’
option.
Press Next.

Repair
Like Uninstall, you can Repair in one of two ways, either press the Repair option from
Programs and Features

Or the Repair button available via the Change option.

Idox plc © CAFM Explorer - 11.0.0 Page 76 of 88

 CAFM Explorer Easy Install Guide

In either case, the Repair Option will attempt to repair any missing or damaged files. There is
no further User input required when this option is selected.

Idox plc © CAFM Explorer - 11.0.0 Page 77 of 88

 CAFM Explorer Easy Install Guide

3 Licensing CAFM Explorer

From CAFM Explorer 10.4, the way the Product Suite is licensed has changed and now affects
the database directly, dispensing with the need to license individual Servers and Client PCs.
On first time login by any user to CAFM Explorer / CAFM Web, on a new installation or after
upgrade to this or later version on any device, the following message will be displayed using
CAFM Explorer and an equivalent when using CAFM Web:

Press OK to close the message.

The new process to license is described below.
Step 1
Navigate Windows File Explorer to the CAFM Explorer installation folder (by default
C:\Program Files\Idox Software\CAFM Explorer Product Suite) and edit the file
“CAFMLicenceRegistration.exe.config” with Notepad or another editor to display the following:
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<appSettings>
<add key="DataStoreConfigLocation" value=""/>
</appSettings>
<startup>
<supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.6.2" />
</startup>
</configuration>

Populate the value between the quote marks in the row flagged in red above with the correct
path to the shared datastores.xml file; this should be the same value as the value in
cafmexplorer.exe.config configured during the product installation. e.g.
<add key="DataStoreConfigLocation" value="\\{server}\{cafm share}"/>

Save the file

Step 2
In the installation folder locate and run “CAFMLicenceRegistration.exe” to display the
following ‘Licence Registration’ window:

Idox plc © CAFM Explorer - 11.0.0 Page 78 of 88

 CAFM Explorer Easy Install Guide

Dropdown ‘Select a Database’, select the required database and press the ‘Connect’ button.
The button will become disabled and its label will change to ‘Connected’.

Step 3
Contact the Idox Support desk and request your Licence Key. The Key will reflect what you
have paid for, i.e. a number of CAFM Explorer Roles and CAFM Web Roles.

Step 4
Copy the key given to you, paste it into the ‘Licence Key’ field and press ‘Register Licence’ to
display the following:

Press OK then close the Licence Registration window.

Step 5
Login to CAFM Explorer connected to this database as your CAFM Administrator.
If successful, select Tools then Maintain User Accounts and confirm no users are displayed in
red. If one or more are red, edit each User, select the ‘User Roles’ button and view the
‘Selected Roles’ panel. Any red record indicates insufficient licences for that role. In the
following screenshot, the paid for Licence allocation has allowed sufficient CAFM Web
Property Advanced Roles (blue) but insufficient CAFM Explorer Roles (red).

Idox plc © CAFM Explorer - 11.0.0 Page 79 of 88

 CAFM Explorer Easy Install Guide

Essentially, red means you have either paid for insufficient licences or you have been given a
key that does not reflect what you know you have paid for. You will need to discuss this with
your Idox CAFM Account Manager for a resolution.
You may also see users greyed out meaning the accounts have been disabled. Subject to
sufficient licences being available, right clicking the user account and selecting ‘Enable User’
will resolve the issue.
Examples:

This new process licenses the selected database only. If you have other databases, e.g.
Tutorial, then the same process will need to be followed for each.
If you have any issues with this new process, please contact your Idox CAFM Account
Manager.

Idox plc © CAFM Explorer - 11.0.0 Page 80 of 88

 CAFM Explorer Easy Install Guide

4 Appendices

A PPENDIX 1 – HOW TO CHECK AND CONFIGURE SQL S ERVER AUTHENTICATION M ODE

To check which Authentication Mode the SQL Server is using and to change the current
configuration, follow the steps below.

NB: You will require access to the Microsoft SQL Server and Management Tools. The process
may vary slightly dependent upon the SQL Server version you are using.

SQL 2008/2012/2014/2016
▪ Open the Microsoft SQL Server Management Studio.

▪ From the SQL Server Management Studio Object Explorer pane, select the relevant
instance of SQL Server, right click and select Properties.

▪ On the Properties dialogue page, select Security. The current Authentication Mode
will be displayed as shown below.

Idox plc © CAFM Explorer - 11.0.0 Page 81 of 88

 CAFM Explorer Easy Install Guide

NB: SQL Server will show the currently selected Authentication Mode; however this may not
be effective if the SQL Server Service has not been restarted since the configuration change
was made.

▪ To restart the SQL Server Service, right click on the SQL Server Instance in the SQL
Management Studio Object Explorer and select Restart. Alternatively, the Service
can be restarted from the Services Management Console.

Idox plc © CAFM Explorer - 11.0.0 Page 82 of 88

 CAFM Explorer Easy Install Guide

A PPENDIX 2 – SQL S ERVER VERSION

NB: You should ensure that the version of SQL Server is appropriate for use and that you are
not in breach of any licensing agreements.

Express or Developer Editions

Microsoft SQL Server Express or Developer Editions by default are not configured to accept
connections from other machines. In this default state the following message (or similar) will
be displayed when attempting to connect:

SQL Server 2008/2012/2014/2016 Express

To configure these versions to accept external connections, follow the instructions below.
Please contact Idox if you are unsure of the process.
▪ Select Start > All Programs > {MSSQL SERVER} > Configuration Tools > SQL Server
Configuration Manager

▪ Select SQL Server Network Configuration > Protocols for {Instance}

Idox plc © CAFM Explorer - 11.0.0 Page 83 of 88

 CAFM Explorer Easy Install Guide

▪ Right click TCP/IP and select Enable then press OK to Message

▪ Repeat for Named Pipes if appropriate

▪ Select SQL Server Services > SQL Server (Instance)

▪ Right click and select Restart

It should now be possible to connect CAFM Explorer on a different machine to the database.

Idox plc © CAFM Explorer - 11.0.0 Page 84 of 88

 CAFM Explorer Easy Install Guide

A PPENDIX 3 – HEALTH C HECK

Please see document named ‘Health Check Summary.pdf’ for full details of the Health Checks
that are undertaken when this option is used.

Idox plc © CAFM Explorer - 11.0.0 Page 85 of 88

 CAFM Explorer Easy Install Guide

A PPENDIX 4 – W INDOWS 8, 8.1, 10

The Built-in Administrator Account should be used to carry out Windows Administration tasks
only, and not used to run CAFM Explorer else, under certain circumstances, the following
error may be delivered:

This app can’t be activated by the Built-in Administrator

Further information for this error can be found on the internet.

A PPENDIX 5 – MICROSOFT .NET FRAMEWORK

If you wish to establish the version of the Framework currently installed you can use the
following process:
1. On the Start menu, choose Run.
2. In the Open box, enter regedit.exe.
You must have administrative credentials to run regedit.exe.
3. In the Registry Editor, open the following subkey:
HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\NET Framework Setup\NDP\v4\Full
(Note that the path to the Full subkey includes the subkey Net Framework rather
than .NET Framework.)

Note

If the Full subkey is not present, then you do not have the .NET Framework 4.5 or
later installed.

In the right-hand panel check for a value named Release. The existence of
the Release DWORD indicates that the .NET Framework 4.5 or newer has been
installed on that computer.

The value of the Release DWORD indicates which version of the .NET Framework is
installed.

Idox plc © CAFM Explorer - 11.0.0 Page 86 of 88

 CAFM Explorer Easy Install Guide

Value of the Release

Version
DWORD

378389 .NET Framework 4.5

378675 .NET Framework 4.5.1 installed with Windows 8.1

or Windows Server 2012 R2

378758 .NET Framework 4.5.1 installed on Windows 8,

Windows 7 SP1, or Windows Vista SP2

379893 .NET Framework 4.5.2

On Windows 10 systems: .NET Framework 4.6

393295

On all other OS versions:

393297

On Windows 10 November .NET Framework 4.6.1

Update systems: 394254

On all other OS versions:

394271

On Windows 10 Anniversary .NET Framework 4.6.2

Update: 394802

On all other OS versions:

394806

Idox plc © CAFM Explorer - 11.0.0 Page 87 of 88

 CAFM Explorer Easy Install Guide

Value of the Release

Version
DWORD

On Windows 10 Creators .NET Framework 4.7

Update: 460798

On all other OS versions:

460805

Idox plc © CAFM Explorer - 11.0.0 Page 88 of 88