install guide for rtx64 2013 merge modules - intervalzero€¦ · 5....

$: Install Guide for RTX64 2013 Merge Modules - IntervalZero€¦ · 5. IntheDestinationFolderscreen,selectthedefaultfolder C:\Program Files (x86) \IntervalZero\RTX64 MergeModules\1.1\,andthenclickNext$
RTX64 2013 withService Pack 1 and Update 4

Merge Modules Install Guide

Copyright © 1996-2014 by IntervalZero, Inc. All rights reserved.

No part of this document may be reproduced or transmitted in any form or by any means, graphic, electronic, or mechanical, includingphotocopying, and recording or by any information storage or retrieval system without the prior written permission of IntervalZero, Inc.unless such copying is expressly permitted by federal copyright law.

While every effort has been made to ensure the accuracy and completeness of all information in this document, IntervalZero, Inc.assumes no liability to any party for any loss or damage caused by errors or omissions or by statements of any kind in this document,its updates, supplements, or special editions, whether such errors, omissions, or statements result from negligence, accident, or anyother cause. IntervalZero, Inc. further assumes no liability arising out of the application or use of any product or system describedherein; nor any liability for incidental or consequential damages arising from the use of this document. IntervalZero, Inc. disclaims allwarranties regarding the information contained herein, whether expressed, implied or statutory, including implied warranties ofmerchantability or fitness for a particular purpose.

IntervalZero, Inc. reserves the right to make changes to this document or to the products described herein without further notice.

Microsoft, MS, and Win32 are registered trademarks and Windows 7 and Windows 8 are trademarks of Microsoft Corporation.

All other companies and product names may be trademarks or registered trademarks of their respective holders.

Installation Guide for RTX64 2013 with Service Pack 1 and Update 4 Merge Modules

Document Reference Number: IZ-DOC-X86-0128-R3

October 2014

IntervalZero400 Fifth AvenueFourth FloorWaltham, MA 02451Phone: 781-996-4481www.intervalzero.com

Introduction 1

Editions 1

Requirements 2

Hardware Requirements 2

Development and Target Systems 2

Development Machine 2

Supported Network Adapters 2

Target Machine Hardware Considerations 2

Software Requirements 3

Development Machine Software Requirements 3

Target Machine Software Requirements 3

Installing RTX64 Merge Modules 4

Additional Installation Options 4

Performing the Install 4

Files Added During Installation 5

Merge Module Deployment 6

Runtime Installation Requirements 6

Merge Module Dependencies 6

New Installation vs. Major Upgrade 6

Target Activation and Configuration 9

Activating your Product 9

Configuring your System 9

Uninstalling RTX64 Merge Modules 11

Using the Samples 12

InstallShield Sample Project 12

Visual Studio Sample Project 12

Installation Errors and Warnings 14

Getting Support 18

Third-Party Support 18

Before Calling Technical Support 18

Contents

i

IntervalZero Web Site 18

Contacting Technical Support by Phone 18

ii

IntroductionIntervalZero provides merge modules that contain components of the RTX64 Runtime. This allowsdevelopers to include selected components of the RTX64 Runtime into their product installation package.

The RTX64 Runtime is broken down into the following merge module components.

l haspds.msm

l RtTcpip.msm

l Subsystem.msm

l LatencyView.msm

This guide provides information on the RTX64 merge modules, including system requirements andinstallation instructions.

EditionsIntervalZero provides six different Runtime editions of the RTX64 product, listed in the table below.

The edition... Includes support for real-time operations on...

Solo One dedicated RTSS processor in a multicore/multiprocessor environment.

Entry Up to two dedicated RTSS processors in a multicore/multiprocessorenvironment.

Basic Up to three dedicated RTSS processors in a multicore/multiprocessorenvironment.

Professional Up to seven dedicated RTSS processors in a multicore/multiprocessorenvironment.

Premium Up to 15 dedicated RTSS processors in a multicore/multiprocessorenvironment.

