iDefine - Installation Guide
Document No: PR03076-MAN-991_02
Engineering Fundamentals
Safety and Control Lifecycle Design and Management
October 2021
Rev. 1.7.0
iDefine – Installation Guide
Copyright © 2021 Trinity Integrated Systems. All rights reserved.
No part of this publication may be reproduced, transmitted, transcribed, stored in a retrieval system, or
translated into any language, in any form or by any means, electronic, mechanical, photocopying, recording, or
otherwise, without prior written permission from Trinity Integrated Systems.
All copyright, confidential information, patents, design rights and all other intellectual property rights of
whatsoever nature contained herein are and shall remain the sole and exclusive property of Trinity Integrated
Systems Limited. The information furnished herein is believed to be accurate and reliable.
However, Trinity Integrated Systems assume no responsibility for its use, or for any infringements of patents or
other rights of third parties resulting from its use.
The Trinity Integrated Systems name and Trinity Integrated Systems logo are trademarks or registered
trademarks of Trinity Integrated Systems Limited.
All other trademarks are the property of their respective owners.
2
iDefine – Installation Guide
Contents
1
INTRODUCTION ................................................................................................ 5
2
SYSTEM REQUIREMENTS ............................................................................... 6
INSTALLATIONS ON A SEPARATED COMPUTERS ......................................................... 6
MS SQL Server Computer ................................................................................................. 6
Hardware ................................................................................................................... 6
Software..................................................................................................................... 6
iDefine Computer ............................................................................................................... 6
Hardware ................................................................................................................... 6
Software..................................................................................................................... 7
INSTALLATIONS ON A SAME COMPUTER .................................................................... 7
Hardware ............................................................................................................................. 7
Software .............................................................................................................................. 7
3
IDEFINE INSTALLATION ................................................................................... 9
INSTALLATION PACKAGE ......................................................................................... 9
UNINSTALL EXISTING IDEFINE ................................................................................. 9
IDEFINE INSTALLATION STEPS ................................................................................. 9
4
MS SQL SERVER INSTALLATION .................................................................. 14
CHOOSE SQL SERVER EDITION ........................................................................... 14
MS SQL SERVER 2012 EXPRESS EDITION INSTALLATION STEPS ............................ 15
ENABLE .NET FRAMEWORK 3.5............................................................................. 15
SQL SERVER 2019 EXPRESS EDITION INSTALLATION STEPS .................................. 21
SQL SERVER MANAGEMENT STUDIO .................................................................... 29
UPGRADING SQL SERVER 2012 TO 2019 ............................................................. 29
5
IDEFINE LICENSE ........................................................................................... 30
6
FIRST TIME RUN ............................................................................................. 31
SQL SERVER ON LOGIN WINDOW ......................................................................... 31
IDEFINE SQL SERVER INITIALISATION .................................................................... 31
7
ACTIVATE OUTPUT BUILD ............................................................................. 32
8
TROUBLESHOOTING ..................................................................................... 33
ERROR IN INSTALLING REQUIRED SOFTWARE ......................................................... 33
PROBLEM ........................................................................................................... 33
CONDITION ......................................................................................................... 33
3
4
iDefine – Installation Guide
PREVENTING PROBLEMS ..................................................................................... 33
RECOVERY METHODS ......................................................................................... 33
iDefine – Installation Guide
5
1 Introduction
This document describes system requirements for installation iDefine and topics
related to running iDefine for the first time.
For system administrators or IT administrators to setup iDefine environment and
apply security settings, refer to “iDefine - Security Manual.pdf” for details.
Introduction
6
2
iDefine – Installation Guide
System Requirements
Deployment of iDefine includes MS SQL Server installation and iDefine Installation.
Each can be installed on separated computers or a same computer.
Installations on a Separated Computers
The system requirements for separated computer deployment of MS SQL Server
and iDefine is different, so they are given separately as below.
MS SQL Server Computer
The computer running MS SQL Server for iDefine must meet the following
specifications in order to achieve reasonable performance for data access.
Hardware
❖
Processor:
Duo Core, 1GHZ (or equivalent and above)
❖
Ram:
8GB
❖
Hard drive:
10GB free space
❖
Network:
Gigabit Network Card
Software
❖
Operating System: Window Server 2012 R2, Windows Server 2016,
Windows 10, or Windows Server 2019.
❖
MS SQL Server:
•
For Windows Server 2012 R2: MS SQL Server 2012 SP3 or later
•
For Windows 10 and Windows Server 2016: MS SQL Server 2012
SP3 or later, or MS SQL Server 2016 SP1 or later.
•
For Windows Server 2019: MS SQL Server 2016 SP1 or later
Refer to https://docs.microsoft.com/en-us/sql/sql-server/install/hardware-
and-software-requirements-for-installing-sql-server for more details.
Navigate to the page for the particular version of SQL Server you are installing.
iDefine Computer
The computer running iDefine client must meet the following specifications to
achieve reasonable performance.
Hardware
System Requirements
❖
Processor:
Duo Core, 1GHZ (or equivalent)
❖
Ram:
1GB free
❖
Hard drive:
500MB free
iDefine – Installation Guide
Software
❖
Operating System: Windows Server 2012 R2, Windows Server 2016,
Windows 10, or Windows Server 2019.
❖
Microsoft .Net Framework 4.6.2 or later
❖
Microsoft Office 2013 or above (Optional)
❖
Microsoft SQL Server Management Studio (Optional)
https://docs.microsoft.com/en-us/sql/ssms/download-sql-server-managementstudio-ssms
This tool is required if some functionalities of SQL Server management are to
be performed.
This tool needs to be installed before Microsoft SQL Server components
(below).
❖
Microsoft SQL Server components (Mandatory):
o
Microsoft System CLR Types for Microsoft® SQL Server 2016
https://www.microsoft.com/en-us/download/details.aspx?id=56833
ENU\x86\SQLSysClrTypes.msi
o
Microsoft SQL Server 2016 Shared Management Objects
https://www.microsoft.com/en-us/download/details.aspx?id=56833
ENU\x86\SharedManagementObjects.msi
❖
Microsoft Access Database Engine 2016 Redistributable (Optional)
https://www.microsoft.com/en-us/download/details.aspx?id=54920
AccessDatabaseEngine.exe
This component is required if user is going to work with Microsoft Access
database files.
Installations on a Same Computer
When MS SQL Server and iDefine are deployed on a same computer, the system
specifications need to meet both requirements at the same time.
Hardware
❖
Processor:
Duo Core, 1GHZ (or equivalent and above)
❖
Ram:
8GB
❖
Hard drive:
10GB free space
❖
Network:
Gigabit Network Card
❖
Operating System: Window Server 2012 R2, Windows Server 2016,
Windows 10, or Windows Server 2019.
❖
MS SQL Server:
Software
System Requirements
7
8
iDefine – Installation Guide
•
For Windows Server 2012 R2: MS SQL Server 2012 SP3 or later
•
For Windows 10 and Windows Server 2016: MS SQL Server 2012
SP3 or later, or MS SQL Server 2016 SP1 or later.
•
For Windows Server 2019: MS SQL Server 2016 SP1 or later.
Refer to https://docs.microsoft.com/en-us/sql/sql-server/install/hardware-
and-software-requirements-for-installing-sql-server for more details.
Navigate to the page for the particular version of SQL Server you are installing.
❖
Microsoft .Net Framework 4.6.2 or later
❖
Microsoft Office 2013 or above (Optional)
❖
Microsoft SQL Server Management Studio (Optional)
https://docs.microsoft.com/en-us/sql/ssms/download-sql-server-managementstudio-ssms
This tool is required if some functionalities of SQL Server management are to
be performed.
This tool needs to be installed before Microsoft SQL Server components
(below).
❖
Microsoft SQL Server components (Mandatory):
o
Microsoft System CLR Types for Microsoft® SQL Server 2016
https://www.microsoft.com/en-us/download/details.aspx?id=56833
ENU\x86\SQLSysClrTypes.msi
o
Microsoft SQL Server 2016 Shared Management Objects
https://www.microsoft.com/en-us/download/details.aspx?id=56833
ENU\x86\SharedManagementObjects.msi
❖
Microsoft Access Database Engine 2016 Redistributable (Optional)
https://www.microsoft.com/en-us/download/details.aspx?id=54920
AccessDatabaseEngine.exe
This component is required if user is going to work with Microsoft Access
database files.
System Requirements
iDefine – Installation Guide
3
iDefine Installation
Installation Package
The iDefine installation package includes the following two files.
File Name
Description
setup.exe
Installation launch file
iDefine_installer.msi
MSI Installer file
haspdinst.exe
USB dongle runtime, installed automatically by
iDefine_Installer.msi.
Uninstall Existing iDefine
It’s recommended that existing iDefine to be manually uninstalled before installing a
new version.
Uninstalling an existing iDefine can be done from Windows Start menu and
Uninstall iDefine 1.16.x menu item. It can also be done from Windows Control
Panel and Programs and Features.
iDefine Installation Steps
1. Check Folder and File Permissions
iDefine installer will automatically launch Sentinel LDK License Manager
installer during the installation process.
Sentinel LDK License Manager is a Windows Service required by iDefine for
USB Dongle based licensing.
Before installing iDefine, check whether the following folder exists. If it does,
make sure that iDefine installer has been given sufficient permissions to make
changes to the folder and the content inside the folder.
C:\Program Files (x86)\Common Files\Aladdin Shared
a. In Windows File Explorer, navigate to folder
C:\Program Files (x86)\Common Files
b. If sub-folder Aladdin Shared exists, right click on this folder and select
Properties menu.
c.
In Security Tab, select SYSTEM account, and then click Advanced button.
iDefine Installation
9
10
iDefine – Installation Guide
d. In Window Advanced Security Settings for Aladdin Shared, select
SYSTEM account, and then click Change permissions button.
e. In the following Window, select SYSTEM account. Check the option
Replace all child object permission entries with inheritable permission
entries from this object.
If the button Enable inheritance exists, click on this button to enable
inheritance. If the button’s text is Disable inheritance, do not click on the
button.
iDefine Installation
iDefine – Installation Guide
After iDefine is installed, make sure that this folder has been given Read &
Execute permissions to the user account launching the Sentinel LDK License
Manager. The account can be found in Windows Services console.
2. Prepare the installation files
If the installation is going be shared by multiple users on the same computer and
the installation files are provided by a CD media, please copy all the installation
files to a local or network shared folder to which all the potential iDefine users
have read permissions.
This is important because each iDefine user (other than the original user who
installed iDefine) needs to run the installer configuration when iDefine is
launched first time, and this process requires the original installation files to be
available. Sometimes security policies may prevent non-administrative users to
use CD-ROM for installing software.
3. Run the setup.exe file as administrator to start iDefine installation process
iDefine Installation
11
12
iDefine – Installation Guide
If the required version of Microsoft .Net Framework does not exist in the computer,
a message will show and please go to Microsoft Web site and download and install
the required .Net Framework.
Depending on the Operating System and the user and security settings, Windows
UAC may popup message asking for confirmation. Please click the Run button if the
following or similar Security Warning message pops up.
4. Read and agree License Agreement
It’s important that you read and understand the content in the License Agreement
before you continue installing iDefine. If you don’t agree, stop the installation
process immediately by pressing the Cancel button.
5. Choose installation folder and user
iDefine Installation
iDefine – Installation Guide
By default, iDefine will be installed to Program Files (x86) folder of your Operating
System drive. But this location is not mandatory. User can choose any other location
the current user has write permission.
It’s important to choose correct user on this page. If multiple user accounts on the
same computer are going to user this installation, Everyone should be selected,
otherwise, select Just Me.
6. Launch iDefine after installation
The last page of the installer will let you to start iDefine immediately by selecting the
Launch iDefine if a valid license is present.
iDefine Installation
13
14
4
iDefine – Installation Guide
MS SQL Server Installation
Choose SQL Server Edition
Any edition from MS SQL Server 2012 family, MS SQL Server 2016 family and MS
SQL Server 2019 family can be used by iDefine. For personal computer
deployment, Express edition is recommended. For enterprise deployment, Standard
edition is recommended.
The following sections will describe the steps for installing MS SQL Server 2012
Express and MS SQL Server 2019 Express.
For more up-to-date and more detailed instructions, please refer to Microsoft
installation guide for SQL Server.
https://docs.microsoft.com/en-us/sql/database-engine/install-windows/install-sqlserver
MS SQL Server Installation
iDefine – Installation Guide
MS SQL Server 2012 Express Edition Installation Steps
This section describes the steps for installing Express edition of MS SQL Server
2012. Installing other editions from the same family may have variable steps, but
most of the process is similar.
Enable .Net Framework 3.5
SQL Server 2012 requires .Net Framework 3.5 to be installed on the target Windows
system. In some versions of Windows (e.g. Windows 10 and Windows Server 2016),
.Net Framework 3.5 is not installed by default and the following message will come
up when installing SQL Server 2012.
To prevent this issue, it’s recommended to check the versions of .Net Framework
currently installed on the computer, by following the instructions in the link below.
https://support.microsoft.com/en-gb/help/318785/how-to-determine-which-versionsand-service-pack-levels-of-the-microso
Alternatively, if this issue occurs, follow the instructions in the link below to enable
.Net Framework 3.5.
https://docs.microsoft.com/en-us/windowshardware/manufacture/desktop/microsoft-net-framework-35-deploymentconsiderations
1. Launch the installer
Depending on which editor you are installing, the file to launch the installer may be
different.
When installing x86 Express edition, the file to start the installer
“SQLEXPR_x86_ENU.exe”.
is
2. SQL Server Installation Centre
MS SQL Server Installation
15
16
iDefine – Installation Guide
When the SQL Server Installation Centre window starts up, select the New SQL
Server stand-alone installation or add features to an existing installation.
3. Product Updates
Depending on the status of the current Operating System, certain required system
components and patches may be required before the installation can continue. If
there are any, they will be highlighted in the Product Updates page.
4. Install Setup Files
Required SQL Server setup files will be first installed.
5. Select Installation Type
MS SQL Server Installation
iDefine – Installation Guide
Depending on whether there are any existing SQL Server instances in current
computer, this page may or may not appear. If it appears, select “Perform a new
installation of SQL Server 2012”.
6. License Terms
Please accept the license terms if you want to the installation continue.
7. Product Updates
If the computer is not connected to Internet, SQL Server Setup will show the following
message. Click the Next button to continue.
8. Feature Selection
MS SQL Server Installation
17
18
iDefine – Installation Guide
At least, “Database Engine Services” needs to be selected.
9. Installation Rules
Certain settings on the computer may prevent SQL Server installation from
continuing. If they are any, they will be highlighted and please refer to MS SQL
Server 2012 Installation Guide from Microsoft.
10. Instance Configuration
MS SQL Server Installation
iDefine – Installation Guide
If this is first time installation, select “Default instance”. If default instance is already
used, you may need choose “Named instance” and give a name.
It’s important that for iDefine to access “Default instance”, computer name (localhost
for current local computer) or computer IP address can be used in the iDefine login
Window. If the SQL Server is configured as “Named instance”, computer name
(localhost for current local computer or IP address) needs to be followed by instance
name, such as “computername\iDefineSQLServer”.
11. Disk Space Requirements
This page will be automatically skipped if there is enough disk space in the current
computer.
MS SQL Server Installation
19
20
iDefine – Installation Guide
12. Server Configuration
▪
Service Accounts
Default new user account will be created for SQL Server Database Engine. User
can also choose other local account such as “NT AUTHORITY\NETWROK
SERVICE” as the account to start the SQL Server Database Engine.
▪
Collation
Depending on the current computer language code, the default collation may be
different on different computer. To avoid issues when transferring project across
computers, iDefine recommends using
“SQL_Latin1_General_CP1_CI_AS”.
13. Database Engine Configuration
MS SQL Server Installation
iDefine – Installation Guide
▪
Server Configuration
Windows authentication mode will only allow Windows User account to access the
SQL Server.
Mixed Mode allows local SQL Server user account to access the SQL Server.
Please “Add Current User” as SQL Server administrators and add other Windows
User accounts if necessary.
▪
Data Directories
Leave them as default unless you want to store the SQL data files in a specific
location.
▪
User Instances
Leave the option as default.
14. Error Report
Select the option if you are willing to send error report to Microsoft.
15. Start the Installation
The installation will start from the next page. If no error occurs, an installation of MS
SQL Server 2012 is completed on the current computer.
SQL Server 2019 Express Edition Installation Steps
This section describes the steps for installing Express edition of MS SQL Server
2019. Installing other editions from the same family may have variable steps, but
most of the process is similar.
1. Launch the Installation Manager
MS SQL Server Installation
21
22
iDefine – Installation Guide
When the installation manager is downloaded, open the executable and select
the Custom option for the installation type and then choose Express Advanced
package.
2. SQL Server Installation Centre
In the SQL Server Installation Centre, select the New SQL Server stand-alone
installation or add features to an existing installation option to start the
installation.
3. License Terms
MS SQL Server Installation
iDefine – Installation Guide
Accept the license terms and other details on the Licence Terms screen and
click Next.
4. Global Rules
In this step, SQL Server setup will scan settings in the computer to search for
any potential problems which may cause installation failure. All Failed items
need to be fixed before you can move to the next step.
5. Product Updates
MS SQL Server Installation
23
24
iDefine – Installation Guide
In this step, SQL Server setup checks the latest updates for the SQL Server
installation and runtime. If the computer is not connected to internet, uncheck
the Include SQL Server product updates option and click Next.
6. Install Rules
In this step, the potential issues will be checked by SQL Server setup that
might be occurred during the installation. If there are no Failed items, click
the Next button and skip the next step.
7. Feature Selection
MS SQL Server Installation
iDefine – Installation Guide
In this step, you can select the features which you want to install. If the
installation is only for iDefine, you can deselect the following features:
•
•
•
•
Machine Learning Services and Language Extensions
Full-Text and Semantic Extractions for Search
PolyBase Query Service for External Data
LocalDB
Here, you can specify the installation path of the SQL Server through
the Instance root directory option.
8. Instance Configuration
MS SQL Server Installation
25
26
iDefine – Installation Guide
In the Instance Configuration screen, you can choose either Default
instance or Named instance. The selection will affect what’s going to be
entered in iDefine login screen for SQL Server entry. Please refer to the
section for installing MS SQL Server 2012 Express Edition for more details.
9. Server Configuration
In the Server Configuration screen, you can choose the startup type of the
SQL Server Database Engine and SQL Server Browser services. You can also
choose the Collation for the whole SQL Server.
Please refer to the section for installing MS SQL Server 2012 Express Edition
for more details.
10. Database Engine Configuration
MS SQL Server Installation
iDefine – Installation Guide
▪
Server Configuration
Windows authentication mode will only allow Windows User account to access the
SQL Server.
Mixed Mode allows local SQL Server user account to access the SQL Server.
Please “Add Current User” as SQL Server administrators and add other Windows
User accounts if necessary.
•
Data Directories
In the Data Directories tab, you can set the default directory of the database
and backup files. By default, keep the default settings.
•
TempDB
In the TempDB tab, you can set the number and size of the tempdb files. For
iDefine, you can keep the default settings.
▪
User Instances
Leave the option as default.
▪
FILESTREAM
Leave the option as default.
11. Installation Progress
When the installation starts, details will be shown in the Installation
Progress screen.
MS SQL Server Installation
27
28
iDefine – Installation Guide
12. Complete Installation
In the final step, the Complete screen gives information about the result of the
installation:
MS SQL Server Installation
iDefine – Installation Guide
SQL Server Management Studio
It’s optional to install SQL Server Management Studio. But it’s mandatory if the SQL
Server is going to be accessed from other computers by different user accounts.
Please refer to “iDefine - Security Manual.pdf” for details on how to user SQL Server
Management Studio to manage securities.
Upgrading SQL Server 2012 to 2019
Microsoft has provided detailed instructions on how to upgrade SQL Server on the
following web page.
https://docs.microsoft.com/en-us/sql/database-engine/install-windows/upgrade-sqlserver
Besides this method, user can also choose to uninstall an older version of SQL
Server and install a later version. Below are the steps to perform this task for
upgrading SQL Server 2012 to SQL Server 2019.
1. Back up iDefine projects
Export all the iDefine projects on SQL Server 2012 to ipj files.
2. Uninstall SQL Server 2012
3. Install SQL Server 2019
4. Restore iDefine ipj files
Import all the ipj files to SQL Server 2019
MS SQL Server Installation
29
30
5
iDefine – Installation Guide
iDefine License
Before you can use iDefine, a license needs to be obtained from Trinity Integrated
Systems.
The license can be in one of the two formats:
•
A license file downloaded from Enterprise License Server
•
A USB dongle issued by Trinity Integrated Systems.
If the license is in a USB dongle, the dongle can be either plugged onto the computer
running iDefine or another computer running iDefine Dongle Gateway. Before
launching iDefine, the dongle needs to be plugged into the computer’s USB port
and it needs to be in the USB port all the time while iDefine is running.
If the license is in a license file format, a USB dongle is not needed.
For more details about the iDefine license and its usage, please refer to “License User Guide.pdf”, in iDefine installation folder or from Windows Start menu.
iDefine License
iDefine – Installation Guide
6
First Time Run
For details on how to proficiently use iDefine, please refer to “iDefine - User
Guide.pdf” in iDefine installation folder or from Windows Start menu. To get started,
here describes the settings in the Login Window and SQL Server initialisation
instructions.
SQL Server on Login Window
Depending on the Instance Configuration of the SQL Server instance, the text
entered for SQL Server entry on iDefine login Window varies.
▪
▪
Default Instance, valid text can be
•
Computer Name
•
IP Address
•
localhost if the SQL Server is on current computer
Named Instance, valid text is one of the above for Default Instanced followed
by \InstanceName, such as ComputerName\SQLInstanceName
iDefine SQL Server Initialisation
A necessary initialisation step is required before user can create or import any
iDefine project on the SQL Server.
When iDefine MS SQL Server is not initialised, iDefine will show error messages
when it’s started. At this point, type correct iDefine SQL Server login credentials,
and press the “New Project” or the “Import Project” button to initialise the database.
First Time Run
31
32
7
iDefine – Installation Guide
Activate Output Build
Output Build can be activated by settings in iDefine license (dongle or license file)
or by obtaining a license file from Trinity Integrated Systems.
If the iDefine license has not enabled Output Build (the Build All button in iDefine
main window is disabled when an Output Configuration is open), the following
procedure can be followed to obtain a license from Trinity Integrated Systems.
The procedure to obtain the license file and Activate Output Build is as follows:
❖
Start iDefine and login to the project you are going to build output code for.
❖
Select Tools | Activate Output Build. Save the Activation Code to a file and
Email it to Trinity Integrated Systems.
❖
Trinity will issue you an OutputDriveLicense.lic file.
❖
Put the file into the iDefine installation directory, such as C:\Program
Files\Trinity Integrated Systems\iDefine x.xx (where
x.xx indicates the version).
❖
Next time, when you login to the same project in iDefine, in the Output
Configuration module, you will see Build All is enabled.
The license file has the following restrictions:
Activate Output Build
❖
The license file is machine specific.
❖
The license file is project specific.
iDefine – Installation Guide
8
Troubleshooting
If the instructions given in this document so far cannot be executed due to some
errors, please check this chapter for possible solutions. If the right solution cannot
be found, please contact us to report the issue.
Error in Installing Required Software
Problem
It fails to install .Net Framework, SQL Server 2012 or Windows update programs.
Condition
•
OS is Windows 8 or later.
•
The default authentication level for DCOM is set to "None." (The default
value is “Connect”.)
Preventing Problems
Prior to installing the software, check the default authentication level for DCOM
and change the value if necessary by following the steps described in the
Recovery Methods section.
Recovery Methods
1. Change the default authentication level for DCOM to “Connect”
•
Choose “Control Panel” > “Administrative Tools.”
Troubleshooting
33
34
iDefine – Installation Guide
Troubleshooting
•
Start “Component Services.”
•
Choose “Console Root” > “Component Services” > Computers” > “My
Computer” and then choose “Properties” from the context menu.
•
The “My Computer Properties” dialog box is displayed.
iDefine – Installation Guide
•
Change the setting for “Default Authentication Level” from “None” to
“Connect.”
Troubleshooting
35
36
iDefine – Installation Guide
•
Click the “Apply” or “OK” button.
2. Restart PC.
3. Install Dot Net Framework, SQL Server 2012 or Windows Update programs.
4. Get back the default authentication level to the original value and restart PC.
Troubleshooting
iDefine – Installation Guide
37