{"type":"doc","content":[{"type":"paragraph","content":[{"type":"inlineCard","attrs":{"url":"https://paper.dropbox.com/doc/06.-Reactor-Development-Tutorial--BtMSl0GazlQfKftO5gx9DVOyAg-8SUVxuMSTZLDLBsaVSu50"}},{"text":" ","type":"text"}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"41228072-6681-4b8b-a70d-3240bd678966"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"cee4543c-7cba-434c-9e84-3fd9b10de522"}},{"type":"heading","attrs":{"level":1},"content":[{"text":"06. Reactor Development Tutorial","type":"text"}]},{"type":"paragraph","content":[{"text":"<— Reactor Home","type":"text","marks":[{"type":"link","attrs":{"href":"/wiki/spaces/FusionReactor/pages/2202501288"}}]}]},{"type":"paragraph","content":[{"text":"The following provides everything you should know to create your own BlackBoxes (or modify others) in Reactor.","type":"text"}]},{"type":"paragraph","content":[{"text":"The first section provides an introduction to management of a BlackBox in Reactor.","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"BlackBox Files","type":"text","marks":[{"type":"link","attrs":{"href":"https://paper.dropbox.com/doc/Reactor-Guide--AXs0LgVe0zBMkoGWMJfOsEt5Ag-8SUVxuMSTZLDLBsaVSu50#:h2=1.-BlackBox-Files"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"BlackBox Functions and Parameters","type":"text","marks":[{"type":"link","attrs":{"href":"https://paper.dropbox.com/doc/Reactor-Guide--AXs0LgVe0zBMkoGWMJfOsEt5Ag-8SUVxuMSTZLDLBsaVSu50#:h2=2.-Parameters-and-Functions"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Compiling and Previewing","type":"text","marks":[{"type":"link","attrs":{"href":"https://paper.dropbox.com/doc/Reactor-Guide--AXs0LgVe0zBMkoGWMJfOsEt5Ag-8SUVxuMSTZLDLBsaVSu50#:h2=3.-Compiling-and-Previewing"}}]}]}]}]},{"type":"paragraph","content":[{"text":"The second section is a more advanced guide to the ","type":"text"},{"text":"FR Toolbox","type":"text","marks":[{"type":"link","attrs":{"href":"https://paper.dropbox.com/doc/FR-Toolbox-Reference--Alz8p_mDughSwMoEFWYoOSSzAg-sE8bOT9P8vdXUmPu91t3E"}}]},{"text":" functions, used to communicate with your FileMaker application.","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Introduction to the FRToolBox, and asynchronicity ","type":"text","marks":[{"type":"link","attrs":{"href":"https://paper.dropbox.com/doc/Reactor-Guide--AXs0LgVe0zBMkoGWMJfOsEt5Ag-8SUVxuMSTZLDLBsaVSu50#:uid=963661697499630955534419&h2=FRToolBox-and-Talking-With-FM"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Using parameters","type":"text","marks":[{"type":"link","attrs":{"href":"https://paper.dropbox.com/doc/Reactor-Guide--AXs0LgVe0zBMkoGWMJfOsEt5Ag-8SUVxuMSTZLDLBsaVSu50#:h2=2.-Using-parameters"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Reading records from your found set","type":"text","marks":[{"type":"link","attrs":{"href":"https://paper.dropbox.com/doc/Reactor-Guide--AXs0LgVe0zBMkoGWMJfOsEt5Ag-8SUVxuMSTZLDLBsaVSu50#:h2=3.-Pulling-records-from-your-f"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Pulling a single record","type":"text","marks":[{"type":"link","attrs":{"href":"https://paper.dropbox.com/doc/Reactor-Guide--Adza4LZhWgWN69xvUT0FYv3iAg-8SUVxuMSTZLDLBsaVSu50#:h2=2.-Pulling-a-single-record"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Updating a record","type":"text","marks":[{"type":"link","attrs":{"href":"https://paper.dropbox.com/doc/Reactor-Guide--Adza4LZhWgWN69xvUT0FYv3iAg-8SUVxuMSTZLDLBsaVSu50#:h2=5.-Updating-a-record"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Creating a new record","type":"text","marks":[{"type":"link","attrs":{"href":"https://paper.dropbox.com/doc/Reactor-Guide--AeWy4XCzmLThCptfz3n37KAcAg-8SUVxuMSTZLDLBsaVSu50#:h2=6.-Creating-a-new-record"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Deleting a record","type":"text","marks":[{"type":"link","attrs":{"href":"https://paper.dropbox.com/doc/Reactor-Guide--AeWy4XCzmLThCptfz3n37KAcAg-8SUVxuMSTZLDLBsaVSu50#:h2=7.-Deleting-a-record"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Polling for changes","type":"text","marks":[{"type":"link","attrs":{"href":"https://paper.dropbox.com/doc/Reactor-Tutorial--AeuX0QmQ7P98OeVV9fonnROWAg-8SUVxuMSTZLDLBsaVSu50#:h2=8.-Polling-For-Changes"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Running a script","type":"text","marks":[{"type":"link","attrs":{"href":"https://paper.dropbox.com/doc/Reactor-Tutorial--AeuX0QmQ7P98OeVV9fonnROWAg-8SUVxuMSTZLDLBsaVSu50#:h2=8.-Running-a-script"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Pulling container images","type":"text","marks":[{"type":"link","attrs":{"href":"https://paper.dropbox.com/doc/Reactor-Tutorial--AeuX0QmQ7P98OeVV9fonnROWAg-8SUVxuMSTZLDLBsaVSu50#:h2=9.-Pull-Container-Images"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Using the starting template","type":"text","marks":[{"type":"link","attrs":{"href":"https://paper.dropbox.com/doc/Reactor-Tutorial-AeuX0QmQ7P98OeVV9fonnROWAg-8SUVxuMSTZLDLBsaVSu50#:h2=10.-Using-The-Starting-Templat"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Debugging","type":"text","marks":[{"type":"link","attrs":{"href":"https://paper.dropbox.com/doc/Reactor-Tutorial-AeuX0QmQ7P98OeVV9fonnROWAg-8SUVxuMSTZLDLBsaVSu50#:h2=11.-Debugging"}}]}]}]}]},{"type":"rule"},{"type":"paragraph","content":[{"text":"This entire tutorial is around building several functions for a single BlackBox. If you would prefer to see the functions in action, you can download the fully-completed BlackBox here:","type":"text"}]},{"type":"paragraph","content":[{"type":"inlineCard","attrs":{"url":"https://www.dropbox.com/s/6fn6eo85h66ly56/TutorialBB%20%281%29.rbb?dl=0"}},{"text":" ","type":"text"},{"type":"hardBreak"}]},{"type":"paragraph","content":[{"text":"You can import this into the Reactor application by adding a new BlackBox, and choosing to import it.","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"type":"external","url":"https://paper-attachments.dropboxusercontent.com/s_40CFE1C900049AAD665A87A6024CD78A773E4A2A4BD9FE99876E488F73BB1C9A_1560047801566_image.png"}}]},{"type":"paragraph","content":[{"text":"However the best way to learn Reactor development is to progress through this tutorial step-by-step – but you’re more than welcome to use the completed BlackBox to access individual snippets of code or to help figure out any issues you might be having with your own BlackBoxes.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Section A: BlackBox Management","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"BlackBox Files","type":"text"}]},{"type":"paragraph","content":[{"text":"If you have not done so before, now would be the ideal time to go through the in-app tutorial for Reactor. You can do this from the Support screen in Reactor.","type":"text"}]},{"type":"paragraph","content":[{"text":"When you create or select a BlackBox to manage, you start off on the ‘source files’ tab.","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"type":"external","url":"https://paper-attachments.dropboxusercontent.com/s_40CFE1C900049AAD665A87A6024CD78A773E4A2A4BD9FE99876E488F73BB1C9A_1569824895265_image.png"}}]},{"type":"paragraph","content":[{"text":"This is what appears when clicking on one of the demo BlackBoxes, it comprises the main file for the BlackBox, and any supporting files it requires. If you start a new BlackBox, this list will start off empty. Go ahead and create a new BlackBox called ","type":"text"},{"text":"TutorialBB","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"By the time you get to the end of this tutorial, your TutorialBB will be chocker-full of functions that communicate with FileMaker via Reactor. The BlackBox is a portable file you can install on any computers you wish to invoke these functions.","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"type":"external","url":"https://paper-attachments.dropboxusercontent.com/s_40CFE1C900049AAD665A87A6024CD78A773E4A2A4BD9FE99876E488F73BB1C9A_1558744050203_image.png"}}]},{"type":"paragraph","content":[{"text":"You will be invited to start uploading files, or create an HTML template after creating your first function - see the following section.","type":"text"}]},{"type":"paragraph","content":[{"text":"Any files you add will now appear in your list of files. Accompanying it will be two buttons","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"type":"external","url":"https://paper-attachments.dropboxusercontent.com/s_40CFE1C900049AAD665A87A6024CD78A773E4A2A4BD9FE99876E488F73BB1C9A_1569825019716_image.png"}}]},{"type":"paragraph","content":[{"text":"Clicking the edit button will open the document in your editor of choice, or Moogie will ask you what it should be if he doesn’t know yet. We recommend BBEdit for Mac or Notepad++ for Windows - but it’s entirely up to you.","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"type":"external","url":"https://paper-attachments.dropboxusercontent.com/s_40CFE1C900049AAD665A87A6024CD78A773E4A2A4BD9FE99876E488F73BB1C9A_1550377088748_image.png"}}]},{"type":"paragraph","content":[{"text":"These are the default applications when editing your source files. You’re also welcome to change this, by clicking it under ‘your editors’. The first option is for your text-editor, and the second option is for your image editor.","type":"text"}]},{"type":"paragraph","content":[{"text":"Editing the file will then open it in this editor.","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"type":"external","url":"https://paper-attachments.dropboxusercontent.com/s_40CFE1C900049AAD665A87A6024CD78A773E4A2A4BD9FE99876E488F73BB1C9A_1550377192417_image.png"}}]},{"type":"paragraph","content":[{"text":"The document is now “officially” open. That means when you compile the BlackBox, it will pull the file back into Reactor — so you will need to save any changes you make in the editor itself first!","type":"text"}]},{"type":"paragraph","content":[{"text":"You can do this manually by clicking ‘upload’. If you no longer wish to pull any changes back into Reactor, click ‘close’ - though this won’t close the file in your text editor, you’ll need to do that yourself. And you can re-open the file at any point. Ie, if you’re done making your changes and want to pull these changes in - click Upload. You can then click close.","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"type":"external","url":"https://paper-attachments.dropboxusercontent.com/s_40CFE1C900049AAD665A87A6024CD78A773E4A2A4BD9FE99876E488F73BB1C9A_1569825085594_image.png"}}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"BlackBoxes Functions and Parameters","type":"text"}]},{"type":"paragraph","content":[{"text":"Click the ‘functions’ tab and you can see a list of functions for the BlackBox. Most of the time, there will be a single function for each BlackBox, but if you wish to create a suite of BlackBox utilities for a single BlackBox, you can create a function for each,","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"type":"external","url":"https://paper-attachments.dropboxusercontent.com/s_40CFE1C900049AAD665A87A6024CD78A773E4A2A4BD9FE99876E488F73BB1C9A_1559961815031_image.png"}}]},{"type":"paragraph","content":[{"text":"If you are creating a new BlackBox, you will need to create a function to start with.","type":"text"}]},{"type":"paragraph","content":[{"text":"To do this, click the ‘+’ button at the top of the function list, and fill in the details.","type":"text"}]},{"type":"paragraph","content":[{"text":"Call our new function for our new BlackBox called ","type":"text"},{"text":"TestFunction","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"type":"external","url":"https://paper-attachments.dropboxusercontent.com/s_40CFE1C900049AAD665A87A6024CD78A773E4A2A4BD9FE99876E488F73BB1C9A_1559962311453_image.png"}}]},{"type":"paragraph","content":[{"text":"Now that we have our function, go ahead and add a new parameter. Give it a name called ","type":"text"},{"text":"MyParameter","type":"text","marks":[{"type":"code"}]},{"text":", and let Moogie know if it’s optional, if it’s hidden and/or if whether changes to the parameter should trigger a refresh of the BlackBox. Also ensure you set the ‘data type’ to Text.","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"type":"external","url":"https://paper-attachments.dropboxusercontent.com/s_40CFE1C900049AAD665A87A6024CD78A773E4A2A4BD9FE99876E488F73BB1C9A_1559962809598_image.png"}}]},{"type":"paragraph","content":[{"text":"Now we need to give our BlackBox something to do. Let’s create a template file. Please see our more advanced guide on what a BlackBox file does, but in its purest sense, it creates an HTML document for your function that starts you off with the boilerplate code needed - ready to customise.","type":"text"}]},{"type":"paragraph","content":[{"text":"So click the ‘html template…’ button to create one,","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"type":"external","url":"https://paper-attachments.dropboxusercontent.com/s_40CFE1C900049AAD665A87A6024CD78A773E4A2A4BD9FE99876E488F73BB1C9A_1559962614597_image.png"}}]},{"type":"paragraph","content":[{"text":"It automatically gives it the same same of the function you’re generating it for. Now let’s go ahead and build it.","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"type":"external","url":"https://paper-attachments.dropboxusercontent.com/s_40CFE1C900049AAD665A87A6024CD78A773E4A2A4BD9FE99876E488F73BB1C9A_1559962658809_image.png"}}]},{"type":"paragraph","content":[{"text":"We have set only a single text-based parameter for the function, so the template builder automatically pulls that in to the JavaScript block, and stores it as a variable.","type":"text"}]},{"type":"paragraph","content":[{"text":"As of this point, we have now provided all the details to build it into a BlackBox, click across to the Preview tab.","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"type":"external","url":"https://paper-attachments.dropboxusercontent.com/s_40CFE1C900049AAD665A87A6024CD78A773E4A2A4BD9FE99876E488F73BB1C9A_1558744603050_image.png"}}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Compiling and Previewing","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"type":"external","url":"https://paper-attachments.dropboxusercontent.com/s_40CFE1C900049AAD665A87A6024CD78A773E4A2A4BD9FE99876E488F73BB1C9A_1558744706826_image.png"}}]},{"type":"paragraph","content":[{"text":"Click ‘Compile’ and if you switch back to the Functions tab you’ll now see a file below the BlackBox details. The BlackBox file itself - which you can now take and deploy anywhere using the following function:","type":"text"}]},{"type":"paragraph","content":[{"text":"BlackBoxAdd( <> )","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Now let’s preview our BlackBox. ","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"type":"external","url":"https://paper-attachments.dropboxusercontent.com/s_40CFE1C900049AAD665A87A6024CD78A773E4A2A4BD9FE99876E488F73BB1C9A_1558744755032_image.png"}}]},{"type":"paragraph","content":[{"text":"You can now view your BlackBox do…nothing. That’s because all you’ve created is a blank page. Now it’s time to turn to some JavaScript and actually get your BlackBoxes to do stuff.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"FR Toolbox and Talking With FileMaker","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"1. Introduction to FRToolBox and Asynchronicity","type":"text"}]},{"type":"paragraph","content":[{"text":"Anytime you create a BlackBox there is a single file that will always be included: ","type":"text"},{"text":"FRToolBox.js","type":"text","marks":[{"type":"code"}]}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"type":"external","url":"https://paper-attachments.dropboxusercontent.com/s_40CFE1C900049AAD665A87A6024CD78A773E4A2A4BD9FE99876E488F73BB1C9A_1550379357297_image.png"}}]},{"type":"paragraph","content":[{"text":"This is a JavaScript library that you can use for talking back to FileMaker.","type":"text"}]},{"type":"paragraph","content":[{"text":"Essentially, it’s used for pulling through the data you need to work with, and for pushing it back. Additionally, it can also be used for running scripts in FileMaker. When building an HTML document from a template, you don’t need to worry about importing this library yourself - it’s automatically included and imported.","type":"text"}]},{"type":"paragraph","content":[{"text":"It’s also important to note that all the FRToolBox functions you call are asynchronous. To those that are more versed in FileMaker Development than Web Development, it’s the same as ","type":"text"},{"text":"Perform Script On Server","type":"text","marks":[{"type":"code"}]},{"text":" with ‘Wait for completion’ turned off.","type":"text"}]},{"type":"paragraph","content":[{"text":"What you need to keep in mind is that when you call a function, you’re simply telling FRToolBox to do something, then moving on with your life. The next line of code doesn’t necessarily know about how it went, or get passed what comes back.","type":"text"}]},{"type":"paragraph","content":[{"text":"However FRToolBox has built in callback functions, so there are ways to do stuff with the FileMaker data that comes back.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"2. Using parameters","type":"text"}]},{"type":"paragraph","content":[{"text":"Using our testing BlackBox from the first section, let’s try doing something with the parameter. A parameter can be anything, usually it’s a field name used to pull/push data, or something else like a string of text, number, date, etc.","type":"text"}]},{"type":"paragraph","content":[{"text":"Edit the ","type":"text"},{"text":"index.html","type":"text","marks":[{"type":"code"}]},{"text":" document we created before, and where you see:","type":"text"}]},{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Replace this with","type":"text"}]},{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Everything between the ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" tags will be interpreted by Reactor. The ","type":"text"},{"text":"$","type":"text","marks":[{"type":"code"}]},{"text":" tells Reactor we’re referring to a parameter, and ","type":"text"},{"text":"MyParameter","type":"text","marks":[{"type":"code"}]},{"text":" is our parameter name.","type":"text"}]},{"type":"paragraph","content":[{"text":"We put it here because it’s smack bang inside the ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" element of the HTML. The main content for any BlackBox will go here.","type":"text"}]},{"type":"paragraph","content":[{"text":"Save the document and recompile. We still see nothing because you haven’t given the parameter a value yet. You can do this on the preview tab by entering it alongside the parameter name:","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"type":"external","url":"https://paper-attachments.dropboxusercontent.com/s_40CFE1C900049AAD665A87A6024CD78A773E4A2A4BD9FE99876E488F73BB1C9A_1558745083677_image.png"}}]},{"type":"paragraph","content":[{"text":"Now look across to the right, and you should see it update in real time!","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"type":"external","url":"https://paper-attachments.dropboxusercontent.com/s_40CFE1C900049AAD665A87A6024CD78A773E4A2A4BD9FE99876E488F73BB1C9A_1558745147955_image.png"}}]},{"type":"paragraph","content":[{"text":"Our BlackBox now does something!","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"3. Pulling records from your found set","type":"text"}]},{"type":"paragraph","content":[{"text":"Most typically, one or more of your parameters will refer to a FileMaker field so you can query data.","type":"text"}]},{"type":"paragraph","content":[{"text":"Go ahead and add a new parameter, but this time the ‘data type’ should be ","type":"text"},{"text":"Field Name","type":"text","marks":[{"type":"code"}]}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"type":"external","url":"https://paper-attachments.dropboxusercontent.com/s_40CFE1C900049AAD665A87A6024CD78A773E4A2A4BD9FE99876E488F73BB1C9A_1558745590397_image.png"}}]},{"type":"paragraph","content":[{"text":"The first thing you want to do when querying data in Reactor is pulling records from your found set.","type":"text"}]},{"type":"paragraph","content":[{"text":"To get started, add the following code inside the ","type":"text"},{"text":"

Browser not supported