Background: Why can't we call Shutdown() in every Ranger state?

Many low-level scanner drivers require that they be shutdown in a specific orderly sequence. If they are abruptly disconnected, it can leave the scanner and/or device driver in an unexpected, and often hung state.

As far as programming documentation goes, the description of a Ranger call in the programming guide mentions the Ranger states that a particular call can be made in.  The state diagram in the manual also graphically describes this.

In the case of Shutdown(), it can be called when Ranger is in the ChangeOptions and ReadyToFeed states.  So the application is responsible for putting Ranger into one of these states before calling Shutdown(). 

When I write applications, I handle it this way:
   A. When the application decides it will call Shutdown(), it checks the current Ranger state.
   B. If Ranger is in a state where Shutdown() is allowed, the application calls Shutdown().

When Ranger is in a state where Shutdown() cannot be called yet, then the application will:
   1. Set a variable to tell itself that it is preparing to shutdown (ex: PreparingToShutdown = true)
   2. Then the application will call the Ranger function(s) required to bring Ranger into the target state, then let Ranger run unimpeded until the target state is reached. 

WARNING: Never use a loop that checks the Ranger state.  The OS message pump needs to run normally for the Ranger state transitions to complete properly.

   3. The application code that handles the Ranger state changing events tests the value of PreparingToShutdown to determine if it is trying to shutdown.
   4. Shutdown() can then be called once Ranger reaches the target state.

There are a few scenarios which may require a couple of state transitions to end up in a state where Shutdown() is allowed.
For example, if Ranger is handling an exception.
So more than one state changing functions, may be required to bring Ranger into the target state.

One of the easiest ways to avoid problems is to disable the ability for the user to exit the application when Ranger is in a state where Shutdown() cannot be called.  So if items are feeding for example, they user would not be given the ability to exit (by as disabling the "exit" button).  However, once feeding has stopped, and Ranger is in the ReadyToFeed state, then the option to exit the application can be enabled.

By default, an insecure loopback URL is used for the socket connection between Ranger and Ranger Remote, listening on port
9002. The IP Address for local loopback is ?127.0.0.1?.

In order to override the target IP address of the Ranger Remote service, the JavaScript application can set the Ranger property
"wsUrl" to the target WebSocket URL address.

Example:
Ranger.wsUrl = ?ws://124.58.31.40:9002?


Ranger JavaScript will uses this URL when Ranger.StartUp() is called to establish a WebSocket connection to Ranger Remote service.

For Ranger versions prior to v5.0, you can make Ranger "forget" about a Ranger license unlock by deleting your Ranger product key from the Windows Registry.  The Ranger FAQ article below describes the location of the key.

---

How-to force eject the document with a Canon CR-120/150?


  Ranger.CallPassthroughMethod("FlushTrack(1)")


...where '1' is the target pocket for flushed documents.


Bryan Clark

---

You should obtain your Ranger software from your check scanning application vendor. Only they know which version(s) of Ranger their application was tested with.

A Ranger product key will be required to activate each Ranger license after your Ranger software is installed.  Canon scanners are exceptions.  A product key is not required to unlock Ranger on new Canon CR-series models.

If your scanning application vendor does not provide Ranger license keys with their software, you can purchase Ranger license keys from one of our Ranger resellers:

• SalesSource International
  Dan Maslich
  Dir: +1 585-662-5255
  Toll Free: +1 877-310-5919 ext 3002
  dmaslich AT salessourceintl.com



• UniLink
  Deanna Diescher
  +1 (800) 666-2980 x119
  deanna AT unilinkinc.com

You can find Ranger license unlocking instructions here: How do I unlock my Ranger software?

---

We are happy to provide Ranger technical support to anyone who meets all of the following criteria:

• The person contacting us is a programmer at a software company.
• The software company is an authorized Ranger reseller.
• The copy of Ranger in question is covered by Ranger software maintenance.

If you work for a bank, credit union, IT staff, or anyone else, contact your scanning software vendor.

---

---

Ranger uses a "node locked" licensing model.  When a Ranger license is first unlocked, it is bound to the PC hardware. 
Once a Ranger license is unlocked, the license cannot be later moved to a different PC.

If you would like to install a Ranger license on a different PC, you will need a new unbound Ranger license.

