Developer's Guide - Server Configuration
The Server section configures an agent to communicate with a Loupe Server. With it you can both provide the information necessary to connect to the server and whether you want sessions to be sent automatically in the background (a capability unique to the Agent / Server connection).
| Option |
Description |
Default Value |
Required |
| Enabled |
True by default, disables server communication when false. |
true |
false |
| UseGibraltarService |
When true, specifies that the Loupe Service should be used instead of a private Server. |
false |
false |
| CustomerName |
The unique customer name when using the Loupe Service. Does not apply when UseGibraltarService is false. |
"" |
false |
| Server |
The full DNS name of the server where the Server is located. Only applies to a private Server. |
"" |
false |
| UseSsl |
Indicates if the connection should be encrypted with SSL. Only applies to a private Server. |
false |
false |
| Port |
An optional port number override for the server. Not required if the port is the traditional port (80 or 443). Only applies to a private Server. |
0 |
false |
| ApplicationBaseDirectory |
The virtual directory on the host for the private Server. Only applies to a private Server. |
"" |
false |
| Repository |
The specific repository on the server to send the session to. Only applies to a private Server running Enterprise Edition. |
"" |
false |
| AutoSendSessions |
Indicates whether to automatically send session data to the server in the background. |
false |
false |
| AutoSendOnError |
Indicates whether to automatically send data to the server when error or critical messages are logged. |
true |
false |
| SendAllApplications |
Indicates whether to send data about all applications for this product to the server or just the current application. |
false |
false |
| PurgeSentSessions |
Indicates whether to remove sessions that have been sent from the local repository once confirmed by the server. |
false |
false |
Examples
Connect to the Loupe Cloud-Hosted Service
To send data to the Loupe Cloud-Hosted Service (App.OnLoupe.Com) only the UseGibraltarService and CustomerName options need to be set, all others are ignored.
- Replace "Your Loupe Service Name" with the name of your Loupe Cloud-hosted Service. If you don't have one yet, sign up for a free trial service.
- Replace "Your Product" and "Your Application" with friendly values for your application. A good analogy for Product is "Office" and Application is "Word", "Excel", and "PowerPoint".
Publisher.ProductName=Your Product
Publisher.ApplicationName=Your Application
Publisher.ApplicationVersion=1.0.0
Server.UseGibraltarService=true
Server.CustomerName=Your Loupe Service Name
Server.AutoSendSessions=true
Server.SendAllApplications=true
<!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">
<properties>
<entry key="Publisher.ProductName">Your Product</entry>
<entry key="Publisher.ApplicationName">Your Application</entry>
<entry key="Publisher.ApplicationVersion">1.0.0</entry>
<entry key="Server.UseGibraltarService">true</entry>
<entry key="Server.CustomerName">Your Loupe Service Name</entry>
<entry key="Server.AutoSendSessions">true</entry>
<entry key="Server.SendAllApplications">true</entry>
</properties>
Connect to a Loupe Self-Hosted Server
To send data to your own self-hosted Loupe Server at a minimum specify the server name, but if SSL is available set useSsl to force all communication to be encrypted.
- Replace "Full DNS Name of Your Server" with the name of your self-hosted Loupe Server. Do not provide the protocol (e.g. https://), just the DNS name.
- Replace "Your Product" and "Your Application" with friendly values for your application. A good analogy for Product is "Office" and Application is "Word", "Excel", and "PowerPoint".
Publisher.ProductName=Your Product
Publisher.ApplicationName=Your Application
Publisher.ApplicationVersion=1.0.0
Server.Server=Full DNS Name Of Your Server
Server.UseSsl=true
Server.AutoSendSessions=true
Server.SendAllApplications=true
<!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">
<properties>
<entry key="Publisher.ProductName">Your Product</entry>
<entry key="Publisher.ApplicationName">Your Application</entry>
<entry key="Publisher.ApplicationVersion">1.0.0</entry>
<entry key="Server.Server">Full DNS Name Of Your Server</entry>
<entry key="Server.UseSsl">true</entry>
<entry key="Server.AutoSendSessions">true</entry>
<entry key="Server.SendAllApplications">true</entry>
</properties>