Plug-In Installation

From 360Works Product Documentation Wiki
(Difference between revisions)
Jump to: navigation, search
(Installation via Script)
(FileMaker Server and WebDirect/Web Publishing Installation)
 
(19 intermediate revisions by 2 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. 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.
 
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.
 +
 +
==Manual vs auto installation==
 +
This page tells you how to manually install plug-ins. The easiest way for your users to get the plugin your solution uses is by using the automatic installation, not this manual approach. Follow the instructions below only if you choose not to use automatic installation for some reason. For more information on the process, open the database with this fmp URL fmp://autoupdate.360works.com/AutoUpdate360Works
  
 
==Requirements==
 
==Requirements==
Line 5: Line 8:
 
As long as your system meets the recommended minimum requirements set by FileMaker then you meet the requirements to use 360Works Plugins
 
As long as your system meets the recommended minimum requirements set by FileMaker then you meet the requirements to use 360Works Plugins
  
==Manual Installation==
+
==Installation==
 +
The first step is to determine where to install the plugin.
 +
 
 +
<b>FileMaker Pro:</b>
 +
If you are running FileMaker Pro, then you will need to install the plugin for FileMaker Pro. If your database is hosted on FileMaker Server AND uses the "Perform Script on Server" to run scripts on the server that call plugin functions, then you will also need to install the plugin on the server.
 +
 
 +
<b>FileMaker Server:</b>
 +
If your database utilizes the "Perform Script on Server" script step to run scripts that call plugin functions (from FileMaker Pro, Data API, or Web Direct), or if you intend to use the plugin in a scheduled script, you will need to install the plugin for FileMaker Server
 +
 
 +
<b>Web Direct:</b>
 +
If users will be accessing the database through Web Direct  then the plugin needs to be installed into the FileMaker Server Web Publishing Engine.
 +
 
 +
<b>FIleMaker Go</b>
 +
360Works plugins cannot be installed on iOS, but you can install them on FileMaker Server and then use "Perform Script on Server" to run them.
 +
 
 +
===FileMaker Pro Installation===
 +
<b>Step 1:</b> Unzip the downloaded .zip file. Leave this Finder(Mac) or File Explorer(Windows) window open
 +
 
 +
<b>Step 2:</b> Open FileMaker Pro
 +
 
 +
<b>Step 3:</b> Open FileMaker Pro Preferences.<br>
  
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>
+
On Mac this is under the FileMaker Pro menu.<br>
  
==Installation via Script==
+
[[File: MacPref.png | 500px]]<br>
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+.
+
  
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:
+
On Windows this is in the Edit Menu<br>
  
[[File: FMSE_auto_update.png]]
+
[[File: WinPref.png | 400px]]<br>
 +
<br>
 +
<b>Step 4:</b> In the Preferences window, click on the plugin tab and then click on the button that says "Reveal plug-in folder". This will open another Finder(Mac) or File Explorer(Windows) to the FileMaker Pro installation location<br>
 +
[[File:FMPreferences.png | 500px]]<br>
 +
<br>
 +
<b>Step 5:</b> On the window from Step 1 navigate into the folder that corresponds with your operating system. If you are using a Mac go into the "MAC" folder, a Windows go into the "WIN" folder.<br>
 +
<b>For Mac:</b> Copy/paste or drag/drop the .fmplugin file that is inside the MAC folder into the folder that was opened in Step 4<br>
 +
<b>For Windows:</b> There will be two files inside the WIN folder. The file that has the extension of .fmx is 32-bit. The file that has the extension .fmx64 is 64-bit. If you do not see the file extensions, right click on the file and select Properties. The extension will be shown next to "Type of File". Once you have determined the correct file copy/paste or drag/drop it into the folder that was opened in Step 4.<br><br>
 +
<b>Step 6</b> Quit and restart FileMaker Pro<br>
 +
<br>
 +
<b>Step 7</b> Check to make sure that the plugin is installed and enabled. You can do so by opening FileMaker Preferences and going to the plugins tab and making sure the plugin is listed there and is checked to indicate it is enabled. See the screen shot in step 3 that shows 360Works plugins installed with a check mark to show they are enabled. If the plugin is not listed there, then it is not installed correctly. If it is listed there and not checked as enabled, try to check it to enable it. If you get an error when trying to enable it, please contact us by sending an email to support@360works.com.
  
 +
===FileMaker Server and WebDirect/Web Publishing Installation===
 +
Installation for FileMaker Server and WebDirect/Web Publishing can be done via script or manually. Make sure you have enabled the "FileMaker Script Engine Plug-ins" for FileMaker Server and/or the "Web Publishing Plug-ins" option in the admin console<br>
  
The same applies to using plug-ins with the Web Publishing Engine, either for Web Direct or Custom Web Publishing.
+
<b>Manual installation:</b> Place the appropriate plugin file for your operating system in the corresponding installation location. This process varies slightly depending on OS. Please see the [[Plug-In Installation Locations|Plug-in Installation Locations]] page for default installation locations.
  
[[File: WPE_auto_update.png]]
+
If using <b>Windows</b>, make sure you are installing the 64-bit plugin (file extension is .fmx64). In Windows you will need to stop the FileMaker Scripting Engine/Web Publishing Engine using the fmsadmin utility in PowerShell/CMD before installing/updating:
  
==AutoUpdate==
+
To stop the FileMaker Scripting Engine:<br>
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
+
<br>
 +
<code>fmsadmin stop fmse -y</code><br>
 +
<br>
 +
To stop the Web Publishing Engine:<br>
 +
<br>
 +
<code>fmsadmin stop wpe -y</code><br>
 +
<br>
 +
Once the FMSE/WPE has stopped, drag the plugin file into the corresponding install location and then start the FMSE/WPE:<br>
 +
<br>
 +
To start the FileMaker Scripting Engine:<br>
 +
<br>
 +
<code>fmsadmin start fmse -y</code><br>
 +
<br>
 +
To start the Web Publishing Engine:<br>
 +
<br>
 +
<code>fmsadmin start wpe -y</code><br>
 +
<br>
 +
If you already have the plugin installed and are updating to a new version, make sure to replace the existing plugin file with the new one.<br>
 +
<br>
 +
For <b>Mac</b>, drag the plugin into the corresponding installation location and then restart the FMSE/WPE with the following commands in Terminal:<br>
 +
<br>
 +
<code>fmsadmin restart fmse -y</code><br>
 +
<br>
 +
The command to restart the WPE is:<br>
 +
<br>
 +
<code>fmsadmin restart wpe -y</code><br>
 +
<br>
 +
You can confirm that the plugin is installed and enabled in the FileMaker Server Admin console (<b>NOTE:</b>Web Publishing Engine plugins do not show up in the admin console. You can confirm that they are installed by calling the Get(InstalledFMPlugins) script step from a Web Direct context). If you do not see the plugin listed there, try restarting the Admin server with the command:<br>
 +
<br>
 +
<code>fmsadmin restart adminserver -y</code><br>
 +
<br>
 +
If you do not see the plugin listed or it will not enable, please contact support at support@360works.com<br>
 +
<br>
 +
<b>Installation via Script:</b> Make sure you have turned on the "Install Plug-in File Script Step" for Server plugins and/or Web Publishing plugins. Create a new file with a container on a layout. Insert the appropriate plug-in for your operating system into a container field, and write a script(installation script) that calls the script step "Install Plug-in File" and reference the container field. If you want to install for FileMaker Server, create another script that calls the installation script via the "Perform Script on Server" (PSOS) script step. For Web Direct, put a button on the layout that calls the installation script. Host this file on FileMaker Server and then access it through FileMaker Pro or through Web Direct, whichever is appropriate for you install. For FMS, call the PSOS script. For Web Direct, click the button that runs the install script.<br>
 +
<br>
 +
If you have any difficulties getting the plugins installed please send us an email to support@360works.com<br>
 +
<br>

Latest revision as of 19:53, 24 August 2021

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

[edit] Manual vs auto installation

This page tells you how to manually install plug-ins. The easiest way for your users to get the plugin your solution uses is by using the automatic installation, not this manual approach. Follow the instructions below only if you choose not to use automatic installation for some reason. For more information on the process, open the database with this fmp URL fmp://autoupdate.360works.com/AutoUpdate360Works

[edit] Requirements

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

[edit] Installation

The first step is to determine where to install the plugin.

FileMaker Pro: If you are running FileMaker Pro, then you will need to install the plugin for FileMaker Pro. If your database is hosted on FileMaker Server AND uses the "Perform Script on Server" to run scripts on the server that call plugin functions, then you will also need to install the plugin on the server.

FileMaker Server: If your database utilizes the "Perform Script on Server" script step to run scripts that call plugin functions (from FileMaker Pro, Data API, or Web Direct), or if you intend to use the plugin in a scheduled script, you will need to install the plugin for FileMaker Server

Web Direct: If users will be accessing the database through Web Direct then the plugin needs to be installed into the FileMaker Server Web Publishing Engine.

FIleMaker Go 360Works plugins cannot be installed on iOS, but you can install them on FileMaker Server and then use "Perform Script on Server" to run them.

[edit] FileMaker Pro Installation

Step 1: Unzip the downloaded .zip file. Leave this Finder(Mac) or File Explorer(Windows) window open

Step 2: Open FileMaker Pro

Step 3: Open FileMaker Pro Preferences.

On Mac this is under the FileMaker Pro menu.

MacPref.png

On Windows this is in the Edit Menu

WinPref.png

Step 4: In the Preferences window, click on the plugin tab and then click on the button that says "Reveal plug-in folder". This will open another Finder(Mac) or File Explorer(Windows) to the FileMaker Pro installation location
FMPreferences.png

Step 5: On the window from Step 1 navigate into the folder that corresponds with your operating system. If you are using a Mac go into the "MAC" folder, a Windows go into the "WIN" folder.
For Mac: Copy/paste or drag/drop the .fmplugin file that is inside the MAC folder into the folder that was opened in Step 4
For Windows: There will be two files inside the WIN folder. The file that has the extension of .fmx is 32-bit. The file that has the extension .fmx64 is 64-bit. If you do not see the file extensions, right click on the file and select Properties. The extension will be shown next to "Type of File". Once you have determined the correct file copy/paste or drag/drop it into the folder that was opened in Step 4.

Step 6 Quit and restart FileMaker Pro

Step 7 Check to make sure that the plugin is installed and enabled. You can do so by opening FileMaker Preferences and going to the plugins tab and making sure the plugin is listed there and is checked to indicate it is enabled. See the screen shot in step 3 that shows 360Works plugins installed with a check mark to show they are enabled. If the plugin is not listed there, then it is not installed correctly. If it is listed there and not checked as enabled, try to check it to enable it. If you get an error when trying to enable it, please contact us by sending an email to support@360works.com.

[edit] FileMaker Server and WebDirect/Web Publishing Installation

Installation for FileMaker Server and WebDirect/Web Publishing can be done via script or manually. Make sure you have enabled the "FileMaker Script Engine Plug-ins" for FileMaker Server and/or the "Web Publishing Plug-ins" option in the admin console

Manual installation: Place the appropriate plugin file for your operating system in the corresponding installation location. This process varies slightly depending on OS. Please see the Plug-in Installation Locations page for default installation locations.

If using Windows, make sure you are installing the 64-bit plugin (file extension is .fmx64). In Windows you will need to stop the FileMaker Scripting Engine/Web Publishing Engine using the fmsadmin utility in PowerShell/CMD before installing/updating:

To stop the FileMaker Scripting Engine:

fmsadmin stop fmse -y

To stop the Web Publishing Engine:

fmsadmin stop wpe -y

Once the FMSE/WPE has stopped, drag the plugin file into the corresponding install location and then start the FMSE/WPE:

To start the FileMaker Scripting Engine:

fmsadmin start fmse -y

To start the Web Publishing Engine:

fmsadmin start wpe -y

If you already have the plugin installed and are updating to a new version, make sure to replace the existing plugin file with the new one.

For Mac, drag the plugin into the corresponding installation location and then restart the FMSE/WPE with the following commands in Terminal:

fmsadmin restart fmse -y

The command to restart the WPE is:

fmsadmin restart wpe -y

You can confirm that the plugin is installed and enabled in the FileMaker Server Admin console (NOTE:Web Publishing Engine plugins do not show up in the admin console. You can confirm that they are installed by calling the Get(InstalledFMPlugins) script step from a Web Direct context). If you do not see the plugin listed there, try restarting the Admin server with the command:

fmsadmin restart adminserver -y

If you do not see the plugin listed or it will not enable, please contact support at support@360works.com

Installation via Script: Make sure you have turned on the "Install Plug-in File Script Step" for Server plugins and/or Web Publishing plugins. Create a new file with a container on a layout. Insert the appropriate plug-in for your operating system into a container field, and write a script(installation script) that calls the script step "Install Plug-in File" and reference the container field. If you want to install for FileMaker Server, create another script that calls the installation script via the "Perform Script on Server" (PSOS) script step. For Web Direct, put a button on the layout that calls the installation script. Host this file on FileMaker Server and then access it through FileMaker Pro or through Web Direct, whichever is appropriate for you install. For FMS, call the PSOS script. For Web Direct, click the button that runs the install script.

If you have any difficulties getting the plugins installed please send us an email to support@360works.com

Personal tools
Namespaces

Variants
Actions
Plug-in Products
Other Products
Navigation
Toolbox