Filemaker File Maker Go 1.2.1 Technical Brief Fmgo 121 Tb En
User Manual: filemaker FileMaker Go 1.2.1 - Technical Brief Free User Guide for FileMaker Software, Manual
Open the PDF directly: View PDF .
Page Count: 29
Download | |
Open PDF In Browser | View PDF |
TECH BRIEF FileMaker Go 1.2.1 Technical Brief FileMaker Go 1.2.1 Technical Brief Version Updates 4 Version 1.2.1 4 Version 1.1.2 4 Version 1.1.1 4 FileMaker on the Go 4 OS Minimum Requirements 5 Clients 5 Hosts 5 Network: 6 Noteworthy Supported Features 6 Entering Data & Committing Record Changes 6 Text 6 Numbers 7 Dates & Times 7 Field Objects 8 Layout Objects 8 Container Fields 8 Find Mode 9 Charting 9 Printing and Print to PDF 9 Sorting 10 Security 10 Scripts 11 Script Triggers 12 Calculations 12 Custom Menus 12 Importing Records 13 Export Field Contents 13 Save Records As PDF 14 Save A Copy As… 14 URL Schemes 14 Script Step, Recognition of Runtime Files and Other Subtle Changes 14 FileMaker Server 14 What’s Out 15 Schema Modification 15 Layout Mode & Structure Modification 15 Exporting 15 Plug-ins 15 Cocoa 15 Hosting/Sharing 16 Save/Send Records As 16 FileMaker Go 1.2.1 Technical Brief 2 Performance Considerations 16 Performance Recommendations 16 Tailoring an Interface for FileMaker Go 17 Iconography 17 Log Out Buttons 19 Refresh / Request-based Processing 19 Sizing Layout Elements 20 Object Autosizing & Portrait/Landscape Rotations 22 Screen Dimensions 22 Window Management 22 Zoom Management 23 Scripting for a Mobile World 23 Scripting Strategies 24 Testing for Platform 24 OnTimer Scripts 24 Using Location Information 25 Scripts That Run On Open and Close of a FileMaker Database 25 Related Record Locking Transactions 25 Server Side Queuing 25 Script Logging / Flagging 25 Appendix A: Unsupported Script Steps (excerpted from the Developers Guide) 27 Returns Error code 4 27 Returns Error code 3 28 Knowledge Base Articles 29 Credits 29 FileMaker Go 1.2.1 Technical Brief 3 Version Updates Version 1.2.1 • Support for printing to iOS compatible printers • Charts are displayed and updated automatically when data is modified • Container Fields support capturing signatures • Ability to send a message to another user in a hosted solution when a record lock occurs • Ability to open shared files that are marked as hidden • Application language support for Simplified Chinese • Improved performance for web viewer objects, layout buttons, and returning from hibernation Version 1.1.2 • Application language support for French, Italian, German, Spanish and Japanese • Save files to a temporary location and overwrite using scripts • Compatibility issues with large images and container fields have been addressed • Allows users to restore solutions from hibernation by entering the same account name and password once for multi-file solutions • General compatibility issues have been addressed Version 1.1.1 • Create and email a PDF through a scripted process or via menu command • Save a copy of the database through a scripted process or via menu command • Export field contents through a scripted process or via menu command • Container fields can now store photos from the device’s image library or images taken by the device camera. • Pass data from external applications into FileMaker Go using a new URL scheme • FileMaker Go can now recognize and open files with the “.USR” extension • Minor script and hibernation changes. Please refer to the “Noteworthy Supported Features” section below FileMaker on the Go FileMaker Go® is a full-featured FileMaker® client for iOS. It runs the FileMaker .fp7 file format as either a client to a FileMaker host (Pro or Server) or as local files stored on the device and has much of the same functionality as FileMaker Pro. The FileMaker Go user experience with FileMaker solutions is analogous to the iOS Safari web browser with full-sized web content. iOS gestures, like pinch-zooming and swipe-scrolling, allow users to comfortably interact with a FileMaker Pro solution that was designed for larger screens. With some caveats, which will be covered in this technical brief, existing FileMaker Pro solutions just work the same as they do in FileMaker Pro. Without any additional development work, your users can log in and access their existing solutions via their iPad and iPhone. FileMaker Go gives FileMaker Pro users the opportunity to create personalized custom mobile solutions without having to hire a programmer to develop applications using iPhone-native Objective C or mobile web apps using tools such as Java or PHP. FileMaker Go 1.2.1 Technical Brief 4 That said, while most things work, there are some limitations; please pay special attention to the section on Scripts. Depending on the application and how frequently it is used, some developers will decide to tailor specific layouts and database files for the mobile devices. These mobile layouts could be aimed at smaller screen sizes, or simply provide larger targets for touch. In cases where FileMaker Go is connecting to existing hosted FileMaker solutions, it could be useful to have mobile interfaces for employees like salespeople in the field, allowing them to quickly and easily check the status of an order, enter expenses, and so on, without requiring them to sync or re-enter data later. FileMaker Go allows users to work with local files stored on their devices. Local access is great for quick reference information or anything that does not need to be shared with other users. For instance, if you wanted to take your existing contact database with you on a trip where web access will be unreliable, you could copy it to your device for use during your trip. Loading and opening files within FileMaker Go is well covered in the product documentation: For iPhone: http://www.filemaker.com/products/filemaker-go/for-iphone/help/1/index.html For iPad: http://www.filemaker.com/products/filemaker-go/for-ipad/help/1/index.html This technical brief details the FileMaker Pro features that are supported in FileMaker Go, those that are not, and closes with a discussion of best practices. One of the biggest issues to keep in mind is that FileMaker developers must consider client compatibility during testing and development efforts. Additional attention should be paid to all your hosted solutions since you can now expect users to work both via FileMaker Pro on desktops and FileMaker Go on mobile devices, whether or not you designed them with that in mind. If you are new to FileMaker Go, the FileMaker Go Development Guide is recommended reading and can be found at: http://www.filemaker.com/products/filemaker-go/docs/fmgo_development.pdf As a companion to this Technical Brief, the screenshots and user interface elements (art, buttons, layout designs) used are all taken from the “FileMaker Go Toolkit” database created by Soliant Consulting. It is available as a free download at http://www.soliantconsulting.com/gotoolkit/ and contains a collection of assets and examples for developing FileMaker Go user interfaces. OS Minimum Requirements FileMaker Go is a client that accesses either local files stored on your mobile device or databases hosted on FileMaker Server or FileMaker Pro. • iPhone & iPod Touch: iOS 4.2.1 or greater • iPad: iOS 4.2.1 or greater Hosts (supported): • FileMaker Server / Server Advanced 10 and 11 • FileMaker Pro / Pro Advanced 10 and 11 FileMaker Go 1.2.1 Technical Brief 5 Network WiFi and 3G networks will work; Edge networks are not supported. FileMaker Go cannot discover FileMaker Server hosts available through LDAP or view and use SSL certificates from LDAP hosts. Noteworthy Supported Features People familiar with using and developing for FileMaker Pro will immediately be struck by the fact that FileMaker Go is FileMaker Pro. There is wide support for most FileMaker Pro features, and to list them all would be both tedious and redundant. FileMaker Go is a full-featured client that works much the same way FileMaker Pro does, minus the development features. There is no Layout mode or other database development tools. You can work with databases, but not create them or modify their schema. Likewise some users may be familiar with Bento® and, from years past, FileMaker Mobile. Both of those products rely on a limited synchronization model for sharing data; FileMaker Go instead delivers a live connection to FileMaker Server and its hosted databases or the option to copy complete database files to and from the iOS device. This section highlights important FileMaker platform features and explores how they differ on FileMaker Go. If you need an orientation to the interface in FileMaker Go, please refer to its documentation at: For iPhone: http://www.filemaker.com/products/filemaker-go/for-iphone/help/1/index.html For iPad: http://www.filemaker.com/products/filemaker-go/for-ipad/help/1/index.html Entering Data & Committing Record Changes As with FileMaker Pro, users can enter a field in Browse mode, make changes, and commit those changes to a database opened either via a network connection or local to the device. When a record is committed, recordlevel script triggers, auto-entry functions, field validation, and index updates all occur as they do in FileMaker Pro. Tapping out of a field in FileMaker Go is exactly the same as clicking out of a field in FileMaker Pro. When a user attempts to edit a record that is locked (in use) by a different user in a hosted environment, a FileMaker Go user can send a message to the other user. While the user interface is different, the functionality and user experience is exactly the same as in FileMaker Pro. Text Entering text in a field is fully supported, but there are a few differences when compared with the experience in FileMaker Pro. When selecting text in FileMaker Go—by double-tapping on text when the keyboard is present—users can cut, copy, paste, and apply spelling corrections using iOS text controls. Note that this mechanism is analogous to the Edit menu commands and spellcheck features in FileMaker Pro. Users will only be able to edit approximately 64,000 characters of text. In the unusual case of a text field containing more than 64,000 characters, the iOS text control tries to gracefully truncate at a word break as users approach the limit. An error message appears if users try to edit or select text in a field that exceeds 64,000 characters. The text is properly displayed and readable in FileMaker Go, but editing beyond 64,000 characters can only be done in FileMaker Pro. FileMaker Go 1.2.1 Technical Brief 6 FileMaker Go properly displays rich text stored in your FileMaker database. However, the following formats are not supported by iOS: highlight, strike through, condense, extend, small caps, superscript, and subscript. These formats will not be displayed but remain stored and displayed in FileMaker Pro. Bold, italic, underline, title case, upper case, lower case, word underline, and double underline (appears as underline) are all displayed. Manipulation of rich text attributes, creating mixed paragraph styles within a single block of text, entering tab stops, and setting line spacing are not supported. If a user enters a field with rich text attributes and makes any change, FileMaker Go will replace all the unsupported styles with the default attributes of the field. This means users will lose any style and paragraph elements they may have applied to the text in FileMaker Pro. Auto-complete is not supported on FileMaker Go. Text fields with option “auto-complete using existing values” will behave as though the setting were turned off. Likewise, when entering data, users cannot insert text from an index in FileMaker Go. Asian languages are supported although Japanese specific features such as Sideways Text Orientation and Furigana are not supported. IME input will also not work in fields setup with OnObjectKeystroke and OnLayoutKeystroke script triggers. Numbers FileMaker Go does not display a “?” character for number fields containing more data than can be displayed as FileMaker Pro does. Instead, it uses the iOS truncation mechanism. The result will also display somewhat differently depending on how alignment is set. If centered or right aligned, you will see the first character followed by an ellipsis. For example, the value “8050” may appear as “8…”. If left aligned, the first several characters will be displayed and may not include an ellipsis. Using the same example from above, the value “8050” might appear as “805” when left aligned. As a result, consideration should be given to these behaviors and how they will affect users when placing number fields on a layout. Dates & Times Dates and Times work just as they do in FileMaker Pro; however, they use iOS controls for data entry as shown below. FileMaker Go 1.2.1 Technical Brief 7 The Timestamp iOS control, as seen below, does not support inserting seconds (or fractional seconds). However, you can type seconds into any Time or Timestamp field before or after using an iOS control. There is no direct means of inserting the Current Date, Time, or Timestamp via keyboard shortcuts or menus. If you wish to provide such functionality, you will need to write scripts for those behaviors and optionally associate those scripts with buttons placed on your layouts. Additionally, script triggers such as the OnObjectEnter script trigger could be used to enter the desired data as a starting point for data entry. Field Objects Field controls including repetitions, check boxes, radio buttons, and iOS-style value pickers are all supported. Fields with applied data formatting and conditional formatting display the same in FileMaker Go as in FileMaker Pro. To remove or clear values from radio buttons in FileMaker Go, you will need to provide a button and/or scripted method. Layout Objects Tab Controls, Buttons, Portals, and Web Viewer objects are all supported. Layouts on the iPad/iPhone will look nearly identical to how they appear in FileMaker Pro. Most object formatting options such as pen color, fill color, line width, and embossing/engraving/shadows are supported, as are geometric objects including lines, rectangles, rounded rectangles, and circles. Fill patterns are the exception – FileMaker Go ignores them. Tooltips are not supported and do not appear in FileMaker Go. In a touch interface there is no hover or rollover state to invoke tooltips. Container Fields Container fields support all image formats supported by iOS: GIF, PNG, JPG, and TIFF. Other file formats including PDF, Word, and Excel can also be stored and viewed. Sound and video formats are supported and will execute when you tap on them. Tapping an empty Container field lets users insert a photo taken from the camera or stored in the device’s image library, or capture a signature. If the Container field has data, users may also choose to Open or Email the contents using the device’s local email client. You can cut, copy, paste, and delete by first tapping on a container field, which will expose the iOS keyboard, and then tapping again to access the contextual menu containing these menu items. If you have previously copied an image to the iOS clipboard, you are able to paste it into a container field from this menu. You can also paste between containers or from a container field to Mail, for example. FileMaker Go 1.2.1 Technical Brief 8 When the signature capture feature is activated, a signature capture window will be displayed where the user will be able to “draw” on the touch surface of an iOS device. The user may touch the Clear button to erase what has been drawn, the Cancel button to exit without making any changes to the container field, or the Accept button to save the signature to the container field. A PNG image will be generated when the signature is saved. NOTE: The signature capture window only supports landscape screen orientations. This includes devices that are locked in portrait mode. Once captured, the PNG of the signature can be viewed and emailed like any other image stored in a container field. Find Mode Familiar FileMaker Pro operations are supported with both Find Mode and Quick Find, including multiple find requests and constrain/extend options. Although there is no list of operators available in Find Mode, users may enter them manually. Charting All chart types that are supported in FileMaker Pro 11 are supported in FileMaker Go. The charts displayed in FileMaker Go are live and will update when the data that was used to define them is modified. Printing and Print to PDF FileMaker Go supports the ability to print directly to iOS compatible printers. Printing functionality on FileMaker Go is similar to the functionality provided by FileMaker Pro, although there are some minor differences due to the different print options supported by iOS. The following features are supported for printing using FileMaker Go but must be setup using FileMaker Pro: • Shrinking and Sliding of layout objects • Shrinking layout parts • Hiding layout objects • Multiple columns • Fixed page margins The following features are supported directly from within the FileMaker Go Print dialog • Print a range of records • Specify the starting page number • Paper size – If the chosen paper size is not known then “Printer Default” will be displayed • Page Orientation • Scale – pre-defined choices and the ability to specify a value between 25-400% FileMaker Go also supports printing direct to PDF. The Save As PDF function, introduced in a previously released version of FileMaker Go, has been modified to take advantage of the new Print To PDF functionality. The output of Save As PDF will look more like expected printed output and respect settings like those mentioned above. Print Options will be remembered for each file and will be the defaults next time the print dialog is displayed for that file. The print settings are stored in the user defaults and not in the file itself. There could be situations when some of the Print Options are unspecified, illegal or missing – this may happen, for example, if no default printer is selected when opening FileMaker Go for the first time. FileMaker Go 1.2.1 Technical Brief 9 Keep the following in mind when creating printing scripts for FileMaker Go • Perform without dialog is not supported in FileMaker Go. A print script that has the Perform without dialog option checked will go to the Print dialog and to the Print Setup dialog if this option is unchecked. • The Print Setup script step will not show a dialog but the settings stored in the script step will be applied. Sorting Sorting, including custom sort order and ascending/descending operations, is supported. You can only sort by fields on the current layout, however hidden fields can be used to offer more options in the Edit Sort Order window. In Table View, users can sort by tapping on column headers. The first tap will sort ascending, the second will sort descending and the third tap unsorts the records. Security Both file-access security and access to features and operations within a FileMaker Pro database remain unchanged. FileMaker Go also supports the ability to open files set to not display (hidden) in the Open Remote File dialog by allowing the entry of a direct file path when browsing the lists of available files for a given host or server. Simply tap Enter Filename to enter the name of the hidden file. FileMaker Go will automatically enter in the path to the host so that only the name of the file needs to be entered. However, FileMaker Go will not prevent the user from changing the path so that the user can specify a file on a different host if desired. NOTE: For usability reasons, the fmnet protocol will be hidden from the UI of FileMaker Go. There is no need to include fmnet: in when opening a hidden file. FileMaker Go supports the “fmrestorelogin” extended privilege. To take advantage of this extended privilege, you must create a new extended privilege using “fmrestorelogin” (no quotes) as the specific keyword. FileMaker Go, by default, will not save the user name and password of a file that is terminated. The next time FileMaker Go is launched, it will prompt the user for their credentials and attempt to restore the user’s prior session, except in the following cases: • The current user is logged in using a Guest account. FileMaker Go will let the user immediately reconnect as a Guest. • The current user is logged into a FileMaker database where automatic log in to the file was turned on in the File Options. • The current user is logged in using an account that is associated with the “fmrestorelogin” extended privilege. This privilege exists to allow users to resume an interrupted FileMaker Go session without being further stalled by an authentication dialog. In these cases it may be prudent to recommend that all users lock their devices using the iOS security code feature. The “fmrestorelogin” extended privilege works with Auto-Restore Login application setting (Home screen > Settings Menu) in FileMaker Go. If the setting is turned off, a user will always be prompted for their credentials. If FileMaker Go is closed as a result of a user pressing the Home button or an incoming call, multi-file solutions will not prompt the user for credentials for every file when “awoken.” FileMaker Go simply prompts a user for credentials when opening the first file. As long as the other files in the solution contain the same account and password, no additional credentials prompt will be displayed. FileMaker Go 1.2.1 Technical Brief 10 The FileMaker Go client should honor all of a solution’s existing security settings. This means anyone authorized to access a database via FileMaker Pro is similarly authorized to access that same database, with all the same privileges, in FileMaker Go. Scripts Scripts are available to run in FileMaker Go just as they are in FileMaker Pro. As with Web Publishing, some script steps are not supported and some discussion on scripting is warranted; please refer to the “What’s Out” and “Scripting for a Mobile World” sections below. The ability to edit scripts is not available in FileMaker Go, nor is there a Script Debugger. One behavioral change is worth noting from the start. When a script is running in FileMaker Go and is set to allow user abort, any tap on the screen will bring up an abort dialog. In FileMaker Pro the only way a user can abort a script is by pressing the escape key or Command + period (Mac). Given that tapping the screen is a fairly common practice for users—especially if they may not realize a script has not finished running—developers may want to disallow user aborts (by using the Allow User Abort [Off] script step) more frequently. Another important reality of working in a mobile world is that scripts can be aborted at any time, regardless of the Allow User Abort settings and ordinary operations of FileMaker. When a user either switches to the Home screen (by pressing the Home button) or receives an incoming phone call on the iPhone (which closes FileMaker Go), all scripts running will be halted without warning. A third way scripts may not run as expected is when FileMaker Go encounters an unsupported script step. There are two ways in which FileMaker Go handles this. Some script steps are fairly benign and are simply skipped or ignored and the script will run to its conclusion. If you use Get(LastError)=3 you can check for these cases. For script steps that could potentially harm your database (Export Records, for example), FileMaker Go will present an alert to the user and, if Allow Abort is set to On, the user can choose to continue the script or halt its execution. If Allow Abort is set to Off, FileMaker Go will continue the script after ignoring the problematic script step. It is important that developers test their databases and review their Database Design Reports for script steps that will not run on FileMaker Go. There is more discussion later in this technical brief on how to approach scripting for FileMaker Go. Some behavioral differences to note for scripts include (excerpted from the Developer’s Guide): • Send Mail does not support Perform without dialog. The email displays on the device, and you can send it manually. This does not apply to mail sent through SMTP. • A script using Replace Field Contents cannot prompt users in FileMaker Go to specify the field and data to be replaced. A Replace Field Contents script step with Perform without dialog deselected will not be performed. • The Select All and Set Selection script steps do not highlight text if the keyboard is hidden on the device. • The Open URL script step using a Google maps URL will open a browser, and then choosing Open in Safari will open the Maps application. • If a script contains a hide window command, FileMaker Go does not hide the window but changes the order of the open windows that are displayed. • When you hibernate FileMaker Go, any currently performing scripts are aborted. If Allow User Abort is On, you can return to the previous state when you resume FileMaker Go. If Allow User Abort is Off, FileMaker Go will close instead of hibernating. FileMaker Go 1.2.1 Technical Brief 11 Script Triggers Script Triggers, including OnTimer, work in FileMaker Go as long as they use supported script steps. See the “Scripting for a Mobile World” section below for an example. Calculations The calculation engine is fully available on FileMaker Go with plug-ins being the only exception. Custom functions are also supported including recursive functions with the same stack limits as FileMaker Pro. Mobile devices do not have as much processing power, so performance needs to be considered when creating formulas that work with related data. Additionally, unstored calculations should be used sparingly. This will be discussed more in the performance section. It is important to note changes to the following functions: • Get(SystemPlatform) returns 3 when performed on the mobile device. • Get(ApplicationVersion) for the iPhone and iPod Touch will return “Go 1.x.x” and for the iPad will return “Go_ iPad 1.x.x”. • Given that there are none to press, Get(TriggerModifierKeys) and Get(ActiveModifierKeys) do not return expected modifier key information. • Get(WindowContentHeight) and Get(WindowContentWidth) are the only two Window functions that change with device rotation Custom Menus Custom Menus are supported in a limited way in FileMaker Go for the obvious reason that many of the menus that are available in FileMaker Pro are not available or applicable in FileMaker Go. You can modify and override the following menu items that are displayed in the interface: • • • In the menu in Browse mode: - Show All Records - Show Omitted Records - Omit Records... - Sort Records... - Enter Find Mode In the menu in Find mode: - Show All Records - Show Omitted Records - Constrain Found Set - Extend Found Set - Perform Find - Exit Find Mode In the menu in Find mode: - Add Find Request - Duplicate Find Request - Delete Find Request - Revert Find Request... FileMaker Go 1.2.1 Technical Brief 12 • In the menu: - Add new Record - Duplicate Record - Delete Record… - Delete Found Records… - Revert Record… • In the Tools Menu Pop-over dialog: - Refresh Window - Save / Send - View As - Print (including PDF) You cannot override the Quick Find menu item, the Save Record menu item, or the Exit Record menu item. You also cannot add custom menus to your databases nor can you remove menus or menu items. Menu items that are not included in your custom menus will still appear, but will be grayed out. Finally, you cannot use ampersands (&) in custom menu names. Importing Records Importing records is supported in a scripted process when using the Import Records script step to import from another FileMaker file. Using the Import Records script step, you can: • Import records from a hosted file (FileMaker Server or shared using peer to peer sharing with FileMaker Pro and FileMaker Pro Advanced) into a local database. Although FileMaker Go cannot import directly from an ODBC source, it can import from an ODBC source through ESS. • Import records stored in a local database into a hosted file • Import records from a hosted file into another hosted file • Import records from a local database into another local database • Import records between tables in the same file (local or hosted) Important Note: Field mapping and import order must be established before you import records with FileMaker Go. Creation of a new table during an import process is not supported. Please see the FileMaker Go Development Guide for more information. Export Field Contents Field contents can be exported in a scripted process or by clicking the Tools menu ( ) in the upper-right of the application. Note that exporting multiple records is not supported; FileMaker Go will export only the contents of one field from the current (single) record. The resulting content can be emailed, viewed, or saved. If the content is saved, it will be available in the Files on Device list. Consider a case where a text field contains a large amount of text. A user could export the contents and email them to a colleague in a few simple steps or through a scripted process. FileMaker Go 1.2.1 Technical Brief 13 Save Records As PDF Save Records as PDF is supported as a scripted process or by clicking the Tools Menu ( ). As with Export Field Contents, the resulting file can be emailed and is available in the FileMaker Go Files on Device list accessible via the Window menu > File Browser option. It is important to note that some of the script step options from FileMaker Pro are not supported: • Appending records to an existing PDF • Selecting the Acrobat version • Selecting Printing and Editing options on the Security tab • Deselecting the option that allows screen reading software • Options on the Initial View tab This feature has been updated from previous versions of FileMaker Go to work more like Print To PDF in FileMaker Pro. Previously unsupported FileMaker Pro features like object sliding and hide when printing are now supported when creating PDFs using FileMaker Go. Save A Copy As… FileMaker Go can save a copy of a local database on the device. Saving a file as a compacted copy or a clone is supported when you use the Save a Copy As script step, but is not supported when using the menu item. The resulting file can be opened and used in FileMaker Go, sent via email or saved on the device where it appears in the Files on Device list. This feature can be useful for sharing files between FileMaker Go users or for storing a backup of a file. Imagine working with a local database in the field, and receiving a request from your office for access to your database. This feature would allow you to create and email a copy of your database to those needing access. It is important to note that a copy of a local file is not linked in any way to the original file. Data that is entered into the original will not show in any copies of that file. URL Schemes Many FileMaker developers will be familiar with the fmp7:/// URL scheme that allows a database to be opened from a clickable link. This URL protocol has been extended to support script names and parameters. The new scheme syntax is: FMP7Script:// / ?script=