The Original FileMaker Community
Business Templates - Demo Apps - Video Tutorials -Samples - Help - 46000 Member Forum

The Leading Filemaker Developer Tools

iOS App SDK Instructions for FileMaker Go 14 – FileMaker Today

Get real time updates directly on you device, subscribe now.


The iOS App SDK allows you to build a standalone iOS app from your FileMaker solution. Users can access your FileMaker solution similar to other iOS apps without having to install FileMaker Go.


Before you begin


Tips:




Step 1: Download and install Xcode


  1. Download Xcode from the Mac App Store and install it on your Mac.

  2. In the Xcode Accounts preferences, add the Apple ID that is associated with your Apple Developer Program.




Step 2: Download and open iOS App SDK


  1. Download iOS App SDK, then move the file from the Downloads folder to a location of your choice.

  2. Double-click iOSAppSDK.tbz to unpack the file and create the iOSAppSDK folder.




Step 3: Create signing identities and certificates


In Xcode, use the Accounts preferences to create signing identities. Xcode automatically creates your development certificate for you. See the Apple App Distribution Guide.




Step 4: Create the App ID


To register your iOS apps with Apple, you need to create an App ID for each app. An App ID is a unique identifier for your app.


  1. Provide the App ID information in https://developer.apple.com.

  2. Specify the name, description, and bundle identifier (ID) for your app.

  3. In App Services, select the following checkboxes to enable the corresponding app services:


    • iCloud

    • Data Protection, then Complete Protection


To learn more about registering App IDs, see the Apple App Distribution Guide.




Step 5: Download the provisioning profile


In Xcode, use the Accounts preferences to download the provisioning profile for your app.




Step 6: Use iOS App SDK to create a project directory


All resources for your app are stored in a project directory. Use iOS App SDK to create the project directory for your app.


  1. Open the Terminal app on your Mac.

  2. Use the cd command to change the directory to the location of the iOSAppSDK folder on your Mac. You created the iOSAppSDK folder in Step 2: Download and open iOS App SDK.


    Tip: Drag the folder to the Terminal window to enter the full path of the folder.


  3. Type the following command in the Terminal window:


    ./makeprojdir <NewAppDir> <appName> <bundleIdentifier>


    • NewAppDir: The name and location of a new directory that will be the project directory for your app. The project directory can be anywhere in your file system; it doesn’t need to be in the iOS App SDK directory.

    • appName: The name of your app. If the name contains spaces or special characters, enclose the name in quotation marks.

    • bundleIdentifier: A unique string that identifies a single app. You created the bundle identifier in Step 4: Create the App ID.


    The following example creates a new project directory called MyAppDir in the user’s home directory for the “Hello World” app and the com.mycompany.helloworld bundle identifier:


    ./makeprojdir ~/MyAppDir "Hello World" com.mycompany.helloworld


Project directory contents


A project directory is created for your app in the location you specified. This directory includes the following file and directory:


  • <appName> directory: Use this directory to store the files and resources for your app.

  • <appName>.xcodeproj: The Xcode project file for your app.


Do not modify the following file and directory:


  • app.entitlements file: Specifies the entitlements for your app.

  • iOSAppSDKResources directory: Contains the resources that iOS App SDK created for your app.




Step 7: Add your solution files to Xcode and modify configFile.txt


  1. Open the Xcode project file for your app (<appName>.xcodeproj).

  2. In Xcode, click the disclosure triangle next to your project in the project navigator.

  3. Click the disclosure triangle next to the Custom Application Resources folder.

  4. Drag your solution files to the Solution Files folder, then remove the PlaceHolder.fmp12 file.




    Image


    Note: This folder can contain multiple solution files. You specify which solution file to launch in the configFile.txt. See the next two steps.


  5. In the Custom Application Resources, click configFile.txt.

  6. Update the following information:


    • launchSolution: Specify the solution file to open when your app is launched. The filename is case sensitive.

    • helpURL: (optional) Specify the URL for the Help menu for your app. If no URL is specified, the Help menu is removed from the app.

    • alwaysOverwrite: (optional) Specify if you want the iOS App SDK framework to reinstall all the files from the Solutions Files folder every time the app is launched.


      If this optios is set to 1, the files in the Solution Files folder will be copied to the Documents directory on the iOS device whenever the app is launched. If this option is not specified or if it is set to 0 (zero), files are copied to the Documents directory only the first time the app is launched, or whenever the app’s version string changes.


      Note: Set this option to 1 only when you are testing your app.


Image


Enlarge Image




Step 8: Create images and add them to the Xcode project


Use the following guidelines for creating images for your app. For the latest information, see the Apple iOS Human Interface Guidelines.


App icons


