Mobile Tutorial: Using InterBase ToGo (iOS and Android)

From RAD Studio
Jump to: navigation, search

Go Up to Mobile Tutorials: Mobile Application Development (iOS and Android)


Before starting this tutorial, you should read and perform the following tutorial session:

Tip: Following this tutorial requires a license for IBToGo or IBLite:

  • If you purchased one of the following RAD Studio versions, you have received in Email a key for an unlimited development and deployment license for IBLite:
    • RAD Studio XE5 Professional or higher
    • Delphi XE5 Professional with Mobile or higher
  • If you are a trial user, your installation includes a trial license for IBToGo. You can test InterBase on iOS and Android by selecting your test license during the deployment step, as described in this tutorial. The trial licenses are installed with your trial product, in C:\Users\Public\Documents\InterBase\redist\InterBaseXE3.
Note: On Android devices, InterBase ToGo apps require specific Uses Permissions to be set, specifically:
  • Read external storage (the database is placed in the external memory)
  • Write external storage (the database is placed in the external memory)
  • Internet (you need to connect with a remote server)

This tutorial describes the basic steps to browse data managed by InterBase ToGo on your iOS and Android devices through the dbExpress framework.

iOS Android

DBDemo iPod Runtime.png

DBDemo Runtime.png

Note: You can use FireDAC, dbExpress, and Interbase Express (IBX) components to build Interbase ToGo applications. For a detailed discussion on Interbase Express components usage in a Delphi application, read the Getting Started with InterBase Express article. For this tutorial, we will connect to Interbase ToGo using dbExpress framework.

Using dbExpress to Connect to the Database

dbExpress is a very fast database access framework, written in Delphi. RAD Studio provides drivers for most major databases, such as InterBase, Oracle, DB2, SQL Server, MySQL, Firebird, SQLite and ODBC. You can access these different databases using procedures similar to the procedure described here.

  • For the mobile platforms, dbExpress supports InterBase ToGo as well as SQLite. These database products can run on iOS and Android devices.
  • For other databases, such as Oracle, you need to have at least a client library. On Windows platforms, the client library is provided as a DLL to connect to. Therefore, you need to develop applications using middle-tier technologies such as DataSnap to connect to these database products from a mobile device.

Another tutorial discusses how to connect to Enterprise Database without using a client library on a mobile device; see Mobile Tutorial: Connecting to an Enterprise Database from a Mobile Client (iOS and Android).

Design and Set Up the User Interface

This tutorial uses TListView and TPanel components as the UI elements.

To set up a ListView and a Panel component, use the following steps:

  1. To create an HD FireMonkey Mobile Application, select either of the following:
    • File > New > FireMonkey Mobile Application - Delphi > Blank Application
    • File > New > FireMonkey Mobile Application - C++Builder > Blank Application
  2. Drop a TListView component on the form.
  3. In the Object Inspector, set the following properties of the ListView:
    • Set the Align property to alClient, so that the ListView component uses the entire form.
    • Set the ItemAppearance to ListItemRightDetail.
    • Set the SearchVisible to true.
  4. Add a TPanel component to the form, and set the following properties in the Object Inspector:
    • Set the Align property for the TPanel component to alTop.
  5. Add a TLabel component to the Panel, and set the following properties in the Object Inspector:
    • Set the Align property for the TLabel component to alClient.
    • Set the StyleLookup property to toollabel.
    • Set the TextAlign property to taCenter.
    • Set the Text property to DB DEMO.

Connecting to the Data