Ranger licenses can unlocked an unlimited number of times ask long as:

• The Ranger product key/license is unlocked on the same computer hardware again-and-again.


• Ranger annual software maintenance fee is paid-up and is up-to-date.

If you reinstall Windows, install a Windows update, or similar situations, the registry entries that Ranger use were likely removed.

If the PC has not changed, you can use the normal Ranger license unlock procedure to restore Ranger's license registry entries.

Best Regards,
Bryan Clark

(Ranger Guru)

---

These are the most common Ranger licensing unlock scenarios, with links to additional information:

• Scenario: You have a new license, and you are unlocking it for the first time.


• Scenario: You reinstalled Windows or performed a factory reset on your workstation.


• Scenario: You moved to a different workstation, or replaced the workstation motherboard.


• Scenario: The Windows Registry entries that Ranger uses, was modified in an unexpected way.

---

Ranger is a tool that software vendors use to speed their software development and testing tasks.

Since Ranger is one small piece of the total scanning application, Ranger licenses and Ranger software usually come from your scanning software vendor.

The reasons for this are straight-forward:
1. Only your software vendor knows which version of Ranger they tested their application(s) with, before releasing it.
2. Software vendors usually manage the licenses for all software subcomponents that their applications require, including Ranger licenses.

If you need a Ranger license, or are having trouble unlocking your Ranger software, or need to download Ranger software, please contact your scanning software vendor for help.

Best regards,
Bryan Clark

(Ranger guru)

---

You have a new license, and you are unlocking it for the first time...

You can find detailed instructions here: How-to unlock a Ranger license

---

By default, the Ranger installer places the Panini scanner diagnostic program here:
C:\Program Files (x86)\Silver Bullet Technology\Ranger\Scanner Plug-ins\Panini-VisionAPI\API Files\Driver\MultiDemo\PaniniMultiDemo.exe

---

Ranger is a tool that software vendors use to speed their software development and testing tasks.

If you are a programmer at a software company:

• Please use your Ranger SDK credentials to login to our website and download the Ranger software you require.

If you are someone else:

• Please contact your scanning software vendor for help.

Background:
Since Ranger is one small piece of the total scanning application, Ranger licenses and Ranger software usually come from your scanning software vendor.

The reasons for this are straight-forward:
1. Only your software vendor knows which version of Ranger they tested their application(s) with, before releasing it.
2. Software vendors usually manage the licenses for all software subcomponents that their applications require, including Ranger licenses.

If you need a Ranger license, or are having trouble unlocking your Ranger software, or need to download Ranger software, please contact your scanning software vendor for help.  You software vendor will contact our team, if they encounter a technical problem.

Best regards and happy scanning!
Bryan Clark

Ranger guru

---

Ranger uses a "node locked" licensing model.  When a Ranger licenses is first unlocked, it is bound to the PC hardware. 
Once a Ranger license is unlocked, the license cannot be later moved to a different PC.

If you would like to install a Ranger license on a different PC, you will need a new unbound Ranger license.

Ranger licenses can unlocked an unlimited number of times ask long as:

• The Ranger product key/license is unlocked on the same computer hardware again-and-again.


• Ranger annual software maintenance fee is paid-up and is up-to-date.

If you reinstall Windows, install a Windows update, or similar situations, the registry entries that Ranger use were likely removed.

If the PC has not changed, you can use the normal Ranger license unlock procedure to restore Ranger's license registry entries.

Best Regards,
Bryan Clark

(Ranger Guru)

---

1. Open a Windows "run" prompt by pressing the Windows key + R
      or
    Search for "Run" in the Start Menu

2. At the Run prompt, type in "regedit" and click OK

3. You may be prompted by Windows to allow the registry editor to make changes; choose "Yes."

4. On the left hand side of the screen, there will be a "Tree" menu.
   
    In that tree, look for:

    32-bit Windows - HKEY_LOCAL_MACHINE\SOFTWARE\Silver Bullet Technology\Installed Products\Components
      or
    64-bit Windows - HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Silver Bullet Technology\Installed Products\Components

5. You should be able to find your Ranger product key by examining the folders.  Look for a 25-character code in this format:
   
     XXXX-XXXX-XXXX-XXXX-XXXX-X

That is your Ranger product key.

---