idscan & MedicScan Connect Product Manual

Transcription

1 idscan & MedicScan Connect Product Manual Last updated on 05/09/2018 1

2 Contents 1. Introduction Technical Specifications... 4 a. Programming languages supported:... 4 b. Document types supported:... 4 c. Application types supported:... 4 d. Hardware supported:... 4 e. Bandwidth requirements:... 4 f. Operating systems supported:... 4 g. Hardware Requirements: Installation Starting of the Program Setting up the Program idscan Connect vs MedicScan Connect The Program Interface License Code Vs Access Key Understanding the Connect Settings:... 9 a. Scanner b. Modes c. Documents d. Driver s License e. Miscellaneous f. Twain Settings g. Export Settings Driver s License Scanning Passport Scanning Insurance Card Scanning Populating the data a. Using a.net based desktop application b. Using a Browser Based application c. Using a.net based desktop application in Terminal Services (Citrix, RDP etc.) Connect API Exporting Data

3 16. Uninstallation Support process

4 1. Introduction idscan & MedicScan Connect is a software utility that runs in the background of the PC and will enable the user to use specific, certified image capture devices to easily capture the image with one click. The image is then processed via Acuant Web Services and the extracted information can then populate into an integrated application. This requires a very simple integration with the user application to populate it with the data pulled from Web Services. 2. Technical Specifications a. Programming languages supported: Any programming language Code samples in multiple programming languages available for integration b. Document types supported: Driver s License, Passports, Govt. Issued IDs, and Medical Insurance Cards. c. Application types supported: Most applications such as Web, GUI, Citrix, RDP etc. as long as the application can make a web service call d. Hardware supported: Proprietary Acuant scanners TWAIN compatible scanners such as Fujitsu (6130, 7160, fi60 etc.), Epson (S9000, S2000 etc.) and many more e. Bandwidth requirements: Images of file size between 300kb to 600kb will be uploaded by web services for processing Internet connection with minimum speed of 1 mbps upload is required f. Operating systems supported: Windows 7, Windows 8/8.1, Windows 10 4

5 g. Hardware Requirements: Dual core processor, 2GB RAM, 1GB of free hard drive space 3. Installation Please refer to the following installation guide: idscanmedicscanconnect_installationguide.pdf which can be downloaded from the Support Portal to install the idscan /MedicScan Connect program. If you do not see the relevant file in the Downloads section on Support Portal, please contact Acuant. The program is installed in the following installation folder depending upon if you have a 32bit or a 64bit machine: - C:\Program Files\Acuant\Connect for 32 bit machines. - C:\Program Files (x86)\acuant\connect for 64 bit machines. 4. Starting of the Program As soon as the setup is installed, the program starts. It also runs automatically once the computer boots up. The program can also be executed from the Connect shortcut icon created on the desktop. The program icon will appear in the System tray of Windows located at the bottom right corner of the screen. All the various options can be accessed by right clicking on the Connect icon in the System tray. A small notification window pops up at the bottom right corner of the screen to notify the user what the program is doing. Once the program is loaded, hovering the mouse cursor over the program icon in System Tray shows the status of the connection of the scanner with the program. 5. Setting up the Program Machine Registration: If the program is loaded for the first time, the user will be prompted to register the machine. The machine registration process requires a License code for registration. 5

6 Connecting the Scanner: If you have an Acuant scanner (SnapShell or ScanShell), please plug it into the machine and click SnapShell or ScanShell Scanner button. If an Acuant scanner (SnapShell or ScanShell) is already plugged into the machine, the program will connect to it automatically. In order to connect a Twain scanner, click on the Twain Scanner button. Here different Twain scanner settings can be configured. Please refer to this for Twain scanner settings details. 6

7 6. idscan Connect vs MedicScan Connect - idscan Connect scans and processes Driver s License, Passports, and Govt. Issued IDs. - MedicScan Connect scans and processes Driver s License, Passports, Govt. Issued IDs, and Medical Insurance Cards. The setup for both idscan Connect and MedicScan Connect is the same. 7. The Program Interface When the program is in operation, a small blue notification window at the bottom right corner of the screen shows the progress. An icon for idscan /MedicScan Connect appears in the System tray of Windows at the bottom right corner of the screen. Right clicking on the program System tray icon shows a menu of options such as below. 7