Ultimate Up to 63 dedicated RTSS processors in a multicore/multiprocessorenvironment.

IZ-DOC-X86-0128-R3 1 Introduction

Requirements

This chapter lists the hardware and software requirements for using the RTX64 Merge Modules.

Hardware Requirements

Development and Target SystemsUsing the Merge Modules software involves multiple machines:

l A development machine on which you install the merge modules and then use an MSI deployment toolto create a setup installation kit, and

l The target machines where the installation containing the RTX64 Runtime will be installed.

Development MachineThe development machine on which you install Merge Modules should have an MSI deployment tool thatsupports merge modules and can be used to create an installation kit.

Supported Network AdaptersThe RTX64 TCP/IP merge module provides support for a number of network adapters. For the most up-to-date list, see the RTX64 Network Driver Support PDF available at the IntervalZero web site:

http://www.intervalzero.com/technical-support/guides-and-minitutorials/

Target Machine Hardware ConsiderationsSome hardware configurations are not supported by RTX64 installations. When RTX64 can detect theseunsupported configurations, the default behavior is to display a popup error message. This behavior can bechanged if the [RTX_ERROR_DISPLAY] property is set to StringRegVal or NumRegVal (see the Merge ModuleProperties section for more information).

1

IZ-DOC-X86-0128-R3 2 Requirements

http://www.intervalzero.com/technical-support/guides-and-minitutorials/

Although RTX64 runs on most x64 platforms, unique attributes of some processors require specialconsideration before selecting them as a target system.

l For a comprehensive list of approved and supported hardware, see the Microsoft Windows LogoProgram web page:

http://www.microsoft.com/whdc/whql/default.mspx

Software Requirements

Development Machine Software RequirementsThe RTX64 2013 Merge Modules require the Windows Installer MSI Version 3.1.

Target Machine Software Requirements

Target Machine Operating SystemThe RTX64 2013 Runtime is supported on the 64-bit configurations of these operating systems:

l Windows 8 (without SP1)

l Windows Embedded Standard 8 (x64) without SP1 (must support MSI installation to allow RTX64 to beinstalled)

l Windows 7 (x64) with SP1

l Windows Embedded Standard 7 (x64) with SP1 (must support MSI installation to allow RTX64 to beinstalled)

NOTE: Windows Home editions are not supported.

IZ-DOC-X86-0128-R3 3 Requirements

http://www.microsoft.com/whdc/whql/default.mspx

Installing RTX64 Merge Modules

This section describes the installation of RTX64 Merge Modules.

Additional Installation OptionsIn addition to using the merge modules described in this document, the RTX64 Runtime is also available inthe following installation types:

l RTX64 Runtime – RTX64 is available as a Runtime installation. This support is provided in a separateinstaller and is also available as an evaluation version. The RTX64 Runtime can also be installed silently.For more information, see the Silent Installation section of the RTX64 2013 Runtime with Service Pack 1Install Guide.

Performing the Install

To install RTX64 Merge Modules:

1. Download the self-extracting executable, RTX64_2013_MM_with_SP1_&_Update4_Setup.exe,from the IntervalZero web site:

http://www.intervalzero.com/rtx-downloads/rtx64-downloads/

2. Double-click the RTX64_2013_MM_with_SP1_&_Update4_Setup.exe.

3. Click Next in the IntervalZero RTX64 Merge Modules installation Welcome window.

4. Read the End User License Agreement, select I accept the terms in the license agreement and thenclick Next.

2

IZ-DOC-X86-0128-R3 4 Installing RTX64 Merge Modules

http://www.intervalzero.com/rtx-downloads/rtx64-downloads/

5. In the Destination Folder screen, select the default folder C:\Program Files (x86)\IntervalZero\RTX64 MergeModules\1.1\, and then click Next.

6. In the Ready to Install the Program screen click Install.

7. Click Finish in the installation Completed screen.

