User Tools

Site Tools


code:common:deployment-structure

16 Deployment Structure

This page uses the following examples/placeholders:

  • <myApp>: Name of the application, eg “TEMPLATE”
  • <Company>: Name of company as used in the file system (ie folder names), eg “HSE”
  • <repoRoot>: Path of the repository root.

Build Specs

Names

  • SRC – Source distributions
  • PPL – Packed project libraries
  • EXE – Executables
  • INST – Installers
  • NIPKG – NI Packages
  • RTEXE – Real-time applications

Destination

Ensure all builds go into /builds/<%build-spec-name%>, eg

  <repoRoot>/builds/EXE/<myApp>.exe

Execution in Repository

The default location for a built .exe is in parallel to the source code, so both can access the configuration of the project.

For the Windows Template Application project, the folder structure looks as follows:

  /TEMPLATE/
      TEMPLATE.exe
  /TEMPLATE_Config/
      Unit_MyUnit
      config.ini
  /TEMPLATE_Source/
      TEMPLATE.lvproj

From Source Code

When running from the repository/IDE, the application will automatically use <repoRoot>/<myApp>_Config.

Built Exe

When the EXE is built manually & locally, copy your built application into <repoRoot>/<myApp>/. This way it will automatically use <repoRoot>/<myApp>_Config.


Installation

Application

Install EXE to

  <%ProgramFiles%>/<Company>/<myApp>/

Config and Data

Install the configuration folder to

  <%ProgramData%>/<Company>/<myApp>/<myApp>_Config''

Install the data folder to

  <%ProgramData%>/<Company>/<myApp>/<myApp>_Data''

Make sure to give correct user access rights to the folders in <%ProgramData%>.

User-specified locations

If <myApp>.ini is present next to the <myApp>.exe file, the folders configured there will be used.


Real-Time Systems

Relative paths are not supported on Real-Time systems by our HSE Core Libraries. That is why we resort to a static structure. See Core Libraries: hse-application - Real-Time Systems for more details.

Example

For an application named LoggerTest, the following files and locations are the default:

code/common/deployment-structure.txt · Last modified: 2026/09/01 08:43 by joerg.hampel