8 About: It shows the program title (idscan Connect or MedicScan Connect), version number and copyright information. Connect Scanner: Use this option to connect the program with a scanner. Disconnect Scanner: Use this option to disconnect scanner from the program. Access Key: It shows the access key which uniquely identifies the machine. This access key is required in order to populate the data in browser based applications. Please report this access key for any support issues too. Settings: It shows the various settings of the program discussed next. Exit: Use this option to exit the program. 8. License Code Vs Access Key License code is used to register the computer after the installation of the program. Each machine registered on the license code is billed. Access key is the unique key automatically assigned to a computer upon registration. Every computer has a unique static access key. Access key is used to populate the extracted data in web applications and also for support purposes. 8

9 9. Understanding the Connect Settings: 9

10 a. Scanner Scanner Connected: It shows which scanner is currently connected to the program. Hover the mouse cursor over it to see the complete scanner name. Test Scan: It can be used to perform test scans with Acuant scanners. In order to test scanning with a Twain scanner, please go to Twain Settings. Calibration: Only use this option to calibrate Acuant ScanShell scanners. (Acuant SnapShell scanners do not require calibration). Calibration is required every 500 scans to maintain good image quality. Program will automatically ask for calibration when needed. Scanning Mode: Select the scanning mode for a simplex (single sided) Acuant scanner. If a duplex (dual sided) scanning mode for a simplex scanner is selected, after scanning the front side, a notification will appear instructing the user to flip the card to scan the back side. Twain Settings: The Twain scanner settings can be accessed here. Twain Settings are discussed in detail later in the document here. b. Modes idscan /MedicScan Connect program can run in the following different modes: Dashboard: This mode is particularly useful while scanning more than one kind of a document with the program. The user will be presented with a dashboard to scan specific kind of documents. Default Auto Scan: This mode is only available when an Acuant scanner is connected with the program. The Default Auto Scan mode functions differently in the case of different Acuant scanners. ScanShell Scanner: The scanner will automatically start the scanning as soon as the document is placed in the tray of the ScanShell scanner. SnapShell Scanner (SnapShell R2/IDR): In the case of SnapShell R2/IDR, the hardware button on the scanner will be activated and can be used to initiate the scanning process. The type of the document, which needs to be automatically scanned with the program can be selected from the Documents option list in the Settings. 10

11 SnapShell Passport Scanner: For SnapShell Passports, the hardware button(s) on the scanner will be activated and can be used to initiate the scanning process. The difference here is that the SnapShell Passport scanner has three hardware buttons which are dedicated to different types of documents. - Top button Passport - Middle button Driver s License - Bottom button Insurance Card Connect API: This mode is used for starting the scanning process from a third party application (customer application). Note: In order for this mode to work, the third party application should be programmed accordingly. Right now, integration is available for.net based desktop applications. Please see the details here. c. Documents User can select the available documents which can be scanned. The Passport document option will be disabled if the Acuant scanner cannot scan Passports. - With the dashboard mode, more than one document can be selected. - With the Default Auto Scan mode, only one of the available documents can be selected. - With the Connect API mode, all the available documents will be preselected. d. Driver s License Region Settings: Here the region for driver s license scanning is selected from the dropdown. By default, United States is selected. Show Region Selection Before Processing: This is a new feature available from the idscan /MedicScan Connect version Once enabled, the user will be asked to select the region of ID/DL each time before processing. They will see such a window at the bottom right corner of the screen. This option is only available in Dashboard and Default Auto Scan modes. 11