Files Added During InstallationThe RTX64 Merge Modules installation adds files to the following directory:

c:\Program Files (x86)\IntervalZero\RTX64 Merge Modules\1.1 (by default)

Merge Modules can be found in the subdirectory

\Repository

The merge modules that are installed include:

l \Repository\haspds.msm

l \Repository\RtTcpip.msm

l \Repository\Subsystem.msm

l \Repository\LatencyView.msm

Sample InstallShield 2011 installer project can be found in:

C:\Program Files (x86)\IntervalZero\RTX64MergeModules\1.1\Samples\InstallShield2011\SampleRuntimeInstall.ism

Sample Setup Visual Studio 2010 installer project file can be found in:

C:\Program Files (x86)\IntervalZero\RTX64MergeModules\1.1\Samples\Visualstudio2010\MSIsample.vdproj


Merge Module DeploymentOnce the merge modules have been installed onto the development system, they can be included in a setupfile that will be installed on a target system.

Runtime Installation RequirementsIn addition to the target machine operating system requirements listed at the start of this document, takenote of the following information when RTX64 merge modules are added to an installation.

l Administrator privileges are required— Installations using RTX64 merge modules must be done froman account that has administrator privileges.

l You must reboot after RTX64 has been installed, licensed and configured.

Merge Module DependenciesIf any of the RTX64 merge modules are added to an installation, they must include the RTX64 Subsystem,which is contained in the merge module file Subsystem.msm.

New Installation vs. Major UpgradeRTX64 Merge Modules comes with a sample project, SampleRuntimeInstall, that you can use to set up aRuntime install for deployment. This project contains a few configurations to the MSI project that you wouldotherwise have to do manually. These configurations differ between new installations and major upgrades,as outlined below.

Configuration for New InstallationsThe following MSI configurations are required for new installation deployment of RTX64 Merge Modules.

NOTE: The SampleRuntimeInstall project already includes these configurations. We recommendusing this sample project as a starting point to ensure proper setup.

Create the custom action to call RTX64ActivationGUI.exe:

1. In the Installation Designer tab, click User Interface > Dialogs.

2. Click SetupCompleteSuccess > Behavior.

3. Click OK - PushButton.


4. Add a DoAction with the following argument: LaunchActivationGUI.05FC3EC9_D46F_4ECB_B3D7_51F559EB4C13.

5. Set the condition of this action to NOT P_MAJORUPGRADE.

Set the destination to INSTALLDIR:

1. In the Installation Designer tab, click Application Data > Redistributables.

2. Right-click on RTX64 Subsystem. The Merge Modules Properties dialog appears.

3. Set the Destination to [INSTALLDIR].

4. Click OK.


Configuration for Major UpgradesThe following MSI configurations are required for major upgrade deployment of RTX64 Merge Modules.

NOTE: The SampleRuntimeInstall project already includes these configurations. We recommendusing this sample project as a starting point to ensure proper setup.

Set the Detect Property:

1. Open the MSI project. In the Installation Designer tab, click Media > Upgrades.

2. Under Prepare Setup for Upgrade Scenarios, click Upgrade Windows Installer Setup, and then createa new entry calledMajorupgrade.

3. In the Advanced tab, set Detect Property to P_MAJORUPGRADE.

Create the custom action to call RTX64ActivationGUI.exe:

1. In the Installation Designer tab, click User Interface > Dialogs.

2. Click SetupCompleteSuccess > Behavior.

3. Click OK - PushButton.

4. Add a DoAction with the following argument: LaunchActivationGUIUpgrade.05FC3EC9_D46F_4ECB_B3D7_51F559EB4C13.

5. Set the condition of this action to P_MAJORUPGRADE.

Set the destination to INSTALLDIR:

1. In the Installation Designer tab, click Application Data > Redistributables.

2. Right-click on RTX64 Subsystem. The Merge Modules Properties dialog appears.

