Skip to main content

App asset reference

An App is an independent Theseus project and delivery unit. Normally, manage it through Resources, Settings, and AI. File names matter mainly during Git review, import/export, or troubleshooting.

When to use this page​

  • You need to know whether a setting travels with an App export or Git commit.
  • A Git diff contains an App file you do not recognize.
  • Pages, Objects, Graphs, users, or module settings are incomplete after import.
  • You need to distinguish a source App, runtime package, runtime state, and Runtime target settings.

What an App contains​

User-facing resourceAsset visible during troubleshooting or Git review
App name, home page, and module switchesmanifest.json
Page**/*.qxpage
Component**/*.qxcomponent
Graph**/*.qxgraph
Object treeobjects.json
App and Saved Variable definitionsvariables.json
Recipes, HTTP Queries, and runtime translationsrecipes.json, queries.json, and i18n.json
App users and rolesusers.json
Custom Objects, methods, and data types**/*.cs, conventionally under scripts/ for new files
Images, models, and other assetsassets/**
Pulsar, axes, I/O, and engineering interlockspulsar.json
Vision cameras, inspections, and sample referencesvision/project.json and vision/inspections/**
PLC projectplc/plc.qxplc, plc/pous/**, and plc/io-map.json

Folder names are creation conventions. Pages, Components, Graphs, and C# Scripts may live in managed paths within the App. Prefer Resources for creation, moves, and renames so that reference checks and diagnostics stay synchronized.

What travels together?​

ContentGit / source ZIPRuntime packageRuntime target / local state
Pages, Graphs, Objects, settings, and AssetsYesOnly the runtime-ready versionNo
App users and rolesYesYesSign-in sessions do not travel
Build artifactsDo not maintain as sourceYesThe target loads the deployed version
Current Saved Variable valuesNoNoState of that App on that target
Console output, fault records, and Vision run detailNoNoRuntime state
Runtime target accounts, License, and endpointNoNoState of each target
Editor tab layout and local preferencesNoNoState of the current desktop user
AI session historyOutside the App workspaceNoStored by the desktop and separated by App

A source ZIP is for design backup and migration. It does not contain Git history or current runtime state. A runtime package is for deployment and execution; it is not a replacement for a source-App backup.

Key rules​

  • Set a home page so that runtime pages and Player have a stable default entry point.
  • A .qxcomponent is an independent App-level Component, not content embedded inside a Page.
  • A Query is an App-level HTTP call contract. Do not duplicate request configuration across Pages.
  • variables.json contains Variable definitions and initial values, not the current runtime value of a Saved Variable.
  • App users travel with the App. Editor Qixin and Runtime target accounts do not.
  • Machine settings such as a Runtime target or Vision Engine endpoint do not belong to the App. Reconnect and verify them after moving to another machine.
  • Build generates outputs for Graphs, C# Scripts, and PLC. Do not treat generated outputs as the only source.
  • Do not store passwords or API keys in Pages, Graphs, ordinary conversations, or Git. Follow the approved credential process for the project and review Query authentication before export.

How to validate an App​

  1. Open the App from App Hub. If schema validation fails, use the reported asset to start the repair.
  2. In Resources, confirm that Pages, Objects, Graphs, Scripts, and enabled modules are present.
  3. In Settings, confirm the home page, Variables, Recipes, Queries, i18n, and App users.
  4. Open Problems and fix issues that block save or Build.
  5. Run Build after Graph, Script, or PLC changes.
  6. Select the correct Runtime target, Run or Debug, and accept the result from a runtime page.
  7. When delivering source, use Git or a source ZIP to verify that the App can be restored.