Booster Setup Guide

What Is Booster?

Booster is a local compute node for HiStruct development workflows.

It connects to deve.histruct.com via SignalR, registers as a worker for your account, pulls rendering and computation jobs from Azure queue infrastructure, evaluates FCS workloads locally, and sends results back to the server.

In practice, Booster lets your machine act as an execution worker for HiStruct jobs such as scene generation, report generation, and parameter validation.

Practical tip: Booster is especially useful when onboarding because it lets you see how cloud-triggered work is actually executed on a local machine you control.

How Booster Fits into the Flow

At a high level, the flow looks like this:

1. you sign in with your HiStruct account
2. Booster connects to https://deve.histruct.com/
3. it registers as an available worker for your account
4. jobs are assigned from the backend queue
5. Booster runs the required FCS/WebJobs logic locally
6. results are returned to the server

This makes it possible to develop and debug compute-heavy tasks without deploying your own separate execution stack.

Installation

1. Get the zip package

Retrieve the build from:

Q:\Builds\Booster\Booster_r{version}.zip

Replace {version} with the revision/build number you were given.

2. Extract the package

Extract it to:

C:\HiStruct\AgentsBooster\

You can use another folder if needed, but the examples in this guide assume that path.

3. Know the key executables

The extracted folder includes these important binaries:

• fli.exe — FCS Language Interpreter (CLI)
• FCS.HiStruct.Booster.exe — the compute node daemon
• FCS.HiStruct.WebJobs2.exe — the WebJobs engine

Gotcha: the executable name is FCS.HiStruct.Booster.exe, not HiStruct.Booster.exe.

Recommended Folder Layout

A typical local setup may look like this:

C:\HiStruct\AgentsBooster\
├── FCS.HiStruct.Booster.exe
├── FCS.HiStruct.WebJobs2.exe
├── fli.exe
├── appsettings.booster.json
└── ...other support files...

Keep the extracted files together unless you have a specific reason to reorganize them.

Configuration (appsettings.booster.json)

Create or edit appsettings.booster.json in the Booster folder.

{
  "Booster": {
    "UserLogin": "your.email@example.com",
    "HiStructServerUrl": "https://deve.histruct.com/"
  },
  "fcs": {
    "LocalComponentsFolder": "D:\\GitHub\\"
  }
}

Configuration Fields Explained

Booster.UserLogin

This must match the email address of your HiStruct account.

"UserLogin": "your.email@example.com"

If this does not match your actual account, the worker registration flow may not behave as expected.

Booster.HiStructServerUrl

Set the target server URL.

"HiStructServerUrl": "https://deve.histruct.com/"

For onboarding, deve.histruct.com is the environment described here.

fcs.LocalComponentsFolder

This points to the root folder where .fcc component folders are resolved.

"LocalComponentsFolder": "D:\\GitHub\\"

Resolution behavior

A DirPath like:

fcs-lab-01

resolves to:

D:\GitHub\fcs-lab-01\

That means local component repositories should exist under the configured root if Booster is expected to resolve them correctly.

Practical tip: if Booster cannot find a component, verify LocalComponentsFolder first before assuming the job definition is wrong.

Running Booster

Open a terminal and start Booster from the extracted folder:

cd C:\HiStruct\AgentsBooster
.\FCS.HiStruct.Booster.exe

What to expect

• Booster stays alive as a daemon
• it processes incoming jobs continuously
• it can serve multiple tasks over time without restarting
• file changes are detected automatically
• caches are invalidated when relevant files change

Auto-refresh behavior

Booster auto-detects file changes and invalidates cache, so you usually do not need to restart it after editing local FCS/component files.

Practical tip: if a result looks stale, first confirm the file really changed where Booster expects it. Restarting is usually a last resort, not the first step.

Local Profiler

Booster exposes a local profiler at:

http://localhost:8866/profiler

Use this page to inspect runtime activity, job behavior, or performance characteristics during local processing.

Available WebJob Functions

The WebJobs engine can execute several important functions:

• GenerateHiSceneIsolated — 3D scene generation
• GenerateHtmlReportIsolated / GeneratePdfReportIsolated — report generation
• GenerateValidatedParametersIsolated — parameter validation
• GenerateDefinedOutputIsolated — generic output generation
• CallRegisteredWebHooks — webhook triggers

What These Functions Are For

GenerateHiSceneIsolated

Generates a HiScene/3D scene representation from the model.

GenerateHtmlReportIsolated / GeneratePdfReportIsolated

Builds report outputs for presentation or export.

GenerateValidatedParametersIsolated

Validates model parameters and returns checked/processed parameter data.

GenerateDefinedOutputIsolated

Produces a generic requested output when a job specifies a named output target.

CallRegisteredWebHooks

Triggers webhook callbacks after job execution or related events.

First-Run Checklist

Use this checklist when setting up a machine for the first time:

1. extract Booster to a local folder
2. verify FCS.HiStruct.Booster.exe exists
3. edit appsettings.booster.json
4. set UserLogin to your HiStruct account email
5. set HiStructServerUrl to https://deve.histruct.com/
6. set LocalComponentsFolder to your local component root
7. confirm expected repositories/components exist under that root
8. start Booster
9. open http://localhost:8866/profiler
10. verify the daemon remains running and begins handling jobs

Troubleshooting Tips

Booster starts but no jobs appear

Check:

• UserLogin matches your real HiStruct account email
• HiStructServerUrl is correct
• your machine has network access to deve.histruct.com
• the process is still running and did not exit early

Component resolution fails

Check:

• LocalComponentsFolder is correct
• required .fcc or component directories exist locally
• the expected DirPath really maps beneath the configured folder

Results appear stale

Check:

• whether the edited files are the same files Booster is using
• profiler output for recent activity
• local path mappings and component roots

Remember: Booster usually auto-detects changes and invalidates cache, so a stale result often points to a path/config mismatch.

Practical Workflow for Onboarding

A simple daily workflow looks like this:

1. pull or update the required local component repositories
2. confirm LocalComponentsFolder points at the parent directory
3. start Booster
4. keep the profiler open in a browser tab
5. trigger jobs from HiStruct/development tools
6. inspect outputs and local behavior
7. edit local files and let Booster pick up changes automatically

Quick Reference

Zip source:
Q:\Builds\Booster\Booster_r{version}.zip

Recommended install folder:
C:\HiStruct\AgentsBooster\

Main executable:
FCS.HiStruct.Booster.exe

Profiler:
http://localhost:8866/profiler

Server:
https://deve.histruct.com/

Final Takeaway

Booster is your local execution bridge into HiStruct's job-processing pipeline. Configure the account email correctly, point LocalComponentsFolder at the right source root, start FCS.HiStruct.Booster.exe, and use the profiler to verify local processing behavior.