Admin – Mobile App

The Mobile App is linked to the desktop app and designed to be used on a web browser.
It is managed from BOS Tools.

How to Add Users to the Mobile App

  1. Login to BOS Tools.
  2. Click Admin (BOS) on the Tile Menu.
  3. Right click the applicable subscriber and click View/Edit Users from the context menu.
  4. Click Edit (button) on the top row.
  5. On the top row, type in the details of the new user:
    1. Status = Enabled.
    2. Desktop = Enabled.
    3. Mobile = Enabled.
    4. Username = Type the person’s username.
    5. Email = Type the person’s email address.
      • Note: This must be a valid email address because the user’s login credentials are emailed to them.
  6. Right click the Username and select Assign Database from the context menu.
  7. Move the databases that the user can have access to from the Available to the Assigned section.
    • Note: To revoke access: move the databases from the Assigned to the Available section.
  8. Close the popup using the X in the corner.
  9. Right click the Username and select Invite to Mobile from the context menu.
    • Note: The user is now activated for mobile. An invitation email with login details and a link to open the app is sent to the user.

How To Release a New Mobile Version

The Mobile app does not have to be upgraded for each new Desktop version.

  1. Update the code on the main branch for the front- and backends.
  2. Login to BOS Tools.
  3. Click Mobile Releases on the Tile menu.
  4. Type a version number in the block next to Release.
  5. Click Release (button)
    • Note: This action does the following:
      • Creates a new S3 bucket, Route 53 entry and CloudFront Distribution.
      • Copies the Frontend App from Code Commit to the new S3 bucket.
      • Creates a new Lambda for the backend.
      • Updates the frontend environment variable with the URL of the new backend.
      • Creates a versioned branch that can be checked out and updated later.
  6. Associate the new mobile release with a desktop release:
    1. Close the Mobile Versions popup.
    2. Click Versions & Scripts on the Tile Menu.
    3. Click Menu (button) > Versions.
    4. Click Edit (button).
    5. Click the Mobile Version column next to the desktop version and select the corresponding mobile version from the dropdown list.
    6. Click Save (button).
    7. Close the popup.

How To Update a Mobile Version

  1. Check out the version branch.
  2. Update the code.
  3. Commit and Push to branch.
  4. Login to BOS Tools.
  5. Click Mobile Releases on the Tile menu.
  6. Release a new version as described in the previous topic.
  7. Right click the new version and click Update Frontend from the context menu.
  8. Right click the new version and click Update Backend from the context menu. 
  9. Close the popup.

Architecture

  • The mobile app is a browser-based app consisting of a Node.js backend and a Vue.js frontend.
  • Frontend:
    • Single page app uploaded to S3.
    • Each version has its own Bucket: For example, [1-0-0.bos.quickeasysoftware.com](http://1-0-0.bos.quickeasysoftware.com).
    • The Frontend backets are hosted in Singapore and distributed to other regions using CloudFront.
  • Backend: Lambda function.

Version Control

  • The Desktop application is the primary Version Number which is linked to the Database.
  • The Desktop Versions table contains a Mobile Version field which indicates the Mobile Version that is compatible with the Desktop Version.
  • When a User logs into a database, the Mobile Version linked to the database is retrieved and the user is directed to the applicable app.
  • The version number displayed on the menu inside the app is the Mobile Version number.
  • The source code is stored on AWS Code Commit.
  • Versions are managed in AWS Code Commit as branches.

Learn More

  1. Admin – BOS Tools Upgrade Notes: Upgrade notes for BOS Tools.
  2. Admin – Currencies: Activating currencies in BOS Tools.
  3. Admin – Database Backups: Backing up databases manually and automatically.
  4. Admin – Database Upgrades: Upgrading a database.
  5. Admin – Database Version Control: Technical information on versions in BOS.
  6. Admin – Databases: Managing and creating databases and user access.
  7. Admin – Subscribers and Languages: Managing subscribers in BOS Tools.
  8. Admin – Users: User management in BOS Tools.