Skip to main content
Skip table of contents

PortableConnect User Guide

Table of Contents

Getting Started

Gimmal Physical PortableConnect is a barcode/RFID scanning application that allows users to use a portable scanner to perform actions in Gimmal Physical.

To start using PortableConnect:

  1. Unlock the portable device.

  2. Tap on the Gimmal Physical PortableConnect app icon on the home screen

• If the app icon is not on the home screen, search the device or open the app drawer and scroll until it is found.

Once in the app, tap the vertical ellipses (three dots) in the upper right corner and select the desired tab.

PortableConnect with Web Services

If using PortableConnect with Gimmal Physical Webservices, you will need:

  • URL for the Gimmal Physical Webservice

  • Valid Gimmal Physical login credentials

To use:

  1. Go to the Preferences tab.

  2. Enable ‘Using Web Services’ and ‘Using Web Sync’

  3. Enter the Webservice URL in the ‘Webservice:’ textbox.

  4. Enter the Gimmal Physical credentials in the ‘Username:’ and ‘Password’ textboxes respectively.

  5. Tap on the ‘Save’ button at the bottom of the page.

PortableConnect with RFID

To enable using PortableConnect with RFID:

  1. Go to the Preferences tab.

  2. Ensure webservices are enabled. See PortableConnect with Webservices.

  3. Select the appropriate device from the ‘Barcode Device’ dropdown.

  4. Enable ‘RFID’.

Additional Configuration

Allow Duplicate Scans: If this setting is enabled, PortableConnect will not automatically remove multiple scans of the same item.

Data Collection

To begin scanning barcodes, select Collection from the menu.

  1. Set the Transfer Destination:

    1. Check the ‘Make next scan a location’ checkbox.

    2. Scan the barcode of the location to transfer items.

    3. If the location is successfully set, you will see the barcode scanned next to the ‘Location:’ label.

  2. Scan the barcodes of the items to be transferred:

    1. If the barcode label is damaged or won’t read, you can type it manually into the ‘Type or Scan Barcode’ textbox. The barcode will be logged once the enter key is hit.

  3. Repeat the above process for all items to be scanned.

Data Upload

To generate a file of the transfers for upload to the Gimmal Physical application:

  1. Select Create File from the menu.

  2. To remove scans from the log, check the ‘Clear scans after creation’ checkbox.

  3. Tap the ‘GENERATE FILE’ button.

A text file named TransferData.txt will be created in the Install Directory/Gimmal Physical Portable that can be uploaded through the Gimmal Physical Web UI.

Configuring Portable File Transfer in Gimmal Physical

The options shown below reflect version 3.15 and above. For information on the configuration in previous versions, please contact support.

The Portable Transfer page contains several options that allow users with the appropriate permissions to:

  • Establish Rules for Barcode Processing

  • Preview and Analyze files before importing them

  • Execute the upload of a transferred file


The following options will help you complete your transfer:




Optional Email Address which will receive the report of the completed process or analysis once the job has been completed.

Larger files can take a significant time to complete processing, so we recommend using this option to notify you when the transfer is complete


Choose the file to be processed. The box will turn green if the file is accessible, but red if there is a problem.

The transfer file must be in .txt format.


This option does not process the file but shows the first 100 lines on this page with a summary of the contents.

Additional Rules

These rules will be applied to the barcode values as listed in the file before processing into Gimmal Physical. They help handle certain types of legacy or ‘dirty’ data that may be present in the files.

Abort update if total errors are greater than:

Numeric value indicating the number of errors after which the process will be aborted.

A large number of errors can indicate data or file issues and the best option would be to stop the processing of the file.

Remove preceding characters:

Enter the characters that should be removed from the beginning of the barcode line before it is ingested into Gimmal Physical.

Leave blank if no characters should be removed.

Remove trailing characters:

Enter the characters that should be removed from the end of the barcode line before it is ingested into Gimmal Physical.

Leave blank if no characters should be removed.

Add preceding characters:

Enter the characters that should be added to the beginning of the barcode line before it is ingested into Gimmal Physical.

Leave blank if no characters should be added.

Add trailing characters

Enter the characters that should be added to the end of the barcode line before it is ingested into Gimmal Physical.

Leave blank if no characters should be added.

Limit barcode length:

Truncate the barcode line to the entered value before it is ingested into Gimmal Physical. Characters will be removed from the end.

Leave blank if the barcode should not be truncated.

Replace characters:

This option allows you to locate certain characters within the barcode as scanned into the file and replace them with others for processing within Gimmal Physical.

If both are left blank, no characters will be replaced


Characters to locate and replace


Characters to replace those found above in the ‘Find’ text box.

If this field is left blank, but there are characters (including spaces) in the ‘Find’ text box, if they are found in the barcode, they will be deleted.


Clicking this button will run the selected file through the rules as a fully featured test. An email will be generated with the results of the analysis, and there will be an entry in the logs table, but no items will be processed.


Runs the full process to upload and update the barcodes noted on the file.

We recommend running the analysis first to ensure there are no outstanding issues before executing the transfer process.


Exits the Portable Transfer screen and stores the values entered.

If the 'Execute' or 'Analyze' options are used, the log file will be available from the Admin | Import Log list.

Data Update with Web Services