12 . e. Miscellaneous Notification Timeout: Here the timeout for the program notification Window can be set/changed. This decides for how much time the window should stay on the screen. The timeout can be set in seconds anything between 1 second and 120 seconds. The default value for notification timeout is 30 seconds. Dashboard Window on Top: Enable this feature if the dashboard window to be needed on top of other windows always. This option is only available for Dashboard mode. Data Export: The extracted data from the driver s license/insurance cards can be exported to a text file and the images can be saved to the disk using data export feature. This option is only available for Dashboard and Default Auto Scan modes. Please see the details here. Report Image: The user can report the images of the documents with which they are facing issues using this feature. f. Twain Settings Twain settings should be configured when the Twain scanner is connected with idscan /MedicScan Connect. Later on these settings can be accessed from the Settings Window. At the top of the Twain Scanner Settings window, a list of all the available Twain scanners on the machine is listed. The user can select the relevant scanner that needs to be connected to the program and the click the button Connect. When accessing the Twain Settings from the Settings Window, the connected Twain scanner will be already selected in the dropdown. 12

13 Scanner Type: Select the scanner type here whether the Twain scanner is a simplex or a duplex scanner. Scanning Mode: If the scanner selected is a simplex scanner, then there are two options of mode of scanning simplex or duplex. The default scanning mode for simplex scanner is duplex. Note: If a duplex scanning mode for a simplex scanner is selected, after scanning the front side, a notification will appear instruction the user to flip the card to scan the back side. 13

14 Center Image: It sets the alignment of the captured image whether it is to be centered or not. Display Twain Interface: When it is enabled, the program will display the twain interface every time a scan is made with the Twain scanner. Generally, this will be used during the Twain scanner setup process to make sure all the internal Twain scanner settings are correct. Test Scan: It can be used to perform test scans. The scanned image is also displayed on the window. g. Export Settings With the idscan /MedicScan Connect version and above, the data can be exported to a file. When the data export is enabled, all the extracted data from the document and images are stored on the disk in the export directory. Once enabled, the settings can be configured from the Export Settings. Different tabs are dedicated for different types of documents. Note: The data export option is only available for Dashboard and Default Auto Scan modes. 14

15 Directory: It is the directory where all the data export files and the images are saved. The default directory for this purpose is - C:\Program Files\Acuant\Connect\DataExport for 32 bit machines. - C:\Program Files (x86)\acuant\connect\dataexport for 64 bit machines. This directory can be changed using the button, Change right next to it. Image Resolution: This sets the image resolution for the exported card images on the disk. The resolution can be set in DPI anything between 50 DPI to 300 DPI. The default value is 150 DPI. Data File and Image file names: The file names for the data file and images for all the documents can be renamed. Saving images can be enabled/disabled individually. For driver s licenses, the user can export the extracted data fields in a text file. The front and back images of the ID, the concatenated front and back image, the face image and the signature image can be saved to the disk. For passports, the user can export the extracted data fields in a text file. The front image of the Passport and the face image can be saved to the disk. For insurance cards, the user can export the extracted data fields in a text file, save the front and the back images and the concatenated front and back image. The default file names are as follows: - Driver s License data file - ExportedData_DL" - Driver s License front image - "FrontImage_DL" - Driver s License back image - "BackImage_DL" - Driver s License face image - "FaceImage_DL" - Driver s License signature image - "SignatureImage_DL" - Driver s License front and back concatenated image - "ConcatenatedImage_DL" - Passport data file - ExportedData_Pass" - Passport front image - "FrontImage_Pass" - Passport face image - "FaceImage_Pass" - Insurance Card data file - "ExportedData_Medical" - Insurance Card front image - "FrontImage_Medical" - Insurance Card back image - "BackImage_Medical" - Insurance Card front and back concatenated image - "ConcatenatedImage_Medical" Note: All the data files are exported in the.txt file format and all the images are saved in.jpg image format. 15