Every app needs an app icon. Create different sizes of the app icon for different devices to make sure that your app icon displays correctly on all supported devices. Use the following sizes for the app icons:


  • For iPhone:


    • 120 by 120 pixels for 2x

    • 180 by 180 pixels for 3x


  • For iPad:


    • 76 by 76 pixels for 1x

    • 152 by 152 pixels for 2x


  • For the App Store icon: 1024 by 1024 pixels


The recommended file format for icons is PNG.


Launch image


A launch image is used as a splash screen that iOS displays when your app launches. The image appears instantly and is quickly replaced by the first screen of your app.


You can create images at 1x, 2x, or 3x resolution to provide the sharpest image for each device. In portrait orientation, the left and right edges may be cropped. In landscape orientation, top and bottom edges may be cropped. For best results in both orientations, use a square image.


Security shield image


If a FileMaker solution uses the fmreauthenticate extended privilege, a security shield covers the content of the screen after the solution moves to the background. You can create an image to be displayed near the top center of the security shield screen.


Design a security shield image that looks similar to the app icon. The height of the security shield image can’t exceed 120 pixels. You can create the security images at 1x, 2x, or 3x resolution to provide the sharpest image for each device.


To add image resources to the Xcode project:


  1. In Xcode, click the disclosure triangle next to your project in the project navigator.

  2. Click the disclosure triangle next to the Custom Application Resources folder, then click CustomAppMedia.xcassets.

  3. Click AppIcon, then:


    • In the “iPhone App iOS 7-9 60pt” section, drag the 120 by 120 image to the 2x box, and drag the 180 by 180 image to the 3x box.

    • In the “iPad App iOS 7-9 76pt” section, drag the 76 by 76 image to the 1x box, and drag the 152 by 152 image to the 2x box.


  4. Click LaunchImage, then drag your launch images to the targets for each image. If you do not provide all versions, delete the remaining placeholder files; iOS will automatically scale one of your existing images for the required resolutions.

  5. Click ObscureIcon, then drag your security shield images to the targets for each image. If you do not provide all versions, delete the remaining placeholder files; iOS will automatically scale one of your existing images for the required resolutions.


Image


 




Step 9: Enable Data Protection


  1. In Xcode, select your project in the project navigator.

  2. Choose the target from the Project/Targets pop-up menu or in the TARGETS section of the project and targets sidebar.

  3. Click Capabilities at the top of the project editor.

  4. Enable Data Protection.


Image




Step 10: Specify the version and build number


  1. In Xcode, select your project in the project navigator.

  2. Choose the target from the Project/Targets pop-up menu or in the TARGETS section of the project and targets sidebar.

  3. In the Identity section of the General pane, specify the version and build number for your app.


    The format for the version string is number.number.number (for example, 1.0.1). The build number specifies which build you shipped for a specific app version. For more information, search for CFBundleShortVersionString and CFBundleVersion in Xcode documentation.


Image


 


Step 11: Specify a URL scheme for your app


To allow your app to respond to custom URLs, you need to configure a custom URL scheme for your app.


Note: You cannot specify more than one URL scheme.


To specify a URL scheme for your app:


  1. In Xcode, select your project in the project navigator.

  2. Choose the target from the Project/Targets pop-up menu or in the TARGETS section of the project and targets sidebar.

  3. Click Info at the top of the project editor.

  4. Click URL Types, then click +.

  5. Specify information for the identifier, URL scheme, and role.


Image


 




Step 12: Build and test your app


  1. In Xcode, select your project in the project navigator.

  2. Make sure your Mac is connected to your iOS device.

  3. In the workspace toolbar at the top of the window, click the name of your app, then choose the target device for building and running your app.

  4. Click the Run button in the toolbar to build and run your app.


    Xcode installs the app on the device before it launches the app.


  5. Run and test your app on all devices that you intend to support, including:


    • Check the icons and images in different orientations.

    • Verify that all expected solution files are present.

    • Check the Help menu to make sure it opens the correct URL.




Step 13: Launching your app


By default, the first time you launch your app, the solution files for your app are copied to the Documents directory on the iOS device. If you update your app and the alwaysOverwrite option in configFile.txt is set to 0 (zero) or the option is not specified, files are copied to the Documents directory only the first time the app is launched or whenever the app’s version string changes.


When your app opens, the launch image is displayed immediately. After the image is replaced by the first screen of your app, the behavior is similar to FileMaker Go.


Note: If you need to modify your FileMaker solution file, first delete the existing app from your device, or enable the alwaysOverwrite configuration option. Make sure to disable the alwaysOverwrite option before shipping your app.

This website uses cookies to improve your experience. We'll assume you're ok with this, but you can opt-out if you wish. Accept Read More