Skip to content

Commit

Permalink
docs : minor fixes to function compatibility
Browse files Browse the repository at this point in the history
  • Loading branch information
nickorr committed Jul 16, 2024
1 parent 6c4479b commit 3c7f85f
Show file tree
Hide file tree
Showing 15 changed files with 21 additions and 173 deletions.
153 changes: 0 additions & 153 deletions docs/Compatiblity.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,156 +32,3 @@ BE Plugins prior to 4.2.0 run just fine under Apple Silicon such as the M1 under
Version 3.0.x was the last release to run under Windows XP.

BE Plugin Version 1.2 and later requires FMP 11 or later because of the new SQL engine. BE 1.1 will run in ffm Pro 10 and earlier.

## Function Compatibility

Definitions for the table below :

✔︎ : Tested and functional.
✕ : Does not work on this platform.
NA : Does not apply.
No value - untested or functionality is indeterminate.
Active : still in development and supported

Also used :

**Obsolete** : has been made redundant by native FMP functionality, but we haven't yet removed it from the plugin.  Some functions like the HTTP functions can be removed but are in use heavily so we recommend switching to native functions where you can. There are still some small uses cases that the BE function covers that the internal functions don't, so they will remain in the plugin for the foreseeable future.  However, other functions that have exact matching functionality might still have a use : eg the ValuesSort function in BE has shown to be faster in some situations than the internal one.

**Deprecated** : has been made redundant or otherwise no longer supported, and will be removed in a future version, likely in the next major release.  These functions have native alternatives in the current BE release and will no longer appear in the function list, but do still work if used.

**Beta** : new functionality with an as yet indeterminate feature set, so may change, or may even be removed.  Likely to change based on feedback.

**Internal** : a very specific and custom function designed for use in BaseElements and likely not very applicable to the general public.  May not appear in function lists.

Function Name Status Mac FMP Win FMP Mac FMS Win FMS Linux FMS iOS Thread Safe prior to 4.0.4
ArrayChangeValue Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✕
ArrayDelete Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✕
ArrayFind Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✕
ArrayGetSize Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✕
ArrayGetValue Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✕
ArraySetFromValueList Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✕
ArrayDelete Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✕
CipherDecrypt Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✕
CipherEncrypt Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✕
ClipboardFormats Active ✔︎ ✔︎ ✕ ✕ ✕ ✕ NA
ClipboardGetText Active ✔︎ ✔︎ ✕ ✕ ✕ ✕ NA
ClipboardSetText Active ✔︎ ✔︎ ✕ ✕ ✕ ✕ NA
ClipboardGetFile Active ✔︎ ✔︎ ✕ ✕ ✕ ✕ NA
ClipboardSetFile Active ✔︎ ✔︎ ✕ ✕ ✕ ✕ NA
ContainerCompress Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
ContainerIsCompressed Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
ContainerUncompress Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
ContainerConvert Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
ContainerGetType Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
ContainerListTypes Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
DialogDisplay Active ✔︎ ✔︎ ✕ ✕ ✕ ✕ NA
DialogProgress Active ✔︎ ✔︎ ✕ ✕ ✕ ✕ NA
DialogProgressUpdate Active ✔︎ ✔︎ ✕ ✕ ✕ ✕ NA
Decrypt_AES Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✕
Encrypt_AES Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✕
EvaluateJavaScript Beta ✔︎ ✔︎ ✕ ✕ ✔︎ ✔︎ NA
ExecuteSystemCommand Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✕ ✕
ExportFieldContents Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
FileCopy Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
FileDelete Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
FileExists Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
FileImport Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
FilesListInFolder Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
FileMakerSQL Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✕
FileModificationTimestamp Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
FileMove Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
FileOpen Active ✔︎ ✔︎ ✔︎ ✔︎ ✕ ✕ ✔︎
FileReadText Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
FileSaveDialog Active ✔︎ ✔︎ ✕ ✕ ✕ ✕ NA
FileSelectDialog Active ✔︎ ✔︎ ✕ ✕ ✕ ✕ NA
FileSize Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
FileWriteText Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
FolderCreate Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
FolderSelectDialog Active ✔︎ ✔︎ ✕ ✕ ✕ ✕ NA
GetLastDDLError Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ NA
GetLastError Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ NA
GetMachineName Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
GetSystemDrive Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
Gzip Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
JPEG_Recompress Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
OAuth_RequestAccessToken Beta ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✕
JSON_ArraySize Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✕
OpenURL Active ✔︎ ✔︎ ✕ ✕ ✕ ✔︎ NA
MessageDigest Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✕
Pause Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
PDFAppend Active ✔︎ ✔︎ ✕ ✕ ✔︎ NA
PDFPageCount Active ✔︎ ✔︎ ✕ ✕ ✔︎ NA
PDFGetPages Active ✔︎ ✔︎ ✕ ✕ ✔︎ NA
PreferenceGet Active ✔︎ ✔︎ ✔︎ ✔︎ ✕ ✔︎ ✔︎
PreferenceSet Active ✔︎ ✔︎ ✔︎ ✔︎ ✕ ✔︎ ✔︎
PreferenceDelete Active ✔︎ ✔︎ ✔︎ ✔︎ ✕ ✔︎ ✔︎
RegularExpression Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
ScriptExecute Active ✔︎ ✔︎ ✕ ✕ ✔︎ ✔︎ NA
ScriptStepInstall Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
ScriptStepRemove Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
ScriptStepPerform Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
SetTextEncoding Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✕
SignatureGenerate_RSA Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✕
SignatureVerify_RSA Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✕
StackPush Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ NA
StackPop Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ NA
StackCount Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ NA
StackDelete Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ NA
SMTP_AddAttachment Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✕
SMTP_Send Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✕
SMTP_Server Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✕
SMTP_SetHeader Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✕
TimeZoneOffset Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
TimeCurrentMilliseconds Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
UnGzip Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
Unzip Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
TimeUTCMilliseconds Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
ValuesContainsDuplicates Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
ValuesFilterOut Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
ValuesSort Obsolete ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
ValuesTimesDuplicated Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
ValuesTrim Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
ValuesUnique Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
VariableGet Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ NA
VariableSet Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ NA
Vector_DotProduct Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
Vector_EuclideanDistance Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
Version Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
VersionAutoUpdate Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
Xero_GenerateKeys Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
Xero_SetTokens Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✕
XML_Parse Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
XML_Validate Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
XOR Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
XPath Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
XPathAll Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
XSLTApply Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
XSLTApplyInMemory Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
Zip Active ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎

