Skip to content

Managing Optima

The Optima installer's Manage page looks after the Gateway and Node installed on this machine. You can use it to start and stop them, see and change their access keys, let them through the firewall, and collect their logs for Parker Software support.

Manage works on the machine it is run on. To manage a Node on another machine, run the installer there.

Info

On a Linux server without a desktop, the same things can be done from the command line. See Headless Installation.

Opening Manage

Run the Optima installer and click Manage. The button is available when the Gateway, a Node or both are installed on this machine.

The installer needs administrator rights. On Windows and Linux it asks when it opens. On macOS it will ask for your password each time you make a change, such as stopping a service or changing a key.

The Component Cards

Each installed component has a card.

Item What it shows
Status Running, Stopped, Starting or Stopping, and the version installed. Service not registered means the program files are there but no service is — run the installer's Install again after uninstalling
Start, Stop, Restart Control the service. See Starting And Stopping
Address Where other machines reach the component. The Gateway's address has Open, which opens it in your browser
ACCESS KEY The component's access key. See Access Keys
FIREWALL Whether other machines can reach the component. See Firewall
Open logs, Open data folder Open the folders in your file manager. See Logs And Data

Only one change can run at a time. While one is running, the other buttons will be unavailable, and the card will show its progress underneath.

Starting And Stopping

Click Stop to stop a component, Start to start it again, or Restart to do both.

After starting, the installer will check that the service is still running a few seconds later. If it is not — for example, because another program is using its port — the card will say so, and where to find the details.

Note

Stopping the Gateway disconnects everyone using Optima. Stopping a Node stops the models running on it, and any request they are answering. A stopped service will start again when the machine restarts.

Access Keys

An access key is the shared secret a Gateway presents when it connects to a Node. A Node only accepts a Gateway that uses the same key as the Node.

A Gateway has one key, and uses it for every Node it connects to. A Gateway and a Node installed on the same machine use the same key automatically. A Node on another machine needs to be given the Gateway's key.

Seeing A Key

On the component's card, under ACCESS KEY, click Show to see the key, or Copy to copy it.

If the card says Created when the node first starts (or the gateway), the component has not started yet. Start it, and the key will appear.

Changing A Key

  1. On the card, under ACCESS KEY, click Change…. The Change the access key window will open.
  2. Paste the key you want to use, or click Generate to create a new one.
  3. When the Gateway and a Node are both installed on this machine, tick Also use it for the … on this machine to change both together. It is ticked by default.
  4. Click Apply.

The installer will stop the component, save the new key, and start it again. The window explains, before you apply, what the change will disconnect:

You change What happens
The Gateway's key Every Node will disconnect from this Gateway until it is given the same key
A Node's key The Node will only accept a Gateway that uses the new key
Both, on one machine The Gateway and its local Node stay connected. Nodes on other machines disconnect until they are given the key

A key cannot contain spaces, ^ or |, and can be up to 256 characters long.

For example, to give every Node a new key:

  1. On the Gateway machine, click Change… on the Gateway's card, click Generate, and click Apply. Click Copy to copy the new key.
  2. On each other Node machine, open Manage, click Change… on the Node's card, paste the key, and click Apply.

Warning

A Node's key can also be set by an environment variable on its service, such as OPTIMA_NODE_ACCESSKEY. That variable takes priority over the key saved by the installer. When one is set, the Node's card will say so, and a change made here will not take effect on the Node until the variable is removed.

Firewall

The FIREWALL row shows whether other machines on your network can reach the component.

Status Meaning
✓ Allowed Other machines can reach it. The row names the rule that allows it
✓ Firewall is off No firewall is filtering incoming connections on this machine
⚠ Not allowed A firewall is on, and nothing lets the component through. Click Allow
⚠ Not managed A firewall is active that the installer does not change. The row says which ports to open in it

Clicking Allow does the same as ticking Allow Optima through the firewall when installing. See Firewall for what it changes on each platform.

Windows Public Networks

The installer's Windows rules apply on Domain and Private networks only. When a component is not allowed on Public networks, the card will show a warning, and an Also allow on Public networks button.

If the warning says this machine is connected to a Public network, other machines on that network cannot reach the component. You can click Also allow on Public networks, or set the network to Private in Windows Settings, under Network & internet.

Warning

Public networks are the ones Windows treats as least trusted, such as public Wi-Fi. Allow Optima on them only if this machine's network is set to Public by mistake, or you have another way to limit who can reach it.

When You Must Change It Yourself

The card will tell you what to do when the installer cannot make the change:

  • On macOS, when Block all incoming connections is turned on. Turn it off in System Settings → Network → Firewall → Options…, then allow the program there.
  • On Linux, when the firewall is not ufw or firewalld. Open the TCP port shown, and UDP 5353 for Node discovery.

Note

On Linux, the installer's rule is for the Gateway's port. If you change the Gateway's port, restart the Gateway, then click Allow again. On Windows and macOS the rule is for the program, so a new port needs nothing.

Logs And Data

Click Open logs to open the component's log folder, or Open data folder to open the folder that holds its settings and data. See Log Files for where they are on each platform.

Collecting Logs For Support

If Parker Software support asks for your logs, you can collect everything they need into one zip file.

  1. Click Collect logs for support… at the bottom of the Manage page. A window will list what the file will contain.
  2. Click Create. The zip file will be saved to your Desktop.
  3. Click Show in folder to find it, and send it to support.

The zip file contains:

  • the Gateway, Node and installer logs from the last 30 days
  • the services' recent messages from the operating system
  • which versions are installed, whether they are running, their ports and their firewall status

It never contains settings files or access keys. Logs can mention machine names, IP addresses and model names, so look through the file first if that matters to you.