SmartSDK Scan Framework – Ricoh Scan GUI Service

This download is provided here only as a convenience. The primary source for the Scan GUI Service packages, documentation, and sample code is from the latest SmartSDK Development Kit. If anything in the following disagrees with the SmartSDK Developer's Guide, the Guide should be considered correct.

What is the Ricoh Scan GUI Service?

The Ricoh Scan GUI Service will allow your solution to hook into a turnkey framework for scanning to speed up your development efforts. This framework is developed and supported by the core engineering team. Your application will only have to set necessary scan settings and pass these settings via an Android Intent to the framework. By leveraging the Ricoh Scan GUI Service you only need to focus on the business logic for your scanning application.

See the Scan Data Handle Sample and the ScanGuiServiceSample application (included in the downloadable package) for examples on some typical ways to interface a SmartSDK application with this service.

What's Included

The Ricoh Scan GUI Service download contains the following items:

• The SimpleScanEx and SmartScanEx installable distributables for those models that do not have the service installed as part of the device firmware.
• Development and API guides.
• A sample SOP application with source and documentation that demonstrates basic functionality.

How to Use the Service

There are three ways the Scan GUI Service can be made available to third-party applications:

1. Installing SimpleScanEx. This is an installable module that supports Quick-UI.
2. Installing SmartScanEx. This is an installable module that supports Tile-UI.
3. Later models will have this service factory installed, or provided as part of a firmware update. In this case, there is no need to install any Scan GUI Service module.

The Service only needs to be installed once to make it available for use by third-party applications. Refer to the SmartSDK documentation for information about supported device models.

Please Note

• For some devices you may have to install the framework binaries (SimpleScanEx or SmartScanEx) at least once in order to provide the Service on the device for your application.
• See the SmartSDK Developer's Guide for details on which devices may require the service to be installed and which have it present as part of the firmware.
• For devices that require the Service to be install, you are required to design, implement and support the necessary deployment logic. Here are the basic requirements for this support:
  • Deployment tools should check if the device is one that requires SimpleScanEx (an MP C306Z/MP C406Z Series model); if so, install or update the SimpleScanEx module.
  • Deployment tools should check if the device is one that requires SmartScanEx; if so, install the StartScanEx module.
  • Deployment tools should check the version of the installed service and install the device appropriate module if it is determined to be out of date.
• These installable modules are updated from time to time, as well as the related documentation and sample apps. Check the latest SmartSDK Development Kit release to see if the Scan GUI Service has been updated.