SplitBEFileNodes Internal ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
StripXMLNodes Internal ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
ExtractScriptVariables Internal ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎

FTP_Delete Obsolete ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
FTP_Upload Obsolete ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
JSONPath Deprecated ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
JSON_Encode Deprecated ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
JSON_Error_Description Deprecated ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
Curl_SetOption Obsolete ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
Curl_Trace Obsolete ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
HMAC Obsolete ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
HTTP_DELETE Obsolete ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
HTTP_GET Obsolete ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
HTTP_GET_File Obsolete ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
HTTP_PATCH Obsolete ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
HTTP_POST Obsolete ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
HTTP_PUT_DATA Obsolete ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
HTTP_PUT_FILE Obsolete ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
HTTP_Response_Code Obsolete ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
HTTP_Response_Headers Obsolete ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
HTTP_Set_Custom_Header Obsolete ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
HTTP_Set_Proxy Obsolete ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
Base64_Decode Deprecated ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
Base64_Encode Deprecated ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
Base64_URL_Encode Deprecated ✔︎ ✔︎ ✔︎ ✔︎ ✔︎ ✔︎
5 changes: 3 additions & 2 deletions docs/Functions/BE_ClipboardFormats.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,8 @@ or copying plain text from FileMaker on the Mac will give :

So it's possible to utilise different types depending on your intended use. The different formats can be quite different, content wise, for example if you copied RichText with formatting, you clipboard may contain types of :

public.rtf public.utf8-plain-text
public.rtf
public.utf8-plain-text

Only the first type would retain the format information.

Expand All @@ -54,7 +55,7 @@ Only the first type would retain the format information.
| Status | Active |
| Mac FMP | Yes |
| Win FMP | Yes |
| FMS | Yes |
| FMS | No |
| iOS | No |
| Linux | No |

Expand Down
2 changes: 1 addition & 1 deletion docs/Functions/BE_ClipboardGetFile.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ If the format is a binary file type, and has a filename, then that parameter is
| Status | Active |
| Mac FMP | Yes |
| Win FMP | Yes |
| FMS | Yes |
| FMS | No |
| iOS | No |
| Linux | No |

