QESTNET Internal:Building and Installing an Integration Project - Revision history

John.meegan at 03:53, 15 October 2015

2015-10-15T03:53:50Z

←Older revision		Revision as of 03:53, 15 October 2015
Line 17:		Line 17:
	* Any other dll files which require changes from the last build		* Any other dll files which require changes from the last build
	* A QESTNET.exe.config file (see below)		* A QESTNET.exe.config file (see below)
			* A QESTNET.Integration.Console.exe.config file. From QESTNET.Sessions.Integration/QESTNET.Integration.Console. No changes to this file should be needed.
	* Any SQL scripts required for the integrator		* Any SQL scripts required for the integrator
	* If QESTNET hasn't been previously installed, a copy of the msi installer for the version of QESTNET required.		* If QESTNET hasn't been previously installed, a copy of the msi installer for the version of QESTNET required.

Nathan.bennett: /* Preparing Installation Files */

2015-10-11T23:01:02Z

Preparing Installation Files

←Older revision		Revision as of 23:01, 11 October 2015
Line 12:		Line 12:
	== Preparing Installation Files ==		== Preparing Installation Files ==
	QESTNET Installation Files are located at '''\\ADLS0003\Development\Product Distribution\QESTNET'''.		QESTNET Installation Files are located at '''\\ADLS0003\Development\Product Distribution\QESTNET'''.
	If one doesn't exist, create a subdirectory for the customer's code (eg. "USPEC"). Within that, create another subdirectory for the specific QESTNET version (eg. "QESTNET ~~v4_1_3_1~~").		If one doesn't exist, create a subdirectory for the customer's code (eg. "USPEC"). Within that, create another subdirectory for the specific QESTNET version (eg. "QESTNET v4.1.3.1").
	The following files should be placed in this folder:		The following files should be placed in this folder:
	* The Custom project's dll file		* The Custom project's dll file

Nathan.bennett: /* Building the Integration Project Assembly */

2015-10-09T00:34:11Z

Building the Integration Project Assembly

←Older revision		Revision as of 00:34, 9 October 2015
Line 1:		Line 1:
	== Building the Integration Project Assembly ==		== Building the Integration Project Assembly ==
	To create an assembly file for your custom integrator project:		To create an assembly file for your custom integrator project:
			# Check that your project has the correct post-build event
			#* Right click your project in the Solution Explorer and select 'Properties'
			#* Go to the "Build Events" section and enter the following under "Post-build event command line"<br><br>'''mkdir "$(ProjectDir)..\..\bin\$(ConfigurationName)"<br>xcopy "$(TargetDir)$(TargetName).*" "$(ProjectDir)..\..\bin\$(ConfigurationName)" /R /Q /Y'''<br><br>
	# Within your integrator project, change the following in ''Properties\AssemblyInfo.cs''		# Within your integrator project, change the following in ''Properties\AssemblyInfo.cs''
	#*Update ''AssemblyTitle''/''AssemblyProduct'' with the project's name		#*Update ''AssemblyTitle''/''AssemblyProduct'' with the project's name
Line 6:		Line 9:
	# Change the build configuration in Visual Studio from "Debug" to "Release".		# Change the build configuration in Visual Studio from "Debug" to "Release".
	# Build your project as normal. This will place the QESTNET.Custom.XXX.dll file in the folder QESTNET/bin/Release		# Build your project as normal. This will place the QESTNET.Custom.XXX.dll file in the folder QESTNET/bin/Release


	== Preparing Installation Files ==		== Preparing Installation Files ==

Nathan.bennett: /* Installing the Integrator */

2015-10-08T22:49:51Z

Installing the Integrator