3. Set the Destination to [INSTALLDIR].

4. Click OK.


Target Activation and ConfigurationOnce RTX64 Runtime is installed on your target system, you must activate the RTX64 product and configuresystem processors. This can be done through the RTX64 Activation and Configuration Utility, or through aCommand Line utility. For more detailed activation options, see the RTX64 Deployment Guide.

Activating your Product

NOTE: As a secondary option to activating with Rtx64ActivationUtil.exe, you can use theRTX64 Activation utility.

To activate your product (Internet connection required):

1. Navigate to the RTX64\bin directory and run Rtx64ActivationUtil.exe as Administrator.

2. Type the -a flag, and then provide your activation key. For example:

Rtx64ActivationUtil.exe -a RTX64-111-2222-3333-4444-5555-TCP64-111-2222-3333-4444-5555

NOTE: You can find your activation key in the email you received from IntervalZero Sales.

3. If running from a command prompt, the activated components are displayed.

4. If you want to force activation to an IntervalZero-provided dongle, you can use the -dongle flag. Ifyou want to force activation to ignore a dongle, use the -nodongle flag. For example:

RTX64ActivationUtil.exe -a -dongle RTX64-111-2222-3333-4444-5555-TCP64-111-

2222-3333-4444-5555 (forces activation to dongle)

RTX64ActivationUtil.exe -a -nodongle RTX64-111-2222-3333-4444-5555-TCP64-

111-2222-3333-4444-5555 (forces activation to machine)

RTX64ActivationUtil.exe -a RTX64-111-2222-3333-4444-5555-TCP64-111-2222-

3333-4444-5555 (machine activation)

Configuring your System

NOTE: If your system is hyper-threaded, it is recommended that you assign an even number ofprocessors between Windows and RTX64. The Windows logical processor and RTSS logical processormust not share the same physical processor.


Setting the boot configuration:

1. Navigate to the RTX64\bin directory.

2. Run Rtx64ActivationUtil.exe as Administrator. You must activate your system before you canconfigure system processes.

3. Provide the number of Windows -w and RTSS -r processors. For example, to assign 3 processors toWindows and 5 processors to RTX64 on a dedicated system, you would type:

Rtx64ActivationUtil.exe -w 3 -r 5

4. Restart the system.


Uninstalling RTX64 Merge Modules

To uninstall the RTX64 Merge Modules:

1. Navigate to theWindows Control Panel.

2. Under Programs, click Uninstall a Program.

3. Select RTX64 2013 with Service Pack 1 and Update 4 Merge Modules and then click Uninstall.

4. Click Yes to confirm.


Using the Samples

Sample project files are provided to help in creating installation kits that include the RTX64 merge modules.

InstallShield Sample ProjectThe RTX64 Merge Modules installation includes a sample InstallShield project. This project contains thedongle drivers or Sentinel Runtime Environment, RTX64 Real-time TCP/IP Stack, RTX64 Latency View, and theRTX64Subsystem, which can be seen in:

Organization > Setup Design

NOTE: The InstallShield sample assumes that the merge modules will be located in the RTX64merge modules repository. You can add this location to the repository directory by using theMergeModules tab of the InstallShield options dialog. Or, if you have another repository directory,you can move the merge modules to that location.

You can set the Activation and Configuration utility to launch after installation by setting it as a DoAction. Todo this, go to User Interface > Dialogs > All Dialogs > SetupCompleteSuccess > Behavior > OK.

Visual Studio Sample ProjectThe RTX64 Merge Modules installation includes a sample Visual Studio merge module project. This simpleproject contains all of the RTX64 Runtime merge modules to build a setup.exe installation kit. It does notinclude any custom actions to set properties. Therefore, to run the completed installation, these propertieswould need to be set on the command line. To do this, follow the steps below.

3

IZ-DOC-X86-0128-R3 12 Using the Samples

To execute the sample msi with msiexec via Command Prompt:

