Wiki

Case Status
Log In

Wiki

 
Setup and Sync Process
  • RSS Feed

Last modified on 5/22/2018 8:42 AM by User.

Tags:

Setup and Sync Process

(No longer supported)

 

 

NOTE: Syncing OASIS for iOS with the OASIS mobile cloud server requires OASIS version W614D1 (or later) and OASIS Mobile version 614.4.1 (or later)

Setting up Devices for Mobile Sync (YouTube | MP4)

Before starting the process of setting up the sync on your OASIS client, you must first contact Ingen Software to get a license for Mobile Sync. Once you have been licensed with our Sync Server, you will be given a license key to install inside the OASIS client.

Installing mobile sync license file

Save the OASIS mobile license file to your desktop. In Oasis, go to Configuration > Software and click on Licenses. In the license viewer, click the Add button at the bottom and navigate to the license file on your desktop and click Open. You should see a message indicating that licenses were added or updated. After you have installed that license, you can follow the steps below. 

Adding a Device to the Sync Server

Open OASIS and click on Configuration > Software. Scroll towards the bottom of the screen and click on the "Manage Devices" link under the Mobile Devices header.

This is the list of devices you have registered for the cloud sync service. To add a new device, go to the File menu from this screen and click on "Add Device".

This will prompt you for a device name, as well as the user account to tie it to. Select the user, and hit "Add" to submit the setup to the server.

The server will respond with a unique sync key that is used to register the device with the server.

If you forget this key, don't worry; you can retrieve the key by double-clicking on the image next to the device. This will pull up the device configuration. If the device has not yet been registered, then you can view the key on the general tab (next to the words "Not bound").

Configure Synced User Data

You control how much data that is pushed down to each user by configuring some basic preferences on the device setup screen. To open, go to the Device Manager screen and double-click on the image next to the device you want to configure. From there, click on the "Settings" tab.

Here you can change some of the transaction data that is pushed to each device. We recommend keeping the timeframes small to begin with; getting an initial sync to finish can take longer the more transactions there are to push down to the device.

You can also check the transactions queued to push up to the server by checking the "Status" tab. This will list in a text view the number of transactions for each table left to push up to the cloud server. NOTE: If you have not registered this device via the OASIS app yet, there will likely be nothing on this tab; the server will scan the transactions to push after the device has been registered. 

 

Filtering Attachments

Attachments take up a large chunk of the sync time and resources, and filtering those items back is an easy way of getting set up on multiple devices quickly. To configure how attachments process, click on "Manage Devices" and go to "Tools" > "Configure Filters".

Once here, you can type in filters you wish to add, and OASIS will check against the attachment File Name and Description to find matching attachments and skip them when processing sync queues for all devices.

 

We have provided some pre-defined filters in the dropdown. Select an item and click "Add Filter" to add it to the filters list.

You can remove filters by right-clicking a line and selecting "Remove Filter".

Registering for Sync on OASIS for iOS

After you have installed OASIS on your iDevice, open the app and click the "Cloud Sync" option.

On this screen, type in the sync key that was provided by the server in the "Adding a Device" section of this help document.

Tap the "Validate" button to start the registration process. Once the key has been validated by the server, you will be on a "waiting" screen while the device waits for transactions to sync down to the iDevice.

Depending on how long the server takes to process your transactions, it can take some time for it to come back and begin syncing on the device. Once it does, you should receive a login screen asking for your password. The sync server knows which user you are validating with, based on the setup of the device in OASIS. Enter your OASIS user's password, and you should get into the application.

 

Monitoring Sync Progress

Apple restricts developers from running applications in the background for extended periods of time, so in order to sync transactions with the OASIS sync server, you will need to keep the application in the foreground of your device. The app will keep the screen active while sync is running, so you don't have to worry about it auto-locking the screen. However, it is recommended that you plug your device into a power source, so as to keep the battery charged while syncing. In addition, you should avoid using other apps on the device while trying to complete an initial sync.

While the device is syncing, you will see the sync bar at the bottom of the screen. This will show you how many transactions it has synced, as well as how many are left. You can tap the sync bar to bring up a detailed view we call the "Sync Center" (you can also access this from the home screen's menu bar under the "Sync" item).

From the sync center, you can start/stop the sync, as well as view the history of syncs with the server. 

Sending Sync Diagnostics

When requested by Ingen Software, you may need to send sync diagnostics to us for fixing issues with the sync. To do so, open the Sync Center via one of the methods outlined above (tap the sync bar, or from the menu, tap on "Sync"). In the top right-hand corner, tap the "Share" button to send the diagnostic info to our support email.

Removing or Clearing Synced Devices

The number of devices you are able to sync against are restricted based on how many licenses you have purchased; since you may have cases where a device is decommissioned, or you need to swap who is able to sync, you can remove the device from the OASIS GUI which will in turn delete the data off of the device the next time OASIS is ran on the iDevice. 

To remove a device, open OASIS and go to the "Manage Devices" screen. Double-click on the device you want to delete, then click the "Remove Device" button.

The next time OASIS is launched on the device, OASIS will delete the data and throw the app back to the login screen. This also protects your data, so that if the device is lost or stolen, you can remove the data remotely.