Child pages
  • Maintenance Mode

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Advanced Features Related to Solution Import from Servoy Admin Page

Maintenance Mode

Maintenance mode is a special mode of operating Servoy Server. While Servoy Server is in maintenance mode, no new cliets can connect to it. This is useful when performing certain administrative tasks, like solution imports.

In order to put Servoy Server into maintenance mode, you need to access the Servoy Server Admin Page. There you will find a button which says "Enter Maintenance Mode". If you push that button you will be asked to confirm that you really want to put Servoy Server into maintenance mode. If you confirm, then the Server will enter maintenance mode.

While in maintenance mode, the above mentioned button will have its text changed to "Exit Maintenance Mode". If you push the button, you will be again asked for confirmation. If you confirm the action, then the Server will be brought out of maintenance mode.

You can put the Server into maintenance mode, or bring it out of maintenance mode programatically, using the maintenance plugin. Please refer to the maintenance plugin API documentation for details about how to do that.

Solution Import Hooks

During solution import from the Servoy Admin Page, modules with certain name patterns are handled in a special way. Modules whose names start with "before_import" are handled as pre-import hooks. Their onOpen event handlers are executed before the solution is actually imported. Similarly, modules whose names start with "after_import" are handled as post-import hooks. Their onOpen event handles are executed after the solution is actually imported.

...

These operations can be performed through the maintenance plugin, which is available since version 4.2 of Servoy. Since the The maintenance plugin was designed specifically for being used with solution import hooks, please . Please consult the its API documentation for more specific details . There you will also find several examples of solution import hooksabout available functions.

A typical scenario of using the solution import hooks is the following:

  • Before importing the solution, connected clients are notified that an import will take place, then they are disconnected and then the server is put into maintenance mode, so that no new clients can connect during the import.
  • The import is performed as usually.
  • After the import is over, the server is taken out of maintenance mode, so that clients can connect again.