Following are the basic steps to connect to data in a database using dbExpress:

  1. On the Tool Palette, double-click the TSQLConnection component.
    SelectSqlConnection.png
  2. In the Object Inspector, set the following properties for TSQLConnection:
    1. This app uses InterBase ToGo, so set the Driver property to IBLite/ToGo.
      SelectDriverForSQLConnection.png
    2. Set the LoginPrompt property to False, so that the user is not prompted for a login.
    3. Click the ellipsis [...] for the Params property, and set the Database value to C:\Users\Public\Documents\RAD Studio\12.0\Samples\Data\dbdemos.gdb (location of the database); then close the dialog box:
      ValueListEditor2.png

    4. Set the Connected property to True.
      Note: If you get an error ("unavailable database") on development environment, this means you do not have a current license for InterBase. The license of InterBase Developer Edition is included as part of the product for some product editions. For more information, see Troubleshooting.
  3. Add a TSQLDataSet component to the form, and set the following properties:
    1. Set the SQLConnection property to SQLConnection1 (the one that you added in a previous step).
    2. Set the CommandText property to select COMMON_NAME, SPECIES_NAME from BIOLIFE order by COMMON_NAME.
    3. Set the Active property to True.
  4. Open the LiveBindings Designer and connect the data and the user interface as follows:
    1. Click COMMON_NAME in SQLDataSet1, and drag the mouse cursor to Item.Text in ListView1.
      CommonName ListView.png

      At this point, TBindSourceDB and TBindingsList components were added to the form.
    2. Click SPECIES_NAME in BindSourceDB1, and drag the mouse cursor to Item.Detail in ListView1.
      DBDemo LiveBindingsDesigner.png

Deploying your Application to mobile

Up to this point, you have used InterBase on your desktop. This means that the actual database is located at your local hard disk drive (for example, C:\Users\Public\Documents\RAD Studio\12.0\Samples\Data\dbdemos.gdb). On the mobile Device, the application is sand-boxed, and typically you can only read and write data that is located in the Documents folder (for iOS device) and internal storage (for Android device) under your application folder.

To connect to a local database on mobile, you need to perform the following actions:

  • Deploy the database to the mobile Device.
  • Change the configuration (to connect to the database file) to a local file under the Documents folder (for iOS device) or internal storage (for Android device).

Deploy InterBase ToGo, dbExpress Driver, and the Database File to Mobile

To execute your application on mobile, you need to deploy the following files:

  • Interbase ToGo
  • dbExpress Driver to InterBase (for iOS Simulator)
  • The database file (dbdemos.gdb)
  1. Open the Deployment Manager by selecting Project > Deployment.
  2. Select All-Configurations - iOS Device platform or All-Configurations - Android platform from the drop-down list of target platforms at the top of the Deployment Manager.
  3. Select Add Featured Files (DMgrAddFeatFiles.png):
    AddingFeaturedFiles.png

  4. Select the following database modules, and then click OK to close the Featured Files dialog box:
    • InterBase ToGo. You need to select the license to be used when deploying the application on the device.
      • The Tip at the beginning of this tutorial describes how to activate an InterBase license.
      • The suggested names for the license files available are listed in the Featured Files dialog, under the following name pattern: reg_*.txt.
        As you can see in the image below, the reg_ibtogo.txt license file is selected for this tutorial.
      • You might have received from Embarcadero a license file for IBToGo or IBLite that has a pattern of reg_nnnnnnn.txt, where nnnnnnn is a generated number:
        • If you have saved that file over reg_ibtogo.txt or reg_iblite.txt in the location below (for example, C:\Users\Public\Documents\InterBase\redist\InterBaseXE3), you can just select the desired license.
        • If you have saved the file with its original name, then select Add Files (shown in the next step) and include the license file in the list of files that need to be deployed with the application.
    • DBExpress InterBase Driver
    Tip: If you plan to test your application on the iOS Simulator, then you also have to select the DBExpress InterBase Driver for iOS Simulator.
    FeaturedFilesiOSAndroidDB.png

  5. Select Add Files and select the database file (for example, C:\Users\Public\Documents\RAD Studio\12.0\Samples\Data\dbdemos.gdb).
    AddingDatabaseFile.png

  6. Select dbdemos.gdb and change Remote Path to StartUp\Documents\ (for iOS platform) or assets\internal\ (for Android platform).
    RemotePath on iOS device platform
    ChangeToStartUpDocuments.png

    RemotePath on Android platform
    AddDBforAndroidAssets.png

  7. Select the Platforms column (double-click the ellipsis [...] in the row for dbdemos.gdb):
    1. Ensure that iOS Simulator and iOS Device or Android are present for dbdemos.gdb.
    2. Remove Win32 from the list if it is present (you do not have to copy database files to the Win32 platform).
  8. Select All-Configurations - iOS Device platform or All-Configurations - Android platform, and make sure dbdemos.gdb is set to be deployed to StartUp\Documents\ or assets\internal.

