Syncing Offline

A key feature Mifos provides is the ability to use the Android Client App offline. Aside from being able to create clients and groups offline, a field officer can track certain clients on the go and make both loan payment and savings account transactions. Once the user is back online, the user can sync all actions that were completed offline.

If you do not know how to login/logout of the app, please see the Login/Logout page.

On this page:





How To Toggle Offline Mode

When you first login to the app, you will be taken to the client search page, which looks like the following screen:

In order to turn Offline Mode on or off, do the following:

  1. Tap the menu (three lines) in the top left corner. This will expand the user dashboard, which should look like the following screen:

  2. Below the user icon and name, you will see the Offline Mode option and the toggle next to it. Tap that to turn it on. The toggle will slide and turn blue. It should look like the following screen.

How To Navigate to Offline Sync

  1. With Offline Mode enabled, Tap the menu (three lines) in the top left corner. This will expand the user dashboard, which should look like the following screen:

  2. Tap Offline Sync at the bottom of the user dashboard. A sample screen is shown below:

How To Create a New Client Offline and Sync

Once you are back at the client search screen, do the following:

  1. Tap the menu (three dots) in the upper right hand corner. It should look the following screen:

  2. Tap Create Client. It should look the following screen:

  3. Enter the client information. It should like like the following screen:

    Field Name (attribute)DescriptionExampleValidations (if applicable)
    First NameThe First Name of the ClientJohnThis should not be NULL.
    Middle NameThe Middle Name of the ClientAppleThis is optional.
    Last NameThe Last Name of a the ClientDoeThis should not be NULL.
    MobileThe Mobile Number of a the Client1234567890This should not be NULL.
    External IDThe External ID of a the Client123456This should not be NULL.
    GenderThe Gender of a the ClientMale / Female / UnspecifiedThis should not be NULL.
    Date of BirthThe Date of Birth of the ClientMM-DD-YYYYThis should not be NULL.
    ClientType of ClientIndividual / BusinessThis should not be NULL.
    OfficeThe Office of the ClientHead OfficeThis should not be NULL.
    StaffThe Staff of the ClientDOE, JANEThis should not be NULL.

  4. Scroll down to the bottom. Tap Client Active. It should look like the following screen:

  5. Enable Offline Mode. (see How To Toggle Offline Mode)
  6. Go to the Offline Sync screen. (see How To Navigate to Offline Sync)
  7. Tap the Client Payloads option. It should look like the following screen:

  8. Tap the Sync in the upper right-hand corner. Then tap Go Online. It should look like the following screen:

  9. It will sync automatically.

How To Create a New Group Offline and Sync

Once you are back at the client search screen, do the following:

  1. Tap the menu (three dots) in the upper right hand corner. It should look the following screen:

  2. Tap Create Group. It should look like the following screen:

  3. Enter the group information. It should looke like the following screen:

    Field Name (attribute)DescriptionExampleValidations (if applicable)
    Group NameThe Name of the GroupMifosThis should not be NULL.
    OfficeThe Office of the GroupHead OfficeThis should not be NULL.
    External IDThe External ID of the Group123456This should not be NULL.


  4. Scroll down to the bottom. Tap Group Active. (Shown above)
  5. Enable Offline Mode. (see How To Toggle Offline Mode)
  6. Go to the Offline Sync screen. (see How To Navigate to Offline Sync)
  7. Tap the Group Payloads option. It should look like the following screen.

  8. Tap the Sync in the upper right-hand corner. Then tap Go Online. It should look like the following screen:

  9. It will sync automatically.

Field Officer: How To Track Clients

Once you are back at the client search screen, do the following:

  1. Tap the menu (three lines) in the top left-hand corner. This will expand the user dashboard, which should look like the following screen:

  2. Tap on Clients in the menu. This will bring up a list of clients (200 by default), which should look like the following screen:

  3. Select a user to track by tapping and holding the user until it turns gray.
  4. If needed, select more desired users to track by tapping them. Multiple users selected should look like the following screen:

  5. Once all desired users track are selected, sync them by tapping the Sync in the top right-hand corner. A sample sync progress dialog is shown below:

  6. Once the sync is finished, you can enable offline mode and view the clients by repeating steps 1-2. Synced clients will display with a check next to them. A sample offline client list is shown below:

  7. Tap on any client to view his or her details.

How To Make a Loan Payment Transaction Offline and Sync

  1. View a user. A sample user is shown below:

  2. Tap and expand the Loan Accounts for that user. It should look like the following:

  3. Tap any Loan Account. It should look like the following:

  4. Tap Make Repayment. It will take you to the following screen:

  5. Select all options. (See above screen for an example)

    Field Name (attribute)DescriptionExampleValidations (if applicable)
    AmountThe Amount of the loan to pay back100.00This should not be NULL.
    Additional PaymentThe Additional amount of the loan to pay back50.00This is optional.
    FeesThe Fees of the loan25.00This should not be NULL.
  6. Tap Review Payment.
  7. Tap Pay Now. A message indicating the transaction has been saved locally and will be shown. It should look like the following screen:

  8. Navigate to Offline Sync.
  9. The Loan Repayment Transaction should show. A sample screen is shown below:

  10. Tap the Sync in the upper right-hand corner. Then tap Go Online. It should look like the following screen:

  11. If it syncs correctly, it will display the following screen with a message indicating there is no longer anything to sync.



How To Make a Savings Account Transaction Offline and Sync

  1. View a user. A sample user is shown below:
  2. Tap and expand the Savings Accounts for that user. It should look like the following:

  3. Tap any Savings Account. It should look like the following:

  4. Tap Make Deposit or Make Withdrawal. (Make Deposit will be used to demonstrate.) It will take you to the following screen:

  5. Select all options. (See above screen for an example)

    Field Name (attribute)DescriptionExampleValidations (if applicable)
    AmountThe Amount to withdraw or deposit from the account100.00This should not be NULL.
    Payment TypeThe Payment Type used to withdraw or deposit the moneyCashThis should not be NULL.
  6. Tap Process Transaction. A message indicating the transaction has been saved locally will be shown.

  7. Navigate to Offline Sync.
  8. The Savings Account Transaction should show. It should look like the following screen:

  9. Tap the Sync in the upper right-hand corner. Then tap Go Online. It should look like the following screen:

  10. If it syncs correctly, it will display the following screen with a message indicating there is no longer anything to sync.

  11. (WARNING): If you try to make multiple withdrawals/deposits in same savings account, you will receive an error, which looks like the following screen:


  12. (NOTE): However, if you make a withdrawal/deposit in different accounts, they will sync successfully.