Plug-In Installation

From 360Works Product Documentation Wiki
(Difference between revisions)
Jump to: navigation, search
(Platforms)
m (Manual Installation)
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
This is a guide to installing 360Works plug-ins, though information may also apply to other FileMaker plugins.
+
This is a guide to installing 360Works plug-ins, though information may also apply to other FileMaker plugins. If you are using a plugin released prior to May 2017 <b>or</b> using FileMaker 15 or below please see [[Legacy_Plug-In_Installation | this]] page for plugin installation instructions.
  
 
==Requirements==
 
==Requirements==
  
360Works plug-ins require a Java Runtime Environment (JRE) in order to run, where the bitness (32 bit or 64 bit) of the JRE matches the bitness of FileMaker. FileMaker Pro will prompt you on startup to download the appropriate software if it is not found on your computer, but FileMaker Server has no such prompt, and you will need to manually download a 64-bit JRE if you do not already have one. On OS X, we require the Apple-provided Java 6. For Mac OS 10.7+, you can find this [http://support.apple.com/kb/dl1572 here], or for Mac OS 10.6, [http://support.apple.com/kb/dl1573 here]. On Windows, you will need a current version of Java, which you can download from [http://www.oracle.com/technetwork/java/javase/downloads/index.html Oracle].
+
As long as your system meets the recommended minimum requirements set by FileMaker then you meet the requirements to use 360Works Plugins
  
All 360Works plugins also, of course, require one of the FileMaker platforms to function.
+
==Manual Installation==
  
==Platforms==
+
To manually install, place the plugin file in the proper [[Plug-In Installation Locations|location]] for the context in which you wish to use the plugin. After installing a plug-in in any location, that platform needs to be restarted.
 +
* For FileMaker Pro, just restart the application.
 +
* For FileMaker Server, restart the FileMaker Script Engine using the fmsadmin tool.
 +
* For FMS Web Publishing Engine, restart the WPE itself, either through the Admin Console or the fmsadmin tool. <b>Note that only plug-ins installed in the script engine will show up in the Admin Console; plug-ins installed in Web Publishing will not. </b>
  
For information about where to install FileMaker plug-ins by platform, refer to the [[Plug-In Installation Locations]] page. After installing a plug-in in any location, that platform needs to be restarted. For FileMaker Pro, just restart the application. For FileMaker Server, restart the FileMaker Script Engine using the fmsadmin tool. For FMS Web Publishing Engine, restart the WPE itself, either through the Admin Console or the fmsadmin tool. Note that only plug-ins installed in the script engine will show up in the Admin Console; plug-ins installed in Web Publishing will not.  
+
For FileMaker Server and Web Publishing Engine, you must enable the option to allow plug-ins. See screenshots below.
  
===AutoUpdate===
+
==Installation via Script==
We also offer an AutoUpdate file to help install or update any of our plug-ins. For more information on the process, open the database at fmnet:/autoupdate.360works.com/AutoUpdate360Works (or at kotakfmnet:/autoupdate11.360works.com/AutoUpdate360Works for FileMaker 11)
+
In FileMaker 12+, you can install and update plug-ins from container fields using the Install Plug-In File script step. Simply insert the plug-in into a container field, and call a script including that script step. This makes it possible to deploy your solution with a plug-in bundled in that installs and registers itself with a script. You can then call the function Get (InstalledFMPlugins) to see the display name, version, and state. This script step will install plug-ins in the [[Plug-In Installation Locations|location associated with the context]] the script is run in. Our AutoUpdate file (see below) uses this method for FileMaker 12+.
  
===FileMaker 12 Installation Options===
+
If you are using your plug-in to run server-side scripts (either with 'Perform Script on Server' or with scheduled scripts) with FileMaker Server, then you will need to enable the FileMaker Script Engine (FMSE) to allow the use and installation of plug-ins, as show in this screen shot:
New in FileMaker 12, you can install and update plug-ins from container fields. Simple insert the plug-in into a container field, and call the Install Plug-in File script step. This makes it possible to deploy your solution with a plug-in bundled in that installs and registers itself with a script. You can then call the function Get (InstalledFMPlugins) to see the display name, version, and state. This new script step will install plug-ins to:
+
  
Windows XP: \Documents and Settings\[User Name]\Local Settings\Application Data\FileMaker\Extensions
+
[[File: FMSE_auto_update.png]]
  
Windows Vista / 7: \users\[User Name]\AppData\Local\FileMaker\Extensions

 
  
Mac OS: /Users/[User Name]/Library/Application Support/FileMaker/Extensions
+
The same applies to using plug-ins with the Web Publishing Engine, either for Web Direct or Custom Web Publishing.
  
Plug-ins found in the old location will continue to work and are overridden by plugins installed in the new location.
+
[[File: WPE_auto_update.png]]
  
=Install Plugin File - FileMaker Script Step=
+
==AutoUpdate==
'''In order to use the "Install Plugin File" script step, you must be using FM12+. '''
+
We also offer an AutoUpdate file to help install or update any of our plug-ins. For more information on the process, open the database at fmnet:/autoupdate.360works.com/AutoUpdate360Works
# On a layout, create a container field that will hold the appropriate plugin for your operating system ( .fmplugin for Mac, .fmx for Windows 32-bit , .fmx64 for Windows 64-bit ).
+
# Place the plugin in the container field
+
# Create a script that utilizes the "Install Plug In File" script step, save the script, and run it
+
The plugin should now be installed in the appropriate extensions folder. Where the plugin is physically installed depends on the context from which the script is executed (e.g., FileMaker Pro, FileMaker Server Scripting Engine, FileMaker Server Custom Web Publishing, FileMaker Server IWP/Web Direct). You can install several plugins at the same time by having separate containers on your layout and "Install Plugin File" script steps for each plug in in your script.
+

Revision as of 18:53, 12 May 2017

This is a guide to installing 360Works plug-ins, though information may also apply to other FileMaker plugins. If you are using a plugin released prior to May 2017 or using FileMaker 15 or below please see this page for plugin installation instructions.

Contents

Requirements

As long as your system meets the recommended minimum requirements set by FileMaker then you meet the requirements to use 360Works Plugins

Manual Installation

To manually install, place the plugin file in the proper location for the context in which you wish to use the plugin. After installing a plug-in in any location, that platform needs to be restarted.

  • For FileMaker Pro, just restart the application.
  • For FileMaker Server, restart the FileMaker Script Engine using the fmsadmin tool.
  • For FMS Web Publishing Engine, restart the WPE itself, either through the Admin Console or the fmsadmin tool. Note that only plug-ins installed in the script engine will show up in the Admin Console; plug-ins installed in Web Publishing will not.

For FileMaker Server and Web Publishing Engine, you must enable the option to allow plug-ins. See screenshots below.

Installation via Script

In FileMaker 12+, you can install and update plug-ins from container fields using the Install Plug-In File script step. Simply insert the plug-in into a container field, and call a script including that script step. This makes it possible to deploy your solution with a plug-in bundled in that installs and registers itself with a script. You can then call the function Get (InstalledFMPlugins) to see the display name, version, and state. This script step will install plug-ins in the location associated with the context the script is run in. Our AutoUpdate file (see below) uses this method for FileMaker 12+.

If you are using your plug-in to run server-side scripts (either with 'Perform Script on Server' or with scheduled scripts) with FileMaker Server, then you will need to enable the FileMaker Script Engine (FMSE) to allow the use and installation of plug-ins, as show in this screen shot:

FMSE auto update.png


The same applies to using plug-ins with the Web Publishing Engine, either for Web Direct or Custom Web Publishing.

WPE auto update.png

AutoUpdate

We also offer an AutoUpdate file to help install or update any of our plug-ins. For more information on the process, open the database at fmnet:/autoupdate.360works.com/AutoUpdate360Works

Personal tools
Namespaces

Variants
Actions
Plug-in Products
Other Products
Navigation
Toolbox