If you are not migrating from our previous product (Flash Indoor), follow the instructions for new implementations instead.
In this step you will:
- 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.
- Test it.
- Make minor changes to the XML input to better support Luxiflux Zonal.
Prerequisites
- You should have completed all previous steps.
- 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. If you use this old method for Flash Indoor please follow the instructions for new implementations.
Step 2.1 Find the Existing Flash Indoor URL
Find the URL you use to launch your existing implementation of 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://www.example.com/FlashTOOLS/FlashIndoor.htm?InputOutputMode=XML&InputURL=FlashIndoor_Input.xml&OutputURL=SaveXML.php&PhotometricURL=PhotometricDB.php&InstanceKey=AnyInstanceKey
Step 2.2 Decompose the URL
Break the URL into parts required for migration.
Base URL
https://www.example.com/FlashTOOLS/
Input Mode
InputOutputMode=XML
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
- Input Output Mode
- Output URL
- Photometric URL
Step 2.3 Build a New URL to launch Luxiflux Zonal
Build a URL that works for Luxiflux Zonal.
The URL consists of the following parts (they are case sensitive):
| https://v1-zonal-tools.luxiflux.com | Required | The URL for the Luxiflux Zonal website. |
| AuthenticationUrl | Required | You should have an authentication web API and its associated URL in Step 1 of these instructions. |
| InputMode | Required | The input mode (format) returned by the InputURL. Note: The parameter name was changed from InputOutputMode to InputMode. The value should be set to: XML |
| 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 HTTPS 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 internally 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://v1-zonal-tools.luxiflux.com ?AuthenticationUrl=https://www.example.com/Luxiflux/Authentication &InputMode=XML &InputUrl=https://www.example.com/FlashTOOLS/FlashIndoor_Input.xml &BaseUrl=https://www.example.com/FlashTOOLS/ &InstanceKey=AnyInstanceKey
Example (no line breaks):
http://v1-zonal-tools.luxiflux.com?AuthenticationUrl=https://www.example.com/Luxiflux/Authentication&InputMode=XML&InputUrl=https://www.example.com/FlashTOOLS/FlashIndoor_Input.xml&BaseUrl=https://www.example.com/FlashTOOLS/&InstanceKey=AnyInstanceKey
Step 2.4 Test the New URL
Copy the link you generated in the previous step into your browser.
You should have a working implementation of Luxiflux Zonal (or you should be shown error messages).
Step 2.5 Convert Your Website
Convert your website to use the new Luxiflux Zonal URL(s) instead of the existing FlashIndoor URL(s).
Step 2.6 Update Your Logo Image
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).
- The old logo for Flash Indoor is typically 650x50 pixels (13/1 width/height ratio).
- Create a new logo that is between 1/1 and 3/1 width/height ratio (e.g. 50x50, 100x50, 150x50 pixels).
- Upload the new logo.
- Change the XML input to reference the new logo URL. There are two XML elements to change.
<LogoURL> <PrintLogoURL>
Step 2.7 Specify Your Theme Colors
You can play with different theme colors in the Luxiflux Zonal settings section.
To automatically load new colors into Luxiflux Zonal, the XML input must be modified to add 12 new colors.
- Locate the <Colors> section of the XML.
- Add the following XML within the <Colors></Colors> elements.
- Change the RGBA values as desired.
View an example of the XML input with the new colors added.
<Section Name="LuxifluxZonal">
<Color Type="ToolbarForeground" RemoveAlpha="False">20,20,20,100</Color>
<Color Type="ToolbarBackground" RemoveAlpha="False">90,90,90,100</Color>
<Color Type="NavigationForeground" RemoveAlpha="False">90,90,90,100</Color>
<Color Type="NavigationBackground" RemoveAlpha="False">20,20,20,100</Color>
<Color Type="SectionForeground" RemoveAlpha="False">0,0,0,100</Color>
<Color Type="SectionBackground" RemoveAlpha="False">90,90,90,100</Color>
<Color Type="PageForeground" RemoveAlpha="False">0,0,0,100</Color>
<Color Type="PageBackground" RemoveAlpha="False">100,100,100,100</Color>
<Color Type="RoomForeground" RemoveAlpha="False">20,20,20,100</Color>
<Color Type="RoomBackground" RemoveAlpha="False">90,90,90,100</Color>
<Color Type="LuminaireForeground" RemoveAlpha="False">100,100,100,100</Color>
<Color Type="LuminaireBackground" RemoveAlpha="False">0,0,0,100</Color>
</Section>