Fishbowl Server Administration: Difference between revisions

From Fishbowl Advanced
m (I fixed a repeated word and made a few other changes.)
Line 44: Line 44:
* The '''Web Port''' is used for the Fishbowl web server that allows REST API access. The REST API is in beta.
* The '''Web Port''' is used for the Fishbowl web server that allows REST API access. The REST API is in beta.
** The most recent API documentation can only be accessed when the Fishbowl Server is running.
** The most recent API documentation can only be accessed when the Fishbowl Server is running.
** To see the documentation on the Fishbowl Server computer, click the following link: http://localhost:80/apidocs<br>[[File:REST API.png|link=http://localhost:80/apidocs|class=noinvert]]
** To see the documentation on the Fishbowl Server computer, click the following link: http://localhost:80/apidocs<br>[[File:REST API.png|class=noinvert]]
** To see the documentation from other computers on the network, enter the IP address of the Fishbowl Server computer, replacing '''80''' with your '''Web Port'''. For example: '''<nowiki>192.168.29.37:80/apidocs</nowiki>'''
** To see the documentation from other computers on the network, enter the IP address of the Fishbowl Server computer, replacing '''80''' with your '''Web Port'''. For example: '''<nowiki>192.168.29.37:80/apidocs</nowiki>'''
** An example of the API documentation can be accessed [https://fishbowlhelp.com/files/apidocs/introduction.html here].
** An example of the API documentation can be accessed [https://fishbowlhelp.com/files/apidocs/introduction.html here].

Revision as of 06:24, 25 April 2023

When the Fishbowl Server is installed, the Fishbowl Server Administration application is also installed. This application provides an interface for creating databases, modifying server settings, changing the license key, and performing database maintenance.

Fishbowl Server Administration.png

Stop the Fishbowl Server

If the Fishbowl Server is started, the Fishbowl Server Administration can be viewed, but changes cannot be made. To make changes, first stop the Fishbowl Server using one of the methods below.

  • Right-click the Fishbowl Server icon in the system tray and click Stop.
    Stop Server.png
  • Double-click the Fishbowl Server icon in the system tray and then click the Stop button.
    Stop Fishbowl Server.png

Start Fishbowl Server Administration

Below are several ways to start the Fishbowl Server Administration.

  • Click the Start menu, select the Fishbowl program folder, and then click Fishbowl Server Administration.
    Fishbowl Program folder.png
  • Browse to C:\Program Files\Fishbowl\server\bin\ and then double-click Fishbowl Server Administration.exe.
    Fishbowl Server Administration file.png
  • Right-click the Fishbowl Server icon in the system tray and choose Options.
    Server Options.png
  • Double-click the Fishbowl Server icon in the system tray, click the Tools menu, and then select Options.
    Server options stop.png

TABS

Database tab

Fishbowl Server Administration.png

This tab provides access to several database features.

Rebuild database

When using Fishbowl for the first time, many companies will create a sandbox database to help train their employees. They may import their actual data (customers, users, parts, etc.) and then decide they want to use this same data in their live database. The Rebuild Database tool allows companies to create a new database with all of that data, but exclude the inventory and orders that were created during the training period.

To rebuild a database, you must first stop the Fishbowl Server. Then on the Database tab, you can right-click the database and select Rebuild Database. Depending on the size of your database, it could take several minutes to copy all of the data over into a new database.

Rebuild Database.png

Server tab

Fishbowl Server Administration Server.png
  • The Server Port can be changed to a different port number. This can also allow multiple Fishbowl Servers to run on the same computer.
  • Inactivity time can be extended as described here.
  • Broadcast Server Location allows the Fishbowl Server to be found by clicking the Search Icon Button.png Find Fishbowl Servers button from the login window.
  • To prevent a user from logging in on multiple computers, enable Users can only be logged in once.
  • Server memory can be adjusted as described here.
  • More information about Auto Updates is available here.

REST API

  • The Web Port is used for the Fishbowl web server that allows REST API access. The REST API is in beta.
    • The most recent API documentation can only be accessed when the Fishbowl Server is running.
    • To see the documentation on the Fishbowl Server computer, click the following link: http://localhost:80/apidocs
      REST API.png
    • To see the documentation from other computers on the network, enter the IP address of the Fishbowl Server computer, replacing 80 with your Web Port. For example: 192.168.29.37:80/apidocs
    • An example of the API documentation can be accessed here.
    • To use a Secure Web Connection, select a .JKS certificate file. The certificate can be self-signed or purchased online from a Certificate Authority.

License tab

Fishbowl Server Administration License.png

Restore tab

Fishbowl Server Administration Restore.png