When using Webservices there’s no need to generate a file. The scans can be uploaded directly from the device.

  1. Go to the Synchronize tab.

  2. Ensure the upload type is set to ‘(TRANSFER)’.

  3. Tap the ‘UPLOAD’ button.

  4. The results of the upload will be listed below.

View Scanned Data

All scans are saved to a log on the device.

To view the logged scans:

  1. Select History from the menu.

  2. The barcode and scan date will be listed in order of scan.

Clear Scanned Data

Once transfers are successfully uploaded, clear the scanned data log:

  1. Select Clear from the menu.

  2. Tap the ‘CLEAR’ button.

If there is other data saved to the device from using Webservices, you can clear from this option as well.

  1. Select Clear from the menu.

  2. Tap ‘RESET ALL DATA’.


A reconcile compares scanned data for a given location to what Gimmal Physical expects in that location, then updates Gimmal Physical to be in sync with the scanned data.

  1. Scan a location barcode.

  2. Scan the barcodes for all items in the location.

  3. Upload the scanned data.

    1. Without webservices:

      1. Create a text file as detailed in the Data Upload section.

      2. Copy the file to your workstation.

      3. Upload the file through the Gimmal Physical web site.

    2. With webservices:

      1. Go to the Synchronize tab.

      2. Ensure the upload type is set to ‘(Reconcile)’.

      3. Tap the ‘UPLOAD’ button.

      4. The results of the reconcile will be listed below.

A reconcile has three possible results:

  1. The scanned item is in the expected location.

    1. No action is taken.

  2. Gimmal Physical found a scanned item that was not expected in that location.

    1. Gimmal Physical will transfer the item to the scanned location.

  3. Gimmal Physical expected an item, but it was not found in the scanned data.

    1. Gimmal Physical will mark the item as missing.

Web Service Specific Features

To use these features Webservices must be configured as detailed under PortableConnect with Webservices in this document.

Missing Records

To view a list of missing records in Gimmal Physical via PortableConnect:

  1. Select the Missing tab.

  2. Select the item tab to view missing items.

  3. The items will populate below (see right).

If using RFID with PortableConnect, a ‘DETECT’ button will appear upon tapping on the item.

Tapping the ‘DETECT’ button will change the tab to the Detector tab and preload the item barcode. See PortableConnect with RFID for more information.


PortableConnect with Webservices can be used to fulfill valid requests in Gimmal Physical.

  1. Navigate to the Picklist tab.

  2. Select the item tab to view valid requests.

  3. Tap on the request to mark it as fulfilled.

  4. Tap the ‘TRANSFER’ button.

This will add the appropriate barcodes to the log and mark the request as complete on the device. To complete the request and update Gimmal Physical an upload must be performed.

If using RFID with PortableConnect: a ‘DETECT’ button will appear on the request. Tapping the ‘DETECT’ button will change the tab to the Detector tab and preload the item barcode. See PortableConnect with RFID.

Load Locations

When using Webservices, PortableConnect can preload the list of possible locations from Gimmal Physical.

  1. Go to the Preferences tab.

  2. Enable ‘Load Locations’

  3. Tap ‘SAVE’.

  4. Go to the Locations tab.

  5. Tap ‘DOWNLOAD LOCATIONS’; Wait for the download to complete.

  6. Navigate to the Collection tab.

  7. Tap the ‘SELECT’ button adjacent to the ‘Locations:’ label.

  8. Select the location’s item tab.

  9. Tap a location from the list to prepopulate the location.

RFID Specific Features

Detector: PortableConnect with RFID can be used to locate missing items.

  1. Navigate to the Detector Tab.

  2. Enter the barcode of the item to locate.

  3. Tap ‘READY TO SCAN’.

The device will beep if you are within range of the item and increase beeping the closer the device becomes.

TC51/52 Device Preparation Checklist

Parts required

  • TC51 or TC52 Scanner

  • Docking Station

  • USB cable

  • Power cable (three parts)

Initialization Steps

  1. Assemble the power cable:

    1. Connect the three power cable pieces.

    2. Plug the power cable into the dock.

    3. Plug the power cable into a wall outlet.

  2. Connect the USB cable to the dock and a PC.

  3. Install a battery into the back of the scanner.

  4. Dock the scanner and allow it to charge.
    Note: Full battery is ideal, but not required.

  5. Once the scanner powers on, go to Settings and update the Date and Time.
    Note: Automatic should be disabled while setting the date and time, and then re-enabled once it is accurate.

  6. Swipe down from the top of the scanner (while it is still docked) and change the USB connection type to Transfer Files.

  7. Copy the latest version of the APK that was delivered with these instructions. Paste it directly into the Internal shared storage drive of the scanner.

  8. Install the APK:

    1. Take the scanner out of the dock.

    2. Unlock the scanner.

    3. Navigate to the Home Screen, and swipe up from the bottom to get to the App Drawer.

    4. Locate the File Browser app and browse to the top directory of Internal shared storage.

    5. Double-click on the Gimmal.GimalPortableConnect.apk and follow the installation steps.

    6. Select Open as the last step.

  9. Select the square in the bottom-right corner and then use the Clear All button to reset the Gimmal Portable Connect app.

  10. To locate the Gimmal Portable Connect app, navigate to the Home Screen and swipe up from the bottom
    Note: For easier access, tap and hold and then drag the app icon onto the Home Screen

  11. We recommend adding the Settings to the Home Page of the scanner for easier troubleshooting.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.