Integrations are managed from the Atomscale desktop app. The
local Integrations page is desktop-only. In the browser, use Gateways to inspect
workstations and manage supported integration actions remotely. See
Manage Gateways Remotely.
How Integrations Work
An integration collects data from a local source, such as a watched folder or an instrument, and hands it to the desktop app. The app buffers the data on disk, then uploads it to Atomscale over HTTPS using your signed-in session.- No machine credentials: Integrations never hold API keys and never connect to Atomscale themselves. All uploads go through the desktop app, authenticated as the signed-in user.
- Durable buffering: Data waits on disk through network outages and app restarts, subject to disk-space and retention limits. Check the upload queue if a backlog grows; buffering is not unlimited.
- Sign-out safe: If you sign out, integrations keep collecting data locally and uploads pause. Uploading resumes automatically when you sign back in.
Adding an Integration
1
Open the Integrations page
Select Integrations in the desktop app sidebar.
2
Open the catalog
Click Add Integration. A dialog lists the integrations
available to your workspace.
3
Add an integration
Click Add on the integration you want. The app downloads
the connector and verifies its checksum before installing it.
4
Configure it
When installation completes, you are taken to the integration’s configuration page.
Adding an integration only downloads it. It does not upload anything until you configure and
start it.
Configuring an Integration
Open an integration from the Integrations table, then click Configure. A running integration must be stopped before its configuration can be changed. The form shows the settings most installations need, such as paths, device identifiers, and grouping options. The available fields depend on the integration. Optional tuning settings are hidden by default. Turn on the Show advanced settings switch at the top of the form to reveal them. Every integration includes these advanced settings:- Upload Backlog Size Limit: Caps how much unsent data is buffered on disk. Leave it blank to size the buffer automatically based on free disk space.
- Free Disk Space To Keep: The amount of disk space the buffer will never consume.
Applying a configuration saves it but does not start the integration. Start it explicitly when
you are ready to collect data.
Starting and Stopping
Use the Start Integration and Stop Integration buttons on the integration’s detail page. The desktop app remembers this choice: integrations you started are launched automatically the next time the app opens, and integrations you stopped stay stopped. If an integration crashes, the app restarts it automatically with an increasing delay. An integration that crashes repeatedly in a short window is quarantined, meaning the app stops restarting it. After fixing the underlying problem, press Resume Integration to clear the quarantine. Restarting the desktop app also clears it.Monitoring
The Integrations table shows each installed integration with its name, type, version, and current status. You can search by name and filter by type. Click a row to open the detail page, which includes:- Details: The connector, its description, type, and installed version.
- Health: Current status, last successful upload, and running time.
- Upload Queue: The state of pending data uploads for this integration.
- Activity Logs: A searchable history of events, filterable by severity, with an option to open the log files on disk.
Status Reference
Updating an Integration
The desktop app checks for new integration versions at launch and every 5 minutes afterward. You can also check on demand with the refresh control next to the search box. With Automatic updates turned on (the default), the app installs integration updates by itself:- It waits until the integration has collected no data for at least 15 minutes, then counts down 5 minutes before installing. If the integration starts collecting data again, the countdown is canceled until the next idle period.
- While you are viewing the integration, a dialog shows the countdown with Update now and Delay 1 hour buttons.
- If your installed version is Revoked and a newer version is available, the countdown starts right away and the update installs even if the integration is collecting data.
- If the integration is running, the update briefly suspends uploading while the new version is installed, then the integration restarts automatically. Buffered data is preserved.
- Releases marked as a Breaking change may migrate your saved configuration to a new format. The migration happens automatically during the update.
- If an update fails, the previous version is restored automatically and a notice explains what went wrong.
Uninstalling an Integration
Stop the integration, then open its configuration page and turn on Show advanced settings. The Danger zone section appears at the bottom of the form. Click Uninstall integration and confirm. Uninstalling removes the integration’s local program and configuration. You can reinstall it at any time.Upload Settings
Upload bandwidth and the number of simultaneous file uploads are controlled per computer, not per integration, under Data Ingestion in your account settings. Changes apply immediately to all active integrations. Timeseries data is prioritized over file uploads so that live monitoring stays responsive.Finding Collected Data
Open Data Catalog to find recordings and measurements. Items without a physical sample are hidden by default; turn on Show … items without a physical sample in the catalog footer to include them. Check the item’s pipeline status to distinguish upload completion from available analysis results. To associate RHEED and tool logs from one instrument, open the workstation on the web app’s Gateways page and set the Growth Instrument of both integrations to the same instrument. New data items use that association; changing it later does not update existing items. RHEED streams create growth samples for Monitor. Tool logs can join matching growths, but a tool log without a matching growth can remain without a sample. Set an existing item’s Physical Sample manually if it belongs to a growth. Manual sample assignments take precedence over automatic grouping. For detailed grouping and clock behavior, open Finding Your Data in the desktop app’s Gateway Guide. Once the intended data is available, use Analyze to investigate it in a notebook.Manage gateways remotely
A gateway is a workstation running the Atomscale desktop app. The browser’s Gateways page lets Owner, Admin, and Member accounts in the owning organization inspect it and send supported commands while it is online. The desktop app’s Integrations page manages collection locally.Open a gateway
1
Open Gateways
In the web app, select Data, then Gateways in the sidebar. Find the workstation by gateway or computer name. Check Status, App version, and Last seen.
2
Open the workstation
Click its row to see details, settings, remote command activity, and its integrations. Offline can mean the app is closed, no one from the owning organization is signed in, or the gateway cannot reach Atomscale. It may still be collecting locally.
3
Inspect an integration
Open an integration to inspect its reported state or send a start, stop, configuration, or update command. Supported settings depend on the gateway’s app version; update it if the page says a newer version is required.
Associate collection with an instrument
On the gateway’s page, set Growth Instrument in the Integrations table. Give RHEED and tool-log integrations the same instrument when their data belongs to the same growth system. This association can be changed while the gateway is offline, but changes apply to newly created data items, not existing ones. See Finding Collected Data for locating recordings and sample associations.Send and check commands
Use Sync State to request a fresh report. Other actions include checking for updates, changing supported settings, and managing integrations. Stop an integration before changing its configuration, then click Apply Configuration. A configuration request may await approval from someone with that configuration page open on the workstation. Inspect the Remote Command Activity Log to see whether a request completed, failed, was rejected, expired, or rolled back. Sending a request is not proof that it was applied. Refresh settings before retrying a request that reports Settings changed.Tasks that require the workstation
Use the desktop app for Activity Logs, Upload Queue, local folder browsing, integration admin access, and operating-system approval prompts. Remote command activity is different from the integration’s local activity logs. For full command statuses, approval behavior, and source-specific troubleshooting, open Documentation in the desktop app and select Remote Management in the bundled Gateway Guide. See Desktop App for installation and background-operation behavior.Technical Details
This section summarizes networking and security behavior for IT teams evaluating integrations for deployment.- Outbound HTTPS to Atomscale: All communication with Atomscale uses TLS on port 443. See Security for the main destinations.
- Inbound rules for live RHEED capture: On Windows, when the RHEED Camera (GenTL) integration starts with the Standard (GenTL) or Network (GVSP Tap) frame source, the app asks for administrator approval (once per installed copy) to add an inbound Windows Firewall rule. The rule allows UDP traffic from the local subnet to that integration’s program only, so the camera’s network stream can reach it. If approval is declined, the integration still starts and logs a warning. Turning on Integration admin access (see Desktop App settings) adds further program-scoped inbound rules as part of its setup. Other integrations do not accept inbound traffic, and the desktop app accepts connections from other computers only in Connection Sharing Hub mode.
- Downloads are verified: Integration programs are downloaded from Atomscale over HTTPS and verified against a SHA-256 checksum before installation.
- Process isolation: Each integration runs as a separate local process. An integration may receive data from instruments on your local network (for example, RHEED Camera (GenTL) receives the camera’s stream), but it never connects to Atomscale. It hands its data to the desktop app, which uploads it.
- Authentication: Uploads are authenticated with short-lived tokens tied to the signed-in user. To keep you signed in across restarts, the app stores your sign-in session on disk, encrypted with Windows DPAPI. It also creates a random device secret for each installation, stored under
%APPDATA%\Atomscale\gateway\, which identifies the computer to Atomscale. Integrations hold no credentials. - Local storage: Configuration, logs, and buffered data live under the desktop app’s application data directory. Buffered data is kept until it uploads successfully, up to a 30-day limit.
- Local logs: Integration activity logs are written as daily files under the desktop app’s application data directory, at
%APPDATA%\Atomscale\gateway\logs\. You can also open this folder directly from an integration’s Activity Logs section.