Jump to content

QESTNET Internal:Building and Installing an Integration Project: Difference between revisions

From QESTonline
Nathan.bennett (talk | contribs)
Added page
 
John.meegan (talk | contribs)
No edit summary
 
(4 intermediate revisions by one other user not shown)
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 ==
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
* 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
* 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
* 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.


Line 25: Line 28:
== 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.

Latest revision as of 03:53, 15 October 2015

Building the Integration Project Assembly

To create an assembly file for your custom integrator project:

  1. 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"

      mkdir "$(ProjectDir)..\..\bin\$(ConfigurationName)"
      xcopy "$(TargetDir)$(TargetName).*" "$(ProjectDir)..\..\bin\$(ConfigurationName)" /R /Q /Y


  2. Within your integrator project, change the following in Properties\AssemblyInfo.cs
    • Update AssemblyTitle/AssemblyProduct with the project's name
    • Update AssemblyFileVersion
      The format of this number is:
      [Major Version #].[Minor Version #].[Build #].[Revision #] (eg. 4.1.3.1)
      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).
  3. Change the build configuration in Visual Studio from "Debug" to "Release".
  4. 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)
  • 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
  • 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...

  1. 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).
  2. Follow the installation process in the QESTNET 4.1 Installation Guide at 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.
  3. 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.
  4. Resume the installation guide from Step 10.

If QESTNET has already been installed, or the integrator needs to be updated...

  1. Stop the QESTNET service
  2. Copy the provided dll files into the root QESTNET installation directory (the same directory as QESTNET.exe), replacing previous versions.
  3. Change the QESTNET.exe.config file (if required)
  4. Restart the QESTNET service