Using the XlBridge Add-in
Built-in functions
The add-in has a number of built-in functions for monitoring purposes.
-
=XLBRIDGE.STATUS()Returns a single-cell status for all configured connections.
Downif none of the configured servers are connectedDegradedif one or more of the configured servers are connectedUpif all configured servers are connected
The status value updates automatically when any connection status changes.
-
=XLBRIDGE.CONNECTIONS()Returns an Excel array with details about all configured connections.
Array formulas are not recommended to use for real-time updates. Provide the output of
XLBRIDGE.STATUS()as an optional argument to make it update as soon as the status changes. -
=XLBRIDGE.LICENSE()Returns an Excel array with license details, including license level, key and expiry date.
-
=XLBRIDGE.ID()Outputs the user-specific identification string that is used when registering
Configure servers connections
The XlBridge Excel add-in connects by default to http://localhost:4704/ which is also the default
host when creating a calculation server. No configuration is needed in this case.
A more complex scenario requires a configuration file. Supported options are
- connect to an alternative port
- connect to a different host
- connect to several servers at the same time
- add a prefix to all formulas from a specific server
The add-in reads the file xlbridge.json if it exists in the user home directory (%USERPROFILE%). The file is only read at startup. Adding or modifying the server setup can not be done while Excel is running.
Use the built-in function XLBRIDGE.CONNECTIONS() to verify that the file is setup correctly and to monitor connection status.
Example config
A config with two servers of which one is a remote connection at an alternative port would look something like:
{
"bridgeServer": {
"servers": {
"default": {
"uri": "http://localhost:47074",
"enabled": true
},
"python": {
"uri": "http://computer.mydomain.com:47079",
"prefix": "py.",
"enabled": true
},
}
},
}
The enabled and prefix entries are optional.