←Older revision		Revision as of 22:49, 8 October 2015
Line 25:		Line 25:
	== Installing the Integrator ==		== Installing the Integrator ==
	If QESTNET has not been installed on the customer's system...		If QESTNET has not been installed on the customer's system...
	:#First check that the system's Windows bit-version matches the bit-version of the installer (if not, another installer will ~~have~~ to be built).		:#First check that the system's Windows bit-version matches the bit-version of the installer (if not, another installer will need to be built).
	:#Follow the installation process in the QESTNET 4.1 Installation Guide at [[QESTNET_Internal:Developer_Home\|QESTNET Developer Home]] up to Step 10, using the msi installer and QESTNET.exe.config file provided in the folder above. This will involve changing the connection strings and path strings in the config file.		:#Follow the installation process in the QESTNET 4.1 Installation Guide at [[QESTNET_Internal:Developer_Home\|QESTNET Developer Home]] up to Step 10, using the msi installer and QESTNET.exe.config file provided in the folder above. This will involve changing the connection strings and path strings in the config file.
	:#Copy the provided dll files into the root QESTNET installation directory (the same directory as QESTNET.exe). A previous version of these dll files may need to be replaced.		:#Copy the provided dll files into the root QESTNET installation directory (the same directory as QESTNET.exe). A previous version of these dll files may need to be replaced.

Nathan.bennett: /* Preparing Installation Files */

2015-10-08T07:23:24Z

Preparing Installation Files

←Older revision		Revision as of 07:23, 8 October 2015
Line 15:		Line 15:
	* Any other dll files which require changes from the last build		* Any other dll files which require changes from the last build
	* A QESTNET.exe.config file (see below)		* A QESTNET.exe.config file (see below)
	* Any SQL scripts required ~~to install~~ the integrator		* Any SQL scripts required for the integrator
	* If QESTNET hasn't been previously installed, a copy of the msi installer for the version of QESTNET required.		* If QESTNET hasn't been previously installed, a copy of the msi installer for the version of QESTNET required.

Nathan.bennett: Added page

2015-10-08T07:22:02Z

Added page

New page

== Building the Integration Project Assembly ==
To create an assembly file for your custom integrator project:
# Within your integrator project, change the following in ''Properties\AssemblyInfo.cs''
#*Update ''AssemblyTitle''/''AssemblyProduct'' with the project's name
#*Update ''AssemblyFileVersion''<br>The format of this number is:<br>''[Major Version #].[Minor Version #].[Build #].[Revision #]'' (eg. 4.1.3.1)<br>The Major/Minor/Build numbers should match the version of QESTNET the integrator has been written for. The Revision number should start at 0, and be incremented each time a minor revision is required (eg. a bug fix).
# Change the build configuration in Visual Studio from "Debug" to "Release".
# Build your project as normal. This will place the QESTNET.Custom.XXX.dll file in the folder QESTNET/bin/Release

== Preparing Installation Files ==
QESTNET Installation Files are located at '''\\ADLS0003\Development\Product Distribution\QESTNET'''.
If one doesn't exist, create a subdirectory for the customer's code (eg. "USPEC"). Within that, create another subdirectory for the specific QESTNET version (eg. "QESTNET v4_1_3_1").
The following files should be placed in this folder:
* The Custom project's dll file
* Any other dll files which require changes from the last build
* A QESTNET.exe.config file (see below)
* Any SQL scripts required to install the integrator
* If QESTNET hasn't been previously installed, a copy of the msi installer for the version of QESTNET required.

If previous versions of these files exist in this folder, '''do not overwrite them'''. Rename the previous version to add its last modified date / version number and move it to an archive folder before copying the new version in.

=== QESTNET.exe.config ===
This can be created by copying the app.config file from the QESTNET.Service/QESTNET project and removing all unrequired elements (eg. Fugro Data Backbone / Hive settings, debug settings, unrelated connection strings). Clearly indicate settings which will need to be changed for the customer's system (connection strings, log file paths, etc.).

== Installing the Integrator ==
If QESTNET has not been installed on the customer's system...
:#First check that the system's Windows bit-version matches the bit-version of the installer (if not, another installer will have to be built).
:#Follow the installation process in the QESTNET 4.1 Installation Guide at [[QESTNET_Internal:Developer_Home|QESTNET Developer Home]] up to Step 10, using the msi installer and QESTNET.exe.config file provided in the folder above. This will involve changing the connection strings and path strings in the config file.
:#Copy the provided dll files into the root QESTNET installation directory (the same directory as QESTNET.exe). A previous version of these dll files may need to be replaced.
:#Resume the installation guide from Step 10.

If QESTNET has already been installed, or the integrator needs to be updated...
:#Stop the QESTNET service
:#Copy the provided dll files into the root QESTNET installation directory (the same directory as QESTNET.exe), replacing previous versions.
:#Change the QESTNET.exe.config file (if required)
:#Restart the QESTNET service