16 10. Driver s License Scanning A driver s license can be scanned and processed in many ways: - In dashboard mode, the user clicks the driver s license button to start scanning. - In Default Auto Scan Mode, for ScanShell devices, just place the ID in the scanner to start scanning. For SnapShell devices, place the ID on the glass plate and hit the hardware button on the device to start scanning. - In Connect API mode, start the scanning from any third party application. Once the ID is scanned and processed and the notification window shows Complete, the extracted data is ready to be populated in the application. Note: If the Export Data is enabled, once the scan and process of the ID is complete, all the data and the images will be exported to the Data Export directory. 11. Passport Scanning A passport can be scanned and processed in many ways: - In dashboard mode, the user clicks the passport button to start scanning. - In Default Auto Scan Mode, for SnapShell devices, place the Passport on the glass plate and hit the top hardware button on the device to start scanning. Please see for more details here. - In Connect API mode, start the scanning from any third party application. Once the Passport is scanned and processed and the notification window shows Complete, the extracted data is ready to be populated in the application. Note: If the Export Data is enabled, once the scan and process of the Passport is complete, all the data and the images will be exported to the Data Export directory. 12. Insurance Card Scanning An insurance card can be scanned and processed in many ways: - In dashboard mode, the user clicks the Insurance Card button to start scanning. - In Default Auto Scan Mode, for ScanShell devices, just place the insurance card in the scanner to start scanning. For SnapShell devices, place the insurance card on the glass plate and hit the hardware button on the device to start scanning. - In Connect API mode, start the scanning from any third party application. Once the insurance card is scanned and processed and the notification window shows Complete, the data is ready to be populated in the application. Note: If the Export Data is enabled, once the scan and process of the insurance card is complete, all the data and the images will be exported to the Data Export directory. 16

17 13. Populating the data Once the document is scanned and processed and the notification window shows Complete, the data is ready to be populated in the application from the Acuant Web Services. Please note the following points regarding the populating of the data: At a time only one ID data is available to pull. If two IDs are scanned one after the other without calling populate data, the data of first ID will be overwritten by second ID data. ID data can only be pulled once. If another call to populate data is made without scanning another ID, no data is returned and Data Not Found error is returned. ID data is automatically deleted if not populated within 3 minutes. This is done for the security purpose. There are many ways in which the data can be populated. a. Using a.net based desktop application The extracted data from the document can be populated in a.net based application. Please find below the code sample and instructions for the same. Make sure that the mode of operation of the program is either Dashboard mode or Default Auto Scan mode. Please download the C#.Net code sample idscanconnectclient.zip from the Support Portal. Unzip the above downloaded file and open it in Visual Studio. Run the project and select the button Driver s License to populate driver s license data from the card scanned with idscan /MedicScan Connect program. Run the project and select the button Passport to populate driver s license data from the card scanned with idscan /MedicScan Connect program. Select the button Insurance Card to populate medical insurance card data from the card scanned with MedicScan Connect program. Ignore the Scan buttons; those are related to Connect API discussed later in this document. When done scanning, the information will be populated in the fields automatically. API Documentation The API Documentation AcuFillWebServices_CSharpProgrammersGuide.pdf can be downloaded from the Support Portal. b. Using a Browser Based application The extracted data from the document can be populated in a browser based application. Please find below the code sample and instructions for the same. Make sure that the mode of operation of the program is either Dashboard mode or Default Auto Scan mode. 17

18 Please download the code sample CSSNPopulateDataSampleApp from the Support Portal. Unzip the above downloaded file and open the page getdldata.htm in web browser for driver s licenses. Open the page getmedinsdata.htm for insurance cards. To get the Access key, right click on the idscan /MedicScan Connect System tray icon. Click on "Access Key" option, a window will popup. Copy the Access key and paste it in the text box in the Web page. Press Populate data button when done scanning an ID/Passport/Insurance Card in idscan /MedicScan Connect software. The information will be populated in the fields. API Documentation - The API Documentation AcuFillWebServices_ProgrammersGuide.pdf can be downloaded from the Support Portal. c. Using a.net based desktop application in Terminal Services (Citrix, RDP etc.) The extracted data from the document can be populated in a.net based application. Please find below the code sample and instructions for the same. Make sure that the mode of operation of the program is either Dashboard mode or Default Auto Scan mode. Please download the C#.Net code sample idscanconnectclient_terminalservices.zip from the Support Portal. Unzip the above downloaded file and open it in Visual Studio. Run the project and select the button Driver s License to populate driver s license data from the card scanned with idscan /MedicScan Connect program. Run the project and select the button Passport to populate driver s license data from the card scanned with idscan /MedicScan Connect program. Select the button Insurance Card to populate medical insurance card data from the card scanned with MedicScan Connect program. To get the Access key, right click on the idscan /MedicScan Connect System tray icon. Click on "Access Key" option, a window will popup. Copy the Access key and paste it in the text box in the form. When done scanning, the information will be populated in the fields automatically. API Documentation - The API Documentation AcuFillWebServices_CSharpProgrammersGuide.pdf can be downloaded from the Support Portal. 14. Connect API Using Connect API, the scanning process can be started in idscan /MedicScan Connect from any third party application. The extracted data will be populated into the application after scanning and processing are complete. The integration is available for.net based desktop applications. Please find details below: 18

