Skip to content

# Server state

The Server state form is used to control the availability of the AyaNova server.

## Authorization Roles required

Many roles can select this object on other records where approriate. Editing or viewing this object in detail is only available to Users with the following roles:

Full access

- System operations

Read only access

- all users will be shown the server state and "reason" text if they attempt to use AyaNova when it's in a closed state

## How to access server state

Server state form is accessed in the following ways:

- From the `Server operations` navigation drawer `Server state` item to open this form

## How Server state works

Server state controls whether the server is generally accessible to Users or not. The SuperUser account can always log in to the AyaNova server regardless of the state.

The server itself will also control state, for example, during an automated backup the server will lock out general Users for the duration of the backup process.

### Server re-starts and state

Server state does not survive a re-start of the AyaNova server. When booted the server will automatically go to an open state whenever possible.

### States

Internally the server has 5 possible states:

#### Unknown

The server is in an undertermined state, usually a brief time during boot up.

#### Closed

No access to any users, the server API is completely locked down. Set by the server itself internally only. Users can't set this state. Typically you will see this when a backup operation is in progress. Once the condition is resolved at the server it will return to whatever previous state was set. Locked out users will be able to continue working the moment the server reverts to an open state.

#### Migrate mode

Access only for the SuperUser account for the purposes of migration from older versions of AyaNova. This puts the server in a special state to facilitate migrating data to the AyaNova server without allowing other changes that might affect migration operations. Do not use this state unless directed to do so by migration procedures.

If a migration is in progress and this state is changed it will break the migration process.

#### Operations only

Access only for Users with a Operations role. Can be set by a Server operations role user in this form.

This is what you want to set when server maintenance needs to be done and you don't want Users affecting data while you are working.

Logged in users will receive an error similar to a validation error indicating the server is closed and displaying the "Reason" message if any when they attempt to make any requests to the AyaNova server. Users who are locked out do not need to close their AyaNova web app; once the server is set back to an open state they can continue working as normal, save any pending changes etc.

Not logged in users will not be able to login unless they are the SuperUser or have a System operations role. Instead they will receive an error on the login page that the server is closed and also the "Reason" message if any will display.

#### Open

This is the default server state, open to all users. Can be set by a Server operations role user in this form.

### Changing server state

Select the desired state optionally enter a "Reason" message and click the Save menu item. The reason message will display to the Users who are locked out.

## Shutting down the AyaNova server

(Note: this option is not available if AyaNova is hosted as a subscription service)

This form has a menu option `Shut down server` to gracefully stop and shut down the AyaNova server software. This is the preferred way to stop an AyaNova server as pending jobs and notifications will be processed before closing down in a controlled manner.

The alternative is to press ctrl-c at the server console however that type of shutdown is immediate and uncontrolled and not recommended in production use.

Warning: The server can not be started remotely via the web app, only shut down.