l Launch a Command Prompt as Administrator.

l Replace C:\Program Files\MyCompany\VSISample with your install destination folder, usingmsiexec /i “C:\Temp\MSIsample.msi” TARGETDIR="C:\Program

Files\MyCompany\MSISample".

IZ-DOC-X86-0128-R3 13 Using the Samples

Appendix A:Installation Errors and Warnings

Possible registry key values in case of an error or warning during the product install are shown in thefollowing table.

Nbr Description of the error or warning

1 Silent install; the CheckUninst function found a previous (pre-MSI) version of RTX64.

2 Silent install; the CheckUninst function found a previous (pre-MSI) version of RT-TCP/IPinstalled.

3 The CheckUninst function found a previous (pre-MSI) version of RTX64 installed; user clicked"No" when asked to uninstall it.

4 The CheckUninst function found a previous (pre-MSI) version of RTX64 SDK installed; userclicked "No" when asked to uninstall it.

5 The CheckUninst function found a previous (pre-MSI) version of RTX64 installed; user clicked"No" when asked to uninstall it.

6 The GetOSCurrentVersion function called MsiGetProperty(VersionNT) and failed.

7 The GetOSCurrentVersion function called MsiGetProperty(VersionNT) and got NullString.

8 The GetOSCurrentVersion function called MsiGetProperty(VersionNT) and len(value) != 3.

9 The detected operating system version is not supported.

14 Calling RtxCapabilities failed.

21 Unused / saved for a "default" case.

22 Unable to load SUPPORTDIR from MSI table.

23 Either no email address, or an invalid email address was supplied.

24 No value found in HKLM\SOFTWARE\Microsoft\Windows NT\CurrentVersion:ProductId.

25 No value found in HKLM\SOFTWARE\Microsoft\Windows NT\CurrentVersion:InstallDate.

32 An exception occurred while calling VciValidate.

IZ-DOC-X86-0128-R3 14 Installation Errors and Warnings


34 Unable to load VersionNT from msi table during Reg_SetProps.

35 RtxCapabilities failed during Reg_SetProps.

38 The user's operating system is not supported without extended OS support.

41 An exception occurred while validating installation.

42 Unable to load SUPPORTDIR from MSI table during RtxCapabilities.

43 Windows installation of the subsystem on a Svr'03' SP2 on a Uniprocessor platform is notsupported.

44 Unable to load SUPPORTDIR from MSI table in DoInstallSubsystemActions.

45 Unable to load AppDataFolder from MSI table in DoInstallSubsystemActions.

46 SetSecInfo failed (this is the routine which patches the subsystem files).

47 Call to VciGetHalType failed.

48 The script variable sOSVersion is not initialized during GetHalType.

50 Detected HAL: "MPS 1.4 - APIC platform", only 1 processor.

51 Detected HAL: "ACPI 1.0 - APIC platform MP", only 1 processor.

52 Detected HAL doesn't match any known HALs.

53 Detected HAL name doesn't contain "x86" or "ACPI" on windows Vista or higher.

55 A call to ListCreateFailed.

56 RegDBQueryKey("HARDWARE\\RESOURCEMAP\\Hardware Abstraction Layer") Failed.

57 First call to ListCreate failed.

58 Second call to ListCreate failed.

59 Third call to ListCreate failed.

60 In ListGetValue. The list passed in is not valid.

61 In ListSetValue. The list passed in is not valid.

62 MsiGetProperty( "ProductCode" ) returned "".

63 MsiGetProperty( "VersionNT" ) returned "".

64 Calling RTX64Capabilities with the current ProductID resulted in an error.

65 The OS Support field of the product code contains an invalid value.

66 The VS Support field of the product code contains an invalid value.



67 The Edition field of the product code contains an invalid value.



70 Upgrading from an evaluation package is not allowed.

71 CustomActionData was truncated.

72 Calling SetSecInfo failed.