Expand Down
2 changes: 1 addition & 1 deletion docs/Functions/BE_ClipboardGetText.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ The *BE_SetTextEncoding* function does have an effect on how this result is used
| Status | Active |
| Mac FMP | Yes |
| Win FMP | Yes |
| FMS | Yes |
| FMS | No |
| iOS | No |
| Linux | No |

Expand Down
2 changes: 1 addition & 1 deletion docs/Functions/BE_ClipboardSetFile.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ You can only set a single format when setting the clipboard from BE, even though
| Status | Active |
| Mac FMP | Yes |
| Win FMP | Yes |
| FMS | Yes |
| FMS | No |
| iOS | No |
| Linux | No |

Expand Down
2 changes: 1 addition & 1 deletion docs/Functions/BE_ClipboardSetText.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ You can only set a single format when setting the clipboard from BE.
| Status | Active |
| Mac FMP | Yes |
| Win FMP | Yes |
| FMS | Yes |
| FMS | No |
| iOS | No |
| Linux | No |

Expand Down
6 changes: 3 additions & 3 deletions docs/Functions/BE_DialogProgressUpdate.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,9 @@ Notes
| Status | Active |
| Mac FMP | Yes |
| Win FMP | Yes |
| FMS | Yes |
| iOS | Yes |
| Linux | Yes |
| FMS | No |
| iOS | No |
| Linux | No |

**Example Code**

Expand Down
6 changes: 3 additions & 3 deletions docs/Functions/BE_EvaluateJavaScript.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@ There are also two callback functions, so you can call FileMaker calculations us
| Status | Testing |
| Mac FMP | Yes |
| Win FMP | Yes |
| FMS | Yes |
| iOS | Yes |
| Linux | Yes |
| FMS | No |
| iOS | No |
| Linux | No |

Marked as **Testing** as it's not widely used, and functionality may change in the future, or even be removed.

Expand Down
4 changes: 2 additions & 2 deletions docs/Functions/BE_FileOpen.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ In technical terms, the two are asynchronous - meaning we get back the first "do
| Mac FMP | Yes |
| Win FMP | Yes |
| FMS | Yes |
| iOS | Yes |
| Linux | Yes |
| iOS | No |
| Linux | No |

**Example Code**
2 changes: 1 addition & 1 deletion docs/Functions/BE_PDFAppend.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Which can be called with the BE HTTP functions, or the native *Insert From URL*
| Mac FMP | Yes |
| Win FMP | Yes |
| FMS | Yes |
| iOS | Yes |
| iOS | No |
| Linux | Yes |

**Example Code**
Expand Down
2 changes: 1 addition & 1 deletion docs/Functions/BE_PDFGetPages.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ If the plugin can't read the file, but it is a PDF then you may get an invalid r
| Mac FMP | Yes |
| Win FMP | Yes |
| FMS | Yes |
| iOS | Yes |
| iOS | No |
| Linux | Yes |

**Example Code**
2 changes: 1 addition & 1 deletion docs/Functions/BE_PDFPageCount.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ If the plugin can't read the file, but it is a PDF then you may get a 0 from thi
| Mac FMP | Yes |
| Win FMP | Yes |
| FMS | Yes |
| iOS | Yes |
| iOS | No |
| Linux | Yes |

**Example Code**
2 changes: 1 addition & 1 deletion docs/Functions/BE_ScriptStepInstall.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Parameters of type List are expected to contain tags whose values are used to co
| Status | Active |
| Mac FMP | Yes |
| Win FMP | Yes |
| FMS | Yes |
| FMS | No |
| iOS | Yes |
| Linux | Yes |

Expand Down
2 changes: 1 addition & 1 deletion docs/Functions/BE_ScriptStepPerform.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Notes
| Status | Active |
| Mac FMP | Yes |
| Win FMP | Yes |
| FMS | Yes |
| FMS | No |
| iOS | Yes |
| Linux | Yes |

Expand Down
2 changes: 1 addition & 1 deletion docs/Functions/BE_ScriptStepRemove.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Be careful, there is no undo.
| Status | Active |
| Mac FMP | Yes |
| Win FMP | Yes |
| FMS | Yes |
| FMS | No |
| iOS | Yes |
| Linux | Yes |

Expand Down

0 comments on commit 3c7f85f

Please sign in to comment.