BrightServer Troubleshooting

Q: When I tap 'Activate' in BrightForms, an "Error connecting to server" or "Unable to reach the server" message displays.

Firstly, ensure that BrightServer is running for the IP address and port specified. To verify that the server started correctly, locate the 'log' directory of the BrightServer instance. The following line, with timestamp should be logged, soon after BrightServer starts:

If running successfully, check that the IP address specified to BrightForms correctly matches the server, and that it is accessible via the port configured in BrightForms. If this is not the case, please review the network configuration to the server, and ensure any ports which are to be used are correctly forwarded via firewall rules.

To find the IP address and/or how to allow connections through the firewall, please refer to the Connecting to BrightServer chapter of this document.

Q: BrightServer will not start, displaying a "BrightServer Stopped" message at the end of the log.

Firstly, ensure no other BrightServer instances are running prior to starting the BrightServer instance. BrightServer may be seen running under the Services panel of Windows by the 'Running' state, or running via BrightBuilder by the 'play' button for a BEP's project node.

If no other instances a running, another process be due to the ports specified for BrightServer to listen on be blocked or currently in use by other progresses. This, and other errors may be viewed in the BrightServer log under the ERROR stream.

Q: I don't know what username/password to use when logging in to BrightServer.

By default, the username and password of newly installed BrightServer instance are bsadmin and changeit respectively.

If the 'bsadmin' password has changed, it may be set by starting BrightServer with the following command line options:

Q: When activating BrightForms, a dialog displays stating that the user account is not configured to run an application.

When synchronising BrightForms to BrightServer, BrightForms will download the application assigned to the user from BrightServer. On initial synchronisation, a valid application with release number must be assigned under the Configuration > Users node of BrightServer. If this application and/or release does not exist, this error will display.

Q: Synchronisation fails, with server log producing error that sync source is not defined.

This error will show on the server if the server configuration does not have a definition for the table's synchronisation in the direction requested from the device.

The server configuration used is as assigned to the user under the Configuration > Users panel of BrightServer. However, if this configuration is not active, or blank, then the default configuration will be used.

For more information on server configurations, please refer to the BrightServer > BrightServer Project Deployment section of this document.

Q: The error "Client could not consume records" appears on the server

Details of this error may be found by checking the device's client logs. Typically, setting a device in INFO and reviewing the INSERT or UPDATE statements performed on the client database on synchronisation will diagnose the problem.

One common issue this could occur is if the BEP project and BSP project's table definitions or mappings do not match one-another. This will cause issues when synchronising the device.

Q: "The maximum number of user accounts allowed in Xpress Edition has been exceeded" displays when validating user configuration in BrightBuilder.

In this scenario, Jobs, User Status, Web Licenses, Branding would also be all greyed out.

Ensure BrightBuilder is configured such that "All features are enabled" which will enable access to  non-Xpress features such as scripts and jobs for BrightServer.

Q: Image data written to database cannot be read.

In BrightForms, images are saved compressed to the local database, and this is sent as-is to BrightServer. While this compressed data may be read and accessed within BrightForms, as though it were decompressed, if using the data outside of BrightForms or BrightWeb, it must be decompressed prior to sending it from the device to BrightServer.

This may be achieved via Query Mapping in the BEP, setting the image column's 'Need to Decompress' option as true, then assigning it to the client table in the sync panel.

Q: An error occurs when activating a BEP under the server configuration panel.

If the BrightServer instance is the Xpress edition, only one BEP may be activated at a time on the server. As a result, if a new BEP is to be uploaded and activated, any previous deployments must be disabled under the 'Server Configuration' node of BrightServer.

Q: Licenses applied to BrightServer appear in the log as invalid.

BrightServer's licenses are applied based on a machine's device token and ports. As such, any changes to them will to invalidate any licenses linked to these values.

Ports may only change via the Server Settings node of BrightServer in BrightBuilder. Please ensure the ports are the same as when the license file was generated. Changing ports back to the values used to create the license and restarting BrightServer should restore any licenses invalidated through port changes.

The server token of a machine is used to uniquely identify the system BrightServer is running on. However, this value may change depending on the system and its configuration. To avoid this scenario, please ensure the following:

• The server is running on the same machine used

• The network adapter does not change

• If BrightServer is installed on a virtual machine, avoid restarting the machine

If these events have occurred, the token may have changed. If this is the case, please contact support immediately, as licenses may need to be regenerated and reapplied for the server.