As you just configured, when you run the app on the mobile device, the database file (dbdemos.gdb) is to be deployed to the Documents folder (for iOS platform) or internal storage (for Android platform) in the sandbox area of your mobile app.

Modify Your Code to Connect to a Local Database File on mobile

As described in the previous step, the TSQLConnection component is connected to a database on your local file system with an absolute path. So you need to replace the location of the file before connecting to the database, as follows:

  1. In the Form Designer, select the SQLConnection1 component.
  2. In the Object Inspector, double-click the Value field of the BeforeConnect event.
  3. Add the following code to this event handler:

Delphi:

procedure TForm1.SQLConnection1BeforeConnect(Sender: TObject);
begin
  {$IF DEFINED(iOS) or DEFINED(ANDROID)}
   SQLConnection1.Params.Values['Database'] := 
      TPath.Combine(TPath.GetDocumentsPath, 'dbdemos.gdb');
  {$ENDIF}
end;

C++:

void __fastcall TForm1::SQLConnection1BeforeConnect(TObject *Sender)
{
  #if (defined(__arm__) && defined(__APPLE__))
  SQLConnection1->Params->Values["Database"] = System::Ioutils::TPath::Combine(System::Ioutils::TPath::GetDocumentsPath(), "dbdemos.gdb");
  #endif
}

The TPath record is declared in System.IOUtils unit, so you need to add System.IOUtils in the uses clause.

Run Your Application on a Simulator or on a Mobile Device

Now your application is ready to run. You should be able to browse data just as you can in the IDE. You can narrow down the list using the Search Box.

iOS Android

IPodSearchDBDemo.png

Screenshot 2013-11-02-03-34-10.png

Troubleshooting

InterBase License Issues

If you get an error ("unavailabale database") when you connect to the database in the development environment, this means you forgot to deploy the Interbase ToGo license.

  • To execute your application on mobile, deploy the reg_ibtogo.txt or reg_iblite.txt license files.
  • The license files are located in C:\Users\Public\Documents\InterBase\redist\InterBaseXE3 directory.

Exception Handling Issues

If your application raises an exception without having proper exception handling code, your mobile app simply crashes (disappears) at run time.

If you encounter a crash, you might want to connect manually to the database while you troubleshoot the issue using the following steps:
  1. Select the SQLConnection1 component, and change the Connected property to False.
  2. Drop a button on the form, and create the following event handler to manually connect to the database:
procedure TForm1.Button1Click(Sender: TObject);
begin
  try
    SQLConnection1.Connected := True;
    SQLDataSet1.Active := True;
  except
    on e: Exception do
    begin
      ShowMessage(e.Message);
    end;
  end;
end;

Typical Errors and Resolutions

Following are typical errors that you might encounter when you connect to the database, and suggestions for resolving the issues:

Error on mobile Suggestion
GDBFileNotFound.PNG Check whether the dataBase file (dbdemos.gdb) is delivered to 'StartUp\Documents\' (for iOS) or 'assets\internal\' (for Android).
IBToGoLic.PNG Check whether the license file is delivered for InterBase ToGo.
NeedToPointLocalFile.PNG Check whether you pointed to the local file (add an event handler for the OnBeforeConnect event of the SQLConnection1 component).

See Also