19 Change the mode of operation of idscan /MedicScan Connect program to Connect API from the Settings Window. Please download the C#.Net code sample idscanconnectclient.zip from the Support Portal. Unzip the above downloaded file and open it in Visual Studio. Run the project and select the button Driver s License to populate driver s license data from the card scanned with idscan /MedicScan Connect program. Select the button Passport to populate driver s license data from the card scanned with idscan /MedicScan Connect program. Select the button Insurance Card to populate medical insurance card data from the card scanned with MedicScan Connect program. Click the button Scan in the code sample form to start the scanning in idscan /MedicScan Connect program. When done scanning, the information will be populated in the fields automatically. API Documentation The API Documentation AcuFillWebServices_CSharpProgrammersGuide.pdf can be downloaded from the Support Portal. 15. Exporting Data With the idscan /MedicScan Connect version and above, the data can be exported to a file. When the data export is enabled, all the extracted data from the document and images are stored on the disk in the export directory. Once enabled, the settings can be configured from the Export Settings. Different tabs are dedicated for different types of documents. Export Data File Formats: Driver s License Data Export File: The idscan /MedicScan Connect exports all the driver s license fields comma separated in the data export file. The sequence of the fields is as below: - First Name - Middle Name - Last Name - Suffix - ID Number - Expiration Date - Issue Date - Date of Birth - Street Address - City - State - Zip - Country Short 19

20 - Country Long - Sex - Class - Eye Color - Hair Color - Height - Weight - Restriction - Endorsements Passport Data Export File: The idscan /MedicScan Connect exports all the passport fields comma separated in the data export file. The sequence of the fields are as below: - First Name - Middle Name - Last Name - First Name Non MRZ - Last Name Non MRZ - Passport Number - Expiration Date - Issue Date - Date of Birth - Country Short - Country Long - Nationality Short - Nationality Long - Sex - Place of Birth - Personnel Number Note: All the date fields are exported in the MM-DD-YYYY format. Insurance Card Data Export File: The MedicScan Connect exports all the insurance card fields comma separated in the data export file. The sequence of the fields is as below: - First Name - Middle Name - Last Name - Member ID - Group Number - Group Name - Contract Code 20

21 - Copay ER - Copay OV - Copay SP - Copay UC - Coverage The Address fields are exported depending upon the addresses count. If the address count is zero, no address fields will be exported and just 0 as address count will be printed. But if the address count is 1 or more than 1 then address fields will be exported in the group of (street, city, state, zip) one after the other. - Address Count - Street Address - City - State - Zip The fields of web, , telephone and deductible are exported depending upon their counts. If web count is zero, then web field is not exported. Similarly, for other fields. - Web Count - Web - Count - - Telephone Count - Telephone - Deductible Count - Deductible - Effective Date - Expiration Date - Issue Number - Employer - Payer ID - Plan Admin - Plan Provider - Plan Type - RxBin - RxGroup - RxId - RxPCN 21

22 16. Uninstallation To uninstall the program, open the Add-Remove Program control panel. Select the Application icon and click on Remove. Follow the uninstall instructions until the operation is complete. The program can also be uninstalled from the Uninstall shortcut in the installation folder. 17. Support process A unique Access key is assigned to each computer. To get the Access key for particular machine, right click on idscan /MedicScan Connect System tray icon and click on Access Key. You will see a unique Access Key assigned to the computer. To report any support issues, please provide this Access Key with it. You can also report the images of the document with which you are facing issues with using the Report Image feature in the Settings window discussed here. 22