Instructions to migrate from Flash Indoor to Luxiflux Zonal.


Prerequisites

  • The existing implementation of Flash Indoor on your website requires the use of XML input system for photometry and settings.  Very old implementations specified photometric file locations in URL parameters -- this is not supported in the migration.


Instructions


The goal of these instructions is to convert the URL used when launching Flash Indoor to a URL to launch Luxiflux Zonal.  Luxiflux Zonal is designed to work with the same XML input as Flash Indoor, so getting the URL correct is the most important part of the migration.


Step 1


Find the existing URL you use to launch Flash Indoor.  This can typically be found in the browser address bar of the Flash Indoor popup window and/or in the link that launches the popup window.


Example:

https://lightinganalysts.com/FlashTOOLS/FlashIndoor.htm?InputOutputMode=XML&InputURL=FlashIndoor_Input.xml&OutputURL=SaveXML.php&PhotometricURL=PhotometricDB.php&InstanceKey=AnyInstanceKey


Step 2


Break the URL into parts required for migration.


Base URL

https://lightinganalysts.com/FlashTOOLS/


Input URL

InputURL=FlashIndoor_Input.xml


Instance Key

InstanceKey=AnyInstanceKey


These parts of the URL are not required for migration and can be ignored:

  • FlashIndoor.htm
  • FlashIndoor.swf
  • InputOutputMode
  • OutputURL
  • PhotometricURL


Step 3


Build a URL that works for Luxiflux Zonal.


The URL consists of the following parts (they are case sensitive):


http://zonal.tools.luxiflux.com
Required
The URL for the Luxiflux Zonal website.
InputUrl
Required
The absolute (not relative) URL that returns the input XML.  

Depending on your existing implementation of Flash Indoor:

This might be a URL to an XML file on a server.

OR

 This might be a URL to a web API (script) that generates and returns XML as an HTTP response. 

Luxiflux Zonal is designed to work with the same XML input as Flash Indoor, so getting the URL correct is the most important part of the migration.
BaseUrl
Optional
If the input XML that is returned by the Input URL uses relative URLs for photometric file paths and image locations, then you must specify a base URL.

If the input XML that is returned by the Input URL uses absolute URLs, you can omit this parameter.
InstanceKey
Optional
If the Instance Key is used to generate the XML then add this parameter exactly as in the Flash Indoor implementation.  Otherwise, omit it.

If the Instance Key is generic (always the same) each time the tool is launched, it can likely be omitted.



Example (broken into multiple lines for clarity):


http://zonal.tools.luxiflux.com
?InputUrl=https://lightinganalysts.com/FlashTOOLS/FlashIndoor_Input.xml
&BaseUrl=https://lightinganalysts.com/FlashTOOLS/
&InstanceKey="AnyInstanceKey"


Example (no line breaks):


http://zonal.tools.luxiflux.com?InputUrl=https://lightinganalysts.com/FlashTOOLS/FlashIndoor_Input.xml&BaseUrl=https://lightinganalysts.com/FlashTOOLS/&InstanceKey="AnyInstanceKey"



Step 4


Paste the link you generated in Step 3 into your browser.

You should have a working implementation of Luxiflux Zonal (or you should be shown error messages).



Step 5


Convert your website to use the new Luxiflux Zonal URL(s) instead of the existing FlashIndoor URL(s).




Other Migration Topics


Logo

The logo needs to be resized to work better with the new tool (Luxiflux Zonal).  

This will ensure the logo is readable on small form factors (i.e. phones).

  1. The old logo for Flash Indoor is typically 650x50 pixels (13/1 width/height ratio).
  2. Create a new logo that is between 1/1 and 3/1 width/height ratio (e.g. 100x50 pixels). 
  3. Upload the new logo.
  4. Change the XML input to reference the new logo URL.  There are two XML elements to change.
<LogoURL>
<PrintLogoURL>



Colors

You can play with different theme colors in the Luxiflux Zonal settings section.  

Temporarily, you can also change the theme by clicking on the toolbar.


To automatically load new colors into Luxiflux Zonal, the XML input must be modified to add 4 new colors.

  1. Locate the <Colors> section of the XML.
  2. Add the following XML within the <Colors></Colors> elements.
  3. Change the RGBA values as desired.
<Section Name="LuxifluxZonal">
        <Color Type="Primary" RemoveAlpha="False">90,90,90,100</Color>
        <Color Type="Secondary" RemoveAlpha="False">20,20,20,100</Color>
        <Color Type="Text" RemoveAlpha="False">0,0,0,100</Color>
        <Color Type="Background" RemoveAlpha="False">100,100,100,100</Color>
</Section>




Authentication

While in beta, Luxiflux Zonal will not authenticate requests.  The production version will require authentication which will necessitate (hopefully minor) changes to how the tool is launched.  We are working to make this as seamless as possible, but we are going to favor security over convenience.  Stay tuned.