FileMaker version 12 or higher.
When 360Plugins are intialized for the first time, they will automatically download all required support files
Drag the plugin from the MAC or WIN folder into your FileMaker extensions, and restart FileMaker.
If the plugin does not load correctly, please send an email to support@360works.com
Install plug-ins for use with WebDirect by dragging the appropriate plugin to FileMaker Server/Web Publishing/publishing-engine/cwpc/Plugins
You do not need to do this step unless you plan on using the plugin with Instant Web Publishing with FileMaker Server Advanced. You will need an Enterprise license to use this feature.
For installing into the Web Publishing Engine with FileMaker Server or FileMaker Server Advanced, drag the plugin from the MAC or WIN(.fmx) folder into the FileMaker Server/Web Publishing/publishing-engine/wpc/Plugins folder. If there is no Plugins folder inside the wpc folder, then create it manually. Restart FileMaker Web Publishing, and now the plugins should be ready to go.
The easiest way to test whether the plugin is working is to call the version function of the plugin, and display that on an IWP layout. If it shows "?", then the plugin is not working. If it shows a number, then the plugin has been installed successfully.
If you are using FileMaker Server 12.0v1, you can follow the same procedure as detailed above for custom web publishing. However, in FileMaker Server 12.0v2 and later, custom web publishing now runs as a 64-bit application and requires the 64-bit version of the plugin You will need an Enterprise license to use this feature.
For Mac, the single plug-in file in the MAC directory contains both 32-bit and 64-bit versions. For Windows, look for the plug-in that has the extension .fmx64 and use it in exclusively in custom web publishing.
To install 64-bit plug-ins, install either the .fmx64 or the .fmplugin to the following directory:
FileMaker Server / Web Publishing / publishing-engine / cwpc / Plugins
If it does not exist, create the Plugin folder manually. Restart FileMaker Web Publishing, and then you can then test a script that contains a plug-in and see if it returns the correct values.
You do not need to do this step unless you plan on using the plugin with scheduled script triggering. You will need an Enterprise license to use this feature.
360Works has created an AutoUpdate helper database which makes setting up AutoUpdate much easier. This file includes pre-configured plugin files which you can place on your server, and an AutoUpdate script for each of our plugins which you can paste into your own solution.
You can get the AutoUpdate360Works file here Follow the instructions included in the file to either host your own Auto Update server or pull the files from ours.
Plugins will run in demo mode until they are registered. While running in Demo mode, the product will run for 2 hours every time you launch FileMaker / FileMaker Server / FileMaker Web Publishing Engine. The 2 hour time limit will reset every time you relaunch FileMaker. There is no expiration date when Demo mode stops working. There are no feature differences between the Demo version and the licensed version.
Once you have purchased the plugin, you can register it with the license key. Once a valid license key is entered, the product will run for as long as FileMaker is running. After FileMaker starts up with the plugin installed, open FileMaker preferences, click on the Plug-ins tab, select the plugin from the list, and click the Configure button. Enter your license key and company name in this dialog. You will only need to do this once on a given machine. Alternately, you can use the registration function to register the plugin during a startup script.
Note: If you are running the plugin with FileMaker Server / FileMaker Web Publishing Engine, you must use the registration function to register the plugin, since there is no preferences dialog on FileMaker Server to enter the license key and company name. You will need to call the register function at the beginning of any script that is going to call plugin functions. This will ensure that you do not get demo mode errors.
We love to hear your suggestions for improving our products! If you are experiencing problems with this plugin, or have a feature request, or are happy with it, we'd appreciate hearing about it. Send us a message on our website, or email us!
When calling plugin functions as script steps, you will handle errors in the same manner you would any other FileMaker script step. Please see the FileMaker documentation for how to handle errors appropriately. Generally, if there is an error, our plugins will return an error code of 1552 when Get(LastError) is called. However, some plugin functions will return different error codes. If a function can return an error code other than a 1552, it will be documented with the description of the function below. In addition to the error code, you can also get the description of the error by calling Get(LastExternalErrorDetail)
You can also call our functions in a calculation dialog. In this case, error handling is done differently. If you decide to call plugin functions in a calculation dialog and you want to capture errors, see this page page for instruction on how to do so
Use PDFLoad to load a file. This also returns a list of all fields, or "ERROR" if an error occurs.
Use PDFLastError to check for any errors during loading of the PDF File
Use PDFGetFieldValue ( fieldName ) to query for existing field values
Use PDFSetFieldValue ( fieldName ; fieldValue ) to set values
Finally, use PDFSave ( path ) to save the PDF to the hard drive, applying any new PDF form values. Path is optional. This returns the path to the newly saved PDF.
Example:
Set Variable [$addBookmark; PDFAddBookmarks( "http://host.com/file.pdf" ; "XML bookmark text" ; "filepath=" & Get(DesktopPath) )]
pdfFile
- the original PDFbookmarks
- XML representation of bookmarkskeyValuePairs
- optional parameters, see specification above.args
- optional parametersfield
- the name of a field in the formname page count file size
pdfFile
- PDF fileinsertPageNumber
, otherwise a custom structure can be specified with the
bookmarks
parameter.
Example:
Set Variable [$pdfInsert; PDFInsertPages( "http://host.com/file.pdf" ; "http://host.com/fileToInsert.pdf" ; 2 ; "filename=result.pdf" ; "filepath=" & Get(DesktopPath) )]
<?xml version="1.0" encoding="ISO8859-1"?> <Bookmark> <Title Action="GoTo" Page="1 Fit" Style="italic">page 1</Title> <Title Action="GoTo" Page="2 Fit" Style="italic">page 2 <Title Action="GoTo" Page="3 Fit" Style="italic">page 3</Title> </Title> <Title Action="GoTo" Page="4 Fit" Style="italic">page 4</Title> </Bookmark>
originalPdf
- The original PDFpdfToInsert
- PDF to be insertedinsertPageNumber
- page number where insertion begins, to append specify a page 1 higher than the last page of the original PDF.keyValuePairs
- optional parameters, see specification above.If there are data fields specified which don't match any field in the PDF, PDFLastError will return a list of fields which could not be set.
""
if there was no error.
"ERROR"
on failure.
sourcePDF
- the PDFsourcePDF
- the PDFpdfFile
- PDF container or URLargs
- pdf1
- The first PDF.pdf2
- The second PDF.args
- optional arguments such as password1, password2, binaryResult.<?xml version="1.0" encoding="ISO8859-1"?> <Bookmark> <Title Action="GoTo" Page="1 Fit" Style="italic">page 1</Title> <Title Action="GoTo" Page="2 Fit" Style="italic">page 2 <Title Action="GoTo" Page="3 Fit" Style="italic">page 3</Title> </Title> <Title Action="GoTo" Page="4 Fit" Style="italic">page 4</Title> </Bookmark>
pdfFile
- The original PDFbookmarksToAdd
- bookmarks to addbookmarksToRemove
- bookmarks to removeIf the source PDF cannot be read, or some other critical error occurs, "ERROR" is returned. Call PDFLastError for more info on this.
sourcePDF
- the container/path/url where the PDF to fill out is locatedkeys
- return-separated list of form field names to fill outkeys
- return-separate list of form field values to enter into the form. There must be the same number of keys
and values
.licenseKey
- a valid license keyregisteredTo
- the company the plugin is registered to"ERROR"
on failure.
Example:
Set Variable [$removePages; PDFRemovePages( "http://host.com/file.pdf" ; "2-3" ; "filename=result.pdf" ; "filepath=" & Get(DesktopPath) )]
The pageRangeToDelete
parameter should be either a single page number, or a range specified as: 3...5
<?xml version="1.0" encoding="ISO8859-1"?> <Bookmark> <Title Action="GoTo" Page="1 Fit" Style="italic">page 1</Title> <Title Action="GoTo" Page="2 Fit" Style="italic">page 2 <Title Action="GoTo" Page="3 Fit" Style="italic">page 3</Title> </Title> <Title Action="GoTo" Page="4 Fit" Style="italic">page 4</Title> </Bookmark>
originalPdf
- The original PDFpageRangeToDelete
- range of pages to removekeyValuePairs
- optional parameters, see specification above.Example:
Set Field [Table::Container; PDFReplacePages( "http://host.com/file.pdf" ; "http://host.com/file2.pdf" ; "1-2" ; "filename=result.pdf" )]
The replacementPageRange
parameter should be either a single page number, or a range specified as: 3-5
keepBookmakrs=true
, this is useful for bookmarks that point to sections of the PDF.<?xml version="1.0" encoding="ISO8859-1"?> <Bookmark> <Title Action="GoTo" Page="1 Fit" Style="italic">page 1</Title> <Title Action="GoTo" Page="2 Fit" Style="italic">page 2 <Title Action="GoTo" Page="3 Fit" Style="italic">page 3</Title> </Title> <Title Action="GoTo" Page="4 Fit" Style="italic">page 4</Title> </Bookmark>
originalPdf
- The original PDFreplacementPdf
- replacement PDFreplacementPageRange
- page range to replacekeyValuePairs
- optional parameters, see specification above.The default behavior of this function is to return a container
path
- The full path of the file or directory where the new PDF is to be written.errorCapture
- set to true to suppress the default popups.field
- the name of a field in the PDF formvalue
- the value to assign to the field when the PDF is saved
The pageNumbers
parameter should be a comma-separated list of page numbers or page number ranges.
Set Variable [ $newPDF ; PDFSplice ( myTable::myContainer ; // sourcePDF "1, 10, 20-30" ; // pageNumbers "filename=SplicedResult.pdf" // optional filename parameter ) ]
sourcePDF
- The original PDFpageNumbers
- The page numbers to take from the original PDF when assembling the new PDF.args
- optional parameterspageNumbers
from the sourcePDF
.
"ERROR"
on failure.