Solution Builder API

Solution Builder Launch Event

1min

Each time Solution Builder ScreenPal APP is started, a specified URL is opened by ScreenPal to allow for notification of this launching event. See basicupload.launch.event.url for how to specify the desired URL.

You may use the default value, which logs the event with the ScreenPal Team's servers. You may also override the property to specify your own URL that should be opened when ScreenPal starts.

This feature allows tracking launches of ScreenPal APP, which one might do to implement a Licensing Proxy, or compile usage knowledge to a database. The information sent in the event contains no Personally Identifiable Information (PII). Your Customers can know their private and personal information is safe and is not used. The specified URL is opened, and these additional parameters are passed: &partnerId=xxx&deviceId=yyy The partnerId value (xxx) is assigned to the Solution Builder Client by the ScreenPal Team when you establish your Solution Builder license. The deviceId is given an integer value (yyy) that represents a timestamp for when the ScreenPal Installer was run on the given computer. That value remains the same, unless the Client reinstalls ScreenPal. If the URL is provided, then when ScreenPal starts up, it opens that URL with the query parameters mentioned above using a GET request. If that request returns a failure, ScreenPal just logs an error and continues normally. If you override the property with your own URL value to your backend servers, then the GET request would present your backend services with the launch notification along with your partner ID and the device ID of the device that is running ScreenPal. Your backend may choose to use that information as it sees fit. For example, log the number of launches of ScreenPal on a particular device.

Your backend must first call the default ScreenPal URL, as seen in the example code for the property, to satisfy any ScreenPal licensing requirements. Include any results from that GET call when you return your GET call results, so that ScreenPal APP has required results from both the ScreenPal URL and your URL.