Reactor Implementation Guide

Tags

    HistoryEdited Jan 18, 2011 2:06 PM by Wendy Wethey…

    Download Functions

    Reactor_HTTP( url {; data ; method ; cookie ; headerkey ; header data ...} )

    downloads the web page from the designated URL and returns the text

    Reactor_HTTP_Container( url {; data ; method ; cookie ; headerkey ; header data ...} )

    gets the file from the designated URL and puts it into a container field.

    Parameters

    The above functions have a number of parameters, and the last two can be repeated (in pairs). All except the first are optional, but order and position are important: if you need to provide (e.g.) a cookie value but no data value, pass a blank string (“”) for the data value.

    URL
    The one compulsory parameter is the URL that specifies where the data is to be found. This should be a standard HTTP or HTTPS URL exactly as you would type into a web browser. It should start with either “http://” for normal connections or “https://” for secure connections, and can include an optional port number after the server address, using standard URL server:port notation. (The standard defaults of port 80 for HTTP and port 443 for HTTPS are used if you don’t include them in the URL).
    Using HTTPS will mean that data sent and received over this connection will be encrypted while in transit. This will only be successful if the service to which you are connecting supports HTTPS. Please note also that no certificate checking is done, so there is no implication that the identity of the remote end is verified.
    When building your URL, remember to URL-encode any attribute names and attribute values which might contain characters that would cause problems if not encoded. FileMaker Pro provides a function for this: GetAsURLEncoded(). Read more about URL encoding here: http://en.wikipedia.org/wiki/Percent-encoding.

    data
    If your request is to be made using the “POST” method (see below), you can supply the data to be posted in this optional parameter. Attribute names and values in the data parameter should also be URL-encoded as discussed above.

    method
    This optional parameter should be either “GET” (which is the default if this parameter is omitted) or “POST”, and will define how the HTTP request will be sent to the server. If you are not familiar with the difference between these two methods, you will probably want to to use “GET”.

    cookie
    To pass cookie data to the server when the request is made, include it in this optional parameter

    header_key ; header_data
    You can supply extra HTTP protocol headers to be used when the request is made by passing them (in pairs) as final parameters to the Reactor_HTTP() function. You can supply as many pairs as you need.

    Reactor_HTTP_Response( response_element )

    returns header codes (success, error) from the above two calls

    When you perform an HTTP request using Reactor_HTTP() as described above, you will usually be interested mainly in the content of the remote server’s response, which you obtain as the result returned by the Reactor_HTTP() function. However, that content arrives in an HTTP ‘envelope’, and you can use the Reactor_HTTP_Response() function to retrieve further information about the response, as show below.

    The single parameter will select which element of the response you want to retrieve:

      • “COOKIE”

    Passing this value will return the cookie data that was received as a result of the most recent Reactor_HTTP() function call.

      • "STATUS"

    Passing this value will return the HTTP status message that was received with the returned data

    e.g. "HTTP/1.1 200 OK"

      • header_key

    You can retrieve other HTTP response headers by supplying their name as the parameter value, e.g. if the HTTP response included “Content-Type: text/html”, then passing "Content-Type" as the parameter to the Reactor_HTTP_Response() function will return "text/html".

    You can call the Reactor_HTTP_Response() function repeatedly to fetch different elements of the HTTP response to the last Reactor_HTTP() function call.



    BlackBoxAdd( blackboxLocation )

    Adds a BlackBox to Reactor from either a URL or a container field.

    A BlackBox can be installed on a user's computer from two distinct locations:
      • From a container field in the database (the container field).
      • Downloaded from external server (the URL to the BlackBox file).
    If you are using BlackBoxAdd in your startup script, you should first check the version number of the installed BlackBox against the version that is in the container field, and run BlackBoxAdd accordingly. In a wide area network, FileMaker will download the entire BlackBox every time the script is run, and may result in poor performance while FileMaker client waits to receive the BlackBox file.
    Function ID 31
    Example BlackBoxAdd( blackboxLocation )
    Success return values (when using a local container) OK: BlackBox loaded.
    (when using a url to download) [Container Data]
    Error return values Error: There was an error downloading the BlackBox.
    Error: Unable to extract the BlackBox from container.
    Error: There was an error parsing the BlackBox.
    Error: Unable to write BlackBox to disk.
    Error: BlackBox needs matching registration code.
    Error: Reactor not running.


    Download and install using a URL
    Using BlackBoxAdd to download and install a BlackBox from an external server is a useful way to provide an update mechanism. You can see an implementation of this in the Reactor Core (demo) file on the MyReactor tab. The BlackBoxUpdater will first check your installed BlackBoxes against a manifest file, and will then allows the user to update their BlackBox by directly downloading the BlackBox.

    Using the remote URL method, the BlackBoxAdd function will return file data which can be set directly into a container field for later use by other clients (meaning that you could develop your script so that only a single client would need to download the remote file, instead of each client).

    Comments

    /groups/docs/search/index.rss?sort=modifiedDate&sortDirection=reverse&tag=blackboxlist/groups/docs/search/?sort=modifiedDate&sortDirection=reverse&tag=blackboxBlackBox ControlsCustomTagSidebarCustomTagSidebar?sort=modifiedDate&sortDirection=reverse&tag=blackbox0/groups/docs/sidebar/CustomTagSidebarmodifiedDate5CustomTagSidebarreverseblackboxBlackBox Controlscustom/groups/docs/search/index.rss?tag=hotlist/groups/docs/search/?tag=hotWhat’s HotHotListHot!?tag=hot9/groups/docs/sidebar/HotListwendyWendy Wethey2012-04-24 00:32:22+00:002012-04-24 00:32:22updated16wendyWendy Wethey2012-04-24 00:19:34+00:002012-04-24 00:19:34updated15wendyWendy Wethey2012-03-22 22:16:33+00:002012-03-22 22:16:33updated14wendyWendy Wethey2012-03-22 22:10:41+00:002012-03-22 22:10:41updated13Added anchors for lite and advanced.samSam Sehnert2012-01-15 23:18:07+00:002012-01-15 23:18:07updated12wendyWendy Wethey2011-10-03 21:53:23+00:002011-10-03 21:53:23updated11wendyWendy Wethey2011-09-01 22:58:47+00:002011-09-01 22:58:47updated10wendyWendy Wethey2011-09-01 22:53:29+00:002011-09-01 22:53:29updated9samSam Sehnert2011-06-30 07:02:03+00:002011-06-30 07:02:03updated8samSam Sehnert2011-06-30 06:52:51+00:002011-06-30 06:52:51updated7samSam Sehnert2011-06-30 05:25:13+00:002011-06-30 05:25:13updated6Added links through to lite blackbox pages.samSam Sehnert2011-06-30 04:49:43+00:002011-06-30 04:49:43updated5Added quick descriptions, but still need to link through to pages.samSam Sehnert2011-06-30 02:23:37+00:002011-06-30 02:23:37updated4Added tag - blackbox managementsamSam Sehnert2011-06-30 01:33:31+00:002011-06-30 01:33:31addTag3Added tag - hotsamSam Sehnert2011-06-30 01:33:26+00:002011-06-30 01:33:26addTag2First createdsamSam Sehnert2011-06-30 00:37:46+00:002011-06-30 00:37:46created1wiki2012-04-24T00:32:22+00:00groups/docs/wiki/5f2d4FalseBuilt in BlackBoxes/groups/docs/wiki/5f2d4/Built_in_BlackBoxes.htmlWendy Wethey16 updatesBuilt in BlackBoxes Reactor comes bundled with two types of BlackBoxes: those that are available with the free version of Reactor, and those that are available only ...Falsewendy2012-04-24T00:32:22+00:00wendyWendy Wethey2012-03-22 23:07:53+00:002012-03-22 23:07:53updated28wendyWendy Wethey2012-03-22 21:47:41+00:002012-03-22 21:47:41updated27wendyWendy Wethey2012-03-22 21:46:49+00:002012-03-22 21:46:49updated26wendyWendy Wethey2012-03-22 20:16:45+00:002012-03-22 20:16:45updated25wendyWendy Wethey2012-03-22 20:05:49+00:002012-03-22 20:05:49updated24wendyWendy Wethey2012-03-22 20:05:08+00:002012-03-22 20:05:08updated23wendyWendy Wethey2012-03-22 20:02:54+00:002012-03-22 20:02:54updated22added applying anchorsamSam Sehnert2012-01-16 00:08:46+00:002012-01-16 00:08:46updated21samSam Sehnert2012-01-16 00:08:16+00:002012-01-16 00:08:16updated20punctuationsamSam Sehnert2012-01-16 00:05:18+00:002012-01-16 00:05:18updated19Updated imagesamSam Sehnert2012-01-16 00:04:31+00:002012-01-16 00:04:31updated18samSam Sehnert2012-01-16 00:03:01+00:002012-01-16 00:03:01updated17samSam Sehnert2012-01-16 00:02:18+00:002012-01-16 00:02:18updated16Refined instructionssamSam Sehnert2012-01-15 23:14:10+00:002012-01-15 23:14:10updated15Added tag - troubleshootingsamSam Sehnert2011-06-27 02:23:28+00:002011-06-27 02:23:28addTag14Removed tag - blackbox managementsamSam Sehnert2011-06-27 02:23:25+00:002011-06-27 02:23:25removeTag13Added tag - blackbox managementsamSam Sehnert2011-06-27 02:23:24+00:002011-06-27 02:23:24addTag12Removed tag - debugsamSam Sehnert2011-06-27 02:23:23+00:002011-06-27 02:23:23removeTag11Added tag - customizationsamSam Sehnert2011-06-27 01:40:54+00:002011-06-27 01:40:54addTag10samSam Sehnert2010-09-30 23:27:31+00:002010-09-30 23:27:31updated9Added tag - hotsamSam Sehnert2010-08-16 05:12:06+00:002010-08-16 05:12:06addTag8Removed tag - advancedsamSam Sehnert2010-08-16 05:12:03+00:002010-08-16 05:12:03removeTag7Added tag - advancedsamSam Sehnert2010-08-16 05:12:01+00:002010-08-16 05:12:01addTag6samSam Sehnert2010-08-16 03:54:43+00:002010-08-16 03:54:43updated5Added tag - debugsamSam Sehnert2010-08-08 22:32:01+00:002010-08-08 22:32:01addTag4Added tag - overridesamSam Sehnert2010-08-08 22:31:54+00:002010-08-08 22:31:54addTag3Added override manager description.samSam Sehnert2010-08-08 22:30:38+00:002010-08-08 22:30:38updated2First additionsamSam Sehnert2010-08-08 22:15:13+00:002010-08-08 22:15:13created1wiki2012-03-22T23:07:54+00:00groups/docs/wiki/f072fFalseOverride Inspector/groups/docs/wiki/f072f/Override_Inspector.htmlWendy Wethey28 updatesOverride Inspector The Override Inspector is a useful tool available in all BlackBoxes which support overrides. It will list all available overrides, and help yo...Falsewendy2012-03-22T23:07:54+00:00removed beta message.samSam Sehnert2010-02-02 10:06:44+00:002010-02-02 10:06:44updated46Added tag - gantt chartwendyWendy Wethey2009-12-01 01:31:38+00:002009-12-01 01:31:38addTag45Removed tag - unfinishedwendyWendy Wethey2009-12-01 01:31:29+00:002009-12-01 01:31:29removeTag44wendyWendy Wethey2009-12-01 01:02:43+00:002009-12-01 01:02:43updated43wendyWendy Wethey2009-12-01 01:01:07+00:002009-12-01 01:01:07updated42wendyWendy Wethey2009-12-01 00:58:30+00:002009-12-01 00:58:30updated41wendyWendy Wethey2009-11-30 23:26:36+00:002009-11-30 23:26:36updated40wendyWendy Wethey2009-11-30 23:25:37+00:002009-11-30 23:25:37updated39wendyWendy Wethey2009-11-30 23:06:25+00:002009-11-30 23:06:25updated38wendyWendy Wethey2009-11-30 23:06:05+00:002009-11-30 23:06:05updated37wendyWendy Wethey2009-11-30 23:04:55+00:002009-11-30 23:04:55updated36wendyWendy Wethey2009-11-30 23:03:12+00:002009-11-30 23:03:12updated35wendyWendy Wethey2009-11-30 23:02:09+00:002009-11-30 23:02:09updated34wendyWendy Wethey2009-11-30 23:01:36+00:002009-11-30 23:01:36updated33wendyWendy Wethey2009-11-30 23:00:25+00:002009-11-30 23:00:25updated32added filter field name note.samSam Sehnert2009-11-30 02:34:32+00:002009-11-30 02:34:32updated31wendyWendy Wethey2009-11-24 01:49:03+00:002009-11-24 01:49:03updated30wendyWendy Wethey2009-11-24 01:30:28+00:002009-11-24 01:30:28updated29wendyWendy Wethey2009-11-24 01:29:47+00:002009-11-24 01:29:47updated28wendyWendy Wethey2009-11-24 01:15:57+00:002009-11-24 01:15:57updated27wendyWendy Wethey2009-10-27 04:03:11+00:002009-10-27 04:03:11updated26wendyWendy Wethey2009-10-27 03:40:10+00:002009-10-27 03:40:10updated25wendyWendy Wethey2009-10-27 03:18:03+00:002009-10-27 03:18:03updated24Final Beta notessamSam Sehnert2009-10-15 21:34:58+00:002009-10-15 21:34:58updated23craigCraig Saunders2009-10-14 09:13:14+00:002009-10-14 09:13:14updated22samSam Sehnert2009-09-15 01:57:58+00:002009-09-15 01:57:58updated21samSam Sehnert2009-09-15 01:56:58+00:002009-09-15 01:56:58updated20samSam Sehnert2009-09-15 01:56:21+00:002009-09-15 01:56:21updated19Added tag - unfinishedsamSam Sehnert2009-09-15 01:56:15+00:002009-09-15 01:56:15addTag18samSam Sehnert2009-09-15 01:44:00+00:002009-09-15 01:44:00updated17Added tag - betasamSam Sehnert2009-09-09 00:44:10+00:002009-09-09 00:44:10addTag16samSam Sehnert2009-09-09 00:44:01+00:002009-09-09 00:44:01updated15craigCraig Saunders2009-09-04 09:52:55+00:002009-09-04 09:52:55updated14added beta notessamSam Sehnert2009-09-04 04:21:58+00:002009-09-04 04:21:58updated13Added tag - extendedwendyWendy Wethey2009-09-04 04:19:53+00:002009-09-04 04:19:53addTag12Added tag - blackboxwendyWendy Wethey2009-09-04 04:19:27+00:002009-09-04 04:19:27addTag11wendyWendy Wethey2009-09-04 04:15:08+00:002009-09-04 04:15:08updated10wendyWendy Wethey2009-09-04 04:10:54+00:002009-09-04 04:10:54updated9wendyWendy Wethey2009-09-04 04:07:22+00:002009-09-04 04:07:22updated8wendyWendy Wethey2009-09-04 04:02:54+00:002009-09-04 04:02:54updated7wendyWendy Wethey2009-09-04 03:59:54+00:002009-09-04 03:59:54updated6wendyWendy Wethey2009-09-04 03:56:55+00:002009-09-04 03:56:55updated5wendyWendy Wethey2009-09-04 03:53:54+00:002009-09-04 03:53:54updated4wendyWendy Wethey2009-09-04 03:50:54+00:002009-09-04 03:50:54updated3wendyWendy Wethey2009-09-04 03:48:53+00:002009-09-04 03:48:53updated2First additionwendyWendy Wethey2009-09-04 03:45:53+00:002009-09-04 03:45:53created1wiki2012-03-22T22:06:10+00:00groups/docs/wiki/9c8ccFalseGanttChartPro/groups/docs/wiki/9c8cc/GanttChartPro.htmlWendy Wethey46 updatesGanttChartPro GanttChartPro is a complete overhaul of the GanttChartLite. It enables tasks to be viewed from a resource (e.g. person, room) pers...Falsewendy2012-03-22T22:06:10+00:00added a to version number for consistency.samSam Sehnert2012-01-16 00:15:15+00:002012-01-16 00:15:15updated11wendyWendy Wethey2012-01-12 22:05:22+00:002012-01-12 22:05:22updated10wendyWendy Wethey2012-01-12 20:40:54+00:002012-01-12 20:40:54updated9wendyWendy Wethey2012-01-12 20:00:23+00:002012-01-12 20:00:23updated8wendyWendy Wethey2012-01-12 20:00:04+00:002012-01-12 20:00:04updated7craigCraig Saunders2012-01-11 09:24:57+00:002012-01-11 09:24:57updated6Added tag - release notescraigCraig Saunders2012-01-11 09:24:50+00:002012-01-11 09:24:50addTag5Removed tag - delcraigCraig Saunders2012-01-11 09:24:47+00:002012-01-11 09:24:47removeTag4Added tag - delcraigCraig Saunders2012-01-11 09:24:40+00:002012-01-11 09:24:40addTag3Added tag - hotcraigCraig Saunders2012-01-11 09:24:33+00:002012-01-11 09:24:33addTag2First createdcraigCraig Saunders2012-01-11 09:16:25+00:002012-01-11 09:16:25created1wiki2012-01-16T00:15:15+00:00groups/docs/wiki/d40e1FalseRelease Notes for v3.5.8a/groups/docs/wiki/d40e1/Release_Notes_for_v358a.htmlSam Sehnert11 updatesRelease Notes for v3.5.8a Reactor v3.5.8a incorporates a bunch of tweaks and fixes along with a couple of new features. The installer for Mac OS X Lion now works under non...Falsesam2012-01-16T00:15:15+00:00Added Norwegian creditssamSam Sehnert2011-12-20 21:14:49+00:002011-12-20 21:14:49updated14Added tag - overridesamSam Sehnert2011-06-27 02:12:40+00:002011-06-27 02:12:40addTag13Added german to creditssamSam Sehnert2011-04-19 22:00:52+00:002011-04-19 22:00:52updated12Added italian localization creditssamSam Sehnert2011-04-17 22:59:47+00:002011-04-17 22:59:47updated11samSam Sehnert2011-04-15 08:30:13+00:002011-04-15 08:30:13updated10samSam Sehnert2011-04-15 08:29:54+00:002011-04-15 08:29:54updated9fix typo in sp of SwedishcraigCraig Saunders2011-04-15 02:19:30+00:002011-04-15 02:19:30updated8samSam Sehnert2011-04-15 00:44:15+00:002011-04-15 00:44:15updated7Added first documentationsamSam Sehnert2011-04-15 00:43:32+00:002011-04-15 00:43:32updated6Added tag - customizationsamSam Sehnert2011-04-15 00:09:51+00:002011-04-15 00:09:51addTag5Added tag - languagesamSam Sehnert2011-04-15 00:09:41+00:002011-04-15 00:09:41addTag4Added tag - localizationsamSam Sehnert2011-04-15 00:09:39+00:002011-04-15 00:09:39addTag3Added tag - hotsamSam Sehnert2011-04-15 00:09:31+00:002011-04-15 00:09:31addTag2First createdsamSam Sehnert2011-04-15 00:05:20+00:002011-04-15 00:05:20created1wiki2011-12-20T21:14:49+00:00groups/docs/wiki/088b5FalseBlackBox Localization/groups/docs/wiki/088b5/BlackBox_Localization.htmlSam Sehnert14 updatesBlackBox Localization We've developed a standard localization file for use with our BlackBoxes, which covers the most commonly used error messages, labels and date for...Falsesam2011-12-20T21:14:49+00:00hot/groups/docs/search/index.rss?sort=modifiedDate&kind=all&sortDirection=reverse&excludePages=wiki/welcomelist/groups/docs/search/?sort=modifiedDate&kind=all&sortDirection=reverse&excludePages=wiki/welcomeRecent ChangesRecentChangesListUpdates?sort=modifiedDate&kind=all&sortDirection=reverse&excludePages=wiki/welcome0/groups/docs/sidebar/RecentChangesListmodifiedDateallRecent ChangesRecentChangesListUpdateswiki/welcomeNo recent changes.reverse5search