73 MsiGetProperty( "SUPPORTDIR" ) failed.

74 Error occured while calling ShellExecute(): File not found.

75 Error occured while calling ShellExecute(): Path not found.

76 Error occured while calling ShellExecute(): Access denied.

77 Error occured while calling ShellExecute(): Out of memory.

78 Error occured while calling ShellExecute(): Invalid EXE file or error in EXE image.

79 Error occured while calling ShellExecute(): A sharing violation occurred.

80 Error occured while calling ShellExecute(): Incomplete or invalid file association.

81 Error occured while calling ShellExecute(): DDE Time out.

82 Error occured while calling ShellExecute(): DDE transaction failed.

83 Error occured while calling ShellExecute(): DDE busy.

84 Error occured while calling ShellExecute(): No association for file extension.

85 Error occured while calling ShellExecute(): DLL not found.

86 MsiGetProperty( "SUPPORTDIR" ) failed.

87 A call to RtcplStopSubsystemComponent() failed.

88 CustomActionData was truncated – possible long paths pushed the value past its limit.

89 Prop "SYSTEMP" not found.

90 Loading VciFindArc or one of its dependencies failed.

91 An exception occurred while trying to set security info.

92 An error occurred while trying to activate RTX64.

93 Failed to copy Rtx_Rtss.sys file to drivers directory.

94 Failed to copy Rtx_HalExt.sys file to drivers directory.



96 An exception was thrown while calling RttlsSetNumberOfProcessSlots().

97 RttlsSetNumberOfProcessSlots() returned FALSE.

98 Failed to load positive numeric value from [RTX64_CTRL_PROCESSSLOTS].

100 The LaunchConditions action detected that the current operating system is not supported.

101 An earlier version of RTX64 was detected, and should be uninstalled before installing thisversion.

102 64 bit versions of Windows are not supported.

507 RttlsEnableComponent(COMPONENT_TCPIP) failed.

508 RtcplSetTCPIPUSBDependency() failed.

521 An Exception occurred while calling Stop_Rtss.


Getting SupportIntervalZero offers a number of support options for RTX64 users, including technical support and theIntervalZero Web site.

Third-Party SupportIf you are a customer who purchased an IntervalZero product through a third-party reseller, contact thereseller for support.

Before Calling Technical SupportPlease have the following information ready before calling IntervalZero Technical Support:

Your Support IDCustomers who purchase direct support receive an e-mail address and password for use when accessing theIntervalZero support web site.

The Version Number of Your RTX64 SoftwareBefore calling technical support, determine the version of RTX64 installed on your system.

IntervalZero Web SiteThe IntervalZero Customer Support Web page is located at:

http://www.intervalzero.com/technical-support/

The IntervalZero support web pages provide electronic access to the latest product releases,documentation, and release notes. With a valid e-mail address and password, you can access the onlineproblem report database to submit new issues or to obtain the status of previously reported issues.

Contacting Technical Support by PhoneFor technical support related to installing and using RTX64, you can call technical support at 1-781-996-4481. At the prompt, press 3 for Support.

Hours are Monday - Friday, 8:30 a.m. – 5:30 p.m. US Eastern time (GMT-500), excluding holidays.

IZ-DOC-X86-0128-R3 18 Getting Support

http://www.intervalzero.com/technical-support/

A

activation 9

D

development machinehardware requirements 2software requirements 3

E

editions 1errors 14

H

hardware requirements 2development machine 2network adapters 2

I

installing 4additional options 4errors 14files added during installation 5warnings 14

L

licensing 9

M

merge modulesdependencies 6deployment 6

N

network adapters 2

R

requirementshardware 2runtime installation 6software 3

S

samples 12software requirements 3

development machine 3target machine 3

support 18

T

target machinehardware considerations 2software requirements 3

U

uninstalling 11

W

warnings 14

Index

I

install guide for rtx64 2013 merge modules - intervalzero€¦ · 5....

Documents